Improved comments.
[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('ttClientHelper');
37 import('ttTimeHelper');
38 import('DateAndTime');
39
40 // Access check.
41 if (!ttAccessCheck(right_data_entry)) {
42   header('Location: access_denied.php');
43   exit();
44 }
45
46 // Initialize and store date in session.
47 $cl_date = $request->getParameter('date', @$_SESSION['date']);
48 $selected_date = new DateAndTime(DB_DATEFORMAT, $cl_date);
49 if($selected_date->isError())
50   $selected_date = new DateAndTime(DB_DATEFORMAT);
51 if(!$cl_date)
52   $cl_date = $selected_date->toString(DB_DATEFORMAT);
53 $_SESSION['date'] = $cl_date;
54
55 // Determine selected week start and end dates.
56 $weekStartDay = $user->week_start;
57 $t_arr = localtime($selected_date->getTimestamp());
58 $t_arr[5] = $t_arr[5] + 1900;
59 if ($t_arr[6] < $weekStartDay)
60   $startWeekBias = $weekStartDay - 7;
61 else
62   $startWeekBias = $weekStartDay;
63 $startDate = new DateAndTime();
64 $startDate->setTimestamp(mktime(0,0,0,$t_arr[4]+1,$t_arr[3]-$t_arr[6]+$startWeekBias,$t_arr[5]));
65 $endDate = new DateAndTime();
66 $endDate->setTimestamp(mktime(0,0,0,$t_arr[4]+1,$t_arr[3]-$t_arr[6]+6+$startWeekBias,$t_arr[5]));
67 // The above is needed to set date range (timestring) in page title.
68
69 // Use custom fields plugin if it is enabled.
70 if ($user->isPluginEnabled('cf')) {
71   require_once('plugins/CustomFields.class.php');
72   $custom_fields = new CustomFields($user->team_id);
73   $smarty->assign('custom_fields', $custom_fields);
74 }
75
76 // Use Monthly Quotas plugin, if applicable.
77 if ($user->isPluginEnabled('mq')){
78   require_once('plugins/MonthlyQuota.class.php');
79   $quota = new MonthlyQuota();
80   $month_quota = $quota->get($selected_date->mYear, $selected_date->mMonth);
81   $month_total = ttTimeHelper::getTimeForMonth($user->getActiveUser(), $selected_date);
82   $minutes_left = ttTimeHelper::toMinutes($month_quota) - ttTimeHelper::toMinutes($month_total);
83
84   $smarty->assign('month_total', $month_total);
85   $smarty->assign('over_quota', $minutes_left < 0);
86   $smarty->assign('quota_remaining', ttTimeHelper::toAbsDuration($minutes_left));
87 }
88
89 // Initialize variables.
90 // Custom field.
91 $cl_cf_1 = trim($request->getParameter('cf_1', ($request->getMethod()=='POST'? null : @$_SESSION['cf_1'])));
92 $_SESSION['cf_1'] = $cl_cf_1;
93 $cl_billable = 1;
94 if ($user->isPluginEnabled('iv')) {
95   if ($request->isPost()) {
96     $cl_billable = $request->getParameter('billable');
97     $_SESSION['billable'] = (int) $cl_billable;
98   } else
99     if (isset($_SESSION['billable']))
100       $cl_billable = $_SESSION['billable'];
101 }
102 $on_behalf_id = $request->getParameter('onBehalfUser', (isset($_SESSION['behalf_id'])? $_SESSION['behalf_id'] : $user->id));
103 $cl_client = $request->getParameter('client', ($request->getMethod()=='POST'? null : @$_SESSION['client']));
104 $_SESSION['client'] = $cl_client;
105 $cl_project = $request->getParameter('project', ($request->getMethod()=='POST'? null : @$_SESSION['project']));
106 $_SESSION['project'] = $cl_project;
107 $cl_task = $request->getParameter('task', ($request->getMethod()=='POST'? null : @$_SESSION['task']));
108 $_SESSION['task'] = $cl_task;
109 $cl_note = trim($request->getParameter('note'));
110
111 // Get the data we need to display week view.
112 // Get column headers, which are day numbers in month.
113 $dayHeaders = ttTimeHelper::getDayHeadersForWeek($startDate->toString(DB_DATEFORMAT));
114 $lockedDays = ttTimeHelper::getLockedDaysForWeek($startDate->toString(DB_DATEFORMAT));
115 // Build data array for the table. Format is described in the function..
116 $dataArray = ttTimeHelper::getDataForWeekView($user->getActiveUser(), $startDate->toString(DB_DATEFORMAT), $endDate->toString(DB_DATEFORMAT), $dayHeaders);
117 // Build day totals (total durations for each day in week).
118 $dayTotals = ttTimeHelper::getDayTotals($dataArray, $dayHeaders);
119
120 // Define rendering class for a label field to the left of durations.
121 class LabelCellRenderer extends DefaultCellRenderer {
122   function render(&$table, $value, $row, $column, $selected = false) {
123     $this->setOptions(array('width'=>200,'valign'=>'middle'));
124     // Special handling for row 0, which represents a new week entry.
125     if (0 == $row) {
126       $this->setOptions(array('style'=>'text-align: center; font-weight: bold;'));
127     }
128     // Special handling for not billable entries.
129     if ($row > 0) {
130       $row_id = $table->getValueAtName($row,'row_id');
131       $billable = ttTimeHelper::parseFromWeekViewRow($row_id, 'bl');
132       if (!$billable) {
133         $this->setOptions(array('style'=>'color: red;')); // TODO: style it properly in CSS.
134       }
135     }
136     $this->setValue(htmlspecialchars($value)); // This escapes HTML for output.
137     return $this->toString();
138   }
139 }
140
141 // Define rendering class for a single cell for time entry in week view table.
142 class TimeCellRenderer extends DefaultCellRenderer {
143   function render(&$table, $value, $row, $column, $selected = false) {
144     $field_name = $table->getValueAt($row,$column)['control_id']; // Our text field names (and ids) are like x_y (row_column).
145     $field = new TextField($field_name);
146     // Disable control if the date is locked.
147     global $lockedDays;
148     if ($lockedDays[$column-1])
149       $field->setEnabled(false);
150     $field->setFormName($table->getFormName());
151     $field->setStyle('width: 60px;'); // TODO: need to style everything properly, eventually.
152     $field->setValue($table->getValueAt($row,$column)['duration']);
153     // Disable control when time entry mode is TYPE_START_FINISH and there is no value in control
154     // because we can't supply start and finish times in week view - there are no fields for them.
155     global $user;
156     if (!$field->getValue() && TYPE_START_FINISH == $user->record_type) {
157         $field->setEnabled(false);
158     }
159     $this->setValue($field->getHtml());
160     return $this->toString();
161   }
162 }
163
164 // Elements of weekTimeForm.
165 $form = new Form('weekTimeForm');
166
167 if ($user->canManageTeam()) {
168   $user_list = ttTeamHelper::getActiveUsers(array('putSelfFirst'=>true));
169   if (count($user_list) > 1) {
170     $form->addInput(array('type'=>'combobox',
171       'onchange'=>'this.form.submit();',
172       'name'=>'onBehalfUser',
173       'style'=>'width: 250px;',
174       'value'=>$on_behalf_id,
175       'data'=>$user_list,
176       'datakeys'=>array('id','name')));
177     $smarty->assign('on_behalf_control', 1);
178   }
179 }
180
181 // Create week_durations table.
182 $table = new Table('week_durations', 'week_view_table');
183 $table->setTableOptions(array('width'=>'100%','cellspacing'=>'1','cellpadding'=>'3','border'=>'0'));
184 $table->setRowOptions(array('class'=>'tableHeaderCentered'));
185 $table->setData($dataArray);
186 // Add columns to table.
187 $table->addColumn(new TableColumn('label', '', new LabelCellRenderer(), $dayTotals['label']));
188 for ($i = 0; $i < 7; $i++) {
189   $table->addColumn(new TableColumn($dayHeaders[$i], $dayHeaders[$i], new TimeCellRenderer(), $dayTotals[$dayHeaders[$i]]));
190 }
191 $table->setInteractive(false);
192 $form->addInputElement($table);
193
194 // Dropdown for clients in MODE_TIME. Use all active clients.
195 if (MODE_TIME == $user->tracking_mode && $user->isPluginEnabled('cl')) {
196   $active_clients = ttTeamHelper::getActiveClients($user->team_id, true);
197   $form->addInput(array('type'=>'combobox',
198     'onchange'=>'fillProjectDropdown(this.value);',
199     'name'=>'client',
200     'style'=>'width: 250px;',
201     'value'=>$cl_client,
202     'data'=>$active_clients,
203     'datakeys'=>array('id', 'name'),
204     'empty'=>array(''=>$i18n->getKey('dropdown.select'))));
205   // Note: in other modes the client list is filtered to relevant clients only. See below.
206 }
207
208 if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
209   // Dropdown for projects assigned to user.
210   $project_list = $user->getAssignedProjects();
211   $form->addInput(array('type'=>'combobox',
212     'onchange'=>'fillTaskDropdown(this.value);',
213     'name'=>'project',
214     'style'=>'width: 250px;',
215     'value'=>$cl_project,
216     'data'=>$project_list,
217     'datakeys'=>array('id','name'),
218     'empty'=>array(''=>$i18n->getKey('dropdown.select'))));
219
220   // Dropdown for clients if the clients plugin is enabled.
221   if ($user->isPluginEnabled('cl')) {
222     $active_clients = ttTeamHelper::getActiveClients($user->team_id, true);
223     // We need an array of assigned project ids to do some trimming.
224     foreach($project_list as $project)
225       $projects_assigned_to_user[] = $project['id'];
226
227     // Build a client list out of active clients. Use only clients that are relevant to user.
228     // Also trim their associated project list to only assigned projects (to user).
229     foreach($active_clients as $client) {
230       $projects_assigned_to_client = explode(',', $client['projects']);
231       if (is_array($projects_assigned_to_client) && is_array($projects_assigned_to_user))
232         $intersection = array_intersect($projects_assigned_to_client, $projects_assigned_to_user);
233       if ($intersection) {
234         $client['projects'] = implode(',', $intersection);
235         $client_list[] = $client;
236       }
237     }
238     $form->addInput(array('type'=>'combobox',
239       'onchange'=>'fillProjectDropdown(this.value);',
240       'name'=>'client',
241       'style'=>'width: 250px;',
242       'value'=>$cl_client,
243       'data'=>$client_list,
244       'datakeys'=>array('id', 'name'),
245       'empty'=>array(''=>$i18n->getKey('dropdown.select'))));
246   }
247 }
248
249 if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
250   $task_list = ttTeamHelper::getActiveTasks($user->team_id);
251   $form->addInput(array('type'=>'combobox',
252     'name'=>'task',
253     'style'=>'width: 250px;',
254     'value'=>$cl_task,
255     'data'=>$task_list,
256     'datakeys'=>array('id','name'),
257     'empty'=>array(''=>$i18n->getKey('dropdown.select'))));
258 }
259 $form->addInput(array('type'=>'textarea','name'=>'note','style'=>'width: 250px; height:'.NOTE_INPUT_HEIGHT.'px;','value'=>$cl_note));
260
261 // Add other controls.
262 $form->addInput(array('type'=>'calendar','name'=>'date','value'=>$cl_date)); // calendar
263 if ($user->isPluginEnabled('iv'))
264   $form->addInput(array('type'=>'checkbox','name'=>'billable','value'=>$cl_billable));
265 $form->addInput(array('type'=>'hidden','name'=>'browser_today','value'=>'get_date()')); // User current date, which gets filled in on btn_submit click.
266 $form->addInput(array('type'=>'submit','name'=>'btn_submit','onclick'=>'browser_today.value=get_date()','value'=>$i18n->getKey('button.submit')));
267
268 // If we have custom fields - add controls for them.
269 if ($custom_fields && $custom_fields->fields[0]) {
270   // Only one custom field is supported at this time.
271   if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT) {
272     $form->addInput(array('type'=>'text','name'=>'cf_1','value'=>$cl_cf_1));
273   } elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
274     $form->addInput(array('type'=>'combobox','name'=>'cf_1',
275       'style'=>'width: 250px;',
276       'value'=>$cl_cf_1,
277       'data'=>$custom_fields->options,
278       'empty'=>array(''=>$i18n->getKey('dropdown.select'))));
279   }
280 }
281
282 // Submit.
283 if ($request->isPost()) {
284   if ($request->getParameter('btn_submit')) {
285     // Validate user input for row 0.
286     // Determine if a new entry was posted.
287     $newEntryPosted = false;
288     foreach($dayHeaders as $dayHeader) {
289       $control_id = '0_'.$dayHeader;
290       if ($request->getParameter($control_id)) {
291         $newEntryPosted = true;
292         break;
293       }
294     }
295     if ($newEntryPosted) {
296       if ($user->isPluginEnabled('cl') && $user->isPluginEnabled('cm') && !$cl_client)
297         $err->add($i18n->getKey('error.client'));
298       if ($custom_fields) {
299         if (!ttValidString($cl_cf_1, !$custom_fields->fields[0]['required'])) $err->add($i18n->getKey('error.field'), $custom_fields->fields[0]['label']);
300       }
301       if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
302         if (!$cl_project) $err->add($i18n->getKey('error.project'));
303       }
304       if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode && $user->task_required) {
305         if (!$cl_task) $err->add($i18n->getKey('error.task'));
306       }
307     }
308
309     // Process the table of values.
310     if ($err->no()) {
311
312       // Obtain values. Iterate through posted parameters one by one,
313       // see if value changed, apply one change at a time until we see an error.
314       $result = true;
315       $rowNumber = 0;
316       // Iterate through existing rows.
317       foreach ($dataArray as $row) {
318         // Iterate through days.
319         foreach ($dayHeaders as $key => $dayHeader) {
320           // Do not process locked days.
321           if ($lockedDays[$key]) continue;
322           // Make control id for the cell.
323           $control_id = $rowNumber.'_'.$dayHeader;
324           // Optain existing and posted durations.
325           $postedDuration = $request->getParameter($control_id);
326           $existingDuration = $dataArray[$rowNumber][$dayHeader]['duration'];
327           // If posted value is not null, check and normalize it.
328           if ($postedDuration) {
329             if (ttTimeHelper::isValidDuration($postedDuration)) {
330               $postedDuration = ttTimeHelper::normalizeDuration($postedDuration, false); // No leading zero.
331             } else {
332               $err->add($i18n->getKey('error.field'), $i18n->getKey('label.duration'));
333               $result = false; break; // Break out. Stop any further processing.
334             }
335           }
336           // Do not process if value has not changed.
337           if ($postedDuration == $existingDuration)
338             continue;
339           // Posted value is different.
340           if ($existingDuration == null) {
341             // Skip inserting 0 duration values.
342             if (0 == ttTimeHelper::toMinutes($postedDuration))
343               continue;
344             // Insert a new record.
345             $fields = array();
346             $fields['row_id'] = $dataArray[$rowNumber]['row_id'];
347             if (!$fields['row_id']) {
348               // Special handling for row 0, a new entry. Need to construct new row_id.
349               $record = array();
350               $record['client_id'] = $cl_client;
351               $record['billable'] = $cl_billable ? '1' : '0';
352               $record['project_id'] = $cl_project;
353               $record['task_id'] = $cl_task;
354               $record['cf_1_value'] = $cl_cf_1;
355               $fields['row_id'] = ttTimeHelper::makeRecordIdentifier($record).'_0'; // TODO: Handle a possible conflict with already existing row...
356                                                                                     // We may have to increment the suffix here.
357               $fields['note'] = $cl_note;
358             }
359             $fields['day_header'] = $dayHeader;
360             $fields['start_date'] = $startDate->toString(DB_DATEFORMAT); // To be able to determine date for the entry using $dayHeader.
361             $fields['duration'] = $postedDuration;
362             $fields['browser_today'] = $request->getParameter('browser_today', null);
363             $result = ttTimeHelper::insertDurationFromWeekView($fields, $custom_fields, $err);
364           } elseif ($postedDuration == null || 0 == ttTimeHelper::toMinutes($postedDuration)) {
365             // Delete an already existing record here.
366             $result = ttTimeHelper::delete($dataArray[$rowNumber][$dayHeader]['tt_log_id'], $user->getActiveUser());
367           } else {
368             $fields = array();
369             $fields['tt_log_id'] = $dataArray[$rowNumber][$dayHeader]['tt_log_id'];
370             $fields['duration'] = $postedDuration;
371             $result = ttTimeHelper::modifyDurationFromWeekView($fields, $err);
372           }
373           if (!$result) break; // Break out of the loop in case of first error.
374         }
375         if (!$result) break; // Break out of the loop in case of first error.
376         $rowNumber++;
377       }
378       if ($result) {
379         header('Location: week.php'); // Normal exit.
380         exit();
381       }
382     }
383   }
384   elseif ($request->getParameter('onBehalfUser')) {
385     if($user->canManageTeam()) {
386       unset($_SESSION['behalf_id']);
387       unset($_SESSION['behalf_name']);
388
389       if($on_behalf_id != $user->id) {
390         $_SESSION['behalf_id'] = $on_behalf_id;
391         $_SESSION['behalf_name'] = ttUserHelper::getUserName($on_behalf_id);
392       }
393       header('Location: week.php');
394       exit();
395     }
396   }
397 } // isPost
398
399 $week_total = ttTimeHelper::getTimeForWeek($user->getActiveUser(), $selected_date);
400
401 $smarty->assign('selected_date', $selected_date);
402 $smarty->assign('week_total', $week_total);
403
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', $startDate->toString($user->date_format).' - '.$endDate->toString($user->date_format));
410
411 $smarty->assign('title', $i18n->getKey('title.time'));
412 $smarty->assign('content_page_name', 'week.tpl');
413 $smarty->display('index.tpl');