Added project_id to tt_timesheets table.
[timetracker.git] / WEB-INF / lib / ttTimesheetHelper.class.php
index 3e44c8c..78e7901 100644 (file)
@@ -28,6 +28,8 @@
 
 import('ttUserHelper');
 import('ttGroupHelper');
+import('form.ActionForm');
+import('ttReportHelper');
 
 // Class ttTimesheetHelper is used to help with project related tasks.
 class ttTimesheetHelper {
@@ -52,29 +54,51 @@ class ttTimesheetHelper {
     return false;
   }
 
-  // insert function inserts a new timesheet into database.
-  static function insert($fields)
+  // createTimesheet function creates a new timesheet.
+  static function createTimesheet($fields)
   {
+    // Create a new timesheet entry.
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
-    $user_id = $fields['user_id'];
     $client_id = $fields['client_id'];
+    $project_id = $fields['project_id'];
     $name = $fields['name'];
-    $submitter_comment = $fields['comment'];
+    $comment = $fields['comment'];
 
-    $sql = "insert into tt_timesheets (user_id, group_id, org_id, client_id, name, submitter_comment)".
-      " values ($user_id, $group_id, $org_id, ".$mdb2->quote($client_id).", ".$mdb2->quote($name).", ".$mdb2->quote($submitter_comment).")";
+    $start_date = new DateAndTime($user->date_format, $fields['start_date']);
+    $start = $start_date->toString(DB_DATEFORMAT);
+
+    $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, 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'))
       return false;
 
     $last_id = $mdb2->lastInsertID('tt_timesheets', 'id');
 
-    // TODO: Associate report items with new timesheet.
+    // Associate time 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.
+    if ($client_id) $client_part = " and client_id = $client_id";
+    if ($project_id) $project_part = " and project_id = $project_id";
+
+    $sql = "update tt_log set timesheet_id = $last_id".
+      " where status = 1 $client_part $project_part and timesheet_id is null".
+      " and date >= ".$mdb2->quote($start)." and date <= ".$mdb2->quote($end).
+      " 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;
 
     return $last_id;
   }
@@ -94,7 +118,7 @@ class ttTimesheetHelper {
     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 = 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";
@@ -148,13 +172,16 @@ class ttTimesheetHelper {
     global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
     $group_id = $user->getGroup();
     $org_id = $user->org_id;
 
-    if ($user->isClient()) $client_part = "and client_id = $user->client_id";
-
-    $sql = "select * from tt_timesheets".
-      " where id = $timesheet_id and group_id = $group_id and org_id = $org_id $client_part 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())
@@ -214,23 +241,168 @@ class ttTimesheetHelper {
   // in current context.
   static function isUserValid($user_id) {
     // We have to cover several situations.
-    //
-    // 1) User is a client.
-    // 2) User with view_all_timesheets rights.
-    // 3) User with view_timesheets rights.
 
     global $user;
 
-    // Step 1.
-    // A client must have view_client_timesheets and
-    // aser must be assigned to one of client projects.
-    if ($user->isClient()) {
-      if (!$user->can('view_client_timesheets'))
-        return false;
-      $valid_users = ttGroupHelper::getUsersForClient($user->client_id);
-      $v = 2;
+    // 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) {
+    global $user;
+    $group_by_client = $user->isPluginEnabled('cl') && !$timesheet['client_id'];
+    $trackingMode = $user->getTrackingMode();
+    $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';
     }
+    if ($options['group_by2'] && $options['group_by2'] != 'project' && $group_by_project) {
+      $options['group_by3'] = 'project';
+    }
+    return $options;
+  }
+
+  // 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) {
+    global $user;
+    $mdb2 = getConnection();
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    $approvers = array();
+    $rank = ttUserHelper::getUserRank($user_id);
+    $sql = "select u.id, u.name, u.email".
+      " 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.rank > $rank and r.rights like '%approve_timesheets%')";
+    $res = $mdb2->query($sql);
+    if (!is_a($res, 'PEAR_Error')) {
+      while ($val = $res->fetchRow()) {
+        $approvers[] = $val;
+      }
+    }
+    return $approvers;
+  }
+
+  // submitTimesheet marks a timesheet as submitted and sends an email to an approver.
+  static function submitTimesheet($fields) {
+    global $user;
+    $mdb2 = getConnection();
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    // First, mark a timesheet as submitted.
+    // Even if mail part below does not work, this will get us a functioning workflow
+    // (without email notifications).
+    $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";
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error')) return false;
+
+    // TODO: send email to approver here...
+    // $approver_id = $fields['approver_id'];
+
+    return true;
+  }
+
+  // approveTimesheet marks a timesheet as approved and sends an email to submitter.
+  static function approveTimesheet($fields) {
+    global $user;
+    $mdb2 = getConnection();
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    // First, mark a timesheet as approved.
+    // Even if mail part below does not work, this will get us a functioning workflow
+    // (without email notifications).
+    $timesheet_id = $fields['timesheet_id'];
+    $comment = $fields['comment'];
 
+    $sql = "update tt_timesheets set approve_status = 1, approve_comment = ".$mdb2->quote($comment).
+      " where id = $timesheet_id and submit_status = 1 and group_id = $group_id and org_id = $org_id";
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error')) return false;
+
+    // TODO: send email to submitter here...
     return true;
   }
+
+  // disapproveTimesheet marks a timesheet as approved and sends an email to submitter.
+  static function disapproveTimesheet($fields) {
+    global $user;
+    $mdb2 = getConnection();
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    // First, mark a timesheet as disapproved.
+    // Even if mail part below does not work, this will get us a functioning workflow
+    // (without email notifications).
+    $timesheet_id = $fields['timesheet_id'];
+    $comment = $fields['comment'];
+
+    $sql = "update tt_timesheets set approve_status = 0, approve_comment = ".$mdb2->quote($comment).
+      " where id = $timesheet_id and submit_status = 1 and group_id = $group_id and org_id = $org_id";
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error')) return false;
+
+    // TODO: send email to submitter here...
+    return true;
+  }
+
+  // The timesheetItemsExist determines whether tt_log records exist in the specified period
+  // for inclusion in a new timesheet.
+  static function timesheetItemsExist($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);
+
+    $end_date = new DateAndTime($user->date_format, $fields['end_date']);
+    $end = $end_date->toString(DB_DATEFORMAT);
+
+    // sql parts.
+    if ($client_id) $client_part = " and client_id = $client_id";
+    if ($project_id) $project_part = " and project_id = $project_id";
+
+    $sql = "select count(*) as num from tt_log".
+      " where status = 1 $client_part $project_part and timesheet_id is null".
+      " and date >= ".$mdb2->quote($start)." and date <= ".$mdb2->quote($end).
+      " 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['num']) {
+        return true;
+      }
+    }
+
+    return false;
+  }
 }