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() {
245 $mdb2 = getConnection();
247 $user_id = $user->getUser();
248 $group_id = $user->getGroup();
249 $org_id = $user->org_id;
251 $approvers = array();
252 $rank = ttUserHelper::getUserRank($user_id);
253 $sql = "select u.id, u.name, u.email".
255 " left join tt_roles r on (r.id = u.role_id)".
256 " where u.status = 1 and u.email is not null and u.group_id = $group_id and u.org_id = $org_id".
257 " and (r.rank > $rank and r.rights like '%approve_timesheets%')";
258 $res = $mdb2->query($sql);
259 if (!is_a($res, 'PEAR_Error')) {
260 while ($val = $res->fetchRow()) {
267 // getApprover obtains approver properties such as name and email.
268 static function getApprover($user_id) {
270 $mdb2 = getConnection();
272 $group_id = $user->getGroup();
273 $org_id = $user->org_id;
275 $rank = ttUserHelper::getUserRank($user->getUser());
276 $sql = "select u.name, u.email".
278 " left join tt_roles r on (r.id = u.role_id)".
279 " where u.id = $user_id and u.status = 1 and u.email is not null and u.group_id = $group_id and u.org_id = $org_id".
280 " and (r.rank > $rank and r.rights like '%approve_timesheets%')";
281 $res = $mdb2->query($sql);
282 if (!is_a($res, 'PEAR_Error')) {
283 if ($val = $res->fetchRow()) {
290 // markSubmitted marks a timesheet as submitted.
291 static function markSubmitted($fields) {
293 $mdb2 = getConnection();
295 $user_id = $user->getUser();
296 $group_id = $user->getGroup();
297 $org_id = $user->org_id;
299 $timesheet_id = $fields['timesheet_id'];
300 $sql = "update tt_timesheets set submit_status = 1".
301 " where id = $timesheet_id and user_id = $user_id and group_id = $group_id and org_id = $org_id";
302 $affected = $mdb2->exec($sql);
303 return (!is_a($affected, 'PEAR_Error'));
306 // sendSubmitEmail sends a notification to an approver about a timesheet submit.
307 static function sendSubmitEmail($fields) {
311 // Send email to a selected approver.
312 if (!$fields['approver_id']) return true; // No approver, nothing to do.
314 $approver = ttTimesheetHelper::getApprover($fields['approver_id']);
315 if (!$approver) return false; // Invalid approver id.
317 $fields['to'] = $approver['email'];
318 $fields['subject'] = $i18n->get('form.timesheet_view.submit_subject');
319 $fields['body'] = sprintf($i18n->get('form.timesheet_view.submit_body'), $user->getName());
321 return ttTimesheetHelper::sendEmail($fields);
324 // sendApprovedEmail sends a notification to user about a timesheet approval.
325 static function sendApprovedEmail($fields) {
329 // Obtain user email.
330 $user_details = $user->getUserDetails($fields['user_id']);
331 $email = $user_details['email'];
332 if (!$email) return true; // No email to send to, nothing to do.
334 $fields['to'] = $email;
335 $fields['subject'] = $i18n->get('form.timesheet_view.approve_subject');
336 $fields['body'] = sprintf($i18n->get('form.timesheet_view.approve_body'), htmlspecialchars($fields['name']), htmlspecialchars($fields['comment']));
338 return ttTimesheetHelper::sendEmail($fields);
341 // sendDisapprovedEmail sends a notification to user about a timesheet disapproval.
342 static function sendDisapprovedEmail($fields) {
346 // Obtain user email.
347 $user_details = $user->getUserDetails($fields['user_id']);
348 $email = $user_details['email'];
349 if (!$email) return true; // No email to send to, nothing to do.
351 $fields['to'] = $email;
352 $fields['subject'] = $i18n->get('form.timesheet_view.disapprove_subject');
353 $fields['body'] = sprintf($i18n->get('form.timesheet_view.disapprove_body'), htmlspecialchars($fields['name']), htmlspecialchars($fields['comment']));
355 return ttTimesheetHelper::sendEmail($fields);
358 // sendEmail is a generic finction that sends a timesheet related email.
359 // TODO: perhaps make it even more generic for the entire application.
360 static function sendEmail($fields, $html = true) {
365 import('mail.Mailer');
366 $mailer = new Mailer();
367 $mailer->setCharSet(CHARSET);
369 $mailer->setContentType('text/html');
370 $mailer->setSender(SENDER);
371 $mailer->setReceiver($fields['to']);
372 if (!empty($user->bcc_email))
373 $mailer->setReceiverBCC($user->bcc_email);
374 $mailer->setMailMode(MAIL_MODE);
375 if (!$mailer->send($fields['subject'], $fields['body']))
381 // markApproved marks a timesheet as approved.
382 static function markApproved($fields) {
384 $mdb2 = getConnection();
386 $user_id = $user->getUser();
387 $group_id = $user->getGroup();
388 $org_id = $user->org_id;
390 $timesheet_id = $fields['timesheet_id'];
391 $comment = $fields['comment'];
393 $sql = "update tt_timesheets set approve_status = 1, approve_comment = ".$mdb2->quote($comment).
394 " where id = $timesheet_id and submit_status = 1 and user_id = $user_id and group_id = $group_id and org_id = $org_id";
395 $affected = $mdb2->exec($sql);
396 return (!is_a($affected, 'PEAR_Error'));
399 // markDisapproved marks a timesheet as not approved.
400 static function markDisapproved($fields) {
402 $mdb2 = getConnection();
404 $user_id = $user->getUser();
405 $group_id = $user->getGroup();
406 $org_id = $user->org_id;
408 $timesheet_id = $fields['timesheet_id'];
409 $comment = $fields['comment'];
411 $sql = "update tt_timesheets set approve_status = 0, approve_comment = ".$mdb2->quote($comment).
412 " where id = $timesheet_id and submit_status = 1 and user_id = $user_id and group_id = $group_id and org_id = $org_id";
413 $affected = $mdb2->exec($sql);
414 return (!is_a($affected, 'PEAR_Error'));
417 // The timesheetItemsExist determines whether tt_log records exist in the specified period
418 // for inclusion in a new timesheet.
419 static function timesheetItemsExist($fields) {
421 $mdb2 = getConnection();
423 $user_id = $user->getUser();
424 $group_id = $user->getGroup();
425 $org_id = $user->org_id;
427 if (isset($fields['client_id'])) $client_id = (int) $fields['client_id'];
428 if (isset($fields['project_id'])) $project_id = (int) $fields['project_id'];
430 $start_date = new DateAndTime($user->date_format, $fields['start_date']);
431 $start = $start_date->toString(DB_DATEFORMAT);
433 $end_date = new DateAndTime($user->date_format, $fields['end_date']);
434 $end = $end_date->toString(DB_DATEFORMAT);
437 if ($client_id) $client_part = " and client_id = $client_id";
438 if ($project_id) $project_part = " and project_id = $project_id";
440 $sql = "select count(*) as num from tt_log".
441 " where status = 1 $client_part $project_part and timesheet_id is null".
442 " and date >= ".$mdb2->quote($start)." and date <= ".$mdb2->quote($end).
443 " and user_id = $user_id and group_id = $group_id and org_id = $org_id";
444 $res = $mdb2->query($sql);
445 if (!is_a($res, 'PEAR_Error')) {
446 $val = $res->fetchRow();
455 // The overlaps function determines if a new timesheet overlaps with
456 // an already existing timesheet.
457 static function overlaps($fields) {
459 $mdb2 = getConnection();
461 $user_id = $user->getUser();
462 $group_id = $user->getGroup();
463 $org_id = $user->org_id;
465 if (isset($fields['client_id'])) $client_id = (int) $fields['client_id'];
466 if (isset($fields['project_id'])) $project_id = (int) $fields['project_id'];
468 $start_date = new DateAndTime($user->date_format, $fields['start_date']);
469 $start = $start_date->toString(DB_DATEFORMAT);
470 $quoted_start = $mdb2->quote($start);
472 $end_date = new DateAndTime($user->date_format, $fields['end_date']);
473 $end = $end_date->toString(DB_DATEFORMAT);
474 $quoted_end = $mdb2->quote($end);
477 if ($client_id) $client_part = " and client_id = $client_id";
478 if ($project_id) $project_part = " and project_id = $project_id";
480 $sql = "select id from tt_timesheets".
481 " where status is not null $client_part $project_part".
482 " and (($quoted_start >= start_date and $quoted_start <= end_date)".
483 " or ($quoted_end >= start_date and $quoted_end <= end_date))".
484 " and user_id = $user_id and group_id = $group_id and org_id = $org_id";
485 $res = $mdb2->query($sql);
486 if (!is_a($res, 'PEAR_Error')) {
487 $val = $res->fetchRow();
495 // The getMatchingTimesheets function retrieves a timesheet that "matches"
496 // a report for an option to assign report items to it.
498 // Condition: report range is fully enclosed in an existing timesheet with
499 // matching client_id and project_id and null approved_status.
500 static function getMatchingTimesheets($options) {
502 $mdb2 = getConnection();
504 $user_id = $user->getUser();
505 $group_id = $user->getGroup();
506 $org_id = $user->org_id;
509 if (isset($options['users'])) {
510 $comma_separated = $options['users'];
511 $users = explode(',', $comma_separated);
512 if (count($users) > 1 || $users[0] != $user->getUser())
516 // No timesheets for expenses.
517 if ($options['show_cost'] && $user->isPluginEnabled('ex')) return false;
519 // Parts for client and project.
520 if ($options['client_id']) $client_part = ' and (client_id is null or client_id = '.(int)$options['client_id'].')';
521 if ($options['project_id']) $project_part = ' and (project_id is null or project_id = '.(int)$options['project_id'].')';
523 // Determine start and end dates.
524 $dateFormat = $user->getDateFormat();
525 if ($options['period'])
526 $period = new Period($options['period'], new DateAndTime($dateFormat));
528 $period = new Period();
530 new DateAndTime($dateFormat, $options['period_start']),
531 new DateAndTime($dateFormat, $options['period_end']));
533 $start = $period->getStartDate(DB_DATEFORMAT);
534 $end = $period->getEndDate(DB_DATEFORMAT);
537 $sql = "select id, name from tt_timesheets".
538 " where ".$mdb2->quote($start)." >= start_date and ".$mdb2->quote($end)." <= end_date".
539 "$client_part $project_part".
540 " and user_id = $user_id and group_id = $group_id and org_id = $org_id".
541 " and approve_status is null and status is not null";
542 $res = $mdb2->query($sql);
543 if (!is_a($res, 'PEAR_Error')) {
544 while ($val = $res->fetchRow()) {