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