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 'View customer history',
113 'Complimentary customer', #aka users-allow_comp
114 { 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
115 'Bill customer now', #NEW
116 'Bulk send customer notices', #NEW
120 # customer package rights
122 'Customer package rights' => [
123 'View customer packages', #NEW
124 'Order customer package',
126 'Change customer package',
127 'Bulk change customer packages',
128 'Edit customer package dates',
129 'Customize customer package',
130 'Suspend customer package',
131 'Suspend customer package later',
132 'Unsuspend customer package',
133 'Cancel customer package immediately',
134 'Cancel customer package later',
135 'Delay suspension events',
136 'Add on-the-fly cancel reason', #NEW
137 'Add on-the-fly suspend reason', #NEW
138 'Edit customer package invoice details', #NEW
139 'Edit customer package comments', #NEW
143 # customer service rights
145 'Customer service rights' => [
146 'View customer services', #NEW
147 'Provision customer service',
148 'Recharge customer service', #NEW
149 'Unprovision customer service',
150 'Change customer service', #NEWNEW
152 'Edit home dir', #NEW
153 'Edit www config', #NEW
154 'Edit domain catchall', #NEW
155 'Edit domain nameservice', #NEW
156 'Manage domain registration',
158 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
162 # customer invoice/financial info rights
164 'Customer invoice / financial info rights' => [
166 'Resend invoices', #NEWNEW
167 'Delete invoices', #new, but no need to phase in
168 'View customer tax exemptions', #yow
169 'Add customer tax adjustment', #new, but no need to phase in
170 'View customer batched payments', #NEW
171 'View customer pending payments', #NEW
172 'Edit customer pending payments', #NEW
173 'View customer billing events', #NEW
177 # customer payment rights
179 'Customer payment rights' => [
181 'Post payment batch',
182 'Apply payment', #NEWNEW
183 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
185 { rightname=>'Refund payment', desc=>'Enable refund of existing customer payments.' },
187 { 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.
192 # customer credit rights
194 'Customer credit and refund rights' => [
196 'Apply credit', #NEWNEW
197 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
198 { 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.
199 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
200 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
201 'Delete refund', #NEW
202 'Add on-the-fly credit reason', #NEW
206 # customer voiding rights..
208 'Customer void rights' => [
209 { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
210 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
212 { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
218 # note/attachment rights...
220 'Customer note and attachment rights' => [
221 'Add customer note', #NEW
222 'Edit customer note', #NEW
223 'View attachments', #NEW
224 'Browse attachments', #NEW
225 'Download attachment', #NEW
226 'Add attachment', #NEW
227 'Edit attachment', #NEW
228 'Delete attachment', #NEW
229 'View deleted attachments', #NEW
230 'Undelete attachment', #NEW
231 'Purge attachment', #NEW
235 # report/listing rights...
237 'Reporting/listing rights' => [
239 'List zip codes', #NEW
244 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
245 'Billing event reports',
246 'Receivables report',
253 'Miscellaneous rights' => [
254 { rightname=>'Job queue', global=>1 },
255 { rightname=>'Time queue', global=>1 },
256 { rightname=>'Process batches', global=>1 },
257 { rightname=>'Reprocess batches', global=>1 },
258 { rightname=>'Redownload resolved batches', global=>1 },
259 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
260 { rightname=>'Export', global=>1 },
261 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
267 #'Database access rights' => [
268 { rightname=>'Raw SQL', global=>1 }, #NEW
272 # setup/config rights
274 'Configuration rights' => [
275 'Edit advertising sources',
276 { rightname=>'Edit global advertising sources', global=>1 },
278 'Edit package definitions',
279 { rightname=>'Edit global package definitions', global=>1 },
281 'Edit billing events',
282 { rightname=>'Edit global billing events', global=>1 },
284 { rightname=>'Dialup configuration' },
285 { rightname=>'Dialup global configuration', global=>1 },
287 { rightname=>'Broadband configuration' },
288 { rightname=>'Broadband global configuration', global=>1 },
290 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
292 { rightname=>'Configuration download', }, #description of how it affects
293 #search/elements/search.html
305 Returns the full list of right names.
311 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
314 =item default_superuser_rights
316 Most (but not all) right names.
320 sub default_superuser_rights {
322 my %omit = map { $_=>1 } (
329 'Redownload resolved batches',
331 'Configuration download',
334 no warnings 'uninitialized';
335 grep { ! $omit{$_} } $class->rights;
340 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
341 category names and values are list references of rights. Each element of the
342 list reference scalar right name or a hashref with the following keys:
346 =item rightname - Right name
348 =item desc - Extended right description
350 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
364 Damn those infernal six-legged creatures!
368 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>