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',
98 'Complimentary customer', #aka users-allow_comp
99 { 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
100 'Add customer note', #NEW
101 'Edit customer note', #NEW
102 'Bill customer now', #NEW
103 'Bulk send customer notices', #NEW
107 # customer package rights
109 'Customer package rights' => [
110 'View customer packages', #NEW
111 'Order customer package',
113 'Change customer package',
114 'Bulk change customer packages',
115 'Edit customer package dates',
116 'Customize customer package',
117 'Suspend customer package',
118 'Suspend customer package later',
119 'Unsuspend customer package',
120 'Cancel customer package immediately',
121 'Cancel customer package later',
122 'Delay suspension events',
123 'Add on-the-fly cancel reason', #NEW
124 'Add on-the-fly suspend reason', #NEW
125 'Edit customer package invoice details', #NEW
126 'Edit customer package comments', #NEW
130 # customer service rights
132 'Customer service rights' => [
133 'View customer services', #NEW
134 'Provision customer service',
135 'Recharge customer service', #NEW
136 'Unprovision customer service',
137 'Change customer service', #NEWNEW
139 'Edit home dir', #NEW
140 'Edit www config', #NEW
141 'Edit domain catchall', #NEW
142 'Edit domain nameservice', #NEW
143 'Manage domain registration',
145 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
149 # customer invoice/financial info rights
151 'Customer invoice / financial info rights' => [
153 'Resend invoices', #NEWNEW
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 # report/listing rights...
206 'Reporting/listing rights' => [
208 'List zip codes', #NEW
213 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
214 'Billing event reports',
215 'Receivables report',
222 'Miscellaneous rights' => [
223 { rightname=>'Job queue', global=>1 },
224 { rightname=>'Time queue', global=>1 },
225 { rightname=>'Process batches', global=>1 },
226 { rightname=>'Reprocess batches', global=>1 },
227 { rightname=>'Redownload resolved batches', global=>1 },
228 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
229 { rightname=>'Export', global=>1 },
230 { rightname=> 'Edit rating data', desc=>'Delete CDRs', global=>1 },
236 #'Database access rights' => [
237 { rightname=>'Raw SQL', global=>1 }, #NEW
241 # setup/config rights
243 'Configuration rights' => [
244 'Edit advertising sources',
245 { rightname=>'Edit global advertising sources', global=>1 },
247 'Edit package definitions',
248 { rightname=>'Edit global package definitions', global=>1 },
250 'Edit billing events',
251 { rightname=>'Edit global billing events', global=>1 },
253 { rightname=>'Dialup configuration' },
254 { rightname=>'Dialup global configuration', global=>1 },
256 { rightname=>'Broadband configuration' },
257 { rightname=>'Broadband global configuration', global=>1 },
259 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
261 { rightname=>'Configuration download', }, #description of how it affects
262 #search/elements/search.html
274 Returns a list of right names.
280 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
285 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
286 category names and values are list references of rights. Each element of the
287 list reference scalar right name or a hashref with the following keys:
291 =item rightname - Right name
293 =item desc - Extended right description
295 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
309 Damn those infernal six-legged creatures!
313 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>