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