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
 231     { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
 232     'Billing event reports',
 233     'Receivables report',
 234     'Financial reports',
 235   ],
 236
 237   ###
 238   # misc rights
 239   ###
 240   'Miscellaneous rights' => [
 241     { rightname=>'Job queue', global=>1 },
 242     { rightname=>'Time queue', global=>1 },
 243     { rightname=>'Process batches', global=>1 },
 244     { rightname=>'Reprocess batches', global=>1 },
 245     { rightname=>'Redownload resolved batches', global=>1 },
 246     { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now?  give em their own ACLs
 247     { rightname=>'Export', global=>1 },
 248     { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
 249   #],
 250   #
 251   ###
 252   # misc misc rights
 253   ###
 254   #'Database access rights' => [
 255     { rightname=>'Raw SQL', global=>1 }, #NEW
 256   ],
 257
 258   ###
 259   # setup/config rights
 260   ###
 261   'Configuration rights' => [
 262     'Edit advertising sources',
 263     { rightname=>'Edit global advertising sources', global=>1 },
 264
 265     'Edit package definitions',
 266     { rightname=>'Edit global package definitions', global=>1 },
 267
 268     'Edit billing events',
 269     { rightname=>'Edit global billing events', global=>1 },
 270
 271     { rightname=>'Dialup configuration' },
 272     { rightname=>'Dialup global configuration', global=>1 },
 273
 274     { rightname=>'Broadband configuration' },
 275     { rightname=>'Broadband global configuration', global=>1 },
 276
 277     { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
 278
 279     { rightname=>'Configuration download', }, #description of how it affects
 280                                               #search/elements/search.html
 281
 282   ],
 283
 284 ;
 285
 286 =head1 CLASS METHODS
 287
 288 =over 4
 289
 290 =item rights
 291
 292 Returns the full list of right names.
 293
 294 =cut
 295
 296 sub rights {
 297   #my $class = shift;
 298   map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
 299 }
 300
 301 =item default_superuser_rights
 302
 303 Most (but not all) right names.
 304
 305 =cut
 306
 307 sub default_superuser_rights {
 308   my $class = shift;
 309   my %omit = map { $_=>1 } (
 310     'Delete customer',
 311     'Delete invoices',
 312     'Delete payment',
 313     'Delete credit', #?
 314     'Delete refund', #?
 315     'Time queue',
 316     'Redownload resolved batches',
 317     'Raw SQL',
 318     'Configuration download',
 319   );
 320
 321   no warnings 'uninitialized';
 322   grep { ! $omit{$_} } $class->rights;
 323 }
 324
 325 =item rights_info
 326
 327 Returns a list of key-value pairs suitable for assigning to a hash.  Keys are
 328 category names and values are list references of rights.  Each element of the
 329 list reference scalar right name or a hashref with the following keys:
 330
 331 =over 4
 332
 333 =item rightname - Right name
 334
 335 =item desc - Extended right description
 336
 337 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
 338
 339 =back
 340
 341 =cut
 342
 343 sub rights_info {
 344   %rights;
 345 }
 346
 347 =back
 348
 349 =head1 BUGS
 350
 351 Damn those infernal six-legged creatures!
 352
 353 =head1 SEE ALSO
 354
 355 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>
 356
 357 =cut
 358
 359 1;
 360