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
146 'Qualify service', #NEW
147 'Waive setup fee', #NEW
151 # customer service rights
153 'Customer service rights' => [
154 'View customer services', #NEW
155 'Provision customer service',
156 'Bulk provision customer service',
157 'Recharge customer service', #NEW
158 'Unprovision customer service',
159 'Change customer service', #NEWNEW
161 'Edit home dir', #NEW
162 'Edit www config', #NEW
163 'Edit domain catchall', #NEW
164 'Edit domain nameservice', #NEW
165 'Manage domain registration',
167 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
171 # customer invoice/financial info rights
173 'Customer invoice / financial info rights' => [
175 'Resend invoices', #NEWNEW
176 'Delete invoices', #new, but no need to phase in
177 'View customer tax exemptions', #yow
178 'Add customer tax adjustment', #new, but no need to phase in
179 'View customer batched payments', #NEW
180 'View customer pending payments', #NEW
181 'Edit customer pending payments', #NEW
182 'View customer billing events', #NEW
186 # customer payment rights
188 'Customer payment rights' => [
190 { rightname=>'Post payment', desc=>'Make check or cash payments.' },
191 { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
192 'Post check payment',
194 'Post payment batch',
195 'Apply payment', #NEWNEW
196 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
197 { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
198 'Process credit card payment',
199 'Process Echeck payment',
200 { 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.
204 # customer credit rights
206 'Customer credit and refund rights' => [
208 'Apply credit', #NEWNEW
209 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
210 { 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.
212 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
215 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
216 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
217 'Refund credit card payment',
218 'Refund Echeck payment',
219 'Delete refund', #NEW
220 'Add on-the-fly credit reason', #NEW
224 # customer voiding rights..
226 'Customer void rights' => [
227 { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
228 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
230 { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
236 # note/attachment rights...
238 'Customer note and attachment rights' => [
239 'Add customer note', #NEW
240 'Edit customer note', #NEW
241 'View attachments', #NEW
242 'Browse attachments', #NEW
243 'Download attachment', #NEW
244 'Add attachment', #NEW
245 'Edit attachment', #NEW
246 'Delete attachment', #NEW
247 'View deleted attachments', #NEW
248 'Undelete attachment', #NEW
249 'Purge attachment', #NEW
253 # report/listing rights...
255 'Reporting/listing rights' => [
257 'List all customers',
258 'List zip codes', #NEW
261 'Summarize packages',
263 'List service passwords',
265 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
266 'Billing event reports',
267 'Receivables report',
269 { rightname=> 'List inventory', global=>1 },
270 { rightname=>'View email logs', global=>1 },
272 'Download report data',
273 'Services: Accounts',
275 'Services: Certificates',
276 'Services: Mail forwards',
277 'Services: Virtual hosting services',
278 'Services: Wireless broadband services',
280 'Services: Dish services',
281 'Services: Hardware',
282 'Services: Phone numbers',
285 'Services: Mailing lists',
286 'Services: External services',
287 'Usage: RADIUS sessions',
288 'Usage: Call Detail Records (CDRs)',
289 'Usage: Unrateable CDRs',
290 'Usage: Time worked',
292 #{ rightname => 'List customers of all agents', global=>1 },
298 'Miscellaneous rights' => [
299 { rightname=>'Job queue', global=>1 },
300 { rightname=>'Time queue', global=>1 },
301 { rightname=>'Process batches', }, #Process payment batches
302 { rightname=>'Process global batches', global=>1 }, #Process global payment batches
303 { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
304 { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
305 { rightname=>'Process invoice batches', },
306 { rightname=>'Process global invoice batches', global=>1 },
307 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
308 { rightname=>'Export', global=>1 },
309 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
315 #'Database access rights' => [
316 { rightname=>'Raw SQL', global=>1 }, #NEW
320 # setup/config rights
322 'Configuration rights' => [
323 'Edit advertising sources',
324 { rightname=>'Edit global advertising sources', global=>1 },
326 'Edit package definitions',
327 { rightname=>'Edit global package definitions', global=>1 },
329 'Edit billing events',
330 { rightname=>'Edit global billing events', global=>1 },
333 { rightname=>'Edit global templates', global=>1 },
336 { rightname=>'Edit global inventory', global=>1 },
338 { rightname=>'Dialup configuration' },
339 { rightname=>'Dialup global configuration', global=>1 },
341 { rightname=>'Broadband configuration' },
342 { rightname=>'Broadband global configuration', global=>1 },
344 { rightname=> 'Configure network monitoring', global=>1 },
346 #{ rightname=>'Edit employees', global=>1, },
347 #{ rightname=>'Edit employee groupss', global=>1, },
349 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
351 { rightname=>'Configuration download', }, #description of how it affects
352 #search/elements/search.html
364 Returns the full list of right names.
370 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
373 =item default_superuser_rights
375 Most (but not all) right names.
379 sub default_superuser_rights {
381 my %omit = map { $_=>1 } (
387 'Edit customer package dates',
389 'Redownload resolved batches',
391 'Configuration download',
392 'View customers of all agents',
393 'View/link unlinked services',
399 no warnings 'uninitialized';
400 grep { ! $omit{$_} } $class->rights;
405 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
406 category names and values are list references of rights. Each element of the
407 list reference scalar right name or a hashref with the following keys:
411 =item rightname - Right name
413 =item desc - Extended right description
415 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
429 Damn those infernal six-legged creatures!
433 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>