2 // +----------------------------------------------------------------------+
3 // | Anuko Time Tracker
4 // +----------------------------------------------------------------------+
5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
6 // +----------------------------------------------------------------------+
7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
8 // | by anyone for any purpose, and freely redistributed alone or in
9 // | combination with other software, provided that the license is obeyed.
11 // | There are only two ways to violate the license:
13 // | 1. To redistribute this code in source form, with the copyright
14 // | notice or license removed or altered. (Distributing in compiled
15 // | forms without embedded copyright notices is permitted).
17 // | 2. To redistribute modified versions of this code in *any* form
18 // | that bears insufficient indications that the modifications are
19 // | not the work of the original author(s).
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
24 // +----------------------------------------------------------------------+
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
29 // The ttRoleHelper is a class to help with custom group roles.
32 // get - gets details of a role identified by its id.
33 static function get($id)
37 $mdb2 = getConnection();
39 $sql = "select id, name, description, rank, rights, status from tt_roles
40 where id = $id and team_id = $user->team_id and (status = 0 or status = 1)";
41 $res = $mdb2->query($sql);
43 if (!is_a($res, 'PEAR_Error')) {
44 $val = $res->fetchRow();
45 if ($val['id'] != '') {
53 // The getRoleByName looks up a role by name.
54 static function getRoleByName($role_name) {
56 $mdb2 = getConnection();
59 $sql = "select id from tt_roles where team_id = $user->team_id and name = ".
60 $mdb2->quote($role_name)." and (status = 1 or status = 0)";
61 $res = $mdb2->query($sql);
63 if (!is_a($res, 'PEAR_Error')) {
64 $val = $res->fetchRow();
71 // The getTopManagerRoleID obtains an ID for top manager role.
72 static function getTopManagerRoleID() {
73 $mdb2 = getConnection();
75 $sql = "select id from tt_roles where team_id = 0 and rank = 512";
76 $res = $mdb2->query($sql);
78 if (!is_a($res, 'PEAR_Error')) {
79 $val = $res->fetchRow();
86 // isClientRole determines if the role is a "client" role.
87 // This simply means the role has no "track_own_time" right.
88 static function isClientRole($role_id) {
90 $mdb2 = getConnection();
92 $sql = "select rights from tt_roles where team_id = $user->team_id and id = $role_id";
93 $res = $mdb2->query($sql);
95 if (!is_a($res, 'PEAR_Error')) {
96 $val = $res->fetchRow();
98 return !in_array('track_own_time', explode(',', $val['rights']));
104 // getRoleByRank looks up a role by its rank.
105 static function getRoleByRank($rank, $team_id) {
107 $mdb2 = getConnection();
109 $rank = (int) $rank; // Cast to int just in case for better security.
111 $sql = "select id from tt_roles where team_id = $team_id and rank = $rank and (status = 1 or status = 0)";
112 $res = $mdb2->query($sql);
114 if (!is_a($res, 'PEAR_Error')) {
115 $val = $res->fetchRow();
122 // update function updates a role in the database.
123 static function update($fields) {
125 $mdb2 = getConnection();
127 $id = (int)$fields['id'];
128 if (isset($fields['name'])) $name_part = 'name = '.$mdb2->quote($fields['name']);
129 if (isset($fields['description'])) $descr_part = ', description = '.$mdb2->quote($fields['description']);
130 if (isset($fields['status'])) $status_part = ', status = '.(int)$fields['status'];
131 if (isset($fields['rights'])) $rights_part = ', rights = '.$mdb2->quote($fields['rights']);
132 $parts = trim($name_part.$descr_part.$status_part.$rights_part, ',');
133 $sql = "update tt_roles set $parts where id = $id and team_id = $user->team_id";
134 $affected = $mdb2->exec($sql);
135 return (!is_a($affected, 'PEAR_Error'));
138 // delete - marks the role as deleted.
139 static function delete($role_id) {
142 $mdb2 = getConnection();
144 // Mark the task as deleted.
145 $sql = "update tt_roles set status = NULL where id = $role_id and team_id = $user->team_id";
146 $affected = $mdb2->exec($sql);
147 return (!is_a($affected, 'PEAR_Error'));
150 // insert - inserts an entry into tt_roles table.
151 static function insert($fields)
153 $mdb2 = getConnection();
155 $team_id = (int) $fields['team_id'];
156 $name = $fields['name'];
157 $rank = (int) $fields['rank'];
158 $description = $fields['description'];
159 $rights = $fields['rights'];
160 $status = $fields['status'];
162 $sql = "insert into tt_roles (team_id, name, rank, description, rights, status)
163 values ($team_id, ".$mdb2->quote($name).", $rank, ".$mdb2->quote($description).", ".$mdb2->quote($rights).", ".$mdb2->quote($status).")";
164 $affected = $mdb2->exec($sql);
165 if (is_a($affected, 'PEAR_Error'))
171 // createPredefinedRoles - creates a set of predefined roles for the team to use.
172 static function createPredefinedRoles($team_id, $lang)
174 // We need localized role names and a new I18n object to obtain them.
179 $mdb2 = getConnection();
181 $rights_client = 'view_own_reports,view_own_charts,view_own_invoices,manage_own_settings';
182 $rights_user = 'track_own_time,track_own_expenses,view_own_reports,view_own_charts,manage_own_settings,view_users';
183 $rights_supervisor = $rights_user.',track_time,track_expenses,view_reports,view_charts,override_punch_mode,override_date_lock,swap_roles,approve_timesheets';
184 $rights_comanager = $rights_supervisor.',manage_users,manage_projects,manage_tasks,manage_custom_fields,manage_clients,manage_invoices';
185 $rights_manager = $rights_comanager.',manage_features,manage_basic_settings,manage_advanced_settings,manage_roles,export_data,manage_subgroups';
188 $name = $mdb2->quote($i18n->getKey('role.user.label'));
189 $description = $mdb2->quote($i18n->getKey('role.user.description'));
190 $rights = $mdb2->quote($rights_user);
191 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($team_id, $name, $description, 4, $rights, 1)";
192 $affected = $mdb2->exec($sql);
193 if (is_a($affected, 'PEAR_Error'))
196 $name = $mdb2->quote($i18n->getKey('role.client.label'));
197 $description = $mdb2->quote($i18n->getKey('role.client.description'));
198 $rights = $mdb2->quote($rights_client);
199 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($team_id, $name, $description, 16, $rights, 1)";
200 $affected = $mdb2->exec($sql);
201 if (is_a($affected, 'PEAR_Error'))
204 $name = $mdb2->quote($i18n->getKey('role.comanager.label'));
205 $description = $mdb2->quote($i18n->getKey('role.comanager.description'));
206 $rights = $mdb2->quote($rights_comanager);
207 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($team_id, $name, $description, 68, $rights, 1)";
208 $affected = $mdb2->exec($sql);
209 if (is_a($affected, 'PEAR_Error'))
212 $name = $mdb2->quote($i18n->getKey('role.manager.label'));
213 $description = $mdb2->quote($i18n->getKey('role.manager.description'));
214 $rights = $mdb2->quote($rights_manager);
215 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($team_id, $name, $description, 324, $rights, 1)";
216 $affected = $mdb2->exec($sql);
217 if (is_a($affected, 'PEAR_Error'))
221 $name = $mdb2->quote($i18n->getKey('role.supervisor.label'));
222 $description = $mdb2->quote($i18n->getKey('role.supervisor.description'));
223 $rights = $mdb2->quote($rights_supervisor);
224 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($team_id, $name, $description, 12, $rights, 0)";
225 $affected = $mdb2->exec($sql);
226 if (is_a($affected, 'PEAR_Error'))
232 // createDefaultRoles - creates a set of predefined roles for the team to use.
233 static function createDefaultRoles()
235 $mdb2 = getConnection();
239 $rights_client = 'view_own_reports,view_own_charts,view_own_invoices,manage_own_settings';
240 $rights_user = 'track_own_time,track_own_expenses,view_own_reports,view_own_charts,manage_own_settings,view_users';
241 $rights_supervisor = $rights_user.',track_time,track_expenses,view_reports,view_charts,override_punch_mode,override_date_lock,swap_roles,approve_timesheets';
242 $rights_comanager = $rights_supervisor.',manage_users,manage_projects,manage_tasks,manage_custom_fields,manage_clients,manage_invoices';
243 $rights_manager = $rights_comanager.',manage_features,manage_basic_settings,manage_advanced_settings,manage_roles,export_data,manage_subgroups';
246 $name = $mdb2->quote($i18n->getKey('role.user.label'));
247 $description = $mdb2->quote($i18n->getKey('role.user.description'));
248 $rights = $mdb2->quote($rights_user);
249 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($user->team_id, $name, $description, 4, $rights, 1)";
250 $affected = $mdb2->exec($sql);
251 if (is_a($affected, 'PEAR_Error'))
254 $name = $mdb2->quote($i18n->getKey('role.client.label'));
255 $description = $mdb2->quote($i18n->getKey('role.client.description'));
256 $rights = $mdb2->quote($rights_client);
257 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($user->team_id, $name, $description, 16, $rights, 1)";
258 $affected = $mdb2->exec($sql);
259 if (is_a($affected, 'PEAR_Error'))
262 $name = $mdb2->quote($i18n->getKey('role.comanager.label'));
263 $description = $mdb2->quote($i18n->getKey('role.comanager.description'));
264 $rights = $mdb2->quote($rights_comanager);
265 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($user->team_id, $name, $description, 68, $rights, 1)";
266 $affected = $mdb2->exec($sql);
267 if (is_a($affected, 'PEAR_Error'))
270 $name = $mdb2->quote($i18n->getKey('role.manager.label'));
271 $description = $mdb2->quote($i18n->getKey('role.manager.description'));
272 $rights = $mdb2->quote($rights_manager);
273 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($user->team_id, $name, $description, 324, $rights, 1)";
274 $affected = $mdb2->exec($sql);
275 if (is_a($affected, 'PEAR_Error'))
279 $name = $mdb2->quote($i18n->getKey('role.supervisor.label'));
280 $description = $mdb2->quote($i18n->getKey('role.supervisor.description'));
281 $rights = $mdb2->quote($rights_supervisor);
282 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($user->team_id, $name, $description, 12, $rights, 0)";
283 $affected = $mdb2->exec($sql);
284 if (is_a($affected, 'PEAR_Error'))