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.
11 // | There are only two ways to violate the license:
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).
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).
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
24 // +----------------------------------------------------------------------+
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
29 import('ttUserHelper');
31 // Class ttTimesheetHelper is used to help with project related tasks.
32 class ttTimesheetHelper {
34 // The getTimesheetByName looks up a project by name.
35 static function getTimesheetByName($name) {
37 $mdb2 = getConnection();
39 $user_id = $user->getUser();
40 $group_id = $user->getGroup();
41 $org_id = $user->org_id;
43 $sql = "select id from tt_timesheets".
44 " where group_id = $group_id and org_id = $org_id and user_id = $user_id and name = ".$mdb2->quote($name).
45 " and status is not null";
46 $res = $mdb2->query($sql);
47 if (!is_a($res, 'PEAR_Error')) {
48 $val = $res->fetchRow();
49 if ($val && $val['id'])
55 // createTimesheet function creates a new timesheet.
56 static function createTimesheet($fields)
58 // Create a new timesheet entry.
60 $mdb2 = getConnection();
62 $user_id = $user->getUser();
63 $group_id = $user->getGroup();
64 $org_id = $user->org_id;
66 $client_id = $fields['client_id'];
67 $project_id = $fields['project_id'];
68 $name = $fields['name'];
69 $comment = $fields['comment'];
71 $start_date = new DateAndTime($user->date_format, $fields['start_date']);
72 $start = $start_date->toString(DB_DATEFORMAT);
74 $end_date = new DateAndTime($user->date_format, $fields['end_date']);
75 $end = $end_date->toString(DB_DATEFORMAT);
77 $sql = "insert into tt_timesheets (user_id, group_id, org_id, client_id, project_id, name, comment, start_date, end_date)".
78 " values ($user_id, $group_id, $org_id, ".$mdb2->quote($client_id).", ".$mdb2->quote($project_id).", ".$mdb2->quote($name).
79 ", ".$mdb2->quote($comment).", ".$mdb2->quote($start).", ".$mdb2->quote($end).")";
80 $affected = $mdb2->exec($sql);
81 if (is_a($affected, 'PEAR_Error'))
84 $last_id = $mdb2->lastInsertID('tt_timesheets', 'id');
86 // Associate tt_log items with timesheet.
87 if (isset($fields['client'])) $client_id = (int) $fields['client_id'];
88 if (isset($fields['project_id'])) $project_id = (int) $fields['project_id'];
90 if ($client_id) $client_part = " and client_id = $client_id";
91 if ($project_id) $project_part = " and project_id = $project_id";
93 $sql = "update tt_log set timesheet_id = $last_id".
94 " where status = 1 $client_part $project_part and timesheet_id is null".
95 " and date >= ".$mdb2->quote($start)." and date <= ".$mdb2->quote($end).
96 " and user_id = $user_id and group_id = $group_id and org_id = $org_id";
97 $affected = $mdb2->exec($sql);
98 if (is_a($affected, 'PEAR_Error'))
104 // The getActiveTimesheets obtains active timesheets for a user.
105 static function getActiveTimesheets()
108 $mdb2 = getConnection();
110 $user_id = $user->getUser();
111 $group_id = $user->getGroup();
112 $org_id = $user->org_id;
115 $sql = "select ts.id, ts.name, ts.client_id, c.name as client_name,".
116 " ts.submit_status, ts.approve_status from tt_timesheets ts".
117 " left join tt_clients c on (c.id = ts.client_id)".
118 " where ts.status = 1 and ts.group_id = $group_id and ts.org_id = $org_id and ts.user_id = $user_id".
120 $res = $mdb2->query($sql);
122 if (!is_a($res, 'PEAR_Error')) {
123 while ($val = $res->fetchRow()) {
130 // The getInactiveTimesheets obtains inactive timesheets for a user.
131 static function getInactiveTimesheets()
134 $mdb2 = getConnection();
136 $user_id = $user->getUser();
137 $group_id = $user->getGroup();
138 $org_id = $user->org_id;
141 $sql = "select ts.id, ts.name, ts.client_id, c.name as client_name,".
142 " ts.submit_status, ts.approve_status from tt_timesheets ts".
143 " left join tt_clients c on (c.id = ts.client_id)".
144 " where ts.status = 0 and ts.group_id = $group_id and ts.org_id = $org_id and ts.user_id = $user_id".
146 $res = $mdb2->query($sql);
148 if (!is_a($res, 'PEAR_Error')) {
149 while ($val = $res->fetchRow()) {
156 // getTimesheet - obtains timesheet data from the database.
157 static function getTimesheet($timesheet_id) {
159 $mdb2 = getConnection();
161 $user_id = $user->getUser();
162 $group_id = $user->getGroup();
163 $org_id = $user->org_id;
165 $sql = "select ts.*, u.name as user_name, c.name as client_name,".
166 " p.name as project_name from tt_timesheets ts".
167 " left join tt_users u on (ts.user_id = u.id)".
168 " left join tt_clients c on (ts.client_id = c.id)".
169 " left join tt_projects p on (ts.project_id = p.id)".
170 " where ts.id = $timesheet_id and ts.user_id = $user_id and ts.group_id = $group_id and ts.org_id = $org_id and ts.status is not null";
171 $res = $mdb2->query($sql);
172 if (!is_a($res, 'PEAR_Error')) {
173 if ($val = $res->fetchRow())
179 // delete - deletes timesheet from the database.
180 static function delete($timesheet_id) {
182 $mdb2 = getConnection();
184 $user_id = $user->getUser();
185 $group_id = $user->getGroup();
186 $org_id = $user->org_id;
188 // Handle tt_log records.
189 $sql = "update tt_log set timesheet_id = null".
190 " where timesheet_id = $timesheet_id and user_id = $user_id and group_id = $group_id and org_id = $org_id";
191 $affected = $mdb2->exec($sql);
192 if (is_a($affected, 'PEAR_Error')) return false;
195 $sql = "update tt_timesheets set status = null".
196 " where id = $timesheet_id and user_id = $user_id and group_id = $group_id and org_id = $org_id";
197 $affected = $mdb2->exec($sql);
198 return (!is_a($affected, 'PEAR_Error'));
201 // update function - updates the timesheet in database.
202 static function update($fields) {
204 $mdb2 = getConnection();
206 $user_id = $user->getUser();
207 $group_id = $user->getGroup();
208 $org_id = $user->org_id;
210 $timesheet_id = $fields['id']; // Timesheet we are updating.
211 $name = $fields['name']; // Timesheet name.
212 $comment = $fields['comment'];
213 $status = $fields['status']; // Timesheet status.
215 $sql = "update tt_timesheets set name = ".$mdb2->quote($name).", comment = ".$mdb2->quote($comment).
216 ", status = ".$mdb2->quote($status).
217 " where id = $timesheet_id and user_id = $user_id and group_id = $group_id and org_id = $org_id";
218 $affected = $mdb2->exec($sql);
219 return (!is_a($affected, 'PEAR_Error'));
222 // getReportOptions prepares $options array to be used with ttReportHelper
223 // to obtain items for timesheet view.
224 static function getReportOptions($timesheet) {
226 $group_by_client = $user->isPluginEnabled('cl') && !$timesheet['client_id'];
227 $trackingMode = $user->getTrackingMode();
228 $group_by_project = MODE_PROJECTS == $trackingMode || MODE_PROJECTS_AND_TASKS == $trackingMode;
230 $options['timesheet_id'] = $timesheet['id'];
231 $options['group_by1'] = 'date';
232 if ($group_by_client || $group_by_project) {
233 $options['group_by2'] = $group_by_client ? 'client' : 'project';
235 if ($options['group_by2'] && $options['group_by2'] != 'project' && $group_by_project) {
236 $options['group_by3'] = 'project';
241 // getApprovers obtains a list of users who can approve a timesheet for a given user
242 // and also have an email to receive a notification about it.
243 static function getApprovers($user_id) {
245 $mdb2 = getConnection();
247 $group_id = $user->getGroup();
248 $org_id = $user->org_id;
250 $approvers = array();
251 $rank = ttUserHelper::getUserRank($user_id);
252 $sql = "select u.id, u.name, u.email".
254 " left join tt_roles r on (r.id = u.role_id)".
255 " where u.status = 1 and u.email is not null and u.group_id = $group_id and u.org_id = $org_id".
256 " and (r.rank > $rank and r.rights like '%approve_timesheets%')";
257 $res = $mdb2->query($sql);
258 if (!is_a($res, 'PEAR_Error')) {
259 while ($val = $res->fetchRow()) {
266 // submitTimesheet marks a timesheet as submitted and sends an email to an approver.
267 static function submitTimesheet($fields) {
269 $mdb2 = getConnection();
271 $group_id = $user->getGroup();
272 $org_id = $user->org_id;
274 // First, mark a timesheet as submitted.
275 // Even if mail part below does not work, this will get us a functioning workflow
276 // (without email notifications).
277 $timesheet_id = $fields['timesheet_id'];
278 $sql = "update tt_timesheets set submit_status = 1".
279 " where id = $timesheet_id and group_id = $group_id and org_id = $org_id";
280 $affected = $mdb2->exec($sql);
281 if (is_a($affected, 'PEAR_Error')) return false;
283 // TODO: send email to approver here...
284 // $approver_id = $fields['approver_id'];
289 // approveTimesheet marks a timesheet as approved and sends an email to submitter.
290 static function approveTimesheet($fields) {
292 $mdb2 = getConnection();
294 $group_id = $user->getGroup();
295 $org_id = $user->org_id;
297 // First, mark a timesheet as approved.
298 // Even if mail part below does not work, this will get us a functioning workflow
299 // (without email notifications).
300 $timesheet_id = $fields['timesheet_id'];
301 $comment = $fields['comment'];
303 $sql = "update tt_timesheets set approve_status = 1, approve_comment = ".$mdb2->quote($comment).
304 " where id = $timesheet_id and submit_status = 1 and group_id = $group_id and org_id = $org_id";
305 $affected = $mdb2->exec($sql);
306 if (is_a($affected, 'PEAR_Error')) return false;
308 // TODO: send email to submitter here...
312 // disapproveTimesheet marks a timesheet as approved and sends an email to submitter.
313 static function disapproveTimesheet($fields) {
315 $mdb2 = getConnection();
317 $group_id = $user->getGroup();
318 $org_id = $user->org_id;
320 // First, mark a timesheet as disapproved.
321 // Even if mail part below does not work, this will get us a functioning workflow
322 // (without email notifications).
323 $timesheet_id = $fields['timesheet_id'];
324 $comment = $fields['comment'];
326 $sql = "update tt_timesheets set approve_status = 0, approve_comment = ".$mdb2->quote($comment).
327 " where id = $timesheet_id and submit_status = 1 and group_id = $group_id and org_id = $org_id";
328 $affected = $mdb2->exec($sql);
329 if (is_a($affected, 'PEAR_Error')) return false;
331 // TODO: send email to submitter here...
335 // The timesheetItemsExist determines whether tt_log records exist in the specified period
336 // for inclusion in a new timesheet.
337 static function timesheetItemsExist($fields) {
339 $mdb2 = getConnection();
341 $user_id = $user->getUser();
342 $group_id = $user->getGroup();
343 $org_id = $user->org_id;
345 if (isset($fields['client_id'])) $client_id = (int) $fields['client_id'];
346 if (isset($fields['project_id'])) $project_id = (int) $fields['project_id'];
348 $start_date = new DateAndTime($user->date_format, $fields['start_date']);
349 $start = $start_date->toString(DB_DATEFORMAT);
351 $end_date = new DateAndTime($user->date_format, $fields['end_date']);
352 $end = $end_date->toString(DB_DATEFORMAT);
355 if ($client_id) $client_part = " and client_id = $client_id";
356 if ($project_id) $project_part = " and project_id = $project_id";
358 $sql = "select count(*) as num from tt_log".
359 " where status = 1 $client_part $project_part and timesheet_id is null".
360 " and date >= ".$mdb2->quote($start)." and date <= ".$mdb2->quote($end).
361 " and user_id = $user_id and group_id = $group_id and org_id = $org_id";
362 $res = $mdb2->query($sql);
363 if (!is_a($res, 'PEAR_Error')) {
364 $val = $res->fetchRow();