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 getUsers obtains all active and inactive (but not deleted) users in a group.
108 static function getUsers() {
110 $mdb2 = getConnection();
111 $sql = "select id, name from tt_users where group_id = $user->group_id and (status = 1 or status = 0) order by upper(name)";
112 $res = $mdb2->query($sql);
113 $user_list = array();
114 if (is_a($res, 'PEAR_Error'))
116 while ($val = $res->fetchRow()) {
122 // The getInactiveUsers obtains all inactive users in a group.
123 static function getInactiveUsers($group_id, $all_fields = false) {
124 $mdb2 = getConnection();
127 $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)";
129 $sql = "select id, name from tt_users where group_id = $group_id and status = 0 order by upper(name)";
130 $res = $mdb2->query($sql);
132 if (!is_a($res, 'PEAR_Error')) {
133 while ($val = $res->fetchRow()) {
141 // The getAllProjects obtains all projects in a group.
142 static function getAllProjects($group_id, $all_fields = false) {
143 $mdb2 = getConnection();
146 $sql = "select * from tt_projects where group_id = $group_id order by status, upper(name)";
148 $sql = "select id, name from tt_projects where group_id = $group_id order by status, upper(name)";
149 $res = $mdb2->query($sql);
151 if (!is_a($res, 'PEAR_Error')) {
152 while ($val = $res->fetchRow()) {
160 // getInactiveTasks - returns an array of inactive tasks for a group.
161 static function getInactiveTasks($group_id)
164 $mdb2 = getConnection();
166 $sql = "select id, name, description from tt_tasks
167 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()) {
178 // The getAllTasks obtains all tasks in a group.
179 static function getAllTasks($group_id, $all_fields = false) {
180 $mdb2 = getConnection();
183 $sql = "select * from tt_tasks where group_id = $group_id order by status, upper(name)";
185 $sql = "select id, name from tt_tasks where group_id = $group_id order by status, upper(name)";
186 $res = $mdb2->query($sql);
188 if (!is_a($res, 'PEAR_Error')) {
189 while ($val = $res->fetchRow()) {
197 // getActiveRolesForUser - returns an array of relevant active roles for user with rank less than self.
198 // "Relevant" means that client roles are filtered out if Client plugin is disabled.
199 static function getActiveRolesForUser()
203 $mdb2 = getConnection();
205 $group_id = $user->getGroup();
206 $org_id = $user->org_id;
208 // Determine max rank. If we are working in on behalf group
209 // then rank restriction does not apply.
210 $max_rank = $user->behalfGroup ? MAX_RANK : $user->rank;
212 $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";
213 $res = $mdb2->query($sql);
215 if (!is_a($res, 'PEAR_Error')) {
216 while ($val = $res->fetchRow()) {
217 $val['is_client'] = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have data entry right.
218 if ($val['is_client'] && !$user->isPluginEnabled('cl'))
219 continue; // Skip adding a client role.
226 // getActiveRoles - returns an array of active roles for a group.
227 static function getActiveRoles($group_id)
230 $mdb2 = getConnection();
232 $sql = "select id, name, description, rank, rights from tt_roles where group_id = $group_id and status = 1 order by rank";
233 $res = $mdb2->query($sql);
235 if (!is_a($res, 'PEAR_Error')) {
236 while ($val = $res->fetchRow()) {
237 $val['is_client'] = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
244 // getInactiveRoles - returns an array of inactive roles for a group.
245 static function getInactiveRoles($group_id)
248 $mdb2 = getConnection();
250 $sql = "select id, name, rank, description from tt_roles
251 where group_id = $group_id and status = 0 order by rank";
252 $res = $mdb2->query($sql);
254 if (!is_a($res, 'PEAR_Error')) {
255 while ($val = $res->fetchRow()) {
262 // getInactiveRolesForUser - returns an array of relevant active roles for user with rank less than self.
263 // "Relevant" means that client roles are filtered out if Client plugin is disabled.
264 static function getInactiveRolesForUser()
268 $mdb2 = getConnection();
270 $group_id = $user->getGroup();
271 $org_id = $user->org_id;
273 // Determine max rank. If we are working in on behalf group
274 // then rank restriction does not apply.
275 $max_rank = $user->behalfGroup ? MAX_RANK : $user->rank;
277 $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";
278 $res = $mdb2->query($sql);
280 if (!is_a($res, 'PEAR_Error')) {
281 while ($val = $res->fetchRow()) {
282 $val['is_client'] = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have data entry right.
283 if ($val['is_client'] && !$user->isPluginEnabled('cl'))
284 continue; // Skip adding a client role.
291 // The getAllClients obtains all clients in a group.
292 static function getAllClients($group_id, $all_fields = false) {
293 $mdb2 = getConnection();
296 $sql = "select * from tt_clients where group_id = $group_id order by status, upper(name)";
298 $sql = "select id, name from tt_clients where group_id = $group_id order by status, upper(name)";
300 $res = $mdb2->query($sql);
302 if (!is_a($res, 'PEAR_Error')) {
303 while ($val = $res->fetchRow()) {
311 // The getAllInvoices returns an array of all invoices for a group.
312 static function getAllInvoices()
317 $mdb2 = getConnection();
319 $sql = "select * from tt_invoices where group_id = $user->group_id";
320 $res = $mdb2->query($sql);
322 if (!is_a($res, 'PEAR_Error')) {
323 $dt = new DateAndTime(DB_DATEFORMAT);
324 while ($val = $res->fetchRow()) {
331 // The getRecentInvoices returns an array of recent invoices (max 3) for a client.
332 static function getRecentInvoices($group_id, $client_id)
337 $mdb2 = getConnection();
339 $sql = "select i.id, i.name from tt_invoices i
340 left join tt_clients c on (c.id = i.client_id)
341 where i.group_id = $group_id and i.status = 1 and c.id = $client_id
342 order by i.id desc limit 3";
343 $res = $mdb2->query($sql);
345 if (!is_a($res, 'PEAR_Error')) {
346 $dt = new DateAndTime(DB_DATEFORMAT);
347 while ($val = $res->fetchRow()) {
354 // getUserToProjectBinds - obtains all user to project binds for a group.
355 static function getUserToProjectBinds($group_id) {
356 $mdb2 = getConnection();
359 $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";
360 $res = $mdb2->query($sql);
362 if (!is_a($res, 'PEAR_Error')) {
363 while ($val = $res->fetchRow()) {
371 // The getAllCustomFields obtains all custom fields in a group.
372 static function getAllCustomFields($group_id) {
373 $mdb2 = getConnection();
375 $sql = "select * from tt_custom_fields where group_id = $group_id order by status";
377 $res = $mdb2->query($sql);
379 if (!is_a($res, 'PEAR_Error')) {
380 while ($val = $res->fetchRow()) {
388 // The getAllCustomFieldOptions obtains all custom field options in a group.
389 static function getAllCustomFieldOptions($group_id) {
390 $mdb2 = getConnection();
392 $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";
394 $res = $mdb2->query($sql);
396 if (!is_a($res, 'PEAR_Error')) {
397 while ($val = $res->fetchRow()) {
405 // The getCustomFieldLog obtains all custom field log entries for a group.
406 static function getCustomFieldLog($group_id) {
407 $mdb2 = getConnection();
409 $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";
411 $res = $mdb2->query($sql);
413 if (!is_a($res, 'PEAR_Error')) {
414 while ($val = $res->fetchRow()) {
422 // getFavReports - obtains all favorite reports for all users in a group.
423 static function getFavReports($group_id) {
424 $mdb2 = getConnection();
427 $sql = "select * from tt_fav_reports where user_id in (select id from tt_users where group_id = $group_id)";
428 $res = $mdb2->query($sql);
430 if (!is_a($res, 'PEAR_Error')) {
431 while ($val = $res->fetchRow()) {
439 // getExpenseItems - obtains all expense items for all users in a group.
440 static function getExpenseItems($group_id) {
441 $mdb2 = getConnection();
444 $sql = "select * from tt_expense_items where user_id in (select id from tt_users where group_id = $group_id)";
445 $res = $mdb2->query($sql);
447 if (!is_a($res, 'PEAR_Error')) {
448 while ($val = $res->fetchRow()) {
456 // getMonthlyQuotas - obtains monthly quotas for a group.
457 static function getMonthlyQuotas($group_id) {
458 $mdb2 = getConnection();
461 $sql = "select year, month, minutes from tt_monthly_quotas where group_id = $group_id";
462 $res = $mdb2->query($sql);
464 if (!is_a($res, 'PEAR_Error')) {
465 while ($val = $res->fetchRow()) {
473 // The delete function permanently deletes all data for a group.
474 static function delete($group_id) {
475 $mdb2 = getConnection();
478 $sql = "select id from tt_users where group_id = $group_id";
479 $res = $mdb2->query($sql);
480 if (is_a($res, 'PEAR_Error')) return false;
481 while ($val = $res->fetchRow()) {
482 $user_id = $val['id'];
483 if (!ttUserHelper::delete($user_id)) return false;
487 if (!ttTeamHelper::deleteTasks($group_id)) return false;
489 // Delete client to project binds.
490 $sql = "delete from tt_client_project_binds where client_id in (select id from tt_clients where group_id = $group_id)";
491 $affected = $mdb2->exec($sql);
492 if (is_a($affected, 'PEAR_Error')) return false;
495 $sql = "delete from tt_projects where group_id = $group_id";
496 $affected = $mdb2->exec($sql);
497 if (is_a($affected, 'PEAR_Error')) return false;
500 $sql = "delete from tt_clients where group_id = $group_id";
501 $affected = $mdb2->exec($sql);
502 if (is_a($affected, 'PEAR_Error')) return false;
505 $sql = "delete from tt_invoices where group_id = $group_id";
506 $affected = $mdb2->exec($sql);
507 if (is_a($affected, 'PEAR_Error')) return false;
509 // Delete custom fields.
510 if (!ttTeamHelper::deleteCustomFields($group_id)) return false;
513 $sql = "delete from tt_roles where group_id = $group_id";
514 $affected = $mdb2->exec($sql);
515 if (is_a($affected, 'PEAR_Error')) return false;
517 // Delete cron entries.
518 $sql = "delete from tt_cron where group_id = $group_id";
519 $affected = $mdb2->exec($sql);
520 if (is_a($affected, 'PEAR_Error')) return false;
522 // Delete predefined expenses.
523 $sql = "delete from tt_predefined_expenses where group_id = $group_id";
524 $affected = $mdb2->exec($sql);
525 if (is_a($affected, 'PEAR_Error')) return false;
527 // Delete monthly quotas.
528 $sql = "delete from tt_monthly_quotas where group_id = $group_id";
529 $affected = $mdb2->exec($sql);
530 if (is_a($affected, 'PEAR_Error')) return false;
533 $sql = "delete from tt_groups where id = $group_id";
534 $affected = $mdb2->exec($sql);
535 if (is_a($affected, 'PEAR_Error')) return false;
540 // The deleteTasks deletes all tasks and task binds for an inactive group.
541 static function deleteTasks($group_id) {
542 $mdb2 = getConnection();
543 $sql = "select id from tt_tasks where group_id = $group_id";
544 $res = $mdb2->query($sql);
545 if (is_a($res, 'PEAR_Error')) return false;
547 while ($val = $res->fetchRow()) {
549 // Delete task binds.
550 $task_id = $val['id'];
551 $sql = "delete from tt_project_task_binds where task_id = $task_id";
552 $affected = $mdb2->exec($sql);
553 if (is_a($affected, 'PEAR_Error')) return false;
556 $sql = "delete from tt_tasks where id = $task_id";
557 $affected = $mdb2->exec($sql);
558 if (is_a($affected, 'PEAR_Error')) return false;
564 // The deleteCustomFields cleans up tt_custom_field_log, tt_custom_field_options and tt_custom_fields tables for an inactive group.
565 static function deleteCustomFields($group_id) {
566 $mdb2 = getConnection();
567 $sql = "select id from tt_custom_fields where group_id = $group_id";
568 $res = $mdb2->query($sql);
569 if (is_a($res, 'PEAR_Error')) return false;
571 while ($val = $res->fetchRow()) {
572 $field_id = $val['id'];
574 // Clean up tt_custom_field_log.
575 $sql = "delete from tt_custom_field_log where field_id = $field_id";
576 $affected = $mdb2->exec($sql);
577 if (is_a($affected, 'PEAR_Error')) return false;
579 // Clean up tt_custom_field_options.
580 $sql = "delete from tt_custom_field_options where field_id = $field_id";
581 $affected = $mdb2->exec($sql);
582 if (is_a($affected, 'PEAR_Error')) return false;
584 // Delete custom field.
585 $sql = "delete from tt_custom_fields where id = $field_id";
586 $affected = $mdb2->exec($sql);
587 if (is_a($affected, 'PEAR_Error')) return false;