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     'View customer history',
  98     'Cancel customer',
  99     'Complimentary customer', #aka users-allow_comp
 100     { 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
 101     'Add customer note', #NEW
 102     'Edit customer note', #NEW
 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     'View customer tax exemptions', #yow
 156     'Add customer tax adjustment', #new, but no need to phase in
 157     'View customer batched payments', #NEW
 158     'View customer pending payments', #NEW
 159     'Edit customer pending payments', #NEW
 160     'View customer billing events', #NEW
 161   ],
 162
 163   ###
 164   # customer payment rights
 165   ###
 166   'Customer payment rights' => [
 167     'Post payment',
 168     'Post payment batch',
 169     'Apply payment', #NEWNEW
 170     { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
 171     'Process payment',
 172     { rightname=>'Refund payment', desc=>'Enable refund of existing customer payments.' },
 173
 174     { 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.
 175
 176   ],
 177
 178   ###
 179   # customer credit rights
 180   ###
 181   'Customer credit and refund rights' => [
 182     'Post credit',
 183     'Apply credit', #NEWNEW
 184     { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
 185     { 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.
 186     { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
 187 #    { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
 188     'Delete refund', #NEW
 189     'Add on-the-fly credit reason', #NEW
 190   ],
 191
 192   ###
 193   # customer voiding rights..
 194   ###
 195   'Customer void rights' => [
 196     { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
 197     { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
 198     'Regular void',
 199     { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
 200
 201
 202   ],
 203
 204   ###
 205   # report/listing rights...
 206   ###
 207   'Reporting/listing rights' => [
 208     'List customers',
 209     'List zip codes', #NEW
 210     'List invoices',
 211     'List packages',
 212     'List services',
 213
 214     { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
 215     'Billing event reports',
 216     'Receivables report',
 217     'Financial reports',
 218   ],
 219
 220   ###
 221   # misc rights
 222   ###
 223   'Miscellaneous rights' => [
 224     { rightname=>'Job queue', global=>1 },
 225     { rightname=>'Time queue', global=>1 },
 226     { rightname=>'Process batches', global=>1 },
 227     { rightname=>'Reprocess batches', global=>1 },
 228     { rightname=>'Redownload resolved batches', global=>1 },
 229     { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now?  give em their own ACLs
 230     { rightname=>'Export', global=>1 },
 231     { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
 232   #],
 233   #
 234   ###
 235   # misc misc rights
 236   ###
 237   #'Database access rights' => [
 238     { rightname=>'Raw SQL', global=>1 }, #NEW
 239   ],
 240
 241   ###
 242   # setup/config rights
 243   ###
 244   'Configuration rights' => [
 245     'Edit advertising sources',
 246     { rightname=>'Edit global advertising sources', global=>1 },
 247
 248     'Edit package definitions',
 249     { rightname=>'Edit global package definitions', global=>1 },
 250
 251     'Edit billing events',
 252     { rightname=>'Edit global billing events', global=>1 },
 253
 254     { rightname=>'Dialup configuration' },
 255     { rightname=>'Dialup global configuration', global=>1 },
 256
 257     { rightname=>'Broadband configuration' },
 258     { rightname=>'Broadband global configuration', global=>1 },
 259
 260     { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
 261
 262     { rightname=>'Configuration download', }, #description of how it affects
 263                                               #search/elements/search.html
 264
 265   ],
 266
 267 ;
 268
 269 =head1 CLASS METHODS
 270
 271 =over 4
 272
 273 =item rights
 274
 275 Returns a list of right names.
 276
 277 =cut
 278
 279   sub rights {
 280   #my $class = shift;
 281   map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
 282   }
 283
 284 =item rights_info
 285
 286 Returns a list of key-value pairs suitable for assigning to a hash.  Keys are
 287 category names and values are list references of rights.  Each element of the
 288 list reference scalar right name or a hashref with the following keys:
 289
 290 =over 4
 291
 292 =item rightname - Right name
 293
 294 =item desc - Extended right description
 295
 296 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
 297
 298 =back
 299
 300 =cut
 301
 302 sub rights_info {
 303   %rights;
 304 }
 305
 306 =back
 307
 308 =head1 BUGS
 309
 310 Damn those infernal six-legged creatures!
 311
 312 =head1 SEE ALSO
 313
 314 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>
 315
 316 =cut
 317
 318 1;
 319