Renamed Punch in mode to Punch mode.
[timetracker.git] / WEB-INF / lib / ttUserHelper.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
31 // Class ttUserHelper contains helper functions for operations with users.
32 class ttUserHelper {
33
34   // The getUserDetails function returns user details.
35   static function getUserDetails($user_id) {
36     $result = array();
37     $mdb2 = getConnection();
38
39     $sql =  "select * from tt_users where id = $user_id";
40     $res = $mdb2->query($sql);
41
42     if (!is_a($res, 'PEAR_Error')) {
43       $val = $res->fetchRow();
44       return $val;
45     }
46     return false;
47   }
48
49   // The getUserName function returns user name.
50   static function getUserName($user_id) {
51     $mdb2 = getConnection();
52
53     $sql = "select name from tt_users where id = $user_id and (status = 1 or status = 0)";
54     $res = $mdb2->query($sql);
55
56     if (!is_a($res, 'PEAR_Error')) {
57       $val = $res->fetchRow();
58       return $val['name'];
59     }
60     return false;
61   }
62
63   // The getUserByLogin function obtains data for a user, who is identified by login.
64   static function getUserByLogin($login) {
65     $mdb2 = getConnection();
66
67     $sql = "select id, name from tt_users where login = ".$mdb2->quote($login)." and (status = 1 or status = 0)";
68     $res = $mdb2->query($sql);
69     if (!is_a($res, 'PEAR_Error')) {
70       if ($val = $res->fetchRow()) {
71         return $val;
72       }
73     }
74     return false;
75   }
76
77   // The getUserByEmail function is a helper function that tries to obtain user details identified by email.
78   // This function works only when one such active user exists.
79   static function getUserByEmail($email) {
80     $mdb2 = getConnection();
81
82     $sql = "select login, count(*) as cnt from tt_users where email = ".$mdb2->quote($email)." and status = 1 group by email";
83     $res = $mdb2->query($sql);
84
85     if (is_a($res, 'PEAR_Error'))
86       return false;
87
88     $val = $res->fetchRow();
89     if (1 <> $val['cnt']) {
90       // We either have no users or multiple users with a given email.
91       return false;
92     }
93     return $val['login'];
94   }
95
96   // The getUserIdByTmpRef obtains user id from a temporary reference (used for password resets).
97   static function getUserIdByTmpRef($ref) {
98     $mdb2 = getConnection();
99
100     $sql = "select user_id from tt_tmp_refs where ref = ".$mdb2->quote($ref);
101     $res = $mdb2->query($sql);
102
103     if (!is_a($res, 'PEAR_Error')) {
104       $val = $res->fetchRow();
105       return $val['user_id'];
106     }
107     return false;
108   }
109
110   // insert - inserts a user into database.
111   static function insert($fields, $hash = true) {
112     $mdb2 = getConnection();
113
114     $password = $mdb2->quote($fields['password']);
115     if($hash)
116       $password = 'md5('.$password.')';
117     $email = isset($fields['email']) ? $fields['email'] : '';
118     $team_id = (int) $fields['team_id'];
119     $role = (int) $fields['role'];
120     $rate = str_replace(',', '.', isset($fields['rate']) ? $fields['rate'] : 0);
121     if($rate == '')
122       $rate = 0;
123     if (array_key_exists('status', $fields)) { // Key exists and may be NULL during migration of deleted acounts.
124       $status_f = ', status';
125       $status_v = ', '.$mdb2->quote($fields['status']);
126     }
127
128     $sql = "insert into tt_users (name, login, password, team_id, role, client_id, rate, email $status_f) values (".
129       $mdb2->quote($fields['name']).", ".$mdb2->quote($fields['login']).
130       ", $password, $team_id, $role, ".$mdb2->quote($fields['client_id']).", $rate, ".$mdb2->quote($email)." $status_v)";
131     $affected = $mdb2->exec($sql);
132
133     // Now deal with project assignment.
134     if (!is_a($affected, 'PEAR_Error')) {
135       $sql = "SELECT LAST_INSERT_ID() AS last_id";
136       $res = $mdb2->query($sql);
137       $val = $res->fetchRow();
138       $last_id = $val['last_id'];
139
140       $projects = isset($fields['projects']) ? $fields['projects'] : array();
141       if (count($projects) > 0) {
142         // We have at least one project assigned. Insert corresponding entries in tt_user_project_binds table.
143         foreach($projects as $p) {
144           if(!isset($p['rate']))
145             $p['rate'] = 0;
146           else
147             $p['rate'] = str_replace(',', '.', $p['rate']);
148
149           $sql = "insert into tt_user_project_binds (project_id, user_id, rate, status) values(".$p['id'].",".$last_id.",".$p['rate'].", 1)";
150           $affected = $mdb2->exec($sql);
151         }
152       }
153       return $last_id;
154     }
155     return false;
156   }
157
158   // update - updates a user in database.
159   static function update($user_id, $fields) {
160     global $user;
161     $mdb2 = getConnection();
162
163     // Check parameters.
164     if (!$user_id || !isset($fields['login']))
165       return false;
166
167     // Prepare query parts.
168     if (isset($fields['password']))
169       $pass_part = ', password = md5('.$mdb2->quote($fields['password']).')';
170     if (right_assign_roles & $user->rights) {
171       if (isset($fields['role'])) {
172         $role = (int) $fields['role'];
173         $role_part = ", role = $role";
174       }
175       if (array_key_exists('client_id', $fields)) // Could be NULL.
176         $client_part = ", client_id = ".$mdb2->quote($fields['client_id']);
177     }
178
179     if (array_key_exists('rate', $fields)) {
180       $rate = str_replace(',', '.', isset($fields['rate']) ? $fields['rate'] : 0);
181       if($rate == '') $rate = 0;
182       $rate_part = ", rate = ".$mdb2->quote($rate); 
183     }
184
185     if (isset($fields['status'])) {
186       $status = (int) $fields['status']; 
187       $status_part = ", status = $status";
188     }
189
190     $sql = "update tt_users set login = ".$mdb2->quote($fields['login']).
191       "$pass_part, name = ".$mdb2->quote($fields['name']).
192       "$role_part $client_part $rate_part $status_part, email = ".$mdb2->quote($fields['email']).
193       " where id = $user_id";
194     $affected = $mdb2->exec($sql);
195     if (is_a($affected, 'PEAR_Error')) return false;
196
197     if (array_key_exists('projects', $fields)) {
198       // Deal with project assignments.
199       // Note: we cannot simply delete old project binds and insert new ones because it screws up reporting
200       // (when looking for cost while entries for de-assigned projects exist).
201       // Therefore, we must iterate through all projects and only delete the binds when no time entries are present,
202       // otherwise de-activate the bind (set its status to inactive). This will keep the bind
203       // and its rate in database for reporting.
204
205       $all_projects = ttTeamHelper::getAllProjects($user->team_id);
206       $assigned_projects = isset($fields['projects']) ? $fields['projects'] : array();
207
208       foreach($all_projects as $p) {
209         // Determine if a project is assigned.
210         $assigned = false;
211         $project_id = $p['id'];
212         $rate = '0.00';
213         if (count($assigned_projects) > 0) {
214           foreach ($assigned_projects as $ap) {
215             if ($project_id == $ap['id']) {
216               $assigned = true;
217               if ($ap['rate']) {
218                 $rate = $ap['rate'];
219                 $rate = str_replace(",",".",$rate);
220               }
221               break;
222             }
223           }
224         }
225
226         if (!$assigned) {
227           ttUserHelper::deleteBind($user_id, $project_id);
228         } else {
229           // Here we need to either update or insert new tt_user_project_binds record.
230           // Determine if a record exists.
231           $sql = "select id from tt_user_project_binds where user_id = $user_id and project_id = $project_id";
232           $res = $mdb2->query($sql);
233           if (is_a($res, 'PEAR_Error')) die ($res->getMessage());
234           if ($val = $res->fetchRow()) {
235             // Record exists. Update it.
236             $sql = "update tt_user_project_binds set status = 1, rate = $rate where id = ".$val['id'];
237             $affected = $mdb2->exec($sql);
238             if (is_a($affected, 'PEAR_Error')) die ($affected->getMessage());
239           } else {
240             // Record does not exist. Insert it.
241             ttUserHelper::insertBind($user_id, $project_id, $rate, 1);
242           }
243         }
244       }
245     }
246     return true;
247   }
248
249   // markDeleted - marks user and its associated things as deleted.
250   static function markDeleted($user_id) {
251     $mdb2 = getConnection();
252     global $user;
253
254     // Preliminary checks. Only managers, co-managers, and admin can do this.
255     if (!$user->canManageTeam() && !$user->isAdmin())
256       return false;
257
258     // Tho logic is different depending on who is doing the operation.
259     // Co-manager and admin - mark user deleted.
260     // Manager - mark user deleted. If manager is the only account in team, mark team items deleted.
261
262     // admin part.
263     if ($user->isAdmin()) {
264       // Mark user binds as deleted.
265       $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id";
266       $affected = $mdb2->exec($sql);
267       if (is_a($affected, 'PEAR_Error'))
268         return false;
269
270       // Mark favorite reports as deleted.
271       $sql = "update tt_fav_reports set status = NULL where user_id = $user_id";
272       $affected = $mdb2->exec($sql);
273       if (is_a($affected, 'PEAR_Error'))
274         return false;
275
276       // Mark user as deleted.
277       $sql = "update tt_users set status = NULL where id = $user_id";
278       $affected = $mdb2->exec($sql);
279       if (is_a($affected, 'PEAR_Error'))
280         return false;
281
282     } elseif ($user->isCoManager()) {
283       // Mark user binds as deleted.
284       $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id";
285       $affected = $mdb2->exec($sql);
286       if (is_a($affected, 'PEAR_Error'))
287         return false;
288
289       // Mark favorite reports as deleted.
290       $sql = "update tt_fav_reports set status = NULL where user_id = $user_id";
291       $affected = $mdb2->exec($sql);
292       if (is_a($affected, 'PEAR_Error'))
293         return false;
294
295       // Mark user as deleted.
296       $sql = "update tt_users set status = NULL where id = $user_id and team_id = ".$user->team_id;
297       $affected = $mdb2->exec($sql);
298       if (is_a($affected, 'PEAR_Error'))
299         return false;
300
301     } elseif ($user->isManager()) {
302       $user_count = ttTeamHelper::getUserCount($user->team_id);
303
304       // Marking deleted a manager with active users is not allowed.
305        if (($user_id == $user->id) && ($user_count > 1))
306         return false;
307
308       if (1 == $user_count) {
309         // Mark tasks deleted.
310         if (!ttTeamHelper::markTasksDeleted($user->team_id))
311           return false;
312
313         // Mark projects deleted.
314         $sql = "update tt_projects set status = NULL where team_id = $user->team_id";
315         $affected = $mdb2->exec($sql);
316         if (is_a($affected, 'PEAR_Error'))
317           return false;
318
319         // Mark clients deleted.
320         $sql = "update tt_clients set status = NULL where team_id = $user->team_id";
321         $affected = $mdb2->exec($sql);
322         if (is_a($affected, 'PEAR_Error'))
323           return false;
324
325         // Mark custom fields deleted.
326         $sql = "update tt_custom_fields set status = NULL where team_id = $user->team_id";
327         $affected = $mdb2->exec($sql);
328         if (is_a($affected, 'PEAR_Error'))
329           return false;
330  
331         // Mark team deleted.
332         $sql = "update tt_teams set status = NULL where id = $user->team_id";
333         $affected = $mdb2->exec($sql);
334         if (is_a($affected, 'PEAR_Error'))
335           return false;
336       }
337
338       // Mark user binds as deleted.
339       $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id";
340       $affected = $mdb2->exec($sql);
341       if (is_a($affected, 'PEAR_Error'))
342         return false;
343
344       // Mark favorite reports as deleted.
345       $sql = "update tt_fav_reports set status = NULL where user_id = $user_id";
346       $affected = $mdb2->exec($sql);
347       if (is_a($affected, 'PEAR_Error'))
348         return false;
349
350       // Mark user as deleted.
351       $sql = "update tt_users set status = NULL where id = $user_id and team_id = ".$user->team_id;
352       $affected = $mdb2->exec($sql);
353       if (is_a($affected, 'PEAR_Error'))
354         return false;
355     }
356
357     return true;
358   }
359
360   // The delete function permanently deletes a user and all associated data.
361   static function delete($user_id) {
362     $mdb2 = getConnection();
363
364     // Delete custom field log entries for user, if we have them.
365     $sql = "delete from tt_custom_field_log where log_id in
366       (select id from tt_log where user_id = $user_id)";
367     $affected = $mdb2->exec($sql);
368     if (is_a($affected, 'PEAR_Error'))
369       return false;
370
371     // Delete log entries for user.
372     $sql = "delete from tt_log where user_id = $user_id";
373     $affected = $mdb2->exec($sql);
374     if (is_a($affected, 'PEAR_Error'))
375       return false;
376
377     // Delete expense items for user.
378     $sql = "delete from tt_expense_items where user_id = $user_id";
379     $affected = $mdb2->exec($sql);
380     if (is_a($affected, 'PEAR_Error'))
381       return false;
382
383     // Delete user binds.
384     $sql = "delete from tt_user_project_binds where user_id = $user_id";
385     $affected = $mdb2->exec($sql);
386     if (is_a($affected, 'PEAR_Error'))
387       return false;
388
389     // Clean up tt_config table.
390     $sql = "delete from tt_config where user_id = $user_id";
391     $affected = $mdb2->exec($sql);
392     if (is_a($affected, 'PEAR_Error'))
393       return false; 
394
395     // Clean up tt_fav_reports table.
396     $sql = "delete from tt_fav_reports where user_id = $user_id";
397     $affected = $mdb2->exec($sql);
398     if (is_a($affected, 'PEAR_Error'))
399       return false;
400
401     // Delete user.
402     $sql = "delete from tt_users where id = $user_id";
403     $affected = $mdb2->exec($sql);    
404     if (is_a($affected, 'PEAR_Error'))
405       return false;
406
407     return true;
408   }
409
410   // The saveTmpRef saves a temporary reference for user that is used to reset user password.
411   static function saveTmpRef($ref, $user_id) {
412     $mdb2 = getConnection();
413
414     $sql = "delete from tt_tmp_refs where timestamp + 86400 < now()";
415     $affected = $mdb2->exec($sql);
416
417     $sql = "insert into tt_tmp_refs (ref, user_id) values(".$mdb2->quote($ref).", $user_id)";
418     $affected = $mdb2->exec($sql);
419   }
420
421   // The setPassword function updates password for user.
422   static function setPassword($user_id, $password) {
423     $mdb2 = getConnection();
424
425     $sql = "update tt_users set password = md5(".$mdb2->quote($password).") where id = $user_id";
426     $affected = $mdb2->exec($sql);
427
428     return (!is_a($affected, 'PEAR_Error'));
429   }
430
431   // insertBind - inserts a user to project bind into tt_user_project_binds table.
432   static function insertBind($user_id, $project_id, $rate, $status) {
433     $mdb2 = getConnection();
434
435     $sql = "insert into tt_user_project_binds (user_id, project_id, rate, status)
436       values($user_id, $project_id, ".$mdb2->quote($rate).", $status)";
437     $affected = $mdb2->exec($sql);
438     return (!is_a($affected, 'PEAR_Error'));
439   }
440
441   // deleteBind - deactivates user to project bind when time entries exist,
442   // otherwise deletes it entirely.
443   static function deleteBind($user_id, $project_id) {
444     $mdb2 = getConnection();
445
446     $sql = "select count(*) as cnt from tt_log where 
447       user_id = $user_id and project_id = $project_id and status = 1";
448     $res = $mdb2->query($sql);
449     if (is_a($res, 'PEAR_Error')) die ($res->getMessage());
450
451     $count = 0;
452     $val = $res->fetchRow();
453     $count = $val['cnt'];
454
455     if ($count > 0) {
456       // Deactivate user bind.
457       $sql = "select id from tt_user_project_binds where user_id = $user_id and project_id = $project_id";
458        $res = $mdb2->query($sql);
459        if (is_a($res, 'PEAR_Error')) die ($res->getMessage());
460        if ($val = $res->fetchRow()) {
461          $sql = "update tt_user_project_binds set status = 0 where id = ".$val['id'];
462          $affected = $mdb2->exec($sql);
463          if (is_a($affected, 'PEAR_Error')) die ($res->getMessage());
464        }
465     } else {
466       // Delete user bind.
467       $sql = "delete from tt_user_project_binds where user_id = $user_id and project_id = $project_id";
468       $affected = $mdb2->exec($sql);
469       if (is_a($affected, 'PEAR_Error')) die ($res->getMessage());
470     }
471     return true;
472   }
473 }