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