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