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 tags',
112 'Edit referring customer',
113 'View customer history',
115 'Complimentary customer', #aka users-allow_comp
117 { 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
118 'Bill customer now', #NEW
119 'Bulk send customer notices', #NEW
120 { rightname=>'View customers of all agents', global=>1 },
124 # customer package rights
126 'Customer package rights' => [
127 'View customer packages', #NEW
128 'Order customer package',
130 'Change customer package',
131 'Bulk change customer packages',
132 'Edit customer package dates',
133 'Discount customer package', #NEW
134 'Custom discount customer package', #NEW
135 'Customize customer package',
136 'Suspend customer package',
137 'Suspend customer package later',
138 'Unsuspend customer package',
139 'Cancel customer package immediately',
140 'Cancel customer package later',
141 'Delay suspension events',
142 'Add on-the-fly cancel reason', #NEW
143 'Add on-the-fly suspend reason', #NEW
144 'Edit customer package invoice details', #NEW
145 'Edit customer package comments', #NEW
149 # customer service rights
151 'Customer service rights' => [
152 'View customer services', #NEW
153 'Provision customer service',
154 'Recharge customer service', #NEW
155 'Unprovision customer service',
156 'Change customer service', #NEWNEW
158 'Edit home dir', #NEW
159 'Edit www config', #NEW
160 'Edit domain catchall', #NEW
161 'Edit domain nameservice', #NEW
162 'Manage domain registration',
164 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
168 # customer invoice/financial info rights
170 'Customer invoice / financial info rights' => [
172 'Resend invoices', #NEWNEW
173 'Delete invoices', #new, but no need to phase in
174 'View customer tax exemptions', #yow
175 'Add customer tax adjustment', #new, but no need to phase in
176 'View customer batched payments', #NEW
177 'View customer pending payments', #NEW
178 'Edit customer pending payments', #NEW
179 'View customer billing events', #NEW
183 # customer payment rights
185 'Customer payment rights' => [
187 'Post payment batch',
188 'Apply payment', #NEWNEW
189 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
191 { rightname=>'Refund payment', desc=>'Enable refund of existing customer payments.' },
193 { 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.
198 # customer credit rights
200 'Customer credit and refund rights' => [
202 'Apply credit', #NEWNEW
203 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
204 { 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.
205 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
206 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
207 'Delete refund', #NEW
208 'Add on-the-fly credit reason', #NEW
212 # customer voiding rights..
214 'Customer void rights' => [
215 { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
216 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
218 { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
224 # note/attachment rights...
226 'Customer note and attachment rights' => [
227 'Add customer note', #NEW
228 'Edit customer note', #NEW
229 'View attachments', #NEW
230 'Browse attachments', #NEW
231 'Download attachment', #NEW
232 'Add attachment', #NEW
233 'Edit attachment', #NEW
234 'Delete attachment', #NEW
235 'View deleted attachments', #NEW
236 'Undelete attachment', #NEW
237 'Purge attachment', #NEW
241 # report/listing rights...
243 'Reporting/listing rights' => [
245 'List zip codes', #NEW
249 'List service passwords',
251 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
252 'Billing event reports',
253 'Receivables report',
256 #{ rightname => 'List customers of all agents', global=>1 },
262 'Miscellaneous rights' => [
263 { rightname=>'Job queue', global=>1 },
264 { rightname=>'Time queue', global=>1 },
265 { rightname=>'Process batches', global=>1 },
266 { rightname=>'Reprocess batches', global=>1 },
267 { rightname=>'Redownload resolved batches', global=>1 },
268 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
269 { rightname=>'Export', global=>1 },
270 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
276 #'Database access rights' => [
277 { rightname=>'Raw SQL', global=>1 }, #NEW
281 # setup/config rights
283 'Configuration rights' => [
284 'Edit advertising sources',
285 { rightname=>'Edit global advertising sources', global=>1 },
287 'Edit package definitions',
288 { rightname=>'Edit global package definitions', global=>1 },
290 'Edit billing events',
291 { rightname=>'Edit global billing events', global=>1 },
294 { rightname=>'Edit global templates', global=>1 },
297 { rightname=>'Edit global inventory', global=>1 },
299 { rightname=>'Dialup configuration' },
300 { rightname=>'Dialup global configuration', global=>1 },
302 { rightname=>'Broadband configuration' },
303 { rightname=>'Broadband global configuration', global=>1 },
305 #{ rightname=>'Edit employees', global=>1, },
306 #{ rightname=>'Edit employee groupss', global=>1, },
308 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
310 { rightname=>'Configuration download', }, #description of how it affects
311 #search/elements/search.html
323 Returns the full list of right names.
329 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
332 =item default_superuser_rights
334 Most (but not all) right names.
338 sub default_superuser_rights {
340 my %omit = map { $_=>1 } (
347 'Redownload resolved batches',
349 'Configuration download',
350 'View customers of all agents',
353 no warnings 'uninitialized';
354 grep { ! $omit{$_} } $class->rights;
359 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
360 category names and values are list references of rights. Each element of the
361 list reference scalar right name or a hashref with the following keys:
365 =item rightname - Right name
367 =item desc - Extended right description
369 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
383 Damn those infernal six-legged creatures!
387 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>