Refactoring in ttProjectHelper class.
[timetracker.git] / WEB-INF / lib / ttProjectHelper.class.php
1 <?php
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.
10 // |
11 // | There are only two ways to violate the license:
12 // |
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).
16 // |
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).
20 // |
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
23 // |
24 // +----------------------------------------------------------------------+
25 // | Contributors:
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
28
29 import('ttTeamHelper');
30 import('ttUserHelper');
31 import('ttGroupHelper');
32
33 // Class ttProjectHelper is used to help with project related tasks.
34 class ttProjectHelper {
35         
36   // getAssignedProjects - returns an array of assigned projects.
37   static function getAssignedProjects($user_id) {
38     global $user;
39     $mdb2 = getConnection();
40
41     $group_id = $user->getGroup();
42     $org_id = $user->org_id;
43
44     $result = array();
45     // Do a query with inner join to get assigned projects.
46     $sql = "select p.id, p.name, p.tasks, upb.rate from tt_projects p".
47       " inner join tt_user_project_binds upb on (upb.user_id = $user_id and upb.project_id = p.id and upb.status = 1)".
48       " where p.group_id = $group_id and p.org_id = $org_id and p.status = 1 order by p.name";
49     $res = $mdb2->query($sql);
50     if (!is_a($res, 'PEAR_Error')) {
51       while ($val = $res->fetchRow()) {
52         $result[] = $val;
53       }
54     }
55     return $result;
56   }
57
58   // getRates - returns an array of project rates for user, including deassigned and deactivated projects.
59   static function getRates($user_id) {
60     global $user;
61     $mdb2 = getConnection();
62
63     $group_id = $user->getGroup();
64     $org_id = $user->org_id;
65
66     $result = array();
67     $sql = "select p.id, upb.rate from tt_projects p".
68       " inner join tt_user_project_binds upb on (upb.user_id = $user_id and upb.project_id = p.id)".
69       " where p.group_id = $group_id and p.org_id = $org_id";
70     $res = $mdb2->query($sql);
71     if (!is_a($res, 'PEAR_Error')) {
72       while ($val = $res->fetchRow()) {
73         $val['rate'] = str_replace('.', $user->getDecimalMark(), $val['rate']);
74         $result[] = $val;
75       }
76     }
77     return $result;
78   }
79   
80   // getProjects - returns an array of active and inactive projects in group.
81   static function getProjects() {
82     global $user;
83     $mdb2 = getConnection();
84
85     $group_id = $user->getGroup();
86     $org_id = $user->org_id;
87
88     $result = array();
89     $sql = "select id, name, tasks from tt_projects".
90       " where group_id = $group_id and org_id = $org_id and (status = 0 or status = 1) order by name";
91     $res = $mdb2->query($sql);
92     if (!is_a($res, 'PEAR_Error')) {
93       while ($val = $res->fetchRow()) {
94         $result[] = $val;
95       }
96     }
97     return $result;
98   }
99
100   // getProjectsForClient - returns an array of active and inactive projects in a group for a client.
101   static function getProjectsForClient() {
102     global $user;
103     $mdb2 = getConnection();
104
105     $group_id = $user->getGroup();
106     $org_id = $user->org_id;
107
108     $result = array();
109     $sql = "select p.id, p.name, p.tasks from tt_projects p".
110       " inner join tt_client_project_binds cpb on (cpb.client_id = $user->client_id and cpb.project_id = p.id)".
111       " where p.group_id = $group_id and p.org_id = $org_id and (p.status = 0 or p.status = 1)".
112       " order by p.name";
113
114     $res = $mdb2->query($sql);
115     if (!is_a($res, 'PEAR_Error')) {
116       while ($val = $res->fetchRow()) {
117         $result[] = $val;
118       }
119     }
120     return $result;
121   }
122
123   // get - gets details of the project identified by its id. 
124   static function get($id) {
125     global $user;
126     $mdb2 = getConnection();
127
128     $group_id = $user->getGroup();
129     $org_id = $user->org_id;
130
131     $sql = "select id, name, description, status, tasks from tt_projects".
132       " where id = $id and group_id = $group_id and org_id = $org_id and (status = 0 or status = 1)";
133     $res = $mdb2->query($sql);
134     if (!is_a($res, 'PEAR_Error')) {
135       $val = $res->fetchRow();
136       if ($val && $val['id'])
137         return $val;
138     }
139     return false;
140   }
141
142   // The getProjectByName looks up a project by name.
143   static function getProjectByName($name) {
144     global $user;
145     $mdb2 = getConnection();
146
147     $group_id = $user->getGroup();
148     $org_id = $user->org_id;
149
150     $sql = "select id from tt_projects".
151       " where group_id = $group_id and org_id = $org_id and name = ".$mdb2->quote($name).
152       " and (status = 1 or status = 0)";
153     $res = $mdb2->query($sql);
154     if (!is_a($res, 'PEAR_Error')) {
155       $val = $res->fetchRow();
156       if ($val && $val['id'])
157         return $val;
158     }
159     return false;
160   }
161   
162   
163   // delete - deletes things associated with a project and marks the project as deleted. 
164   static function delete($id) {
165     global $user;
166     $mdb2 = getConnection();
167
168     $group_id = $user->getGroup();
169     $org_id = $user->org_id;
170
171     // Start with project itself. Reason: if the passed in project_id is bogus,
172     // we'll fail right here and don't damage any other data.
173
174     // Mark project as deleted and remove associated tasks.
175     $sql = "update tt_projects set status = NULL, tasks = NULL where id = $id and group_id = $group_id and org_id = $org_id";
176     $affected = $mdb2->exec($sql);
177     if (is_a($affected, 'PEAR_Error') || 0 == $affected)
178       return false; // An error ocurred, or 0 rows updated.
179
180     // Delete user binds to this project.
181     $sql = "delete from tt_user_project_binds where project_id = $id and group_id = $group_id and org_id = $org_id";
182     $affected = $mdb2->exec($sql);
183     if (is_a($affected, 'PEAR_Error'))
184       return false;
185
186     // Delete task binds to this project.
187     $sql = "delete from tt_project_task_binds where project_id = $id and group_id = $group_id and org_id = $org_id";
188     $affected = $mdb2->exec($sql);
189     if (is_a($affected, 'PEAR_Error'))
190       return false;
191
192     // Delete client binds to this project.
193     $sql = "delete from tt_client_project_binds where project_id = $id and group_id = $group_id and org_id = $org_id";
194     $affected = $mdb2->exec($sql);
195     if (is_a($affected, 'PEAR_Error'))
196       return false;
197
198     return true;
199   }
200   
201   // insert function inserts a new project into database.
202   static function insert($fields)
203   {
204     global $user;
205     $mdb2 = getConnection();
206
207     $group_id = $user->getGroup();
208     $org_id = $user->org_id;
209
210     $name = $fields['name'];
211     $description = $fields['description'];
212     $users = $fields['users'];
213     $tasks = $fields['tasks'];
214     $comma_separated = implode(',', $tasks); // This is a comma-separated list of associated task ids.
215     $status = $fields['status'];
216     
217     $sql = "insert into tt_projects (group_id, org_id, name, description, tasks, status)".
218       " values ($group_id, $org_id, ".$mdb2->quote($name).", ".$mdb2->quote($description).", ".$mdb2->quote($comma_separated).", ".$mdb2->quote($status).")";
219     $affected = $mdb2->exec($sql);
220     if (is_a($affected, 'PEAR_Error'))
221       return false;
222
223     $last_id = $mdb2->lastInsertID('tt_projects', 'id');
224
225     // Bind the project to users.
226     $active_users = ttGroupHelper::getActiveUsers(array('getAllFields'=>true));
227     foreach ($active_users as $u) {
228       if(in_array($u['id'], $users)) {
229         $sql = "insert into tt_user_project_binds (project_id, user_id, group_id, org_id, status, rate) values(
230           $last_id, ".$u['id'].", $group_id, $org_id, 1, ".$u['rate'].")";
231         $affected = $mdb2->exec($sql);
232         if (is_a($affected, 'PEAR_Error'))
233           return false;
234       }
235     }
236
237     // Bind the project to tasks in tt_project_task_binds table.
238     $all_tasks = ttTeamHelper::getAllTasks($group_id);
239     foreach ($all_tasks as $task) {
240       if(in_array($task['id'], $tasks)) {
241         $sql = "insert into tt_project_task_binds (project_id, task_id, group_id, org_id)".
242           " values($last_id, ".$task['id'].", $group_id, $org_id)";
243         $affected = $mdb2->exec($sql);
244         if (is_a($affected, 'PEAR_Error'))
245           return false;
246       }
247     }
248
249     return $last_id;
250   } 
251
252   // update function - updates the project in database.
253   static function update($fields) {
254     global $user;
255     $mdb2 = getConnection();
256
257     $group_id = $user->getGroup();
258     $org_id = $user->org_id;
259
260     $project_id = $fields['id']; // Project we are updating.
261     $name = $fields['name']; // Project name.
262     $description = $fields['description']; // Project description.
263     $users_to_bind = $fields['users']; // Users to bind with project.
264     $tasks_to_bind = $fields['tasks']; // Tasks to bind with project.
265     $status = $fields['status']; // Project status.
266     
267     // Update records in tt_user_project_binds table.
268     $sql = "select user_id, status from tt_user_project_binds where project_id = $project_id";
269     $all_users = array();
270     $users_to_update = array();
271     $res2 = $mdb2->query($sql);
272     while ($row = $res2->fetchRow()) {
273       if(!in_array($row['user_id'], $users_to_bind)) { 
274         // Delete tt_user_project_binds record (safely).
275         ttUserHelper::deleteBind($row['user_id'], $project_id);
276       } elseif (!$row['status']) {
277         // If we are here, status of the bind is not active. Memorize such users to update their bind status.
278         $users_to_update[] = $row['user_id'];  // Users we need to update in tt_user_project_binds.
279       }
280       $all_users[] = $row['user_id']; // All users from tt_user_project_binds for project.
281     }
282     // Insert records.
283     $users_to_add = array_diff($users_to_bind, $all_users); // Users missing from tt_user_project_binds, that we need to insert.
284     if(count($users_to_add) > 0) {
285       $sql = "select id, rate from tt_users where id in (".join(', ', $users_to_add).")";
286       $res = $mdb2->query($sql);
287       while ($row = $res->fetchRow()) {
288         $user_rate[$row['id']] = $row['rate'];
289       }
290       foreach ($users_to_add as $id) {
291         $sql = "insert into tt_user_project_binds (user_id, project_id, group_id, org_id, rate, status)".
292           " values($id, $project_id, $group_id, $org_id, ".$user_rate[$id].", 1)";
293         $affected = $mdb2->exec($sql);
294         if (is_a($affected, 'PEAR_Error'))
295           return false;
296       }
297     }
298     // Update status (to active) in existing tt_user_project_binds records.
299     if ($users_to_update) {
300       $sql = "update tt_user_project_binds set status = 1 where project_id = $project_id and user_id in (".join(', ', $users_to_update).")";
301       $affected = $mdb2->exec($sql);
302       if (is_a($affected, 'PEAR_Error'))
303         return false;
304     }
305     // End of updating tt_user_project_binds table.
306
307     // Update records in tt_project_task_binds table.
308     // Obtain existing task binds.
309     $existing_task_binds = array();
310     $sql = "select task_id from tt_project_task_binds where project_id = $project_id";
311     $res = $mdb2->query($sql);
312     while ($val = $res->fetchRow()) {
313       $existing_task_binds[] = $val['task_id'];
314     }
315     // Determine which task binds to delete and which ones to add.
316     $task_binds_to_delete = array_diff($existing_task_binds, $tasks_to_bind);
317     $task_binds_to_add = array_diff($tasks_to_bind, $existing_task_binds);
318     foreach ($task_binds_to_delete as $task_id) {
319       $sql = "delete from tt_project_task_binds where project_id = $project_id and task_id = $task_id";
320       $affected = $mdb2->exec($sql);
321       if (is_a($affected, 'PEAR_Error'))
322         return false;
323     }    
324     foreach ($task_binds_to_add as $task_id) {
325       $sql = "insert into tt_project_task_binds (project_id, task_id, group_id, org_id)".
326         " values($project_id, $task_id, $group_id, $org_id)";
327       $affected = $mdb2->exec($sql);
328       if (is_a($affected, 'PEAR_Error'))
329         return false;
330     }
331     // End of updating tt_project_task_binds table.
332     
333     // Update project name, description, tasks and status in tt_projects table.
334     $comma_separated = implode(",", $tasks_to_bind); // This is a comma-separated list of associated task ids.
335     $sql = "update tt_projects set name = ".$mdb2->quote($name).", description = ".$mdb2->quote($description).
336            ", tasks = ".$mdb2->quote($comma_separated).", status = $status where id = $project_id and group_id = ".$user->getGroup();
337     $affected = $mdb2->exec($sql);
338     return (!is_a($affected, 'PEAR_Error'));
339   }
340   
341   /*
342   // getAssignedUsers - returns an array of user ids assigned to a project.
343   static function getAssignedUsers($project_id)
344   {
345         global $user;
346         
347     $result = array();
348     $mdb2 = getConnection();
349     
350     // Do a query with inner join to get assigned users.
351     $sql = "select id, name from tt_users u
352       inner join tt_user_project_binds ub on (ub.user_id = u.id and ub.project_id = $project_id and ub.status = 1)";
353     $res = $mdb2->query($sql);
354     if (!is_a($res, 'PEAR_Error')) {
355       while ($val = $res->fetchRow()) {
356         $result[] = $val;
357       }
358     }
359     return $result;
360   }*/
361 }