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',
104 # basic customer rights
106 'Customer rights' => [
109 #'View Customer | View tickets',
111 'Edit customer basics',
112 'Edit customer tags',
113 'Edit referring customer',
114 'Edit customer addresses',
115 'Edit customer billing information',
116 'View customer history',
118 'Unsuspend customer',
120 'Complimentary customer', #aka users-allow_comp
122 'Merge customer across agents',
123 { 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
124 'Bill customer now', #NEW
125 'Bulk send customer notices', #NEW
126 { rightname=>'View customers of all agents', global=>1 },
130 # customer package rights
132 'Customer package rights' => [
133 'View customer packages', #NEW
134 'Order customer package',
136 'Change customer package',
137 'Bulk change customer packages',
138 'Edit customer package dates',
139 'Discount customer package', #NEW
140 'Custom discount customer package', #NEW
141 'Customize customer package',
142 'Suspend customer package',
143 'Suspend customer package later',
144 'Unsuspend customer package',
145 'Cancel customer package immediately',
146 'Cancel customer package later',
147 'Un-cancel customer package',
148 'Delay suspension events',
149 'Add on-the-fly cancel reason', #NEW
150 'Add on-the-fly suspend reason', #NEW
151 'Edit customer package invoice details', #NEW
152 'Edit customer package comments', #NEW
153 'Qualify service', #NEW
154 'Waive setup fee', #NEW
158 # customer service rights
160 'Customer service rights' => [
161 'View customer services', #NEW
162 'Provision customer service',
163 'Bulk provision customer service',
164 'Recharge customer service', #NEW
165 'Unprovision customer service',
166 'Change customer service', #NEWNEW
168 'Edit home dir', #NEW
169 'Edit www config', #NEW
170 'Edit domain catchall', #NEW
171 'Edit domain nameservice', #NEW
172 'Manage domain registration',
174 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
178 # customer invoice/financial info rights
180 'Customer invoice / financial info rights' => [
182 'Resend invoices', #NEWNEW
183 'Delete invoices', #new, but no need to phase in
184 'View customer tax exemptions', #yow
185 'Add customer tax adjustment', #new, but no need to phase in
186 'View customer batched payments', #NEW
187 'View customer pending payments', #NEW
188 'Edit customer pending payments', #NEW
189 'View customer billing events', #NEW
193 # customer payment rights
195 'Customer payment rights' => [
197 { rightname=>'Post payment', desc=>'Make check or cash payments.' },
198 { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
199 'Post check payment',
201 'Post payment batch',
202 'Apply payment', #NEWNEW
203 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
204 { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
205 'Process credit card payment',
206 'Process Echeck payment',
207 { 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.
211 # customer credit rights
213 'Customer credit and refund rights' => [
215 'Apply credit', #NEWNEW
216 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
217 { 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.
219 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
222 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
223 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
224 'Refund credit card payment',
225 'Refund Echeck payment',
226 'Delete refund', #NEW
227 'Add on-the-fly credit reason', #NEW
231 # customer voiding rights..
233 'Customer void rights' => [
234 { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
235 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
237 { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
243 # note/attachment rights...
245 'Customer note and attachment rights' => [
246 'Add customer note', #NEW
247 'Edit customer note', #NEW
248 'View attachments', #NEW
249 'Browse attachments', #NEW
250 'Download attachment', #NEW
251 'Add attachment', #NEW
252 'Edit attachment', #NEW
253 'Delete attachment', #NEW
254 'View deleted attachments', #NEW
255 'Undelete attachment', #NEW
256 'Purge attachment', #NEW
260 # report/listing rights...
262 'Reporting/listing rights' => [
264 'List all customers',
265 'Advanced customer search',
266 'List zip codes', #NEW
269 'Summarize packages',
271 'List service passwords',
273 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
274 'Billing event reports',
275 'Receivables report',
277 { rightname=> 'List inventory', global=>1 },
278 { rightname=>'View email logs', global=>1 },
280 'Download report data',
281 'Services: Accounts',
282 'Services: Accounts: Advanced search',
284 'Services: Certificates',
285 'Services: Mail forwards',
286 'Services: Virtual hosting services',
287 'Services: Wireless broadband services',
288 'Services: Wireless broadband services: Advanced search',
290 'Services: Dish services',
291 'Services: Hardware',
292 'Services: Hardware: Advanced search',
293 'Services: Phone numbers',
296 'Services: Mailing lists',
297 'Services: External services',
298 'Usage: RADIUS sessions',
299 'Usage: Call Detail Records (CDRs)',
300 'Usage: Unrateable CDRs',
301 'Usage: Time worked',
303 #{ rightname => 'List customers of all agents', global=>1 },
309 'Miscellaneous rights' => [
310 { rightname=>'Job queue', global=>1 },
311 { rightname=>'Time queue', global=>1 },
312 { rightname=>'Process batches', }, #Process payment batches
313 { rightname=>'Process global batches', global=>1 }, #Process global payment batches
314 { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
315 { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
316 { rightname=>'Process invoice batches', },
317 { rightname=>'Process global invoice batches', global=>1 },
318 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
319 { rightname=>'Export', global=>1 },
320 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
326 #'Database access rights' => [
327 { rightname=>'Raw SQL', global=>1 }, #NEW
331 # setup/config rights
333 'Configuration rights' => [
334 'Edit advertising sources',
335 { rightname=>'Edit global advertising sources', global=>1 },
337 'Edit package definitions',
338 { rightname=>'Edit global package definitions', global=>1 },
340 'Edit billing events',
341 { rightname=>'Edit global billing events', global=>1 },
344 { rightname=>'View global templates', global=>1 },
346 { rightname=>'Edit global templates', global=>1 },
349 { rightname=>'Edit global inventory', global=>1 },
351 { rightname=>'Dialup configuration' },
352 { rightname=>'Dialup global configuration', global=>1 },
354 { rightname=>'Broadband configuration' },
355 { rightname=>'Broadband global configuration', global=>1 },
357 { rightname=> 'Configure network monitoring', global=>1 },
359 #{ rightname=>'Edit employees', global=>1, },
360 #{ rightname=>'Edit employee groupss', global=>1, },
362 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
364 { rightname=>'Configuration download', }, #description of how it affects
365 #search/elements/search.html
377 Returns the full list of right names.
383 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
386 =item default_superuser_rights
388 Most (but not all) right names.
392 sub default_superuser_rights {
394 my %omit = map { $_=>1 } (
400 'Edit customer package dates',
402 'Usage: Time worked',
403 'Redownload resolved batches',
405 'Configuration download',
406 'View customers of all agents',
407 'View/link unlinked services',
411 'Edit customer package dates',
414 no warnings 'uninitialized';
415 grep { ! $omit{$_} } $class->rights;
420 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
421 category names and values are list references of rights. Each element of the
422 list reference scalar right name or a hashref with the following keys:
426 =item rightname - Right name
428 =item desc - Extended right description
430 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
444 Damn those infernal six-legged creatures!
448 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>