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