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($start_date, $end_date, $includeFiles = false) {
  34     global $user;
  35
  36     $user_id = $user->getUser();
  37     $group_id = $user->getGroup();
  38     $org_id = $user->org_id;
  39
  40     $sql_time_format = "'%k:%i'"; //  24 hour format.
  41     if ('%I:%M %p' == $user->time_format)
  42       $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
  43
  44     $result = array();
  45     $mdb2 = getConnection();
  46
  47     $client_field = null;
  48     if ($user->isPluginEnabled('cl'))
  49       $client_field = ', c.id as client_id, c.name as client';
  50
  51     $custom_field_1 = null;
  52     if ($user->isPluginEnabled('cf')) {
  53       $custom_fields = new CustomFields();
  54       $cf_1_type = $custom_fields->fields[0]['type'];
  55       if ($cf_1_type == CustomFields::TYPE_TEXT) {
  56         $custom_field_1 = ', cfl.value as cf_1_value';
  57       } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
  58         $custom_field_1 = ', cfo.id as cf_1_id, cfo.value as cf_1_value';
  59       }
  60     }
  61
  62     if ($includeFiles) {
  63       $filePart = ', if(Sub1.entity_id is null, 0, 1) as has_files';
  64       $fileJoin =  " left join (select distinct entity_id from tt_files".
  65       " where entity_type = 'time' and group_id = $group_id and org_id = $org_id and status = 1) Sub1".
  66       " on (l.id = Sub1.entity_id)";
  67     }
  68
  69     $left_joins = " left join tt_projects p on (l.project_id = p.id)".
  70       " left join tt_tasks t on (l.task_id = t.id)";
  71     if ($user->isPluginEnabled('cl'))
  72       $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
  73     if ($user->isPluginEnabled('cf')) {
  74       if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
  75         $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) ';
  76       elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
  77         $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) ';
  78     }
  79     $left_joins .= $fileJoin;
  80
  81     $sql = "select l.id as id, l.date as date, TIME_FORMAT(l.start, $sql_time_format) as start,".
  82       " TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,".
  83       " TIME_FORMAT(l.duration, '%k:%i') as duration, p.id as project_id, p.name as project,".
  84       " t.id as task_id, t.name as task, l.comment, l.billable, l.invoice_id $client_field $custom_field_1 $filePart".
  85       " from tt_log l $left_joins".
  86       " where l.date >= '$start_date' and l.date <= '$end_date'".
  87       " and l.user_id = $user_id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1".
  88       " order by l.date, p.name, t.name, l.start, l.id";
  89     $res = $mdb2->query($sql);
  90     if (!is_a($res, 'PEAR_Error')) {
  91       while ($val = $res->fetchRow()) {
  92         if($val['duration']=='0:00')
  93           $val['finish'] = '';
  94         $result[] = $val;
  95       }
  96     } else return false;
  97
  98     return $result;
  99   }
 100
 101   // getDataForWeekView - builds an array to render a table of durations and comments for a week view.
 102   // In a week view we want one row representing the same attributes to have 7 values for each day of week.
 103   // We identify similar records by a combination of client, billable, project, task, and custom field values.
 104   // This will allow us to extend the feature when more custom fields are added.
 105   //
 106   // "cl:546,bl:1,pr:23456,ts:27464,cf_1:example text"
 107   // The above means client 546, billable, project 23456, task 27464, custom field text "example text".
 108   //
 109   // "cl:546,bl:0,pr:23456,ts:27464,cf_1:7623"
 110   // The above means client 546, not billable, project 23456, task 27464, custom field option id 7623.
 111   //
 112   // Daily comments are implemented as alternate rows following week durations.
 113   // For example: row_0 - new entry durations, row_1 - new entry daily comments,
 114   //              row_2 - existing entry durations, row_3 - existing entry comments, etc.
 115   //
 116   // Description of $dataArray format that the function returns.
 117   // $dataArray = array(
 118   //   array( // Row 0. This is a special, one-off row for a new week entry with empty values.
 119   //     'row_id' => null, // Row identifier. Null for a new entry.
 120   //     'label' => 'New entry:', // Human readable label for the row describing what this time entry is for.
 121   //     'day_0' => array('control_id' => '0_day_0', 'tt_log_id' => null, 'duration' => null), // control_id is row_id plus day header for column.
 122   //     'day_1' => array('control_id' => '0_day_1', 'tt_log_id' => null, 'duration' => null),
 123   //     'day_2' => array('control_id' => '0_day_2', 'tt_log_id' => null, 'duration' => null),
 124   //     'day_3' => array('control_id' => '0_day_3', 'tt_log_id' => null, 'duration' => null),
 125   //     'day_4' => array('control_id' => '0_day_4', 'tt_log_id' => null, 'duration' => null),
 126   //     'day_5' => array('control_id' => '0_day_5', 'tt_log_id' => null, 'duration' => null),
 127   //     'day_6' => array('control_id' => '0_day_6', 'tt_log_id' => null, 'duration' => null)
 128   //   ),
 129   //
 130   //   array( // Row 1. This row represents daily comments for a new entry in row above (row 0).
 131   //     'row_id' => null,
 132   //     'label' => 'Notes:',
 133   //     'day_0' => array('control_id' => '1_day_0', 'tt_log_id' => null, 'note' => null),
 134   //     'day_1' => array('control_id' => '1_day_1', 'tt_log_id' => null, 'note' => null),
 135   //     'day_2' => array('control_id' => '1_day_2', 'tt_log_id' => null, 'note' => null),
 136   //     'day_3' => array('control_id' => '1_day_3', 'tt_log_id' => null, 'note' => null),
 137   //     'day_4' => array('control_id' => '1_day_4', 'tt_log_id' => null, 'note' => null),
 138   //     'day_5' => array('control_id' => '1_day_5', 'tt_log_id' => null, 'note' => null),
 139   //     'day_6' => array('control_id' => '1_day_6', 'tt_log_id' => null, 'note' => null)
 140   //   ),
 141   //
 142   //   array( // Row 2.
 143   //     'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0',
 144   //     'label' => 'Anuko - Time Tracker - Coding - Option 2',
 145   //     'day_0' => array('control_id' => '2_day_0', 'tt_log_id' => 12345, 'duration' => '00:00'),
 146   //     'day_1' => array('control_id' => '2_day_1', 'tt_log_id' => 12346, 'duration' => '01:00'),
 147   //     'day_2' => array('control_id' => '2_day_2', 'tt_log_id' => 12347, 'duration' => '02:00'),
 148   //     'day_3' => array('control_id' => '2_day_3', 'tt_log_id' => null, 'duration' => null),
 149   //     'day_4' => array('control_id' => '2_day_4', 'tt_log_id' => 12348, 'duration' => '04:00'),
 150   //     'day_5' => array('control_id' => '2_day_5', 'tt_log_id' => 12349, 'duration' => '04:00'),
 151   //     'day_6' => array('control_id' => '2_day_6', 'tt_log_id' => null, 'duration' => null)
 152   //   ),
 153   //   array( // Row 3.
 154   //     'row_id' => 'cl:546,bl:1,pr:23456,ts:27464,cf_1:7623_0_notes',
 155   //     'label' => 'Notes:',
 156   //     'day_0' => array('control_id' => '3_day_0', 'tt_log_id' => 12345, 'note' => 'Comment one'),
 157   //     'day_1' => array('control_id' => '3_day_1', 'tt_log_id' => 12346, 'note' => 'Comment two'),
 158   //     'day_2' => array('control_id' => '3_day_2', 'tt_log_id' => 12347, 'note' => 'Comment three'),
 159   //     'day_3' => array('control_id' => '3_day_3', 'tt_log_id' => null, 'note' => null),
 160   //     'day_4' => array('control_id' => '3_day_4', 'tt_log_id' => 12348, 'note' => 'Comment four'),
 161   //     'day_5' => array('control_id' => '3_day_5', 'tt_log_id' => 12349, 'note' => 'Comment five'),
 162   //     'day_6' => array('control_id' => '3_day_6', 'tt_log_id' => null, 'note' => null)
 163   //   )
 164   // );
 165   static function getDataForWeekView($records, $dayHeaders) {
 166     global $user;
 167     global $i18n;
 168
 169     $dataArray = array();
 170
 171     // Construct the first row for a brand new entry.
 172     $dataArray[] = array('row_id' => null,'label' => $i18n->get('form.week.new_entry').':'); // Insert row.
 173     // Insert empty cells with proper control ids.
 174     for ($i = 0; $i < 7; $i++) {
 175       $control_id = '0_'. $dayHeaders[$i];
 176       $dataArray[0][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
 177     }
 178     if ($user->isPluginEnabled('wvns')) {
 179       // Construct the second row for daily comments for a brand new entry.
 180       $dataArray[] = array('row_id' => null,'label' => $i18n->get('label.notes').':'); // Insert row.
 181       // Insert empty cells with proper control ids.
 182       for ($i = 0; $i < 7; $i++) {
 183         $control_id = '1_'. $dayHeaders[$i];
 184         $dataArray[1][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
 185       }
 186     }
 187
 188     // Iterate through records and build $dataArray cell by cell.
 189     foreach ($records as $record) {
 190       // Create row id without suffix.
 191       $row_id_no_suffix = ttWeekViewHelper::makeRowIdentifier($record);
 192       // Handle potential multiple records with the same attributes by using a numerical suffix.
 193       $suffix = 0;
 194       $row_id = $row_id_no_suffix.'_'.$suffix;
 195       $day_header = substr($record['date'], 8); // Day number in month.
 196       while (ttWeekViewHelper::cellExists($row_id, $day_header, $dataArray)) {
 197         $suffix++;
 198         $row_id = $row_id_no_suffix.'_'.$suffix;
 199       }
 200       // Find row.
 201       $pos = ttWeekViewHelper::findRow($row_id, $dataArray);
 202       if ($pos < 0) {
 203         // Insert row for durations.
 204         $dataArray[] = array('row_id' => $row_id,'label' => ttWeekViewHelper::makeRowLabel($record));
 205         $pos = ttWeekViewHelper::findRow($row_id, $dataArray);
 206         // Insert empty cells with proper control ids.
 207         for ($i = 0; $i < 7; $i++) {
 208           $control_id = $pos.'_'. $dayHeaders[$i];
 209           $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
 210         }
 211         // Insert row for comments.
 212         if ($user->isPluginEnabled('wvns')) {
 213           $dataArray[] = array('row_id' => $row_id.'_notes','label' => $i18n->get('label.notes').':');
 214           $pos++;
 215           // Insert empty cells with proper control ids.
 216           for ($i = 0; $i < 7; $i++) {
 217             $control_id = $pos.'_'. $dayHeaders[$i];
 218             $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
 219           }
 220           $pos--;
 221         }
 222       }
 223       // Insert actual cell data from $record (one cell only).
 224       $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'duration' => $record['duration']);
 225       // Insert existing comment from $record into the comment cell.
 226       if ($user->isPluginEnabled('wvns')) {
 227         $pos++;
 228         $dataArray[$pos][$day_header] = array('control_id' => $pos.'_'. $day_header, 'tt_log_id' => $record['id'],'note' => $record['comment']);
 229       }
 230     }
 231     return $dataArray;
 232   }
 233
 234   // prePopulateFromPastWeeks - is a complementary function to getDataForWeekView.
 235   // It builds an "empty" $dataArray with only labels present. Labels are taken from
 236   // the most recent active past week, up to 5 weeks back from now.
 237   // This is a data entry acceleration feature to help users quickly populate their
 238   // regular entry list for a new week, even after a long vacation.
 239   static function prePopulateFromPastWeeks($startDate, $dayHeaders) {
 240     global $user;
 241     global $i18n;
 242
 243     // First, determine past week start and end dates.
 244     $objDate = new DateAndTime(DB_DATEFORMAT, $startDate);
 245     $objDate->decDay(7);
 246     $pastWeekStartDate = $objDate->toString(DB_DATEFORMAT);
 247     $objDate->incDay(6);
 248     $pastWeekEndDate = $objDate->toString(DB_DATEFORMAT);
 249     unset($objDate);
 250
 251     // Obtain past week(s) records.
 252     $records = ttWeekViewHelper::getRecordsForInterval($pastWeekStartDate, $pastWeekEndDate);
 253     // Handle potential situation of no records by re-trying for up to 4 more previous weeks (after a long vacation, etc.).
 254     if (!$records) {
 255       for ($i = 0; $i < 4; $i++) {
 256         $objDate = new DateAndTime(DB_DATEFORMAT, $pastWeekStartDate);
 257         $objDate->decDay(7);
 258         $pastWeekStartDate = $objDate->toString(DB_DATEFORMAT);
 259         $objDate->incDay(6);
 260         $pastWeekEndDate = $objDate->toString(DB_DATEFORMAT);
 261         unset($objDate);
 262
 263         $records = ttWeekViewHelper::getRecordsForInterval($pastWeekStartDate, $pastWeekEndDate);
 264         // Break out of the loop if we found something.
 265         if ($records) break;
 266       }
 267     }
 268
 269     // Construct the first row for a brand new entry.
 270     $dataArray[] = array('row_id' => null,'label' => $i18n->get('form.week.new_entry').':'); // Insert row.
 271     // Insert empty cells with proper control ids.
 272     for ($i = 0; $i < 7; $i++) {
 273       $control_id = '0_'. $dayHeaders[$i];
 274       $dataArray[0][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
 275     }
 276     // Construct the second row for daily comments for a brand new entry.
 277     $dataArray[] = array('row_id' => null,'label' => $i18n->get('label.notes').':'); // Insert row.
 278     // Insert empty cells with proper control ids.
 279     for ($i = 0; $i < 7; $i++) {
 280       $control_id = '1_'. $dayHeaders[$i];
 281       $dataArray[1][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
 282     }
 283
 284     // Iterate through records and build an "empty" $dataArray.
 285     foreach ($records as $record) {
 286       // Create row id with 0 suffix. In prepopulated view, we only need one row for similar records.
 287       $row_id = ttWeekViewHelper::makeRowIdentifier($record).'_0';
 288       // Find row.
 289       $pos = ttWeekViewHelper::findRow($row_id, $dataArray);
 290       if ($pos < 0) {
 291         // Insert row for durations.
 292         $dataArray[] = array('row_id' => $row_id,'label' => ttWeekViewHelper::makeRowLabel($record));
 293         $pos = ttWeekViewHelper::findRow($row_id, $dataArray);
 294         // Insert empty cells with proper control ids.
 295         for ($i = 0; $i < 7; $i++) {
 296           $control_id = $pos.'_'. $dayHeaders[$i];
 297           $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'duration' => null);
 298         }
 299         // Insert row for comments.
 300         $dataArray[] = array('row_id' => $row_id.'_notes','label' => $i18n->get('label.notes').':');
 301         $pos++;
 302         // Insert empty cells with proper control ids.
 303         for ($i = 0; $i < 7; $i++) {
 304           $control_id = $pos.'_'. $dayHeaders[$i];
 305           $dataArray[$pos][$dayHeaders[$i]] = array('control_id' => $control_id, 'tt_log_id' => null,'note' => null);
 306         }
 307         $pos--;
 308       }
 309     }
 310
 311     return $dataArray;
 312   }
 313
 314   // cellExists is a helper function for getDataForWeekView() to see if a cell with a given label
 315   // and a day header already exists.
 316   static function cellExists($row_id, $day_header, $dataArray) {
 317     foreach($dataArray as $row) {
 318       if ($row['row_id'] == $row_id && !empty($row[$day_header]['duration']))
 319         return true;
 320     }
 321     return false;
 322   }
 323
 324   // findRow returns an existing row position in $dataArray, -1 otherwise.
 325   static function findRow($row_id, $dataArray) {
 326     $pos = 0; // Row position in array.
 327     foreach($dataArray as $row) {
 328       if ($row['row_id'] == $row_id)
 329         return $pos;
 330       $pos++; // Increment for search.
 331     }
 332     return -1; // Row not found.
 333   }
 334
 335   // getDayTotals calculates total durations for each day from the existing data in $dataArray.
 336   static function getDayTotals($dataArray, $dayHeaders) {
 337     $dayTotals = array();
 338
 339     // Insert label.
 340     global $i18n;
 341     $dayTotals['label'] = $i18n->get('label.day_total').':';
 342
 343     foreach ($dataArray as $row) {
 344       foreach($dayHeaders as $dayHeader) {
 345         if (array_key_exists($dayHeader, $row)) {
 346           $minutes = ttTimeHelper::toMinutes($row[$dayHeader]['duration']);
 347           $dayTotals[$dayHeader] += $minutes;
 348         }
 349       }
 350     }
 351     // Convert minutes to hh:mm for display.
 352     foreach($dayHeaders as $dayHeader) {
 353       $dayTotals[$dayHeader] = ttTimeHelper::toAbsDuration($dayTotals[$dayHeader]);
 354     }
 355     return $dayTotals;
 356   }
 357
 358   // getDayHeadersForWeek - obtains day column headers for week view, which are simply day numbers in month.
 359   static function getDayHeadersForWeek($start_date) {
 360     $dayHeaders = array();
 361     $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
 362     $dayHeaders[] = (string) $objDate->getDate(); // It returns an int on first call.
 363     if (strlen($dayHeaders[0]) == 1)              // Which is an implementation detail of DateAndTime class.
 364       $dayHeaders[0] = '0'.$dayHeaders[0];        // Add a 0 for single digit day.
 365     $objDate->incDay();
 366     $dayHeaders[] = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
 367     $objDate->incDay();
 368     $dayHeaders[] = $objDate->getDate();
 369     $objDate->incDay();
 370     $dayHeaders[] = $objDate->getDate();
 371     $objDate->incDay();
 372     $dayHeaders[] = $objDate->getDate();
 373     $objDate->incDay();
 374     $dayHeaders[] = $objDate->getDate();
 375     $objDate->incDay();
 376     $dayHeaders[] = $objDate->getDate();
 377     unset($objDate);
 378     return $dayHeaders;
 379   }
 380
 381   // getLockedDaysForWeek - builds an array of locked days in week.
 382   static function getLockedDaysForWeek($start_date) {
 383     global $user;
 384     $lockedDays = array();
 385     $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
 386     for ($i = 0; $i < 7; $i++) {
 387       $lockedDays[] = $user->isDateLocked($objDate);
 388       $objDate->incDay();
 389     }
 390     unset($objDate);
 391     return $lockedDays;
 392   }
 393
 394   // makeRowIdentifier - builds a string identifying a row for a week view from a single record properties.
 395   //                     Note that the return value is without a suffix.
 396   // For example:
 397   // "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
 398   // "cl:546,bl:1,pr:23456,ts:27464,cf_1:7623"
 399   static function makeRowIdentifier($record) {
 400     global $user;
 401     // Start with client.
 402     if ($user->isPluginEnabled('cl'))
 403       $row_identifier = $record['client_id'] ? 'cl:'.$record['client_id'] : '';
 404     // Add billable flag.
 405     if (!empty($row_identifier)) $row_identifier .= ',';
 406     $row_identifier .= 'bl:'.$record['billable'];
 407     // Add project.
 408     $row_identifier .= $record['project_id'] ? ',pr:'.$record['project_id'] : '';
 409     // Add task.
 410     $row_identifier .= $record['task_id'] ? ',ts:'.$record['task_id'] : '';
 411     // Add custom field 1.
 412     if ($user->isPluginEnabled('cf')) {
 413       if ($record['cf_1_id'])
 414         $row_identifier .= ',cf_1:'.$record['cf_1_id'];
 415       else if ($record['cf_1_value'])
 416         $row_identifier .= ',cf_1:'.$record['cf_1_value'];
 417     }
 418
 419     return $row_identifier;
 420   }
 421
 422   // makeRowLabel - builds a human readable label for a row in week view,
 423   // which is a combination ot record properties.
 424   // Client - Project - Task - Custom field 1.
 425   // Note that billable property is not part of the label. Instead,
 426   // we identify such records with a different color in week view.
 427   static function makeRowLabel($record) {
 428     global $user;
 429     // Start with client.
 430     if ($user->isPluginEnabled('cl'))
 431       $label = $record['client'];
 432
 433     // Add project.
 434     if (!empty($label) && !empty($record['project'])) $label .= ' - ';
 435     $label .= $record['project'];
 436
 437     // Add task.
 438     if (!empty($label) && !empty($record['task'])) $label .= ' - ';
 439     $label .= $record['task'];
 440
 441     // Add custom field 1.
 442     if ($user->isPluginEnabled('cf')) {
 443       if (!empty($label) && !empty($record['cf_1_value'])) $label .= ' - ';
 444       $label .= $record['cf_1_value'];
 445     }
 446
 447     return $label;
 448   }
 449
 450   // parseFromWeekViewRow - obtains field value encoded in row identifier.
 451   // For example, for a row id like "cl:546,bl:0,pr:23456,ts:27464,cf_1:example text"
 452   // requesting a client "cl" should return 546.
 453   static function parseFromWeekViewRow($row_id, $field_label) {
 454     // Find beginning of label.
 455     $pos = strpos($row_id, $field_label);
 456     if ($pos === false) return null; // Not found.
 457
 458     // Strip suffix from row id.
 459     $suffixPos = strrpos($row_id, '_');
 460     if ($suffixPos)
 461       $remaninder = substr($row_id, 0, $suffixPos);
 462
 463     // Find beginning of value.
 464     $posBegin = 1 + strpos($remaninder, ':', $pos);
 465     // Find end of value.
 466     $posEnd = strpos($remaninder, ',', $posBegin);
 467     if ($posEnd === false) $posEnd = strlen($remaninder);
 468     // Return value.
 469     return substr($remaninder, $posBegin, $posEnd - $posBegin);
 470   }
 471
 472   // dateFromDayHeader calculates date from start date and day header in week view.
 473   static function dateFromDayHeader($start_date, $day_header) {
 474     $objDate = new DateAndTime(DB_DATEFORMAT, $start_date);
 475     $currentDayHeader = (string) $objDate->getDate(); // It returns an int on first call.
 476     if (strlen($currentDayHeader) == 1)               // Which is an implementation detail of DateAndTime class.
 477       $currentDayHeader = '0'.$currentDayHeader;      // Add a 0 for single digit day.
 478     $i = 1;
 479     while ($currentDayHeader != $day_header && $i < 7) {
 480       // Iterate through remaining days to find a match.
 481       $objDate->incDay();
 482       $currentDayHeader = $objDate->getDate(); // After incDay it returns a string with leading 0, when necessary.
 483       $i++;
 484     }
 485     return $objDate->toString(DB_DATEFORMAT);
 486   }
 487
 488   // insertDurationFromWeekView - inserts a new record in log tables from a week view post.
 489   static function insertDurationFromWeekView($fields, $custom_fields, $err) {
 490     global $i18n;
 491     global $user;
 492
 493     // Determine date for a new entry.
 494     $entry_date = ttWeekViewHelper::dateFromDayHeader($fields['start_date'], $fields['day_header']);
 495     $objEntryDate = new DateAndTime(DB_DATEFORMAT, $entry_date);
 496
 497     // Prohibit creating entries in future.
 498     if (!$user->future_entries && $fields['browser_today']) {
 499       $objBrowserToday = new DateAndTime(DB_DATEFORMAT, $fields['browser_today']);
 500       if ($objEntryDate->after($objBrowserToday)) {
 501         $err->add($i18n->get('error.future_date'));
 502         return false;
 503       }
 504     }
 505
 506     // Prepare an array of fields for regular insert function.
 507     $fields4insert = array();
 508     $fields4insert['user_id'] = $user->getUser();
 509     $fields4insert['group_id'] = $user->getGroup();
 510     $fields4insert['org_id'] = $user->org_id;
 511     $fields4insert['date'] = $entry_date;
 512     $fields4insert['duration'] = $fields['duration'];
 513     $fields4insert['client'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'cl');
 514     $fields4insert['billable'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'bl');
 515     $fields4insert['project'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'pr');
 516     $fields4insert['task'] = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'ts');
 517     $fields4insert['note'] = $fields['note'];
 518
 519     // Try to insert a record.
 520     $id = ttTimeHelper::insert($fields4insert);
 521     if (!$id) return false; // Something failed.
 522
 523     // Insert custom field if we have it.
 524     $result = true;
 525     $cf_1 = ttWeekViewHelper::parseFromWeekViewRow($fields['row_id'], 'cf_1');
 526     if ($custom_fields && $cf_1) {
 527       if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
 528         $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], null, $cf_1);
 529       elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
 530         $result = $custom_fields->insert($id, $custom_fields->fields[0]['id'], $cf_1, null);
 531     }
 532
 533     return $result;
 534   }
 535
 536   // modifyDurationFromWeekView - modifies a duration of an existing record from a week view post.
 537   static function modifyDurationFromWeekView($fields, $err) {
 538     global $i18n;
 539     global $user;
 540
 541     // Possible errors: 1) Overlap if the existing record has start time. 2) Going beyond 24 hour boundary.
 542     if (!ttWeekViewHelper::canModify($fields['tt_log_id'], $fields['duration'], $err))
 543       return false;
 544
 545     $mdb2 = getConnection();
 546     $duration = $fields['duration'];
 547     $tt_log_id = $fields['tt_log_id'];
 548     $user_id = $user->getUser();
 549     $sql = "update tt_log set duration = '$duration' where id = $tt_log_id and user_id = $user_id";
 550     $affected = $mdb2->exec($sql);
 551     if (is_a($affected, 'PEAR_Error'))
 552       return false;
 553
 554     return true;
 555   }
 556
 557   // canModify - determines if an  already existing tt_log record
 558   // can be modified with a new user-provided duration.
 559   static function canModify($tt_log_id, $new_duration, $err) {
 560     global $i18n;
 561     $mdb2 = getConnection();
 562
 563     // Determine if we have start time in record, as further checking does not makes sense otherwise.
 564     $sql = "select user_id, date, start, duration from tt_log  where id = $tt_log_id";
 565     $res = $mdb2->query($sql);
 566     if (!is_a($res, 'PEAR_Error')) {
 567       if (!$res->numRows()) {
 568         $err->add($i18n->get('error.db')); // This is not expected.
 569         return false;
 570       }
 571       $val = $res->fetchRow();
 572       $oldDuration = $val['duration'];
 573       if (!$val['start'])
 574         return true; // There is no start time in the record, therefore safe to modify.
 575     }
 576
 577     // We do have start time.
 578     // Quick test if new duration is less then already existing.
 579     $newMinutes = ttTimeHelper::toMinutes($new_duration);
 580     $oldMinutes = ttTimeHelper::toMinutes($oldDuration);
 581     if ($newMinutes < $oldMinutes)
 582       return true; // Safe to modify.
 583
 584     // Does the new duration put the record beyond 24:00 boundary?
 585     $startMinutes = ttTimeHelper::toMinutes($val['start']);
 586     $newEndMinutes = $startMinutes + $newMinutes;
 587     if ($newEndMinutes > 1440) {
 588       // Invalid duration, as new duration puts the record beyond current day.
 589       $err->add($i18n->get('error.field'), $i18n->get('label.duration'));
 590       return false;
 591     }
 592
 593     // Does the new duration causes the record to overlap with others?
 594     $user_id = $val['user_id'];
 595     $date = $val['date'];
 596     $startMinutes = ttTimeHelper::toMinutes($val['start']);
 597     $start = ttTimeHelper::toAbsDuration($startMinutes);
 598     $finish = ttTimeHelper::toAbsDuration($newEndMinutes);
 599     if (ttTimeHelper::overlaps($user_id, $date, $start, $finish, $tt_log_id)) {
 600       $err->add($i18n->get('error.overlap'));
 601       return false;
 602     }
 603
 604     return true; // There are no conflicts, safe to modify.
 605   }
 606
 607   // modifyCommentFromWeekView - modifies a comment in an existing record from a week view post.
 608   static function modifyCommentFromWeekView($fields) {
 609     global $user;
 610
 611     $mdb2 = getConnection();
 612     $tt_log_id = $fields['tt_log_id'];
 613     $comment = $fields['comment'];
 614     $user_id = $user->getUser();
 615     $sql = "update tt_log set comment = ".$mdb2->quote($fields['comment'])." where id = $tt_log_id and user_id = $user_id";
 616     $affected = $mdb2->exec($sql);
 617     if (is_a($affected, 'PEAR_Error'))
 618       return false;
 619
 620     return true;
 621   }
 622 }