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 referring customer',
 112     'View customer history',
 113     'Cancel customer',
 114     'Complimentary customer', #aka users-allow_comp
 115     { 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
 116     'Bill customer now', #NEW
 117     'Bulk send customer notices', #NEW
 118     { rightname=>'View customers of all agents', global=>1 },
 119   ],
 120
 121   ###
 122   # customer package rights
 123   ###
 124   'Customer package rights' => [
 125     'View customer packages', #NEW
 126     'Order customer package',
 127     'One-time charge',
 128     'Change customer package',
 129     'Bulk change customer packages',
 130     'Edit customer package dates',
 131     'Discount customer package', #NEW
 132     'Custom discount customer package', #NEW
 133     'Customize customer package',
 134     'Suspend customer package',
 135     'Suspend customer package later',
 136     'Unsuspend customer package',
 137     'Cancel customer package immediately',
 138     'Cancel customer package later',
 139     'Delay suspension events',
 140     'Add on-the-fly cancel reason', #NEW
 141     'Add on-the-fly suspend reason', #NEW
 142     'Edit customer package invoice details', #NEW
 143     'Edit customer package comments', #NEW
 144   ],
 145
 146   ###
 147   # customer service rights
 148   ###
 149   'Customer service rights' => [
 150     'View customer services', #NEW
 151     'Provision customer service',
 152     'Recharge customer service', #NEW
 153     'Unprovision customer service',
 154     'Change customer service', #NEWNEW
 155     'Edit usage', #NEW
 156     'Edit home dir', #NEW
 157     'Edit www config', #NEW
 158     'Edit domain catchall', #NEW
 159     'Edit domain nameservice', #NEW
 160     'Manage domain registration',
 161
 162     { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
 163   ],
 164
 165   ###
 166   # customer invoice/financial info rights
 167   ###
 168   'Customer invoice / financial info rights' => [
 169     'View invoices',
 170     'Resend invoices', #NEWNEW
 171     'Delete invoices', #new, but no need to phase in
 172     'View customer tax exemptions', #yow
 173     'Add customer tax adjustment', #new, but no need to phase in
 174     'View customer batched payments', #NEW
 175     'View customer pending payments', #NEW
 176     'Edit customer pending payments', #NEW
 177     'View customer billing events', #NEW
 178   ],
 179
 180   ###
 181   # customer payment rights
 182   ###
 183   'Customer payment rights' => [
 184     'Post payment',
 185     'Post payment batch',
 186     'Apply payment', #NEWNEW
 187     { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
 188     'Process payment',
 189     { rightname=>'Refund payment', desc=>'Enable refund of existing customer payments.' },
 190
 191     { 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.
 192
 193   ],
 194
 195   ###
 196   # customer credit rights
 197   ###
 198   'Customer credit and refund rights' => [
 199     'Post credit',
 200     'Apply credit', #NEWNEW
 201     { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
 202     { 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.
 203     { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
 204 #    { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
 205     'Delete refund', #NEW
 206     'Add on-the-fly credit reason', #NEW
 207   ],
 208
 209   ###
 210   # customer voiding rights..
 211   ###
 212   'Customer void rights' => [
 213     { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
 214     { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
 215     'Regular void',
 216     { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
 217
 218
 219   ],
 220
 221   ###
 222   # note/attachment rights...
 223   ###
 224   'Customer note and attachment rights' => [
 225     'Add customer note', #NEW
 226     'Edit customer note', #NEW
 227     'View attachments', #NEW
 228     'Browse attachments', #NEW
 229     'Download attachment', #NEW
 230     'Add attachment', #NEW
 231     'Edit attachment', #NEW
 232     'Delete attachment', #NEW
 233     'View deleted attachments', #NEW
 234     'Undelete attachment', #NEW
 235     'Purge attachment', #NEW
 236   ],
 237
 238   ###
 239   # report/listing rights...
 240   ###
 241   'Reporting/listing rights' => [
 242     'List customers',
 243     'List zip codes', #NEW
 244     'List invoices',
 245     'List packages',
 246     'List services',
 247     'List service passwords',
 248
 249     { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
 250     'Billing event reports',
 251     'Receivables report',
 252     'Financial reports',
 253
 254     #{ rightname => 'List customers of all agents', global=>1 },
 255   ],
 256
 257   ###
 258   # misc rights
 259   ###
 260   'Miscellaneous rights' => [
 261     { rightname=>'Job queue', global=>1 },
 262     { rightname=>'Time queue', global=>1 },
 263     { rightname=>'Process batches', global=>1 },
 264     { rightname=>'Reprocess batches', global=>1 },
 265     { rightname=>'Redownload resolved batches', global=>1 },
 266     { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now?  give em their own ACLs
 267     { rightname=>'Export', global=>1 },
 268     { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
 269   #],
 270   #
 271   ###
 272   # misc misc rights
 273   ###
 274   #'Database access rights' => [
 275     { rightname=>'Raw SQL', global=>1 }, #NEW
 276   ],
 277
 278   ###
 279   # setup/config rights
 280   ###
 281   'Configuration rights' => [
 282     'Edit advertising sources',
 283     { rightname=>'Edit global advertising sources', global=>1 },
 284
 285     'Edit package definitions',
 286     { rightname=>'Edit global package definitions', global=>1 },
 287
 288     'Edit billing events',
 289     { rightname=>'Edit global billing events', global=>1 },
 290
 291     'Edit inventory',
 292     { rightname=>'Edit global inventory', global=>1 },
 293
 294     { rightname=>'Dialup configuration' },
 295     { rightname=>'Dialup global configuration', global=>1 },
 296
 297     { rightname=>'Broadband configuration' },
 298     { rightname=>'Broadband global configuration', global=>1 },
 299
 300     #{ rightname=>'Edit employees', global=>1, },
 301     #{ rightname=>'Edit employee groupss', global=>1, },
 302
 303     { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
 304
 305     { rightname=>'Configuration download', }, #description of how it affects
 306                                               #search/elements/search.html
 307
 308   ],
 309
 310 ;
 311
 312 =head1 CLASS METHODS
 313
 314 =over 4
 315
 316 =item rights
 317
 318 Returns the full list of right names.
 319
 320 =cut
 321
 322 sub rights {
 323   #my $class = shift;
 324   map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
 325 }
 326
 327 =item default_superuser_rights
 328
 329 Most (but not all) right names.
 330
 331 =cut
 332
 333 sub default_superuser_rights {
 334   my $class = shift;
 335   my %omit = map { $_=>1 } (
 336     'Delete customer',
 337     'Delete invoices',
 338     'Delete payment',
 339     'Delete credit', #?
 340     'Delete refund', #?
 341     'Time queue',
 342     'Redownload resolved batches',
 343     'Raw SQL',
 344     'Configuration download',
 345   );
 346
 347   no warnings 'uninitialized';
 348   grep { ! $omit{$_} } $class->rights;
 349 }
 350
 351 =item rights_info
 352
 353 Returns a list of key-value pairs suitable for assigning to a hash.  Keys are
 354 category names and values are list references of rights.  Each element of the
 355 list reference scalar right name or a hashref with the following keys:
 356
 357 =over 4
 358
 359 =item rightname - Right name
 360
 361 =item desc - Extended right description
 362
 363 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
 364
 365 =back
 366
 367 =cut
 368
 369 sub rights_info {
 370   %rights;
 371 }
 372
 373 =back
 374
 375 =head1 BUGS
 376
 377 Damn those infernal six-legged creatures!
 378
 379 =head1 SEE ALSO
 380
 381 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>
 382
 383 =cut
 384
 385 1;
 386