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
157 'Change package contract end date',
161 # customer service rights
163 'Customer service rights' => [
164 'View customer services', #NEW
165 'Provision customer service',
166 'Bulk provision customer service',
167 'Bulk move customer services', #NEWNEW
168 'Recharge customer service', #NEW
169 'Unprovision customer service',
170 'Change customer service', #NEWNEW
173 'Edit home dir', #NEW
174 'Edit www config', #NEW
175 'Edit domain catchall', #NEW
176 'Edit domain nameservice', #NEW
177 'Manage domain registration',
179 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
183 # customer invoice/financial info rights
185 'Customer invoice / financial info rights' => [
187 'Resend invoices', #NEWNEW
188 { rightname=>'Print and mail invoices', desc=>"Print and mail via Freeside's web service", }, ##NEWER than NEWNEWNEW
192 'View customer tax exemptions', #yow
193 'Edit customer tax exemptions', #NEWNEW
194 'Add customer tax adjustment', #new, but no need to phase in
195 'View customer batched payments', #NEW
196 'View customer pending payments', #NEW
197 'Edit customer pending payments', #NEW
198 'View customer billing events', #NEW
199 'View legacy typeset statements', #new, but no need to phase in
203 # customer payment rights
205 'Customer payment rights' => [
207 { rightname=>'Post payment', desc=>'Make check or cash payments.' },
208 { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
209 'Post check payment',
211 'Post payment batch',
212 'Apply payment', #NEWNEW
213 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
214 { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
215 'Process credit card payment',
216 'Process Echeck payment',
217 { 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.
221 # customer credit rights
223 'Customer credit and refund rights' => [
225 { rightname=>'Backdate credit', desc=>'Enable credits to be posted for days other than today.' },
226 'Credit line items', #NEWNEWNEW
227 'Apply credit', #NEWNEW
228 'Void credit', #NEWER than things marked NEWNEWNEW
229 'Unvoid credit', #NEWER than things marked NEWNEWNEW
230 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
231 { 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.
233 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
236 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
237 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
238 'Refund credit card payment',
239 'Refund Echeck payment',
240 'Delete refund', #NEW
241 'Add on-the-fly credit reason', #NEW
242 'Add on-the-fly void credit reason',
246 # customer voiding rights..
248 'Customer payment void rights' => [
249 { rightname=>'Credit card void', desc=>'Enable local-only voiding of credit card payments in addition to refunds against the payment gateway.' }, #aka. cc-void
250 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
252 { rightname=>'Unvoid payments', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
258 # note/attachment rights...
260 'Customer note and attachment rights' => [
261 'Add customer note', #NEW
262 'Edit customer note', #NEW
263 'View attachments', #NEW
264 'Browse attachments', #NEW
265 'Download attachment', #NEW
266 'Add attachment', #NEW
267 'Edit attachment', #NEW
268 'Delete attachment', #NEW
269 'View deleted attachments', #NEW
270 'Undelete attachment', #NEW
271 'Purge attachment', #NEW
275 # report/listing rights...
277 'Reporting/listing rights' => [
281 'List all customers',
282 'Advanced customer search',
283 'List zip codes', #NEW
287 'Summarize packages',
289 'List service passwords',
291 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
292 'Billing event reports',
293 'Receivables report',
295 { rightname=>'Send reports to customers', global=>1 },
296 { rightname=> 'List inventory', global=>1 },
297 { rightname=>'View email logs', global=>1 },
298 { rightname=>'View system logs' },
300 'Download report data',
301 'Services: Accounts',
302 'Services: Accounts: Advanced search',
304 'Services: Certificates',
305 'Services: Mail forwards',
306 'Services: Virtual hosting services',
307 'Services: Wireless broadband services',
308 'Services: Wireless broadband services: Advanced search',
310 'Services: Cable subscribers',
311 'Services: Dish services',
312 'Services: Hardware',
313 'Services: Hardware: Advanced search',
314 'Services: Phone numbers',
315 'Services: Phone numbers: Advanced search',
318 'Services: Mailing lists',
319 'Services: Alarm services',
320 'Services: External services',
321 'Services: Circuits',
323 'Services: Fiber: Advanced search',
324 'Usage: RADIUS sessions',
325 'Usage: Call Detail Records (CDRs)',
326 'Usage: Unrateable CDRs',
327 'Usage: Time worked',
328 { rightname=>'Employees: Commission Report', global=>1 },
329 { rightname=>'Employees: Audit Report', global=>1 },
331 #{ rightname => 'List customers of all agents', global=>1 },
337 'Miscellaneous rights' => [
338 { rightname=>'Job queue', global=>1 },
339 { rightname=>'Time queue', global=>1 },
340 { rightname=>'Process batches', }, #Process payment batches
341 { rightname=>'Process global batches', global=>1 }, #Process global payment batches
342 { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
343 { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
344 { rightname=>'Process invoice batches', },
345 { rightname=>'Process global invoice batches', global=>1 },
346 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
347 { rightname=>'Export', global=>1 },
348 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
354 #'Database access rights' => [
355 { rightname=>'Raw SQL', global=>1 }, #NEW
358 #'Employee preference rights' => [
359 { rightname=>'Employee preference telephony integration' },
365 # setup/config rights
367 'Configuration rights' => [
368 'Edit advertising sources',
369 { rightname=>'Edit global advertising sources', global=>1 },
373 'Edit package definitions',
374 { rightname=>'Edit global package definitions', global=>1 },
375 'Edit package definition costs',
377 'Bulk edit package definitions',
379 'Edit FCC report configuration',
380 { rightname => 'Edit FCC report configuration for all agents', global=>1 },
383 #{ rightname=>'Edit global CDR rates', global=>1, },
385 'Edit fee definitions',
386 { rightname=>'Edit global fee definitions', global=>1 },
388 'Edit billing events',
389 { rightname=>'Edit global billing events', global=>1 },
392 { rightname=>'View global templates', global=>1 },
394 { rightname=>'Edit global templates', global=>1 },
397 { rightname=>'Edit global inventory', global=>1 },
399 { rightname=>'Dialup configuration' },
400 { rightname=>'Dialup global configuration', global=>1 },
402 { rightname=>'Broadband configuration' },
403 { rightname=>'Broadband global configuration', global=>1 },
405 { rightname=>'Alarm configuration' },
406 { rightname=>'Alarm global configuration', global=>1 },
408 { rightname=> 'Configure network monitoring', global=>1 },
410 #{ rightname=>'Edit employees', global=>1, },
411 #{ rightname=>'Edit employee groupss', global=>1, },
413 { rightname=>'Edit custom fields', global=>1 },
415 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
417 { rightname=>'Configuration download', }, #description of how it affects
418 #search/elements/search.html
430 Returns the full list of right names.
436 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
439 =item default_superuser_rights
441 Most (but not all) right names.
445 sub default_superuser_rights {
447 my %omit = map { $_=>1 } (
453 'Edit customer package dates',
455 'Usage: Time worked',
456 'Redownload resolved batches',
458 'Configuration download',
459 'View customers of all agents',
460 'View/link unlinked services',
464 'Void invoices',#people are overusing this when credits are more appropriate
466 'View legacy typeset statments',
469 no warnings 'uninitialized';
470 grep { ! $omit{$_} } $class->rights;
475 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
476 category names and values are list references of rights. Each element of the
477 list reference scalar right name or a hashref with the following keys:
481 =item rightname - Right name
483 =item desc - Extended right description
485 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
499 Damn those infernal six-legged creatures!
503 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>