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