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