Merged getWhere and getFavWhere into one function.
[timetracker.git] / cron.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 /*
30  * cron.php - this file is an entry point to execute scheduled jobs in Time Tracker.
31  * It must be called externally (for example, from the system cron or task scheduler).
32  * 
33  * Internally, we store scheduled jobs in tt_cron table in db. The cron_spec field is in cron format.
34  * Along with it, we store last and next timestamps for jobs, we use them as an execute condition.
35  * 
36  * Although cron_spec follows 5-field cron specification precisely, actual job timing depends on
37  * how often cron.php is called. For example, an hourly ping will execute jobs no more than once
38  * each hour, even if they are due more often. Configure whatever calls this file accordingly.
39  */
40
41 require_once('initialize.php');
42 require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
43 require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
44 import('ttFavReportHelper');
45 import('ttReportHelper');
46
47 $mdb2 = getConnection();
48 $now = time();
49
50  $sql = "select c.id, c.cron_spec, c.report_id, c.email, c.cc, c.subject, c.report_condition from tt_cron c
51    left join tt_fav_reports fr on (c.report_id = fr.id)
52    where $now >= c.next and fr.status = 1
53    and c.status = 1 and c.report_id is not null and c.email is not null";
54 $res = $mdb2->query($sql);
55 if (is_a($res, 'PEAR_Error'))
56   exit();
57
58 while ($val = $res->fetchRow()) {
59   // We have jobs to execute in user language.
60
61   // Get favorite report details.
62   $options = ttFavReportHelper::getReportOptions($val['report_id']);
63   if (!$options) continue; // Skip not found report.
64
65   // Recycle global $user object, as user settings are specific for each report.
66   $user = new ttUser(null, $options['user_id']);
67   if (!$user->id) continue; // Skip not found user.
68
69   // Special handling of the NULL $options['users'] field (this used to mean "all users").
70   if (!$options['users']) {
71     if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient()) {
72       if ($user->can('view_reports') || $user->can('view_all_reports')) {
73         $max_rank = $user->rank-1;
74         if ($user->can('view_all_reports')) $max_rank = 512;
75         if ($user->can('view_own_reports'))
76           $user_options = array('max_rank'=>$max_rank,'include_self'=>true);
77         else
78           $user_options = array('max_rank'=>$max_rank);
79         $users = $user->getUsers($user_options); // Active and inactive users.
80       } elseif ($user->isClient()) {
81         $users = ttTeamHelper::getUsersForClient(); // Active and inactive users for clients.
82       }
83       foreach ($users as $single_user) {
84         $user_ids[] = $single_user['id'];
85       }
86       $options['users'] = implode(',', $user_ids);
87     }
88   } else {
89     // TODO: add checking the existing user list for potentially changed access rights for user.
90   }
91
92   // Skip users with disabled Notifications plugin.
93   if (!$user->isPluginEnabled('no')) continue;
94
95   // Recycle $i18n object because language is user-specific.
96   $i18n->load($user->lang);
97
98   // Check condition on a report.
99   $condition_ok = true;
100   if ($val['report_condition'])
101     $condition_ok = ttReportHelper::checkFavReportCondition($options, $val['report_condition']);
102
103   // Email report if condition is okay.
104   if ($condition_ok) {
105     if (ttReportHelper::sendFavReport($options, $val['subject'], $val['email'], $val['cc']))
106       echo "Report ".$val['report_id']. " sent.<br>";
107     else
108       echo "Error while emailing report...<br>";
109   }
110
111   // Calculate next execution time.
112   $next = tdCron::getNextOccurrence($val['cron_spec'], $now + 60); // +60 sec is here to get us correct $next when $now is close to existing "next".
113                                                                    // This is because the accuracy of tdcron class appears to be 1 minute.
114
115   // Update last and next values in tt_cron.
116   $sql = "update tt_cron set last = $now, next = $next where id = ".$val['id'];
117   $affected = $mdb2->exec($sql);
118   if (is_a($affected, 'PEAR_Error')) continue;
119 }
120
121 echo "Done!";