time.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 if ($user->behalf_id && (!$user->can('track_time') || !$user->checkBehalfId())) {
  43   header('Location: access_denied.php'); // Trying on behalf, but no right or wrong user.
  44   exit();
  45 }
  46 if (!$user->behalf_id && !$user->can('track_own_time') && !$user->adjustBehalfId()) {
  47   header('Location: access_denied.php'); // Trying as self, but no right for self, and noone to work on behalf.
  48   exit();
  49 }
  50 if ($request->isPost()) {
  51   $userChanged = $request->getParameter('user_changed'); // Reused in multiple places below.
  52   if ($userChanged && !($user->can('track_time') && $user->isUserValid($request->getParameter('user')))) {
  53     header('Location: access_denied.php'); // Group changed, but no rght or wrong user id.
  54     exit();
  55   }
  56 }
  57 // End of access checks.
  58
  59 // Determine user for which we display this page.
  60 if ($request->isPost() && $userChanged) {
  61   $user_id = $request->getParameter('user');
  62   $user->setOnBehalfUser($user_id);
  63 } else {
  64   $user_id = $user->getUser();
  65 }
  66
  67 $group_id = $user->getGroup();
  68
  69 // Initialize and store date in session.
  70 $cl_date = $request->getParameter('date', @$_SESSION['date']);
  71 $selected_date = new DateAndTime(DB_DATEFORMAT, $cl_date);
  72 if($selected_date->isError())
  73   $selected_date = new DateAndTime(DB_DATEFORMAT);
  74 if(!$cl_date)
  75   $cl_date = $selected_date->toString(DB_DATEFORMAT);
  76 $_SESSION['date'] = $cl_date;
  77
  78 // Use custom fields plugin if it is enabled.
  79 if ($user->isPluginEnabled('cf')) {
  80   require_once('plugins/CustomFields.class.php');
  81   $custom_fields = new CustomFields();
  82   $smarty->assign('custom_fields', $custom_fields);
  83 }
  84
  85 if ($user->isPluginEnabled('mq')){
  86   require_once('plugins/MonthlyQuota.class.php');
  87   $quota = new MonthlyQuota();
  88   $month_quota_minutes = $quota->getUserQuota($selected_date->mYear, $selected_date->mMonth);
  89   $quota_minutes_from_1st = $quota->getUserQuotaFrom1st($selected_date);
  90   $month_total = ttTimeHelper::getTimeForMonth($selected_date);
  91   $month_total_minutes = ttTimeHelper::toMinutes($month_total);
  92   $balance_left = $quota_minutes_from_1st - $month_total_minutes;
  93   $minutes_left = $month_quota_minutes - $month_total_minutes;
  94
  95   $smarty->assign('month_total', $month_total);
  96   $smarty->assign('over_balance', $balance_left < 0);
  97   $smarty->assign('balance_remaining', ttTimeHelper::toAbsDuration($balance_left));
  98   $smarty->assign('over_quota', $minutes_left < 0);
  99   $smarty->assign('quota_remaining', ttTimeHelper::toAbsDuration($minutes_left));
 100 }
 101
 102 // Initialize variables.
 103 $cl_start = trim($request->getParameter('start'));
 104 $cl_finish = trim($request->getParameter('finish'));
 105 $cl_duration = trim($request->getParameter('duration'));
 106 $cl_note = trim($request->getParameter('note'));
 107 // Custom field.
 108 $cl_cf_1 = trim($request->getParameter('cf_1', ($request->isPost() ? null : @$_SESSION['cf_1'])));
 109 $_SESSION['cf_1'] = $cl_cf_1;
 110 $cl_billable = 1;
 111 if ($user->isPluginEnabled('iv')) {
 112   if ($request->isPost()) {
 113     $cl_billable = $request->getParameter('billable');
 114     $_SESSION['billable'] = (int) $cl_billable;
 115   } else
 116     if (isset($_SESSION['billable']))
 117       $cl_billable = $_SESSION['billable'];
 118 }
 119 //$on_behalf_id = $request->getParameter('onBehalfUser', (isset($_SESSION['behalf_id'])? $_SESSION['behalf_id'] : $user->id));
 120 //$on_behalf_group_id = $request->getParameter('onBehalfGroup', (isset($_SESSION['behalf_group_id'])? $_SESSION['behalf_group_id'] : $user->group_id));
 121 $cl_client = $request->getParameter('client', ($request->isPost() ? null : @$_SESSION['client']));
 122 $_SESSION['client'] = $cl_client;
 123 $cl_project = $request->getParameter('project', ($request->isPost() ? null : @$_SESSION['project']));
 124 $_SESSION['project'] = $cl_project;
 125 $cl_task = $request->getParameter('task', ($request->isPost() ? null : @$_SESSION['task']));
 126 $_SESSION['task'] = $cl_task;
 127
 128 // Elements of timeRecordForm.
 129 $form = new Form('timeRecordForm');
 130 if ($user->can('track_time')) {
 131   $rank = $user->getMaxRankForGroup($group_id);
 132   if ($user->can('track_own_time'))
 133     $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>$rank,'include_self'=>true,'self_first'=>true);
 134   else
 135     $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>$rank);
 136   $user_list = $user->getUsers($options);
 137   if (count($user_list) >= 1) {
 138     $form->addInput(array('type'=>'combobox',
 139       'onchange'=>'document.timeRecordForm.user_changed.value=1;document.timeRecordForm.submit();',
 140       'name'=>'user',
 141       'style'=>'width: 250px;',
 142       'value'=>$user_id,
 143       'data'=>$user_list,
 144       'datakeys'=>array('id','name')));
 145     $form->addInput(array('type'=>'hidden','name'=>'user_changed'));
 146     $smarty->assign('user_dropdown', 1);
 147   }
 148 }
 149
 150 // Dropdown for clients in MODE_TIME. Use all active clients.
 151 if (MODE_TIME == $user->getTrackingMode() && $user->isPluginEnabled('cl')) {
 152   $active_clients = ttGroupHelper::getActiveClients(true);
 153   $form->addInput(array('type'=>'combobox',
 154     'onchange'=>'fillProjectDropdown(this.value);',
 155     'name'=>'client',
 156     'style'=>'width: 250px;',
 157     'value'=>$cl_client,
 158     'data'=>$active_clients,
 159     'datakeys'=>array('id', 'name'),
 160     'empty'=>array(''=>$i18n->get('dropdown.select'))));
 161   // Note: in other modes the client list is filtered to relevant clients only. See below.
 162 }
 163
 164 if (MODE_PROJECTS == $user->getTrackingMode() || MODE_PROJECTS_AND_TASKS == $user->getTrackingMode()) {
 165   // Dropdown for projects assigned to user.
 166   $project_list = $user->getAssignedProjects();
 167   $form->addInput(array('type'=>'combobox',
 168     'onchange'=>'fillTaskDropdown(this.value);',
 169     'name'=>'project',
 170     'style'=>'width: 250px;',
 171     'value'=>$cl_project,
 172     'data'=>$project_list,
 173     'datakeys'=>array('id','name'),
 174     'empty'=>array(''=>$i18n->get('dropdown.select'))));
 175
 176   // Dropdown for clients if the clients plugin is enabled.
 177   if ($user->isPluginEnabled('cl')) {
 178     $active_clients = ttGroupHelper::getActiveClients(true);
 179     // We need an array of assigned project ids to do some trimming.
 180     foreach($project_list as $project)
 181       $projects_assigned_to_user[] = $project['id'];
 182
 183     // Build a client list out of active clients. Use only clients that are relevant to user.
 184     // Also trim their associated project list to only assigned projects (to user).
 185     foreach($active_clients as $client) {
 186       $projects_assigned_to_client = explode(',', $client['projects']);
 187       if (is_array($projects_assigned_to_client) && is_array($projects_assigned_to_user))
 188         $intersection = array_intersect($projects_assigned_to_client, $projects_assigned_to_user);
 189       if ($intersection) {
 190         $client['projects'] = implode(',', $intersection);
 191         $client_list[] = $client;
 192       }
 193     }
 194     $form->addInput(array('type'=>'combobox',
 195       'onchange'=>'fillProjectDropdown(this.value);',
 196       'name'=>'client',
 197       'style'=>'width: 250px;',
 198       'value'=>$cl_client,
 199       'data'=>$client_list,
 200       'datakeys'=>array('id', 'name'),
 201       'empty'=>array(''=>$i18n->get('dropdown.select'))));
 202   }
 203 }
 204
 205 if (MODE_PROJECTS_AND_TASKS == $user->getTrackingMode()) {
 206   $task_list = ttGroupHelper::getActiveTasks();
 207   $form->addInput(array('type'=>'combobox',
 208     'name'=>'task',
 209     'style'=>'width: 250px;',
 210     'value'=>$cl_task,
 211     'data'=>$task_list,
 212     'datakeys'=>array('id','name'),
 213     'empty'=>array(''=>$i18n->get('dropdown.select'))));
 214 }
 215
 216 // Add other controls.
 217 if ((TYPE_START_FINISH == $user->getRecordType()) || (TYPE_ALL == $user->getRecordType())) {
 218   $form->addInput(array('type'=>'text','name'=>'start','value'=>$cl_start,'onchange'=>"formDisable('start');"));
 219   $form->addInput(array('type'=>'text','name'=>'finish','value'=>$cl_finish,'onchange'=>"formDisable('finish');"));
 220   if ($user->punch_mode && !$user->canOverridePunchMode()) {
 221     // Make the start and finish fields read-only.
 222     $form->getElement('start')->setEnabled(false);
 223     $form->getElement('finish')->setEnabled(false);
 224   }
 225 }
 226 if ((TYPE_DURATION == $user->getRecordType()) || (TYPE_ALL == $user->getRecordType()))
 227   $form->addInput(array('type'=>'text','name'=>'duration','value'=>$cl_duration,'onchange'=>"formDisable('duration');"));
 228 if (!defined('NOTE_INPUT_HEIGHT'))
 229   define('NOTE_INPUT_HEIGHT', 40);
 230 $form->addInput(array('type'=>'textarea','name'=>'note','style'=>'width: 600px; height:'.NOTE_INPUT_HEIGHT.'px;','value'=>$cl_note));
 231 $form->addInput(array('type'=>'calendar','name'=>'date','value'=>$cl_date)); // calendar
 232 if ($user->isPluginEnabled('iv'))
 233   $form->addInput(array('type'=>'checkbox','name'=>'billable','value'=>$cl_billable));
 234 $form->addInput(array('type'=>'hidden','name'=>'browser_today','value'=>'')); // User current date, which gets filled in on btn_submit click.
 235 $form->addInput(array('type'=>'submit','name'=>'btn_submit','onclick'=>'browser_today.value=get_date()','value'=>$i18n->get('button.submit')));
 236
 237 // If we have custom fields - add controls for them.
 238 if ($custom_fields && $custom_fields->fields[0]) {
 239   // Only one custom field is supported at this time.
 240   if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT) {
 241     $form->addInput(array('type'=>'text','name'=>'cf_1','value'=>$cl_cf_1));
 242   } elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
 243     $form->addInput(array('type'=>'combobox','name'=>'cf_1',
 244       'style'=>'width: 250px;',
 245       'value'=>$cl_cf_1,
 246       'data'=>$custom_fields->options,
 247       'empty'=>array(''=>$i18n->get('dropdown.select'))));
 248   }
 249 }
 250
 251 // Submit.
 252 if ($request->isPost()) {
 253   if ($request->getParameter('btn_submit')) {
 254
 255     // Validate user input.
 256     if ($user->isPluginEnabled('cl') && $user->isPluginEnabled('cm') && !$cl_client)
 257       $err->add($i18n->get('error.client'));
 258     if ($custom_fields) {
 259       if (!ttValidString($cl_cf_1, !$custom_fields->fields[0]['required'])) $err->add($i18n->get('error.field'), $custom_fields->fields[0]['label']);
 260     }
 261     if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
 262       if (!$cl_project) $err->add($i18n->get('error.project'));
 263     }
 264     if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode && $user->task_required) {
 265       if (!$cl_task) $err->add($i18n->get('error.task'));
 266     }
 267     if (strlen($cl_duration) == 0) {
 268       if ($cl_start || $cl_finish) {
 269         if (!ttTimeHelper::isValidTime($cl_start))
 270           $err->add($i18n->get('error.field'), $i18n->get('label.start'));
 271         if ($cl_finish) {
 272           if (!ttTimeHelper::isValidTime($cl_finish))
 273             $err->add($i18n->get('error.field'), $i18n->get('label.finish'));
 274           if (!ttTimeHelper::isValidInterval($cl_start, $cl_finish))
 275             $err->add($i18n->get('error.interval'), $i18n->get('label.finish'), $i18n->get('label.start'));
 276         }
 277       } else {
 278         if ((TYPE_START_FINISH == $user->record_type) || (TYPE_ALL == $user->record_type)) {
 279           $err->add($i18n->get('error.empty'), $i18n->get('label.start'));
 280           $err->add($i18n->get('error.empty'), $i18n->get('label.finish'));
 281         }
 282         if ((TYPE_DURATION == $user->record_type) || (TYPE_ALL == $user->record_type))
 283           $err->add($i18n->get('error.empty'), $i18n->get('label.duration'));
 284       }
 285     } else {
 286       if (false === ttTimeHelper::postedDurationToMinutes($cl_duration))
 287         $err->add($i18n->get('error.field'), $i18n->get('label.duration'));
 288     }
 289     if (!ttValidString($cl_note, true)) $err->add($i18n->get('error.field'), $i18n->get('label.note'));
 290     // Finished validating user input.
 291
 292     // Prohibit creating entries in future.
 293     if (!$user->future_entries) {
 294       $browser_today = new DateAndTime(DB_DATEFORMAT, $request->getParameter('browser_today', null));
 295       if ($selected_date->after($browser_today))
 296         $err->add($i18n->get('error.future_date'));
 297     }
 298
 299     // Prohibit creating entries in locked range.
 300     if ($user->isDateLocked($selected_date))
 301       $err->add($i18n->get('error.range_locked'));
 302
 303     // Prohibit creating another uncompleted record.
 304     if ($err->no()) {
 305       if (($not_completed_rec = ttTimeHelper::getUncompleted($user_id)) && (($cl_finish == '') && ($cl_duration == '')))
 306         $err->add($i18n->get('error.uncompleted_exists')." <a href = 'time_edit.php?id=".$not_completed_rec['id']."'>".$i18n->get('error.goto_uncompleted')."</a>");
 307     }
 308
 309     // Prohibit creating an overlapping record.
 310     if ($err->no()) {
 311       if (ttTimeHelper::overlaps($user_id, $cl_date, $cl_start, $cl_finish))
 312         $err->add($i18n->get('error.overlap'));
 313     }
 314
 315     // Insert record.
 316     if ($err->no()) {
 317       $id = ttTimeHelper::insert(array(
 318         'date' => $cl_date,
 319         'user_id' => $user_id,
 320         'group_id' => $group_id,
 321         'org_id' => $user->org_id,
 322         'client' => $cl_client,
 323         'project' => $cl_project,
 324         'task' => $cl_task,
 325         'start' => $cl_start,
 326         'finish' => $cl_finish,
 327         'duration' => $cl_duration,
 328         'note' => $cl_note,
 329         'billable' => $cl_billable));
 330
 331       // Insert a custom field if we have it.
 332       $result = true;
 333       if ($id && $custom_fields && $cl_cf_1) {
 334         if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
 335           $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], null, $cl_cf_1);
 336         elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
 337           $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], $cl_cf_1, null);
 338       }
 339       if ($id && $result) {
 340         header('Location: time.php');
 341         exit();
 342       }
 343       $err->add($i18n->get('error.db'));
 344     }
 345   } elseif ($request->getParameter('btn_stop')) {
 346     // Stop button pressed to finish an uncompleted record.
 347     $record_id = $request->getParameter('record_id');
 348     $record = ttTimeHelper::getRecord($record_id, $user_id);
 349     $browser_date = $request->getParameter('browser_date');
 350     $browser_time = $request->getParameter('browser_time');
 351
 352     // Can we complete this record?
 353     if ($record['date'] == $browser_date                                // closing today's record
 354       && ttTimeHelper::isValidInterval($record['start'], $browser_time) // finish time is greater than start time
 355       && !ttTimeHelper::overlaps($user_id, $browser_date, $record['start'], $browser_time)) { // no overlap
 356       $res = ttTimeHelper::update(array(
 357           'id'=>$record['id'],
 358           'date'=>$record['date'],
 359           'user_id'=>$user_id,
 360           'client'=>$record['client_id'],
 361           'project'=>$record['project_id'],
 362           'task'=>$record['task_id'],
 363           'start'=>$record['start'],
 364           'finish'=>$browser_time,
 365           'note'=>$record['comment'],
 366           'billable'=>$record['billable']));
 367       if (!$res)
 368         $err->add($i18n->get('error.db'));
 369     } else {
 370       // Cannot complete, redirect for manual edit.
 371       header('Location: time_edit.php?id='.$record_id);
 372       exit();
 373     }
 374   }
 375 } // isPost
 376
 377 $week_total = ttTimeHelper::getTimeForWeek($selected_date);
 378
 379 $smarty->assign('selected_date', $selected_date);
 380 $smarty->assign('week_total', $week_total);
 381 $smarty->assign('day_total', ttTimeHelper::getTimeForDay($cl_date));
 382 $smarty->assign('time_records', ttTimeHelper::getRecords($user_id, $cl_date));
 383 $smarty->assign('client_list', $client_list);
 384 $smarty->assign('project_list', $project_list);
 385 $smarty->assign('task_list', $task_list);
 386 $smarty->assign('forms', array($form->getName()=>$form->toArray()));
 387 $smarty->assign('onload', 'onLoad="fillDropdowns()"');
 388 $smarty->assign('timestring', $selected_date->toString($user->getDateFormat()));
 389 $smarty->assign('title', $i18n->get('title.time'));
 390 $smarty->assign('content_page_name', 'time.tpl');
 391 $smarty->display('index.tpl');