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