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