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