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 getActiveUsers obtains all active users in a given group.
58 static function getActiveUsers($options = null) {
61 $mdb2 = getConnection();
63 $group_id = $user->getGroup();
64 $org_id = $user->org_id;
66 if (isset($options['getAllFields']))
67 $sql = "select u.*, r.name as role_name, r.rank from tt_users u left join tt_roles r on (u.role_id = r.id) where u.group_id = $group_id and u.org_id = $org_id and u.status = 1 order by upper(u.name)";
69 $sql = "select id, name from tt_users where group_id = $group_id and org_id = $org_id and status = 1 order by upper(name)";
70 $res = $mdb2->query($sql);
72 if (is_a($res, 'PEAR_Error'))
74 while ($val = $res->fetchRow()) {
75 // Localize top manager role name, as it is not localized in db.
76 if ($val['rank'] == 512)
77 $val['role_name'] = $i18n->get('role.top_manager.label');
81 if (isset($options['putSelfFirst'])) {
82 // Put own entry at the front.
83 $cnt = count($user_list);
84 for($i = 0; $i < $cnt; $i++) {
85 if ($user_list[$i]['id'] == $user->id) {
86 $self = $user_list[$i]; // Found self.
87 array_unshift($user_list, $self); // Put own entry at the front.
88 array_splice($user_list, $i+1, 1); // Remove duplicate.
95 // The swapRolesWith swaps existing user role with that of another user.
96 static function swapRolesWith($user_id) {
98 $mdb2 = getConnection();
100 // Obtain role id for the user we are swapping ourselves with.
101 $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";
102 $res = $mdb2->query($sql);
103 if (is_a($res, 'PEAR_Error'))
105 $val = $res->fetchRow();
106 if (!$val['id'] || !$val['role_id'])
109 $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$user->id;
112 $sql = "update tt_users set role_id = $user->role_id".$modified_part." where id = $user_id and group_id = $user->group_id";
113 $affected = $mdb2->exec($sql);
114 if (is_a($affected, 'PEAR_Error')) return false;
117 $role_id = $val['role_id'];
118 $sql = "update tt_users set role_id = $role_id".$modified_part." where id = $user->id and group_id = $user->group_id";
119 $affected = $mdb2->exec($sql);
120 if (is_a($affected, 'PEAR_Error')) return false;
125 // The getUsersForSwap obtains all users a current user can swap roles with.
126 static function getUsersForSwap() {
128 $mdb2 = getConnection();
130 $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)";
131 $res = $mdb2->query($sql);
132 $user_list = array();
133 if (is_a($res, 'PEAR_Error'))
135 while ($val = $res->fetchRow()) {
136 $isClient = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
138 continue; // Skip adding clients.
145 // The getUsers obtains all active and inactive (but not deleted) users in a group.
146 static function getUsers() {
148 $mdb2 = getConnection();
149 $sql = "select id, name from tt_users where group_id = $user->group_id and (status = 1 or status = 0) order by upper(name)";
150 $res = $mdb2->query($sql);
151 $user_list = array();
152 if (is_a($res, 'PEAR_Error'))
154 while ($val = $res->fetchRow()) {
160 // The getInactiveUsers obtains all inactive users in a group.
161 static function getInactiveUsers($group_id, $all_fields = false) {
162 $mdb2 = getConnection();
165 $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)";
167 $sql = "select id, name from tt_users where group_id = $group_id and status = 0 order by upper(name)";
168 $res = $mdb2->query($sql);
170 if (!is_a($res, 'PEAR_Error')) {
171 while ($val = $res->fetchRow()) {
179 // The getAllProjects obtains all projects in a group.
180 static function getAllProjects($group_id, $all_fields = false) {
181 $mdb2 = getConnection();
184 $sql = "select * from tt_projects where group_id = $group_id order by status, upper(name)";
186 $sql = "select id, name from tt_projects where group_id = $group_id order by status, upper(name)";
187 $res = $mdb2->query($sql);
189 if (!is_a($res, 'PEAR_Error')) {
190 while ($val = $res->fetchRow()) {
198 // getActiveTasks - returns an array of active tasks for a group.
199 static function getActiveTasks($group_id)
202 $mdb2 = getConnection();
204 $sql = "select id, name, description from tt_tasks where group_id = $group_id and status = 1 order by upper(name)";
205 $res = $mdb2->query($sql);
207 if (!is_a($res, 'PEAR_Error')) {
208 while ($val = $res->fetchRow()) {
215 // getInactiveTasks - returns an array of inactive tasks for a group.
216 static function getInactiveTasks($group_id)
219 $mdb2 = getConnection();
221 $sql = "select id, name, description from tt_tasks
222 where group_id = $group_id and status = 0 order by upper(name)";
223 $res = $mdb2->query($sql);
225 if (!is_a($res, 'PEAR_Error')) {
226 while ($val = $res->fetchRow()) {
233 // The getAllTasks obtains all tasks in a group.
234 static function getAllTasks($group_id, $all_fields = false) {
235 $mdb2 = getConnection();
238 $sql = "select * from tt_tasks where group_id = $group_id order by status, upper(name)";
240 $sql = "select id, name from tt_tasks where group_id = $group_id order by status, upper(name)";
241 $res = $mdb2->query($sql);
243 if (!is_a($res, 'PEAR_Error')) {
244 while ($val = $res->fetchRow()) {
252 // getActiveRolesForUser - returns an array of relevant active roles for user with rank less than self.
253 // "Relevant" means that client roles are filtered out if Client plugin is disabled.
254 static function getActiveRolesForUser()
258 $mdb2 = getConnection();
260 $group_id = $user->getGroup();
261 $org_id = $user->org_id;
263 // Determine max rank. If we are working in on behalf group
264 // then rank restriction does not apply.
265 $max_rank = $user->behalfGroup ? MAX_RANK : $user->rank;
267 $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";
268 $res = $mdb2->query($sql);
270 if (!is_a($res, 'PEAR_Error')) {
271 while ($val = $res->fetchRow()) {
272 $val['is_client'] = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have data entry right.
273 if ($val['is_client'] && !$user->isPluginEnabled('cl'))
274 continue; // Skip adding a client role.
281 // getActiveRoles - returns an array of active roles for a group.
282 static function getActiveRoles($group_id)
285 $mdb2 = getConnection();
287 $sql = "select id, name, description, rank, rights from tt_roles where group_id = $group_id and status = 1 order by rank";
288 $res = $mdb2->query($sql);
290 if (!is_a($res, 'PEAR_Error')) {
291 while ($val = $res->fetchRow()) {
292 $val['is_client'] = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
299 // getInactiveRoles - returns an array of inactive roles for a group.
300 static function getInactiveRoles($group_id)
303 $mdb2 = getConnection();
305 $sql = "select id, name, rank, description from tt_roles
306 where group_id = $group_id and status = 0 order by rank";
307 $res = $mdb2->query($sql);
309 if (!is_a($res, 'PEAR_Error')) {
310 while ($val = $res->fetchRow()) {
317 // getInactiveRolesForUser - returns an array of relevant active roles for user with rank less than self.
318 // "Relevant" means that client roles are filtered out if Client plugin is disabled.
319 static function getInactiveRolesForUser()
323 $mdb2 = getConnection();
325 $group_id = $user->getGroup();
326 $org_id = $user->org_id;
328 // Determine max rank. If we are working in on behalf group
329 // then rank restriction does not apply.
330 $max_rank = $user->behalfGroup ? MAX_RANK : $user->rank;
332 $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";
333 $res = $mdb2->query($sql);
335 if (!is_a($res, 'PEAR_Error')) {
336 while ($val = $res->fetchRow()) {
337 $val['is_client'] = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have data entry right.
338 if ($val['is_client'] && !$user->isPluginEnabled('cl'))
339 continue; // Skip adding a client role.
346 // The getAllClients obtains all clients in a group.
347 static function getAllClients($group_id, $all_fields = false) {
348 $mdb2 = getConnection();
351 $sql = "select * from tt_clients where group_id = $group_id order by status, upper(name)";
353 $sql = "select id, name from tt_clients where group_id = $group_id order by status, upper(name)";
355 $res = $mdb2->query($sql);
357 if (!is_a($res, 'PEAR_Error')) {
358 while ($val = $res->fetchRow()) {
366 // The getActiveInvoices returns an array of active invoices for a group.
367 static function getActiveInvoices($localizeDates = true)
370 $addPaidStatus = $user->isPluginEnabled('ps');
373 $mdb2 = getConnection();
375 if ($user->isClient())
376 $client_part = " and i.client_id = $user->client_id";
378 $sql = "select i.id, i.name, i.date, i.client_id, i.status, c.name as client_name from tt_invoices i
379 left join tt_clients c on (c.id = i.client_id)
380 where i.status = 1 and i.group_id = $user->group_id $client_part order by i.name";
381 $res = $mdb2->query($sql);
383 if (!is_a($res, 'PEAR_Error')) {
384 $dt = new DateAndTime(DB_DATEFORMAT);
385 while ($val = $res->fetchRow()) {
386 if ($localizeDates) {
387 $dt->parseVal($val['date']);
388 $val['date'] = $dt->toString($user->date_format);
391 $val['paid'] = ttInvoiceHelper::isPaid($val['id']);
398 // The getAllInvoices returns an array of all invoices for a group.
399 static function getAllInvoices()
404 $mdb2 = getConnection();
406 $sql = "select * from tt_invoices where group_id = $user->group_id";
407 $res = $mdb2->query($sql);
409 if (!is_a($res, 'PEAR_Error')) {
410 $dt = new DateAndTime(DB_DATEFORMAT);
411 while ($val = $res->fetchRow()) {
418 // The getRecentInvoices returns an array of recent invoices (max 3) for a client.
419 static function getRecentInvoices($group_id, $client_id)
424 $mdb2 = getConnection();
426 $sql = "select i.id, i.name from tt_invoices i
427 left join tt_clients c on (c.id = i.client_id)
428 where i.group_id = $group_id and i.status = 1 and c.id = $client_id
429 order by i.id desc limit 3";
430 $res = $mdb2->query($sql);
432 if (!is_a($res, 'PEAR_Error')) {
433 $dt = new DateAndTime(DB_DATEFORMAT);
434 while ($val = $res->fetchRow()) {
441 // getUserToProjectBinds - obtains all user to project binds for a group.
442 static function getUserToProjectBinds($group_id) {
443 $mdb2 = getConnection();
446 $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";
447 $res = $mdb2->query($sql);
449 if (!is_a($res, 'PEAR_Error')) {
450 while ($val = $res->fetchRow()) {
458 // The getAllCustomFields obtains all custom fields in a group.
459 static function getAllCustomFields($group_id) {
460 $mdb2 = getConnection();
462 $sql = "select * from tt_custom_fields where group_id = $group_id order by status";
464 $res = $mdb2->query($sql);
466 if (!is_a($res, 'PEAR_Error')) {
467 while ($val = $res->fetchRow()) {
475 // The getAllCustomFieldOptions obtains all custom field options in a group.
476 static function getAllCustomFieldOptions($group_id) {
477 $mdb2 = getConnection();
479 $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";
481 $res = $mdb2->query($sql);
483 if (!is_a($res, 'PEAR_Error')) {
484 while ($val = $res->fetchRow()) {
492 // The getCustomFieldLog obtains all custom field log entries for a group.
493 static function getCustomFieldLog($group_id) {
494 $mdb2 = getConnection();
496 $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";
498 $res = $mdb2->query($sql);
500 if (!is_a($res, 'PEAR_Error')) {
501 while ($val = $res->fetchRow()) {
509 // getFavReports - obtains all favorite reports for all users in a group.
510 static function getFavReports($group_id) {
511 $mdb2 = getConnection();
514 $sql = "select * from tt_fav_reports where user_id in (select id from tt_users where group_id = $group_id)";
515 $res = $mdb2->query($sql);
517 if (!is_a($res, 'PEAR_Error')) {
518 while ($val = $res->fetchRow()) {
526 // getExpenseItems - obtains all expense items for all users in a group.
527 static function getExpenseItems($group_id) {
528 $mdb2 = getConnection();
531 $sql = "select * from tt_expense_items where user_id in (select id from tt_users where group_id = $group_id)";
532 $res = $mdb2->query($sql);
534 if (!is_a($res, 'PEAR_Error')) {
535 while ($val = $res->fetchRow()) {
543 // getNotifications - obtains notification descriptions for a group.
544 static function getNotifications($group_id) {
545 $mdb2 = getConnection();
548 $sql = "select c.id, c.cron_spec, c.email, c.report_condition, fr.name from tt_cron c
549 left join tt_fav_reports fr on (fr.id = c.report_id)
550 where c.group_id = $group_id and c.status = 1 and fr.status = 1";
551 $res = $mdb2->query($sql);
553 if (!is_a($res, 'PEAR_Error')) {
554 while ($val = $res->fetchRow()) {
562 // getMonthlyQuotas - obtains monthly quotas for a group.
563 static function getMonthlyQuotas($group_id) {
564 $mdb2 = getConnection();
567 $sql = "select year, month, minutes from tt_monthly_quotas where group_id = $group_id";
568 $res = $mdb2->query($sql);
570 if (!is_a($res, 'PEAR_Error')) {
571 while ($val = $res->fetchRow()) {
579 // The delete function permanently deletes all data for a group.
580 static function delete($group_id) {
581 $mdb2 = getConnection();
584 $sql = "select id from tt_users where group_id = $group_id";
585 $res = $mdb2->query($sql);
586 if (is_a($res, 'PEAR_Error')) return false;
587 while ($val = $res->fetchRow()) {
588 $user_id = $val['id'];
589 if (!ttUserHelper::delete($user_id)) return false;
593 if (!ttTeamHelper::deleteTasks($group_id)) return false;
595 // Delete client to project binds.
596 $sql = "delete from tt_client_project_binds where client_id in (select id from tt_clients where group_id = $group_id)";
597 $affected = $mdb2->exec($sql);
598 if (is_a($affected, 'PEAR_Error')) return false;
601 $sql = "delete from tt_projects where group_id = $group_id";
602 $affected = $mdb2->exec($sql);
603 if (is_a($affected, 'PEAR_Error')) return false;
606 $sql = "delete from tt_clients where group_id = $group_id";
607 $affected = $mdb2->exec($sql);
608 if (is_a($affected, 'PEAR_Error')) return false;
611 $sql = "delete from tt_invoices where group_id = $group_id";
612 $affected = $mdb2->exec($sql);
613 if (is_a($affected, 'PEAR_Error')) return false;
615 // Delete custom fields.
616 if (!ttTeamHelper::deleteCustomFields($group_id)) return false;
619 $sql = "delete from tt_roles where group_id = $group_id";
620 $affected = $mdb2->exec($sql);
621 if (is_a($affected, 'PEAR_Error')) return false;
623 // Delete cron entries.
624 $sql = "delete from tt_cron where group_id = $group_id";
625 $affected = $mdb2->exec($sql);
626 if (is_a($affected, 'PEAR_Error')) return false;
628 // Delete predefined expenses.
629 $sql = "delete from tt_predefined_expenses where group_id = $group_id";
630 $affected = $mdb2->exec($sql);
631 if (is_a($affected, 'PEAR_Error')) return false;
633 // Delete monthly quotas.
634 $sql = "delete from tt_monthly_quotas where group_id = $group_id";
635 $affected = $mdb2->exec($sql);
636 if (is_a($affected, 'PEAR_Error')) return false;
639 $sql = "delete from tt_groups where id = $group_id";
640 $affected = $mdb2->exec($sql);
641 if (is_a($affected, 'PEAR_Error')) return false;
646 // The deleteTasks deletes all tasks and task binds for an inactive group.
647 static function deleteTasks($group_id) {
648 $mdb2 = getConnection();
649 $sql = "select id from tt_tasks where group_id = $group_id";
650 $res = $mdb2->query($sql);
651 if (is_a($res, 'PEAR_Error')) return false;
653 while ($val = $res->fetchRow()) {
655 // Delete task binds.
656 $task_id = $val['id'];
657 $sql = "delete from tt_project_task_binds where task_id = $task_id";
658 $affected = $mdb2->exec($sql);
659 if (is_a($affected, 'PEAR_Error')) return false;
662 $sql = "delete from tt_tasks where id = $task_id";
663 $affected = $mdb2->exec($sql);
664 if (is_a($affected, 'PEAR_Error')) return false;
670 // The deleteCustomFields cleans up tt_custom_field_log, tt_custom_field_options and tt_custom_fields tables for an inactive group.
671 static function deleteCustomFields($group_id) {
672 $mdb2 = getConnection();
673 $sql = "select id from tt_custom_fields where group_id = $group_id";
674 $res = $mdb2->query($sql);
675 if (is_a($res, 'PEAR_Error')) return false;
677 while ($val = $res->fetchRow()) {
678 $field_id = $val['id'];
680 // Clean up tt_custom_field_log.
681 $sql = "delete from tt_custom_field_log where field_id = $field_id";
682 $affected = $mdb2->exec($sql);
683 if (is_a($affected, 'PEAR_Error')) return false;
685 // Clean up tt_custom_field_options.
686 $sql = "delete from tt_custom_field_options where field_id = $field_id";
687 $affected = $mdb2->exec($sql);
688 if (is_a($affected, 'PEAR_Error')) return false;
690 // Delete custom field.
691 $sql = "delete from tt_custom_fields where id = $field_id";
692 $affected = $mdb2->exec($sql);
693 if (is_a($affected, 'PEAR_Error')) return false;