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