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_roless 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 // update function updates a role in the database.
72 static function update($fields) {
74 $mdb2 = getConnection();
76 $id = (int)$fields['id'];
77 if (isset($fields['name'])) $name_part = 'name = '.$mdb2->quote($fields['name']);
78 if (isset($fields['description'])) $descr_part = ', description = '.$mdb2->quote($fields['description']);
79 if (isset($fields['status'])) $status_part = ', status = '.(int)$fields['status'];
80 if (isset($fields['rights'])) $rights_part = ', rights = '.$mdb2->quote($fields['rights']);
81 $parts = trim($name_part.$descr_part.$status_part.$rights_part, ',');
82 $sql = "update tt_roles set $parts where id = $id and team_id = $user->team_id";
83 $affected = $mdb2->exec($sql);
84 return (!is_a($affected, 'PEAR_Error'));
87 // delete - marks the role as deleted.
88 static function delete($role_id) {
91 $mdb2 = getConnection();
93 // Mark the task as deleted.
94 $sql = "update tt_roles set status = NULL where id = $role_id and team_id = $user->team_id";
95 $affected = $mdb2->exec($sql);
96 return (!is_a($affected, 'PEAR_Error'));
99 // insert - inserts an entry into tt_roles table.
100 static function insert($fields)
102 $mdb2 = getConnection();
104 $team_id = (int) $fields['team_id'];
105 $name = $fields['name'];
106 $rank = (int) $fields['rank'];
107 $rights = $fields['rights'];
108 $status = $fields['status'];
110 $sql = "insert into tt_roles (team_id, name, rank, rights, status)
111 values ($team_id, ".$mdb2->quote($name).", $rank, ".$mdb2->quote($rights).", ".$mdb2->quote($status).")";
112 $affected = $mdb2->exec($sql);
113 if (is_a($affected, 'PEAR_Error'))
119 // rolesExist - checks whether roles for team already exist.
120 static function rolesExist()
122 $mdb2 = getConnection();
125 $sql = "select count(*) as count from tt_roles where team_id = $user->team_id";
126 $res = $mdb2->query($sql);
127 if (!is_a($res, 'PEAR_Error')) {
128 $val = $res->fetchRow();
129 if ($val['count'] > 0)
130 return true; // Roles for team exist.
135 // createDefaultRoles - creates a set of predefined roles for the team to use.
136 static function createDefaultRoles()
138 $mdb2 = getConnection();
142 $rights_client = 'view_own_data,manage_own_settings';
143 $rights_user = 'data_entry,view_own_data,manage_own_settings,view_users';
144 $rights_supervisor = $rights_user.',on_behalf_data_entry,view_data,override_punch_mode,swap_roles,approve_timesheets';
145 $rights_comanager = $rights_supervisor.',manage_users,manage_projects,manage_tasks,manage_custom_fields,manage_clients,manage_invoices';
146 $rights_manager = $rights_comanager.'manage_features,manage_basic_settings,manage_advanced_settings,manage_roles,export_data,manage_subgroups';
149 $name = $mdb2->quote($i18n->getKey('role.user.label'));
150 $description = $mdb2->quote($i18n->getKey('role.user.description'));
151 $rights = $mdb2->quote($rights_user);
152 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($user->team_id, $name, $description, 4, $rights, 1)";
153 $affected = $mdb2->exec($sql);
154 if (is_a($affected, 'PEAR_Error'))
157 $name = $mdb2->quote($i18n->getKey('role.client.label'));
158 $description = $mdb2->quote($i18n->getKey('role.client.description'));
159 $rights = $mdb2->quote($rights_client);
160 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($user->team_id, $name, $description, 16, $rights, 1)";
161 $affected = $mdb2->exec($sql);
162 if (is_a($affected, 'PEAR_Error'))
165 $name = $mdb2->quote($i18n->getKey('role.comanager.label'));
166 $description = $mdb2->quote($i18n->getKey('role.comanager.description'));
167 $rights = $mdb2->quote($rights_comanager);
168 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($user->team_id, $name, $description, 68, $rights, 1)";
169 $affected = $mdb2->exec($sql);
170 if (is_a($affected, 'PEAR_Error'))
173 $name = $mdb2->quote($i18n->getKey('role.manager.label'));
174 $description = $mdb2->quote($i18n->getKey('role.manager.description'));
175 $rights = $mdb2->quote($rights_manager);
176 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($user->team_id, $name, $description, 324, $rights, 1)";
177 $affected = $mdb2->exec($sql);
178 if (is_a($affected, 'PEAR_Error'))
182 $name = $mdb2->quote($i18n->getKey('role.supervisor.label'));
183 $description = $mdb2->quote($i18n->getKey('role.supervisor.description'));
184 $rights = $mdb2->quote($rights_supervisor);
185 $sql = "insert into tt_roles (team_id, name, description, rank, rights, status) values($user->team_id, $name, $description, 12, $rights, 0)";
186 $affected = $mdb2->exec($sql);
187 if (is_a($affected, 'PEAR_Error'))