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