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