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