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     'Basic payment and refund reports',
 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     'Customers: Customer churn report',
 303     'Services: Accounts',
 304     'Services: Accounts: Advanced search',
 305     'Services: Domains',
 306     'Services: Certificates',
 307     'Services: Mail forwards',
 308     'Services: Virtual hosting services',
 309     'Services: Wireless broadband services',
 310     'Services: Wireless broadband services: Advanced search',
 311     'Services: DSLs',
 312     'Services: Cable subscribers',
 313     'Services: Conferencing',
 314     'Services: Dish services',
 315     'Services: Hardware',
 316     'Services: Hardware: Advanced search',
 317     'Services: Phone numbers',
 318     'Services: Phone numbers: Advanced search',
 319     'Services: PBXs',
 320     'Services: Ports',
 321     'Services: Mailing lists',
 322     'Services: Alarm services',
 323     'Services: Video',
 324     'Services: Circuits',
 325     'Services: Fiber',
 326     'Services: Fiber: Advanced search',
 327     'Services: External services',
 328     'Usage: RADIUS sessions',
 329     'Usage: Call Detail Records (CDRs)',
 330     'Usage: Unrateable CDRs',
 331     'Usage: Time worked',
 332     #gone in 4.x as a distinct ACL (for now?) { rightname=>'Employees: Commission Report', global=>1 },
 333     { rightname=>'Employee Reports', global=>1 },
 334
 335     #{ rightname => 'List customers of all agents', global=>1 },
 336   ],
 337
 338   ###
 339   # misc rights
 340   ###
 341   'Miscellaneous rights' => [
 342     { rightname=>'Job queue', global=>1 },
 343     { rightname=>'Time queue', global=>1 },
 344     { rightname=>'Process batches', }, #Process payment batches
 345     { rightname=>'Process global batches', global=>1 }, #Process global payment batches
 346     { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
 347     { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
 348     { rightname=>'Process invoice batches', },
 349     { rightname=>'Process global invoice batches', global=>1 },
 350     { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now?  give em their own ACLs
 351     { rightname=>'Export', global=>1 },
 352     { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
 353   #],
 354   #
 355   ###
 356   # misc misc rights
 357   ###
 358   #'Database access rights' => [
 359     { rightname=>'Raw SQL', global=>1 }, #NEW
 360   #]
 361
 362   #'Employee preference rights' => [
 363     { rightname=>'Employee preference telephony integration' },
 364   #]
 365
 366   #'RT preference rights' => [
 367     { rightname=>'RT activity notification' },
 368   #]
 369
 370   ],
 371
 372   ###
 373   # setup/config rights
 374   ###
 375   'Configuration rights' => [
 376     'Edit advertising sources',
 377     { rightname=>'Edit global advertising sources', global=>1 },
 378
 379     'Edit sales people',
 380
 381     'Edit package definitions',
 382     { rightname=>'Edit global package definitions', global=>1 },
 383     'Edit package definition costs',
 384
 385     'Bulk edit package definitions',
 386
 387     'Edit FCC report configuration',
 388     { rightname => 'Edit FCC report configuration for all agents', global=>1 },
 389
 390     'Edit CDR rates',
 391     #{ rightname=>'Edit global CDR rates', global=>1, },
 392
 393     'Edit fee definitions',
 394     { rightname=>'Edit global fee definitions', global=>1 },
 395
 396     'Edit billing events',
 397     { rightname=>'Edit global billing events', global=>1 },
 398
 399     'View templates',
 400     { rightname=>'View global templates', global=>1 },
 401     'Edit templates',
 402     { rightname=>'Edit global templates', global=>1 },
 403
 404     'Edit inventory',
 405     { rightname=>'Edit global inventory', global=>1 },
 406
 407     { rightname=>'Dialup configuration' },
 408     { rightname=>'Dialup global configuration', global=>1 },
 409
 410     { rightname=>'Broadband configuration' },
 411     { rightname=>'Broadband global configuration', global=>1 },
 412
 413     { rightname=>'Alarm configuration' },
 414     { rightname=>'Alarm global configuration', global=>1 },
 415
 416     { rightname=> 'Configure network monitoring', global=>1 },
 417
 418     #{ rightname=>'Edit employees', global=>1, },
 419     #{ rightname=>'Edit employee groupss', global=>1, },
 420
 421     { rightname=>'Edit custom fields', global=>1 },
 422
 423     { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
 424
 425     { rightname=>'Configuration download', }, #description of how it affects
 426                                               #search/elements/search.html
 427
 428   ],
 429
 430 ;
 431
 432 =head1 CLASS METHODS
 433
 434 =over 4
 435
 436 =item rights
 437
 438 Returns the full list of right names.
 439
 440 =cut
 441
 442 sub rights {
 443   #my $class = shift;
 444   map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
 445 }
 446
 447 =item default_superuser_rights
 448
 449 Most (but not all) right names.
 450
 451 =cut
 452
 453 sub default_superuser_rights {
 454   my $class = shift;
 455   my %omit = map { $_=>1 } (
 456     'Delete refund', #?
 457     'Edit customer package dates',
 458     'Time queue',
 459     'Usage: Time worked',
 460     'Redownload resolved batches',
 461     'Raw SQL',
 462     'Configuration download',
 463     'View customers of all agents',
 464     'View/link unlinked services',
 465     'Edit usage',
 466     'Credit card void',
 467     'Echeck void',
 468     'Void invoices',#people are overusing this when credits are more appropriate
 469     'Backdate credit',
 470     'View legacy typeset statments',
 471   );
 472
 473   no warnings 'uninitialized';
 474   grep { ! $omit{$_} } $class->rights;
 475 }
 476
 477 =item rights_info
 478
 479 Returns a list of key-value pairs suitable for assigning to a hash.  Keys are
 480 category names and values are list references of rights.  Each element of the
 481 list reference scalar right name or a hashref with the following keys:
 482
 483 =over 4
 484
 485 =item rightname - Right name
 486
 487 =item desc - Extended right description
 488
 489 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
 490
 491 =back
 492
 493 =cut
 494
 495 sub rights_info {
 496   %rights;
 497 }
 498
 499 =back
 500
 501 =head1 BUGS
 502
 503 Damn those infernal six-legged creatures!
 504
 505 =head1 SEE ALSO
 506
 507 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>
 508
 509 =cut
 510
 511 1;
 512