svc_acct.dir should be editable with ACL (#1730)
[freeside.git] / FS / FS / AccessRight.pm
1 package FS::AccessRight;
2
3 use strict;
4 use vars qw(@rights); # %rights);
5 use Tie::IxHash;
6
7 =head1 NAME
8
9 FS::AccessRight - Access control rights.
10
11 =head1 SYNOPSIS
12
13   use FS::AccessRight;
14
15 =head1 DESCRIPTION
16
17 Access control rights - Permission to perform specific actions that can be
18 assigned to users and/or groups.
19
20 =cut
21
22 #@rights = (
23 #  'Reports' => [
24 #    '_desc' => 'Access to high-level reporting',
25 #  ],
26 #  'Configuration' => [
27 #    '_desc' => 'Access to configuration',
28 #
29 #    'Settings' => {},
30 #
31 #    'agent' => [
32 #      '_desc' => 'Master access to reseller configuration',
33 #      'agent_type'  => {},
34 #      'agent'       => {},
35 #    ],
36 #
37 #    'export_svc_pkg' => [
38 #      '_desc' => 'Access to export, service and package configuration',
39 #      'part_export' => {},
40 #      'part_svc'    => {},
41 #      'part_pkg'    => {},
42 #      'pkg_class'   => {},
43 #    ],
44 #
45 #    'billing' => [
46 #      '_desc' => 'Access to billing configuration',
47 #      'payment_gateway'  => {},
48 #      'part_bill_event'  => {},
49 #      'prepay_credit'    => {},
50 #      'rate'             => {},
51 #      'cust_main_county' => {},
52 #    ],
53 #
54 #    'dialup' => [
55 #      '_desc' => 'Access to dialup configuraiton',
56 #      'svc_acct_pop' => {},
57 #    ],
58 #
59 #    'broadband' => [
60 #      '_desc' => 'Access to broadband configuration',
61 #      'router'     => {},
62 #      'addr_block' => {},
63 #    ],
64 #
65 #    'misc' => [
66 #      'part_referral'      => {},
67 #      'part_virtual_field' => {},
68 #      'msgcat'             => {},
69 #      'inventory_class'    => {},
70 #    ],
71 #
72 #  },
73 #
74 #);
75 #
76 ##turn it into a more hash-like structure, but ordered via IxHash
77
78 #well, this is what we have for now.  could be ordered better, could be lots of
79 # things better, but this ACL system does 99% of what folks need and the UI
80 # isn't *that* bad
81
82 # okay, well it *really* needs some catgorization in the UI.  badly.
83 @rights = (
84
85 ##
86 # basic customer rights
87 ##
88   'New customer',
89   'View customer',
90   #'View Customer | View tickets',
91   'Edit customer',
92   'Cancel customer',
93   'Complimentary customer', #aka users-allow_comp 
94   'Delete customer', #aka. deletecustomers #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 customers' packages if they cancel service.
95   'Add customer note', #NEW
96   'Edit customer note', #NEW
97
98 ###
99 # customer package rights
100 ###
101   'View customer packages', #NEW
102   'Order customer package',
103   'One-time charge',
104   'Change customer package',
105   'Bulk change customer packages',
106   'Edit customer package dates',
107   'Customize customer package',
108   'Suspend customer package',
109   'Suspend customer package later',
110   'Unsuspend customer package',
111   'Cancel customer package immediately',
112   'Cancel customer package later',
113   'Add on-the-fly cancel reason', #NEW
114   'Add on-the-fly suspend reason', #NEW
115
116 ###
117 # customer service rights
118 ###
119   'Edit usage', #NEW
120   'Edit home dir', #NEW
121   'Edit www config', #NEW
122   'View customer services', #NEW
123   'Provision customer service',
124   'Recharge customer service', #NEW
125   'Unprovision customer service',
126
127   'View/link unlinked services', #not agent-virtualizable without more work
128
129 ###
130 # customer invoice/financial info rights
131 ###
132   'View invoices',
133   'View customer tax exemptions', #yow
134   'View customer batched payments', #NEW
135
136 ###
137 # customer payment rights
138 ###
139   'Post payment',
140   'Post payment batch',
141   'Unapply payment', #aka. unapplypayments Enable "unapplication" of unclosed payments.
142   'Process payment',
143   'Refund payment',
144
145   'Delete payment', #aka. deletepayments - Enable deletion of unclosed payments. Be very careful! Only delete payments that were data-entry errors, not adjustments. Optionally specify one or more comma-separated email addresses to be notified when a payment is deleted.
146
147   'Delete refund', #NEW
148
149 ###
150 # customer credit rights
151 ###
152   'Post credit',
153   #'Apply credit',
154   'Unapply credit', #aka unapplycredits Enable "unapplication" of unclosed credits.
155   'Delete credit', #aka. deletecredits Enable deletion of unclosed credits. Be very careful! Only delete credits that were data-entry errors, not adjustments. Optionally specify one or more comma-separated email addresses to be notified when a credit is deleted.
156
157 ###
158 # customer voiding rights..
159 ###
160   'Credit card void', #aka. cc-void #Enable local-only voiding of echeck payments in addition to refunds against the payment gateway
161   'Echeck void', #aka. echeck-void #Enable local-only voiding of echeck payments in addition to refunds against the payment gateway
162   'Regular void',
163   'Unvoid', #aka. unvoid #Enable unvoiding of voided payments
164
165 ###
166 # report/listing rights...
167 ###
168   'List customers',
169   'List zip codes', #NEW
170   'List invoices',
171   'List packages',
172   'List services',
173
174   'List rating data',  # 'Usage reports',
175   'Billing event reports',
176   'Financial reports',
177
178 ###
179 # misc rights
180 ###
181   'Job queue',         # these are not currently agent-virtualized
182   'Process batches',   # NEW
183   'Reprocess batches', # NEW
184   'Import',            #
185   'Export',            #
186
187 ###
188 # misc misc rights
189 ###
190   'Raw SQL', #NEW
191
192 ###
193 # setup/config rights
194 ###
195   'Edit advertising sources',
196   'Edit global advertising sources',
197
198   'Configuration', #most of the rest of the configuraiton is not
199                    # agent-virtualized
200 );
201
202 sub rights {
203   @rights;
204 }
205