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' => [
99 #'View customer contacts',
101 'Generate quotation',
105 # basic customer rights
107 'Customer rights' => [
110 #'View Customer | View tickets',
112 'Edit customer tags',
113 'Edit referring customer',
114 'View customer history',
116 'Unsuspend customer',
118 'Complimentary customer', #aka users-allow_comp
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 'Change 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
155 # customer service rights
157 'Customer service rights' => [
158 'View customer services', #NEW
159 'Provision customer service',
160 'Bulk provision customer service',
161 'Recharge customer service', #NEW
162 'Unprovision customer service',
163 'Change customer service', #NEWNEW
165 'Edit home dir', #NEW
166 'Edit www config', #NEW
167 'Edit domain catchall', #NEW
168 'Edit domain nameservice', #NEW
169 'Manage domain registration',
171 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
175 # customer invoice/financial info rights
177 'Customer invoice / financial info rights' => [
179 'Resend invoices', #NEWNEW
180 'Delete invoices', #new, but no need to phase in
181 'View customer tax exemptions', #yow
182 'Add customer tax adjustment', #new, but no need to phase in
183 'View customer batched payments', #NEW
184 'View customer pending payments', #NEW
185 'Edit customer pending payments', #NEW
186 'View customer billing events', #NEW
190 # customer payment rights
192 'Customer payment rights' => [
194 { rightname=>'Post payment', desc=>'Make check or cash payments.' },
195 { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
196 'Post check payment',
198 'Post payment batch',
199 'Apply payment', #NEWNEW
200 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
201 { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
202 'Process credit card payment',
203 'Process Echeck payment',
204 { 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.
208 # customer credit rights
210 'Customer credit and refund rights' => [
212 'Apply credit', #NEWNEW
213 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
214 { 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.
216 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
219 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
220 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
221 'Refund credit card payment',
222 'Refund Echeck payment',
223 'Delete refund', #NEW
224 'Add on-the-fly credit reason', #NEW
228 # customer voiding rights..
230 'Customer void rights' => [
231 { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
232 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
234 { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
240 # note/attachment rights...
242 'Customer note and attachment rights' => [
243 'Add customer note', #NEW
244 'Edit customer note', #NEW
245 'View attachments', #NEW
246 'Browse attachments', #NEW
247 'Download attachment', #NEW
248 'Add attachment', #NEW
249 'Edit attachment', #NEW
250 'Delete attachment', #NEW
251 'View deleted attachments', #NEW
252 'Undelete attachment', #NEW
253 'Purge attachment', #NEW
257 # report/listing rights...
259 'Reporting/listing rights' => [
261 'List all customers',
262 'Advanced customer search',
263 'List zip codes', #NEW
266 'Summarize packages',
268 'List service passwords',
270 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
271 'Billing event reports',
272 'Receivables report',
274 { rightname=> 'List inventory', global=>1 },
275 { rightname=>'View email logs', global=>1 },
277 'Download report data',
278 'Services: Accounts',
279 'Services: Accounts: Advanced search',
281 'Services: Certificates',
282 'Services: Mail forwards',
283 'Services: Virtual hosting services',
284 'Services: Wireless broadband services',
285 'Services: Wireless broadband services: Advanced search',
287 'Services: Dish services',
288 'Services: Hardware',
289 'Services: Hardware: Advanced search',
290 'Services: Phone numbers',
293 'Services: Mailing lists',
294 'Services: External services',
295 'Usage: RADIUS sessions',
296 'Usage: Call Detail Records (CDRs)',
297 'Usage: Unrateable CDRs',
298 'Usage: Time worked',
300 #{ rightname => 'List customers of all agents', global=>1 },
306 'Miscellaneous rights' => [
307 { rightname=>'Job queue', global=>1 },
308 { rightname=>'Time queue', global=>1 },
309 { rightname=>'Process batches', }, #Process payment batches
310 { rightname=>'Process global batches', global=>1 }, #Process global payment batches
311 { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
312 { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
313 { rightname=>'Process invoice batches', },
314 { rightname=>'Process global invoice batches', global=>1 },
315 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
316 { rightname=>'Export', global=>1 },
317 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
323 #'Database access rights' => [
324 { rightname=>'Raw SQL', global=>1 }, #NEW
328 # setup/config rights
330 'Configuration rights' => [
331 'Edit advertising sources',
332 { rightname=>'Edit global advertising sources', global=>1 },
334 'Edit package definitions',
335 { rightname=>'Edit global package definitions', global=>1 },
337 'Edit billing events',
338 { rightname=>'Edit global billing events', global=>1 },
341 { rightname=>'View global templates', global=>1 },
343 { rightname=>'Edit global templates', global=>1 },
346 { rightname=>'Edit global inventory', global=>1 },
348 { rightname=>'Dialup configuration' },
349 { rightname=>'Dialup global configuration', global=>1 },
351 { rightname=>'Broadband configuration' },
352 { rightname=>'Broadband global configuration', global=>1 },
354 { rightname=> 'Configure network monitoring', global=>1 },
356 #{ rightname=>'Edit employees', global=>1, },
357 #{ rightname=>'Edit employee groupss', global=>1, },
359 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
361 { rightname=>'Configuration download', }, #description of how it affects
362 #search/elements/search.html
374 Returns the full list of right names.
380 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
383 =item default_superuser_rights
385 Most (but not all) right names.
389 sub default_superuser_rights {
391 my %omit = map { $_=>1 } (
397 'Edit customer package dates',
399 'Redownload resolved batches',
401 'Configuration download',
402 'View customers of all agents',
403 'View/link unlinked services',
409 no warnings 'uninitialized';
410 grep { ! $omit{$_} } $class->rights;
415 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
416 category names and values are list references of rights. Each element of the
417 list reference scalar right name or a hashref with the following keys:
421 =item rightname - Right name
423 =item desc - Extended right description
425 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
439 Damn those infernal six-legged creatures!
443 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>