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     'Cancel customer',
  98     'Complimentary customer', #aka users-allow_comp
  99     { 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
 100     'Add customer note', #NEW
 101     'Edit customer note', #NEW
 102     'Bill customer now', #NEW
 103   ],
 104
 105   ###
 106   # customer package rights
 107   ###
 108   'Customer package rights' => [
 109     'View customer packages', #NEW
 110     'Order customer package',
 111     'One-time charge',
 112     'Change customer package',
 113     'Bulk change customer packages',
 114     'Edit customer package dates',
 115     'Customize customer package',
 116     'Suspend customer package',
 117     'Suspend customer package later',
 118     'Unsuspend customer package',
 119     'Cancel customer package immediately',
 120     'Cancel customer package later',
 121     'Add on-the-fly cancel reason', #NEW
 122     'Add on-the-fly suspend reason', #NEW
 123   ],
 124
 125   ###
 126   # customer service rights
 127   ###
 128   'Customer service rights' => [
 129     'View customer services', #NEW
 130     'Provision customer service',
 131     'Recharge customer service', #NEW
 132     'Unprovision customer service',
 133     'Change customer service', #NEWNEW
 134     'Edit usage', #NEW
 135     'Edit home dir', #NEW
 136     'Edit www config', #NEW
 137     'Edit domain catchall', #NEW
 138     'Edit domain nameservice', #NEW
 139
 140     { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
 141   ],
 142
 143   ###
 144   # customer invoice/financial info rights
 145   ###
 146   'Customer invoice / financial info rights' => [
 147     'View invoices',
 148     'Resend invoices', #NEWNEW
 149     'View customer tax exemptions', #yow
 150     'View customer batched payments', #NEW
 151     'View customer billing events', #NEW
 152   ],
 153
 154   ###
 155   # customer payment rights
 156   ###
 157   'Customer payment rights' => [
 158     'Post payment',
 159     'Post payment batch',
 160     'Apply payment', #NEWNEW
 161     { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
 162     'Process payment',
 163     'Refund payment',
 164
 165     { 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.
 166
 167   ],
 168
 169   ###
 170   # customer credit rights
 171   ###
 172   'Customer credit and refund rights' => [
 173     'Post credit',
 174     'Apply credit', #NEWNEW
 175     { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
 176     { 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.
 177     'Delete refund', #NEW
 178     'Add on-the-fly credit reason', #NEW
 179   ],
 180
 181   ###
 182   # customer voiding rights..
 183   ###
 184   'Customer void rights' => [
 185     { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
 186     { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
 187     'Regular void',
 188     { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
 189
 190
 191   ],
 192
 193   ###
 194   # report/listing rights...
 195   ###
 196   'Reprting/listing rights' => [
 197     'List customers',
 198     'List zip codes', #NEW
 199     'List invoices',
 200     'List packages',
 201     'List services',
 202
 203     { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
 204     'Billing event reports',
 205     'Financial reports',
 206   ],
 207
 208   ###
 209   # misc rights
 210   ###
 211   'Miscellaneous rights' => [
 212     { rightname=>'Job queue', global=>1 },
 213     { rightname=>'Time queue', global=>1 },
 214     { rightname=>'Process batches', global=>1 },
 215     { rightname=>'Reprocess batches', global=>1 },
 216     { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now?  give em their own ACLs
 217     { rightname=>'Export', global=>1 },
 218   #],
 219   #
 220   ###
 221   # misc misc rights
 222   ###
 223   #'Database access rights' => [
 224     { rightname=>'Raw SQL', global=>1 }, #NEW
 225   ],
 226
 227   ###
 228   # setup/config rights
 229   ###
 230   'Configuration rights' => [
 231     'Edit advertising sources',
 232     { rightname=>'Edit global advertising sources', global=>1 },
 233
 234     'Edit package definitions',
 235     { rightname=>'Edit global package definitions', global=>1 },
 236
 237     'Edit billing events',
 238     { rightname=>'Edit global billing events', global=>1 },
 239
 240     { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
 241   ],
 242
 243 ;
 244
 245 =head1 CLASS METHODS
 246
 247 =over 4
 248
 249 =item rights
 250
 251 Returns a list of right names.
 252
 253 =cut
 254
 255   sub rights {
 256   #my $class = shift;
 257   map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
 258   }
 259
 260 =item rights_info
 261
 262 Returns a list of key-value pairs suitable for assigning to a hash.  Keys are
 263 category names and values are list references of rights.  Each element of the
 264 list reference scalar right name or a hashref with the following keys:
 265
 266 =over 4
 267
 268 =item rightname - Right name
 269
 270 =item desc - Extended right description
 271
 272 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
 273
 274 =back
 275
 276 =cut
 277
 278 sub rights_info {
 279   %rights;
 280 }
 281
 282 =back
 283
 284 =head1 BUGS
 285
 286 Damn those infernal six-legged creatures!
 287
 288 =head1 SEE ALSO
 289
 290 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>
 291
 292 =cut
 293
 294 1;
 295