WEB-INF/lib/ttUser.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 class ttUser {
  30   var $login = null;            // User login.
  31   var $name = null;             // User name.
  32   var $id = null;               // User id.
  33   var $team_id = null;          // Team id.
  34   var $role = null;             // User role (user, client, comanager, manager, admin).
  35   var $client_id = null;        // Client id for client user role.
  36   var $behalf_id = null;        // User id, on behalf of whom we are working.
  37   var $behalf_name = null;      // User name, on behalf of whom we are working.
  38   var $email = null;            // User email.
  39   var $lang = null;             // Language.
  40   var $decimal_mark = null;     // Decimal separator.
  41   var $date_format = null;      // Date format.
  42   var $time_format = null;      // Time format.
  43   var $week_start = 0;          // Week start day.
  44   var $show_holidays = 1;       // Whether to show holidays in calendar.
  45   var $tracking_mode = 0;       // Tracking mode.
  46   var $project_required = 0;    // Whether project selection is required on time entires.
  47   var $task_required = 0;       // Whether task selection is required on time entires.
  48   var $record_type = 0;         // Record type (duration vs start and finish, or both).
  49   var $uncompleted_indicators = 0; // Uncompleted time entry indicators (show nowhere or on users page).
  50   var $bcc_email = null;        // Bcc email.
  51   var $currency = null;         // Currency.
  52   var $plugins = null;          // Comma-separated list of enabled plugins.
  53   var $config = null;           // Comma-separated list of miscellaneous config options.
  54   var $team = null;             // Team name.
  55   var $custom_logo = 0;         // Whether to use a custom logo for team.
  56   var $lock_spec = null;        // Cron specification for record locking.
  57   var $workday_hours = 8;       // Number of work hours in a regular day.
  58   var $rights = 0;              // A mask of user rights.
  59
  60   // Constructor.
  61   function __construct($login, $id = null) {
  62     if (!$login && !$id) {
  63       // nothing to initialize
  64       return;
  65     }
  66
  67     $mdb2 = getConnection();
  68
  69     $sql = "SELECT u.id, u.login, u.name, u.team_id, u.role, u.client_id, u.email, t.name as team_name,
  70       t.currency, t.lang, t.decimal_mark, t.date_format, t.time_format, t.week_start,
  71       t.tracking_mode, t.project_required, t.task_required, t.record_type, t.uncompleted_indicators,
  72       t.bcc_email, t.plugins, t.config, t.lock_spec, t.workday_hours, t.custom_logo
  73       FROM tt_users u LEFT JOIN tt_teams t ON (u.team_id = t.id) WHERE ";
  74     if ($id)
  75       $sql .= "u.id = $id";
  76     else
  77       $sql .= "u.login = ".$mdb2->quote($login);
  78     $sql .= " AND u.status = 1";
  79
  80     $res = $mdb2->query($sql);
  81     if (is_a($res, 'PEAR_Error')) {
  82       return;
  83     }
  84
  85     $val = $res->fetchRow();
  86     if ($val['id'] > 0) {
  87       $this->login = $val['login'];
  88       $this->name = $val['name'];
  89       $this->id = $val['id'];
  90       $this->team_id = $val['team_id'];
  91       $this->role = $val['role'];
  92       $this->client_id = $val['client_id'];
  93       $this->email = $val['email'];
  94       $this->lang = $val['lang'];
  95       $this->decimal_mark = $val['decimal_mark'];
  96       $this->date_format = $val['date_format'];
  97       $this->time_format = $val['time_format'];
  98       $this->week_start = $val['week_start'];
  99       $this->tracking_mode = $val['tracking_mode'];
 100       $this->project_required = $val['project_required'];
 101       $this->task_required = $val['task_required'];
 102       $this->record_type = $val['record_type'];
 103       $this->uncompleted_indicators = $val['uncompleted_indicators'];
 104       $this->bcc_email = $val['bcc_email'];
 105       $this->team = $val['team_name'];
 106       $this->currency = $val['currency'];
 107       $this->plugins = $val['plugins'];
 108       $this->lock_spec = $val['lock_spec'];
 109       $this->workday_hours = $val['workday_hours'];
 110       $this->custom_logo = $val['custom_logo'];
 111
 112       // Set user config options.
 113       $this->config = $val['config'];
 114       $this->show_holidays = in_array('show_holidays', explode(',', $this->config));
 115
 116       // Set "on behalf" id and name.
 117       if (isset($_SESSION['behalf_id'])) {
 118           $this->behalf_id = $_SESSION['behalf_id'];
 119           $this->behalf_name = $_SESSION['behalf_name'];
 120       }
 121
 122       // Set user rights.
 123       if ($this->role == ROLE_USER) {
 124         $this->rights = right_data_entry|right_view_charts|right_view_reports;
 125       } elseif ($this->role == ROLE_CLIENT) {
 126         $this->rights = right_view_reports|right_view_invoices; // TODO: how about right_view_charts, too?
 127       } elseif ($this->role == ROLE_COMANAGER) {
 128         $this->rights = right_data_entry|right_view_charts|right_view_reports|right_view_invoices|right_manage_team;
 129       } elseif ($this->role == ROLE_MANAGER) {
 130         $this->rights = right_data_entry|right_view_charts|right_view_reports|right_view_invoices|right_manage_team|right_assign_roles|right_export_team;
 131       } elseif ($this->role == ROLE_SITE_ADMIN) {
 132         $this->rights = right_administer_site;
 133       }
 134     }
 135   }
 136
 137   // The getActiveUser returns user id on behalf of whom current user is operating.
 138   function getActiveUser() {
 139     return ($this->behalf_id ? $this->behalf_id : $this->id);
 140   }
 141
 142   // isAdmin - determines whether current user is admin (has right_administer_site).
 143   function isAdmin() {
 144     return (right_administer_site & $this->role);
 145   }
 146
 147   // isManager - determines whether current user is team manager.
 148   function isManager() {
 149     return (ROLE_MANAGER == $this->role);
 150   }
 151
 152   // isCoManager - determines whether current user is team comanager.
 153   function isCoManager() {
 154     return (ROLE_COMANAGER == $this->role);
 155   }
 156
 157   // isClient - determines whether current user is a client.
 158   function isClient() {
 159     return (ROLE_CLIENT == $this->role);
 160   }
 161
 162   // canManageTeam - determines whether current user is manager or co-manager.
 163   function canManageTeam() {
 164     return (right_manage_team & $this->role);
 165   }
 166
 167   // isPluginEnabled checks whether a plugin is enabled for user.
 168   function isPluginEnabled($plugin)
 169   {
 170     return in_array($plugin, explode(',', $this->plugins));
 171   }
 172
 173   // getAssignedProjects - returns an array of assigned projects.
 174   function getAssignedProjects()
 175   {
 176     $result = array();
 177     $mdb2 = getConnection();
 178
 179     // Do a query with inner join to get assigned projects.
 180     $sql = "select p.id, p.name, p.description, p.tasks, upb.rate from tt_projects p
 181       inner join tt_user_project_binds upb on (upb.user_id = ".$this->getActiveUser()." and upb.project_id = p.id and upb.status = 1)
 182       where p.team_id = $this->team_id and p.status = 1 order by p.name";
 183     $res = $mdb2->query($sql);
 184     if (!is_a($res, 'PEAR_Error')) {
 185       while ($val = $res->fetchRow()) {
 186         $result[] = $val;
 187       }
 188     }
 189     return $result;
 190   }
 191
 192   // isDateLocked checks whether a specifc date is locked for modifications.
 193   function isDateLocked($date)
 194   {
 195     if ($this->isPluginEnabled('lk') && $this->lock_spec) {
 196       // Override for managers.
 197       if ($this->canManageTeam()) return false;
 198
 199       require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
 200       require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
 201
 202       // Calculate the last occurrence of a lock.
 203       $last = tdCron::getLastOccurrence($this->lock_spec, time());
 204       $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
 205       if ($date->before($lockdate)) {
 206         return true;
 207       }
 208     }
 209     return false;
 210   }
 211 }