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',
104 # basic customer rights
106 'Customer rights' => [
109 #'View Customer | View tickets',
111 'Edit customer tags',
112 'Edit referring customer',
113 'View customer history',
115 'Unsuspend customer',
117 'Complimentary customer', #aka users-allow_comp
119 'Merge customer across agents',
120 { 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
121 'Bill customer now', #NEW
122 'Bulk send customer notices', #NEW
123 { rightname=>'View customers of all agents', global=>1 },
127 # customer package rights
129 'Customer package rights' => [
130 'View customer packages', #NEW
131 'Order customer package',
133 'Modify one-time charge',
134 'Change customer package',
135 'Detach customer package',
136 'Bulk change customer packages',
137 'Edit customer package dates',
138 'Discount customer package', #NEW
139 'Custom discount customer package', #NEW
140 'Customize customer package',
141 'Suspend customer package',
142 'Suspend customer package later',
143 'Unsuspend customer package',
144 'Cancel customer package immediately',
145 'Cancel customer package later',
146 'Un-cancel customer package',
147 'Delay suspension events',
148 'Add on-the-fly cancel reason', #NEW
149 'Add on-the-fly suspend reason', #NEW
150 'Edit customer package invoice details', #NEW
151 'Edit customer package comments', #NEW
152 'Qualify service', #NEW
153 'Waive setup fee', #NEW
154 'View appointments', #NEWNEW
156 'View package definition costs', #NEWNEW
160 # customer service rights
162 'Customer service rights' => [
163 'View customer services', #NEW
164 'Provision customer service',
165 'Bulk provision customer service',
166 'Bulk move customer services', #NEWNEW
167 'Recharge customer service', #NEW
168 'Unprovision customer service',
169 'Change customer service', #NEWNEW
172 'Edit home dir', #NEW
173 'Edit www config', #NEW
174 'Edit domain catchall', #NEW
175 'Edit domain nameservice', #NEW
176 'Manage domain registration',
178 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
182 # customer invoice/financial info rights
184 'Customer invoice / financial info rights' => [
186 'Resend invoices', #NEWNEW
187 { rightname=>'Print and mail invoices', desc=>"Print and mail via Freeside's web service", }, ##NEWER than NEWNEWNEW
191 'View customer tax exemptions', #yow
192 'Edit customer tax exemptions', #NEWNEW
193 'Add customer tax adjustment', #new, but no need to phase in
194 'View customer batched payments', #NEW
195 'View customer pending payments', #NEW
196 'Edit customer pending payments', #NEW
197 'View customer billing events', #NEW
198 'View legacy typeset statements', #new, but no need to phase in
202 # customer payment rights
204 'Customer payment rights' => [
206 { rightname=>'Post payment', desc=>'Make check or cash payments.' },
207 { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
208 'Post check payment',
210 'Post payment batch',
211 'Apply payment', #NEWNEW
212 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
213 { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
214 'Process credit card payment',
215 'Process Echeck payment',
216 { 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.
220 # customer credit rights
222 'Customer credit and refund rights' => [
224 { rightname=>'Backdate credit', desc=>'Enable credits to be posted for days other than today.' },
225 'Credit line items', #NEWNEWNEW
226 'Apply credit', #NEWNEW
227 'Void credit', #NEWER than things marked NEWNEWNEW
228 'Unvoid credit', #NEWER than things marked NEWNEWNEW
229 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
230 { 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.
232 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
235 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
236 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
237 'Refund credit card payment',
238 'Refund Echeck payment',
239 'Delete refund', #NEW
240 'Add on-the-fly credit reason', #NEW
241 'Add on-the-fly void credit reason',
245 # customer voiding rights..
247 'Customer payment void rights' => [
248 { rightname=>'Credit card void', desc=>'Enable local-only voiding of credit card payments in addition to refunds against the payment gateway.' }, #aka. cc-void
249 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
251 { rightname=>'Unvoid payments', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
257 # note/attachment rights...
259 'Customer note and attachment rights' => [
260 'Add customer note', #NEW
261 'Edit customer note', #NEW
262 'View attachments', #NEW
263 'Browse attachments', #NEW
264 'Download attachment', #NEW
265 'Add attachment', #NEW
266 'Edit attachment', #NEW
267 'Delete attachment', #NEW
268 'View deleted attachments', #NEW
269 'Undelete attachment', #NEW
270 'Purge attachment', #NEW
274 # report/listing rights...
276 'Reporting/listing rights' => [
280 'List all customers',
281 'Advanced customer search',
282 'List zip codes', #NEW
286 'Summarize packages',
288 'List service passwords',
290 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
291 'Billing event reports',
292 'Receivables report',
294 { rightname=>'Send reports to customers', global=>1 },
295 { rightname=> 'List inventory', global=>1 },
296 { rightname=>'View email logs', global=>1 },
297 { rightname=>'View system logs' },
299 'Download report data',
300 'Services: Accounts',
301 'Services: Accounts: Advanced search',
303 'Services: Certificates',
304 'Services: Mail forwards',
305 'Services: Virtual hosting services',
306 'Services: Wireless broadband services',
307 'Services: Wireless broadband services: Advanced search',
309 'Services: Cable subscribers',
310 'Services: Dish services',
311 'Services: Hardware',
312 'Services: Hardware: Advanced search',
313 'Services: Phone numbers',
314 'Services: Phone numbers: Advanced search',
317 'Services: Mailing lists',
318 'Services: Alarm services',
319 'Services: External services',
320 'Services: Circuits',
322 'Services: Fiber: Advanced search',
323 'Usage: RADIUS sessions',
324 'Usage: Call Detail Records (CDRs)',
325 'Usage: Unrateable CDRs',
326 'Usage: Time worked',
327 { rightname=>'Employees: Commission Report', global=>1 },
328 { rightname=>'Employees: Audit Report', global=>1 },
330 #{ rightname => 'List customers of all agents', global=>1 },
336 'Miscellaneous rights' => [
337 { rightname=>'Job queue', global=>1 },
338 { rightname=>'Time queue', global=>1 },
339 { rightname=>'Process batches', }, #Process payment batches
340 { rightname=>'Process global batches', global=>1 }, #Process global payment batches
341 { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
342 { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
343 { rightname=>'Process invoice batches', },
344 { rightname=>'Process global invoice batches', global=>1 },
345 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
346 { rightname=>'Export', global=>1 },
347 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
353 #'Database access rights' => [
354 { rightname=>'Raw SQL', global=>1 }, #NEW
357 #'Employee preference rights' => [
358 { rightname=>'Employee preference telephony integration' },
364 # setup/config rights
366 'Configuration rights' => [
367 'Edit advertising sources',
368 { rightname=>'Edit global advertising sources', global=>1 },
372 'Edit package definitions',
373 { rightname=>'Edit global package definitions', global=>1 },
374 'Edit package definition costs',
376 'Bulk edit package definitions',
378 'Edit FCC report configuration',
379 { rightname => 'Edit FCC report configuration for all agents', global=>1 },
382 #{ rightname=>'Edit global CDR rates', global=>1, },
384 'Edit fee definitions',
385 { rightname=>'Edit global fee definitions', global=>1 },
387 'Edit billing events',
388 { rightname=>'Edit global billing events', global=>1 },
391 { rightname=>'View global templates', global=>1 },
393 { rightname=>'Edit global templates', global=>1 },
396 { rightname=>'Edit global inventory', global=>1 },
398 { rightname=>'Dialup configuration' },
399 { rightname=>'Dialup global configuration', global=>1 },
401 { rightname=>'Broadband configuration' },
402 { rightname=>'Broadband global configuration', global=>1 },
404 { rightname=>'Alarm configuration' },
405 { rightname=>'Alarm global configuration', global=>1 },
407 { rightname=> 'Configure network monitoring', global=>1 },
409 #{ rightname=>'Edit employees', global=>1, },
410 #{ rightname=>'Edit employee groupss', global=>1, },
412 { rightname=>'Edit custom fields', global=>1 },
414 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
416 { rightname=>'Configuration download', }, #description of how it affects
417 #search/elements/search.html
429 Returns the full list of right names.
435 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
438 =item default_superuser_rights
440 Most (but not all) right names.
444 sub default_superuser_rights {
446 my %omit = map { $_=>1 } (
452 'Edit customer package dates',
454 'Usage: Time worked',
455 'Redownload resolved batches',
457 'Configuration download',
458 'View customers of all agents',
459 'View/link unlinked services',
463 'Void invoices',#people are overusing this when credits are more appropriate
465 'View legacy typeset statments',
468 no warnings 'uninitialized';
469 grep { ! $omit{$_} } $class->rights;
474 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
475 category names and values are list references of rights. Each element of the
476 list reference scalar right name or a hashref with the following keys:
480 =item rightname - Right name
482 =item desc - Extended right description
484 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
498 Damn those infernal six-legged creatures!
502 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>