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