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