Implemented sending email to timesheet approver.
[timetracker.git] / WEB-INF / lib / ttTimesheetHelper.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 import('ttUserHelper');
30
31 // Class ttTimesheetHelper is used to help with project related tasks.
32 class ttTimesheetHelper {
33
34   // The getTimesheetByName looks up a project by name.
35   static function getTimesheetByName($name) {
36     global $user;
37     $mdb2 = getConnection();
38
39     $user_id = $user->getUser();
40     $group_id = $user->getGroup();
41     $org_id = $user->org_id;
42
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'])
50         return $val;
51     }
52     return false;
53   }
54
55   // createTimesheet function creates a new timesheet.
56   static function createTimesheet($fields)
57   {
58     // Create a new timesheet entry.
59     global $user;
60     $mdb2 = getConnection();
61
62     $user_id = $user->getUser();
63     $group_id = $user->getGroup();
64     $org_id = $user->org_id;
65
66     $client_id = $fields['client_id'];
67     $project_id = $fields['project_id'];
68     $name = $fields['name'];
69     $comment = $fields['comment'];
70
71     $start_date = new DateAndTime($user->date_format, $fields['start_date']);
72     $start = $start_date->toString(DB_DATEFORMAT);
73
74     $end_date = new DateAndTime($user->date_format, $fields['end_date']);
75     $end = $end_date->toString(DB_DATEFORMAT);
76
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'))
82       return false;
83
84     $last_id = $mdb2->lastInsertID('tt_timesheets', 'id');
85
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'];
89     // sql parts.
90     if ($client_id) $client_part = " and client_id = $client_id";
91     if ($project_id) $project_part = " and project_id = $project_id";
92
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'))
99       return false;
100
101     return $last_id;
102   }
103
104   // The getActiveTimesheets obtains active timesheets for a user.
105   static function getActiveTimesheets()
106   {
107     global $user;
108     $mdb2 = getConnection();
109
110     $user_id = $user->getUser();
111     $group_id = $user->getGroup();
112     $org_id = $user->org_id;
113
114     $result = array();
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".
119       " order by ts.name";
120     $res = $mdb2->query($sql);
121     $result = array();
122     if (!is_a($res, 'PEAR_Error')) {
123       while ($val = $res->fetchRow()) {
124         $result[] = $val;
125       }
126     }
127     return $result;
128   }
129
130   // The getInactiveTimesheets obtains inactive timesheets for a user.
131   static function getInactiveTimesheets()
132   {
133     global $user;
134     $mdb2 = getConnection();
135
136     $user_id = $user->getUser();
137     $group_id = $user->getGroup();
138     $org_id = $user->org_id;
139
140     $result = array();
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".
145       " order by ts.name";
146     $res = $mdb2->query($sql);
147     $result = array();
148     if (!is_a($res, 'PEAR_Error')) {
149       while ($val = $res->fetchRow()) {
150         $result[] = $val;
151       }
152     }
153     return $result;
154   }
155
156   // getTimesheet - obtains timesheet data from the database.
157   static function getTimesheet($timesheet_id) {
158     global $user;
159     $mdb2 = getConnection();
160
161     $user_id = $user->getUser();
162     $group_id = $user->getGroup();
163     $org_id = $user->org_id;
164
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())
174         return $val;
175     }
176     return false;
177   }
178
179   // delete - deletes timesheet from the database.
180   static function delete($timesheet_id) {
181     global $user;
182     $mdb2 = getConnection();
183
184     $user_id = $user->getUser();
185     $group_id = $user->getGroup();
186     $org_id = $user->org_id;
187
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;
193
194     // Delete timesheet.
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'));
199   }
200
201   // update function - updates the timesheet in database.
202   static function update($fields) {
203     global $user;
204     $mdb2 = getConnection();
205
206     $user_id = $user->getUser();
207     $group_id = $user->getGroup();
208     $org_id = $user->org_id;
209
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.
214
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'));
220   }
221
222   // getReportOptions prepares $options array to be used with ttReportHelper
223   // to obtain items for timesheet view.
224   static function getReportOptions($timesheet) {
225     global $user;
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;
229
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';
234     }
235     if ($options['group_by2'] && $options['group_by2'] != 'project' && $group_by_project) {
236       $options['group_by3'] = 'project';
237     }
238     return $options;
239   }
240
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() {
244     global $user;
245     $mdb2 = getConnection();
246
247     $user_id = $user->getUser();
248     $group_id = $user->getGroup();
249     $org_id = $user->org_id;
250
251     $approvers = array();
252     $rank = ttUserHelper::getUserRank($user_id);
253     $sql = "select u.id, u.name, u.email".
254       " from tt_users u".
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()) {
261         $approvers[] = $val;
262       }
263     }
264     return $approvers;
265   }
266
267   // getApprover obtains approver properties such as name and email.
268   static function getApprover($user_id) {
269     global $user;
270     $mdb2 = getConnection();
271
272     $group_id = $user->getGroup();
273     $org_id = $user->org_id;
274
275     $rank = ttUserHelper::getUserRank($user->getUser());
276     $sql = "select u.name, u.email".
277       " from tt_users u".
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()) {
284         return $val;
285       }
286     }
287     return false;
288   }
289
290   // submitTimesheet marks a timesheet as submitted and also sends an email
291   // to a selected approver.
292   static function submitTimesheet($fields) {
293     global $user;
294     $mdb2 = getConnection();
295
296     $user_id = $user->getUser();
297     $group_id = $user->getGroup();
298     $org_id = $user->org_id;
299
300     // First, mark timesheet as submitted.
301     // Even if mail part below does not work, this will get us a functioning workflow
302     // without email notification.
303     $timesheet_id = $fields['timesheet_id'];
304     $sql = "update tt_timesheets set submit_status = 1".
305       " where id = $timesheet_id and user_id = $user_id and group_id = $group_id and org_id = $org_id";
306     $affected = $mdb2->exec($sql);
307     return (!is_a($affected, 'PEAR_Error'));
308   }
309
310   // sendSubmitEmail sends a notification to an approver about a timesheet submit.
311   static function sendSubmitEmail($fields) {
312     global $i18n;
313     global $user;
314
315     // Send email to a selected approver.
316     if (!$fields['approver_id']) return true; // No approver, nothing to do.
317
318     $approver = ttTimesheetHelper::getApprover($fields['approver_id']);
319     if (!$approver) return false; // Invalid approver id.
320
321     $fields['to'] = $approver['email'];
322     $fields['subject'] = $i18n->get('form.timesheet_view.submit_subject');
323     $fields['body'] = sprintf($i18n->get('form.timesheet_view.submit_body'), $user->getName());
324
325     return ttTimesheetHelper::sendEmail($fields);
326   }
327
328   // sendEmail is a generic finction that sends a timesheet related email.
329   // TODO: perhaps make it even more generic for the entire application.
330   static function sendEmail($fields, $html = true) {
331     global $i18n;
332     global $user;
333
334     // Send email.
335     import('mail.Mailer');
336     $mailer = new Mailer();
337     $mailer->setCharSet(CHARSET);
338     if ($html)
339       $mailer->setContentType('text/html');
340     $mailer->setSender(SENDER);
341     $mailer->setReceiver($fields['to']);
342     if (!empty($user->bcc_email))
343       $mailer->setReceiverBCC($user->bcc_email);
344     $mailer->setMailMode(MAIL_MODE);
345     if (!$mailer->send($fields['subject'], $fields['body']))
346       return false;
347
348     return true;
349   }
350
351   // approveTimesheet marks a timesheet as approved and sends an email to submitter.
352   static function approveTimesheet($fields) {
353     global $user;
354     $mdb2 = getConnection();
355
356     $user_id = $user->getUser();
357     $group_id = $user->getGroup();
358     $org_id = $user->org_id;
359
360     // First, mark timesheet as approved.
361     // Even if mail part below does not work, this will get us a functioning workflow
362     // without email notification.
363     $timesheet_id = $fields['timesheet_id'];
364     $comment = $fields['comment'];
365
366     $sql = "update tt_timesheets set approve_status = 1, approve_comment = ".$mdb2->quote($comment).
367       " where id = $timesheet_id and submit_status = 1 and user_id = $user_id and group_id = $group_id and org_id = $org_id";
368     $affected = $mdb2->exec($sql);
369     if (is_a($affected, 'PEAR_Error')) return false;
370
371     // TODO: send email to submitter here...
372     return true;
373   }
374
375   // disapproveTimesheet marks a timesheet as approved and sends an email to submitter.
376   static function disapproveTimesheet($fields) {
377     global $user;
378     $mdb2 = getConnection();
379
380     $user_id = $user->getUser();
381     $group_id = $user->getGroup();
382     $org_id = $user->org_id;
383
384     // First, mark timesheet as disapproved.
385     // Even if mail part below does not work, this will get us a functioning workflow
386     // without email notification.
387     $timesheet_id = $fields['timesheet_id'];
388     $comment = $fields['comment'];
389
390     $sql = "update tt_timesheets set approve_status = 0, approve_comment = ".$mdb2->quote($comment).
391       " where id = $timesheet_id and submit_status = 1 and user_id = $user_id and group_id = $group_id and org_id = $org_id";
392     $affected = $mdb2->exec($sql);
393     if (is_a($affected, 'PEAR_Error')) return false;
394
395     // TODO: send email to submitter here...
396     return true;
397   }
398
399   // The timesheetItemsExist determines whether tt_log records exist in the specified period
400   // for inclusion in a new timesheet.
401   static function timesheetItemsExist($fields) {
402     global $user;
403     $mdb2 = getConnection();
404
405     $user_id = $user->getUser();
406     $group_id = $user->getGroup();
407     $org_id = $user->org_id;
408
409     if (isset($fields['client_id'])) $client_id = (int) $fields['client_id'];
410     if (isset($fields['project_id'])) $project_id = (int) $fields['project_id'];
411
412     $start_date = new DateAndTime($user->date_format, $fields['start_date']);
413     $start = $start_date->toString(DB_DATEFORMAT);
414
415     $end_date = new DateAndTime($user->date_format, $fields['end_date']);
416     $end = $end_date->toString(DB_DATEFORMAT);
417
418     // sql parts.
419     if ($client_id) $client_part = " and client_id = $client_id";
420     if ($project_id) $project_part = " and project_id = $project_id";
421
422     $sql = "select count(*) as num from tt_log".
423       " where status = 1 $client_part $project_part and timesheet_id is null".
424       " and date >= ".$mdb2->quote($start)." and date <= ".$mdb2->quote($end).
425       " and user_id = $user_id and group_id = $group_id and org_id = $org_id";
426     $res = $mdb2->query($sql);
427     if (!is_a($res, 'PEAR_Error')) {
428       $val = $res->fetchRow();
429       if ($val['num']) {
430         return true;
431       }
432     }
433
434     return false;
435   }
436
437   // The overlaps function determines if a new timesheet overlaps with
438   // an already existing timesheet.
439   static function overlaps($fields) {
440     global $user;
441     $mdb2 = getConnection();
442
443     $user_id = $user->getUser();
444     $group_id = $user->getGroup();
445     $org_id = $user->org_id;
446
447     if (isset($fields['client_id'])) $client_id = (int) $fields['client_id'];
448     if (isset($fields['project_id'])) $project_id = (int) $fields['project_id'];
449
450     $start_date = new DateAndTime($user->date_format, $fields['start_date']);
451     $start = $start_date->toString(DB_DATEFORMAT);
452     $quoted_start = $mdb2->quote($start);
453
454     $end_date = new DateAndTime($user->date_format, $fields['end_date']);
455     $end = $end_date->toString(DB_DATEFORMAT);
456     $quoted_end = $mdb2->quote($end);
457
458     // sql parts.
459     if ($client_id) $client_part = " and client_id = $client_id";
460     if ($project_id) $project_part = " and project_id = $project_id";
461
462     $sql = "select id from tt_timesheets".
463       " where status is not null $client_part $project_part".
464       " and (($quoted_start >= start_date and $quoted_start <= end_date)".
465       "   or ($quoted_end >= start_date and $quoted_end <= end_date))".
466       " and user_id = $user_id and group_id = $group_id and org_id = $org_id";
467     $res = $mdb2->query($sql);
468     if (!is_a($res, 'PEAR_Error')) {
469       $val = $res->fetchRow();
470       if ($val['id']) {
471         return true;
472       }
473     }
474     return false;
475   }
476
477   // The getMatchingTimesheets function retrieves a timesheet that "matches"
478   // a report for an option to assign report items to it.
479   //
480   // Condition: report range is fully enclosed in an existing timesheet with
481   // matching client_id and project_id and null approved_status.
482   static function getMatchingTimesheets($options) {
483     global $user;
484     $mdb2 = getConnection();
485
486     $user_id = $user->getUser();
487     $group_id = $user->getGroup();
488     $org_id = $user->org_id;
489
490     // Check users.
491     if (isset($options['users'])) {
492       $comma_separated = $options['users'];
493       $users = explode(',', $comma_separated);
494       if (count($users) > 1 || $users[0] != $user->getUser())
495         return false;
496     }
497
498     // No timesheets for expenses.
499     if ($options['show_cost'] && $user->isPluginEnabled('ex')) return false;
500     
501     // Parts for client and project.
502     if ($options['client_id']) $client_part = ' and (client_id is null or client_id = '.(int)$options['client_id'].')';
503     if ($options['project_id']) $project_part = ' and (project_id is null or project_id = '.(int)$options['project_id'].')';
504
505     // Determine start and end dates.
506     $dateFormat = $user->getDateFormat();
507     if ($options['period'])
508       $period = new Period($options['period'], new DateAndTime($dateFormat));
509     else {
510       $period = new Period();
511       $period->setPeriod(
512         new DateAndTime($dateFormat, $options['period_start']),
513         new DateAndTime($dateFormat, $options['period_end']));
514     }
515     $start = $period->getStartDate(DB_DATEFORMAT);
516     $end = $period->getEndDate(DB_DATEFORMAT);
517
518     $result = false;
519     $sql = "select id, name from tt_timesheets".
520       " where ".$mdb2->quote($start)." >= start_date and ".$mdb2->quote($end)." <= end_date".
521       "$client_part $project_part".
522       " and user_id = $user_id and group_id = $group_id and org_id = $org_id".
523       " and approve_status is null and status is not null";
524     $res = $mdb2->query($sql);
525     if (!is_a($res, 'PEAR_Error')) {
526       while ($val = $res->fetchRow()) {
527         $result[] = $val;
528       }
529     }
530     return $result;
531   }
532 }