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