Improved safety of timesheet assignment by adding an inner join.
[timetracker.git] / WEB-INF / lib / ttTimesheetHelper.class.php
index 6b13ae5..a348cb5 100644 (file)
 // +----------------------------------------------------------------------+
 
 import('ttUserHelper');
-import('ttGroupHelper');
-import('form.ActionForm');
-import('ttReportHelper');
 
 // Class ttTimesheetHelper is used to help with project related tasks.
 class ttTimesheetHelper {
 
   // The getTimesheetByName looks up a project by name.
-  static function getTimesheetByName($name, $user_id) {
+  static function getTimesheetByName($name) {
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
     $sql = "select id from tt_timesheets".
       " where group_id = $group_id and org_id = $org_id and user_id = $user_id and name = ".$mdb2->quote($name).
-      " and (status = 1 or status = 0)";
+      " and status is not null";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       $val = $res->fetchRow();
@@ -66,6 +64,7 @@ class ttTimesheetHelper {
     $org_id = $user->org_id;
 
     $client_id = $fields['client_id'];
+    $project_id = $fields['project_id'];
     $name = $fields['name'];
     $comment = $fields['comment'];
 
@@ -75,8 +74,8 @@ class ttTimesheetHelper {
     $end_date = new DateAndTime($user->date_format, $fields['end_date']);
     $end = $end_date->toString(DB_DATEFORMAT);
 
-    $sql = "insert into tt_timesheets (user_id, group_id, org_id, client_id, name, comment, start_date, end_date)".
-      " values ($user_id, $group_id, $org_id, ".$mdb2->quote($client_id).", ".$mdb2->quote($name).
+    $sql = "insert into tt_timesheets (user_id, group_id, org_id, client_id, project_id, name, comment, start_date, end_date)".
+      " values ($user_id, $group_id, $org_id, ".$mdb2->quote($client_id).", ".$mdb2->quote($project_id).", ".$mdb2->quote($name).
       ", ".$mdb2->quote($comment).", ".$mdb2->quote($start).", ".$mdb2->quote($end).")";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error'))
@@ -84,7 +83,7 @@ class ttTimesheetHelper {
 
     $last_id = $mdb2->lastInsertID('tt_timesheets', 'id');
 
-    // Associate time items with timesheet.
+    // Associate tt_log items with timesheet.
     if (isset($fields['client'])) $client_id = (int) $fields['client_id'];
     if (isset($fields['project_id'])) $project_id = (int) $fields['project_id'];
     // sql parts.
@@ -103,31 +102,25 @@ class ttTimesheetHelper {
   }
 
   // The getActiveTimesheets obtains active timesheets for a user.
-  static function getActiveTimesheets($user_id)
+  static function getActiveTimesheets()
   {
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
-    // $addPaidStatus = $user->isPluginEnabled('ps');
     $result = array();
-
-    if ($user->isClient())
-      $client_part = "and ts.client_id = $user->client_id";
-
-    $sql = "select ts.id, ts.name, ts.client_id, c.name as client_name, ts.submit_status, ts.approve_status from tt_timesheets ts".
+    $sql = "select ts.id, ts.name, ts.client_id, c.name as client_name,".
+      " ts.submit_status, ts.approve_status from tt_timesheets ts".
       " left join tt_clients c on (c.id = ts.client_id)".
       " where ts.status = 1 and ts.group_id = $group_id and ts.org_id = $org_id and ts.user_id = $user_id".
-      " $client_part order by ts.name";
+      " order by ts.name";
     $res = $mdb2->query($sql);
     $result = array();
     if (!is_a($res, 'PEAR_Error')) {
-      $dt = new DateAndTime(DB_DATEFORMAT);
       while ($val = $res->fetchRow()) {
-        //if ($addPaidStatus)
-        //  $val['paid'] = ttTimesheetHelper::isPaid($val['id']);
         $result[] = $val;
       }
     }
@@ -135,31 +128,25 @@ class ttTimesheetHelper {
   }
 
   // The getInactiveTimesheets obtains inactive timesheets for a user.
-  static function getInactiveTimesheets($user_id)
+  static function getInactiveTimesheets()
   {
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
-    // $addPaidStatus = $user->isPluginEnabled('ps');
     $result = array();
-
-    if ($user->isClient())
-      $client_part = "and ts.client_id = $user->client_id";
-
-    $sql = "select ts.id, ts.name, ts.client_id, c.name as client_name, ts.submit_status, ts.approval_status from tt_timesheets ts".
+    $sql = "select ts.id, ts.name, ts.client_id, c.name as client_name,".
+      " ts.submit_status, ts.approve_status from tt_timesheets ts".
       " left join tt_clients c on (c.id = ts.client_id)".
       " where ts.status = 0 and ts.group_id = $group_id and ts.org_id = $org_id and ts.user_id = $user_id".
-      " $client_part order by ts.name";
+      " order by ts.name";
     $res = $mdb2->query($sql);
     $result = array();
     if (!is_a($res, 'PEAR_Error')) {
-      $dt = new DateAndTime(DB_DATEFORMAT);
       while ($val = $res->fetchRow()) {
-        //if ($addPaidStatus)
-        //  $val['paid'] = ttTimesheetHelper::isPaid($val['id']);
         $result[] = $val;
       }
     }
@@ -175,8 +162,12 @@ class ttTimesheetHelper {
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
-    $sql = "select * from tt_timesheets".
-      " where id = $timesheet_id and user_id = $user_id and group_id = $group_id and org_id = $org_id and status is not null";
+    $sql = "select ts.*, u.name as user_name, c.name as client_name,".
+      " p.name as project_name from tt_timesheets ts".
+      " left join tt_users u on (ts.user_id = u.id)".
+      " left join tt_clients c on (ts.client_id = c.id)".
+      " left join tt_projects p on (ts.project_id = p.id)".
+      " where ts.id = $timesheet_id and ts.user_id = $user_id and ts.group_id = $group_id and ts.org_id = $org_id and ts.status is not null";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       if ($val = $res->fetchRow())
@@ -190,24 +181,19 @@ class ttTimesheetHelper {
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
-    // Handle time records.
+    // Handle tt_log records.
     $sql = "update tt_log set timesheet_id = null".
-      " where timesheet_id = $timesheet_id and group_id = $group_id and org_id = $org_id";
-    $affected = $mdb2->exec($sql);
-    if (is_a($affected, 'PEAR_Error')) return false;
-
-    // Handle expense items.
-    $sql = "update tt_expense_items set timesheet_id = null".
-      " where timesheet_id = $timesheet_id and group_id = $group_id and org_id = $org_id";
+      " where timesheet_id = $timesheet_id and user_id = $user_id and group_id = $group_id and org_id = $org_id";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error')) return false;
 
     // Delete timesheet.
     $sql = "update tt_timesheets set status = null".
-      " where id = $timesheet_id and group_id = $group_id and org_id = $org_id";
+      " where id = $timesheet_id and user_id = $user_id and group_id = $group_id and org_id = $org_id";
     $affected = $mdb2->exec($sql);
     return (!is_a($affected, 'PEAR_Error'));
   }
@@ -217,34 +203,22 @@ class ttTimesheetHelper {
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
     $timesheet_id = $fields['id']; // Timesheet we are updating.
     $name = $fields['name']; // Timesheet name.
-    $submitter_comment = $fields['submitter_comment'];
-    $status = $fields['status']; // Project status.
+    $comment = $fields['comment'];
+    $status = $fields['status']; // Timesheet status.
 
-    $sql = "update tt_timesheets set name = ".$mdb2->quote($name).", submitter_comment = ".$mdb2->quote($submitter_comment).
+    $sql = "update tt_timesheets set name = ".$mdb2->quote($name).", comment = ".$mdb2->quote($comment).
       ", status = ".$mdb2->quote($status).
-      " where id = $timesheet_id and group_id = $group_id and org_id = $org_id";
+      " where id = $timesheet_id and user_id = $user_id and group_id = $group_id and org_id = $org_id";
     $affected = $mdb2->exec($sql);
     return (!is_a($affected, 'PEAR_Error'));
   }
 
-  // isUserValid function is used during access checks and determines whether user id, passed in post, is valid
-  // in current context.
-  static function isUserValid($user_id) {
-    // We have to cover several situations.
-
-    global $user;
-
-    // TODO: we are currently re-designing timesheets.
-    // Clients are not supposed to view them at all.
-    // And the post will change on_behalf user, to keep things consistent.
-    return false;
-  }
-
   // getReportOptions prepares $options array to be used with ttReportHelper
   // to obtain items for timesheet view.
   static function getReportOptions($timesheet) {
@@ -254,11 +228,6 @@ class ttTimesheetHelper {
     $group_by_project = MODE_PROJECTS == $trackingMode || MODE_PROJECTS_AND_TASKS == $trackingMode;
 
     $options['timesheet_id'] = $timesheet['id'];
-    $options['client_id'] = $timesheet['client_id'];
-    $options['users'] = $timesheet['user_id'];
-    $options['show_durarion'] = 1;
-    $options['show_cost'] = 1; // To include expenses.
-    $options['show_totals_only'] = 1;
     $options['group_by1'] = 'date';
     if ($group_by_client || $group_by_project) {
       $options['group_by2'] = $group_by_client ? 'client' : 'project';
@@ -271,10 +240,11 @@ class ttTimesheetHelper {
 
   // getApprovers obtains a list of users who can approve a timesheet for a given user
   // and also have an email to receive a notification about it.
-  static function getApprovers($user_id) {
+  static function getApprovers() {
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
@@ -284,7 +254,7 @@ class ttTimesheetHelper {
       " from tt_users u".
       " left join tt_roles r on (r.id = u.role_id)".
       " where u.status = 1 and u.email is not null and u.group_id = $group_id and u.org_id = $org_id".
-      " and (r.rights like '%approve_all_timesheets%' or (r.rank > $rank and r.rights like '%approve_timesheets%'))";
+      " and (r.rank > $rank and r.rights like '%approve_timesheets%')";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       while ($val = $res->fetchRow()) {
@@ -294,20 +264,22 @@ class ttTimesheetHelper {
     return $approvers;
   }
 
-  // submitTimesheet marks a timesheet as submitted and sends an email to an approver.
+  // submitTimesheet marks a timesheet as submitted and also sends an email
+  // to a selected approver.
   static function submitTimesheet($fields) {
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
-    // First, mark timesheet as submitted.
+    // First, mark timesheet as submitted.
     // Even if mail part below does not work, this will get us a functioning workflow
-    // (without email notifications).
+    // without email notification.
     $timesheet_id = $fields['timesheet_id'];
     $sql = "update tt_timesheets set submit_status = 1".
-      " where id = $timesheet_id and group_id = $group_id and org_id = $org_id";
+      " where id = $timesheet_id and user_id = $user_id and group_id = $group_id and org_id = $org_id";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error')) return false;
 
@@ -322,17 +294,18 @@ class ttTimesheetHelper {
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
-    // First, mark timesheet as approved.
+    // First, mark timesheet as approved.
     // Even if mail part below does not work, this will get us a functioning workflow
-    // (without email notifications).
+    // without email notification.
     $timesheet_id = $fields['timesheet_id'];
-    $manager_comment = $fields['comment'];
+    $comment = $fields['comment'];
 
-    $sql = "update tt_timesheets set approval_status = 1, manager_comment = ".$mdb2->quote($manager_comment).
-      " where id = $timesheet_id and submit_status = 1 and group_id = $group_id and org_id = $org_id";
+    $sql = "update tt_timesheets set approve_status = 1, approve_comment = ".$mdb2->quote($comment).
+      " where id = $timesheet_id and submit_status = 1 and user_id = $user_id and group_id = $group_id and org_id = $org_id";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error')) return false;
 
@@ -345,17 +318,18 @@ class ttTimesheetHelper {
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
-    // First, mark timesheet as disapproved.
+    // First, mark timesheet as disapproved.
     // Even if mail part below does not work, this will get us a functioning workflow
-    // (without email notifications).
+    // without email notification.
     $timesheet_id = $fields['timesheet_id'];
-    $manager_comment = $fields['comment'];
+    $comment = $fields['comment'];
 
-    $sql = "update tt_timesheets set approval_status = 0, manager_comment = ".$mdb2->quote($manager_comment).
-      " where id = $timesheet_id and submit_status = 1 and group_id = $group_id and org_id = $org_id";
+    $sql = "update tt_timesheets set approve_status = 0, approve_comment = ".$mdb2->quote($comment).
+      " where id = $timesheet_id and submit_status = 1 and user_id = $user_id and group_id = $group_id and org_id = $org_id";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error')) return false;
 
@@ -400,4 +374,101 @@ class ttTimesheetHelper {
 
     return false;
   }
+
+  // The overlaps function determines if a new timesheet overlaps with
+  // an already existing timesheet.
+  static function overlaps($fields) {
+    global $user;
+    $mdb2 = getConnection();
+
+    $user_id = $user->getUser();
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    if (isset($fields['client_id'])) $client_id = (int) $fields['client_id'];
+    if (isset($fields['project_id'])) $project_id = (int) $fields['project_id'];
+
+    $start_date = new DateAndTime($user->date_format, $fields['start_date']);
+    $start = $start_date->toString(DB_DATEFORMAT);
+    $quoted_start = $mdb2->quote($start);
+
+    $end_date = new DateAndTime($user->date_format, $fields['end_date']);
+    $end = $end_date->toString(DB_DATEFORMAT);
+    $quoted_end = $mdb2->quote($end);
+
+    // sql parts.
+    if ($client_id) $client_part = " and client_id = $client_id";
+    if ($project_id) $project_part = " and project_id = $project_id";
+
+    $sql = "select id from tt_timesheets".
+      " where status is not null $client_part $project_part".
+      " and (($quoted_start >= start_date and $quoted_start <= end_date)".
+      "   or ($quoted_end >= start_date and $quoted_end <= end_date))".
+      " and user_id = $user_id and group_id = $group_id and org_id = $org_id";
+    $res = $mdb2->query($sql);
+    if (!is_a($res, 'PEAR_Error')) {
+      $val = $res->fetchRow();
+      if ($val['id']) {
+        return true;
+      }
+    }
+    return false;
+  }
+
+  // The getMatchingTimesheets function retrieves a timesheet that "matches"
+  // a report for an option to assign report items to it.
+  //
+  // Condition: report range is fully enclosed in an existing timesheet with
+  // matching client_id and project_id and null approved_status.
+  static function getMatchingTimesheets($options) {
+    global $user;
+    $mdb2 = getConnection();
+
+    $user_id = $user->getUser();
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    // Check users.
+    if (isset($options['users'])) {
+      $comma_separated = $options['users'];
+      $users = explode(',', $comma_separated);
+      if (count($users) > 1 || $users[0] != $user->getUser())
+        return false;
+    }
+
+    // No timesheets for expenses.
+    if ($options['show_cost'] && $user->isPluginEnabled('ex')) return false;
+    
+    // Parts for client and project.
+    if ($options['client_id']) $client_part = ' and client_id = '.(int)$options['client_id'];
+    if ($options['project_id']) $project_part = ' and project_id = '.(int)$options['project_id'];
+    // TODO: test and fix the above for NULL client and project ids...
+
+    // Determine start and end dates.
+    $dateFormat = $user->getDateFormat();
+    if ($options['period'])
+      $period = new Period($options['period'], new DateAndTime($dateFormat));
+    else {
+      $period = new Period();
+      $period->setPeriod(
+        new DateAndTime($dateFormat, $options['period_start']),
+        new DateAndTime($dateFormat, $options['period_end']));
+    }
+    $start = $period->getStartDate(DB_DATEFORMAT);
+    $end = $period->getEndDate(DB_DATEFORMAT);
+
+    $result = false;
+    $sql = "select id, name from tt_timesheets".
+      " where ".$mdb2->quote($start)." >= start_date and ".$mdb2->quote($end)." <= end_date".
+      "$client_part $project_part".
+      " and user_id = $user_id and group_id = $group_id and org_id = $org_id".
+      " and approve_status is null and status is not null";
+    $res = $mdb2->query($sql);
+    if (!is_a($res, 'PEAR_Error')) {
+      while ($val = $res->fetchRow()) {
+        $result[] = $val;
+      }
+    }
+    return $result;
+  }
 }