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',
90 # basic customer rights
92 'Customer rights' => [
95 #'View Customer | View tickets',
97 'View customer history',
99 'Complimentary customer', #aka users-allow_comp
100 { 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
101 'Bill customer now', #NEW
102 'Bulk send customer notices', #NEW
106 # customer package rights
108 'Customer package rights' => [
109 'View customer packages', #NEW
110 'Order customer package',
112 'Change customer package',
113 'Bulk change customer packages',
114 'Edit customer package dates',
115 'Customize customer package',
116 'Suspend customer package',
117 'Suspend customer package later',
118 'Unsuspend customer package',
119 'Cancel customer package immediately',
120 'Cancel customer package later',
121 'Delay suspension events',
122 'Add on-the-fly cancel reason', #NEW
123 'Add on-the-fly suspend reason', #NEW
124 'Edit customer package invoice details', #NEW
125 'Edit customer package comments', #NEW
129 # customer service rights
131 'Customer service rights' => [
132 'View customer services', #NEW
133 'Provision customer service',
134 'Recharge customer service', #NEW
135 'Unprovision customer service',
136 'Change customer service', #NEWNEW
138 'Edit home dir', #NEW
139 'Edit www config', #NEW
140 'Edit domain catchall', #NEW
141 'Edit domain nameservice', #NEW
142 'Manage domain registration',
144 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
148 # customer invoice/financial info rights
150 'Customer invoice / financial info rights' => [
152 'Resend invoices', #NEWNEW
153 'Delete invoices', #new, but no need to phase in
154 'View customer tax exemptions', #yow
155 'Add customer tax adjustment', #new, but no need to phase in
156 'View customer batched payments', #NEW
157 'View customer pending payments', #NEW
158 'Edit customer pending payments', #NEW
159 'View customer billing events', #NEW
163 # customer payment rights
165 'Customer payment rights' => [
167 'Post payment batch',
168 'Apply payment', #NEWNEW
169 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
171 { rightname=>'Refund payment', desc=>'Enable refund of existing customer payments.' },
173 { 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.
178 # customer credit rights
180 'Customer credit and refund rights' => [
182 'Apply credit', #NEWNEW
183 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
184 { 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.
185 { rightname=>'Post refund', desc=>'Enable posting of check and cash refunds.' },
186 # { rightname=>'Process refund', desc=>'Enable processing of generic credit card/ACH refunds (i.e. not associated with a specific prior payment).' },
187 'Delete refund', #NEW
188 'Add on-the-fly credit reason', #NEW
192 # customer voiding rights..
194 'Customer void rights' => [
195 { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
196 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
198 { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
204 # note/attachment rights...
206 'Customer note and attachment rights' => [
207 'Add customer note', #NEW
208 'Edit customer note', #NEW
209 'Download attachment', #NEW
210 'Add attachment', #NEW
211 'Edit attachment', #NEW
212 'Delete attachment', #NEW
213 'View deleted attachments', #NEW
214 'Undelete attachment', #NEW
215 'Purge attachment', #NEW
219 # report/listing rights...
221 'Reporting/listing rights' => [
223 'List zip codes', #NEW
228 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
229 'Billing event reports',
230 'Receivables report',
237 'Miscellaneous rights' => [
238 { rightname=>'Job queue', global=>1 },
239 { rightname=>'Time queue', global=>1 },
240 { rightname=>'Process batches', global=>1 },
241 { rightname=>'Reprocess batches', global=>1 },
242 { rightname=>'Redownload resolved batches', global=>1 },
243 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
244 { rightname=>'Export', global=>1 },
245 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
251 #'Database access rights' => [
252 { rightname=>'Raw SQL', global=>1 }, #NEW
256 # setup/config rights
258 'Configuration rights' => [
259 'Edit advertising sources',
260 { rightname=>'Edit global advertising sources', global=>1 },
262 'Edit package definitions',
263 { rightname=>'Edit global package definitions', global=>1 },
265 'Edit billing events',
266 { rightname=>'Edit global billing events', global=>1 },
268 { rightname=>'Dialup configuration' },
269 { rightname=>'Dialup global configuration', global=>1 },
271 { rightname=>'Broadband configuration' },
272 { rightname=>'Broadband global configuration', global=>1 },
274 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
276 { rightname=>'Configuration download', }, #description of how it affects
277 #search/elements/search.html
289 Returns the full list of right names.
295 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
298 =item default_superuser_rights
300 Most (but not all) right names.
304 sub default_superuser_rights {
306 my %omit = map { $_=>1 } (
313 'Redownload resolved batches',
315 'Configuration download',
318 no warnings 'uninitialized';
319 grep { ! $omit{$_} } $class->rights;
324 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
325 category names and values are list references of rights. Each element of the
326 list reference scalar right name or a hashref with the following keys:
330 =item rightname - Right name
332 =item desc - Extended right description
334 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
348 Damn those infernal six-legged creatures!
352 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>