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