Refactoring: renamed getActiveUser() to getUser().
[timetracker.git] / 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 checks.
38 if (!(ttAccessAllowed('track_own_time') || ttAccessAllowed('track_time'))) {
39   header('Location: access_denied.php');
40   exit();
41 }
42 $cl_id = (int)$request->getParameter('id');
43 $time_rec = ttTimeHelper::getRecord($cl_id, $user->getUser());
44 if (!$time_rec || $time_rec['invoice_id']) {
45   // Prohibit editing not ours or invoiced records.
46   header('Location: access_denied.php');
47   exit();
48 }
49 // End of access checks.
50
51 // Use custom fields plugin if it is enabled.
52 if ($user->isPluginEnabled('cf')) {
53   require_once('plugins/CustomFields.class.php');
54   $custom_fields = new CustomFields($user->group_id);
55   $smarty->assign('custom_fields', $custom_fields);
56 }
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->isPost()) {
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 ($user->isPluginEnabled('iv'))
74     $cl_billable = $request->getParameter('billable');
75   if ($user->isPluginEnabled('ps'))
76     $cl_paid = $request->getParameter('paid');
77 } else {
78   $cl_client = $time_rec['client_id'];
79   $cl_project = $time_rec['project_id'];
80   $cl_task = $time_rec['task_id'];
81   $cl_start = $time_rec['start'];
82   $cl_finish = $time_rec['finish'];
83   $cl_duration = $time_rec['duration'];
84   $cl_date = $item_date->toString($user->date_format);
85   $cl_note = $time_rec['comment'];
86
87   // If we have custom fields - obtain values for them.
88   if ($custom_fields) {
89     // Get custom field value for time record.
90     $fields = $custom_fields->get($time_rec['id']);
91     if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
92       $cl_cf_1 = $fields[0]['value'];
93     elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
94       $cl_cf_1 = $fields[0]['option_id'];
95   }
96
97   $cl_billable = $time_rec['billable'];
98   $cl_paid = $time_rec['paid'];
99
100   // Add an info message to the form if we are editing an uncompleted record.
101   if (strlen($cl_start) > 0 && $cl_start == $cl_finish && $cl_duration == '0:00') {
102     $cl_finish = '';
103     $cl_duration = '';
104     $msg->add($i18n->get('form.time_edit.uncompleted'));
105   }
106 }
107
108 // Initialize elements of 'timeRecordForm'.
109 $form = new Form('timeRecordForm');
110
111 // Dropdown for clients in MODE_TIME. Use all active clients.
112 if (MODE_TIME == $user->tracking_mode && $user->isPluginEnabled('cl')) {
113   $active_clients = ttTeamHelper::getActiveClients($user->group_id, true);
114   $form->addInput(array('type'=>'combobox',
115     'onchange'=>'fillProjectDropdown(this.value);',
116     'name'=>'client',
117     'style'=>'width: 250px;',
118     'value'=>$cl_client,
119     'data'=>$active_clients,
120     'datakeys'=>array('id', 'name'),
121     'empty'=>array(''=>$i18n->get('dropdown.select'))));
122   // Note: in other modes the client list is filtered to relevant clients only. See below.
123 }
124
125 if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
126   // Dropdown for projects assigned to user.
127   $project_list = $user->getAssignedProjects();
128   $form->addInput(array('type'=>'combobox',
129     'onchange'=>'fillTaskDropdown(this.value);',
130     'name'=>'project',
131     'style'=>'width: 250px;',
132     'value'=>$cl_project,
133     'data'=>$project_list,
134     'datakeys'=>array('id','name'),
135     'empty'=>array(''=>$i18n->get('dropdown.select'))));
136
137   // Dropdown for clients if the clients plugin is enabled.
138   if ($user->isPluginEnabled('cl')) {
139     $active_clients = ttTeamHelper::getActiveClients($user->group_id, true);
140     // We need an array of assigned project ids to do some trimming.
141     foreach($project_list as $project)
142       $projects_assigned_to_user[] = $project['id'];
143
144     // Build a client list out of active clients. Use only clients that are relevant to user.
145     // Also trim their associated project list to only assigned projects (to user).
146     foreach($active_clients as $client) {
147       $projects_assigned_to_client = explode(',', $client['projects']);
148       if (is_array($projects_assigned_to_client) && is_array($projects_assigned_to_user))
149         $intersection = array_intersect($projects_assigned_to_client, $projects_assigned_to_user);
150       if ($intersection) {
151         $client['projects'] = implode(',', $intersection);
152         $client_list[] = $client;
153       }
154     }
155     $form->addInput(array('type'=>'combobox',
156       'onchange'=>'fillProjectDropdown(this.value);',
157       'name'=>'client',
158       'style'=>'width: 250px;',
159       'value'=>$cl_client,
160       'data'=>$client_list,
161       'datakeys'=>array('id', 'name'),
162       'empty'=>array(''=>$i18n->get('dropdown.select'))));
163   }
164 }
165
166 if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
167   $task_list = ttTeamHelper::getActiveTasks($user->group_id);
168   $form->addInput(array('type'=>'combobox',
169     'name'=>'task',
170     'style'=>'width: 250px;',
171     'value'=>$cl_task,
172     'data'=>$task_list,
173     'datakeys'=>array('id','name'),
174     'empty'=>array(''=>$i18n->get('dropdown.select'))));
175 }
176
177 // Add other controls.
178 if ((TYPE_START_FINISH == $user->record_type) || (TYPE_ALL == $user->record_type)) {
179   $form->addInput(array('type'=>'text','name'=>'start','value'=>$cl_start,'onchange'=>"formDisable('start');"));
180   $form->addInput(array('type'=>'text','name'=>'finish','value'=>$cl_finish,'onchange'=>"formDisable('finish');"));
181   if ($user->punch_mode && !$user->canOverridePunchMode()) {
182     // Make the start and finish fields read-only.
183     $form->getElement('start')->setEnabled(false);
184     $form->getElement('finish')->setEnabled(false);
185   }
186 }
187 if ((TYPE_DURATION == $user->record_type) || (TYPE_ALL == $user->record_type))
188   $form->addInput(array('type'=>'text','name'=>'duration','value'=>$cl_duration,'onchange'=>"formDisable('duration');"));
189 $form->addInput(array('type'=>'datefield','name'=>'date','maxlength'=>'20','value'=>$cl_date));
190 $form->addInput(array('type'=>'textarea','name'=>'note','style'=>'width: 250px; height: 200px;','value'=>$cl_note));
191 // If we have custom fields - add controls for them.
192 if ($custom_fields && $custom_fields->fields[0]) {
193   // Only one custom field is supported at this time.
194   if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT) {
195     $form->addInput(array('type'=>'text','name'=>'cf_1','value'=>$cl_cf_1));
196   } elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
197     $form->addInput(array('type'=>'combobox',
198       'name'=>'cf_1',
199       'style'=>'width: 250px;',
200       'value'=>$cl_cf_1,
201       'data'=>$custom_fields->options,
202       'empty' => array('' => $i18n->get('dropdown.select'))));
203   }
204 }
205 // Hidden control for record id.
206 $form->addInput(array('type'=>'hidden','name'=>'id','value'=>$cl_id));
207 if ($user->isPluginEnabled('iv'))
208   $form->addInput(array('type'=>'checkbox','name'=>'billable','value'=>$cl_billable));
209 if ($user->can('manage_invoices') && $user->isPluginEnabled('ps'))
210   $form->addInput(array('type'=>'checkbox','name'=>'paid','value'=>$cl_paid));
211 $form->addInput(array('type'=>'hidden','name'=>'browser_today','value'=>'')); // User current date, which gets filled in on btn_save or btn_copy click.
212 $form->addInput(array('type'=>'submit','name'=>'btn_save','onclick'=>'browser_today.value=get_date()','value'=>$i18n->get('button.save')));
213 $form->addInput(array('type'=>'submit','name'=>'btn_copy','onclick'=>'browser_today.value=get_date()','value'=>$i18n->get('button.copy')));
214 $form->addInput(array('type'=>'submit','name'=>'btn_delete','value'=>$i18n->get('label.delete')));
215
216 if ($request->isPost()) {
217
218   // Validate user input.
219   if ($user->isPluginEnabled('cl') && $user->isPluginEnabled('cm') && !$cl_client)
220     $err->add($i18n->get('error.client'));
221   if ($custom_fields) {
222     if (!ttValidString($cl_cf_1, !$custom_fields->fields[0]['required'])) $err->add($i18n->get('error.field'), $custom_fields->fields[0]['label']);
223   }
224   if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
225     if (!$cl_project) $err->add($i18n->get('error.project'));
226   }
227   if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode && $user->task_required) {
228     if (!$cl_task) $err->add($i18n->get('error.task'));
229   }
230   if (!$cl_duration) {
231     if ('0' == $cl_duration)
232       $err->add($i18n->get('error.field'), $i18n->get('label.duration'));
233     elseif ($cl_start || $cl_finish) {
234       if (!ttTimeHelper::isValidTime($cl_start))
235         $err->add($i18n->get('error.field'), $i18n->get('label.start'));
236       if ($cl_finish) {
237         if (!ttTimeHelper::isValidTime($cl_finish))
238           $err->add($i18n->get('error.field'), $i18n->get('label.finish'));
239         if (!ttTimeHelper::isValidInterval($cl_start, $cl_finish))
240           $err->add($i18n->get('error.interval'), $i18n->get('label.finish'), $i18n->get('label.start'));
241       }
242     } else {
243       if ((TYPE_START_FINISH == $user->record_type) || (TYPE_ALL == $user->record_type)) {
244         $err->add($i18n->get('error.empty'), $i18n->get('label.start'));
245         $err->add($i18n->get('error.empty'), $i18n->get('label.finish'));
246       }
247       if ((TYPE_DURATION == $user->record_type) || (TYPE_ALL == $user->record_type))
248         $err->add($i18n->get('error.empty'), $i18n->get('label.duration'));
249     }
250   } else {
251     if (false === ttTimeHelper::postedDurationToMinutes($cl_duration))
252       $err->add($i18n->get('error.field'), $i18n->get('label.duration'));
253   }
254   if (!ttValidDate($cl_date)) $err->add($i18n->get('error.field'), $i18n->get('label.date'));
255   if (!ttValidString($cl_note, true)) $err->add($i18n->get('error.field'), $i18n->get('label.note'));
256   // Finished validating user input.
257
258   // This is a new date for the time record.
259   $new_date = new DateAndTime($user->date_format, $cl_date);
260
261   // Prohibit creating entries in future.
262   if (!$user->future_entries) {
263     $browser_today = new DateAndTime(DB_DATEFORMAT, $request->getParameter('browser_today', null));
264     if ($new_date->after($browser_today))
265       $err->add($i18n->get('error.future_date'));
266   }
267
268   // Save record.
269   if ($request->getParameter('btn_save')) {
270     // We need to:
271     // 1) Prohibit saving locked time entries in any form.
272     // 2) Prohibit saving completed unlocked entries into locked interval.
273     // 3) Prohibit saving uncompleted unlocked entries when another uncompleted entry exists.
274
275     // Now, step by step.
276     if ($err->no()) {
277       // 1) Prohibit saving locked entries in any form.
278       if ($user->isDateLocked($item_date))
279         $err->add($i18n->get('error.range_locked'));
280
281       // 2) Prohibit saving completed unlocked entries into locked range.
282       if ($err->no() && $user->isDateLocked($new_date))
283         $err->add($i18n->get('error.range_locked'));
284
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->getUser());
289         if ($not_completed_rec && ($time_rec['id'] <> $not_completed_rec['id'])) {
290           // We have another not completed record.
291           $err->add($i18n->get('error.uncompleted_exists')." <a href = 'time_edit.php?id=".$not_completed_rec['id']."'>".$i18n->get('error.goto_uncompleted')."</a>");
292         }
293       }
294     }
295
296     // Prohibit creating an overlapping record.
297     if ($err->no()) {
298       if (ttTimeHelper::overlaps($user->getUser(), $new_date->toString(DB_DATEFORMAT), $cl_start, $cl_finish, $cl_id))
299         $err->add($i18n->get('error.overlap'));
300     }
301
302     // Now, an update.
303     if ($err->no()) {
304       $res = ttTimeHelper::update(array(
305         'id'=>$cl_id,
306         'date'=>$new_date->toString(DB_DATEFORMAT),
307         'user_id'=>$user->getUser(),
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         'paid'=>$cl_paid));
317
318       // If we have custom fields - update values.
319       if ($res && $custom_fields) {
320         if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
321           $res = $custom_fields->update($cl_id, $custom_fields->fields[0]['id'], null, $cl_cf_1);
322         elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
323           $res = $custom_fields->update($cl_id, $custom_fields->fields[0]['id'], $cl_cf_1, null);
324       }
325       if ($res)
326       {
327         header('Location: time.php?date='.$new_date->toString(DB_DATEFORMAT));
328         exit();
329       }
330     }
331   }
332
333   // Save as new record.
334   if ($request->getParameter('btn_copy')) {
335     // We need to:
336     // 1) Prohibit saving into locked range.
337     // 2) Prohibit saving uncompleted unlocked entries when another uncompleted entry exists.
338
339     // Now, step by step.
340     if ($err->no()) {
341       // 1) Prohibit saving into locked range.
342       if ($user->isDateLocked($new_date))
343         $err->add($i18n->get('error.range_locked'));
344
345       // 2) Prohibit saving uncompleted unlocked entries when another uncompleted entry exists.
346       $uncompleted = ($cl_finish == '' && $cl_duration == '');
347       if ($uncompleted) {
348         $not_completed_rec = ttTimeHelper::getUncompleted($user->getUser());
349         if ($not_completed_rec) {
350           // We have another not completed record.
351           $err->add($i18n->get('error.uncompleted_exists')." <a href = 'time_edit.php?id=".$not_completed_rec['id']."'>".$i18n->get('error.goto_uncompleted')."</a>");
352         }
353       }
354     }
355
356     // Prohibit creating an overlapping record.
357     if ($err->no()) {
358       if (ttTimeHelper::overlaps($user->getUser(), $new_date->toString(DB_DATEFORMAT), $cl_start, $cl_finish))
359         $err->add($i18n->get('error.overlap'));
360     }
361
362     // Now, a new insert.
363     if ($err->no()) {
364
365       $id = ttTimeHelper::insert(array(
366         'date'=>$new_date->toString(DB_DATEFORMAT),
367         'user_id'=>$user->getUser(),
368         'group_id'=>$user->getGroup(),
369         'org_id' => $user->org_id,
370         'client'=>$cl_client,
371         'project'=>$cl_project,
372         'task'=>$cl_task,
373         'start'=>$cl_start,
374         'finish'=>$cl_finish,
375         'duration'=>$cl_duration,
376         'note'=>$cl_note,
377         'billable'=>$cl_billable,
378         'paid'=>$cl_paid));
379
380       // Insert a custom field if we have it.
381       $res = true;
382       if ($id && $custom_fields && $cl_cf_1) {
383         if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
384           $res = $custom_fields->insert($id, $custom_fields->fields[0]['id'], null, $cl_cf_1);
385         elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
386           $res = $custom_fields->insert($id, $custom_fields->fields[0]['id'], $cl_cf_1, null);
387       }
388       if ($id && $res) {
389         header('Location: time.php?date='.$new_date->toString(DB_DATEFORMAT));
390         exit();
391       }
392       $err->add($i18n->get('error.db'));
393     }
394   }
395
396   if ($request->getParameter('btn_delete')) {
397     header("Location: time_delete.php?id=$cl_id");
398     exit();
399   }
400 } // isPost
401
402 $smarty->assign('client_list', $client_list);
403 $smarty->assign('project_list', $project_list);
404 $smarty->assign('task_list', $task_list);
405 $smarty->assign('forms', array($form->getName()=>$form->toArray()));
406 $smarty->assign('onload', 'onLoad="fillDropdowns()"');
407 $smarty->assign('title', $i18n->get('title.edit_time_record'));
408 $smarty->assign('content_page_name', 'time_edit.tpl');
409 $smarty->display('index.tpl');