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