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 getUserName function returns user name.
  35   static function getUserName($user_id) {
  36     $mdb2 = getConnection();
  37
  38     $sql = "select name from tt_users where id = $user_id and (status = 1 or status = 0)";
  39     $res = $mdb2->query($sql);
  40
  41     if (!is_a($res, 'PEAR_Error')) {
  42       $val = $res->fetchRow();
  43       return $val['name'];
  44     }
  45     return false;
  46   }
  47
  48   // The getUserByLogin function obtains data for a user, who is identified by login.
  49   static function getUserByLogin($login) {
  50     $mdb2 = getConnection();
  51
  52     $sql = "select id, name from tt_users where login = ".$mdb2->quote($login)." and (status = 1 or status = 0)";
  53     $res = $mdb2->query($sql);
  54     if (!is_a($res, 'PEAR_Error')) {
  55       if ($val = $res->fetchRow()) {
  56         return $val;
  57       }
  58     }
  59     return false;
  60   }
  61
  62   // The getUserByEmail function is a helper function that tries to obtain user details identified by email.
  63   // This function works only when one such active user exists.
  64   static function getUserByEmail($email) {
  65     $mdb2 = getConnection();
  66
  67     $sql = "select login, count(*) as cnt from tt_users where email = ".$mdb2->quote($email)." and status = 1 group by email";
  68     $res = $mdb2->query($sql);
  69
  70     if (is_a($res, 'PEAR_Error'))
  71       return false;
  72
  73     $val = $res->fetchRow();
  74     if (1 <> $val['cnt']) {
  75       // We either have no users or multiple users with a given email.
  76       return false;
  77     }
  78     return $val['login'];
  79   }
  80
  81   // The getUserIdByTmpRef obtains user id from a temporary reference (used for password resets).
  82   static function getUserIdByTmpRef($ref) {
  83     $mdb2 = getConnection();
  84
  85     $sql = "select user_id from tt_tmp_refs where ref = ".$mdb2->quote($ref);
  86     $res = $mdb2->query($sql);
  87
  88     if (!is_a($res, 'PEAR_Error')) {
  89       $val = $res->fetchRow();
  90       return $val['user_id'];
  91     }
  92     return false;
  93   }
  94
  95   // insert - inserts a user into database.
  96   static function insert($fields, $hash = true) {
  97     global $user;
  98     $mdb2 = getConnection();
  99
 100     $password = $mdb2->quote($fields['password']);
 101     if($hash)
 102       $password = 'md5('.$password.')';
 103     $email = isset($fields['email']) ? $fields['email'] : '';
 104     $group_id = (int) $fields['group_id'];
 105     $org_id = (int) $fields['org_id'];
 106     $rate = str_replace(',', '.', isset($fields['rate']) ? $fields['rate'] : 0);
 107     if($rate == '')
 108       $rate = 0;
 109     if (array_key_exists('status', $fields)) { // Key exists and may be NULL during migration of deleted acounts.
 110       $status_f = ', status';
 111       $status_v = ', '.$mdb2->quote($fields['status']);
 112     }
 113     $created_ip_v = ', '.$mdb2->quote($_SERVER['REMOTE_ADDR']);
 114     $created_by_v = ', '.$user->id;
 115
 116     $sql = "insert into tt_users (name, login, password, group_id, org_id, role_id, client_id, rate, email, created, created_ip, created_by $status_f) values (".
 117       $mdb2->quote($fields['name']).", ".$mdb2->quote($fields['login']).
 118       ", $password, $group_id, $org_id, ".$mdb2->quote($fields['role_id']).", ".$mdb2->quote($fields['client_id']).", $rate, ".$mdb2->quote($email).", now() $created_ip_v $created_by_v $status_v)";
 119     $affected = $mdb2->exec($sql);
 120
 121     // Now deal with project assignment.
 122     if (!is_a($affected, 'PEAR_Error')) {
 123       $last_id = $mdb2->lastInsertID('tt_users', 'id');
 124       $projects = isset($fields['projects']) ? $fields['projects'] : array();
 125       if (count($projects) > 0) {
 126         // We have at least one project assigned. Insert corresponding entries in tt_user_project_binds table.
 127         foreach($projects as $p) {
 128           if(!isset($p['rate']))
 129             $p['rate'] = 0;
 130           else
 131             $p['rate'] = str_replace(',', '.', $p['rate']);
 132
 133           $sql = "insert into tt_user_project_binds (project_id, user_id, group_id, org_id, rate, status)".
 134             " values(".$p['id'].", $last_id, $group_id, $org_id, ".$p['rate'].", 1)";
 135           $affected = $mdb2->exec($sql);
 136         }
 137       }
 138       return $last_id;
 139     }
 140     return false;
 141   }
 142
 143   // update - updates a user in database.
 144   static function update($user_id, $fields) {
 145     global $user;
 146     $mdb2 = getConnection();
 147
 148     // Check parameters.
 149     if (!$user_id)
 150       return false;
 151
 152     $group_id = $user->getGroup();
 153     $org_id = $user->org_id;
 154
 155     // Prepare query parts.
 156     if (isset($fields['login'])) {
 157       $login_part = ", login = ".$mdb2->quote($fields['login']);
 158     }
 159
 160     if (isset($fields['password']))
 161       $pass_part = ', password = md5('.$mdb2->quote($fields['password']).')';
 162
 163     if (isset($fields['name']))
 164       $name_part = ', name = '.$mdb2->quote($fields['name']);
 165
 166     if ($user->can('manage_users')) {
 167       if (isset($fields['role_id'])) {
 168         $role_id = (int) $fields['role_id'];
 169         $role_part = ", role_id = $role_id";
 170       }
 171       if (array_key_exists('client_id', $fields)) // Could be NULL.
 172         $client_part = ", client_id = ".$mdb2->quote($fields['client_id']);
 173     }
 174
 175     if (array_key_exists('rate', $fields)) {
 176       $rate = str_replace(',', '.', isset($fields['rate']) ? $fields['rate'] : 0);
 177       if($rate == '') $rate = 0;
 178       $rate_part = ", rate = ".$mdb2->quote($rate);
 179     }
 180
 181     if (isset($fields['email']))
 182       $email_part = ', email = '.$mdb2->quote($fields['email']);
 183
 184     if (isset($fields['status'])) {
 185       $status = (int) $fields['status'];
 186       $status_part = ", status = $status";
 187     }
 188
 189     $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$user->id;
 190     $parts = ltrim($login_part.$pass_part.$name_part.$role_part.$client_part.$rate_part.$email_part.$modified_part.$status_part, ',');
 191
 192     $sql = "update tt_users set $parts".
 193       " where id = $user_id and group_id = $group_id and org_id = $org_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->getGroup());
 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(array(
 242               'user_id' => $user_id,
 243               'project_id' => $project_id,
 244               'rate' => $rate,
 245               'status' => ACTIVE));
 246            }
 247         }
 248       }
 249     }
 250     return true;
 251   }
 252
 253   // The delete function permanently deletes a user and all associated data.
 254   static function delete($user_id) {
 255     $mdb2 = getConnection();
 256
 257     // Delete custom field log entries for user, if we have them.
 258     $sql = "delete from tt_custom_field_log where log_id in
 259       (select id from tt_log where user_id = $user_id)";
 260     $affected = $mdb2->exec($sql);
 261     if (is_a($affected, 'PEAR_Error'))
 262       return false;
 263
 264     // Delete log entries for user.
 265     $sql = "delete from tt_log where user_id = $user_id";
 266     $affected = $mdb2->exec($sql);
 267     if (is_a($affected, 'PEAR_Error'))
 268       return false;
 269
 270     // Delete expense items for user.
 271     $sql = "delete from tt_expense_items where user_id = $user_id";
 272     $affected = $mdb2->exec($sql);
 273     if (is_a($affected, 'PEAR_Error'))
 274       return false;
 275
 276     // Delete user binds.
 277     $sql = "delete from tt_user_project_binds where user_id = $user_id";
 278     $affected = $mdb2->exec($sql);
 279     if (is_a($affected, 'PEAR_Error'))
 280       return false;
 281
 282     // Clean up tt_config table.
 283     $sql = "delete from tt_config where user_id = $user_id";
 284     $affected = $mdb2->exec($sql);
 285     if (is_a($affected, 'PEAR_Error'))
 286       return false;
 287
 288     // Clean up tt_fav_reports table.
 289     $sql = "delete from tt_fav_reports where user_id = $user_id";
 290     $affected = $mdb2->exec($sql);
 291     if (is_a($affected, 'PEAR_Error'))
 292       return false;
 293
 294     // Delete user.
 295     $sql = "delete from tt_users where id = $user_id";
 296     $affected = $mdb2->exec($sql);
 297     if (is_a($affected, 'PEAR_Error'))
 298       return false;
 299
 300     return true;
 301   }
 302
 303   // The saveTmpRef saves a temporary reference for user that is used to reset user password.
 304   static function saveTmpRef($ref, $user_id) {
 305     $mdb2 = getConnection();
 306
 307     $sql = "delete from tt_tmp_refs where created < now() - interval 1 hour";
 308     $affected = $mdb2->exec($sql);
 309
 310     $sql = "insert into tt_tmp_refs (created, ref, user_id) values(now(), ".$mdb2->quote($ref).", $user_id)";
 311     $affected = $mdb2->exec($sql);
 312   }
 313
 314   // The setPassword function updates password for user.
 315   static function setPassword($user_id, $password) {
 316     $mdb2 = getConnection();
 317
 318     $sql = "update tt_users set password = md5(".$mdb2->quote($password).") where id = $user_id";
 319     $affected = $mdb2->exec($sql);
 320
 321     return (!is_a($affected, 'PEAR_Error'));
 322   }
 323
 324   // insertBind - inserts a user to project bind into tt_user_project_binds table.
 325   static function insertBind($fields) {
 326     global $user;
 327     $mdb2 = getConnection();
 328
 329     $group_id = $user->getGroup();
 330     $org_id = $user->org_id;
 331     $user_id = (int) $fields['user_id'];
 332     $project_id = (int) $fields['project_id'];
 333     $rate = $mdb2->quote($fields['rate']);
 334     $status = $mdb2->quote($fields['status']);
 335
 336     $sql = "insert into tt_user_project_binds (user_id, project_id, group_id, org_id, rate, status)".
 337       " values($user_id, $project_id, $group_id, $org_id, $rate, $status)";
 338     $affected = $mdb2->exec($sql);
 339     return (!is_a($affected, 'PEAR_Error'));
 340   }
 341
 342   // deleteBind - deactivates user to project bind when time entries exist,
 343   // otherwise deletes it entirely.
 344   static function deleteBind($user_id, $project_id) {
 345     $mdb2 = getConnection();
 346
 347     $sql = "select count(*) as cnt from tt_log where
 348       user_id = $user_id and project_id = $project_id and status = 1";
 349     $res = $mdb2->query($sql);
 350     if (is_a($res, 'PEAR_Error')) die ($res->getMessage());
 351
 352     $count = 0;
 353     $val = $res->fetchRow();
 354     $count = $val['cnt'];
 355
 356     if ($count > 0) {
 357       // Deactivate user bind.
 358       $sql = "select id from tt_user_project_binds where user_id = $user_id and project_id = $project_id";
 359        $res = $mdb2->query($sql);
 360        if (is_a($res, 'PEAR_Error')) die ($res->getMessage());
 361        if ($val = $res->fetchRow()) {
 362          $sql = "update tt_user_project_binds set status = 0 where id = ".$val['id'];
 363          $affected = $mdb2->exec($sql);
 364          if (is_a($affected, 'PEAR_Error')) die ($res->getMessage());
 365        }
 366     } else {
 367       // Delete user bind.
 368       $sql = "delete from tt_user_project_binds where user_id = $user_id and project_id = $project_id";
 369       $affected = $mdb2->exec($sql);
 370       if (is_a($affected, 'PEAR_Error')) die ($res->getMessage());
 371     }
 372     return true;
 373   }
 374
 375   // updateLastAccess - updates last access info for user in db.
 376   static function updateLastAccess() {
 377     global $user;
 378     $mdb2 = getConnection();
 379     $accessed_ip = $mdb2->quote($_SERVER['REMOTE_ADDR']);
 380     $sql = "update tt_users set accessed = now(), accessed_ip = $accessed_ip where id = $user->id";
 381     $mdb2->exec($sql);
 382   }
 383 }