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     'Merge customer across agents',
 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     'Modify one-time charge',
 134     'Change customer package',
 135     'Detach customer package',
 136     'Bulk change customer packages',
 137     'Edit customer package dates',
 138     'Discount customer package', #NEW
 139     'Custom discount customer package', #NEW
 140     'Customize customer package',
 141     'Suspend customer package',
 142     'Suspend customer package later',
 143     'Unsuspend customer package',
 144     'Cancel customer package immediately',
 145     'Cancel customer package later',
 146     'Un-cancel customer package',
 147     'Delay suspension events',
 148     'Add on-the-fly cancel reason', #NEW
 149     'Add on-the-fly suspend reason', #NEW
 150     'Edit customer package invoice details', #NEW
 151     'Edit customer package comments', #NEW
 152     'Qualify service', #NEW
 153     'Waive setup fee', #NEW
 154   ],
 155
 156   ###
 157   # customer service rights
 158   ###
 159   'Customer service rights' => [
 160     'View customer services', #NEW
 161     'Provision customer service',
 162     'Bulk provision customer service',
 163     'Bulk move customer services', #NEWNEW
 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     'Void invoices',
 185     'Unvoid invoices',
 186     'Delete invoices',
 187     'View customer tax exemptions', #yow
 188     'Edit customer tax exemptions', #NEWNEW
 189     'Add customer tax adjustment', #new, but no need to phase in
 190     'View customer batched payments', #NEW
 191     'View customer pending payments', #NEW
 192     'Edit customer pending payments', #NEW
 193     'View customer billing events', #NEW
 194   ],
 195
 196   ###
 197   # customer payment rights
 198   ###
 199   'Customer payment rights' => [
 200     'View payments',
 201     { rightname=>'Post payment', desc=>'Make check or cash payments.' },
 202     { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
 203     'Post check payment',
 204     'Post cash payment',
 205     'Post payment batch',
 206     'Apply payment', #NEWNEW
 207     { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
 208     { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
 209     'Process credit card payment',
 210     'Process Echeck payment',
 211     { 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.
 212   ],
 213
 214   ###
 215   # customer credit rights
 216   ###
 217   'Customer credit and refund rights' => [
 218     'Post credit',
 219     'Credit line items', #NEWNEWNEW
 220     'Apply credit', #NEWNEW
 221     { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
 222     { 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.
 223     'View refunds',
 224     { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
 225     'Post check refund',
 226     'Post cash refund',
 227 #    { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
 228     { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
 229     'Refund credit card payment',
 230     'Refund Echeck payment',
 231     'Delete refund', #NEW
 232     'Add on-the-fly credit reason', #NEW
 233     'Add on-the-fly refund reason', #NEW
 234   ],
 235
 236   ###
 237   # customer voiding rights..
 238   ###
 239   'Customer payment void rights' => [
 240     { rightname=>'Credit card void', desc=>'Enable local-only voiding of credit card payments in addition to refunds against the payment gateway.' }, #aka. cc-void
 241     { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
 242     'Void payments',
 243     { rightname=>'Unvoid payments', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
 244
 245
 246   ],
 247
 248   ###
 249   # note/attachment rights...
 250   ###
 251   'Customer note and attachment rights' => [
 252     'Add customer note', #NEW
 253     'Edit customer note', #NEW
 254     'View attachments', #NEW
 255     'Browse attachments', #NEW
 256     'Download attachment', #NEW
 257     'Add attachment', #NEW
 258     'Edit attachment', #NEW
 259     'Delete attachment', #NEW
 260     'View deleted attachments', #NEW
 261     'Undelete attachment', #NEW
 262     'Purge attachment', #NEW
 263   ],
 264
 265   ###
 266   # report/listing rights...
 267   ###
 268   'Reporting/listing rights' => [
 269     'List customers',
 270     'List all customers',
 271     'Advanced customer search',
 272     'List zip codes', #NEW
 273     'List quotations',
 274     'List invoices',
 275     'List packages',
 276     'Summarize packages',
 277     'List services',
 278     'List service passwords',
 279
 280     { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
 281     'Billing event reports',
 282     'Receivables report',
 283     'Financial reports',
 284     { rightname=> 'List inventory', global=>1 },
 285     { rightname=>'View email logs', global=>1 },
 286     { rightname=>'View system logs' },
 287
 288     'Download report data',
 289     'Services: Accounts',
 290     'Services: Accounts: Advanced search',
 291     'Services: Domains',
 292     'Services: Certificates',
 293     'Services: Mail forwards',
 294     'Services: Virtual hosting services',
 295     'Services: Wireless broadband services',
 296     'Services: Wireless broadband services: Advanced search',
 297     'Services: DSLs',
 298     'Services: Cable subscribers',
 299     'Services: Conferencing',
 300     'Services: Dish services',
 301     'Services: Hardware',
 302     'Services: Hardware: Advanced search',
 303     'Services: Phone numbers',
 304     'Services: Phone numbers: Advanced search',
 305     'Services: PBXs',
 306     'Services: Ports',
 307     'Services: Mailing lists',
 308     'Services: Alarm services',
 309     'Services: Video',
 310     'Services: External services',
 311     'Usage: RADIUS sessions',
 312     'Usage: Call Detail Records (CDRs)',
 313     'Usage: Unrateable CDRs',
 314     'Usage: Time worked',
 315     #gone in 4.x as a distinct ACL (for now?) { rightname=>'Employees: Commission Report', global=>1 },
 316     { rightname=>'Employees: Audit Report', global=>1 },
 317
 318     #{ rightname => 'List customers of all agents', global=>1 },
 319   ],
 320
 321   ###
 322   # misc rights
 323   ###
 324   'Miscellaneous rights' => [
 325     { rightname=>'Job queue', global=>1 },
 326     { rightname=>'Time queue', global=>1 },
 327     { rightname=>'Process batches', }, #Process payment batches
 328     { rightname=>'Process global batches', global=>1 }, #Process global payment batches
 329     { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
 330     { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
 331     { rightname=>'Process invoice batches', },
 332     { rightname=>'Process global invoice batches', global=>1 },
 333     { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now?  give em their own ACLs
 334     { rightname=>'Export', global=>1 },
 335     { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
 336   #],
 337   #
 338   ###
 339   # misc misc rights
 340   ###
 341   #'Database access rights' => [
 342     { rightname=>'Raw SQL', global=>1 }, #NEW
 343   ],
 344
 345   ###
 346   # setup/config rights
 347   ###
 348   'Configuration rights' => [
 349     'Edit advertising sources',
 350     { rightname=>'Edit global advertising sources', global=>1 },
 351
 352     'Edit sales people',
 353
 354     'Edit package definitions',
 355     { rightname=>'Edit global package definitions', global=>1 },
 356     'Edit package definition costs',
 357
 358     'Bulk edit package definitions',
 359
 360     'Edit fee definitions',
 361     { rightname=>'Edit global fee definitions', global=>1 },
 362
 363     'Edit billing events',
 364     { rightname=>'Edit global billing events', global=>1 },
 365
 366     'View templates',
 367     { rightname=>'View global templates', global=>1 },
 368     'Edit templates',
 369     { rightname=>'Edit global templates', global=>1 },
 370
 371     'Edit inventory',
 372     { rightname=>'Edit global inventory', global=>1 },
 373
 374     { rightname=>'Dialup configuration' },
 375     { rightname=>'Dialup global configuration', global=>1 },
 376
 377     { rightname=>'Broadband configuration' },
 378     { rightname=>'Broadband global configuration', global=>1 },
 379
 380     { rightname=>'Alarm configuration' },
 381     { rightname=>'Alarm global configuration', global=>1 },
 382
 383     { rightname=> 'Configure network monitoring', global=>1 },
 384
 385     #{ rightname=>'Edit employees', global=>1, },
 386     #{ rightname=>'Edit employee groupss', global=>1, },
 387
 388     { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
 389
 390     { rightname=>'Configuration download', }, #description of how it affects
 391                                               #search/elements/search.html
 392
 393   ],
 394
 395 ;
 396
 397 =head1 CLASS METHODS
 398
 399 =over 4
 400
 401 =item rights
 402
 403 Returns the full list of right names.
 404
 405 =cut
 406
 407 sub rights {
 408   #my $class = shift;
 409   map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
 410 }
 411
 412 =item default_superuser_rights
 413
 414 Most (but not all) right names.
 415
 416 =cut
 417
 418 sub default_superuser_rights {
 419   my $class = shift;
 420   my %omit = map { $_=>1 } (
 421     'Delete invoices',
 422     'Delete payment',
 423     'Delete credit', #?
 424     'Delete refund', #?
 425     'Edit customer package dates',
 426     'Time queue',
 427     'Usage: Time worked',
 428     'Redownload resolved batches',
 429     'Raw SQL',
 430     'Configuration download',
 431     'View customers of all agents',
 432     'View/link unlinked services',
 433     'Edit usage',
 434     'Credit card void',
 435     'Echeck void',
 436     'Edit customer package dates',
 437   );
 438
 439   no warnings 'uninitialized';
 440   grep { ! $omit{$_} } $class->rights;
 441 }
 442
 443 =item rights_info
 444
 445 Returns a list of key-value pairs suitable for assigning to a hash.  Keys are
 446 category names and values are list references of rights.  Each element of the
 447 list reference scalar right name or a hashref with the following keys:
 448
 449 =over 4
 450
 451 =item rightname - Right name
 452
 453 =item desc - Extended right description
 454
 455 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
 456
 457 =back
 458
 459 =cut
 460
 461 sub rights_info {
 462   %rights;
 463 }
 464
 465 =back
 466
 467 =head1 BUGS
 468
 469 Damn those infernal six-legged creatures!
 470
 471 =head1 SEE ALSO
 472
 473 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>
 474
 475 =cut
 476
 477 1;
 478