mobile/timer.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 check.
  38 if (!ttAccessAllowed('track_own_time')) {
  39   header('Location: access_denied.php');
  40   exit();
  41 }
  42
  43 // Initialize and store date in session.
  44 $cl_date  = $request->getParameter('date', @$_SESSION['date']);
  45 $selected_date = new DateAndTime(DB_DATEFORMAT, $cl_date);
  46 if($selected_date->isError())
  47   $selected_date = new DateAndTime(DB_DATEFORMAT);
  48 if(!$cl_date)
  49   $cl_date = $selected_date->toString(DB_DATEFORMAT);
  50 $_SESSION['date'] = $cl_date;
  51 // TODO: for time page we may limit the day to today only.
  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 // Initialize variables.
  61 $cl_start = trim($request->getParameter('browser_time'));
  62 $cl_finish = trim($request->getParameter('browser_time'));
  63 // Custom field.
  64 $cl_cf_1 = trim($request->getParameter('cf_1', ($request->isPost() ? null : @$_SESSION['cf_1'])));
  65 $_SESSION['cf_1'] = $cl_cf_1;
  66 $cl_billable = 1;
  67 if ($user->isPluginEnabled('iv')) {
  68   if ($request->isPost()) {
  69     $cl_billable = $request->getParameter('billable');
  70     $_SESSION['billable'] = (int) $cl_billable;
  71   } else
  72     if (isset($_SESSION['billable']))
  73       $cl_billable = $_SESSION['billable'];
  74 }
  75 $cl_client = $request->getParameter('client', @$_SESSION['client']);
  76 $_SESSION['client'] = $cl_client;
  77 $cl_project = $request->getParameter('project', @$_SESSION['project']);
  78 $_SESSION['project'] = $cl_project;
  79 $cl_task = $request->getParameter('task', @$_SESSION['task']);
  80 $_SESSION['task'] = $cl_task;
  81
  82 // Obtain uncompleted record. Assumtion is that only 1 uncompleted record is allowed.
  83 $uncompleted = ttTimeHelper::getUncompleted($user->getUser());
  84 $enable_controls = ($uncompleted == null);
  85
  86 // Elements of timeRecordForm.
  87 $form = new Form('timeRecordForm');
  88
  89 // Dropdown for clients in MODE_TIME. Use all active clients.
  90 if (MODE_TIME == $user->tracking_mode && $user->isPluginEnabled('cl')) {
  91     $active_clients = ttGroupHelper::getActiveClients(true);
  92     $form->addInput(array('type'=>'combobox',
  93       'onchange'=>'fillProjectDropdown(this.value);',
  94       'name'=>'client',
  95       'style'=>'width: 250px;',
  96       'enable'=>$enable_controls,
  97       'value'=>$cl_client,
  98       'data'=>$active_clients,
  99       'datakeys'=>array('id', 'name'),
 100       'empty'=>array(''=>$i18n->get('dropdown.select'))));
 101   // Note: in other modes the client list is filtered to relevant clients only. See below.
 102 }
 103
 104 if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
 105   // Dropdown for projects assigned to user.
 106   $project_list = $user->getAssignedProjects();
 107   $form->addInput(array('type'=>'combobox',
 108     'onchange'=>'fillTaskDropdown(this.value);',
 109     'name'=>'project',
 110     'style'=>'width: 250px;',
 111     'enable'=>$enable_controls,
 112     'value'=>$cl_project,
 113     'data'=>$project_list,
 114     'datakeys'=>array('id','name'),
 115     'empty'=>array(''=>$i18n->get('dropdown.select'))));
 116
 117   // Dropdown for clients if the clients plugin is enabled.
 118   if ($user->isPluginEnabled('cl')) {
 119     $active_clients = ttGroupHelper::getActiveClients(true);
 120     // We need an array of assigned project ids to do some trimming.
 121     foreach($project_list as $project)
 122       $projects_assigned_to_user[] = $project['id'];
 123
 124     // Build a client list out of active clients. Use only clients that are relevant to user.
 125     // Also trim their associated project list to only assigned projects (to user).
 126     foreach($active_clients as $client) {
 127       $projects_assigned_to_client = explode(',', $client['projects']);
 128       $intersection = array_intersect($projects_assigned_to_client, $projects_assigned_to_user);
 129       if ($intersection) {
 130         $client['projects'] = implode(',', $intersection);
 131         $client_list[] = $client;
 132       }
 133     }
 134     $form->addInput(array('type'=>'combobox',
 135       'onchange'=>'fillProjectDropdown(this.value);',
 136       'name'=>'client',
 137       'style'=>'width: 250px;',
 138       'enable'=>$enable_controls,
 139       'value'=>$cl_client,
 140       'data'=>$client_list,
 141       'datakeys'=>array('id', 'name'),
 142       'empty'=>array(''=>$i18n->get('dropdown.select'))));
 143   }
 144 }
 145
 146 if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
 147   $task_list = ttGroupHelper::getActiveTasks();
 148   $form->addInput(array('type'=>'combobox',
 149     'name'=>'task',
 150     'style'=>'width: 250px;',
 151     'enable'=>$enable_controls,
 152     'value'=>$cl_task,
 153     'data'=>$task_list,
 154     'datakeys'=>array('id','name'),
 155     'empty'=>array(''=>$i18n->get('dropdown.select'))));
 156 }
 157 if ($user->isPluginEnabled('iv'))
 158   $form->addInput(array('type'=>'checkbox','name'=>'billable','value'=>$cl_billable,'enable'=>$enable_controls));
 159 $form->addInput(array('type'=>'hidden','name'=>'browser_today','value'=>'')); // User current date, which gets filled in on button click.
 160 $form->addInput(array('type'=>'hidden','name'=>'browser_time','value'=>''));  // User current time, which gets filled in on button click.
 161 $enable_start = $uncompleted ? false : true;
 162 if (!$uncompleted)
 163   $form->addInput(array('type'=>'submit','name'=>'btn_start','onclick'=>'browser_time.value=get_time()','value'=>$i18n->get('label.start'),'enable'=>$enable_start));
 164 else
 165   $form->addInput(array('type'=>'submit','name'=>'btn_stop','onclick'=>'browser_time.value=get_time()','value'=>$i18n->get('label.finish'),'enable'=>!$enable_start));
 166
 167 // If we have custom fields - add controls for them.
 168 if ($custom_fields && $custom_fields->fields[0]) {
 169   // Only one custom field is supported at this time.
 170   if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT) {
 171     $form->addInput(array('type'=>'text','name'=>'cf_1','value'=>$cl_cf_1));
 172   } elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) {
 173     $form->addInput(array('type'=>'combobox','name'=>'cf_1',
 174       'style'=>'width: 250px;',
 175       'value'=>$cl_cf_1,
 176       'data'=>$custom_fields->options,
 177       'empty'=>array(''=>$i18n->get('dropdown.select'))
 178     ));
 179   }
 180 }
 181
 182 // Submit.
 183 if ($request->isPost()) {
 184   if ($request->getParameter('btn_start')) {
 185     // Start button clicked. We need to create a new uncompleted record with only the start time.
 186     $cl_finish = null;
 187
 188     // Validate user input.
 189     if ($user->isPluginEnabled('cl') && $user->isPluginEnabled('cm') && !$cl_client)
 190       $err->add($i18n->get('error.client'));
 191     if ($custom_fields) {
 192       if (!ttValidString($cl_cf_1, !$custom_fields->fields[0]['required'])) $err->add($i18n->get('error.field'), $custom_fields->fields[0]['label']);
 193     }
 194     if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
 195       if (!$cl_project) $err->add($i18n->get('error.project'));
 196     }
 197     if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) {
 198       if (!$cl_task) $err->add($i18n->get('error.task'));
 199     }
 200     // Finished validating user input.
 201
 202     // Prohibit creating entries in future.
 203     if (!$user->future_entries) {
 204       $browser_today = new DateAndTime(DB_DATEFORMAT, $request->getParameter('browser_today', null));
 205       if ($selected_date->after($browser_today))
 206         $err->add($i18n->get('error.future_date'));
 207     }
 208
 209     // Prohibit creating time entries in locked interval.
 210     if ($user->isDateLocked($selected_date))
 211       $err->add($i18n->get('error.range_locked'));
 212
 213     // Prohibit creating another uncompleted record.
 214     if ($err->no() && $uncompleted) {
 215       $err->add($i18n->get('error.uncompleted_exists')." <a href = 'time_edit.php?id=".$not_completed_rec['id']."'>".$i18n->get('error.goto_uncompleted')."</a>");
 216     }
 217
 218     // Prohibit creating an overlapping record.
 219     if ($err->no()) {
 220       if (ttTimeHelper::overlaps($user->getUser(), $cl_date, $cl_start, $cl_finish))
 221         $err->add($i18n->get('error.overlap'));
 222     }
 223
 224     if ($err->no()) {
 225       $id = ttTimeHelper::insert(array(
 226         'date' => $cl_date,
 227         'user_id' => $user->getUser(),
 228         'group_id' => $user->getGroup(),
 229         'org_id' => $user->org_id,
 230         'client' => $cl_client,
 231         'project' => $cl_project,
 232         'task' => $cl_task,
 233         'start' => $cl_start,
 234         'finish' => $cl_finish,
 235         'duration' => $cl_duration,
 236         'note' => $cl_note,
 237         'billable' => $cl_billable));
 238
 239       // Insert a custom field if we have it.
 240       $result = true;
 241       if ($id && $custom_fields && $cl_cf_1) {
 242         if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
 243           $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], null, $cl_cf_1);
 244         elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
 245           $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], $cl_cf_1, null);
 246       }
 247
 248       if ($id && $result) {
 249         header('Location: timer.php');
 250         exit();
 251       }
 252       $err->add($i18n->get('error.db'));
 253     }
 254   }
 255   if ($request->getParameter('btn_stop')) {
 256     // Stop button clicked. We need to finish an uncompleted record in progress.
 257     $record = ttTimeHelper::getRecord($uncompleted['id'], $user->getUser());
 258
 259     // Can we complete this record?
 260     if (ttTimeHelper::isValidInterval($record['start'], $cl_finish) // finish time is greater than start time
 261       && !ttTimeHelper::overlaps($user->getUser(), $cl_date, $record['start'], $cl_finish)) { // no overlap
 262       $res = ttTimeHelper::update(array(
 263         'id'=>$record['id'],
 264         'date'=>$cl_date,
 265         'user_id'=>$user->getUser(),
 266         'client'=>$record['client_id'],
 267         'project'=>$record['project_id'],
 268         'task'=>$record['task_id'],
 269         'start'=>$record['start'],
 270         'finish'=>$cl_finish,
 271         'note'=>$record['comment'],
 272         'billable'=>$record['billable']));
 273       if ($res) {
 274         header('Location: timer.php');
 275         exit();
 276       } else
 277         $err->add($i18n->get('error.db'));
 278     } else {
 279       // Cannot complete, redirect for manual edit.
 280       header('Location: time_edit.php?id='.$record['id']);
 281       exit();
 282     }
 283   }
 284 } // isPost
 285
 286 $week_total = ttTimeHelper::getTimeForWeek($cl_date);
 287 $smarty->assign('week_total', $week_total);
 288
 289 $smarty->assign('uncompleted', $uncompleted);
 290
 291
 292
 293 $smarty->assign('time_records', ttTimeHelper::getRecords($user->getUser(), $cl_date));
 294 $smarty->assign('day_total', ttTimeHelper::getTimeForDay($cl_date));
 295 $smarty->assign('client_list', $client_list);
 296 $smarty->assign('project_list', $project_list);
 297 $smarty->assign('task_list', $task_list);
 298 $smarty->assign('forms', array($form->getName()=>$form->toArray()));
 299 $smarty->assign('onload', 'onLoad="fillDropdowns()"');
 300 $smarty->assign('timestring', $selected_date->toString($user->date_format));
 301 $smarty->assign('title', $i18n->get('title.time'));
 302 $smarty->assign('content_page_name', 'mobile/timer.tpl');
 303 $smarty->display('mobile/index.tpl');