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