Merge branch 'patch-3' of https://github.com/gjones2/Freeside (fix closing tag)
[freeside.git] / FS / FS / AccessRight.pm
index 17d2d76..66624e1 100644 (file)
@@ -85,6 +85,21 @@ assigned to users and/or groups.
 
 #well, this is what we have for now.  getting better.
 tie my %rights, 'Tie::IxHash',
 
 #well, this is what we have for now.  getting better.
 tie my %rights, 'Tie::IxHash',
+
+  ###
+  # contact rights
+  ###
+  'Contact and Prospect rights' => [
+    'New prospect',
+    'View prospect',
+    'Edit prospect',
+    'List prospects',
+    'Edit contact', #!
+    #'New contact',
+    #'View customer contacts',
+    #'List contacts',
+    'Generate quotation',
+  ],
   
   ###
   # basic customer rights
   
   ###
   # basic customer rights
@@ -94,21 +109,19 @@ tie my %rights, 'Tie::IxHash',
     'View customer',
     #'View Customer | View tickets',
     'Edit customer',
     'View customer',
     #'View Customer | View tickets',
     'Edit customer',
+    'Edit customer tags',
+    'Edit referring customer',
     'View customer history',
     'View customer history',
+    'Suspend customer',
+    'Unsuspend customer',
     'Cancel customer',
     'Complimentary customer', #aka users-allow_comp 
     'Cancel customer',
     'Complimentary customer', #aka users-allow_comp 
+    'Merge customer',
+    'Merge customer across agents',
     { 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
     { 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
-    'Add customer note', #NEW
-    'Edit customer note', #NEW
-    'Download attachment', #NEW
-    'Add attachment', #NEW
-    'Edit attachment', #NEW
-    'Delete attachment', #NEW
-    'View deleted attachments', #NEW
-    'Undelete attachment', #NEW
-    'Purge attachment', #NEW
     'Bill customer now', #NEW
     'Bulk send customer notices', #NEW
     'Bill customer now', #NEW
     'Bulk send customer notices', #NEW
+    { rightname=>'View customers of all agents', global=>1 },
   ],
   
   ###
   ],
   
   ###
@@ -121,17 +134,22 @@ tie my %rights, 'Tie::IxHash',
     'Change customer package',
     'Bulk change customer packages',
     'Edit customer package dates',
     'Change customer package',
     'Bulk change customer packages',
     'Edit customer package dates',
+    'Discount customer package', #NEW
+    'Custom discount customer package', #NEW
     'Customize customer package',
     'Suspend customer package',
     'Suspend customer package later',
     'Unsuspend customer package',
     'Cancel customer package immediately',
     'Cancel customer package later',
     'Customize customer package',
     'Suspend customer package',
     'Suspend customer package later',
     'Unsuspend customer package',
     'Cancel customer package immediately',
     'Cancel customer package later',
+    'Un-cancel customer package',
     'Delay suspension events',
     'Add on-the-fly cancel reason', #NEW
     'Add on-the-fly suspend reason', #NEW
     'Edit customer package invoice details', #NEW
     'Edit customer package comments', #NEW
     'Delay suspension events',
     'Add on-the-fly cancel reason', #NEW
     'Add on-the-fly suspend reason', #NEW
     'Edit customer package invoice details', #NEW
     'Edit customer package comments', #NEW
+    'Qualify service', #NEW
+    'Waive setup fee', #NEW
   ],
   
   ###
   ],
   
   ###
@@ -140,6 +158,7 @@ tie my %rights, 'Tie::IxHash',
   'Customer service rights' => [
     'View customer services', #NEW
     'Provision customer service',
   'Customer service rights' => [
     'View customer services', #NEW
     'Provision customer service',
+    'Bulk provision customer service',
     'Recharge customer service', #NEW
     'Unprovision customer service',
     'Change customer service', #NEWNEW
     'Recharge customer service', #NEW
     'Unprovision customer service',
     'Change customer service', #NEWNEW
@@ -159,6 +178,9 @@ tie my %rights, 'Tie::IxHash',
   'Customer invoice / financial info rights' => [
     'View invoices',
     'Resend invoices', #NEWNEW
   'Customer invoice / financial info rights' => [
     'View invoices',
     'Resend invoices', #NEWNEW
+    'Void invoices',
+    'Unvoid invoices',
+    'Delete invoices',
     'View customer tax exemptions', #yow
     'Add customer tax adjustment', #new, but no need to phase in
     'View customer batched payments', #NEW
     'View customer tax exemptions', #yow
     'Add customer tax adjustment', #new, but no need to phase in
     'View customer batched payments', #NEW
@@ -171,15 +193,18 @@ tie my %rights, 'Tie::IxHash',
   # customer payment rights
   ###
   'Customer payment rights' => [
   # customer payment rights
   ###
   'Customer payment rights' => [
-    'Post payment',
+    'View payments',
+    { rightname=>'Post payment', desc=>'Make check or cash payments.' },
+    { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
+    'Post check payment',
+    'Post cash payment',
     'Post payment batch',
     'Apply payment', #NEWNEW
     { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
     'Post payment batch',
     'Apply payment', #NEWNEW
     { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
-    'Process payment',
-    { rightname=>'Refund payment', desc=>'Enable refund of existing customer payments.' },
-
+    { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
+    'Process credit card payment',
+    'Process Echeck payment',
     { 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.
     { 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.
-  
   ],
   
   ###
   ],
   
   ###
@@ -190,8 +215,14 @@ tie my %rights, 'Tie::IxHash',
     'Apply credit', #NEWNEW
     { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
     { 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.
     'Apply credit', #NEWNEW
     { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
     { 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.
+    'View refunds',
     { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
     { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
+    'Post check refund',
+    'Post cash refund',
 #    { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
 #    { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
+    { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
+    'Refund credit card payment',
+    'Refund Echeck payment',
     'Delete refund', #NEW
     'Add on-the-fly credit reason', #NEW
   ],
     'Delete refund', #NEW
     'Add on-the-fly credit reason', #NEW
   ],
@@ -199,29 +230,79 @@ tie my %rights, 'Tie::IxHash',
   ###
   # customer voiding rights..
   ###
   ###
   # customer voiding rights..
   ###
-  'Customer void rights' => [
+  'Customer payment void rights' => [
     { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void 
     { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
     { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void 
     { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
-    'Regular void',
-    { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid 
+    'Void payments',
+    { rightname=>'Unvoid payments', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid 
     
   
   ],
     
   
   ],
+  ###
+  # note/attachment rights...
+  ###
+  'Customer note and attachment rights' => [
+    'Add customer note', #NEW
+    'Edit customer note', #NEW
+    'View attachments', #NEW
+    'Browse attachments', #NEW
+    'Download attachment', #NEW
+    'Add attachment', #NEW
+    'Edit attachment', #NEW
+    'Delete attachment', #NEW
+    'View deleted attachments', #NEW
+    'Undelete attachment', #NEW
+    'Purge attachment', #NEW
+  ],
   
   ###
   # report/listing rights...
   ###
   'Reporting/listing rights' => [
     'List customers',
   
   ###
   # report/listing rights...
   ###
   'Reporting/listing rights' => [
     'List customers',
+    'List all customers',
+    'Advanced customer search',
     'List zip codes', #NEW
     'List zip codes', #NEW
+    'List quotations',
     'List invoices',
     'List packages',
     'List invoices',
     'List packages',
+    'Summarize packages',
     'List services',
     'List services',
+    'List service passwords',
   
     { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
     'Billing event reports',
     'Receivables report',
     'Financial reports',
   
     { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
     'Billing event reports',
     'Receivables report',
     'Financial reports',
+    { rightname=> 'List inventory', global=>1 },
+    { rightname=>'View email logs', global=>1 },
+    { rightname=>'View system logs' },
+
+    'Download report data',
+    'Services: Accounts',
+    'Services: Accounts: Advanced search',
+    'Services: Domains',
+    'Services: Certificates',
+    'Services: Mail forwards',
+    'Services: Virtual hosting services',
+    'Services: Wireless broadband services',
+    'Services: Wireless broadband services: Advanced search',
+    'Services: DSLs',
+    'Services: Dish services',
+    'Services: Hardware',
+    'Services: Hardware: Advanced search',
+    'Services: Phone numbers',
+    'Services: PBXs',
+    'Services: Ports',
+    'Services: Mailing lists',
+    'Services: External services',
+    'Usage: RADIUS sessions',
+    'Usage: Call Detail Records (CDRs)',
+    'Usage: Unrateable CDRs',
+    'Usage: Time worked',
+
+    #{ rightname => 'List customers of all agents', global=>1 },
   ],
   
   ###
   ],
   
   ###
@@ -230,9 +311,12 @@ tie my %rights, 'Tie::IxHash',
   'Miscellaneous rights' => [
     { rightname=>'Job queue', global=>1 },
     { rightname=>'Time queue', global=>1 },
   'Miscellaneous rights' => [
     { rightname=>'Job queue', global=>1 },
     { rightname=>'Time queue', global=>1 },
-    { rightname=>'Process batches', global=>1 },
-    { rightname=>'Reprocess batches', global=>1 },
-    { rightname=>'Redownload resolved batches', global=>1 },
+    { rightname=>'Process batches', }, #Process payment batches
+    { rightname=>'Process global batches', global=>1 }, #Process global payment batches
+    { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
+    { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
+    { rightname=>'Process invoice batches', },
+    { rightname=>'Process global invoice batches', global=>1 },
     { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now?  give em their own ACLs
     { rightname=>'Export', global=>1 },
     { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
     { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now?  give em their own ACLs
     { rightname=>'Export', global=>1 },
     { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
@@ -257,12 +341,25 @@ tie my %rights, 'Tie::IxHash',
   
     'Edit billing events',
     { rightname=>'Edit global billing events', global=>1 },
   
     'Edit billing events',
     { rightname=>'Edit global billing events', global=>1 },
+
+    'View templates',
+    { rightname=>'View global templates', global=>1 },
+    'Edit templates',
+    { rightname=>'Edit global templates', global=>1 },
+
+    'Edit inventory',
+    { rightname=>'Edit global inventory', global=>1 },
   
     { rightname=>'Dialup configuration' },
     { rightname=>'Dialup global configuration', global=>1 },
 
     { rightname=>'Broadband configuration' },
     { rightname=>'Broadband global configuration', global=>1 },
   
     { rightname=>'Dialup configuration' },
     { rightname=>'Dialup global configuration', global=>1 },
 
     { rightname=>'Broadband configuration' },
     { rightname=>'Broadband global configuration', global=>1 },
+    
+    { rightname=> 'Configure network monitoring', global=>1 },
+
+    #{ rightname=>'Edit employees', global=>1, },
+    #{ rightname=>'Edit employee groupss', global=>1, },
 
     { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
 
 
     { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
 
@@ -279,14 +376,46 @@ tie my %rights, 'Tie::IxHash',
   
 =item rights
 
   
 =item rights
 
-Returns a list of right names.
+Returns the full list of right names.
 
 =cut
   
 
 =cut
   
-  sub rights {
+sub rights {
   #my $class = shift;
   map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
   #my $class = shift;
   map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
-  }
+}
+
+=item default_superuser_rights
+
+Most (but not all) right names.
+
+=cut
+
+sub default_superuser_rights {
+  my $class = shift;
+  my %omit = map { $_=>1 } (
+    'Delete customer',
+    'Delete invoices',
+    'Delete payment',
+    'Delete credit', #?
+    'Delete refund', #?
+    'Edit customer package dates',
+    'Time queue',
+    'Usage: Time worked',
+    'Redownload resolved batches',
+    'Raw SQL',
+    'Configuration download',
+    'View customers of all agents',
+    'View/link unlinked services',
+    'Edit usage',
+    'Credit card void',
+    'Echeck void',
+    'Edit customer package dates',
+  );
+
+  no warnings 'uninitialized';
+  grep { ! $omit{$_} } $class->rights;
+}
   
 =item rights_info
 
   
 =item rights_info