WEB-INF/lib/ttWeekViewHelper.class.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 // ttWeekViewHelper class groups together functions used in week view.
  30 class ttWeekViewHelper {
  31
  32   // getRecordsForInterval - returns time records for a user for a given interval of dates.
  33   static function getRecordsForInterval($user_id, $start_date, $end_date) {
  34     global $user;
  35     $sql_time_format = "'%k:%i'"; //  24 hour format.
  36     if ('%I:%M %p' == $user->time_format)
  37       $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
  38
  39     $result = array();
  40     $mdb2 = getConnection();
  41
  42     $client_field = null;
  43     if ($user->isPluginEnabled('cl'))
  44       $client_field = ', c.id as client_id, c.name as client';
  45
  46     $custom_field_1 = null;
  47     if ($user->isPluginEnabled('cf')) {
  48       $custom_fields = new CustomFields($user->team_id);
  49       $cf_1_type = $custom_fields->fields[0]['type'];
  50       if ($cf_1_type == CustomFields::TYPE_TEXT) {
  51         $custom_field_1 = ', cfl.value as cf_1_value';
  52       } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
  53         $custom_field_1 = ', cfo.id as cf_1_id, cfo.value as cf_1_value';
  54       }
  55     }
  56
  57     $left_joins = " left join tt_projects p on (l.project_id = p.id)".
  58       " left join tt_tasks t on (l.task_id = t.id)";
  59     if ($user->isPluginEnabled('cl'))
  60       $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
  61     if ($user->isPluginEnabled('cf')) {
  62       if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
  63         $left_joins .= 'left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1) left join tt_custom_field_options cfo on (cfl.value = cfo.id) ';
  64       elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
  65         $left_joins .= 'left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1) left join tt_custom_field_options cfo on (cfl.option_id = cfo.id) ';
  66     }
  67
  68     $sql = "select l.id as id, l.date as date, TIME_FORMAT(l.start, $sql_time_format) as start,
  69       TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
  70       TIME_FORMAT(l.duration, '%k:%i') as duration, p.id as project_id, p.name as project,
  71       t.id as task_id, t.name as task, l.comment, l.billable, l.invoice_id $client_field $custom_field_1
  72       from tt_log l
  73       $left_joins
  74       where l.date >= '$start_date' and l.date <= '$end_date' and l.user_id = $user_id and l.status = 1
  75       order by l.date, p.name, t.name, l.start, l.id";
  76     $res = $mdb2->query($sql);
  77     if (!is_a($res, 'PEAR_Error')) {
  78       while ($val = $res->fetchRow()) {
  79         if($val['duration']=='0:00')
  80           $val['finish'] = '';
  81         $result[] = $val;
  82       }
  83     } else return false;
  84
  85     return $result;
  86   }
  87
  88   // getDataForWeekView - builds an array to render a table of durations for week view.
  89   // In a week view we want one row representing the same attributes to have 7 values for each day of week.
  90   // We identify simlar records by a combination of client, billable, project, task, and custom field values.
  91   // This will allow us to extend the feature when more custom fields are added.
  92   //
  93   // "cl:546,bl:1,pr:23456,ts:27464,cf_1:example text"
  94   // The above means client 546, billable, project 23456, task 27464, custom field text "example text".
  95   //
  96   // "cl:546,bl:0,pr:23456,ts:27464,cf_1:7623"
  97   // The above means client 546, not billable, project 23456, task 27464, custom field option id 7623.
  98   //
  99   // Description of $dataArray format that the function returns.
 100   // $dataArray = array(
 101   //   array( // Row 0. This is a special, one-off row for a new week entry with empty values.
 102   //     'row_id' => null', // Row identifier. Null for a new entry.
 103   //     'label' => 'New entry', // Human readable label for the row describing what this time entry is for.
 104   //     'day_0' => array('control_id' => '0_day_0', 'tt_log_id' => null, 'duration' => null), // control_id is row_id plus day header for column.
 105   //     'day_1' => array('control_id' => '0_day_1', 'tt_log_id' => null, 'duration' => null),
 106   //     'day_2' => array('control_id' => '0_day_2', 'tt_log_id' => null, 'duration' => null),
 107   //     'day_3' => array('control_id' => '0_day_3', 'tt_log_id' => null, 'duration' => null),
 108   //     'day_4' => array('control_id' => '0_day_4', 'tt_log_id' => null, 'duration' => null),
 109   //     'day_5' => array('control_id' => '0_day_5', 'tt_log_id' => null, 'duration' => null),
 110   //     'day_6' => array('control_id' => '0_day_6', 'tt_log_id' => null, 'duration' => null)
 111   //   ),
 112   //   array( // Row 1.
 113   //     'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0', // Row identifier. See ttWeekViewHelper::makeRowIdentifier().
 114   //     'label' => 'Anuko - Time Tracker - Coding',              // Human readable label for the row describing what this time entry is for.
 115   //     'day_0' => array('control_id' => '1_day_0', 'tt_log_id' => 12345, 'duration' => '00:00'), // control_id is row_id plus day header for column.
 116   //     'day_1' => array('control_id' => '1_day_1', 'tt_log_id' => 12346, 'duration' => '01:00'),
 117   //     'day_2' => array('control_id' => '1_day_2', 'tt_log_id' => 12347, 'duration' => '02:00'),
 118   //     'day_3' => array('control_id' => '1_day_3', 'tt_log_id' => null, 'duration' => null),
 119   //     'day_4' => array('control_id' => '1_day_4', 'tt_log_id' => 12348, 'duration' => '04:00'),
 120   //     'day_5' => array('control_id' => '1_day_5', 'tt_log_id' => 12349, 'duration' => '04:00'),
 121   //     'day_6' => array('control_id' => '1_day_6', 'tt_log_id' => null, 'duration' => null)
 122   //   ),
 123   //   array( // Row 2.
 124   //     'row_id' => 'bl:0_0',
 125   //     'label' => '', // In this case the label is empty as we don't have anything to put into it, as we only have billable flag.
 126   //     'day_0' => array('control_id' => '2_day_0', 'tt_log_id' => null, 'duration' => null),
 127   //     'day_1' => array('control_id' => '2_day_1', 'tt_log_id' => 12350, 'duration' => '01:30'),
 128   //     'day_2' => array('control_id' => '2_day_2', 'tt_log_id' => null, 'duration' => null),
 129   //     'day_3' => array('control_id' => '2_day_3', 'tt_log_id' => 12351,'duration' => '02:30'),
 130   //     'day_4' => array('control_id' => '2_day_4', 'tt_log_id' => 12352, 'duration' => '04:00'),
 131   //     'day_5' => array('control_id' => '2_day_5', 'tt_log_id' => null, 'duration' => null),
 132   //     'day_6' => array('control_id' => '2_day_6', 'tt_log_id' => null, 'duration' => null)
 133   //   )
 134   // );
 135   static function getDataForWeekView($records, $dayHeaders) {
 136     global $i18n;
 137
 138     $dataArray = array();
 139
 140     // Construct the first row for a brand new entry.
 141     $dataArray[] = array('row_id' => null,'label' => $i18n->getKey('form.week.new_entry')); // Insert row.
 142     // Insert empty cells with proper control ids.
 143     for ($i = 0; $i < 7; $i++) {
 144       $control_id = '0_'. $dayHeaders[$i];
 145       $dataArray[0][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
 146     }
 147
 148     // Iterate through records and build $dataArray cell by cell.
 149     foreach ($records as $record) {
 150       // Create record id without suffix.
 151       $row_id_no_suffix = ttWeekViewHelper::makeRowIdentifier($record);
 152       // Handle potential multiple records with the same attributes by using a numerical suffix.
 153       $suffix = 0;
 154       $row_id = $row_id_no_suffix.'_'.$suffix;
 155       $day_header = substr($record['date'], 8); // Day number in month.
 156       while (ttWeekViewHelper::cellExists($row_id, $day_header, $dataArray)) {
 157         $suffix++;
 158         $row_id = $row_id_no_suffix.'_'.$suffix;
 159       }
 160       // Find row.
 161       $pos = ttWeekViewHelper::findRow($row_id, $dataArray);
 162       if ($pos < 0) {
 163         $dataArray[] = array('row_id' => $row_id,'label' => ttWeekViewHelper::makeRowLabel($record)); // Insert row.
 164         $pos = ttWeekViewHelper::findRow($row_id, $dataArray);
 165         // Insert empty cells with proper control ids.
 166         for ($i = 0; $i < 7; $i++) {
 167           $control_id = $pos.'_'. $dayHeaders[$i];
 168           $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
 169         }
 170       }
 171       // Insert actual cell data from $record (one cell only).
 172       $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'duration' => $record['duration']);
 173     }
 174     return $dataArray;
 175   }
 176
 177   // cellExists is a helper function for getDataForWeekView() to see if a cell with a given label
 178   // and a day header already exists.
 179   static function cellExists($row_id, $day_header, $dataArray) {
 180     foreach($dataArray as $row) {
 181       if ($row['row_id'] == $row_id && !empty($row[$day_header]['duration']))
 182         return true;
 183     }
 184     return false;
 185   }
 186
 187   // findRow returns an existing row position in $dataArray, -1 otherwise.
 188   static function findRow($row_id, $dataArray) {
 189     $pos = 0; // Row position in array.
 190     foreach($dataArray as $row) {
 191       if ($row['row_id'] == $row_id)
 192         return $pos;
 193       $pos++; // Increment for search.
 194     }
 195     return -1; // Row not found.
 196   }
 197
 198   // getDayTotals calculates total durations for each day from the existing data in $dataArray.
 199   static function getDayTotals($dataArray, $dayHeaders) {
 200     $dayTotals = array();
 201
 202     // Insert label.
 203     global $i18n;
 204     $dayTotals['label'] = $i18n->getKey('label.day_total');
 205
 206     foreach ($dataArray as $row) {
 207       foreach($dayHeaders as $dayHeader) {
 208         if (array_key_exists($dayHeader, $row)) {
 209           $minutes = ttTimeHelper::toMinutes($row[$dayHeader]['duration']);
 210           $dayTotals[$dayHeader] += $minutes;
 211         }
 212       }
 213     }
 214     // Convert minutes to hh:mm for display.
 215     foreach($dayHeaders as $dayHeader) {
 216       $dayTotals[$dayHeader] = ttTimeHelper::toAbsDuration($dayTotals[$dayHeader]);
 217     }
 218     return $dayTotals;
 219   }
 220
 221   // getDayHeadersForWeek - obtains day column headers for week view, which are simply day numbers in month.
 222   static function getDayHeadersForWeek($start_date) {
 223     $dayHeaders = array();
 224     $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
 225     $dayHeaders[] = (string) $objDate->getDate(); // It returns an int on first call.
 226     if (strlen($dayHeaders[0]) == 1)              // Which is an implementation detail of DateAndTime class.
 227       $dayHeaders[0] = '0'.$dayHeaders[0];        // Add a 0 for single digit day.
 228     $objDate->incDay();
 229     $dayHeaders[] = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
 230     $objDate->incDay();
 231     $dayHeaders[] = $objDate->getDate();
 232     $objDate->incDay();
 233     $dayHeaders[] = $objDate->getDate();
 234     $objDate->incDay();
 235     $dayHeaders[] = $objDate->getDate();
 236     $objDate->incDay();
 237     $dayHeaders[] = $objDate->getDate();
 238     $objDate->incDay();
 239     $dayHeaders[] = $objDate->getDate();
 240     unset($objDate);
 241     return $dayHeaders;
 242   }
 243
 244   // getLockedDaysForWeek - builds an array of locked days in week.
 245   static function getLockedDaysForWeek($start_date) {
 246     global $user;
 247     $lockedDays = array();
 248     $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
 249     for ($i = 0; $i < 7; $i++) {
 250       $lockedDays[] = $user->isDateLocked($objDate);
 251       $objDate->incDay();
 252     }
 253     unset($objDate);
 254     return $lockedDays;
 255   }
 256
 257   // makeRowIdentifier - builds a string identifying a row for a week view from a single record properties.
 258   //                     Note that the return value is without a suffix.
 259   // For example:
 260   // "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
 261   // "cl:546,bl:1,pr:23456,ts:27464,cf_1:7623"
 262   static function makeRowIdentifier($record) {
 263     global $user;
 264     // Start with client.
 265     if ($user->isPluginEnabled('cl'))
 266       $row_identifier = $record['client_id'] ? 'cl:'.$record['client_id'] : '';
 267     // Add billable flag.
 268     if (!empty($row_identifier)) $row_identifier .= ',';
 269     $row_identifier .= 'bl:'.$record['billable'];
 270     // Add project.
 271     $row_identifier .= $record['project_id'] ? ',pr:'.$record['project_id'] : '';
 272     // Add task.
 273     $row_identifier .= $record['task_id'] ? ',ts:'.$record['task_id'] : '';
 274     // Add custom field 1.
 275     if ($user->isPluginEnabled('cf')) {
 276       if ($record['cf_1_id'])
 277         $row_identifier .= ',cf_1:'.$record['cf_1_id'];
 278       else if ($record['cf_1_value'])
 279         $row_identifier .= ',cf_1:'.$record['cf_1_value'];
 280     }
 281
 282     return $row_identifier;
 283   }
 284
 285   // makeRowLabel - builds a human readable label for a row in week view,
 286   // which is a combination ot record properties.
 287   // Client - Project - Task - Custom field 1.
 288   // Note that billable property is not part of the label. Instead,
 289   // we identify such records with a different color in week view.
 290   static function makeRowLabel($record) {
 291     global $user;
 292     // Start with client.
 293     if ($user->isPluginEnabled('cl'))
 294       $label = $record['client'];
 295
 296     // Add project.
 297     if (!empty($label) && !empty($record['project'])) $label .= ' - ';
 298     $label .= $record['project'];
 299
 300     // Add task.
 301     if (!empty($label) && !empty($record['task'])) $label .= ' - ';
 302     $label .= $record['task'];
 303
 304     // Add custom field 1.
 305     if ($user->isPluginEnabled('cf')) {
 306       if (!empty($label) && !empty($record['cf_1_value'])) $label .= ' - ';
 307       $label .= $record['cf_1_value'];
 308     }
 309
 310     return $label;
 311   }
 312
 313   // parseFromWeekViewRow - obtains field value encoded in row identifier.
 314   // For example, for a row id like "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
 315   // requesting a client "cl" should return 546.
 316   static function parseFromWeekViewRow($row_id, $field_label) {
 317     // Find beginning of label.
 318     $pos = strpos($row_id, $field_label);
 319     if ($pos === false) return null; // Not found.
 320
 321     // Strip suffix from row id.
 322     $suffixPos = strrpos($row_id, '_');
 323     if ($suffixPos)
 324       $remaninder = substr($row_id, 0, $suffixPos);
 325
 326     // Find beginning of value.
 327     $posBegin = 1 + strpos($remaninder, ':', $pos);
 328     // Find end of value.
 329     $posEnd = strpos($remaninder, ',', $posBegin);
 330     if ($posEnd === false) $posEnd = strlen($remaninder);
 331     // Return value.
 332     return substr($remaninder, $posBegin, $posEnd - $posBegin);
 333   }
 334
 335   // dateFromDayHeader calculates date from start date and day header in week view.
 336   static function dateFromDayHeader($start_date, $day_header) {
 337     $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
 338     $currentDayHeader = (string) $objDate->getDate(); // It returns an int on first call.
 339     if (strlen($currentDayHeader) == 1)               // Which is an implementation detail of DateAndTime class.
 340       $currentDayHeader = '0'.$currentDayHeader;      // Add a 0 for single digit day.
 341     $i = 1;
 342     while ($currentDayHeader != $day_header && $i < 7) {
 343       // Iterate through remaining days to find a match.
 344       $objDate->incDay();
 345       $currentDayHeader = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
 346       $i++;
 347     }
 348     return $objDate->toString(DB_DATEFORMAT);
 349   }
 350
 351   // insertDurationFromWeekView - inserts a new record in log tables from a week view post.
 352   static function insertDurationFromWeekView($fields, $custom_fields, $err) {
 353     global $i18n;
 354     global $user;
 355
 356     // Determine date for a new entry.
 357     $entry_date = ttWeekViewHelper::dateFromDayHeader($fields['start_date'], $fields['day_header']);
 358     $objEntryDate = new DateAndTime(DB_DATEFORMAT, $entry_date);
 359
 360     // Prohibit creating entries in future.
 361     if (defined('FUTURE_ENTRIES') && !isTrue(FUTURE_ENTRIES) && $fields['browser_today']) {
 362       $objBrowserToday = new DateAndTime(DB_DATEFORMAT, $fields['browser_today']);
 363       if ($objEntryDate->after($objBrowserToday)) {
 364         $err->add($i18n->getKey('error.future_date'));
 365         return false;
 366       }
 367     }
 368
 369     // Prepare an array of fields for regular insert function.
 370     $fields4insert = array();
 371     $fields4insert['user_id'] = $user->getActiveUser();
 372     $fields4insert['date'] = $entry_date;
 373     $fields4insert['duration'] = $fields['duration'];
 374     $fields4insert['client'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'cl');
 375     $fields4insert['billable'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'bl');
 376     $fields4insert['project'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'pr');
 377     $fields4insert['task'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'ts');
 378     $fields4insert['note'] = $fields['note'];
 379
 380     // Try to insert a record.
 381     $id = ttTimeHelper::insert($fields4insert);
 382     if (!$id) return false; // Something failed.
 383
 384     // Insert custom field if we have it.
 385     $result = true;
 386     $cf_1 = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'cf_1');
 387     if ($custom_fields && $cf_1) {
 388       if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
 389         $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], null, $cf_1);
 390       elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
 391         $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], $cf_1, null);
 392     }
 393
 394     return $result;
 395   }
 396
 397   // modifyDurationFromWeekView - modifies a duration of an existing record from a week view post.
 398   static function modifyDurationFromWeekView($fields, $err) {
 399     global $i18n;
 400     global $user;
 401
 402     // Possible errors: 1) Overlap if the existing record has start time. 2) Going beyond 24 hour boundary.
 403     // TODO: rename this function.
 404     // Handle different errors with specific error messages.
 405     if (!ttWeekViewHelper::canModify($fields['tt_log_id'], $fields['duration'], $err)) {
 406       // $err->add($i18n->getKey('error.overlap'));
 407       return false;
 408     }
 409
 410     $mdb2 = getConnection();
 411     $duration = $fields['duration'];
 412     $tt_log_id = $fields['tt_log_id'];
 413     $user_id = $user->getActiveUser();
 414     $sql = "update tt_log set duration = '$duration' where id = $tt_log_id and user_id = $user_id";
 415     $affected = $mdb2->exec($sql);
 416     if (is_a($affected, 'PEAR_Error'))
 417       return false;
 418
 419     return true;
 420   }
 421
 422   // canModify - determines if an  already existing tt_log record
 423   // can be modified with a new user-provided duration.
 424   static function canModify($tt_log_id, $new_duration, $err) {
 425     global $i18n;
 426     $mdb2 = getConnection();
 427
 428     // Determine if we have start time in record, as further checking does not makes sense otherwise.
 429     $sql = "select user_id, date, start, duration from tt_log  where id = $tt_log_id";
 430     $res = $mdb2->query($sql);
 431     if (!is_a($res, 'PEAR_Error')) {
 432       if (!$res->numRows()) {
 433         $err->add($i18n->getKey('error.db')); // This is not expected.
 434         return false;
 435       }
 436       $val = $res->fetchRow();
 437       $oldDuration = $val['duration'];
 438       if (!$val['start'])
 439         return true; // There is no start time in the record, therefore safe to modify.
 440     }
 441
 442     // We do have start time.
 443     // Quick test if new duration is less then already existing.
 444     $newMinutes = ttTimeHelper::toMinutes($new_duration);
 445     $oldMinutes = ttTimeHelper::toMinutes($oldDuration);
 446     if ($newMinutes < $oldMinutes)
 447       return true; // Safe to modify.
 448
 449     // Does the new duration put the record beyond 24:00 boundary?
 450     $startMinutes = ttTimeHelper::toMinutes($val['start']);
 451     $newEndMinutes = $startMinutes + $newMinutes;
 452     if ($newEndMinutes > 1440) {
 453       // Invalid duration, as new duration puts the record beyond current day.
 454       $err->add($i18n->getKey('error.field'), $i18n->getKey('label.duration'));
 455       return false;
 456     }
 457
 458     // Does the new duration causes the record to overlap with others?
 459     $user_id = $val['user_id'];
 460     $date = $val['date'];
 461     $startMinutes = ttTimeHelper::toMinutes($val['start']);
 462     $start = ttTimeHelper::toAbsDuration($startMinutes);
 463     $finish = ttTimeHelper::toAbsDuration($newEndMinutes);
 464     if (ttTimeHelper::overlaps($user_id, $date, $start, $finish, $tt_log_id)) {
 465       $err->add($i18n->getKey('error.overlap'));
 466       return false;
 467     }
 468
 469     return true; // There are no conflicts, safe to modify.
 470   }
 471 }