WEB-INF/lib/ttTimesheetHelper.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 import('ttUserHelper');
  30 import('ttGroupHelper');
  31 import('form.ActionForm');
  32 import('ttReportHelper');
  33
  34 // Class ttTimesheetHelper is used to help with project related tasks.
  35 class ttTimesheetHelper {
  36
  37   // The getTimesheetByName looks up a project by name.
  38   static function getTimesheetByName($name, $user_id) {
  39     global $user;
  40     $mdb2 = getConnection();
  41
  42     $group_id = $user->getGroup();
  43     $org_id = $user->org_id;
  44
  45     $sql = "select id from tt_timesheets".
  46       " where group_id = $group_id and org_id = $org_id and user_id = $user_id and name = ".$mdb2->quote($name).
  47       " and (status = 1 or status = 0)";
  48     $res = $mdb2->query($sql);
  49     if (!is_a($res, 'PEAR_Error')) {
  50       $val = $res->fetchRow();
  51       if ($val && $val['id'])
  52         return $val;
  53     }
  54     return false;
  55   }
  56
  57   // createTimesheet function creates a new timesheet.
  58   static function createTimesheet($fields)
  59   {
  60     // Create a new timesheet entry.
  61     global $user;
  62     $mdb2 = getConnection();
  63
  64     $user_id = $user->getUser();
  65     $group_id = $user->getGroup();
  66     $org_id = $user->org_id;
  67
  68     $client_id = $fields['client_id'];
  69     $name = $fields['name'];
  70     $submitter_comment = $fields['comment'];
  71
  72     $sql = "insert into tt_timesheets (user_id, group_id, org_id, client_id, name, submitter_comment)".
  73       " values ($user_id, $group_id, $org_id, ".$mdb2->quote($client_id).", ".$mdb2->quote($name).", ".$mdb2->quote($submitter_comment).")";
  74     $affected = $mdb2->exec($sql);
  75     if (is_a($affected, 'PEAR_Error'))
  76       return false;
  77
  78     $last_id = $mdb2->lastInsertID('tt_timesheets', 'id');
  79
  80     // Associate time items with timesheet.
  81     if (isset($fields['client'])) $client_id = (int) $fields['client_id'];
  82     if (isset($fields['project_id'])) $project_id = (int) $fields['project_id'];
  83     // sql parts.
  84     if ($client_id) $client_part = " and client_id = $client_id";
  85     if ($project_id) $project_part = " and project_id = $project_id";
  86
  87     $start_date = new DateAndTime($user->date_format, $fields['start_date']);
  88     $start = $start_date->toString(DB_DATEFORMAT);
  89
  90     $end_date = new DateAndTime($user->date_format, $fields['end_date']);
  91     $end = $end_date->toString(DB_DATEFORMAT);
  92
  93     $sql = "update tt_log set timesheet_id = $last_id".
  94       " where status = 1 $client_part $project_part and timesheet_id is null".
  95       " and date >= ".$mdb2->quote($start)." and date <= ".$mdb2->quote($end).
  96       " and user_id = $user_id and group_id = $group_id and org_id = $org_id";
  97     $affected = $mdb2->exec($sql);
  98     if (is_a($affected, 'PEAR_Error'))
  99       return false;
 100
 101     return $last_id;
 102   }
 103
 104   // The getActiveTimesheets obtains active timesheets for a user.
 105   static function getActiveTimesheets($user_id)
 106   {
 107     global $user;
 108     $mdb2 = getConnection();
 109
 110     $group_id = $user->getGroup();
 111     $org_id = $user->org_id;
 112
 113     // $addPaidStatus = $user->isPluginEnabled('ps');
 114     $result = array();
 115
 116     if ($user->isClient())
 117       $client_part = "and ts.client_id = $user->client_id";
 118
 119     $sql = "select ts.id, ts.name, ts.client_id, c.name as client_name, ts.submit_status, ts.approval_status from tt_timesheets ts".
 120       " left join tt_clients c on (c.id = ts.client_id)".
 121       " where ts.status = 1 and ts.group_id = $group_id and ts.org_id = $org_id and ts.user_id = $user_id".
 122       " $client_part order by ts.name";
 123     $res = $mdb2->query($sql);
 124     $result = array();
 125     if (!is_a($res, 'PEAR_Error')) {
 126       $dt = new DateAndTime(DB_DATEFORMAT);
 127       while ($val = $res->fetchRow()) {
 128         //if ($addPaidStatus)
 129         //  $val['paid'] = ttTimesheetHelper::isPaid($val['id']);
 130         $result[] = $val;
 131       }
 132     }
 133     return $result;
 134   }
 135
 136   // The getInactiveTimesheets obtains inactive timesheets for a user.
 137   static function getInactiveTimesheets($user_id)
 138   {
 139     global $user;
 140     $mdb2 = getConnection();
 141
 142     $group_id = $user->getGroup();
 143     $org_id = $user->org_id;
 144
 145     // $addPaidStatus = $user->isPluginEnabled('ps');
 146     $result = array();
 147
 148     if ($user->isClient())
 149       $client_part = "and ts.client_id = $user->client_id";
 150
 151     $sql = "select ts.id, ts.name, ts.client_id, c.name as client_name, ts.submit_status, ts.approval_status from tt_timesheets ts".
 152       " left join tt_clients c on (c.id = ts.client_id)".
 153       " where ts.status = 0 and ts.group_id = $group_id and ts.org_id = $org_id and ts.user_id = $user_id".
 154       " $client_part order by ts.name";
 155     $res = $mdb2->query($sql);
 156     $result = array();
 157     if (!is_a($res, 'PEAR_Error')) {
 158       $dt = new DateAndTime(DB_DATEFORMAT);
 159       while ($val = $res->fetchRow()) {
 160         //if ($addPaidStatus)
 161         //  $val['paid'] = ttTimesheetHelper::isPaid($val['id']);
 162         $result[] = $val;
 163       }
 164     }
 165     return $result;
 166   }
 167
 168   // getTimesheet - obtains timesheet data from the database.
 169   static function getTimesheet($timesheet_id) {
 170     global $user;
 171     $mdb2 = getConnection();
 172
 173     $user_id = $user->getUser();
 174     $group_id = $user->getGroup();
 175     $org_id = $user->org_id;
 176
 177     $sql = "select * from tt_timesheets".
 178       " where id = $timesheet_id and user_id = $user_id and group_id = $group_id and org_id = $org_id and status is not null";
 179     $res = $mdb2->query($sql);
 180     if (!is_a($res, 'PEAR_Error')) {
 181       if ($val = $res->fetchRow())
 182         return $val;
 183     }
 184     return false;
 185   }
 186
 187   // delete - deletes timesheet from the database.
 188   static function delete($timesheet_id) {
 189     global $user;
 190     $mdb2 = getConnection();
 191
 192     $group_id = $user->getGroup();
 193     $org_id = $user->org_id;
 194
 195     // Handle time records.
 196     $sql = "update tt_log set timesheet_id = null".
 197       " where timesheet_id = $timesheet_id and group_id = $group_id and org_id = $org_id";
 198     $affected = $mdb2->exec($sql);
 199     if (is_a($affected, 'PEAR_Error')) return false;
 200
 201     // Handle expense items.
 202     $sql = "update tt_expense_items set timesheet_id = null".
 203       " where timesheet_id = $timesheet_id and group_id = $group_id and org_id = $org_id";
 204     $affected = $mdb2->exec($sql);
 205     if (is_a($affected, 'PEAR_Error')) return false;
 206
 207     // Delete timesheet.
 208     $sql = "update tt_timesheets set status = null".
 209       " where id = $timesheet_id and group_id = $group_id and org_id = $org_id";
 210     $affected = $mdb2->exec($sql);
 211     return (!is_a($affected, 'PEAR_Error'));
 212   }
 213
 214   // update function - updates the timesheet in database.
 215   static function update($fields) {
 216     global $user;
 217     $mdb2 = getConnection();
 218
 219     $group_id = $user->getGroup();
 220     $org_id = $user->org_id;
 221
 222     $timesheet_id = $fields['id']; // Timesheet we are updating.
 223     $name = $fields['name']; // Timesheet name.
 224     $submitter_comment = $fields['submitter_comment'];
 225     $status = $fields['status']; // Project status.
 226
 227     $sql = "update tt_timesheets set name = ".$mdb2->quote($name).", submitter_comment = ".$mdb2->quote($submitter_comment).
 228       ", status = ".$mdb2->quote($status).
 229       " where id = $timesheet_id and group_id = $group_id and org_id = $org_id";
 230     $affected = $mdb2->exec($sql);
 231     return (!is_a($affected, 'PEAR_Error'));
 232   }
 233
 234   // isUserValid function is used during access checks and determines whether user id, passed in post, is valid
 235   // in current context.
 236   static function isUserValid($user_id) {
 237     // We have to cover several situations.
 238     //
 239     // 1) User is a client.
 240     // 2) User with view_all_timesheets rights.
 241     // 3) User with view_timesheets rights.
 242
 243     global $user;
 244
 245     // TODO: we are currently re-designing timesheets.
 246     // Clients are not supposed to view them at all.
 247     // And the post will change on_behalf user, to keep things consistent.
 248     return false;
 249   }
 250
 251   // getReportOptions prepares $options array to be used with ttReportHelper
 252   // to obtain items for timesheet view.
 253   static function getReportOptions($timesheet) {
 254     global $user;
 255     $group_by_client = $user->isPluginEnabled('cl') && !$timesheet['client_id'];
 256     $trackingMode = $user->getTrackingMode();
 257     $group_by_project = MODE_PROJECTS == $trackingMode || MODE_PROJECTS_AND_TASKS == $trackingMode;
 258
 259     $options['timesheet_id'] = $timesheet['id'];
 260     $options['client_id'] = $timesheet['client_id'];
 261     $options['users'] = $timesheet['user_id'];
 262     $options['show_durarion'] = 1;
 263     $options['show_cost'] = 1; // To include expenses.
 264     $options['show_totals_only'] = 1;
 265     $options['group_by1'] = 'date';
 266     if ($group_by_client || $group_by_project) {
 267       $options['group_by2'] = $group_by_client ? 'client' : 'project';
 268     }
 269     if ($options['group_by2'] && $options['group_by2'] != 'project' && $group_by_project) {
 270       $options['group_by3'] = 'project';
 271     }
 272     return $options;
 273   }
 274
 275   // getApprovers obtains a list of users who can approve a timesheet for a given user
 276   // and also have an email to receive a notification about it.
 277   static function getApprovers($user_id) {
 278     global $user;
 279     $mdb2 = getConnection();
 280
 281     $group_id = $user->getGroup();
 282     $org_id = $user->org_id;
 283
 284     $approvers = array();
 285     $rank = ttUserHelper::getUserRank($user_id);
 286     $sql = "select u.id, u.name, u.email".
 287       " from tt_users u".
 288       " left join tt_roles r on (r.id = u.role_id)".
 289       " where u.status = 1 and u.email is not null and u.group_id = $group_id and u.org_id = $org_id".
 290       " and (r.rights like '%approve_all_timesheets%' or (r.rank > $rank and r.rights like '%approve_timesheets%'))";
 291     $res = $mdb2->query($sql);
 292     if (!is_a($res, 'PEAR_Error')) {
 293       while ($val = $res->fetchRow()) {
 294         $approvers[] = $val;
 295       }
 296     }
 297     return $approvers;
 298   }
 299
 300   // submitTimesheet marks a timesheet as submitted and sends an email to an approver.
 301   static function submitTimesheet($fields) {
 302     global $user;
 303     $mdb2 = getConnection();
 304
 305     $group_id = $user->getGroup();
 306     $org_id = $user->org_id;
 307
 308     // First, mark a timesheet as submitted.
 309     // Even if mail part below does not work, this will get us a functioning workflow
 310     // (without email notifications).
 311     $timesheet_id = $fields['timesheet_id'];
 312     $sql = "update tt_timesheets set submit_status = 1".
 313       " where id = $timesheet_id and group_id = $group_id and org_id = $org_id";
 314     $affected = $mdb2->exec($sql);
 315     if (is_a($affected, 'PEAR_Error')) return false;
 316
 317     // TODO: send email to approver here...
 318     // $approver_id = $fields['approver_id'];
 319
 320     return true;
 321   }
 322
 323   // approveTimesheet marks a timesheet as approved and sends an email to submitter.
 324   static function approveTimesheet($fields) {
 325     global $user;
 326     $mdb2 = getConnection();
 327
 328     $group_id = $user->getGroup();
 329     $org_id = $user->org_id;
 330
 331     // First, mark a timesheet as approved.
 332     // Even if mail part below does not work, this will get us a functioning workflow
 333     // (without email notifications).
 334     $timesheet_id = $fields['timesheet_id'];
 335     $manager_comment = $fields['comment'];
 336
 337     $sql = "update tt_timesheets set approval_status = 1, manager_comment = ".$mdb2->quote($manager_comment).
 338       " where id = $timesheet_id and submit_status = 1 and group_id = $group_id and org_id = $org_id";
 339     $affected = $mdb2->exec($sql);
 340     if (is_a($affected, 'PEAR_Error')) return false;
 341
 342     // TODO: send email to submitter here...
 343     return true;
 344   }
 345
 346   // disapproveTimesheet marks a timesheet as approved and sends an email to submitter.
 347   static function disapproveTimesheet($fields) {
 348     global $user;
 349     $mdb2 = getConnection();
 350
 351     $group_id = $user->getGroup();
 352     $org_id = $user->org_id;
 353
 354     // First, mark a timesheet as disapproved.
 355     // Even if mail part below does not work, this will get us a functioning workflow
 356     // (without email notifications).
 357     $timesheet_id = $fields['timesheet_id'];
 358     $manager_comment = $fields['comment'];
 359
 360     $sql = "update tt_timesheets set approval_status = 0, manager_comment = ".$mdb2->quote($manager_comment).
 361       " where id = $timesheet_id and submit_status = 1 and group_id = $group_id and org_id = $org_id";
 362     $affected = $mdb2->exec($sql);
 363     if (is_a($affected, 'PEAR_Error')) return false;
 364
 365     // TODO: send email to submitter here...
 366     return true;
 367   }
 368
 369   // The timesheetItemsExist determines whether tt_log records exist in the specified period
 370   // for inclusion in a new timesheet.
 371   static function timesheetItemsExist($fields) {
 372     global $user;
 373     $mdb2 = getConnection();
 374
 375     $user_id = $user->getUser();
 376     $group_id = $user->getGroup();
 377     $org_id = $user->org_id;
 378
 379     if (isset($fields['client_id'])) $client_id = (int) $fields['client_id'];
 380     if (isset($fields['project_id'])) $project_id = (int) $fields['project_id'];
 381
 382     $start_date = new DateAndTime($user->date_format, $fields['start_date']);
 383     $start = $start_date->toString(DB_DATEFORMAT);
 384
 385     $end_date = new DateAndTime($user->date_format, $fields['end_date']);
 386     $end = $end_date->toString(DB_DATEFORMAT);
 387
 388     // sql parts.
 389     if ($client_id) $client_part = " and client_id = $client_id";
 390     if ($project_id) $project_part = " and project_id = $project_id";
 391
 392     $sql = "select count(*) as num from tt_log".
 393       " where status = 1 $client_part $project_part and timesheet_id is null".
 394       " and date >= ".$mdb2->quote($start)." and date <= ".$mdb2->quote($end).
 395       " and user_id = $user_id and group_id = $group_id and org_id = $org_id";
 396     $res = $mdb2->query($sql);
 397     if (!is_a($res, 'PEAR_Error')) {
 398       $val = $res->fetchRow();
 399       if ($val['num']) {
 400         return true;
 401       }
 402     }
 403
 404     return false;
 405   }
 406 }