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
118 { rightname=>'View customers of all agents', global=>1 },
122 # customer package rights
124 'Customer package rights' => [
125 'View customer packages', #NEW
126 'Order customer package',
128 'Change customer package',
129 'Bulk change customer packages',
130 'Edit customer package dates',
131 'Discount customer package', #NEW
132 'Custom discount customer package', #NEW
133 'Customize customer package',
134 'Suspend customer package',
135 'Suspend customer package later',
136 'Unsuspend customer package',
137 'Cancel customer package immediately',
138 'Cancel customer package later',
139 'Delay suspension events',
140 'Add on-the-fly cancel reason', #NEW
141 'Add on-the-fly suspend reason', #NEW
142 'Edit customer package invoice details', #NEW
143 'Edit customer package comments', #NEW
147 # customer service rights
149 'Customer service rights' => [
150 'View customer services', #NEW
151 'Provision customer service',
152 'Recharge customer service', #NEW
153 'Unprovision customer service',
154 'Change customer service', #NEWNEW
156 'Edit home dir', #NEW
157 'Edit www config', #NEW
158 'Edit domain catchall', #NEW
159 'Edit domain nameservice', #NEW
160 'Manage domain registration',
162 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
166 # customer invoice/financial info rights
168 'Customer invoice / financial info rights' => [
170 'Resend invoices', #NEWNEW
171 'Delete invoices', #new, but no need to phase in
172 'View customer tax exemptions', #yow
173 'Add customer tax adjustment', #new, but no need to phase in
174 'View customer batched payments', #NEW
175 'View customer pending payments', #NEW
176 'Edit customer pending payments', #NEW
177 'View customer billing events', #NEW
181 # customer payment rights
183 'Customer payment rights' => [
185 'Post payment batch',
186 'Apply payment', #NEWNEW
187 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
189 { rightname=>'Refund payment', desc=>'Enable refund of existing customer payments.' },
191 { 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.
196 # customer credit rights
198 'Customer credit and refund rights' => [
200 'Apply credit', #NEWNEW
201 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
202 { 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.
203 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
204 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
205 'Delete refund', #NEW
206 'Add on-the-fly credit reason', #NEW
210 # customer voiding rights..
212 'Customer void rights' => [
213 { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
214 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
216 { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
222 # note/attachment rights...
224 'Customer note and attachment rights' => [
225 'Add customer note', #NEW
226 'Edit customer note', #NEW
227 'View attachments', #NEW
228 'Browse attachments', #NEW
229 'Download attachment', #NEW
230 'Add attachment', #NEW
231 'Edit attachment', #NEW
232 'Delete attachment', #NEW
233 'View deleted attachments', #NEW
234 'Undelete attachment', #NEW
235 'Purge attachment', #NEW
239 # report/listing rights...
241 'Reporting/listing rights' => [
243 'List zip codes', #NEW
247 'List service passwords',
249 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
250 'Billing event reports',
251 'Receivables report',
254 #{ rightname => 'List customers of all agents', global=>1 },
260 'Miscellaneous rights' => [
261 { rightname=>'Job queue', global=>1 },
262 { rightname=>'Time queue', global=>1 },
263 { rightname=>'Process batches', global=>1 },
264 { rightname=>'Reprocess batches', global=>1 },
265 { rightname=>'Redownload resolved batches', global=>1 },
266 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
267 { rightname=>'Export', global=>1 },
268 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
274 #'Database access rights' => [
275 { rightname=>'Raw SQL', global=>1 }, #NEW
279 # setup/config rights
281 'Configuration rights' => [
282 'Edit advertising sources',
283 { rightname=>'Edit global advertising sources', global=>1 },
285 'Edit package definitions',
286 { rightname=>'Edit global package definitions', global=>1 },
288 'Edit billing events',
289 { rightname=>'Edit global billing events', global=>1 },
292 { rightname=>'Edit global templates', global=>1 },
295 { rightname=>'Edit global inventory', global=>1 },
297 { rightname=>'Dialup configuration' },
298 { rightname=>'Dialup global configuration', global=>1 },
300 { rightname=>'Broadband configuration' },
301 { rightname=>'Broadband global configuration', global=>1 },
303 #{ rightname=>'Edit employees', global=>1, },
304 #{ rightname=>'Edit employee groupss', global=>1, },
306 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
308 { rightname=>'Configuration download', }, #description of how it affects
309 #search/elements/search.html
321 Returns the full list of right names.
327 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
330 =item default_superuser_rights
332 Most (but not all) right names.
336 sub default_superuser_rights {
338 my %omit = map { $_=>1 } (
345 'Redownload resolved batches',
347 'Configuration download',
350 no warnings 'uninitialized';
351 grep { ! $omit{$_} } $class->rights;
356 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
357 category names and values are list references of rights. Each element of the
358 list reference scalar right name or a hashref with the following keys:
362 =item rightname - Right name
364 =item desc - Extended right description
366 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
380 Damn those infernal six-legged creatures!
384 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>