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     'List prospects',
  97     'Edit contact', #!
  98     #'New contact',
  99     #'View customer contacts',
 100     #'List contacts',
 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     { 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
 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     'Change customer package',
 133     'Bulk change customer packages',
 134     'Edit customer package dates',
 135     'Discount customer package', #NEW
 136     'Custom discount customer package', #NEW
 137     'Customize customer package',
 138     'Suspend customer package',
 139     'Suspend customer package later',
 140     'Unsuspend customer package',
 141     'Cancel customer package immediately',
 142     'Cancel customer package later',
 143     'Un-cancel customer package',
 144     'Delay suspension events',
 145     'Add on-the-fly cancel reason', #NEW
 146     'Add on-the-fly suspend reason', #NEW
 147     'Edit customer package invoice details', #NEW
 148     'Edit customer package comments', #NEW
 149     'Qualify service', #NEW
 150     'Waive setup fee', #NEW
 151   ],
 152
 153   ###
 154   # customer service rights
 155   ###
 156   'Customer service rights' => [
 157     'View customer services', #NEW
 158     'Provision customer service',
 159     'Bulk provision customer service',
 160     'Recharge customer service', #NEW
 161     'Unprovision customer service',
 162     'Change customer service', #NEWNEW
 163     'Edit usage', #NEW
 164     'Edit home dir', #NEW
 165     'Edit www config', #NEW
 166     'Edit domain catchall', #NEW
 167     'Edit domain nameservice', #NEW
 168     'Manage domain registration',
 169
 170     { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
 171   ],
 172
 173   ###
 174   # customer invoice/financial info rights
 175   ###
 176   'Customer invoice / financial info rights' => [
 177     'View invoices',
 178     'Resend invoices', #NEWNEW
 179     'Delete invoices', #new, but no need to phase in
 180     'View customer tax exemptions', #yow
 181     'Add customer tax adjustment', #new, but no need to phase in
 182     'View customer batched payments', #NEW
 183     'View customer pending payments', #NEW
 184     'Edit customer pending payments', #NEW
 185     'View customer billing events', #NEW
 186   ],
 187
 188   ###
 189   # customer payment rights
 190   ###
 191   'Customer payment rights' => [
 192     'View payments',
 193     { rightname=>'Post payment', desc=>'Make check or cash payments.' },
 194     { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
 195     'Post check payment',
 196     'Post cash payment',
 197     'Post payment batch',
 198     'Apply payment', #NEWNEW
 199     { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
 200     { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
 201     'Process credit card payment',
 202     'Process Echeck payment',
 203     { 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.
 204   ],
 205
 206   ###
 207   # customer credit rights
 208   ###
 209   'Customer credit and refund rights' => [
 210     'Post credit',
 211     'Apply credit', #NEWNEW
 212     { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
 213     { 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.
 214     'View refunds',
 215     { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
 216     'Post check refund',
 217     'Post cash refund',
 218 #    { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
 219     { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
 220     'Refund credit card payment',
 221     'Refund Echeck payment',
 222     'Delete refund', #NEW
 223     'Add on-the-fly credit reason', #NEW
 224   ],
 225
 226   ###
 227   # customer voiding rights..
 228   ###
 229   'Customer void rights' => [
 230     { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
 231     { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
 232     'Regular void',
 233     { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
 234
 235
 236   ],
 237
 238   ###
 239   # note/attachment rights...
 240   ###
 241   'Customer note and attachment rights' => [
 242     'Add customer note', #NEW
 243     'Edit customer note', #NEW
 244     'View attachments', #NEW
 245     'Browse attachments', #NEW
 246     'Download attachment', #NEW
 247     'Add attachment', #NEW
 248     'Edit attachment', #NEW
 249     'Delete attachment', #NEW
 250     'View deleted attachments', #NEW
 251     'Undelete attachment', #NEW
 252     'Purge attachment', #NEW
 253   ],
 254
 255   ###
 256   # report/listing rights...
 257   ###
 258   'Reporting/listing rights' => [
 259     'List customers',
 260     'List all customers',
 261     'List zip codes', #NEW
 262     'List invoices',
 263     'List packages',
 264     'Summarize packages',
 265     'List services',
 266     'List service passwords',
 267
 268     { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
 269     'Billing event reports',
 270     'Receivables report',
 271     'Financial reports',
 272     { rightname=> 'List inventory', global=>1 },
 273     { rightname=>'View email logs', global=>1 },
 274
 275     'Download report data',
 276     'Services: Accounts',
 277     'Services: Domains',
 278     'Services: Certificates',
 279     'Services: Mail forwards',
 280     'Services: Virtual hosting services',
 281     'Services: Wireless broadband services',
 282     'Services: DSLs',
 283     'Services: Dish services',
 284     'Services: Hardware',
 285     'Services: Phone numbers',
 286     'Services: PBXs',
 287     'Services: Ports',
 288     'Services: Mailing lists',
 289     'Services: External services',
 290     'Usage: RADIUS sessions',
 291     'Usage: Call Detail Records (CDRs)',
 292     'Usage: Unrateable CDRs',
 293     'Usage: Time worked',
 294
 295     #{ rightname => 'List customers of all agents', global=>1 },
 296   ],
 297
 298   ###
 299   # misc rights
 300   ###
 301   'Miscellaneous rights' => [
 302     { rightname=>'Job queue', global=>1 },
 303     { rightname=>'Time queue', global=>1 },
 304     { rightname=>'Process batches', }, #Process payment batches
 305     { rightname=>'Process global batches', global=>1 }, #Process global payment batches
 306     { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
 307     { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
 308     { rightname=>'Process invoice batches', },
 309     { rightname=>'Process global invoice batches', global=>1 },
 310     { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now?  give em their own ACLs
 311     { rightname=>'Export', global=>1 },
 312     { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
 313   #],
 314   #
 315   ###
 316   # misc misc rights
 317   ###
 318   #'Database access rights' => [
 319     { rightname=>'Raw SQL', global=>1 }, #NEW
 320   ],
 321
 322   ###
 323   # setup/config rights
 324   ###
 325   'Configuration rights' => [
 326     'Edit advertising sources',
 327     { rightname=>'Edit global advertising sources', global=>1 },
 328
 329     'Edit package definitions',
 330     { rightname=>'Edit global package definitions', global=>1 },
 331
 332     'Edit billing events',
 333     { rightname=>'Edit global billing events', global=>1 },
 334
 335     'View templates',
 336     { rightname=>'View global templates', global=>1 },
 337     'Edit templates',
 338     { rightname=>'Edit global templates', global=>1 },
 339
 340     'Edit inventory',
 341     { rightname=>'Edit global inventory', global=>1 },
 342
 343     { rightname=>'Dialup configuration' },
 344     { rightname=>'Dialup global configuration', global=>1 },
 345
 346     { rightname=>'Broadband configuration' },
 347     { rightname=>'Broadband global configuration', global=>1 },
 348
 349     { rightname=> 'Configure network monitoring', global=>1 },
 350
 351     #{ rightname=>'Edit employees', global=>1, },
 352     #{ rightname=>'Edit employee groupss', global=>1, },
 353
 354     { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
 355
 356     { rightname=>'Configuration download', }, #description of how it affects
 357                                               #search/elements/search.html
 358
 359   ],
 360
 361 ;
 362
 363 =head1 CLASS METHODS
 364
 365 =over 4
 366
 367 =item rights
 368
 369 Returns the full list of right names.
 370
 371 =cut
 372
 373 sub rights {
 374   #my $class = shift;
 375   map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
 376 }
 377
 378 =item default_superuser_rights
 379
 380 Most (but not all) right names.
 381
 382 =cut
 383
 384 sub default_superuser_rights {
 385   my $class = shift;
 386   my %omit = map { $_=>1 } (
 387     'Delete customer',
 388     'Delete invoices',
 389     'Delete payment',
 390     'Delete credit', #?
 391     'Delete refund', #?
 392     'Edit customer package dates',
 393     'Time queue',
 394     'Redownload resolved batches',
 395     'Raw SQL',
 396     'Configuration download',
 397     'View customers of all agents',
 398     'View/link unlinked services',
 399     'Edit usage',
 400     'Credit card void',
 401     'Echeck void',
 402   );
 403
 404   no warnings 'uninitialized';
 405   grep { ! $omit{$_} } $class->rights;
 406 }
 407
 408 =item rights_info
 409
 410 Returns a list of key-value pairs suitable for assigning to a hash.  Keys are
 411 category names and values are list references of rights.  Each element of the
 412 list reference scalar right name or a hashref with the following keys:
 413
 414 =over 4
 415
 416 =item rightname - Right name
 417
 418 =item desc - Extended right description
 419
 420 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
 421
 422 =back
 423
 424 =cut
 425
 426 sub rights_info {
 427   %rights;
 428 }
 429
 430 =back
 431
 432 =head1 BUGS
 433
 434 Damn those infernal six-legged creatures!
 435
 436 =head1 SEE ALSO
 437
 438 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>
 439
 440 =cut
 441
 442 1;
 443