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 'Un-cancel customer package',
142 'Delay suspension events',
143 'Add on-the-fly cancel reason', #NEW
144 'Add on-the-fly suspend reason', #NEW
145 'Edit customer package invoice details', #NEW
146 'Edit customer package comments', #NEW
147 'Qualify service', #NEW
148 'Waive setup fee', #NEW
152 # customer service rights
154 'Customer service rights' => [
155 'View customer services', #NEW
156 'Provision customer service',
157 'Bulk provision customer service',
158 'Recharge customer service', #NEW
159 'Unprovision customer service',
160 'Change customer service', #NEWNEW
162 'Edit home dir', #NEW
163 'Edit www config', #NEW
164 'Edit domain catchall', #NEW
165 'Edit domain nameservice', #NEW
166 'Manage domain registration',
168 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
172 # customer invoice/financial info rights
174 'Customer invoice / financial info rights' => [
176 'Resend invoices', #NEWNEW
177 'Delete invoices', #new, but no need to phase in
178 'View customer tax exemptions', #yow
179 'Add customer tax adjustment', #new, but no need to phase in
180 'View customer batched payments', #NEW
181 'View customer pending payments', #NEW
182 'Edit customer pending payments', #NEW
183 'View customer billing events', #NEW
187 # customer payment rights
189 'Customer payment rights' => [
191 { rightname=>'Post payment', desc=>'Make check or cash payments.' },
192 { rightname=>'Backdate payment', desc=>'Enable payments to be posted for days other than today.' },
193 'Post check payment',
195 'Post payment batch',
196 'Apply payment', #NEWNEW
197 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
198 { rightname=>'Process payment', desc=>'Process credit card or e-check payments' },
199 'Process credit card payment',
200 'Process Echeck payment',
201 { 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.
205 # customer credit rights
207 'Customer credit and refund rights' => [
209 'Apply credit', #NEWNEW
210 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
211 { 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.
213 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
216 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
217 { rightname=>'Refund payment', desc=>'Enable refund of existing customer credit card or e-check payments.' },
218 'Refund credit card payment',
219 'Refund Echeck payment',
220 'Delete refund', #NEW
221 'Add on-the-fly credit reason', #NEW
225 # customer voiding rights..
227 'Customer void rights' => [
228 { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
229 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
231 { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
237 # note/attachment rights...
239 'Customer note and attachment rights' => [
240 'Add customer note', #NEW
241 'Edit customer note', #NEW
242 'View attachments', #NEW
243 'Browse attachments', #NEW
244 'Download attachment', #NEW
245 'Add attachment', #NEW
246 'Edit attachment', #NEW
247 'Delete attachment', #NEW
248 'View deleted attachments', #NEW
249 'Undelete attachment', #NEW
250 'Purge attachment', #NEW
254 # report/listing rights...
256 'Reporting/listing rights' => [
258 'List all customers',
259 'List zip codes', #NEW
262 'Summarize packages',
264 'List service passwords',
266 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
267 'Billing event reports',
268 'Receivables report',
270 { rightname=> 'List inventory', global=>1 },
271 { rightname=>'View email logs', global=>1 },
273 'Download report data',
274 'Services: Accounts',
276 'Services: Certificates',
277 'Services: Mail forwards',
278 'Services: Virtual hosting services',
279 'Services: Wireless broadband services',
281 'Services: Dish services',
282 'Services: Hardware',
283 'Services: Phone numbers',
286 'Services: Mailing lists',
287 'Services: External services',
288 'Usage: RADIUS sessions',
289 'Usage: Call Detail Records (CDRs)',
290 'Usage: Unrateable CDRs',
291 'Usage: Time worked',
293 #{ rightname => 'List customers of all agents', global=>1 },
299 'Miscellaneous rights' => [
300 { rightname=>'Job queue', global=>1 },
301 { rightname=>'Time queue', global=>1 },
302 { rightname=>'Process batches', }, #Process payment batches
303 { rightname=>'Process global batches', global=>1 }, #Process global payment batches
304 { rightname=>'Reprocess batches', global=>1 }, #Reprocess payment batches
305 { rightname=>'Redownload resolved batches', global=>1 }, #Redownload resolved payment batches
306 { rightname=>'Process invoice batches', },
307 { rightname=>'Process global invoice batches', global=>1 },
308 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
309 { rightname=>'Export', global=>1 },
310 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
316 #'Database access rights' => [
317 { rightname=>'Raw SQL', global=>1 }, #NEW
321 # setup/config rights
323 'Configuration rights' => [
324 'Edit advertising sources',
325 { rightname=>'Edit global advertising sources', global=>1 },
327 'Edit package definitions',
328 { rightname=>'Edit global package definitions', global=>1 },
330 'Edit billing events',
331 { rightname=>'Edit global billing events', global=>1 },
334 { rightname=>'Edit global templates', global=>1 },
337 { rightname=>'Edit global inventory', global=>1 },
339 { rightname=>'Dialup configuration' },
340 { rightname=>'Dialup global configuration', global=>1 },
342 { rightname=>'Broadband configuration' },
343 { rightname=>'Broadband global configuration', global=>1 },
345 { rightname=> 'Configure network monitoring', global=>1 },
347 #{ rightname=>'Edit employees', global=>1, },
348 #{ rightname=>'Edit employee groupss', global=>1, },
350 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
352 { rightname=>'Configuration download', }, #description of how it affects
353 #search/elements/search.html
365 Returns the full list of right names.
371 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
374 =item default_superuser_rights
376 Most (but not all) right names.
380 sub default_superuser_rights {
382 my %omit = map { $_=>1 } (
388 'Edit customer package dates',
390 'Redownload resolved batches',
392 'Configuration download',
393 'View customers of all agents',
394 'View/link unlinked services',
400 no warnings 'uninitialized';
401 grep { ! $omit{$_} } $class->rights;
406 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
407 category names and values are list references of rights. Each element of the
408 list reference scalar right name or a hashref with the following keys:
412 =item rightname - Right name
414 =item desc - Extended right description
416 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
430 Damn those infernal six-legged creatures!
434 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>