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