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 'Edit customer invoice terms',
113 'View customer history',
115 'Unsuspend customer',
117 'Complimentary customer', #aka users-allow_comp
119 'Merge customer across agents',
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 'Customize billing during suspension',
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 start date',
158 'Change package contract end date',
162 # customer service rights
164 'Customer service rights' => [
165 'View customer services', #NEW
166 'Provision customer service',
167 'Bulk provision customer service',
168 'Bulk move customer services', #NEWNEW
169 'Recharge customer service', #NEW
170 'Unprovision customer service',
171 'Change customer service', #NEWNEW
174 'Edit home dir', #NEW
175 'Edit www config', #NEW
176 'Edit domain catchall', #NEW
177 'Edit domain nameservice', #NEW
178 'Manage domain registration',
180 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
184 # customer invoice/financial info rights
186 'Customer invoice / financial info rights' => [
188 'Resend invoices', #NEWNEW
189 { 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',
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
231 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
234 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
235 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
236 'Refund credit card payment',
237 'Refund Echeck payment',
238 'Delete refund', #NEW
239 'Add on-the-fly credit reason', #NEW
240 'Add on-the-fly void reason',
241 'Add on-the-fly refund reason', #NEW
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 'Delete customer note', #NEWEST
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',
294 'Basic payment and refund reports',
296 { rightname=>'Send reports to customers', global=>1 },
297 { rightname=> 'List inventory', global=>1 },
298 { rightname=>'View email logs', global=>1 },
299 { rightname=>'View system logs' },
301 'Download report data',
302 'Customers: Customer churn report',
303 'Services: Accounts',
304 'Services: Accounts: Advanced search',
306 'Services: Certificates',
307 'Services: Mail forwards',
308 'Services: Virtual hosting services',
309 'Services: Wireless broadband services',
310 'Services: Wireless broadband services: Advanced search',
312 'Services: Cable subscribers',
313 'Services: Conferencing',
314 'Services: Dish services',
315 'Services: Hardware',
316 'Services: Hardware: Advanced search',
317 'Services: Phone numbers',
318 'Services: Phone numbers: Advanced search',
321 'Services: Mailing lists',
322 'Services: Alarm services',
324 'Services: Circuits',
326 'Services: Fiber: Advanced search',
327 'Services: External services',
328 'Usage: RADIUS sessions',
329 'Usage: Call Detail Records (CDRs)',
330 'Usage: Unrateable CDRs',
331 'Usage: Time worked',
332 #gone in 4.x as a distinct ACL (for now?) { rightname=>'Employees: Commission Report', global=>1 },
333 { rightname=>'Employees: Audit Report', global=>1 },
335 #{ rightname => 'List customers of all agents', global=>1 },
341 'Miscellaneous rights' => [
342 { rightname=>'Job queue', global=>1 },
343 { rightname=>'Time queue', global=>1 },
344 { rightname=>'Process batches', }, #Process payment batches
345 { rightname=>'Process global batches', global=>1 }, #Process global payment batches
346 { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
347 { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
348 { rightname=>'Process invoice batches', },
349 { rightname=>'Process global invoice batches', global=>1 },
350 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
351 { rightname=>'Export', global=>1 },
352 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
358 #'Database access rights' => [
359 { rightname=>'Raw SQL', global=>1 }, #NEW
362 #'Employee preference rights' => [
363 { rightname=>'Employee preference telephony integration' },
366 #'RT preference rights' => [
367 { rightname=>'RT activity notification' },
373 # setup/config rights
375 'Configuration rights' => [
376 'Edit advertising sources',
377 { rightname=>'Edit global advertising sources', global=>1 },
381 'Edit package definitions',
382 { rightname=>'Edit global package definitions', global=>1 },
383 'Edit package definition costs',
385 'Bulk edit package definitions',
387 'Edit FCC report configuration',
388 { rightname => 'Edit FCC report configuration for all agents', global=>1 },
391 #{ rightname=>'Edit global CDR rates', global=>1, },
393 'Edit fee definitions',
394 { rightname=>'Edit global fee definitions', global=>1 },
396 'Edit billing events',
397 { rightname=>'Edit global billing events', global=>1 },
400 { rightname=>'View global templates', global=>1 },
402 { rightname=>'Edit global templates', global=>1 },
405 { rightname=>'Edit global inventory', global=>1 },
407 { rightname=>'Dialup configuration' },
408 { rightname=>'Dialup global configuration', global=>1 },
410 { rightname=>'Broadband configuration' },
411 { rightname=>'Broadband global configuration', global=>1 },
413 { rightname=>'Alarm configuration' },
414 { rightname=>'Alarm global configuration', global=>1 },
416 { rightname=> 'Configure network monitoring', global=>1 },
418 #{ rightname=>'Edit employees', global=>1, },
419 #{ rightname=>'Edit employee groupss', global=>1, },
421 { rightname=>'Edit custom fields', global=>1 },
423 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
425 { rightname=>'Configuration download', }, #description of how it affects
426 #search/elements/search.html
438 Returns the full list of right names.
444 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
447 =item default_superuser_rights
449 Most (but not all) right names.
453 sub default_superuser_rights {
455 my %omit = map { $_=>1 } (
457 'Edit customer package dates',
459 'Usage: Time worked',
460 'Redownload resolved batches',
462 'Configuration download',
463 'View customers of all agents',
464 'View/link unlinked services',
468 'Void invoices',#people are overusing this when credits are more appropriate
470 'View legacy typeset statments',
473 no warnings 'uninitialized';
474 grep { ! $omit{$_} } $class->rights;
479 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
480 category names and values are list references of rights. Each element of the
481 list reference scalar right name or a hashref with the following keys:
485 =item rightname - Right name
487 =item desc - Extended right description
489 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
503 Damn those infernal six-legged creatures!
507 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>