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