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