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     'List prospects',
  97     'Edit contact', #!
  98     #'New contact',
  99     #'View customer contacts',
 100     #'List contacts',
 101     'Generate quotation',
 102   ],
 103
 104   ###
 105   # basic customer rights
 106   ###
 107   'Customer rights' => [
 108     'New customer',
 109     'View customer',
 110     #'View Customer | View tickets',
 111     'Edit customer',
 112     'Edit customer tags',
 113     'Edit referring customer',
 114     'View customer history',
 115     'Suspend customer',
 116     'Unsuspend customer',
 117     'Cancel customer',
 118     'Complimentary customer', #aka users-allow_comp
 119     'Merge customer',
 120     { 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
 121     'Bill customer now', #NEW
 122     'Bulk send customer notices', #NEW
 123     { rightname=>'View customers of all agents', global=>1 },
 124   ],
 125
 126   ###
 127   # customer package rights
 128   ###
 129   'Customer package rights' => [
 130     'View customer packages', #NEW
 131     'Order customer package',
 132     'One-time charge',
 133     'Change 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   ],
 153
 154   ###
 155   # customer service rights
 156   ###
 157   'Customer service rights' => [
 158     'View customer services', #NEW
 159     'Provision customer service',
 160     'Bulk provision customer service',
 161     'Recharge customer service', #NEW
 162     'Unprovision customer service',
 163     'Change customer service', #NEWNEW
 164     'Edit usage', #NEW
 165     'Edit home dir', #NEW
 166     'Edit www config', #NEW
 167     'Edit domain catchall', #NEW
 168     'Edit domain nameservice', #NEW
 169     'Manage domain registration',
 170
 171     { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
 172   ],
 173
 174   ###
 175   # customer invoice/financial info rights
 176   ###
 177   'Customer invoice / financial info rights' => [
 178     'View invoices',
 179     'Resend invoices', #NEWNEW
 180     'Delete invoices', #new, but no need to phase in
 181     'View customer tax exemptions', #yow
 182     'Add customer tax adjustment', #new, but no need to phase in
 183     'View customer batched payments', #NEW
 184     'View customer pending payments', #NEW
 185     'Edit customer pending payments', #NEW
 186     'View customer billing events', #NEW
 187   ],
 188
 189   ###
 190   # customer payment rights
 191   ###
 192   'Customer payment rights' => [
 193     'View payments',
 194     { rightname=>'Post payment', desc=>'Make check or cash payments.' },
 195     { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
 196     'Post check payment',
 197     'Post cash payment',
 198     'Post payment batch',
 199     'Apply payment', #NEWNEW
 200     { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
 201     { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
 202     'Process credit card payment',
 203     'Process Echeck payment',
 204     { 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.
 205   ],
 206
 207   ###
 208   # customer credit rights
 209   ###
 210   'Customer credit and refund rights' => [
 211     'Post credit',
 212     'Apply credit', #NEWNEW
 213     { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
 214     { 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.
 215     'View refunds',
 216     { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
 217     'Post check refund',
 218     'Post cash refund',
 219 #    { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
 220     { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
 221     'Refund credit card payment',
 222     'Refund Echeck payment',
 223     'Delete refund', #NEW
 224     'Add on-the-fly credit reason', #NEW
 225   ],
 226
 227   ###
 228   # customer voiding rights..
 229   ###
 230   'Customer void rights' => [
 231     { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
 232     { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
 233     'Regular void',
 234     { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
 235
 236
 237   ],
 238
 239   ###
 240   # note/attachment rights...
 241   ###
 242   'Customer note and attachment rights' => [
 243     'Add customer note', #NEW
 244     'Edit customer note', #NEW
 245     'View attachments', #NEW
 246     'Browse attachments', #NEW
 247     'Download attachment', #NEW
 248     'Add attachment', #NEW
 249     'Edit attachment', #NEW
 250     'Delete attachment', #NEW
 251     'View deleted attachments', #NEW
 252     'Undelete attachment', #NEW
 253     'Purge attachment', #NEW
 254   ],
 255
 256   ###
 257   # report/listing rights...
 258   ###
 259   'Reporting/listing rights' => [
 260     'List customers',
 261     'List all customers',
 262     'Advanced customer search',
 263     'List zip codes', #NEW
 264     'List invoices',
 265     'List packages',
 266     'Summarize packages',
 267     'List services',
 268     'List service passwords',
 269
 270     { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
 271     'Billing event reports',
 272     'Receivables report',
 273     'Financial reports',
 274     { rightname=> 'List inventory', global=>1 },
 275     { rightname=>'View email logs', global=>1 },
 276
 277     'Download report data',
 278     'Services: Accounts',
 279     'Services: Accounts: Advanced search',
 280     'Services: Domains',
 281     'Services: Certificates',
 282     'Services: Mail forwards',
 283     'Services: Virtual hosting services',
 284     'Services: Wireless broadband services',
 285     'Services: Wireless broadband services: Advanced search',
 286     'Services: DSLs',
 287     'Services: Dish services',
 288     'Services: Hardware',
 289     'Services: Hardware: Advanced search',
 290     'Services: Phone numbers',
 291     'Services: PBXs',
 292     'Services: Ports',
 293     'Services: Mailing lists',
 294     'Services: External services',
 295     'Usage: RADIUS sessions',
 296     'Usage: Call Detail Records (CDRs)',
 297     'Usage: Unrateable CDRs',
 298     'Usage: Time worked',
 299
 300     #{ rightname => 'List customers of all agents', global=>1 },
 301   ],
 302
 303   ###
 304   # misc rights
 305   ###
 306   'Miscellaneous rights' => [
 307     { rightname=>'Job queue', global=>1 },
 308     { rightname=>'Time queue', global=>1 },
 309     { rightname=>'Process batches', }, #Process payment batches
 310     { rightname=>'Process global batches', global=>1 }, #Process global payment batches
 311     { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
 312     { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
 313     { rightname=>'Process invoice batches', },
 314     { rightname=>'Process global invoice batches', global=>1 },
 315     { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now?  give em their own ACLs
 316     { rightname=>'Export', global=>1 },
 317     { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
 318   #],
 319   #
 320   ###
 321   # misc misc rights
 322   ###
 323   #'Database access rights' => [
 324     { rightname=>'Raw SQL', global=>1 }, #NEW
 325   ],
 326
 327   ###
 328   # setup/config rights
 329   ###
 330   'Configuration rights' => [
 331     'Edit advertising sources',
 332     { rightname=>'Edit global advertising sources', global=>1 },
 333
 334     'Edit package definitions',
 335     { rightname=>'Edit global package definitions', global=>1 },
 336
 337     'Edit billing events',
 338     { rightname=>'Edit global billing events', global=>1 },
 339
 340     'View templates',
 341     { rightname=>'View global templates', global=>1 },
 342     'Edit templates',
 343     { rightname=>'Edit global templates', global=>1 },
 344
 345     'Edit inventory',
 346     { rightname=>'Edit global inventory', global=>1 },
 347
 348     { rightname=>'Dialup configuration' },
 349     { rightname=>'Dialup global configuration', global=>1 },
 350
 351     { rightname=>'Broadband configuration' },
 352     { rightname=>'Broadband global configuration', global=>1 },
 353
 354     { rightname=> 'Configure network monitoring', global=>1 },
 355
 356     #{ rightname=>'Edit employees', global=>1, },
 357     #{ rightname=>'Edit employee groupss', global=>1, },
 358
 359     { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
 360
 361     { rightname=>'Configuration download', }, #description of how it affects
 362                                               #search/elements/search.html
 363
 364   ],
 365
 366 ;
 367
 368 =head1 CLASS METHODS
 369
 370 =over 4
 371
 372 =item rights
 373
 374 Returns the full list of right names.
 375
 376 =cut
 377
 378 sub rights {
 379   #my $class = shift;
 380   map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
 381 }
 382
 383 =item default_superuser_rights
 384
 385 Most (but not all) right names.
 386
 387 =cut
 388
 389 sub default_superuser_rights {
 390   my $class = shift;
 391   my %omit = map { $_=>1 } (
 392     'Delete customer',
 393     'Delete invoices',
 394     'Delete payment',
 395     'Delete credit', #?
 396     'Delete refund', #?
 397     'Edit customer package dates',
 398     'Time queue',
 399     'Redownload resolved batches',
 400     'Raw SQL',
 401     'Configuration download',
 402     'View customers of all agents',
 403     'View/link unlinked services',
 404     'Edit usage',
 405     'Credit card void',
 406     'Echeck void',
 407   );
 408
 409   no warnings 'uninitialized';
 410   grep { ! $omit{$_} } $class->rights;
 411 }
 412
 413 =item rights_info
 414
 415 Returns a list of key-value pairs suitable for assigning to a hash.  Keys are
 416 category names and values are list references of rights.  Each element of the
 417 list reference scalar right name or a hashref with the following keys:
 418
 419 =over 4
 420
 421 =item rightname - Right name
 422
 423 =item desc - Extended right description
 424
 425 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
 426
 427 =back
 428
 429 =cut
 430
 431 sub rights_info {
 432   %rights;
 433 }
 434
 435 =back
 436
 437 =head1 BUGS
 438
 439 Damn those infernal six-legged creatures!
 440
 441 =head1 SEE ALSO
 442
 443 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>
 444
 445 =cut
 446
 447 1;
 448