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 # 'prepay_credit' => {},
58 # 'cust_main_county' => {},
62 # '_desc' => 'Access to dialup configuraiton',
63 # 'svc_acct_pop' => {},
67 # '_desc' => 'Access to broadband configuration',
73 # 'part_referral' => {},
74 # 'part_virtual_field' => {},
76 # 'inventory_class' => {},
83 ##turn it into a more hash-like structure, but ordered via IxHash
85 #well, this is what we have for now. getting better.
86 tie my %rights, 'Tie::IxHash',
91 'Contact and Prospect rights' => [
97 #'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 'Bill customer now', #NEW
120 'Bulk send customer notices', #NEW
121 { rightname=>'View customers of all agents', global=>1 },
125 # customer package rights
127 'Customer package rights' => [
128 'View customer packages', #NEW
129 'Order customer package',
131 'Modify one-time charge',
132 'Change customer package',
133 'Detach customer package',
134 'Bulk change customer packages',
135 'Edit customer package dates',
136 'Discount customer package', #NEW
137 'Custom discount customer package', #NEW
138 'Customize customer package',
139 'Suspend customer package',
140 'Suspend customer package later',
141 'Unsuspend customer package',
142 'Cancel customer package immediately',
143 'Cancel customer package later',
144 'Un-cancel customer package',
145 'Delay suspension events',
146 'Add on-the-fly cancel reason', #NEW
147 'Add on-the-fly suspend reason', #NEW
148 'Edit customer package invoice details', #NEW
149 'Edit customer package comments', #NEW
150 'Qualify service', #NEW
151 'Waive setup fee', #NEW
152 'View appointments', #NEWNEW
154 'View package definition costs', #NEWNEW
155 'Change package start date',
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
186 { rightname=>'Print and mail invoices', desc=>"Print and mail via Freeside's web service", }, ##NEWER than NEWNEWNEW
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
196 'View legacy typeset statements', #new, but no need to phase in
200 # customer payment rights
202 'Customer payment rights' => [
204 { rightname=>'Post payment', desc=>'Make check or cash payments.' },
205 { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
206 'Post check payment',
208 'Post payment batch',
209 'Apply payment', #NEWNEW
210 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
211 { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
212 'Process credit card payment',
213 'Process Echeck payment',
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 'Void credit', #NEWER than things marked NEWNEWNEW
225 'Unvoid credit', #NEWER than things marked NEWNEWNEW
226 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
228 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
231 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
232 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
233 'Refund credit card payment',
234 'Refund Echeck payment',
235 'Delete refund', #NEW
236 'Add on-the-fly credit reason', #NEW
237 'Add on-the-fly void reason',
238 'Add on-the-fly refund reason', #NEW
242 # customer voiding rights..
244 'Customer payment void rights' => [
245 { rightname=>'Credit card void', desc=>'Enable local-only voiding of credit card payments in addition to refunds against the payment gateway.' }, #aka. cc-void
246 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
248 { rightname=>'Unvoid payments', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
254 # note/attachment rights...
256 'Customer note and attachment rights' => [
257 'Add customer note', #NEW
258 'Edit customer note', #NEW
259 'View attachments', #NEW
260 'Browse attachments', #NEW
261 'Download attachment', #NEW
262 'Add attachment', #NEW
263 'Edit attachment', #NEW
264 'Delete attachment', #NEW
265 'View deleted attachments', #NEW
266 'Undelete attachment', #NEW
267 'Purge attachment', #NEW
271 # report/listing rights...
273 'Reporting/listing rights' => [
277 'List all customers',
278 'Advanced customer search',
279 'List zip codes', #NEW
283 'Summarize packages',
285 'List service passwords',
287 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
288 'Billing event reports',
289 'Receivables report',
291 { rightname=>'Send reports to customers', global=>1 },
292 { rightname=> 'List inventory', global=>1 },
293 { rightname=>'View email logs', global=>1 },
294 { rightname=>'View system logs' },
296 'Download report data',
297 'Services: Accounts',
298 'Services: Accounts: Advanced search',
300 'Services: Certificates',
301 'Services: Mail forwards',
302 'Services: Virtual hosting services',
303 'Services: Wireless broadband services',
304 'Services: Wireless broadband services: Advanced search',
306 'Services: Cable subscribers',
307 'Services: Conferencing',
308 'Services: Dish services',
309 'Services: Hardware',
310 'Services: Hardware: Advanced search',
311 'Services: Phone numbers',
312 'Services: Phone numbers: Advanced search',
315 'Services: Mailing lists',
316 'Services: Alarm services',
318 'Services: Circuits',
320 'Services: Fiber: Advanced search',
321 'Services: External services',
322 'Usage: RADIUS sessions',
323 'Usage: Call Detail Records (CDRs)',
324 'Usage: Unrateable CDRs',
325 'Usage: Time worked',
326 #gone in 4.x as a distinct ACL (for now?) { rightname=>'Employees: Commission Report', global=>1 },
327 { rightname=>'Employees: Audit Report', global=>1 },
329 #{ rightname => 'List customers of all agents', global=>1 },
335 'Miscellaneous rights' => [
336 { rightname=>'Job queue', global=>1 },
337 { rightname=>'Time queue', global=>1 },
338 { rightname=>'Process batches', }, #Process payment batches
339 { rightname=>'Process global batches', global=>1 }, #Process global payment batches
340 { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
341 { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
342 { rightname=>'Process invoice batches', },
343 { rightname=>'Process global invoice batches', global=>1 },
344 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
345 { rightname=>'Export', global=>1 },
346 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
352 #'Database access rights' => [
353 { rightname=>'Raw SQL', global=>1 }, #NEW
356 #'Employee preference rights' => [
357 { rightname=>'Employee preference telephony integration' },
363 # setup/config rights
365 'Configuration rights' => [
366 'Edit advertising sources',
367 { rightname=>'Edit global advertising sources', global=>1 },
371 'Edit package definitions',
372 { rightname=>'Edit global package definitions', global=>1 },
373 'Edit package definition costs',
375 'Bulk edit package definitions',
377 'Edit FCC report configuration',
378 { rightname => 'Edit FCC report configuration for all agents', global=>1 },
381 #{ rightname=>'Edit global CDR rates', global=>1, },
383 'Edit fee definitions',
384 { rightname=>'Edit global fee definitions', global=>1 },
386 'Edit billing events',
387 { rightname=>'Edit global billing events', global=>1 },
390 { rightname=>'View global templates', global=>1 },
392 { rightname=>'Edit global templates', global=>1 },
395 { rightname=>'Edit global inventory', global=>1 },
397 { rightname=>'Dialup configuration' },
398 { rightname=>'Dialup global configuration', global=>1 },
400 { rightname=>'Broadband configuration' },
401 { rightname=>'Broadband global configuration', global=>1 },
403 { rightname=>'Alarm configuration' },
404 { rightname=>'Alarm global configuration', global=>1 },
406 { rightname=> 'Configure network monitoring', global=>1 },
408 #{ rightname=>'Edit employees', global=>1, },
409 #{ rightname=>'Edit employee groupss', global=>1, },
411 { rightname=>'Edit custom fields', global=>1 },
413 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
415 { rightname=>'Configuration download', }, #description of how it affects
416 #search/elements/search.html
428 Returns the full list of right names.
434 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
437 =item default_superuser_rights
439 Most (but not all) right names.
443 sub default_superuser_rights {
445 my %omit = map { $_=>1 } (
447 'Edit customer package dates',
449 'Usage: Time worked',
450 'Redownload resolved batches',
452 'Configuration download',
453 'View customers of all agents',
454 'View/link unlinked services',
458 'Void invoices',#people are overusing this when credits are more appropriate
460 'View legacy typeset statments',
463 no warnings 'uninitialized';
464 grep { ! $omit{$_} } $class->rights;
469 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
470 category names and values are list references of rights. Each element of the
471 list reference scalar right name or a hashref with the following keys:
475 =item rightname - Right name
477 =item desc - Extended right description
479 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
493 Damn those infernal six-legged creatures!
497 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>