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 # 'prepay_credit' => {},
58 # 'cust_main_county' => {},
62 # '_desc' => 'Access to dialup configuraiton',
63 # 'svc_acct_pop' => {},
67 # '_desc' => 'Access to broadband configuration',
73 # 'part_referral' => {},
74 # 'part_virtual_field' => {},
76 # 'inventory_class' => {},
83 ##turn it into a more hash-like structure, but ordered via IxHash
85 #well, this is what we have for now. getting better.
86 tie my %rights, 'Tie::IxHash',
91 'Contact and Prospect rights' => [
97 #'View customer contacts',
103 # basic customer rights
105 'Customer rights' => [
108 #'View Customer | View tickets',
110 'Edit customer tags',
111 'Edit referring customer',
112 'View customer history',
114 'Unsuspend customer',
116 'Complimentary customer', #aka users-allow_comp
118 'Merge customer across agents',
119 'Bill customer now', #NEW
120 'Bulk send customer notices', #NEW
121 { rightname=>'View customers of all agents', global=>1 },
125 # customer package rights
127 'Customer package rights' => [
128 'View customer packages', #NEW
129 'Order customer package',
131 'Modify one-time charge',
132 'Change customer package',
133 'Detach customer package',
134 'Bulk change customer packages',
135 'Edit customer package dates',
136 'Discount customer package', #NEW
137 'Custom discount customer package', #NEW
138 'Customize customer package',
139 'Suspend customer package',
140 'Suspend customer package later',
141 'Unsuspend customer package',
142 'Cancel customer package immediately',
143 'Cancel customer package later',
144 'Un-cancel customer package',
145 'Delay suspension events',
146 'Add on-the-fly cancel reason', #NEW
147 'Add on-the-fly suspend reason', #NEW
148 'Edit customer package invoice details', #NEW
149 'Edit customer package comments', #NEW
150 'Qualify service', #NEW
151 'Waive setup fee', #NEW
152 'View appointments', #NEWNEW
154 'View package definition costs', #NEWNEW
158 # customer service rights
160 'Customer service rights' => [
161 'View customer services', #NEW
162 'Provision customer service',
163 'Bulk provision customer service',
164 'Bulk move customer services', #NEWNEW
165 'Recharge customer service', #NEW
166 'Unprovision customer service',
167 'Change customer service', #NEWNEW
170 'Edit home dir', #NEW
171 'Edit www config', #NEW
172 'Edit domain catchall', #NEW
173 'Edit domain nameservice', #NEW
174 'Manage domain registration',
176 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
180 # customer invoice/financial info rights
182 'Customer invoice / financial info rights' => [
184 'Resend invoices', #NEWNEW
188 'View customer tax exemptions', #yow
189 'Edit customer tax exemptions', #NEWNEW
190 'Add customer tax adjustment', #new, but no need to phase in
191 'View customer batched payments', #NEW
192 'View customer pending payments', #NEW
193 'Edit customer pending payments', #NEW
194 'View customer billing events', #NEW
198 # customer payment rights
200 'Customer payment rights' => [
202 { rightname=>'Post payment', desc=>'Make check or cash payments.' },
203 { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
204 'Post check payment',
206 'Post payment batch',
207 'Apply payment', #NEWNEW
208 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
209 { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
210 'Process credit card payment',
211 'Process Echeck payment',
212 { 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.
216 # customer credit rights
218 'Customer credit and refund rights' => [
220 { rightname=>'Backdate credit', desc=>'Enable credits to be posted for days other than today.' },
221 'Credit line items', #NEWNEWNEW
222 'Apply credit', #NEWNEW
223 'Void credit', #NEWER than things marked NEWNEWNEW
224 'Unvoid credit', #NEWER than things marked NEWNEWNEW
225 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
226 { 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.
228 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
231 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
232 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
233 'Refund credit card payment',
234 'Refund Echeck payment',
235 'Delete refund', #NEW
236 'Add on-the-fly credit reason', #NEW
237 'Add on-the-fly void credit reason',
238 'Add on-the-fly refund reason', #NEW
242 # customer voiding rights..
244 'Customer payment void rights' => [
245 { rightname=>'Credit card void', desc=>'Enable local-only voiding of credit card payments in addition to refunds against the payment gateway.' }, #aka. cc-void
246 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
248 { rightname=>'Unvoid payments', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
254 # note/attachment rights...
256 'Customer note and attachment rights' => [
257 'Add customer note', #NEW
258 'Edit customer note', #NEW
259 'View attachments', #NEW
260 'Browse attachments', #NEW
261 'Download attachment', #NEW
262 'Add attachment', #NEW
263 'Edit attachment', #NEW
264 'Delete attachment', #NEW
265 'View deleted attachments', #NEW
266 'Undelete attachment', #NEW
267 'Purge attachment', #NEW
271 # report/listing rights...
273 'Reporting/listing rights' => [
277 'List all customers',
278 'Advanced customer search',
279 'List zip codes', #NEW
283 'Summarize packages',
285 'List service passwords',
287 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
288 'Billing event reports',
289 'Receivables report',
291 { rightname=> 'List inventory', global=>1 },
292 { rightname=>'View email logs', global=>1 },
293 { rightname=>'View system logs' },
295 'Download report data',
296 'Services: Accounts',
297 'Services: Accounts: Advanced search',
299 'Services: Certificates',
300 'Services: Mail forwards',
301 'Services: Virtual hosting services',
302 'Services: Wireless broadband services',
303 'Services: Wireless broadband services: Advanced search',
305 'Services: Cable subscribers',
306 'Services: Conferencing',
307 'Services: Dish services',
308 'Services: Hardware',
309 'Services: Hardware: Advanced search',
310 'Services: Phone numbers',
311 'Services: Phone numbers: Advanced search',
314 'Services: Mailing lists',
315 'Services: Alarm services',
317 'Services: Circuits',
318 'Services: External services',
319 'Usage: RADIUS sessions',
320 'Usage: Call Detail Records (CDRs)',
321 'Usage: Unrateable CDRs',
322 'Usage: Time worked',
323 #gone in 4.x as a distinct ACL (for now?) { rightname=>'Employees: Commission Report', global=>1 },
324 { rightname=>'Employees: Audit Report', global=>1 },
326 #{ rightname => 'List customers of all agents', global=>1 },
332 'Miscellaneous rights' => [
333 { rightname=>'Job queue', global=>1 },
334 { rightname=>'Time queue', global=>1 },
335 { rightname=>'Process batches', }, #Process payment batches
336 { rightname=>'Process global batches', global=>1 }, #Process global payment batches
337 { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
338 { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
339 { rightname=>'Process invoice batches', },
340 { rightname=>'Process global invoice batches', global=>1 },
341 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
342 { rightname=>'Export', global=>1 },
343 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
349 #'Database access rights' => [
350 { rightname=>'Raw SQL', global=>1 }, #NEW
354 # setup/config rights
356 'Configuration rights' => [
357 'Edit advertising sources',
358 { rightname=>'Edit global advertising sources', global=>1 },
362 'Edit package definitions',
363 { rightname=>'Edit global package definitions', global=>1 },
364 'Edit package definition costs',
366 'Bulk edit package definitions',
368 'Edit FCC report configuration',
369 { rightname => 'Edit FCC report configuration for all agents', global=>1 },
372 #{ rightname=>'Edit global CDR rates', global=>1, },
374 'Edit fee definitions',
375 { rightname=>'Edit global fee definitions', global=>1 },
377 'Edit billing events',
378 { rightname=>'Edit global billing events', global=>1 },
381 { rightname=>'View global templates', global=>1 },
383 { rightname=>'Edit global templates', global=>1 },
386 { rightname=>'Edit global inventory', global=>1 },
388 { rightname=>'Dialup configuration' },
389 { rightname=>'Dialup global configuration', global=>1 },
391 { rightname=>'Broadband configuration' },
392 { rightname=>'Broadband global configuration', global=>1 },
394 { rightname=>'Alarm configuration' },
395 { rightname=>'Alarm global configuration', global=>1 },
397 { rightname=> 'Configure network monitoring', global=>1 },
399 #{ rightname=>'Edit employees', global=>1, },
400 #{ rightname=>'Edit employee groupss', global=>1, },
402 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
404 { rightname=>'Configuration download', }, #description of how it affects
405 #search/elements/search.html
417 Returns the full list of right names.
423 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
426 =item default_superuser_rights
428 Most (but not all) right names.
432 sub default_superuser_rights {
434 my %omit = map { $_=>1 } (
439 'Edit customer package dates',
441 'Usage: Time worked',
442 'Redownload resolved batches',
444 'Configuration download',
445 'View customers of all agents',
446 'View/link unlinked services',
450 'Void invoices',#people are overusing this when credits are more appropriate
454 no warnings 'uninitialized';
455 grep { ! $omit{$_} } $class->rights;
460 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
461 category names and values are list references of rights. Each element of the
462 list reference scalar right name or a hashref with the following keys:
466 =item rightname - Right name
468 =item desc - Extended right description
470 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
484 Damn those infernal six-legged creatures!
488 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>