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     ));
 120   // Note: in other modes the client list is filtered to relevant clients only. See below.
 121 }
 122
 123 if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
 124   // Dropdown for projects assigned to user.
 125   $project_list = $user->getAssignedProjects();
 126   $form->addInput(array('type'=>'combobox',
 127     'onchange'=>'fillTaskDropdown(this.value);',
 128     'name'=>'project',
 129     'style'=>'width: 250px;',
 130     'value'=>$cl_project,
 131     'data'=>$project_list,
 132     'datakeys'=>array('id','name'),
 133     'empty'=>array(''=>$i18n->getKey('dropdown.select'))
 134   ));
 135
 136   // Dropdown for clients if the clients plugin is enabled.
 137   if (in_array('cl', explode(',', $user->plugins))) {
 138     $active_clients = ttTeamHelper::getActiveClients($user->team_id, true);
 139     // We need an array of assigned project ids to do some trimming.
 140     foreach($project_list as $project)
 141       $projects_assigned_to_user[] = $project['id'];
 142
 143     // Build a client list out of active clients. Use only clients that are relevant to user.
 144     // Also trim their associated project list to only assigned projects (to user).
 145     foreach($active_clients as $client) {
 146       $projects_assigned_to_client = explode(',', $client['projects']);
 147       if (is_array($projects_assigned_to_client) && is_array($projects_assigned_to_user))
 148         $intersection = array_intersect($projects_assigned_to_client, $projects_assigned_to_user);
 149       if ($intersection) {
 150         $client['projects'] = implode(',', $intersection);
 151         $client_list[] = $client;
 152       }
 153     }
 154     $form->addInput(array('type'=>'combobox',
 155       'onchange'=>'fillProjectDropdown(this.value);',
 156       'name'=>'client',
 157       'style'=>'width: 250px;',
 158       'value'=>$cl_client,
 159       'data'=>$client_list,
 160       'datakeys'=>array('id', 'name'),
 161       'empty'=>array(''=>$i18n->getKey('dropdown.select'))
 162     ));
 163   }
 164 }
 165
 166 if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
 167   $task_list = ttTeamHelper::getActiveTasks($user->team_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->getKey('dropdown.select'))
 175   ));
 176 }
 177
 178 // Add other controls.
 179 if ((TYPE_START_FINISH == $user->record_type) || (TYPE_ALL == $user->record_type)) {
 180   $form->addInput(array('type'=>'text','name'=>'start','value'=>$cl_start,'onchange'=>"formDisable('start');"));
 181   $form->addInput(array('type'=>'text','name'=>'finish','value'=>$cl_finish,'onchange'=>"formDisable('finish');"));
 182 }
 183 if (!$user->canManageTeam() && defined('READONLY_START_FINISH') && isTrue(READONLY_START_FINISH)) {
 184   // Make the start and finish fields read-only.
 185   $form->getElement('start')->setEnable(false);
 186   $form->getElement('finish')->setEnable(false);
 187 }
 188 if ((TYPE_DURATION == $user->record_type) || (TYPE_ALL == $user->record_type))
 189   $form->addInput(array('type'=>'text','name'=>'duration','value'=>$cl_duration,'onchange'=>"formDisable('duration');"));
 190 $form->addInput(array('type'=>'datefield','name'=>'date','maxlength'=>'20','value'=>$cl_date));
 191 $form->addInput(array('type'=>'textarea','name'=>'note','style'=>'width: 250px; height: 200px;','value'=>$cl_note));
 192 // If we have custom fields - add controls for them.
 193 if ($custom_fields && $custom_fields->fields[0]) {
 194   // Only one custom field is supported at this time.
 195   if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT) {
 196         $form->addInput(array('type'=>'text','name'=>'cf_1','value'=>$cl_cf_1));
 197   } else if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
 198     $form->addInput(array('type'=>'combobox',
 199       'name'=>'cf_1',
 200       'style'=>'width: 250px;',
 201       'value'=>$cl_cf_1,
 202       'data'=>$custom_fields->options,
 203       'empty' => array('' => $i18n->getKey('dropdown.select'))
 204     ));
 205   }
 206 }
 207 // Hidden control for record id.
 208 $form->addInput(array('type'=>'hidden','name'=>'id','value'=>$cl_id));
 209 if (in_array('iv', explode(',', $user->plugins)))
 210   $form->addInput(array('type'=>'checkbox','name'=>'billable','data'=>1,'value'=>$cl_billable));
 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->getKey('button.save')));
 213 $form->addInput(array('type'=>'submit','name'=>'btn_copy','onclick'=>'browser_today.value=get_date()','value'=>$i18n->getKey('button.copy')));
 214 $form->addInput(array('type'=>'submit','name'=>'btn_delete','value'=>$i18n->getKey('label.delete')));
 215
 216 if ($request->getMethod() == 'POST') {
 217
 218   // Validate user input.
 219   if (in_array('cl', explode(',', $user->plugins)) && in_array('cm', explode(',', $user->plugins)) && !$cl_client)
 220     $errors->add($i18n->getKey('error.client'));
 221   if ($custom_fields) {
 222     if (!ttValidString($cl_cf_1, !$custom_fields->fields[0]['required'])) $errors->add($i18n->getKey('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) $errors->add($i18n->getKey('error.project'));
 226   }
 227   if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
 228     if (!$cl_task) $errors->add($i18n->getKey('error.task'));
 229   }
 230   if (!$cl_duration) {
 231     if ('0' == $cl_duration)
 232       $errors->add($i18n->getKey('error.field'), $i18n->getKey('label.duration'));
 233     else if ($cl_start || $cl_finish) {
 234       if (!ttTimeHelper::isValidTime($cl_start))
 235         $errors->add($i18n->getKey('error.field'), $i18n->getKey('label.start'));
 236       if ($cl_finish) {
 237         if (!ttTimeHelper::isValidTime($cl_finish))
 238           $errors->add($i18n->getKey('error.field'), $i18n->getKey('label.finish'));
 239         if (!ttTimeHelper::isValidInterval($cl_start, $cl_finish))
 240           $errors->add($i18n->getKey('error.interval'), $i18n->getKey('label.finish'), $i18n->getKey('label.start'));
 241       }
 242     } else {
 243       if ((TYPE_START_FINISH == $user->record_type) || (TYPE_ALL == $user->record_type)) {
 244         $errors->add($i18n->getKey('error.empty'), $i18n->getKey('label.start'));
 245         $errors->add($i18n->getKey('error.empty'), $i18n->getKey('label.finish'));
 246       }
 247       if ((TYPE_DURATION == $user->record_type) || (TYPE_ALL == $user->record_type))
 248         $errors->add($i18n->getKey('error.empty'), $i18n->getKey('label.duration'));
 249     }
 250   } else {
 251     if (!ttTimeHelper::isValidDuration($cl_duration))
 252       $errors->add($i18n->getKey('error.field'), $i18n->getKey('label.duration'));
 253   }
 254   if (!ttValidDate($cl_date)) $errors->add($i18n->getKey('error.field'), $i18n->getKey('label.date'));
 255   if (!ttValidString($cl_note, true)) $errors->add($i18n->getKey('error.field'), $i18n->getKey('label.note'));
 256   // Finished validating user input.
 257
 258   // Determine lock date.
 259   $lock_interval = $user->lock_interval;
 260   $lockdate = 0;
 261   if ($lock_interval > 0) {
 262     $lockdate = new DateAndTime();
 263     $lockdate->decDay($lock_interval);
 264   }
 265
 266   // This is a new date for the time record.
 267   $new_date = new DateAndTime($user->date_format, $cl_date);
 268
 269   // Prohibit creating entries in future.
 270   if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES)) {
 271     $browser_today = new DateAndTime(DB_DATEFORMAT, $request->getParameter('browser_today', null));
 272     if ($new_date->after($browser_today))
 273       $errors->add($i18n->getKey('error.future_date'));
 274   }
 275
 276   // Save record.
 277   if ($request->getParameter('btn_save')) {
 278     // We need to:
 279     // 1) Prohibit saving locked time entries in any form.
 280     // 2) Prohibit saving completed unlocked entries into locked interval.
 281     // 3) Prohibit saving uncompleted unlocked entries when another uncompleted entry exists.
 282
 283     // Now, step by step.
 284     if ($errors->isEmpty()) {
 285       // 1) Prohibit saving locked time entries in any form.
 286       if($lockdate && $item_date->before($lockdate))
 287         $errors->add($i18n->getKey('error.period_locked'));
 288       // 2) Prohibit saving completed unlocked entries into locked interval.
 289       if($errors->isEmpty() && $lockdate && $new_date->before($lockdate))
 290         $errors->add($i18n->getKey('error.period_locked'));
 291       // 3) Prohibit saving uncompleted unlocked entries when another uncompleted entry exists.
 292       $uncompleted = ($cl_finish == '' && $cl_duration == '');
 293       if ($uncompleted) {
 294         $not_completed_rec = ttTimeHelper::getUncompleted($user->getActiveUser());
 295         if ($not_completed_rec && ($time_rec['id'] <> $not_completed_rec['id'])) {
 296           // We have another not completed record.
 297           $errors->add($i18n->getKey('error.uncompleted_exists')." <a href = 'time_edit.php?id=".$not_completed_rec['id']."'>".$i18n->getKey('error.goto_uncompleted')."</a>");
 298         }
 299       }
 300     }
 301
 302     // Prohibit creating an overlapping record.
 303     if ($errors->isEmpty()) {
 304       if (ttTimeHelper::overlaps($user->getActiveUser(), $new_date->toString(DB_DATEFORMAT), $cl_start, $cl_finish, $cl_id))
 305         $errors->add($i18n->getKey('error.overlap'));
 306     }
 307
 308     // Now, an update.
 309     if ($errors->isEmpty()) {
 310       $res = ttTimeHelper::update(array(
 311           'id'=>$cl_id,
 312           'date'=>$new_date->toString(DB_DATEFORMAT),
 313           'user_id'=>$user->getActiveUser(),
 314           'client'=>$cl_client,
 315           'project'=>$cl_project,
 316           'task'=>$cl_task,
 317           'start'=>$cl_start,
 318           'finish'=>$cl_finish,
 319           'duration'=>$cl_duration,
 320           'note'=>$cl_note,
 321           'billable'=>$cl_billable));
 322
 323       // If we have custom fields - update values.
 324       if ($res && $custom_fields) {
 325         if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
 326           $res = $custom_fields->update($cl_id, $custom_fields->fields[0]['id'], null, $cl_cf_1);
 327         else if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
 328           $res = $custom_fields->update($cl_id, $custom_fields->fields[0]['id'], $cl_cf_1, null);
 329       }
 330       if ($res)
 331       {
 332         header('Location: time.php?date='.$new_date->toString(DB_DATEFORMAT));
 333         exit();
 334       }
 335     }
 336   }
 337
 338   // Save as new record.
 339   if ($request->getParameter('btn_copy')) {
 340     // We need to:
 341     // 1) Prohibit saving into locked interval.
 342     // 2) Prohibit saving uncompleted unlocked entries when another uncompleted entry exists.
 343
 344     // Now, step by step.
 345     if ($errors->isEmpty()) {
 346       // 1) Prohibit saving into locked interval.
 347       if($lockdate && $new_date->before($lockdate))
 348         $errors->add($i18n->getKey('error.period_locked'));
 349       // 2) Prohibit saving uncompleted unlocked entries when another uncompleted entry exists.
 350       $uncompleted = ($cl_finish == '' && $cl_duration == '');
 351       if ($uncompleted) {
 352         $not_completed_rec = ttTimeHelper::getUncompleted($user->getActiveUser());
 353         if ($not_completed_rec) {
 354           // We have another not completed record.
 355           $errors->add($i18n->getKey('error.uncompleted_exists')." <a href = 'time_edit.php?id=".$not_completed_rec['id']."'>".$i18n->getKey('error.goto_uncompleted')."</a>");
 356         }
 357       }
 358     }
 359
 360     // Prohibit creating an overlapping record.
 361     if ($errors->isEmpty()) {
 362       if (ttTimeHelper::overlaps($user->getActiveUser(), $new_date->toString(DB_DATEFORMAT), $cl_start, $cl_finish))
 363         $errors->add($i18n->getKey('error.overlap'));
 364     }
 365
 366     // Now, a new insert.
 367     if ($errors->isEmpty()) {
 368
 369       $id = ttTimeHelper::insert(array(
 370         'date'=>$new_date->toString(DB_DATEFORMAT),
 371         'user_id'=>$user->getActiveUser(),
 372         'client'=>$cl_client,
 373         'project'=>$cl_project,
 374         'task'=>$cl_task,
 375         'start'=>$cl_start,
 376         'finish'=>$cl_finish,
 377         'duration'=>$cl_duration,
 378         'note'=>$cl_note,
 379         'billable'=>$cl_billable));
 380
 381       // Insert a custom field if we have it.
 382       $res = true;
 383       if ($id && $custom_fields && $cl_cf_1) {
 384         if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
 385           $res = $custom_fields->insert($id, $custom_fields->fields[0]['id'], null, $cl_cf_1);
 386         else if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
 387           $res = $custom_fields->insert($id, $custom_fields->fields[0]['id'], $cl_cf_1, null);
 388       }
 389       if ($id && $res) {
 390         header('Location: time.php?date='.$new_date->toString(DB_DATEFORMAT));
 391         exit();
 392       }
 393       $errors->add($i18n->getKey('error.db'));
 394     }
 395   }
 396
 397   if ($request->getParameter('btn_delete')) {
 398     header("Location: time_delete.php?id=$cl_id");
 399     exit();
 400   }
 401 } // End of if ($request->getMethod() == "POST")
 402
 403 $smarty->assign('client_list', $client_list);
 404 $smarty->assign('project_list', $project_list);
 405 $smarty->assign('task_list', $task_list);
 406 $smarty->assign('forms', array($form->getName()=>$form->toArray()));
 407 $smarty->assign('onload', 'onLoad="fillDropdowns()"');
 408 $smarty->assign('title', $i18n->getKey('title.edit_time_record'));
 409 $smarty->assign('content_page_name', 'time_edit.tpl');
 410 $smarty->display('index.tpl');