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   ],
 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 basics',
 112     'Edit customer tags',
 113     'Edit referring customer',
 114     'Edit customer addresses',
 115     'Edit customer billing information',
 116     'View customer history',
 117     'Suspend customer',
 118     'Unsuspend customer',
 119     'Cancel customer',
 120     'Complimentary customer', #aka users-allow_comp
 121     'Merge customer',
 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 },
 127   ],
 128
 129   ###
 130   # customer package rights
 131   ###
 132   'Customer package rights' => [
 133     'View customer packages', #NEW
 134     'Order customer package',
 135     'One-time charge',
 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
 155   ],
 156
 157   ###
 158   # customer service rights
 159   ###
 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
 167     'Edit password',
 168     'Edit usage', #NEW
 169     'Edit home dir', #NEW
 170     'Edit www config', #NEW
 171     'Edit domain catchall', #NEW
 172     'Edit domain nameservice', #NEW
 173     'Manage domain registration',
 174
 175     { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
 176   ],
 177
 178   ###
 179   # customer invoice/financial info rights
 180   ###
 181   'Customer invoice / financial info rights' => [
 182     'View invoices',
 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
 192   ],
 193
 194   ###
 195   # customer payment rights
 196   ###
 197   'Customer payment rights' => [
 198     'View payments',
 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',
 202     'Post cash 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.
 210   ],
 211
 212   ###
 213   # customer credit rights
 214   ###
 215   'Customer credit and refund rights' => [
 216     'Post credit',
 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.
 221     'View refunds',
 222     { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
 223     'Post check refund',
 224     'Post cash refund',
 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
 231   ],
 232
 233   ###
 234   # customer voiding rights..
 235   ###
 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
 239     'Regular void',
 240     { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
 241
 242
 243   ],
 244
 245   ###
 246   # note/attachment rights...
 247   ###
 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
 260   ],
 261
 262   ###
 263   # report/listing rights...
 264   ###
 265   'Reporting/listing rights' => [
 266     'List customers',
 267     'List all customers',
 268     'Advanced customer search',
 269     'List zip codes', #NEW
 270     'List invoices',
 271     'List packages',
 272     'Summarize packages',
 273     'List services',
 274     'List service passwords',
 275
 276     { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
 277     'Billing event reports',
 278     'Receivables report',
 279     'Financial reports',
 280     { rightname=> 'List inventory', global=>1 },
 281     { rightname=>'View email logs', global=>1 },
 282     { rightname=>'View system logs' },
 283
 284     'Download report data',
 285     'Services: Accounts',
 286     'Services: Accounts: Advanced search',
 287     'Services: Domains',
 288     'Services: Certificates',
 289     'Services: Mail forwards',
 290     'Services: Virtual hosting services',
 291     'Services: Wireless broadband services',
 292     'Services: Wireless broadband services: Advanced search',
 293     'Services: DSLs',
 294     'Services: Dish services',
 295     'Services: Hardware',
 296     'Services: Hardware: Advanced search',
 297     'Services: Phone numbers',
 298     'Services: Phone numbers: Advanced search',
 299     'Services: PBXs',
 300     'Services: Ports',
 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',
 307     { rightname=>'Employees: Commission Report', global=>1 },
 308     { rightname=>'Employees: Audit Report', global=>1 },
 309
 310     #{ rightname => 'List customers of all agents', global=>1 },
 311   ],
 312
 313   ###
 314   # misc rights
 315   ###
 316   'Miscellaneous rights' => [
 317     { rightname=>'Job queue', global=>1 },
 318     { rightname=>'Time queue', global=>1 },
 319     { rightname=>'Process batches', }, #Process payment batches
 320     { rightname=>'Process global batches', global=>1 }, #Process global payment batches
 321     { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
 322     { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
 323     { rightname=>'Process invoice batches', },
 324     { rightname=>'Process global invoice batches', global=>1 },
 325     { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now?  give em their own ACLs
 326     { rightname=>'Export', global=>1 },
 327     { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
 328   #],
 329   #
 330   ###
 331   # misc misc rights
 332   ###
 333   #'Database access rights' => [
 334     { rightname=>'Raw SQL', global=>1 }, #NEW
 335   ],
 336
 337   ###
 338   # setup/config rights
 339   ###
 340   'Configuration rights' => [
 341     'Edit advertising sources',
 342     { rightname=>'Edit global advertising sources', global=>1 },
 343
 344     'Edit package definitions',
 345     { rightname=>'Edit global package definitions', global=>1 },
 346
 347     'Bulk edit package definitions',
 348
 349     'Edit billing events',
 350     { rightname=>'Edit global billing events', global=>1 },
 351
 352     'View templates',
 353     { rightname=>'View global templates', global=>1 },
 354     'Edit templates',
 355     { rightname=>'Edit global templates', global=>1 },
 356
 357     'Edit inventory',
 358     { rightname=>'Edit global inventory', global=>1 },
 359
 360     { rightname=>'Dialup configuration' },
 361     { rightname=>'Dialup global configuration', global=>1 },
 362
 363     { rightname=>'Broadband configuration' },
 364     { rightname=>'Broadband global configuration', global=>1 },
 365
 366     { rightname=> 'Configure network monitoring', global=>1 },
 367
 368     #{ rightname=>'Edit employees', global=>1, },
 369     #{ rightname=>'Edit employee groupss', global=>1, },
 370
 371     { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
 372
 373     { rightname=>'Configuration download', }, #description of how it affects
 374                                               #search/elements/search.html
 375
 376   ],
 377
 378 ;
 379
 380 =head1 CLASS METHODS
 381
 382 =over 4
 383
 384 =item rights
 385
 386 Returns the full list of right names.
 387
 388 =cut
 389
 390 sub rights {
 391   #my $class = shift;
 392   map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
 393 }
 394
 395 =item default_superuser_rights
 396
 397 Most (but not all) right names.
 398
 399 =cut
 400
 401 sub default_superuser_rights {
 402   my $class = shift;
 403   my %omit = map { $_=>1 } (
 404     'Delete customer',
 405     'Delete invoices',
 406     'Delete payment',
 407     'Delete credit', #?
 408     'Delete refund', #?
 409     'Edit customer package dates',
 410     'Time queue',
 411     'Usage: Time worked',
 412     'Redownload resolved batches',
 413     'Raw SQL',
 414     'Configuration download',
 415     'View customers of all agents',
 416     'View/link unlinked services',
 417     'Edit usage',
 418     'Credit card void',
 419     'Echeck void',
 420     'Edit customer package dates',
 421   );
 422
 423   no warnings 'uninitialized';
 424   grep { ! $omit{$_} } $class->rights;
 425 }
 426
 427 =item rights_info
 428
 429 Returns a list of key-value pairs suitable for assigning to a hash.  Keys are
 430 category names and values are list references of rights.  Each element of the
 431 list reference scalar right name or a hashref with the following keys:
 432
 433 =over 4
 434
 435 =item rightname - Right name
 436
 437 =item desc - Extended right description
 438
 439 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
 440
 441 =back
 442
 443 =cut
 444
 445 sub rights_info {
 446   %rights;
 447 }
 448
 449 =back
 450
 451 =head1 BUGS
 452
 453 Damn those infernal six-legged creatures!
 454
 455 =head1 SEE ALSO
 456
 457 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>
 458
 459 =cut
 460
 461 1;
 462