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