Refactoring white space
[timetracker.git] / mobile / time_edit.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('ttUserHelper');
32 import('ttTeamHelper');
33 import('ttClientHelper');
34 import('ttTimeHelper');
35 import('DateAndTime');
36
37 // Access check.
38 if (!ttAccessCheck(right_data_entry)) {
39   header('Location: access_denied.php');
40   exit();
41 }
42
43 // Use custom fields plugin if it is enabled.
44 if (in_array('cf', explode(',', $user->plugins))) {
45   require_once('../plugins/CustomFields.class.php');
46   $custom_fields = new CustomFields($user->team_id);
47   $smarty->assign('custom_fields', $custom_fields);
48 }
49
50 $cl_id = $request->getParameter('id');
51
52 // Get the time record we are editing.
53 $time_rec = ttTimeHelper::getRecord($cl_id, $user->getActiveUser());
54
55 // Prohibit editing invoiced records.
56 if ($time_rec['invoice_id']) die($i18n->getKey('error.sys'));
57
58 $item_date = new DateAndTime(DB_DATEFORMAT, $time_rec['date']);
59
60 // Initialize variables.
61 $cl_start = $cl_finish = $cl_duration = $cl_date = $cl_note = $cl_project = $cl_task = $cl_billable = null;
62 if ($request->getMethod() == 'POST') {
63   $cl_start = trim($request->getParameter('start'));
64   $cl_finish = trim($request->getParameter('finish'));
65   $cl_duration = trim($request->getParameter('duration'));
66   $cl_date = $request->getParameter('date');
67   $cl_note = trim($request->getParameter('note'));
68   $cl_cf_1 = trim($request->getParameter('cf_1'));
69   $cl_client = $request->getParameter('client');
70   $cl_project = $request->getParameter('project');
71   $cl_task = $request->getParameter('task');
72   $cl_billable = 1;
73   if (in_array('iv', explode(',', $user->plugins)))
74     $cl_billable = $request->getParameter('billable');
75 } else {
76   $cl_client = $time_rec['client_id'];
77   $cl_project = $time_rec['project_id'];
78   $cl_task = $time_rec['task_id'];
79   $cl_start = $time_rec['start'];
80   $cl_finish = $time_rec['finish'];
81   $cl_duration = $time_rec['duration'];
82   $cl_date = $item_date->toString($user->date_format);
83   $cl_note = $time_rec['comment'];
84
85   // If we have custom fields - obtain values for them.
86   if ($custom_fields) {
87     // Get custom field value for time record.
88     $fields = $custom_fields->get($time_rec['id']);
89     if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
90       $cl_cf_1 = $fields[0]['value'];
91     else if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
92       $cl_cf_1 = $fields[0]['option_id'];
93   }
94
95   $cl_billable = $time_rec['billable'];
96
97   // Add an info message to the form if we are editing an uncompleted record.
98   if (($cl_start == $cl_finish) && ($cl_duration == '0:00')) {
99     $cl_finish = '';
100     $cl_duration = '';
101     $messages->add($i18n->getKey('form.time_edit.uncompleted'));
102   }
103 }
104
105 // Initialize elements of 'timeRecordForm'.
106 $form = new Form('timeRecordForm');
107
108 // Dropdown for clients in MODE_TIME. Use all active clients.
109 if (MODE_TIME == $user->tracking_mode && in_array('cl', explode(',', $user->plugins))) {
110     $active_clients = ttTeamHelper::getActiveClients($user->team_id, true);
111     $form->addInput(array('type'=>'combobox',
112       'onchange'=>'fillProjectDropdown(this.value);',
113       'name'=>'client',
114       'style'=>'width: 250px;',
115       'value'=>$cl_client,
116       'data'=>$active_clients,
117       'datakeys'=>array('id', 'name'),
118       'empty'=>array(''=>$i18n->getKey('dropdown.select'))));
119   // Note: in other modes the client list is filtered to relevant clients only. See below.
120 }
121
122 if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
123   // Dropdown for projects assigned to user.
124   $project_list = $user->getAssignedProjects();
125   $form->addInput(array('type'=>'combobox',
126     'onchange'=>'fillTaskDropdown(this.value);',
127     'name'=>'project',
128     'style'=>'width: 250px;',
129     'value'=>$cl_project,
130     'data'=>$project_list,
131     'datakeys'=>array('id','name'),
132     'empty'=>array(''=>$i18n->getKey('dropdown.select'))));
133
134   // Dropdown for clients if the clients plugin is enabled.
135   if (in_array('cl', explode(',', $user->plugins))) {
136     $active_clients = ttTeamHelper::getActiveClients($user->team_id, true);
137     // We need an array of assigned project ids to do some trimming.
138     foreach($project_list as $project)
139       $projects_assigned_to_user[] = $project['id'];
140
141     // Build a client list out of active clients. Use only clients that are relevant to user.
142     // Also trim their associated project list to only assigned projects (to user).
143     foreach($active_clients as $client) {
144       $projects_assigned_to_client = explode(',', $client['projects']);
145       if (is_array($projects_assigned_to_client) && is_array($projects_assigned_to_user))
146         $intersection = array_intersect($projects_assigned_to_client, $projects_assigned_to_user);
147       if ($intersection) {
148         $client['projects'] = implode(',', $intersection);
149         $client_list[] = $client;
150       }
151     }
152     $form->addInput(array('type'=>'combobox',
153       'onchange'=>'fillProjectDropdown(this.value);',
154       'name'=>'client',
155       'style'=>'width: 250px;',
156       'value'=>$cl_client,
157       'data'=>$client_list,
158       'datakeys'=>array('id', 'name'),
159       'empty'=>array(''=>$i18n->getKey('dropdown.select'))));
160   }
161 }
162
163 if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
164   $task_list = ttTeamHelper::getActiveTasks($user->team_id);
165   $form->addInput(array('type'=>'combobox',
166     'name'=>'task',
167     'style'=>'width: 250px;',
168     'value'=>$cl_task,
169     'data'=>$task_list,
170     'datakeys'=>array('id','name'),
171     'empty'=>array(''=>$i18n->getKey('dropdown.select'))));
172 }
173
174 // Add other controls.
175 if ((TYPE_START_FINISH == $user->record_type) || (TYPE_ALL == $user->record_type)) {
176   $form->addInput(array('type'=>'text','name'=>'start','value'=>$cl_start,'onchange'=>"formDisable('start');"));
177   $form->addInput(array('type'=>'text','name'=>'finish','value'=>$cl_finish,'onchange'=>"formDisable('finish');"));
178 }
179 if (!$user->canManageTeam() && defined('READONLY_START_FINISH') && isTrue(READONLY_START_FINISH)) {
180   // Make the start and finish fields read-only.
181   $form->getElement('start')->setEnable(false);
182   $form->getElement('finish')->setEnable(false);
183 }
184 if ((TYPE_DURATION == $user->record_type) || (TYPE_ALL == $user->record_type))
185   $form->addInput(array('type'=>'text','name'=>'duration','value'=>$cl_duration,'onchange'=>"formDisable('duration');"));
186 $form->addInput(array('type'=>'datefield','name'=>'date','maxlength'=>'20','value'=>$cl_date));
187 $form->addInput(array('type'=>'textarea','name'=>'note','style'=>'width: 250px; height: 60px;','value'=>$cl_note));
188 // If we have custom fields - add controls for them.
189 if ($custom_fields && $custom_fields->fields[0]) {
190   // Only one custom field is supported at this time.
191   if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT) {
192     $form->addInput(array('type'=>'text','name'=>'cf_1','value'=>$cl_cf_1));
193   } else if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
194     $form->addInput(array('type'=>'combobox',
195       'name'=>'cf_1',
196       'style'=>'width: 250px;',
197       'value'=>$cl_cf_1,
198       'data'=>$custom_fields->options,
199       'empty' => array('' => $i18n->getKey('dropdown.select'))));
200   }
201 }
202 // Hidden control for record id.
203 $form->addInput(array('type'=>'hidden','name'=>'id','value'=>$cl_id));
204 if (in_array('iv', explode(',', $user->plugins)))
205   $form->addInput(array('type'=>'checkbox','name'=>'billable','data'=>1,'value'=>$cl_billable));
206 $form->addInput(array('type'=>'hidden','name'=>'browser_today','value'=>'')); // User current date, which gets filled in on btn_save click.
207 $form->addInput(array('type'=>'submit','name'=>'btn_save','onclick'=>'browser_today.value=get_date()','value'=>$i18n->getKey('button.save')));
208 $form->addInput(array('type'=>'submit','name'=>'btn_delete','value'=>$i18n->getKey('label.delete')));
209
210 if ($request->getMethod() == 'POST') {
211
212   // Validate user input.
213   if (in_array('cl', explode(',', $user->plugins)) && in_array('cm', explode(',', $user->plugins)) && !$cl_client)
214     $errors->add($i18n->getKey('error.client'));
215   if ($custom_fields) {
216     if (!ttValidString($cl_cf_1, !$custom_fields->fields[0]['required'])) $errors->add($i18n->getKey('error.field'), $custom_fields->fields[0]['label']);
217   }
218   if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
219     if (!$cl_project) $errors->add($i18n->getKey('error.project'));
220   }
221   if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
222     if (!$cl_task) $errors->add($i18n->getKey('error.task'));
223   }
224   if (!$cl_duration) {
225     if ('0' == $cl_duration)
226       $errors->add($i18n->getKey('error.field'), $i18n->getKey('label.duration'));
227     else if ($cl_start || $cl_finish) {
228       if (!ttTimeHelper::isValidTime($cl_start))
229         $errors->add($i18n->getKey('error.field'), $i18n->getKey('label.start'));
230       if ($cl_finish) {
231         if (!ttTimeHelper::isValidTime($cl_finish))
232           $errors->add($i18n->getKey('error.field'), $i18n->getKey('label.finish'));
233         if (!ttTimeHelper::isValidInterval($cl_start, $cl_finish))
234           $errors->add($i18n->getKey('error.interval'), $i18n->getKey('label.finish'), $i18n->getKey('label.start'));
235       }
236     } else {
237       if ((TYPE_START_FINISH == $user->record_type) || (TYPE_ALL == $user->record_type)) {
238         $errors->add($i18n->getKey('error.empty'), $i18n->getKey('label.start'));
239         $errors->add($i18n->getKey('error.empty'), $i18n->getKey('label.finish'));
240       }
241       if ((TYPE_DURATION == $user->record_type) || (TYPE_ALL == $user->record_type))
242         $errors->add($i18n->getKey('error.empty'), $i18n->getKey('label.duration'));
243     }
244   } else {
245     if (!ttTimeHelper::isValidDuration($cl_duration))
246       $errors->add($i18n->getKey('error.field'), $i18n->getKey('label.duration'));
247   }
248   if (!ttValidDate($cl_date)) $errors->add($i18n->getKey('error.field'), $i18n->getKey('label.date'));
249   if (!ttValidString($cl_note, true)) $errors->add($i18n->getKey('error.field'), $i18n->getKey('label.note'));
250   // Finished validating user input.
251
252   // Determine lock date.
253   $lock_interval = $user->lock_interval;
254   $lockdate = 0;
255   if ($lock_interval > 0) {
256     $lockdate = new DateAndTime();
257     $lockdate->decDay($lock_interval);
258   }
259
260   // This is a new date for the time record.
261   $new_date = new DateAndTime($user->date_format, $cl_date);
262
263   // Prohibit creating entries in future.
264   if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES)) {
265     $browser_today = new DateAndTime(DB_DATEFORMAT, $request->getParameter('browser_today', null));
266     if ($new_date->after($browser_today))
267       $errors->add($i18n->getKey('error.future_date'));
268   }
269
270   // Save record.
271   if ($request->getParameter('btn_save')) {
272     // We need to:
273     // 1) Prohibit saving locked time entries in any form.
274     // 2) Prohibit saving completed unlocked entries into locked interval.
275     // 3) Prohibit saving uncompleted unlocked entries when another uncompleted entry exists.
276
277     // Now, step by step.
278     if ($errors->isEmpty()) {
279       // 1) Prohibit saving locked time entries in any form.
280       if($lockdate && $item_date->before($lockdate))
281         $errors->add($i18n->getKey('error.period_locked'));
282       // 2) Prohibit saving completed unlocked entries into locked interval.
283       if($errors->isEmpty() && $lockdate && $new_date->before($lockdate))
284         $errors->add($i18n->getKey('error.period_locked'));
285       // 3) Prohibit saving uncompleted unlocked entries when another uncompleted entry exists.
286       $uncompleted = ($cl_finish == '' && $cl_duration == '');
287       if ($uncompleted) {
288         $not_completed_rec = ttTimeHelper::getUncompleted($user->getActiveUser());
289         if ($not_completed_rec && ($time_rec['id'] <> $not_completed_rec['id'])) {
290           // We have another not completed record.
291           $errors->add($i18n->getKey('error.uncompleted_exists')." <a href = 'time_edit.php?id=".$not_completed_rec['id']."'>".$i18n->getKey('error.goto_uncompleted')."</a>");
292         }
293       }
294     }
295
296     // Prohibit creating an overlapping record.
297     if ($errors->isEmpty()) {
298       if (ttTimeHelper::overlaps($user->getActiveUser(), $new_date->toString(DB_DATEFORMAT), $cl_start, $cl_finish, $cl_id))
299         $errors->add($i18n->getKey('error.overlap'));
300     }
301
302     // Now, an update.
303     if ($errors->isEmpty()) {
304       $res = ttTimeHelper::update(array(
305           'id'=>$cl_id,  
306           'date'=>$new_date->toString(DB_DATEFORMAT),
307           'user_id'=>$user->getActiveUser(),
308           'client'=>$cl_client,
309           'project'=>$cl_project,
310           'task'=>$cl_task,
311           'start'=>$cl_start,
312           'finish'=>$cl_finish,
313           'duration'=>$cl_duration,
314           'note'=>$cl_note,
315           'billable'=>$cl_billable));
316
317       // If we have custom fields - update values.
318       if ($res && $custom_fields) {
319         if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
320           $res = $custom_fields->update($cl_id, $custom_fields->fields[0]['id'], null, $cl_cf_1);
321         else if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
322           $res = $custom_fields->update($cl_id, $custom_fields->fields[0]['id'], $cl_cf_1, null);
323       }
324       if ($res)
325       {
326         header('Location: time.php?date='.$new_date->toString(DB_DATEFORMAT));
327         exit();
328       }
329     }
330   }
331
332   if ($request->getParameter('btn_delete')) {
333     header("Location: time_delete.php?id=$cl_id");
334     exit();
335   }
336 } // POST
337
338 $smarty->assign('client_list', $client_list);
339 $smarty->assign('project_list', $project_list);
340 $smarty->assign('task_list', $task_list);
341 $smarty->assign('forms', array($form->getName()=>$form->toArray()));
342 $smarty->assign('onload', 'onLoad="fillDropdowns()"');
343 $smarty->assign('title', $i18n->getKey('title.edit_time_record'));
344 $smarty->assign('content_page_name', 'mobile/time_edit.tpl');
345 $smarty->display('mobile/index.tpl');