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