1 package FS::AccessRight;
4 use vars qw(@rights); # %rights);
9 FS::AccessRight - Access control rights.
15 my @rights = FS::AccessRight->rights;
17 #my %rights = FS::AccessRight->rights_categorized;
18 tie my %rights, 'Tie::IxHash', FS::AccessRight->rights_categorized;
19 foreach my $category ( keys %rights ) {
20 my @category_rights = @{ $rights{$category} };
25 Access control rights - Permission to perform specific actions that can be
26 assigned to users and/or groups.
32 # '_desc' => 'Access to high-level reporting',
34 # 'Configuration' => [
35 # '_desc' => 'Access to configuration',
40 # '_desc' => 'Master access to reseller configuration',
45 # 'export_svc_pkg' => [
46 # '_desc' => 'Access to export, service and package configuration',
47 # 'part_export' => {},
54 # '_desc' => 'Access to billing configuration',
55 # 'payment_gateway' => {},
56 # 'part_bill_event' => {},
57 # 'prepay_credit' => {},
59 # 'cust_main_county' => {},
63 # '_desc' => 'Access to dialup configuraiton',
64 # 'svc_acct_pop' => {},
68 # '_desc' => 'Access to broadband configuration',
74 # 'part_referral' => {},
75 # 'part_virtual_field' => {},
77 # 'inventory_class' => {},
84 ##turn it into a more hash-like structure, but ordered via IxHash
86 #well, this is what we have for now. getting better.
87 tie my %rights, 'Tie::IxHash',
92 'Contact and Prospect rights' => [
99 #'View customer contacts',
104 # basic customer rights
106 'Customer rights' => [
109 #'View Customer | View tickets',
111 'Edit customer basics',
112 'Edit customer tags',
113 'Edit referring customer',
114 'Edit customer addresses',
115 'Edit customer billing information',
116 'View customer history',
118 'Unsuspend customer',
120 'Complimentary customer', #aka users-allow_comp
122 'Merge customer across agents',
123 { rightname=>'Delete customer', desc=>"Enable customer deletions. Be very careful! Deleting a customer will remove all traces that this customer ever existed! It should probably only be used when auditing a legacy database. Normally, you cancel all of a customer's packages if they cancel service." }, #aka. deletecustomers
124 'Bill customer now', #NEW
125 'Bulk send customer notices', #NEW
126 { rightname=>'View customers of all agents', global=>1 },
130 # customer package rights
132 'Customer package rights' => [
133 'View customer packages', #NEW
134 'Order customer package',
136 'Change customer package',
137 'Bulk change customer packages',
138 'Edit customer package dates',
139 'Discount customer package', #NEW
140 'Custom discount customer package', #NEW
141 'Customize customer package',
142 'Suspend customer package',
143 'Suspend customer package later',
144 'Unsuspend customer package',
145 'Cancel customer package immediately',
146 'Cancel customer package later',
147 'Un-cancel customer package',
148 'Delay suspension events',
149 'Add on-the-fly cancel reason', #NEW
150 'Add on-the-fly suspend reason', #NEW
151 'Edit customer package invoice details', #NEW
152 'Edit customer package comments', #NEW
153 'Qualify service', #NEW
154 'Waive setup fee', #NEW
158 # customer service rights
160 'Customer service rights' => [
161 'View customer services', #NEW
162 'Provision customer service',
163 'Bulk provision customer service',
164 'Recharge customer service', #NEW
165 'Unprovision customer service',
166 'Change customer service', #NEWNEW
169 'Edit home dir', #NEW
170 'Edit www config', #NEW
171 'Edit domain catchall', #NEW
172 'Edit domain nameservice', #NEW
173 'Manage domain registration',
175 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
179 # customer invoice/financial info rights
181 'Customer invoice / financial info rights' => [
183 'Resend invoices', #NEWNEW
184 'Delete invoices', #new, but no need to phase in
185 'View customer tax exemptions', #yow
186 'Edit customer tax exemptions', #NEWNEW
187 'Add customer tax adjustment', #new, but no need to phase in
188 'View customer batched payments', #NEW
189 'View customer pending payments', #NEW
190 'Edit customer pending payments', #NEW
191 'View customer billing events', #NEW
195 # customer payment rights
197 'Customer payment rights' => [
199 { rightname=>'Post payment', desc=>'Make check or cash payments.' },
200 { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
201 'Post check payment',
203 'Post payment batch',
204 'Apply payment', #NEWNEW
205 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
206 { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
207 'Process credit card payment',
208 'Process Echeck payment',
209 { rightname=>'Delete payment', desc=>'Enable deletion of unclosed payments. Be very careful! Only delete payments that were data-entry errors, not adjustments.' }, #aka. deletepayments Optionally specify one or more comma-separated email addresses to be notified when a payment is deleted.
213 # customer credit rights
215 'Customer credit and refund rights' => [
217 'Credit line items', #NEWNEWNEW
218 'Apply credit', #NEWNEW
219 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
220 { rightname=>'Delete credit', desc=>'Enable deletion of unclosed credits. Be very careful! Only delete credits that were data-entry errors, not adjustments.' }, #aka. deletecredits Optionally specify one or more comma-separated email addresses to be notified when a credit is deleted.
222 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
225 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
226 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
227 'Refund credit card payment',
228 'Refund Echeck payment',
229 'Delete refund', #NEW
230 'Add on-the-fly credit reason', #NEW
234 # customer voiding rights..
236 'Customer void rights' => [
237 { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
238 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
240 { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
246 # note/attachment rights...
248 'Customer note and attachment rights' => [
249 'Add customer note', #NEW
250 'Edit customer note', #NEW
251 'View attachments', #NEW
252 'Browse attachments', #NEW
253 'Download attachment', #NEW
254 'Add attachment', #NEW
255 'Edit attachment', #NEW
256 'Delete attachment', #NEW
257 'View deleted attachments', #NEW
258 'Undelete attachment', #NEW
259 'Purge attachment', #NEW
263 # report/listing rights...
265 'Reporting/listing rights' => [
267 'List all customers',
268 'Advanced customer search',
269 'List zip codes', #NEW
272 'Summarize packages',
274 'List service passwords',
276 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
277 'Billing event reports',
278 'Receivables report',
280 { rightname=> 'List inventory', global=>1 },
281 { rightname=>'View email logs', global=>1 },
282 { rightname=>'View system logs' },
284 'Download report data',
285 'Services: Accounts',
286 'Services: Accounts: Advanced search',
288 'Services: Certificates',
289 'Services: Mail forwards',
290 'Services: Virtual hosting services',
291 'Services: Wireless broadband services',
292 'Services: Wireless broadband services: Advanced search',
294 'Services: Dish services',
295 'Services: Hardware',
296 'Services: Hardware: Advanced search',
297 'Services: Phone numbers',
298 'Services: Phone numbers: Advanced search',
301 'Services: Mailing lists',
302 'Services: External services',
303 'Usage: RADIUS sessions',
304 'Usage: Call Detail Records (CDRs)',
305 'Usage: Unrateable CDRs',
306 'Usage: Time worked',
308 #{ rightname => 'List customers of all agents', global=>1 },
314 'Miscellaneous rights' => [
315 { rightname=>'Job queue', global=>1 },
316 { rightname=>'Time queue', global=>1 },
317 { rightname=>'Process batches', }, #Process payment batches
318 { rightname=>'Process global batches', global=>1 }, #Process global payment batches
319 { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
320 { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
321 { rightname=>'Process invoice batches', },
322 { rightname=>'Process global invoice batches', global=>1 },
323 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
324 { rightname=>'Export', global=>1 },
325 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
331 #'Database access rights' => [
332 { rightname=>'Raw SQL', global=>1 }, #NEW
336 # setup/config rights
338 'Configuration rights' => [
339 'Edit advertising sources',
340 { rightname=>'Edit global advertising sources', global=>1 },
342 'Edit package definitions',
343 { rightname=>'Edit global package definitions', global=>1 },
345 'Bulk edit package definitions',
347 'Edit billing events',
348 { rightname=>'Edit global billing events', global=>1 },
351 { rightname=>'View global templates', global=>1 },
353 { rightname=>'Edit global templates', global=>1 },
356 { rightname=>'Edit global inventory', global=>1 },
358 { rightname=>'Dialup configuration' },
359 { rightname=>'Dialup global configuration', global=>1 },
361 { rightname=>'Broadband configuration' },
362 { rightname=>'Broadband global configuration', global=>1 },
364 { rightname=> 'Configure network monitoring', global=>1 },
366 #{ rightname=>'Edit employees', global=>1, },
367 #{ rightname=>'Edit employee groupss', global=>1, },
369 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
371 { rightname=>'Configuration download', }, #description of how it affects
372 #search/elements/search.html
384 Returns the full list of right names.
390 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
393 =item default_superuser_rights
395 Most (but not all) right names.
399 sub default_superuser_rights {
401 my %omit = map { $_=>1 } (
407 'Edit customer package dates',
409 'Usage: Time worked',
410 'Redownload resolved batches',
412 'Configuration download',
413 'View customers of all agents',
414 'View/link unlinked services',
418 'Edit customer package dates',
421 no warnings 'uninitialized';
422 grep { ! $omit{$_} } $class->rights;
427 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
428 category names and values are list references of rights. Each element of the
429 list reference scalar right name or a hashref with the following keys:
433 =item rightname - Right name
435 =item desc - Extended right description
437 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
451 Damn those infernal six-legged creatures!
455 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>