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 import('ttUserHelper');
30 import('DateAndTime');
31 import('ttInvoiceHelper');
33 // Class ttTeamHelper - contains helper functions that operate with groups.
36 // The getUsersForClient obtains all active and inactive users in a group that are relevant to a client.
37 static function getUsersForClient() {
39 $mdb2 = getConnection();
41 $sql = "select u.id, u.name from tt_user_project_binds upb".
42 " inner join tt_client_project_binds cpb on (upb.project_id = cpb.project_id and cpb.client_id = $user->client_id)".
43 " inner join tt_users u on (u.id = upb.user_id)".
44 " where (u.status = 1 or u.status = 0)".
46 " order by upper(u.name)";
47 $res = $mdb2->query($sql);
49 if (is_a($res, 'PEAR_Error'))
51 while ($val = $res->fetchRow()) {
57 // The swapRolesWith swaps existing user role with that of another user.
58 static function swapRolesWith($user_id) {
60 $mdb2 = getConnection();
62 // Obtain role id for the user we are swapping ourselves with.
63 $sql = "select u.id, u.role_id from tt_users u left join tt_roles r on (u.role_id = r.id) where u.id = $user_id and u.group_id = $user->group_id and u.status = 1 and r.rank < $user->rank";
64 $res = $mdb2->query($sql);
65 if (is_a($res, 'PEAR_Error'))
67 $val = $res->fetchRow();
68 if (!$val['id'] || !$val['role_id'])
71 $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$user->id;
74 $sql = "update tt_users set role_id = $user->role_id".$modified_part." where id = $user_id and group_id = $user->group_id";
75 $affected = $mdb2->exec($sql);
76 if (is_a($affected, 'PEAR_Error')) return false;
79 $role_id = $val['role_id'];
80 $sql = "update tt_users set role_id = $role_id".$modified_part." where id = $user->id and group_id = $user->group_id";
81 $affected = $mdb2->exec($sql);
82 if (is_a($affected, 'PEAR_Error')) return false;
87 // The getUsersForSwap obtains all users a current user can swap roles with.
88 static function getUsersForSwap() {
90 $mdb2 = getConnection();
92 $sql = "select u.id, u.name, r.rank, r.rights from tt_users u left join tt_roles r on (u.role_id = r.id) where u.group_id = $user->group_id and u.status = 1 and r.rank < $user->rank order by upper(u.name)";
93 $res = $mdb2->query($sql);
95 if (is_a($res, 'PEAR_Error'))
97 while ($val = $res->fetchRow()) {
98 $isClient = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
100 continue; // Skip adding clients.
107 // The getInactiveUsers obtains all inactive users in a group.
108 static function getInactiveUsers($group_id, $all_fields = false) {
109 $mdb2 = getConnection();
112 $sql = "select u.*, r.name as role_name from tt_users u left join tt_roles r on (u.role_id = r.id) where u.group_id = $group_id and u.status = 0 order by upper(u.name)";
114 $sql = "select id, name from tt_users where group_id = $group_id and status = 0 order by upper(name)";
115 $res = $mdb2->query($sql);
117 if (!is_a($res, 'PEAR_Error')) {
118 while ($val = $res->fetchRow()) {
126 // The getAllProjects obtains all projects in a group.
127 static function getAllProjects($group_id, $all_fields = false) {
128 $mdb2 = getConnection();
131 $sql = "select * from tt_projects where group_id = $group_id order by status, upper(name)";
133 $sql = "select id, name from tt_projects where group_id = $group_id order by status, upper(name)";
134 $res = $mdb2->query($sql);
136 if (!is_a($res, 'PEAR_Error')) {
137 while ($val = $res->fetchRow()) {
145 // getActiveRolesForUser - returns an array of relevant active roles for user with rank less than self.
146 // "Relevant" means that client roles are filtered out if Client plugin is disabled.
147 static function getActiveRolesForUser()
151 $mdb2 = getConnection();
153 $group_id = $user->getGroup();
154 $org_id = $user->org_id;
156 // Determine max rank. If we are working in on behalf group
157 // then rank restriction does not apply.
158 $max_rank = $user->behalfGroup ? MAX_RANK : $user->rank;
160 $sql = "select id, name, description, rank, rights from tt_roles where group_id = $group_id and org_id = $org_id and rank < $max_rank and status = 1 order by rank";
161 $res = $mdb2->query($sql);
163 if (!is_a($res, 'PEAR_Error')) {
164 while ($val = $res->fetchRow()) {
165 $val['is_client'] = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have data entry right.
166 if ($val['is_client'] && !$user->isPluginEnabled('cl'))
167 continue; // Skip adding a client role.
174 // getActiveRoles - returns an array of active roles for a group.
175 static function getActiveRoles($group_id)
178 $mdb2 = getConnection();
180 $sql = "select id, name, description, rank, rights from tt_roles where group_id = $group_id and status = 1 order by rank";
181 $res = $mdb2->query($sql);
183 if (!is_a($res, 'PEAR_Error')) {
184 while ($val = $res->fetchRow()) {
185 $val['is_client'] = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
192 // getInactiveRoles - returns an array of inactive roles for a group.
193 static function getInactiveRoles($group_id)
196 $mdb2 = getConnection();
198 $sql = "select id, name, rank, description from tt_roles
199 where group_id = $group_id and status = 0 order by rank";
200 $res = $mdb2->query($sql);
202 if (!is_a($res, 'PEAR_Error')) {
203 while ($val = $res->fetchRow()) {
210 // getInactiveRolesForUser - returns an array of relevant active roles for user with rank less than self.
211 // "Relevant" means that client roles are filtered out if Client plugin is disabled.
212 static function getInactiveRolesForUser()
216 $mdb2 = getConnection();
218 $group_id = $user->getGroup();
219 $org_id = $user->org_id;
221 // Determine max rank. If we are working in on behalf group
222 // then rank restriction does not apply.
223 $max_rank = $user->behalfGroup ? MAX_RANK : $user->rank;
225 $sql = "select id, name, description, rank, rights from tt_roles where group_id = $group_id and org_id = $org_id and rank < $max_rank and status = 0 order by rank";
226 $res = $mdb2->query($sql);
228 if (!is_a($res, 'PEAR_Error')) {
229 while ($val = $res->fetchRow()) {
230 $val['is_client'] = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have data entry right.
231 if ($val['is_client'] && !$user->isPluginEnabled('cl'))
232 continue; // Skip adding a client role.
239 // The getAllClients obtains all clients in a group.
240 static function getAllClients($group_id, $all_fields = false) {
241 $mdb2 = getConnection();
244 $sql = "select * from tt_clients where group_id = $group_id order by status, upper(name)";
246 $sql = "select id, name from tt_clients where group_id = $group_id order by status, upper(name)";
248 $res = $mdb2->query($sql);
250 if (!is_a($res, 'PEAR_Error')) {
251 while ($val = $res->fetchRow()) {
259 // The getAllInvoices returns an array of all invoices for a group.
260 static function getAllInvoices()
265 $mdb2 = getConnection();
267 $sql = "select * from tt_invoices where group_id = $user->group_id";
268 $res = $mdb2->query($sql);
270 if (!is_a($res, 'PEAR_Error')) {
271 $dt = new DateAndTime(DB_DATEFORMAT);
272 while ($val = $res->fetchRow()) {
279 // The getRecentInvoices returns an array of recent invoices (max 3) for a client.
280 static function getRecentInvoices($group_id, $client_id)
285 $mdb2 = getConnection();
287 $sql = "select i.id, i.name from tt_invoices i
288 left join tt_clients c on (c.id = i.client_id)
289 where i.group_id = $group_id and i.status = 1 and c.id = $client_id
290 order by i.id desc limit 3";
291 $res = $mdb2->query($sql);
293 if (!is_a($res, 'PEAR_Error')) {
294 $dt = new DateAndTime(DB_DATEFORMAT);
295 while ($val = $res->fetchRow()) {
302 // getUserToProjectBinds - obtains all user to project binds for a group.
303 static function getUserToProjectBinds($group_id) {
304 $mdb2 = getConnection();
307 $sql = "select * from tt_user_project_binds where user_id in (select id from tt_users where group_id = $group_id) order by user_id, status, project_id";
308 $res = $mdb2->query($sql);
310 if (!is_a($res, 'PEAR_Error')) {
311 while ($val = $res->fetchRow()) {
319 // The getAllCustomFields obtains all custom fields in a group.
320 static function getAllCustomFields($group_id) {
321 $mdb2 = getConnection();
323 $sql = "select * from tt_custom_fields where group_id = $group_id order by status";
325 $res = $mdb2->query($sql);
327 if (!is_a($res, 'PEAR_Error')) {
328 while ($val = $res->fetchRow()) {
336 // The getAllCustomFieldOptions obtains all custom field options in a group.
337 static function getAllCustomFieldOptions($group_id) {
338 $mdb2 = getConnection();
340 $sql = "select * from tt_custom_field_options where field_id in (select id from tt_custom_fields where group_id = $group_id) order by id";
342 $res = $mdb2->query($sql);
344 if (!is_a($res, 'PEAR_Error')) {
345 while ($val = $res->fetchRow()) {
353 // The getCustomFieldLog obtains all custom field log entries for a group.
354 static function getCustomFieldLog($group_id) {
355 $mdb2 = getConnection();
357 $sql = "select * from tt_custom_field_log where field_id in (select id from tt_custom_fields where group_id = $group_id) order by id";
359 $res = $mdb2->query($sql);
361 if (!is_a($res, 'PEAR_Error')) {
362 while ($val = $res->fetchRow()) {
370 // getFavReports - obtains all favorite reports for all users in a group.
371 static function getFavReports($group_id) {
372 $mdb2 = getConnection();
375 $sql = "select * from tt_fav_reports where user_id in (select id from tt_users where group_id = $group_id)";
376 $res = $mdb2->query($sql);
378 if (!is_a($res, 'PEAR_Error')) {
379 while ($val = $res->fetchRow()) {
387 // getExpenseItems - obtains all expense items for all users in a group.
388 static function getExpenseItems($group_id) {
389 $mdb2 = getConnection();
392 $sql = "select * from tt_expense_items where user_id in (select id from tt_users where group_id = $group_id)";
393 $res = $mdb2->query($sql);
395 if (!is_a($res, 'PEAR_Error')) {
396 while ($val = $res->fetchRow()) {
404 // getMonthlyQuotas - obtains monthly quotas for a group.
405 static function getMonthlyQuotas($group_id) {
406 $mdb2 = getConnection();
409 $sql = "select year, month, minutes from tt_monthly_quotas where group_id = $group_id";
410 $res = $mdb2->query($sql);
412 if (!is_a($res, 'PEAR_Error')) {
413 while ($val = $res->fetchRow()) {
421 // The delete function permanently deletes all data for a group.
422 static function delete($group_id) {
423 $mdb2 = getConnection();
426 $sql = "select id from tt_users where group_id = $group_id";
427 $res = $mdb2->query($sql);
428 if (is_a($res, 'PEAR_Error')) return false;
429 while ($val = $res->fetchRow()) {
430 $user_id = $val['id'];
431 if (!ttUserHelper::delete($user_id)) return false;
435 if (!ttTeamHelper::deleteTasks($group_id)) return false;
437 // Delete client to project binds.
438 $sql = "delete from tt_client_project_binds where client_id in (select id from tt_clients where group_id = $group_id)";
439 $affected = $mdb2->exec($sql);
440 if (is_a($affected, 'PEAR_Error')) return false;
443 $sql = "delete from tt_projects where group_id = $group_id";
444 $affected = $mdb2->exec($sql);
445 if (is_a($affected, 'PEAR_Error')) return false;
448 $sql = "delete from tt_clients where group_id = $group_id";
449 $affected = $mdb2->exec($sql);
450 if (is_a($affected, 'PEAR_Error')) return false;
453 $sql = "delete from tt_invoices where group_id = $group_id";
454 $affected = $mdb2->exec($sql);
455 if (is_a($affected, 'PEAR_Error')) return false;
457 // Delete custom fields.
458 if (!ttTeamHelper::deleteCustomFields($group_id)) return false;
461 $sql = "delete from tt_roles where group_id = $group_id";
462 $affected = $mdb2->exec($sql);
463 if (is_a($affected, 'PEAR_Error')) return false;
465 // Delete cron entries.
466 $sql = "delete from tt_cron where group_id = $group_id";
467 $affected = $mdb2->exec($sql);
468 if (is_a($affected, 'PEAR_Error')) return false;
470 // Delete predefined expenses.
471 $sql = "delete from tt_predefined_expenses where group_id = $group_id";
472 $affected = $mdb2->exec($sql);
473 if (is_a($affected, 'PEAR_Error')) return false;
475 // Delete monthly quotas.
476 $sql = "delete from tt_monthly_quotas where group_id = $group_id";
477 $affected = $mdb2->exec($sql);
478 if (is_a($affected, 'PEAR_Error')) return false;
481 $sql = "delete from tt_groups where id = $group_id";
482 $affected = $mdb2->exec($sql);
483 if (is_a($affected, 'PEAR_Error')) return false;
488 // The deleteTasks deletes all tasks and task binds for an inactive group.
489 static function deleteTasks($group_id) {
490 $mdb2 = getConnection();
491 $sql = "select id from tt_tasks where group_id = $group_id";
492 $res = $mdb2->query($sql);
493 if (is_a($res, 'PEAR_Error')) return false;
495 while ($val = $res->fetchRow()) {
497 // Delete task binds.
498 $task_id = $val['id'];
499 $sql = "delete from tt_project_task_binds where task_id = $task_id";
500 $affected = $mdb2->exec($sql);
501 if (is_a($affected, 'PEAR_Error')) return false;
504 $sql = "delete from tt_tasks where id = $task_id";
505 $affected = $mdb2->exec($sql);
506 if (is_a($affected, 'PEAR_Error')) return false;
512 // The deleteCustomFields cleans up tt_custom_field_log, tt_custom_field_options and tt_custom_fields tables for an inactive group.
513 static function deleteCustomFields($group_id) {
514 $mdb2 = getConnection();
515 $sql = "select id from tt_custom_fields where group_id = $group_id";
516 $res = $mdb2->query($sql);
517 if (is_a($res, 'PEAR_Error')) return false;
519 while ($val = $res->fetchRow()) {
520 $field_id = $val['id'];
522 // Clean up tt_custom_field_log.
523 $sql = "delete from tt_custom_field_log where field_id = $field_id";
524 $affected = $mdb2->exec($sql);
525 if (is_a($affected, 'PEAR_Error')) return false;
527 // Clean up tt_custom_field_options.
528 $sql = "delete from tt_custom_field_options where field_id = $field_id";
529 $affected = $mdb2->exec($sql);
530 if (is_a($affected, 'PEAR_Error')) return false;
532 // Delete custom field.
533 $sql = "delete from tt_custom_fields where id = $field_id";
534 $affected = $mdb2->exec($sql);
535 if (is_a($affected, 'PEAR_Error')) return false;