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