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