1 package FS::AccessRight;
4 use vars qw(@rights); # %rights);
9 FS::AccessRight - Access control rights.
15 my @rights = FS::AccessRight->rights;
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} };
25 Access control rights - Permission to perform specific actions that can be
26 assigned to users and/or groups.
32 # '_desc' => 'Access to high-level reporting',
34 # 'Configuration' => [
35 # '_desc' => 'Access to configuration',
40 # '_desc' => 'Master access to reseller configuration',
45 # 'export_svc_pkg' => [
46 # '_desc' => 'Access to export, service and package configuration',
47 # 'part_export' => {},
54 # '_desc' => 'Access to billing configuration',
55 # 'payment_gateway' => {},
56 # 'part_bill_event' => {},
57 # 'prepay_credit' => {},
59 # 'cust_main_county' => {},
63 # '_desc' => 'Access to dialup configuraiton',
64 # 'svc_acct_pop' => {},
68 # '_desc' => 'Access to broadband configuration',
74 # 'part_referral' => {},
75 # 'part_virtual_field' => {},
77 # 'inventory_class' => {},
84 ##turn it into a more hash-like structure, but ordered via IxHash
86 #well, this is what we have for now. getting better.
87 tie my %rights, 'Tie::IxHash',
92 'Contact and Prospect rights' => [
98 #'View customer contacts',
103 # basic customer rights
105 'Customer rights' => [
108 #'View Customer | View tickets',
110 'Edit customer tags',
111 'Edit referring customer',
112 'View customer history',
114 'Unsuspend customer',
116 'Complimentary customer', #aka users-allow_comp
118 'Merge customer across agents',
119 { 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
120 'Bill customer now', #NEW
121 'Bulk send customer notices', #NEW
122 { rightname=>'View customers of all agents', global=>1 },
126 # customer package rights
128 'Customer package rights' => [
129 'View customer packages', #NEW
130 'Order customer package',
132 'Modify one-time charge',
133 'Change customer package',
134 'Detach customer package',
135 'Bulk change customer packages',
136 'Edit customer package dates',
137 'Discount customer package', #NEW
138 'Custom discount customer package', #NEW
139 'Customize customer package',
140 'Suspend customer package',
141 'Suspend customer package later',
142 'Unsuspend customer package',
143 'Cancel customer package immediately',
144 'Cancel customer package later',
145 'Un-cancel customer package',
146 'Delay suspension events',
147 'Add on-the-fly cancel reason', #NEW
148 'Add on-the-fly suspend reason', #NEW
149 'Edit customer package invoice details', #NEW
150 'Edit customer package comments', #NEW
151 'Qualify service', #NEW
152 'Waive setup fee', #NEW
153 'View appointments', #NEWNEW
155 'View package definition costs', #NEWNEW
159 # customer service rights
161 'Customer service rights' => [
162 'View customer services', #NEW
163 'Provision customer service',
164 'Bulk provision customer service',
165 'Bulk move customer services', #NEWNEW
166 'Recharge customer service', #NEW
167 'Unprovision customer service',
168 'Change customer service', #NEWNEW
171 'Edit home dir', #NEW
172 'Edit www config', #NEW
173 'Edit domain catchall', #NEW
174 'Edit domain nameservice', #NEW
175 'Manage domain registration',
177 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
181 # customer invoice/financial info rights
183 'Customer invoice / financial info rights' => [
185 'Resend invoices', #NEWNEW
189 'View customer tax exemptions', #yow
190 'Edit customer tax exemptions', #NEWNEW
191 'Add customer tax adjustment', #new, but no need to phase in
192 'View customer batched payments', #NEW
193 'View customer pending payments', #NEW
194 'Edit customer pending payments', #NEW
195 'View customer billing events', #NEW
199 # customer payment rights
201 'Customer payment rights' => [
203 { rightname=>'Post payment', desc=>'Make check or cash payments.' },
204 { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
205 'Post check payment',
207 'Post payment batch',
208 'Apply payment', #NEWNEW
209 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
210 { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
211 'Process credit card payment',
212 'Process Echeck payment',
213 { 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.
217 # customer credit rights
219 'Customer credit and refund rights' => [
221 { rightname=>'Backdate credit', desc=>'Enable credits to be posted for days other than today.' },
222 'Credit line items', #NEWNEWNEW
223 'Apply credit', #NEWNEW
224 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
225 { 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.
227 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
230 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
231 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
232 'Refund credit card payment',
233 'Refund Echeck payment',
234 'Delete refund', #NEW
235 'Add on-the-fly credit reason', #NEW
239 # customer voiding rights..
241 'Customer payment void rights' => [
242 { rightname=>'Credit card void', desc=>'Enable local-only voiding of credit card payments in addition to refunds against the payment gateway.' }, #aka. cc-void
243 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
245 { rightname=>'Unvoid payments', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
251 # note/attachment rights...
253 'Customer note and attachment rights' => [
254 'Add customer note', #NEW
255 'Edit customer note', #NEW
256 'View attachments', #NEW
257 'Browse attachments', #NEW
258 'Download attachment', #NEW
259 'Add attachment', #NEW
260 'Edit attachment', #NEW
261 'Delete attachment', #NEW
262 'View deleted attachments', #NEW
263 'Undelete attachment', #NEW
264 'Purge attachment', #NEW
268 # report/listing rights...
270 'Reporting/listing rights' => [
274 'List all customers',
275 'Advanced customer search',
276 'List zip codes', #NEW
280 'Summarize packages',
282 'List service passwords',
284 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
285 'Billing event reports',
286 'Receivables report',
288 { rightname=> 'List inventory', global=>1 },
289 { rightname=>'View email logs', global=>1 },
290 { rightname=>'View system logs' },
292 'Download report data',
293 'Services: Accounts',
294 'Services: Accounts: Advanced search',
296 'Services: Certificates',
297 'Services: Mail forwards',
298 'Services: Virtual hosting services',
299 'Services: Wireless broadband services',
300 'Services: Wireless broadband services: Advanced search',
302 'Services: Cable subscribers',
303 'Services: Dish services',
304 'Services: Hardware',
305 'Services: Hardware: Advanced search',
306 'Services: Phone numbers',
307 'Services: Phone numbers: Advanced search',
310 'Services: Mailing lists',
311 'Services: Alarm services',
312 'Services: External services',
313 'Usage: RADIUS sessions',
314 'Services: Circuits',
315 'Usage: Call Detail Records (CDRs)',
316 'Usage: Unrateable CDRs',
317 'Usage: Time worked',
318 { rightname=>'Employees: Commission Report', global=>1 },
319 { rightname=>'Employees: Audit Report', global=>1 },
321 #{ rightname => 'List customers of all agents', global=>1 },
327 'Miscellaneous rights' => [
328 { rightname=>'Job queue', global=>1 },
329 { rightname=>'Time queue', global=>1 },
330 { rightname=>'Process batches', }, #Process payment batches
331 { rightname=>'Process global batches', global=>1 }, #Process global payment batches
332 { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
333 { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
334 { rightname=>'Process invoice batches', },
335 { rightname=>'Process global invoice batches', global=>1 },
336 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
337 { rightname=>'Export', global=>1 },
338 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
344 #'Database access rights' => [
345 { rightname=>'Raw SQL', global=>1 }, #NEW
349 # setup/config rights
351 'Configuration rights' => [
352 'Edit advertising sources',
353 { rightname=>'Edit global advertising sources', global=>1 },
357 'Edit package definitions',
358 { rightname=>'Edit global package definitions', global=>1 },
359 'Edit package definition costs',
361 'Bulk edit package definitions',
363 'Edit FCC report configuration',
364 { rightname => 'Edit FCC report configuration for all agents', global=>1 },
367 #{ rightname=>'Edit global CDR rates', global=>1, },
369 'Edit fee definitions',
370 { rightname=>'Edit global fee definitions', global=>1 },
372 'Edit billing events',
373 { rightname=>'Edit global billing events', global=>1 },
376 { rightname=>'View global templates', global=>1 },
378 { rightname=>'Edit global templates', global=>1 },
381 { rightname=>'Edit global inventory', global=>1 },
383 { rightname=>'Dialup configuration' },
384 { rightname=>'Dialup global configuration', global=>1 },
386 { rightname=>'Broadband configuration' },
387 { rightname=>'Broadband global configuration', global=>1 },
389 { rightname=>'Alarm configuration' },
390 { rightname=>'Alarm global configuration', global=>1 },
392 { rightname=> 'Configure network monitoring', global=>1 },
394 #{ rightname=>'Edit employees', global=>1, },
395 #{ rightname=>'Edit employee groupss', global=>1, },
397 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
399 { rightname=>'Configuration download', }, #description of how it affects
400 #search/elements/search.html
412 Returns the full list of right names.
418 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
421 =item default_superuser_rights
423 Most (but not all) right names.
427 sub default_superuser_rights {
429 my %omit = map { $_=>1 } (
435 'Edit customer package dates',
437 'Usage: Time worked',
438 'Redownload resolved batches',
440 'Configuration download',
441 'View customers of all agents',
442 'View/link unlinked services',
446 'Void invoices',#people are overusing this when credits are more appropriate
450 no warnings 'uninitialized';
451 grep { ! $omit{$_} } $class->rights;
456 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
457 category names and values are list references of rights. Each element of the
458 list reference scalar right name or a hashref with the following keys:
462 =item rightname - Right name
464 =item desc - Extended right description
466 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
480 Damn those infernal six-legged creatures!
484 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>