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