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',
156 'Change package contract end date',
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
190 'View customer tax exemptions', #yow
191 'Edit customer tax exemptions', #NEWNEW
192 'Add customer tax adjustment', #new, but no need to phase in
193 'View customer batched payments', #NEW
194 'View customer pending payments', #NEW
195 'Edit customer pending payments', #NEW
196 'View customer billing events', #NEW
197 'View legacy typeset statements', #new, but no need to phase in
201 # customer payment rights
203 'Customer payment rights' => [
205 { rightname=>'Post payment', desc=>'Make check or cash payments.' },
206 { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
207 'Post check payment',
209 'Post payment batch',
210 'Apply payment', #NEWNEW
211 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
212 { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
213 'Process credit card payment',
214 'Process Echeck payment',
218 # customer credit rights
220 'Customer credit and refund rights' => [
222 { rightname=>'Backdate credit', desc=>'Enable credits to be posted for days other than today.' },
223 'Credit line items', #NEWNEWNEW
224 'Apply credit', #NEWNEW
225 'Void credit', #NEWER than things marked NEWNEWNEW
226 'Unvoid credit', #NEWER than things marked NEWNEWNEW
227 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
229 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
232 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
233 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
234 'Refund credit card payment',
235 'Refund Echeck payment',
236 'Delete refund', #NEW
237 'Add on-the-fly credit reason', #NEW
238 'Add on-the-fly void reason',
239 'Add on-the-fly refund reason', #NEW
243 # customer voiding rights..
245 'Customer payment void rights' => [
246 { rightname=>'Credit card void', desc=>'Enable local-only voiding of credit card payments in addition to refunds against the payment gateway.' }, #aka. cc-void
247 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
249 { rightname=>'Unvoid payments', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
255 # note/attachment rights...
257 'Customer note and attachment rights' => [
258 'Add customer note', #NEW
259 'Edit customer note', #NEW
260 'View attachments', #NEW
261 'Browse attachments', #NEW
262 'Download attachment', #NEW
263 'Add attachment', #NEW
264 'Edit attachment', #NEW
265 'Delete attachment', #NEW
266 'View deleted attachments', #NEW
267 'Undelete attachment', #NEW
268 'Purge attachment', #NEW
272 # report/listing rights...
274 'Reporting/listing rights' => [
278 'List all customers',
279 'Advanced customer search',
280 'List zip codes', #NEW
284 'Summarize packages',
286 'List service passwords',
288 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
289 'Billing event reports',
290 'Receivables report',
292 { rightname=>'Send reports to customers', global=>1 },
293 { rightname=> 'List inventory', global=>1 },
294 { rightname=>'View email logs', global=>1 },
295 { rightname=>'View system logs' },
297 'Download report data',
298 'Services: Accounts',
299 'Services: Accounts: Advanced search',
301 'Services: Certificates',
302 'Services: Mail forwards',
303 'Services: Virtual hosting services',
304 'Services: Wireless broadband services',
305 'Services: Wireless broadband services: Advanced search',
307 'Services: Cable subscribers',
308 'Services: Conferencing',
309 'Services: Dish services',
310 'Services: Hardware',
311 'Services: Hardware: Advanced search',
312 'Services: Phone numbers',
313 'Services: Phone numbers: Advanced search',
316 'Services: Mailing lists',
317 'Services: Alarm services',
319 'Services: Circuits',
321 'Services: Fiber: Advanced search',
322 'Services: External services',
323 'Usage: RADIUS sessions',
324 'Usage: Call Detail Records (CDRs)',
325 'Usage: Unrateable CDRs',
326 'Usage: Time worked',
327 #gone in 4.x as a distinct ACL (for now?) { 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 } (
448 'Edit customer package dates',
450 'Usage: Time worked',
451 'Redownload resolved batches',
453 'Configuration download',
454 'View customers of all agents',
455 'View/link unlinked services',
459 'Void invoices',#people are overusing this when credits are more appropriate
461 'View legacy typeset statments',
464 no warnings 'uninitialized';
465 grep { ! $omit{$_} } $class->rights;
470 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
471 category names and values are list references of rights. Each element of the
472 list reference scalar right name or a hashref with the following keys:
476 =item rightname - Right name
478 =item desc - Extended right description
480 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
494 Damn those infernal six-legged creatures!
498 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>