Improved population of on behalf dropdowns on week view and expenses pages.
[timetracker.git] / week.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 require_once('initialize.php');
30 import('form.Form');
31 import('form.DefaultCellRenderer');
32 import('form.Table');
33 import('form.TextField');
34 import('ttUserHelper');
35 import('ttTeamHelper');
36 import('ttWeekViewHelper');
37 import('ttClientHelper');
38 import('ttTimeHelper');
39 import('DateAndTime');
40
41 // Access checks.
42 if (!(ttAccessAllowed('track_own_time') || ttAccessAllowed('track_time'))) {
43   header('Location: access_denied.php');
44   exit();
45 }
46 if (!$user->isPluginEnabled('wv')) {
47   header('Location: feature_disabled.php');
48   exit();
49 }
50 if ($user->behalf_id && (!$user->can('track_time') || !$user->checkBehalfId())) {
51   header('Location: access_denied.php'); // Trying on behalf, but no right or wrong user.
52   exit();
53 }
54 if (!$user->behalf_id && !$user->can('track_own_time') && !$user->adjustBehalfId()) {
55   header('Location: access_denied.php'); // Trying as self, but no right for self, and noone to work on behalf.
56   exit();
57 }
58
59 // Initialize and store date in session.
60 $cl_date = $request->getParameter('date', @$_SESSION['date']);
61 $selected_date = new DateAndTime(DB_DATEFORMAT, $cl_date);
62 if($selected_date->isError())
63   $selected_date = new DateAndTime(DB_DATEFORMAT);
64 if(!$cl_date)
65   $cl_date = $selected_date->toString(DB_DATEFORMAT);
66 $_SESSION['date'] = $cl_date;
67
68 // Determine selected week start and end dates.
69 $weekStartDay = $user->week_start;
70 $t_arr = localtime($selected_date->getTimestamp());
71 $t_arr[5] = $t_arr[5] + 1900;
72 if ($t_arr[6] < $weekStartDay)
73   $startWeekBias = $weekStartDay - 7;
74 else
75   $startWeekBias = $weekStartDay;
76 $startDate = new DateAndTime();
77 $startDate->setTimestamp(mktime(0,0,0,$t_arr[4]+1,$t_arr[3]-$t_arr[6]+$startWeekBias,$t_arr[5]));
78 $endDate = new DateAndTime();
79 $endDate->setTimestamp(mktime(0,0,0,$t_arr[4]+1,$t_arr[3]-$t_arr[6]+6+$startWeekBias,$t_arr[5]));
80 // The above is needed to set date range (timestring) in page title.
81
82 // Use custom fields plugin if it is enabled.
83 if ($user->isPluginEnabled('cf')) {
84   require_once('plugins/CustomFields.class.php');
85   $custom_fields = new CustomFields($user->team_id);
86   $smarty->assign('custom_fields', $custom_fields);
87 }
88
89 // Use Monthly Quotas plugin, if applicable.
90 if ($user->isPluginEnabled('mq')){
91   require_once('plugins/MonthlyQuota.class.php');
92   $quota = new MonthlyQuota();
93   $month_quota = $quota->get($selected_date->mYear, $selected_date->mMonth);
94   $month_total = ttTimeHelper::getTimeForMonth($user->getActiveUser(), $selected_date);
95   $minutes_left = round(60*$month_quota) - ttTimeHelper::toMinutes($month_total);
96
97   $smarty->assign('month_total', $month_total);
98   $smarty->assign('over_quota', $minutes_left < 0);
99   $smarty->assign('quota_remaining', ttTimeHelper::toAbsDuration($minutes_left));
100 }
101
102 // Initialize variables.
103 // Custom field.
104 $cl_cf_1 = trim($request->getParameter('cf_1', ($request->isPost() ? null : @$_SESSION['cf_1'])));
105 $_SESSION['cf_1'] = $cl_cf_1;
106 $cl_billable = 1;
107 if ($user->isPluginEnabled('iv')) {
108   if ($request->isPost()) {
109     $cl_billable = $request->getParameter('billable');
110     $_SESSION['billable'] = (int) $cl_billable;
111   } else
112     if (isset($_SESSION['billable']))
113       $cl_billable = $_SESSION['billable'];
114 }
115 $on_behalf_id = $request->getParameter('onBehalfUser', (isset($_SESSION['behalf_id'])? $_SESSION['behalf_id'] : $user->id));
116 $cl_client = $request->getParameter('client', ($request->isPost() ? null : @$_SESSION['client']));
117 $_SESSION['client'] = $cl_client;
118 $cl_project = $request->getParameter('project', ($request->isPost() ? null : @$_SESSION['project']));
119 $_SESSION['project'] = $cl_project;
120 $cl_task = $request->getParameter('task', ($request->isPost() ? null : @$_SESSION['task']));
121 $_SESSION['task'] = $cl_task;
122 $cl_note = $request->getParameter('note', ($request->isPost() ? null : @$_SESSION['note']));
123 $_SESSION['note'] = $cl_note;
124
125 // Get the data we need to display week view.
126 // Get column headers, which are day numbers in month.
127 $dayHeaders = ttWeekViewHelper::getDayHeadersForWeek($startDate->toString(DB_DATEFORMAT));
128 $lockedDays = ttWeekViewHelper::getLockedDaysForWeek($startDate->toString(DB_DATEFORMAT));
129 // Get already existing records.
130 $records = ttWeekViewHelper::getRecordsForInterval($user->getActiveUser(), $startDate->toString(DB_DATEFORMAT), $endDate->toString(DB_DATEFORMAT));
131 // Build data array for the table. Format is described in ttWeekViewHelper::getDataForWeekView function.
132 if ($records)
133   $dataArray = ttWeekViewHelper::getDataForWeekView($records, $dayHeaders);
134 else
135   $dataArray = ttWeekViewHelper::prePopulateFromPastWeeks($startDate->toString(DB_DATEFORMAT), $dayHeaders);
136
137 // Build day totals (total durations for each day in week).
138 $dayTotals = ttWeekViewHelper::getDayTotals($dataArray, $dayHeaders);
139
140 // Define rendering class for a label field to the left of durations.
141 class LabelCellRenderer extends DefaultCellRenderer {
142   function render(&$table, $value, $row, $column, $selected = false) {
143     global $user;
144
145     $this->setOptions(array('width'=>200,'valign'=>'middle'));
146
147     // Special handling for a new week entry (row 0, or 0 and 1 if we show notes).
148     if (0 == $row) {
149       $this->setOptions(array('style'=>'text-align: center; font-weight: bold; vertical-align: top;'));
150     } else if ($user->isPluginEnabled('wvns') && (1 == $row)) {
151       $this->setOptions(array('style'=>'text-align: right; vertical-align: top;'));
152     } else if ($user->isPluginEnabled('wvns') && (0 != $row % 2)) {
153       $this->setOptions(array('style'=>'text-align: right;'));
154     }
155     // Special handling for not billable entries.
156     $ignoreRow = $user->isPluginEnabled('wvns') ? 1 : 0; 
157     if ($row > $ignoreRow) {
158       $row_id = $table->getValueAtName($row,'row_id');
159       $billable = ttWeekViewHelper::parseFromWeekViewRow($row_id, 'bl');
160       if (!$billable) {
161         if (($user->isPluginEnabled('wvns') && (0 == $row % 2)) || !$user->isPluginEnabled('wvns')) {
162           $this->setOptions(array('style'=>'color: red;')); // TODO: style it properly in CSS.
163         }
164       }
165     }
166     $this->setValue(htmlspecialchars($value)); // This escapes HTML for output.
167     return $this->toString();
168   }
169 }
170
171 // Define rendering class for a single cell for a time or a comment entry in week view table.
172 class WeekViewCellRenderer extends DefaultCellRenderer {
173   function render(&$table, $value, $row, $column, $selected = false) {
174     global $user;
175
176     $field_name = $table->getValueAt($row,$column)['control_id']; // Our text field names (and ids) are like x_y (row_column).
177     $field = new TextField($field_name);
178     // Disable control if the date is locked.
179     global $lockedDays;
180     if ($lockedDays[$column-1])
181       $field->setEnabled(false);
182     $field->setFormName($table->getFormName());
183     $field->setStyle('width: 60px;'); // TODO: need to style everything properly, eventually.
184     // Provide visual separation for new entry row.
185     $rowToSeparate = $user->isPluginEnabled('wvns') ? 1 : 0;
186     if ($rowToSeparate == $row) {
187       $field->setStyle('width: 60px; margin-bottom: 40px');
188     }
189     if ($user->isPluginEnabled('wvns')) {
190       if (0 == $row % 2) {
191         $field->setValue($table->getValueAt($row,$column)['duration']); // Duration for even rows.
192       } else {
193         $field->setValue($table->getValueAt($row,$column)['note']);     // Comment for odd rows.
194         $field->setTitle($table->getValueAt($row,$column)['note']);     // Tooltip to help view the entire comment.
195       }
196     } else {
197       $field->setValue($table->getValueAt($row,$column)['duration']);
198       // $field->setTitle($table->getValueAt($row,$column)['note']); // Tooltip to see comment. TODO - value not available.
199     }
200     // Disable control when time entry mode is TYPE_START_FINISH and there is no value in control
201     // because we can't supply start and finish times in week view - there are no fields for them.
202     if (!$field->getValue() && TYPE_START_FINISH == $user->record_type) {
203         $field->setEnabled(false);
204     }
205     $this->setValue($field->getHtml());
206     return $this->toString();
207   }
208 }
209
210 // Elements of weekTimeForm.
211 $form = new Form('weekTimeForm');
212
213 if ($user->can('track_time')) {
214   if ($user->can('track_own_time'))
215     $options = array('status'=>ACTIVE,'max_rank'=>$user->rank-1,'include_self'=>true,'self_first'=>true);
216   else
217     $options = array('status'=>ACTIVE,'max_rank'=>$user->rank-1);
218   $user_list = $user->getUsers($options);
219   if (count($user_list) >= 1) {
220     $form->addInput(array('type'=>'combobox',
221       'onchange'=>'this.form.submit();',
222       'name'=>'onBehalfUser',
223       'style'=>'width: 250px;',
224       'value'=>$on_behalf_id,
225       'data'=>$user_list,
226       'datakeys'=>array('id','name')));
227     $smarty->assign('on_behalf_control', 1);
228   }
229 }
230
231 // Create week_durations table.
232 $table = new Table('week_durations', 'week_view_table');
233 $table->setTableOptions(array('width'=>'100%','cellspacing'=>'1','cellpadding'=>'3','border'=>'0'));
234 $table->setRowOptions(array('class'=>'tableHeaderCentered'));
235 $table->setData($dataArray);
236 // Add columns to table.
237 $table->addColumn(new TableColumn('label', '', new LabelCellRenderer(), $dayTotals['label']));
238 for ($i = 0; $i < 7; $i++) {
239   $table->addColumn(new TableColumn($dayHeaders[$i], $dayHeaders[$i], new WeekViewCellRenderer(), $dayTotals[$dayHeaders[$i]]));
240 }
241 $table->setInteractive(false);
242 $form->addInputElement($table);
243
244 // Dropdown for clients in MODE_TIME. Use all active clients.
245 if (MODE_TIME == $user->tracking_mode && $user->isPluginEnabled('cl')) {
246   $active_clients = ttTeamHelper::getActiveClients($user->team_id, true);
247   $form->addInput(array('type'=>'combobox',
248     'onchange'=>'fillProjectDropdown(this.value);',
249     'name'=>'client',
250     'style'=>'width: 250px;',
251     'value'=>$cl_client,
252     'data'=>$active_clients,
253     'datakeys'=>array('id', 'name'),
254     'empty'=>array(''=>$i18n->get('dropdown.select'))));
255   // Note: in other modes the client list is filtered to relevant clients only. See below.
256 }
257
258 if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
259   // Dropdown for projects assigned to user.
260   $project_list = $user->getAssignedProjects();
261   $form->addInput(array('type'=>'combobox',
262     'onchange'=>'fillTaskDropdown(this.value);',
263     'name'=>'project',
264     'style'=>'width: 250px;',
265     'value'=>$cl_project,
266     'data'=>$project_list,
267     'datakeys'=>array('id','name'),
268     'empty'=>array(''=>$i18n->get('dropdown.select'))));
269
270   // Dropdown for clients if the clients plugin is enabled.
271   if ($user->isPluginEnabled('cl')) {
272     $active_clients = ttTeamHelper::getActiveClients($user->team_id, true);
273     // We need an array of assigned project ids to do some trimming.
274     foreach($project_list as $project)
275       $projects_assigned_to_user[] = $project['id'];
276
277     // Build a client list out of active clients. Use only clients that are relevant to user.
278     // Also trim their associated project list to only assigned projects (to user).
279     foreach($active_clients as $client) {
280       $projects_assigned_to_client = explode(',', $client['projects']);
281       if (is_array($projects_assigned_to_client) && is_array($projects_assigned_to_user))
282         $intersection = array_intersect($projects_assigned_to_client, $projects_assigned_to_user);
283       if ($intersection) {
284         $client['projects'] = implode(',', $intersection);
285         $client_list[] = $client;
286       }
287     }
288     $form->addInput(array('type'=>'combobox',
289       'onchange'=>'fillProjectDropdown(this.value);',
290       'name'=>'client',
291       'style'=>'width: 250px;',
292       'value'=>$cl_client,
293       'data'=>$client_list,
294       'datakeys'=>array('id', 'name'),
295       'empty'=>array(''=>$i18n->get('dropdown.select'))));
296   }
297 }
298
299 if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
300   $task_list = ttTeamHelper::getActiveTasks($user->team_id);
301   $form->addInput(array('type'=>'combobox',
302     'name'=>'task',
303     'style'=>'width: 250px;',
304     'value'=>$cl_task,
305     'data'=>$task_list,
306     'datakeys'=>array('id','name'),
307     'empty'=>array(''=>$i18n->get('dropdown.select'))));
308 }
309 if (!defined('NOTE_INPUT_HEIGHT'))
310   define('NOTE_INPUT_HEIGHT', 40);
311 $form->addInput(array('type'=>'textarea','name'=>'note','style'=>'width: 250px; height:'.NOTE_INPUT_HEIGHT.'px;','value'=>$cl_note));
312
313 // Add other controls.
314 $form->addInput(array('type'=>'calendar','name'=>'date','value'=>$cl_date)); // calendar
315 if ($user->isPluginEnabled('iv'))
316   $form->addInput(array('type'=>'checkbox','name'=>'billable','value'=>$cl_billable));
317 $form->addInput(array('type'=>'hidden','name'=>'browser_today','value'=>'get_date()')); // User current date, which gets filled in on btn_submit click.
318 $form->addInput(array('type'=>'submit','name'=>'btn_submit','onclick'=>'browser_today.value=get_date()','value'=>$i18n->get('button.submit')));
319
320 // If we have custom fields - add controls for them.
321 if ($custom_fields && $custom_fields->fields[0]) {
322   // Only one custom field is supported at this time.
323   if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT) {
324     $form->addInput(array('type'=>'text','name'=>'cf_1','value'=>$cl_cf_1));
325   } elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
326     $form->addInput(array('type'=>'combobox','name'=>'cf_1',
327       'style'=>'width: 250px;',
328       'value'=>$cl_cf_1,
329       'data'=>$custom_fields->options,
330       'empty'=>array(''=>$i18n->get('dropdown.select'))));
331   }
332 }
333
334 // Submit.
335 if ($request->isPost()) {
336   if ($request->getParameter('btn_submit')) {
337     // Validate user input for row 0.
338     // Determine if a new entry was posted.
339     $newEntryPosted = false;
340     foreach($dayHeaders as $dayHeader) {
341       $control_id = '0_'.$dayHeader;
342       if ($request->getParameter($control_id)) {
343         $newEntryPosted = true;
344         break;
345       }
346     }
347     if ($newEntryPosted) {
348       if ($user->isPluginEnabled('cl') && $user->isPluginEnabled('cm') && !$cl_client)
349         $err->add($i18n->get('error.client'));
350       if ($custom_fields) {
351         if (!ttValidString($cl_cf_1, !$custom_fields->fields[0]['required'])) $err->add($i18n->get('error.field'), $custom_fields->fields[0]['label']);
352       }
353       if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
354         if (!$cl_project) $err->add($i18n->get('error.project'));
355       }
356       if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode && $user->task_required) {
357         if (!$cl_task) $err->add($i18n->get('error.task'));
358       }
359     }
360     // Finished validating user input for row 0.
361
362     // Process the table of values.
363     if ($err->no()) {
364
365       // Obtain values. Iterate through posted parameters one by one,
366       // see if value changed, apply one change at a time until we see an error.
367       $result = true;
368       $rowNumber = 0;
369       // Iterate through existing rows.
370       foreach ($dataArray as $row) {
371         // Iterate through days.
372         foreach ($dayHeaders as $key => $dayHeader) {
373           // Do not process locked days.
374           if ($lockedDays[$key]) continue;
375           // Make control id for the cell.
376           $control_id = $rowNumber.'_'.$dayHeader;
377
378           // Handle durations and comments in separate blocks of code.
379           if (!$user->isPluginEnabled('wvns') || (0 == $rowNumber % 2)) {
380             // Handle durations row here.
381
382             // Obtain existing and posted durations.
383             $postedDuration = $request->getParameter($control_id);
384             $existingDuration = $dataArray[$rowNumber][$dayHeader]['duration'];
385             // If posted value is not null, check and normalize it.
386             if ($postedDuration) {
387               if (false === ttTimeHelper::postedDurationToMinutes($postedDuration)) {
388                 $err->add($i18n->get('error.field'), $i18n->get('label.duration'));
389                 $result = false; break; // Break out. Stop any further processing.
390               } else {
391                 $minutes = ttTimeHelper::postedDurationToMinutes($postedDuration);
392                 $postedDuration = ttTimeHelper::minutesToDuration($minutes);
393               }
394             }
395             // Do not process if value has not changed.
396             if ($postedDuration == $existingDuration)
397               continue;
398             // Posted value is different.
399             if ($existingDuration == null) {
400               // Skip inserting 0 duration values.
401               if (0 == ttTimeHelper::toMinutes($postedDuration))
402                 continue;
403               // Insert a new record.
404               $fields = array();
405               $fields['row_id'] = $dataArray[$rowNumber]['row_id'];
406               if (!$fields['row_id']) {
407                 // Special handling for row 0, a new entry. Need to construct new row_id.
408                 $record = array();
409                 $record['client_id'] = $cl_client;
410                 $record['billable'] = $cl_billable ? '1' : '0';
411                 $record['project_id'] = $cl_project;
412                 $record['task_id'] = $cl_task;
413                 $record['cf_1_value'] = $cl_cf_1;
414                 $fields['row_id'] = ttWeekViewHelper::makeRowIdentifier($record).'_0';
415                 // Note: no need to check for a possible conflict with an already existing row
416                 // because we are doing an insert that does not affect already existing data.
417
418                 if ($user->isPluginEnabled('wvn')) {
419                   $fields['note'] = $request->getParameter('note');
420                 }
421               }
422               $fields['day_header'] = $dayHeader;
423               $fields['start_date'] = $startDate->toString(DB_DATEFORMAT); // To be able to determine date for the entry using $dayHeader.
424               $fields['duration'] = $postedDuration;
425               $fields['browser_today'] = $request->getParameter('browser_today', null);
426               if ($user->isPluginEnabled('wvns')) {
427                 // Take note value from the control below duration.
428                 $noteRowNumber = $rowNumber + 1;
429                 $note_control_id =  $noteRowNumber.'_'.$dayHeader;
430                 $fields['note'] = $request->getParameter($note_control_id);
431               }
432               $result = ttWeekViewHelper::insertDurationFromWeekView($fields, $custom_fields, $err);
433             } elseif ($postedDuration == null || 0 == ttTimeHelper::toMinutes($postedDuration)) {
434               // Delete an already existing record here.
435               $result = ttTimeHelper::delete($dataArray[$rowNumber][$dayHeader]['tt_log_id'], $user->getActiveUser());
436             } else {
437               $fields = array();
438               $fields['tt_log_id'] = $dataArray[$rowNumber][$dayHeader]['tt_log_id'];
439               $fields['duration'] = $postedDuration;
440               $result = ttWeekViewHelper::modifyDurationFromWeekView($fields, $err);
441             }
442             if (!$result) break; // Break out of the loop in case of first error.
443
444           } else if ($user->isPluginEnabled('wvns')) {
445             // Handle commments row here.
446
447             // Obtain existing and posted comments.
448             $postedComment = $request->getParameter($control_id);
449             $existingComment = $dataArray[$rowNumber][$dayHeader]['note'];
450             // If posted value is not null, check it.
451             if ($postedComment && !ttValidString($postedComment, true)) {
452               $err->add($i18n->get('error.field'), $i18n->get('label.note'));
453               $result = false; break; // Break out. Stop any further processing.
454             }
455             // Do not process if value has not changed.
456             if ($postedComment == $existingComment)
457               continue;
458
459             // Posted value is different.
460             // TODO: handle new entries separately in the durations block above.
461
462             // Here, only update the comment on an already existing record.
463             $fields = array();
464             $fields['tt_log_id'] = $dataArray[$rowNumber][$dayHeader]['tt_log_id'];
465             if ($fields['tt_log_id']) {
466               $fields['comment'] = $postedComment;
467               $result = ttWeekViewHelper::modifyCommentFromWeekView($fields);
468             }
469             if (!$result) break; // Break out of the loop in case of first error.
470           }
471         }
472         if (!$result) break; // Break out of the loop in case of first error.
473         $rowNumber++;
474       }
475       if ($result) {
476         header('Location: week.php'); // Normal exit.
477         exit();
478       }
479     }
480   }
481   elseif ($request->getParameter('onBehalfUser')) {
482     if($user->can('track_time')) {
483       unset($_SESSION['behalf_id']);
484       unset($_SESSION['behalf_name']);
485
486       if($on_behalf_id != $user->id) {
487         $_SESSION['behalf_id'] = $on_behalf_id;
488         $_SESSION['behalf_name'] = ttUserHelper::getUserName($on_behalf_id);
489       }
490       header('Location: week.php');
491       exit();
492     }
493   }
494 } // isPost
495
496 $week_total = ttTimeHelper::getTimeForWeek($user->getActiveUser(), $selected_date);
497
498 $smarty->assign('selected_date', $selected_date);
499 $smarty->assign('week_total', $week_total);
500
501 $smarty->assign('client_list', $client_list);
502 $smarty->assign('project_list', $project_list);
503 $smarty->assign('task_list', $task_list);
504 $smarty->assign('forms', array($form->getName()=>$form->toArray()));
505 $smarty->assign('onload', 'onLoad="fillDropdowns()"');
506 $smarty->assign('timestring', $startDate->toString($user->date_format).' - '.$endDate->toString($user->date_format));
507 $smarty->assign('time_records', $records);
508
509 $smarty->assign('title', $i18n->get('title.time'));
510 $smarty->assign('content_page_name', 'week.tpl');
511 $smarty->display('index.tpl');