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