oops, missed 1.7
[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   'Bill customer now', #NEW
98
99 ###
100 # customer package rights
101 ###
102   'View customer packages', #NEW
103   'Order customer package',
104   'One-time charge',
105   'Change customer package',
106   'Bulk change customer packages',
107   'Edit customer package dates',
108   'Customize customer package',
109   'Suspend customer package',
110   'Suspend customer package later',
111   'Unsuspend customer package',
112   'Cancel customer package immediately',
113   'Cancel customer package later',
114   'Add on-the-fly cancel reason', #NEW
115   'Add on-the-fly suspend reason', #NEW
116
117 ###
118 # customer service rights
119 ###
120   'Edit usage', #NEW
121   'Edit home dir', #NEW
122   'Edit www config', #NEW
123   'Edit domain catchall', #NEW
124   'Edit domain nameservice', #NEW
125   'View customer services', #NEW
126   'Provision customer service',
127   'Recharge customer service', #NEW
128   'Unprovision customer service',
129   'Change customer service', #NEWNEW
130
131   'View/link unlinked services', #not agent-virtualizable without more work
132
133 ###
134 # customer invoice/financial info rights
135 ###
136   'View invoices',
137   'Resend invoices', #NEWNEW
138   'View customer tax exemptions', #yow
139   'View customer batched payments', #NEW
140
141 ###
142 # customer payment rights
143 ###
144   'Post payment',
145   'Post payment batch',
146   'Apply payment', #NEWNEW
147   'Unapply payment', #aka. unapplypayments Enable "unapplication" of unclosed payments.
148   'Process payment',
149   'Refund payment',
150
151   '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.
152
153   'Delete refund', #NEW
154
155 ###
156 # customer credit rights
157 ###
158   'Post credit',
159   'Apply credit', #NEWNEW
160   'Unapply credit', #aka unapplycredits Enable "unapplication" of unclosed credits.
161   '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.
162   'Add on-the-fly credit reason', #NEW
163
164 ###
165 # customer voiding rights..
166 ###
167   'Credit card void', #aka. cc-void #Enable local-only voiding of echeck payments in addition to refunds against the payment gateway
168   'Echeck void', #aka. echeck-void #Enable local-only voiding of echeck payments in addition to refunds against the payment gateway
169   'Regular void',
170   'Unvoid', #aka. unvoid #Enable unvoiding of voided payments
171
172 ###
173 # report/listing rights...
174 ###
175   'List customers',
176   'List zip codes', #NEW
177   'List invoices',
178   'List packages',
179   'List services',
180
181   'List rating data',  # 'Usage reports',
182   'Billing event reports',
183   'Financial reports',
184
185 ###
186 # misc rights
187 ###
188   'Job queue',         # these are not currently agent-virtualized
189   'Process batches',   # NEW
190   'Reprocess batches', # NEW
191   'Import',            #
192   'Export',            #
193
194 ###
195 # misc misc rights
196 ###
197   'Raw SQL', #NEW
198
199 ###
200 # setup/config rights
201 ###
202   'Edit advertising sources',
203   'Edit global advertising sources',
204
205   'Configuration', #most of the rest of the configuraiton is not
206                    # agent-virtualized
207 );
208
209 sub rights {
210   @rights;
211 }
212