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 require_once('initialize.php');
31 import('ttUserHelper');
32 import('ttGroupHelper');
33 import('ttTeamHelper');
34 import('ttClientHelper');
35 import('ttTimeHelper');
36 import('DateAndTime');
39 if (!(ttAccessAllowed('track_own_time') || ttAccessAllowed('track_time'))) {
40 header('Location: access_denied.php');
43 if ($user->behalf_id && (!$user->can('track_time') || !$user->checkBehalfId())) {
44 header('Location: access_denied.php'); // Trying on behalf, but no right or wrong user.
47 if (!$user->behalf_id && !$user->can('track_own_time') && !$user->adjustBehalfId()) {
48 header('Location: access_denied.php'); // Trying as self, but no right for self, and noone to work on behalf.
51 // End of access checks.
53 // Initialize and store date in session.
54 $cl_date = $request->getParameter('date', @$_SESSION['date']);
55 $selected_date = new DateAndTime(DB_DATEFORMAT, $cl_date);
56 if($selected_date->isError())
57 $selected_date = new DateAndTime(DB_DATEFORMAT);
59 $cl_date = $selected_date->toString(DB_DATEFORMAT);
60 $_SESSION['date'] = $cl_date;
62 // Use custom fields plugin if it is enabled.
63 if ($user->isPluginEnabled('cf')) {
64 require_once('plugins/CustomFields.class.php');
65 $custom_fields = new CustomFields($user->group_id);
66 $smarty->assign('custom_fields', $custom_fields);
69 if ($user->isPluginEnabled('mq')){
70 require_once('plugins/MonthlyQuota.class.php');
71 $quota = new MonthlyQuota();
72 $month_quota_minutes = $quota->get($selected_date->mYear, $selected_date->mMonth);
73 $month_total = ttTimeHelper::getTimeForMonth($user->getActiveUser(), $selected_date);
74 $minutes_left = $month_quota_minutes - ttTimeHelper::toMinutes($month_total);
76 $smarty->assign('month_total', $month_total);
77 $smarty->assign('over_quota', $minutes_left < 0);
78 $smarty->assign('quota_remaining', ttTimeHelper::toAbsDuration($minutes_left));
81 // Initialize variables.
82 $cl_start = trim($request->getParameter('start'));
83 $cl_finish = trim($request->getParameter('finish'));
84 $cl_duration = trim($request->getParameter('duration'));
85 $cl_note = trim($request->getParameter('note'));
87 $cl_cf_1 = trim($request->getParameter('cf_1', ($request->isPost() ? null : @$_SESSION['cf_1'])));
88 $_SESSION['cf_1'] = $cl_cf_1;
90 if ($user->isPluginEnabled('iv')) {
91 if ($request->isPost()) {
92 $cl_billable = $request->getParameter('billable');
93 $_SESSION['billable'] = (int) $cl_billable;
95 if (isset($_SESSION['billable']))
96 $cl_billable = $_SESSION['billable'];
98 $on_behalf_id = $request->getParameter('onBehalfUser', (isset($_SESSION['behalf_id'])? $_SESSION['behalf_id'] : $user->id));
99 $on_behalf_group_id = $request->getParameter('onBehalfGroup', (isset($_SESSION['behalf_group_id'])? $_SESSION['behalf_group_id'] : $user->group_id));
100 $cl_client = $request->getParameter('client', ($request->isPost() ? null : @$_SESSION['client']));
101 $_SESSION['client'] = $cl_client;
102 $cl_project = $request->getParameter('project', ($request->isPost() ? null : @$_SESSION['project']));
103 $_SESSION['project'] = $cl_project;
104 $cl_task = $request->getParameter('task', ($request->isPost() ? null : @$_SESSION['task']));
105 $_SESSION['task'] = $cl_task;
107 // Elements of timeRecordForm.
108 $form = new Form('timeRecordForm');
110 if (defined('SUBGROUP_DEBUG') && isTrue(SUBGROUP_DEBUG)) {
111 if ($user->can('manage_subgroups')) {
112 $groups = $user->getGroups();
113 if (count($groups) > 1) {
114 $form->addInput(array('type'=>'combobox',
115 'onchange'=>'this.form.submit();',
116 'name'=>'onBehalfGroup',
117 'style'=>'width: 250px;',
118 'value'=>$on_behalf_group_id,
120 'datakeys'=>array('id','name')));
121 $smarty->assign('on_behalf_group_control', 1);
126 if ($user->can('track_time')) {
127 // Determine max rank.
128 $max_rank = $on_behalf_group_id == $user->group_id ? $user->rank-1 : 512; // TODO: stop using magic numbers.
129 if ($user->can('track_own_time'))
130 $options = array('group_id'=>$on_behalf_group_id,'status'=>ACTIVE,'max_rank'=>$max_rank,'include_self'=>true,'self_first'=>true);
132 $options = array('group_id'=>$on_behalf_group_id,'status'=>ACTIVE,'max_rank'=>$max_rank);
133 $user_list = $user->getUsers($options);
134 if (count($user_list) >= 1) {
135 $form->addInput(array('type'=>'combobox',
136 'onchange'=>'this.form.submit();',
137 'name'=>'onBehalfUser',
138 'style'=>'width: 250px;',
139 'value'=>$on_behalf_id,
141 'datakeys'=>array('id','name')));
142 $smarty->assign('on_behalf_control', 1);
146 // Dropdown for clients in MODE_TIME. Use all active clients.
147 if (MODE_TIME == $user->tracking_mode && $user->isPluginEnabled('cl')) {
148 $active_clients = ttTeamHelper::getActiveClients($user->group_id, true);
149 $form->addInput(array('type'=>'combobox',
150 'onchange'=>'fillProjectDropdown(this.value);',
152 'style'=>'width: 250px;',
154 'data'=>$active_clients,
155 'datakeys'=>array('id', 'name'),
156 'empty'=>array(''=>$i18n->get('dropdown.select'))));
157 // Note: in other modes the client list is filtered to relevant clients only. See below.
160 if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
161 // Dropdown for projects assigned to user.
162 $project_list = $user->getAssignedProjects();
163 $form->addInput(array('type'=>'combobox',
164 'onchange'=>'fillTaskDropdown(this.value);',
166 'style'=>'width: 250px;',
167 'value'=>$cl_project,
168 'data'=>$project_list,
169 'datakeys'=>array('id','name'),
170 'empty'=>array(''=>$i18n->get('dropdown.select'))));
172 // Dropdown for clients if the clients plugin is enabled.
173 if ($user->isPluginEnabled('cl')) {
174 $active_clients = ttTeamHelper::getActiveClients($user->group_id, true);
175 // We need an array of assigned project ids to do some trimming.
176 foreach($project_list as $project)
177 $projects_assigned_to_user[] = $project['id'];
179 // Build a client list out of active clients. Use only clients that are relevant to user.
180 // Also trim their associated project list to only assigned projects (to user).
181 foreach($active_clients as $client) {
182 $projects_assigned_to_client = explode(',', $client['projects']);
183 if (is_array($projects_assigned_to_client) && is_array($projects_assigned_to_user))
184 $intersection = array_intersect($projects_assigned_to_client, $projects_assigned_to_user);
186 $client['projects'] = implode(',', $intersection);
187 $client_list[] = $client;
190 $form->addInput(array('type'=>'combobox',
191 'onchange'=>'fillProjectDropdown(this.value);',
193 'style'=>'width: 250px;',
195 'data'=>$client_list,
196 'datakeys'=>array('id', 'name'),
197 'empty'=>array(''=>$i18n->get('dropdown.select'))));
201 if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
202 $task_list = ttTeamHelper::getActiveTasks($user->group_id);
203 $form->addInput(array('type'=>'combobox',
205 'style'=>'width: 250px;',
208 'datakeys'=>array('id','name'),
209 'empty'=>array(''=>$i18n->get('dropdown.select'))));
212 // Add other controls.
213 if ((TYPE_START_FINISH == $user->record_type) || (TYPE_ALL == $user->record_type)) {
214 $form->addInput(array('type'=>'text','name'=>'start','value'=>$cl_start,'onchange'=>"formDisable('start');"));
215 $form->addInput(array('type'=>'text','name'=>'finish','value'=>$cl_finish,'onchange'=>"formDisable('finish');"));
216 if ($user->punch_mode && !$user->canOverridePunchMode()) {
217 // Make the start and finish fields read-only.
218 $form->getElement('start')->setEnabled(false);
219 $form->getElement('finish')->setEnabled(false);
222 if ((TYPE_DURATION == $user->record_type) || (TYPE_ALL == $user->record_type))
223 $form->addInput(array('type'=>'text','name'=>'duration','value'=>$cl_duration,'onchange'=>"formDisable('duration');"));
224 if (!defined('NOTE_INPUT_HEIGHT'))
225 define('NOTE_INPUT_HEIGHT', 40);
226 $form->addInput(array('type'=>'textarea','name'=>'note','style'=>'width: 600px; height:'.NOTE_INPUT_HEIGHT.'px;','value'=>$cl_note));
227 $form->addInput(array('type'=>'calendar','name'=>'date','value'=>$cl_date)); // calendar
228 if ($user->isPluginEnabled('iv'))
229 $form->addInput(array('type'=>'checkbox','name'=>'billable','value'=>$cl_billable));
230 $form->addInput(array('type'=>'hidden','name'=>'browser_today','value'=>'')); // User current date, which gets filled in on btn_submit click.
231 $form->addInput(array('type'=>'submit','name'=>'btn_submit','onclick'=>'browser_today.value=get_date()','value'=>$i18n->get('button.submit')));
233 // If we have custom fields - add controls for them.
234 if ($custom_fields && $custom_fields->fields[0]) {
235 // Only one custom field is supported at this time.
236 if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT) {
237 $form->addInput(array('type'=>'text','name'=>'cf_1','value'=>$cl_cf_1));
238 } elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
239 $form->addInput(array('type'=>'combobox','name'=>'cf_1',
240 'style'=>'width: 250px;',
242 'data'=>$custom_fields->options,
243 'empty'=>array(''=>$i18n->get('dropdown.select'))));
248 if ($request->isPost()) {
249 if ($request->getParameter('btn_submit')) {
251 // Validate user input.
252 if ($user->isPluginEnabled('cl') && $user->isPluginEnabled('cm') && !$cl_client)
253 $err->add($i18n->get('error.client'));
254 if ($custom_fields) {
255 if (!ttValidString($cl_cf_1, !$custom_fields->fields[0]['required'])) $err->add($i18n->get('error.field'), $custom_fields->fields[0]['label']);
257 if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
258 if (!$cl_project) $err->add($i18n->get('error.project'));
260 if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode && $user->task_required) {
261 if (!$cl_task) $err->add($i18n->get('error.task'));
263 if (strlen($cl_duration) == 0) {
264 if ($cl_start || $cl_finish) {
265 if (!ttTimeHelper::isValidTime($cl_start))
266 $err->add($i18n->get('error.field'), $i18n->get('label.start'));
268 if (!ttTimeHelper::isValidTime($cl_finish))
269 $err->add($i18n->get('error.field'), $i18n->get('label.finish'));
270 if (!ttTimeHelper::isValidInterval($cl_start, $cl_finish))
271 $err->add($i18n->get('error.interval'), $i18n->get('label.finish'), $i18n->get('label.start'));
274 if ((TYPE_START_FINISH == $user->record_type) || (TYPE_ALL == $user->record_type)) {
275 $err->add($i18n->get('error.empty'), $i18n->get('label.start'));
276 $err->add($i18n->get('error.empty'), $i18n->get('label.finish'));
278 if ((TYPE_DURATION == $user->record_type) || (TYPE_ALL == $user->record_type))
279 $err->add($i18n->get('error.empty'), $i18n->get('label.duration'));
282 if (false === ttTimeHelper::postedDurationToMinutes($cl_duration))
283 $err->add($i18n->get('error.field'), $i18n->get('label.duration'));
285 if (!ttValidString($cl_note, true)) $err->add($i18n->get('error.field'), $i18n->get('label.note'));
286 // Finished validating user input.
288 // Prohibit creating entries in future.
289 if (!$user->future_entries) {
290 $browser_today = new DateAndTime(DB_DATEFORMAT, $request->getParameter('browser_today', null));
291 if ($selected_date->after($browser_today))
292 $err->add($i18n->get('error.future_date'));
295 // Prohibit creating entries in locked range.
296 if ($user->isDateLocked($selected_date))
297 $err->add($i18n->get('error.range_locked'));
299 // Prohibit creating another uncompleted record.
301 if (($not_completed_rec = ttTimeHelper::getUncompleted($user->getActiveUser())) && (($cl_finish == '') && ($cl_duration == '')))
302 $err->add($i18n->get('error.uncompleted_exists')." <a href = 'time_edit.php?id=".$not_completed_rec['id']."'>".$i18n->get('error.goto_uncompleted')."</a>");
305 // Prohibit creating an overlapping record.
307 if (ttTimeHelper::overlaps($user->getActiveUser(), $cl_date, $cl_start, $cl_finish))
308 $err->add($i18n->get('error.overlap'));
313 $id = ttTimeHelper::insert(array(
315 'user_id' => $user->getActiveUser(),
316 'group_id' => $user->getActiveGroup(),
317 'client' => $cl_client,
318 'project' => $cl_project,
320 'start' => $cl_start,
321 'finish' => $cl_finish,
322 'duration' => $cl_duration,
324 'billable' => $cl_billable));
326 // Insert a custom field if we have it.
328 if ($id && $custom_fields && $cl_cf_1) {
329 if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
330 $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], null, $cl_cf_1);
331 elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
332 $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], $cl_cf_1, null);
334 if ($id && $result) {
335 header('Location: time.php');
338 $err->add($i18n->get('error.db'));
340 } elseif ($request->getParameter('btn_stop')) {
341 // Stop button pressed to finish an uncompleted record.
342 $record_id = $request->getParameter('record_id');
343 $record = ttTimeHelper::getRecord($record_id, $user->getActiveUser());
344 $browser_date = $request->getParameter('browser_date');
345 $browser_time = $request->getParameter('browser_time');
347 // Can we complete this record?
348 if ($record['date'] == $browser_date // closing today's record
349 && ttTimeHelper::isValidInterval($record['start'], $browser_time) // finish time is greater than start time
350 && !ttTimeHelper::overlaps($user->getActiveUser(), $browser_date, $record['start'], $browser_time)) { // no overlap
351 $res = ttTimeHelper::update(array(
353 'date'=>$record['date'],
354 'user_id'=>$user->getActiveUser(),
355 'client'=>$record['client_id'],
356 'project'=>$record['project_id'],
357 'task'=>$record['task_id'],
358 'start'=>$record['start'],
359 'finish'=>$browser_time,
360 'note'=>$record['comment'],
361 'billable'=>$record['billable']));
363 $err->add($i18n->get('error.db'));
365 // Cannot complete, redirect for manual edit.
366 header('Location: time_edit.php?id='.$record_id);
370 elseif ($request->getParameter('onBehalfGroup')) {
371 if($user->can('manage_subgroups')) {
372 unset($_SESSION['behalf_group_id']);
373 unset($_SESSION['behalf_group_name']);
375 if($on_behalf_group_id != $user->group_id) {
376 $_SESSION['behalf_group_id'] = $on_behalf_group_id;
377 $_SESSION['behalf_group_name'] = ttGroupHelper::getGroupName($on_behalf_group_id);
379 header('Location: time.php');
383 elseif ($request->getParameter('onBehalfUser')) {
384 if($user->can('track_time')) {
385 unset($_SESSION['behalf_id']);
386 unset($_SESSION['behalf_name']);
388 if($on_behalf_id != $user->id) {
389 $_SESSION['behalf_id'] = $on_behalf_id;
390 $_SESSION['behalf_name'] = ttUserHelper::getUserName($on_behalf_id);
392 header('Location: time.php');
398 $week_total = ttTimeHelper::getTimeForWeek($user->getActiveUser(), $selected_date);
400 $smarty->assign('selected_date', $selected_date);
401 $smarty->assign('week_total', $week_total);
402 $smarty->assign('day_total', ttTimeHelper::getTimeForDay($user->getActiveUser(), $cl_date));
403 $smarty->assign('time_records', ttTimeHelper::getRecords($user->getActiveUser(), $cl_date));
404 $smarty->assign('client_list', $client_list);
405 $smarty->assign('project_list', $project_list);
406 $smarty->assign('task_list', $task_list);
407 $smarty->assign('forms', array($form->getName()=>$form->toArray()));
408 $smarty->assign('onload', 'onLoad="fillDropdowns()"');
409 $smarty->assign('timestring', $selected_date->toString($user->date_format));
410 $smarty->assign('title', $i18n->get('title.time'));
411 $smarty->assign('content_page_name', 'time.tpl');
412 $smarty->display('index.tpl');