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