Merged getRecords and getRecordsWithFiles into one function to keep things compact.
[timetracker.git] / WEB-INF / lib / ttTimeHelper.class.php
index a66652b..9ad64fc 100644 (file)
@@ -132,17 +132,21 @@ class ttTimeHelper {
     if (!isset($duration) || strlen($duration) == 0)
       return null; // Value is not set. Caller decides whether it is valid or not.
 
+    // We allow negative durations, similar to negative expenses (installments).
+    $signMultiplier = ttStartsWith($duration, '-') ? -1 : 1;
+    if ($signMultiplier == -1) $duration = ltrim($duration, '-');
+
     // Handle whole hours.
     if (preg_match('/^\d{1,3}h?$/', $duration )) { // 0 - 999, 0h - 999h
       $minutes = 60 * trim($duration, 'h');
-      return $minutes > $max ? false : $minutes;
+      return $minutes > $max ? false : $signMultiplier * $minutes;
     }
 
     // Handle a normalized duration value.
     if (preg_match('/^\d{1,3}:[0-5][0-9]$/', $duration )) { // 0:00 - 999:59
       $time_array = explode(':', $duration);
       $minutes = (int)@$time_array[1] + ((int)@$time_array[0]) * 60;
-      return $minutes > $max ? false : $minutes;
+      return $minutes > $max ? false : $signMultiplier * $minutes;
     }
 
     // Handle localized fractional hours.
@@ -153,13 +157,13 @@ class ttTimeHelper {
           $duration = str_replace (',', '.', $duration);
 
         $minutes = (int)round(60 * floatval($duration));
-        return $minutes > $max ? false : $minutes;
+        return $minutes > $max ? false : $signMultiplier * $minutes;
     }
 
     // Handle minutes. Some users enter durations like 10m (meaning 10 minutes).
     if (preg_match('/^\d{1,5}m$/', $duration )) { // 0m - 99999m
       $minutes = (int) trim($duration, 'm');
-      return $minutes > $max ? false : $minutes;
+      return $minutes > $max ? false : $signMultiplier * $minutes;
     }
 
     // Everything else is not a valid duration.
@@ -169,22 +173,26 @@ class ttTimeHelper {
   // minutesToDuration converts an integer number of minutes into duration string.
   // Formats returned HH:MM, HHH:MM, HH, or HHH.
   static function minutesToDuration($minutes, $abbreviate = false) {
-    if ($minutes < 0) return false;
+    $sign = $minutes >= 0 ? '' : '-';
+    $minutes = abs($minutes);
 
     $hours = (string) (int)($minutes / 60);
     $mins = (string) round(fmod($minutes, 60));
     if (strlen($mins) == 1)
       $mins = '0' . $mins;
     if ($abbreviate && $mins == '00')
-      return $hours;
+      return $sign.$hours;
 
-    return $hours.':'.$mins;
+    return $sign.$hours.':'.$mins;
   }
 
   // toMinutes - converts a time string in format 00:00 to a number of minutes.
   static function toMinutes($value) {
+    $signMultiplier = ttStartsWith($value, '-') ? -1 : 1;
+    if ($signMultiplier == -1) $duration = ltrim($duration, '-');
+
     $time_a = explode(':', $value);
-    return (int)@$time_a[1] + ((int)@$time_a[0]) * 60;
+    return $signMultiplier * ((int)@$time_a[1] + ((int)@$time_a[0]) * 60);
   }
 
   // toAbsDuration - converts a number of minutes to format 0:00
@@ -510,6 +518,15 @@ class ttTimeHelper {
     global $user;
     $mdb2 = getConnection();
 
+    // Delete associated files.
+    if ($user->isPluginEnabled('at')) {
+      import('ttFileHelper');
+      global $err;
+      $fileHelper = new ttFileHelper($err);
+      if (!$fileHelper->deleteEntityFiles($id, 'time'))
+        return false;
+    }
+
     $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
@@ -543,7 +560,7 @@ class ttTimeHelper {
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       $val = $res->fetchRow();
-      return sec_to_time_fmt_hm($val['sm']);
+      return ttTimeHelper::minutesToDuration($val['sm'] / 60);
     }
     return false;
   }
@@ -565,7 +582,7 @@ class ttTimeHelper {
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       $val = $res->fetchRow();
-      return sec_to_time_fmt_hm($val['sm']);
+      return ttTimeHelper::minutesToDuration($val['sm'] / 60);
     }
     return false;
   }
@@ -587,7 +604,7 @@ class ttTimeHelper {
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       $val = $res->fetchRow();
-      return sec_to_time_fmt_hm($val['sm']);
+      return ttTimeHelper::minutesToDuration($val['sm'] / 60);
     }
     return false;
   }
@@ -659,22 +676,27 @@ class ttTimeHelper {
   }
 
   // getRecord - retrieves a time record identified by its id.
-  static function getRecord($id, $user_id) {
+  static function getRecord($id) {
     global $user;
+
+    $user_id = $user->getUser();
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
     $sql_time_format = "'%k:%i'"; //  24 hour format.
     if ('%I:%M %p' == $user->time_format)
       $sql_time_format = "'%h:%i %p'"; // 12 hour format for MySQL TIME_FORMAT function.
 
     $mdb2 = getConnection();
 
-    $sql = "select l.id as id, TIME_FORMAT(l.start, $sql_time_format) as start,
-      TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
-      TIME_FORMAT(l.duration, '%k:%i') as duration,
-      p.name as project_name, t.name as task_name, l.comment, l.client_id, l.project_id, l.task_id, l.invoice_id, l.billable, l.paid, l.date
-      from tt_log l
-      left join tt_projects p on (p.id = l.project_id)
-      left join tt_tasks t on (t.id = l.task_id)
-      where l.id = $id and l.user_id = $user_id and l.status = 1";
+    $sql = "select l.id as id, TIME_FORMAT(l.start, $sql_time_format) as start,".
+      " TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,".
+      " TIME_FORMAT(l.duration, '%k:%i') as duration,".
+      " p.name as project_name, t.name as task_name, l.comment, l.client_id, l.project_id, l.task_id,".
+      " l.timesheet_id, l.invoice_id, l.billable, l.approved, l.paid, l.date from tt_log l".
+      " left join tt_projects p on (p.id = l.project_id)".
+      " left join tt_tasks t on (t.id = l.task_id)".
+      " where l.id = $id and l.user_id = $user_id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       if (!$res->numRows()) {
@@ -687,6 +709,82 @@ class ttTimeHelper {
     return false;
   }
 
+  // getRecordForFileView - retrieves a time record identified by its id for
+  // attachment view operation.
+  //
+  // It is different from getRecord, as we want users with appropriate rights
+  // to be able to see other users files, without changing "on behalf" user.
+  // For example, viewing reports for all users and their attached files
+  // from report links.
+  static function getRecordForFileView($id) {
+    // There are several possible situations:
+    //
+    // Record is ours. Check "view_own_reports" or "view_all_reports".
+    // Record is for the current on behalf user. Check "view_reports" or "view_all_reports".
+    // Record is for someone else. Check "view_reports" or "view_all_reports" and rank.
+    //
+    // It looks like the best way is to use 2 queries, obtain user_id first, then check rank.
+
+    global $user;
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    $mdb2 = getConnection();
+
+    // Obtain user_id for the time record.
+    $sql = "select l.id, l.user_id, l.timesheet_id, l.invoice_id, l.approved from tt_log l ".
+      " where l.id = $id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1";
+    $res = $mdb2->query($sql);
+    if (is_a($res, 'PEAR_Error')) return false;
+    if (!$res->numRows()) return false;
+
+    $val = $res->fetchRow();
+    $user_id = $val['user_id'];
+
+    // If record is ours.
+    if ($user_id == $user->id) {
+      if ($user->can('view_own_reports') || $user->can('view_all_reports')) {
+        $val['can_edit'] = !($val['timesheet_id'] || $val['invoice_id'] || $val['approved']);
+        return $val;
+      }
+      return false; // No rights.
+    }
+
+    // If record belongs to a user we impersonate.
+    if ($user->behalfUser && $user_id == $user->behalfUser->id) {
+      if ($user->can('view_reports') || $user->can('view_all_reports')) {
+        $val['can_edit'] = !($val['timesheet_id'] || $val['invoice_id'] || $val['approved']);
+        return $val;
+      }
+      return false; // No rights.
+    }
+
+    // Record belongs to someone else. We need to check user rank.
+    if (!($user->can('view_reports') || $user->can('view_all_reports'))) return false;
+    $max_rank = $user->can('view_all_reports') ? MAX_RANK : $user->getMaxRankForGroup($group_id);
+
+    $left_joins = ' left join tt_users u on (l.user_id = u.id)';
+    $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
+
+    $where_part = " where l.id = $id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1".
+    $where_part .= " and r.rank <= $max_rank";
+
+    $sql = "select l.id, l.user_id, l.timesheet_id, l.invoice_id, l.approved".
+      " from tt_log l $left_joins $where_part";
+    $res = $mdb2->query($sql);
+    if (!is_a($res, 'PEAR_Error')) {
+      if (!$res->numRows()) {
+        return false;
+      }
+      if ($val = $res->fetchRow()) {
+        $val['can_edit'] = false;
+        return $val;
+      }
+    }
+    return false;
+  }
+
   // getAllRecords - returns all time records for a certain user.
   static function getAllRecords($user_id) {
     $result = array();
@@ -709,10 +807,11 @@ class ttTimeHelper {
   }
 
   // getRecords - returns time records for a user for a given date.
-  static function getRecords($user_id, $date) {
+  static function getRecords($date, $includeFiles = false) {
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
@@ -724,19 +823,45 @@ class ttTimeHelper {
     if ($user->isPluginEnabled('cl'))
       $client_field = ", c.name as client";
 
+    $include_cf_1 = $user->isPluginEnabled('cf');
+    if ($include_cf_1) {
+      $custom_fields = new CustomFields();
+      $cf_1_type = $custom_fields->fields[0]['type'];
+      if ($cf_1_type == CustomFields::TYPE_TEXT) {
+        $custom_field = ", cfl.value as cf_1";
+      } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
+        $custom_field = ", cfo.value as cf_1";
+      }
+    }
+
+    if ($includeFiles) {
+      $filePart = ', if(Sub1.entity_id is null, 0, 1) as has_files';
+      $fileJoin =  " left join (select distinct entity_id from tt_files".
+      " where entity_type = 'time' and group_id = $group_id and org_id = $org_id and status = 1) Sub1".
+      " on (l.id = Sub1.entity_id)";
+    }
+
     $left_joins = " left join tt_projects p on (l.project_id = p.id)".
       " left join tt_tasks t on (l.task_id = t.id)";
     if ($user->isPluginEnabled('cl'))
       $left_joins .= " left join tt_clients c on (l.client_id = c.id)";
+    if ($include_cf_1) {
+      if ($cf_1_type == CustomFields::TYPE_TEXT)
+        $left_joins .= " left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1)";
+      elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
+        $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)";
+      }
+    }
+    $left_joins .= $fileJoin;
 
     $result = array();
-    $sql = "select l.id as id, TIME_FORMAT(l.start, $sql_time_format) as start,
-      TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,
-      TIME_FORMAT(l.duration, '%k:%i') as duration, p.name as project, t.name as task, l.comment, l.billable, l.invoice_id $client_field
-      from tt_log l
-      $left_joins
-      where l.date = '$date' and l.user_id = $user_id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1
-      order by l.start, l.id";
+    $sql = "select l.id as id, TIME_FORMAT(l.start, $sql_time_format) as start,".
+      " TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), $sql_time_format) as finish,".
+      " TIME_FORMAT(l.duration, '%k:%i') as duration, p.name as project, t.name as task, l.comment,".
+      " l.billable, l.approved, l.timesheet_id, l.invoice_id $client_field $custom_field $filePart from tt_log l $left_joins".
+      " where l.date = '$date' and l.user_id = $user_id and l.group_id = $group_id and l.org_id = $org_id and l.status = 1".
+      " order by l.start, l.id";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       while ($val = $res->fetchRow()) {