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 referring customer',
112 'View customer history',
114 'Complimentary customer', #aka users-allow_comp
115 { 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
116 'Bill customer now', #NEW
117 'Bulk send customer notices', #NEW
121 # customer package rights
123 'Customer package rights' => [
124 'View customer packages', #NEW
125 'Order customer package',
127 'Change customer package',
128 'Bulk change customer packages',
129 'Edit customer package dates',
130 'Discount customer package', #NEW
131 'Custom discount customer package', #NEW
132 'Customize customer package',
133 'Suspend customer package',
134 'Suspend customer package later',
135 'Unsuspend customer package',
136 'Cancel customer package immediately',
137 'Cancel customer package later',
138 'Delay suspension events',
139 'Add on-the-fly cancel reason', #NEW
140 'Add on-the-fly suspend reason', #NEW
141 'Edit customer package invoice details', #NEW
142 'Edit customer package comments', #NEW
146 # customer service rights
148 'Customer service rights' => [
149 'View customer services', #NEW
150 'Provision customer service',
151 'Recharge customer service', #NEW
152 'Unprovision customer service',
153 'Change customer service', #NEWNEW
155 'Edit home dir', #NEW
156 'Edit www config', #NEW
157 'Edit domain catchall', #NEW
158 'Edit domain nameservice', #NEW
159 'Manage domain registration',
161 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
165 # customer invoice/financial info rights
167 'Customer invoice / financial info rights' => [
169 'Resend invoices', #NEWNEW
170 'Delete invoices', #new, but no need to phase in
171 'View customer tax exemptions', #yow
172 'Add customer tax adjustment', #new, but no need to phase in
173 'View customer batched payments', #NEW
174 'View customer pending payments', #NEW
175 'Edit customer pending payments', #NEW
176 'View customer billing events', #NEW
180 # customer payment rights
182 'Customer payment rights' => [
184 'Post payment batch',
185 'Apply payment', #NEWNEW
186 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
188 { rightname=>'Refund payment', desc=>'Enable refund of existing customer payments.' },
190 { 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.
195 # customer credit rights
197 'Customer credit and refund rights' => [
199 'Apply credit', #NEWNEW
200 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
201 { 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.
202 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
203 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
204 'Delete refund', #NEW
205 'Add on-the-fly credit reason', #NEW
209 # customer voiding rights..
211 'Customer void rights' => [
212 { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
213 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
215 { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
221 # note/attachment rights...
223 'Customer note and attachment rights' => [
224 'Add customer note', #NEW
225 'Edit customer note', #NEW
226 'View attachments', #NEW
227 'Browse attachments', #NEW
228 'Download attachment', #NEW
229 'Add attachment', #NEW
230 'Edit attachment', #NEW
231 'Delete attachment', #NEW
232 'View deleted attachments', #NEW
233 'Undelete attachment', #NEW
234 'Purge attachment', #NEW
238 # report/listing rights...
240 'Reporting/listing rights' => [
242 'List zip codes', #NEW
246 'List service passwords',
248 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
249 'Billing event reports',
250 'Receivables report',
257 'Miscellaneous rights' => [
258 { rightname=>'Job queue', global=>1 },
259 { rightname=>'Time queue', global=>1 },
260 { rightname=>'Process batches', global=>1 },
261 { rightname=>'Reprocess batches', global=>1 },
262 { rightname=>'Redownload resolved batches', global=>1 },
263 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
264 { rightname=>'Export', global=>1 },
265 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
271 #'Database access rights' => [
272 { rightname=>'Raw SQL', global=>1 }, #NEW
276 # setup/config rights
278 'Configuration rights' => [
279 'Edit advertising sources',
280 { rightname=>'Edit global advertising sources', global=>1 },
282 'Edit package definitions',
283 { rightname=>'Edit global package definitions', global=>1 },
285 'Edit billing events',
286 { rightname=>'Edit global billing events', global=>1 },
289 { rightname=>'Edit global inventory', global=>1 },
291 { rightname=>'Dialup configuration' },
292 { rightname=>'Dialup global configuration', global=>1 },
294 { rightname=>'Broadband configuration' },
295 { rightname=>'Broadband global configuration', global=>1 },
297 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
299 { rightname=>'Configuration download', }, #description of how it affects
300 #search/elements/search.html
312 Returns the full list of right names.
318 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
321 =item default_superuser_rights
323 Most (but not all) right names.
327 sub default_superuser_rights {
329 my %omit = map { $_=>1 } (
336 'Redownload resolved batches',
338 'Configuration download',
341 no warnings 'uninitialized';
342 grep { ! $omit{$_} } $class->rights;
347 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
348 category names and values are list references of rights. Each element of the
349 list reference scalar right name or a hashref with the following keys:
353 =item rightname - Right name
355 =item desc - Extended right description
357 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
371 Damn those infernal six-legged creatures!
375 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>