RT# 77332 - Fixed error where all packages updated with new next bill date, instead...
[freeside.git] / FS / FS / AccessRight.pm
1 package FS::AccessRight;
2
3 use strict;
4 use vars qw(@rights); # %rights);
5 use Tie::IxHash;
6
7 =head1 NAME
8
9 FS::AccessRight - Access control rights.
10
11 =head1 SYNOPSIS
12
13   use FS::AccessRight;
14
15   my @rights = FS::AccessRight->rights;
16
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} };
21   }
22
23 =head1 DESCRIPTION
24
25 Access control rights - Permission to perform specific actions that can be
26 assigned to users and/or groups.
27
28 =cut
29
30 #@rights = (
31 #  'Reports' => [
32 #    '_desc' => 'Access to high-level reporting',
33 #  ],
34 #  'Configuration' => [
35 #    '_desc' => 'Access to configuration',
36 #
37 #    'Settings' => {},
38 #
39 #    'agent' => [
40 #      '_desc' => 'Master access to reseller configuration',
41 #      'agent_type'  => {},
42 #      'agent'       => {},
43 #    ],
44 #
45 #    'export_svc_pkg' => [
46 #      '_desc' => 'Access to export, service and package configuration',
47 #      'part_export' => {},
48 #      'part_svc'    => {},
49 #      'part_pkg'    => {},
50 #      'pkg_class'   => {},
51 #    ],
52 #
53 #    'billing' => [
54 #      '_desc' => 'Access to billing configuration',
55 #      'payment_gateway'  => {},
56 #      'part_bill_event'  => {},
57 #      'prepay_credit'    => {},
58 #      'rate'             => {},
59 #      'cust_main_county' => {},
60 #    ],
61 #
62 #    'dialup' => [
63 #      '_desc' => 'Access to dialup configuraiton',
64 #      'svc_acct_pop' => {},
65 #    ],
66 #
67 #    'broadband' => [
68 #      '_desc' => 'Access to broadband configuration',
69 #      'router'     => {},
70 #      'addr_block' => {},
71 #    ],
72 #
73 #    'misc' => [
74 #      'part_referral'      => {},
75 #      'part_virtual_field' => {},
76 #      'msgcat'             => {},
77 #      'inventory_class'    => {},
78 #    ],
79 #
80 #  },
81 #
82 #);
83 #
84 ##turn it into a more hash-like structure, but ordered via IxHash
85
86 #well, this is what we have for now.  getting better.
87 tie my %rights, 'Tie::IxHash',
88
89   ###
90   # contact rights
91   ###
92   'Contact and Prospect rights' => [
93     'New prospect',
94     'View prospect',
95     'Edit prospect',
96     'Edit contact', #!
97     #'New contact',
98     #'View customer contacts',
99     'Generate quotation',
100     'Disable quotation',
101   ],
102   
103   ###
104   # basic customer rights
105   ###
106   'Customer rights' => [
107     'New customer',
108     'View customer',
109     #'View Customer | View tickets',
110     'Edit customer',
111     'Edit customer tags',
112     'Edit referring customer',
113     'Edit customer invoice terms',
114     'View customer history',
115     'Suspend customer',
116     'Unsuspend customer',
117     'Cancel customer',
118     'Complimentary customer', #aka users-allow_comp 
119     'Merge customer',
120     'Merge customer across agents',
121     { 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
122     'Bill customer now', #NEW
123     'Bulk send customer notices', #NEW
124     { rightname=>'View customers of all agents', global=>1 },
125   ],
126   
127   ###
128   # customer package rights
129   ###
130   'Customer package rights' => [
131     'View customer packages', #NEW
132     'Order customer package',
133     'One-time charge',
134     'Modify one-time charge',
135     'Change customer package',
136     'Detach 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     'Customize billing during suspension',
150     'Add on-the-fly cancel reason', #NEW
151     'Add on-the-fly suspend reason', #NEW
152     'Edit customer package invoice details', #NEW
153     'Edit customer package comments', #NEW
154     'Qualify service', #NEW
155     'Waive setup fee', #NEW
156     'View appointments', #NEWNEW
157     'Make appointment',
158     'View package definition costs', #NEWNEW
159     'Change package contract end date',
160   ],
161   
162   ###
163   # customer service rights
164   ###
165   'Customer service rights' => [
166     'View customer services', #NEW
167     'Provision customer service',
168     'Bulk provision customer service',
169     'Bulk move customer services', #NEWNEW
170     'Recharge customer service', #NEW
171     'Unprovision customer service',
172     'Change customer service', #NEWNEW
173     'Edit password',
174     'Edit usage', #NEW
175     'Edit home dir', #NEW
176     'Edit www config', #NEW
177     'Edit domain catchall', #NEW
178     'Edit domain nameservice', #NEW
179     'Manage domain registration',
180   
181     { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
182   ],
183   
184   ###
185   # customer invoice/financial info rights
186   ###
187   'Customer invoice / financial info rights' => [
188     'View invoices',
189     'Resend invoices', #NEWNEW
190     { rightname=>'Print and mail invoices', desc=>"Print and mail via Freeside's web service", }, ##NEWER than NEWNEWNEW
191     'Void invoices',
192     'Unvoid invoices',
193     'Delete invoices',
194     'View customer tax exemptions', #yow
195     'Edit customer tax exemptions', #NEWNEW
196     'Add customer tax adjustment', #new, but no need to phase in
197     'View customer batched payments', #NEW
198     'View customer pending payments', #NEW
199     'Edit customer pending payments', #NEW
200     'View customer billing events', #NEW
201     'View legacy typeset statements', #new, but no need to phase in
202   ],
203   
204   ###
205   # customer payment rights
206   ###
207   'Customer payment rights' => [
208     'View payments',
209     { rightname=>'Post payment', desc=>'Make check or cash payments.' },
210     { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
211     'Post check payment',
212     'Post cash payment',
213     'Post payment batch',
214     'Apply payment', #NEWNEW
215     { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
216     { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
217     'Process credit card payment',
218     'Process Echeck payment',
219     { 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.
220   ],
221   
222   ###
223   # customer credit rights
224   ###
225   'Customer credit and refund rights' => [
226     'Post credit',
227     { rightname=>'Backdate credit', desc=>'Enable credits to be posted for days other than today.' },
228     'Credit line items', #NEWNEWNEW
229     'Apply credit', #NEWNEW
230     'Void credit', #NEWER than things marked NEWNEWNEW
231     'Unvoid credit', #NEWER than things marked NEWNEWNEW
232     { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
233     { 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.
234     'View refunds',
235     { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
236     'Post check refund',
237     'Post cash refund',
238 #    { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
239     { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
240     'Refund credit card payment',
241     'Refund Echeck payment',
242     'Delete refund', #NEW
243     'Add on-the-fly credit reason', #NEW
244     'Add on-the-fly void credit reason',
245   ],
246   
247   ###
248   # customer voiding rights..
249   ###
250   'Customer payment void rights' => [
251     { rightname=>'Credit card void', desc=>'Enable local-only voiding of credit card payments in addition to refunds against the payment gateway.' }, #aka. cc-void 
252     { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
253     'Void payments',
254     { rightname=>'Unvoid payments', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid 
255     
256   
257   ],
258  
259   ###
260   # note/attachment rights...
261   ###
262   'Customer note and attachment rights' => [
263     'Add customer note', #NEW
264     'Edit customer note', #NEW
265     'View attachments', #NEW
266     'Browse attachments', #NEW
267     'Download attachment', #NEW
268     'Add attachment', #NEW
269     'Edit attachment', #NEW
270     'Delete attachment', #NEW
271     'View deleted attachments', #NEW
272     'Undelete attachment', #NEW
273     'Purge attachment', #NEW
274   ],
275   
276   ###
277   # report/listing rights...
278   ###
279   'Reporting/listing rights' => [
280     'List prospects',
281     'List contacts',
282     'List customers',
283     'List all customers',
284     'Advanced customer search',
285     'List zip codes', #NEW
286     'List quotations',
287     'List invoices',
288     'List packages',
289     'Summarize packages',
290     'List services',
291     'List service passwords',
292   
293     { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
294     'Billing event reports',
295     'Receivables report',
296     'Basic payment and refund reports',
297     'Financial reports',
298     { rightname=>'Send reports to customers', global=>1 },
299     { rightname=> 'List inventory', global=>1 },
300     { rightname=>'View email logs', global=>1 },
301     { rightname=>'View system logs' },
302
303     'Download report data',
304     'Customers: Customer churn report',
305     'Services: Accounts',
306     'Services: Accounts: Advanced search',
307     'Services: Domains',
308     'Services: Certificates',
309     'Services: Mail forwards',
310     'Services: Virtual hosting services',
311     'Services: Wireless broadband services',
312     'Services: Wireless broadband services: Advanced search',
313     'Services: DSLs',
314     'Services: Cable subscribers',
315     'Services: Dish services',
316     'Services: Hardware',
317     'Services: Hardware: Advanced search',
318     'Services: Phone numbers',
319     'Services: Phone numbers: Advanced search',
320     'Services: PBXs',
321     'Services: Ports',
322     'Services: Mailing lists',
323     'Services: Alarm services',
324     'Services: External services',
325     'Services: Circuits',
326     'Services: Fiber',
327     'Services: Fiber: Advanced search',
328     'Usage: RADIUS sessions',
329     'Usage: Call Detail Records (CDRs)',
330     'Usage: Unrateable CDRs',
331     'Usage: Time worked',
332     { rightname=>'Employees: Commission Report', global=>1 },
333     { rightname=>'Employees: Audit Report', global=>1 },
334
335     #{ rightname => 'List customers of all agents', global=>1 },
336   ],
337   
338   ###
339   # misc rights
340   ###
341   'Miscellaneous rights' => [
342     { rightname=>'Job queue', global=>1 },
343     { rightname=>'Time queue', global=>1 },
344     { rightname=>'Process batches', }, #Process payment batches
345     { rightname=>'Process global batches', global=>1 }, #Process global payment batches
346     { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
347     { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
348     { rightname=>'Process invoice batches', },
349     { rightname=>'Process global invoice batches', global=>1 },
350     { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now?  give em their own ACLs
351     { rightname=>'Export', global=>1 },
352     { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
353   #],
354   #
355   ###
356   # misc misc rights
357   ###
358   #'Database access rights' => [
359     { rightname=>'Raw SQL', global=>1 }, #NEW
360   #]
361
362   #'Employee preference rights' => [
363     { rightname=>'Employee preference telephony integration' },
364   #]
365
366   #'RT preference rights' => [
367     { rightname=>'RT activity notification' },
368   #]
369
370   ],
371   
372   ###
373   # setup/config rights
374   ###
375   'Configuration rights' => [
376     'Edit advertising sources',
377     { rightname=>'Edit global advertising sources', global=>1 },
378
379     'Edit sales people',
380
381     'Edit package definitions',
382     { rightname=>'Edit global package definitions', global=>1 },
383     'Edit package definition costs',
384
385     'Bulk edit package definitions',
386
387     'Edit FCC report configuration',
388     { rightname => 'Edit FCC report configuration for all agents', global=>1 },
389
390     'Edit CDR rates',
391     #{ rightname=>'Edit global CDR rates', global=>1, },
392
393     'Edit fee definitions',
394     { rightname=>'Edit global fee definitions', global=>1 },
395
396     'Edit billing events',
397     { rightname=>'Edit global billing events', global=>1 },
398
399     'View templates',
400     { rightname=>'View global templates', global=>1 },
401     'Edit templates',
402     { rightname=>'Edit global templates', global=>1 },
403
404     'Edit inventory',
405     { rightname=>'Edit global inventory', global=>1 },
406   
407     { rightname=>'Dialup configuration' },
408     { rightname=>'Dialup global configuration', global=>1 },
409
410     { rightname=>'Broadband configuration' },
411     { rightname=>'Broadband global configuration', global=>1 },
412
413     { rightname=>'Alarm configuration' },
414     { rightname=>'Alarm global configuration', global=>1 },
415
416     { rightname=> 'Configure network monitoring', global=>1 },
417
418     #{ rightname=>'Edit employees', global=>1, },
419     #{ rightname=>'Edit employee groupss', global=>1, },
420
421     { rightname=>'Edit custom fields', global=>1 },
422
423     { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
424
425     { rightname=>'Configuration download', }, #description of how it affects
426                                               #search/elements/search.html
427
428   ],
429   
430 ;
431   
432 =head1 CLASS METHODS
433   
434 =over 4
435   
436 =item rights
437
438 Returns the full list of right names.
439
440 =cut
441   
442 sub rights {
443   #my $class = shift;
444   map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
445 }
446
447 =item default_superuser_rights
448
449 Most (but not all) right names.
450
451 =cut
452
453 sub default_superuser_rights {
454   my $class = shift;
455   my %omit = map { $_=>1 } (
456     'Delete customer',
457     'Delete invoices',
458     'Delete payment',
459     'Delete credit', #?
460     'Delete refund', #?
461     'Edit customer package dates',
462     'Time queue',
463     'Usage: Time worked',
464     'Redownload resolved batches',
465     'Raw SQL',
466     'Configuration download',
467     'View customers of all agents',
468     'View/link unlinked services',
469     'Edit usage',
470     'Credit card void',
471     'Echeck void',
472     'Void invoices',#people are overusing this when credits are more appropriate
473     'Backdate credit',
474     'View legacy typeset statments',
475   );
476
477   no warnings 'uninitialized';
478   grep { ! $omit{$_} } $class->rights;
479 }
480   
481 =item rights_info
482
483 Returns a list of key-value pairs suitable for assigning to a hash.  Keys are
484 category names and values are list references of rights.  Each element of the
485 list reference scalar right name or a hashref with the following keys:
486
487 =over 4
488
489 =item rightname - Right name
490
491 =item desc - Extended right description
492
493 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
494
495 =back
496
497 =cut
498
499 sub rights_info {
500   %rights;
501 }
502
503 =back
504
505 =head1 BUGS
506
507 Damn those infernal six-legged creatures!
508
509 =head1 SEE ALSO
510
511 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>
512
513 =cut
514
515 1;
516