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