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
105 # customer package rights
107 'Customer package rights' => [
108 'View customer packages', #NEW
109 'Order customer package',
111 'Change customer package',
112 'Bulk change customer packages',
113 'Edit customer package dates',
114 'Customize customer package',
115 'Suspend customer package',
116 'Suspend customer package later',
117 'Unsuspend customer package',
118 'Cancel customer package immediately',
119 'Cancel customer package later',
120 'Add on-the-fly cancel reason', #NEW
121 'Add on-the-fly suspend reason', #NEW
125 # customer service rights
127 'Customer service rights' => [
129 'Edit home dir', #NEW
130 'Edit www config', #NEW
131 'View customer services', #NEW
132 'Provision customer service',
133 'Recharge customer service', #NEW
134 'Unprovision customer service',
136 { rightname=>'View/link unlinked services', global=>1 }, #not agent-virtualizable without more work
140 # customer invoice/financial info rights
142 'Customer invoice / financial info rights' => [
144 'View customer tax exemptions', #yow
145 'View customer batched payments', #NEW
146 'View customer billing events', #NEW
150 # customer payment rights
152 'Customer payment rights' => [
154 'Post payment batch',
155 { rightname=>'Unapply payment', desc=>'Enable "unapplication" of unclosed payments from specific invoices.' }, #aka. unapplypayments
159 { 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.
164 # customer credit rights
166 'Customer credit and refund rights' => [
169 { rightname=>'Unapply credit', desc=>'Enable "unapplication" of unclosed credits.' }, #aka unapplycredits
170 { 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.
171 'Delete refund', #NEW
175 # customer voiding rights..
177 'Customer void rights' => [
178 { rightname=>'Credit card void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. cc-void
179 { rightname=>'Echeck void', desc=>'Enable local-only voiding of echeck payments in addition to refunds against the payment gateway.' }, #aka. echeck-void
181 { rightname=>'Unvoid', desc=>'Enable unvoiding of voided payments' }, #aka. unvoid
187 # report/listing rights...
189 'Reprting/listing rights' => [
191 'List zip codes', #NEW
196 { rightname=> 'List rating data', desc=>'Usage reports', global=>1 },
197 'Billing event reports',
204 'Miscellaneous rights' => [
205 { rightname=>'Job queue', global=>1 },
206 { rightname=>'Time queue', global=>1 },
207 { rightname=>'Process batches', global=>1 },
208 { rightname=>'Reprocess batches', global=>1 },
209 { rightname=>'Import', global=>1 }, #some of these are ag-virt'ed now? give em their own ACLs
210 { rightname=>'Export', global=>1 },
216 #'Database access rights' => [
217 { rightname=>'Raw SQL', global=>1 }, #NEW
221 # setup/config rights
223 'Configuration rights' => [
224 'Edit advertising sources',
225 { rightname=>'Edit global advertising sources', global=>1 },
227 'Edit package definitions',
228 { rightname=>'Edit global package definitions', global=>1 },
230 'Edit billing events',
231 { rightname=>'Edit global billing events', global=>1 },
233 { rightname=>'Configuration', global=>1 }, #most of the rest of the configuraiton is not agent-virtualized
244 Returns a list of right names.
250 map { ref($_) ? $_->{'rightname'} : $_ } map @{ $rights{$_} }, keys %rights;
255 Returns a list of key-value pairs suitable for assigning to a hash. Keys are
256 category names and values are list references of rights. Each element of the
257 list reference scalar right name or a hashref with the following keys:
261 =item rightname - Right name
263 =item desc - Extended right description
265 =item global - Global flag, indicates that this access right provides access to global data which is shared among all agents.
279 Damn those infernal six-legged creatures!
283 L<FS::access_right>, L<FS::access_group>, L<FS::access_user>