Separated users section on reports in 2 for active and inactive users.
[timetracker.git] / WEB-INF / lib / ttFavReportHelper.class.php
index 305a4fc..a3e130c 100644 (file)
 // | https://www.anuko.com/time_tracker/credits.htm
 // +----------------------------------------------------------------------+
 
-import('ttTeamHelper');
+import('ttGroupHelper');
 
 // Class ttFavReportHelper is used to help with favorite report related tasks.
 class ttFavReportHelper {
 
   // getReports - returns an array of favorite reports for user.
-  static function getReports($user_id) {
+  static function getReports() {
+    global $user;
     $mdb2 = getConnection();
 
+    $user_id = $user->getUser();
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
     $result = array();
-    $sql = "select * from tt_fav_reports where user_id = $user_id and status = 1";
+    $sql = "select * from tt_fav_reports".
+      " where user_id = $user_id and group_id = $group_id and org_id = $org_id and status = 1";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       while ($val = $res->fetchRow()) {
@@ -47,7 +53,30 @@ class ttFavReportHelper {
     return false;
   }
 
+  // get - returns a report identified by its id for user.
+  static function get($id) {
+    global $user;
+    $mdb2 = getConnection();
+
+    $user_id = $user->getUser();
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    $sql = "select * from tt_fav_reports".
+      " where id = $id and user_id = $user_id and group_id = $group_id and org_id = $org_id and status = 1";
+    $res = $mdb2->query($sql);
+    if (!is_a($res, 'PEAR_Error')) {
+      if ($val = $res->fetchRow()) {
+        return $val;
+      }
+    }
+    return false;
+  }
+
   // getReport - returns a report identified by its id.
+  // TODO: get rid of this function by encapsulating all cron related tasks in its own class.
+  // Because cron works for all orgs and we want this class to always work in context of
+  // a logged on user, for better security.
   static function getReport($id) {
     $mdb2 = getConnection();
 
@@ -62,10 +91,16 @@ class ttFavReportHelper {
   }
 
   // getReportByName - returns a report identified by its name.
-  static function getReportByName($user_id, $report_name) {
+  static function getReportByName($report_name) {
+    global $user;
     $mdb2 = getConnection();
 
-    $sql = "select * from tt_fav_reports where user_id = $user_id and status = 1 and name = ".$mdb2->quote($report_name);
+    $user_id = $user->getUser();
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    $sql = "select id from tt_fav_reports".
+      " where user_id = $user_id and group_id = $group_id and org_id = $org_id and status = 1 and name = ".$mdb2->quote($report_name);
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       if ($val = $res->fetchRow()) {
@@ -77,43 +112,51 @@ class ttFavReportHelper {
 
   // insertReport - stores reports settings in database.
   static function insertReport($fields) {
+    global $user;
     $mdb2 = getConnection();
 
-    $sql = "insert into tt_fav_reports (name, user_id, client_id, cf_1_option_id, project_id, task_id,
-      billable, invoice, paid_status, users, period, period_start, period_end,
-      show_client, show_invoice, show_paid, show_ip,
-      show_project, show_start, show_duration, show_cost,
-      show_task, show_end, show_note, show_custom_field_1, show_work_units,
-      group_by1, group_by2, group_by3, show_totals_only)
-      values(".
-      $mdb2->quote($fields['name']).", ".$fields['user_id'].", ".
+    $user_id = $user->getUser();
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    $sql = "insert into tt_fav_reports".
+      " (name, user_id, group_id, org_id, client_id, cf_1_option_id, project_id, task_id,".
+      " billable, approved, invoice, timesheet, paid_status, users, period, period_start,".
+      " period_end, show_client, show_invoice, show_paid, show_ip,".
+      " show_project, show_timesheet, show_start, show_duration, show_cost,".
+      " show_task, show_end, show_note, show_approved, show_custom_field_1, show_work_units,".
+      " group_by1, group_by2, group_by3, show_totals_only)".
+      " values(".
+      $mdb2->quote($fields['name']).", $user_id, $group_id, $org_id, ".
       $mdb2->quote($fields['client']).", ".$mdb2->quote($fields['option']).", ".
       $mdb2->quote($fields['project']).", ".$mdb2->quote($fields['task']).", ".
-      $mdb2->quote($fields['billable']).", ".$mdb2->quote($fields['invoice']).", ".
+      $mdb2->quote($fields['billable']).", ".$mdb2->quote($fields['approved']).", ".
+      $mdb2->quote($fields['invoice']).", ".$mdb2->quote($fields['timesheet']).", ".
       $mdb2->quote($fields['paid_status']).", ".
       $mdb2->quote($fields['users']).", ".$mdb2->quote($fields['period']).", ".
       $mdb2->quote($fields['from']).", ".$mdb2->quote($fields['to']).", ".
       $fields['chclient'].", ".$fields['chinvoice'].", ".$fields['chpaid'].", ".$fields['chip'].", ".
-      $fields['chproject'].", ".$fields['chstart'].", ".$fields['chduration'].", ".$fields['chcost'].", ".
-      $fields['chtask'].", ".$fields['chfinish'].", ".$fields['chnote'].", ".$fields['chcf_1'].", ".$fields['chunits'].", ".
+      $fields['chproject'].", ".$fields['chtimesheet'].", ".$fields['chstart'].", ".$fields['chduration'].", ".$fields['chcost'].", ".
+      $fields['chtask'].", ".$fields['chfinish'].", ".$fields['chnote'].", ".$fields['chapproved'].", ".$fields['chcf_1'].", ".$fields['chunits'].", ".
       $mdb2->quote($fields['group_by1']).", ".$mdb2->quote($fields['group_by2']).", ".
       $mdb2->quote($fields['group_by3']).", ".$fields['chtotalsonly'].")";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error'))
       return false;
 
-    $sql = "select last_insert_id() as last_id";
-    $res = $mdb2->query($sql);
-    if (is_a($res, 'PEAR_Error'))
-      return false;
-
-    $val = $res->fetchRow();
-    return $val['last_id'];
+    $last_id = $mdb2->lastInsertID('tt_fav_reports', 'id');
+    return $last_id;
   }
 
   // updateReport - updates report options in the database.
-  function updateReport($fields) {
+  static function updateReport($fields) {
+    global $user;
     $mdb2 = getConnection();
+
+    $user_id = $user->getUser();
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
     $sql = "update tt_fav_reports set ".
       "name = ".$mdb2->quote($fields['name']).", ".
       "client_id = ".$mdb2->quote($fields['client']).", ".
@@ -121,7 +164,9 @@ class ttFavReportHelper {
       "project_id = ".$mdb2->quote($fields['project']).", ".
       "task_id = ".$mdb2->quote($fields['task']).", ".
       "billable = ".$mdb2->quote($fields['billable']).", ".
+      "approved = ".$mdb2->quote($fields['approved']).", ".
       "invoice = ".$mdb2->quote($fields['invoice']).", ".
+      "timesheet = ".$mdb2->quote($fields['timesheet']).", ".
       "paid_status = ".$mdb2->quote($fields['paid_status']).", ".
       "users = ".$mdb2->quote($fields['users']).", ".
       "period = ".$mdb2->quote($fields['period']).", ".
@@ -132,19 +177,21 @@ class ttFavReportHelper {
       "show_paid = ".$fields['chpaid'].", ".
       "show_ip = ".$fields['chip'].", ".
       "show_project = ".$fields['chproject'].", ".
+      "show_timesheet = ".$fields['chtimesheet'].", ".
       "show_start = ".$fields['chstart'].", ".
       "show_duration = ".$fields['chduration'].", ".
       "show_cost = ".$fields['chcost'].", ".
       "show_task = ".$fields['chtask'].", ".
       "show_end = ".$fields['chfinish'].", ".
       "show_note = ".$fields['chnote'].", ".
+      "show_approved = ".$fields['chapproved'].", ".
       "show_custom_field_1 = ".$fields['chcf_1'].", ".
       "show_work_units = ".$fields['chunits'].", ".
       "group_by1 = ".$mdb2->quote($fields['group_by1']).", ".
       "group_by2 = ".$mdb2->quote($fields['group_by2']).", ".
       "group_by3 = ".$mdb2->quote($fields['group_by3']).", ".
       "show_totals_only = ".$fields['chtotalsonly'].
-      " where id = ".$fields['id'];
+      " where id = ".$fields['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;
@@ -153,36 +200,48 @@ class ttFavReportHelper {
   }
 
   // saveReport - saves report options in the database.
-  static function saveReport($user_id, $bean) {
+  static function saveReport($bean) {
     global $user;
 
     //  Set default value of 0 for not set checkboxes (in bean).
     //  Later in this function we use it to construct $fields array to update database.
     if (!$bean->getAttribute('chclient')) $bean->setAttribute('chclient', 0);
-    if (!$bean->getAttribute('chinvoice')) $bean->setAttribute('chinvoice', 0);
-    if (!$bean->getAttribute('chpaid')) $bean->setAttribute('chpaid', 0);
-    if (!$bean->getAttribute('chip')) $bean->setAttribute('chip', 0);
-    if (!$bean->getAttribute('chproject')) $bean->setAttribute('chproject', 0);
     if (!$bean->getAttribute('chstart')) $bean->setAttribute('chstart', 0);
+    if (!$bean->getAttribute('chfinish')) $bean->setAttribute('chfinish', 0);
     if (!$bean->getAttribute('chduration')) $bean->setAttribute('chduration', 0);
-    if (!$bean->getAttribute('chcost')) $bean->setAttribute('chcost', 0);
+    if (!$bean->getAttribute('chproject')) $bean->setAttribute('chproject', 0);
     if (!$bean->getAttribute('chtask')) $bean->setAttribute('chtask', 0);
-    if (!$bean->getAttribute('chfinish')) $bean->setAttribute('chfinish', 0);
     if (!$bean->getAttribute('chnote')) $bean->setAttribute('chnote', 0);
+    if (!$bean->getAttribute('chcost')) $bean->setAttribute('chcost', 0);
+
+    if (!$bean->getAttribute('chtimesheet')) $bean->setAttribute('chtimesheet', 0);
+    if (!$bean->getAttribute('chip')) $bean->setAttribute('chip', 0);
+    if (!$bean->getAttribute('chapproved')) $bean->setAttribute('chapproved', 0);
+    if (!$bean->getAttribute('chpaid')) $bean->setAttribute('chpaid', 0);
+
     if (!$bean->getAttribute('chcf_1')) $bean->setAttribute('chcf_1', 0);
     if (!$bean->getAttribute('chunits')) $bean->setAttribute('chunits', 0);
+    if (!$bean->getAttribute('chinvoice')) $bean->setAttribute('chinvoice', 0);
+
     if (!$bean->getAttribute('chtotalsonly')) $bean->setAttribute('chtotalsonly', 0);
 
-    $users_in_bean = $bean->getAttribute('users');
-    if ($users_in_bean && is_array($users_in_bean)) {
-      $users = join(',', $users_in_bean);
+    $active_users_in_bean = $bean->getAttribute('users_active');
+    if ($active_users_in_bean && is_array($active_users_in_bean)) {
+      $users = join(',', $active_users_in_bean);
+    }
+    $inactive_users_in_bean = $bean->getAttribute('users_inactive');
+    if ($inactive_users_in_bean && is_array($inactive_users_in_bean)) {
+      if ($users) $users .= ',';
+      $users .= join(',', $inactive_users_in_bean);
     }
+
     if ($bean->getAttribute('start_date')) {
-      $dt = new DateAndTime($user->date_format, $bean->getAttribute('start_date'));
+      $dt = new DateAndTime($user->getDateFormat(), $bean->getAttribute('start_date'));
       $from = $dt->toString(DB_DATEFORMAT);
     }
     if ($bean->getAttribute('end_date')) {
-      $dt = new DateAndTime($user->date_format, $bean->getAttribute('end_date'));
+      $dt = new DateAndTime($user->getDateFormat(), $bean->getAttribute('end_date'));
       $to = $dt->toString(DB_DATEFORMAT);
     }
 
@@ -193,37 +252,40 @@ class ttFavReportHelper {
       'project'=>$bean->getAttribute('project'),
       'task'=>$bean->getAttribute('task'),
       'billable'=>$bean->getAttribute('include_records'),
-      'invoice'=>$bean->getAttribute('invoice'),
+      'approved'=>$bean->getAttribute('approved'),
       'paid_status'=>$bean->getAttribute('paid_status'),
+      'invoice'=>$bean->getAttribute('invoice'),
+      'timesheet'=>$bean->getAttribute('timesheet'),
       'users'=>$users,
       'period'=>$bean->getAttribute('period'),
       'from'=>$from,
       'to'=>$to,
       'chclient'=>$bean->getAttribute('chclient'),
-      'chinvoice'=>$bean->getAttribute('chinvoice'),
-      'chpaid'=>$bean->getAttribute('chpaid'),
-      'chip'=>$bean->getAttribute('chip'),
-      'chproject'=>$bean->getAttribute('chproject'),
       'chstart'=>$bean->getAttribute('chstart'),
+      'chfinish'=>$bean->getAttribute('chfinish'),
       'chduration'=>$bean->getAttribute('chduration'),
-      'chcost'=>$bean->getAttribute('chcost'),
+      'chproject'=>$bean->getAttribute('chproject'),
       'chtask'=>$bean->getAttribute('chtask'),
-      'chfinish'=>$bean->getAttribute('chfinish'),
       'chnote'=>$bean->getAttribute('chnote'),
+      'chcost'=>$bean->getAttribute('chcost'),
+      'chtimesheet'=>$bean->getAttribute('chtimesheet'),
+      'chip'=>$bean->getAttribute('chip'),
+      'chapproved'=>$bean->getAttribute('chapproved'),
+      'chpaid'=>$bean->getAttribute('chpaid'),
       'chcf_1'=>$bean->getAttribute('chcf_1'),
       'chunits'=>$bean->getAttribute('chunits'),
+      'chinvoice'=>$bean->getAttribute('chinvoice'),
       'group_by1'=>$bean->getAttribute('group_by1'),
       'group_by2'=>$bean->getAttribute('group_by2'),
       'group_by3'=>$bean->getAttribute('group_by3'),
       'chtotalsonly'=>$bean->getAttribute('chtotalsonly'));
 
     $id = false;
-    $report = ttFavReportHelper::getReportByName($user_id, $fields['name']);
+    $report = ttFavReportHelper::getReportByName($fields['name']);
     if ($report) {
       $fields['id'] = $report['id'];
       $id = ttFavReportHelper::updateReport($fields);
     } else {
-      $fields['user_id'] = $user_id;
       $id = ttFavReportHelper::insertReport($fields);
     }
 
@@ -232,47 +294,65 @@ class ttFavReportHelper {
 
   // deleteReport - deletes a favorite report.
   static function deleteReport($id) {
+    global $user;
     $mdb2 = getConnection();
 
-    $sql = "delete from tt_fav_reports where id = $id";
+    $user_id = $user->getUser();
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    $sql = "delete from tt_cron".
+      " where report_id = $id and group_id = $group_id and org_id = $org_id";
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error'))
+      return false;
+
+    $sql = "delete from tt_fav_reports".
+      " where id = $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'));
   }
 
   // loadReport - loads report options from database into a bean.
-  static function loadReport($user_id, &$bean) {
+  static function loadReport(&$bean) {
     global $user;
+    $user_id = $user->getUser();
 
-    $val = ttFavReportHelper::getReport($bean->getAttribute('favorite_report'));
+    $val = ttFavReportHelper::get($bean->getAttribute('favorite_report'));
     if ($val) {
       $bean->setAttribute('client', $val['client_id']);
       $bean->setAttribute('option', $val['cf_1_option_id']);
       $bean->setAttribute('project', $val['project_id']);
       $bean->setAttribute('task', $val['task_id']);
       $bean->setAttribute('include_records', $val['billable']);
+      $bean->setAttribute('approved', $val['approved']);
       $bean->setAttribute('invoice', $val['invoice']);
       $bean->setAttribute('paid_status', $val['paid_status']);
-      $bean->setAttribute('users', explode(',', $val['users']));
+      $bean->setAttribute('timesheet', $val['timesheet']);
+      $bean->setAttribute('users_active', explode(',', $val['users']));
+      $bean->setAttribute('users_inactive', explode(',', $val['users']));
       $bean->setAttribute('period', $val['period']);
       if ($val['period_start']) {
         $dt = new DateAndTime(DB_DATEFORMAT, $val['period_start']);
-        $bean->setAttribute('start_date', $dt->toString($user->date_format));
+        $bean->setAttribute('start_date', $dt->toString($user->getDateFormat()));
       }
       if ($val['period_end']) {
         $dt = new DateAndTime(DB_DATEFORMAT, $val['period_end']);
-        $bean->setAttribute('end_date', $dt->toString($user->date_format));
+        $bean->setAttribute('end_date', $dt->toString($user->getDateFormat()));
       }
       $bean->setAttribute('chclient', $val['show_client']);
       $bean->setAttribute('chinvoice', $val['show_invoice']);
       $bean->setAttribute('chpaid', $val['show_paid']);
       $bean->setAttribute('chip', $val['show_ip']);
       $bean->setAttribute('chproject', $val['show_project']);
+      $bean->setAttribute('chtimesheet', $val['show_timesheet']);
       $bean->setAttribute('chstart', $val['show_start']);
       $bean->setAttribute('chduration', $val['show_duration']);
       $bean->setAttribute('chcost', $val['show_cost']);
       $bean->setAttribute('chtask', $val['show_task']);
       $bean->setAttribute('chfinish', $val['show_end']);
       $bean->setAttribute('chnote', $val['show_note']);
+      $bean->setAttribute('chapproved', $val['show_approved']);
       $bean->setAttribute('chcf_1', $val['show_custom_field_1']);
       $bean->setAttribute('chunits', $val['show_work_units']);
       $bean->setAttribute('group_by1', $val['group_by1']);
@@ -288,20 +368,27 @@ class ttFavReportHelper {
         'project'=>'',
         'task'=>'',
         'include_records'=>'',
+        'approved'=>'',
+        'paid_status'=>'',
         'invoice'=>'',
+        'timesheet'=>'',
         'users'=>$user_id,
         'period'=>'',
         'chclient'=>'1',
-        'chinvoice'=>'',
-        'chproject'=>'1',
         'chstart'=>'1',
+        'chfinish'=>'1',
         'chduration'=>'1',
-        'chcost'=>'',
+        'chproject'=>'1',
         'chtask'=>'1',
-        'chfinish'=>'1',
         'chnote'=>'1',
+        'chcost'=>'',
+        'chtimesheet'=>'',
+        'chip'=>'',
+        'chapproved'=>'',
+        'chpaid'=>'',
         'chcf_1'=>'',
         'chunits'=>'',
+        'chinvoice'=>'',
         'group_by1'=>'',
         'group_by2'=>'',
         'group_by3'=>'',
@@ -335,7 +422,7 @@ class ttFavReportHelper {
     return $options;
   }
 
-  // adjustOptions takes and array or report options and adjusts them for current user
+  // adjustOptions takes an array or report options and adjusts them for current user
   // (and group) settings. This is needed in situations when a fav report is stored in db
   // long ago, but user or group attributes are now changed, so we have to adjust.
   static function adjustOptions($options) {
@@ -354,7 +441,7 @@ class ttFavReportHelper {
             $user_options = array('max_rank'=>$max_rank);
           $users = $user->getUsers($user_options); // Active and inactive users.
         } elseif ($user->isClient()) {
-          $users = ttTeamHelper::getUsersForClient(); // Active and inactive users for clients.
+          $users = ttGroupHelper::getUsersForClient(); // Active and inactive users for clients.
         }
         foreach ($users as $single_user) {
           $user_ids[] = $single_user['id'];
@@ -364,13 +451,13 @@ class ttFavReportHelper {
     } else {
       $users_to_adjust = explode(',', $options['users']); // Users to adjust.
       if ($user->isClient()) {
-        $users = ttTeamHelper::getUsersForClient(); // Active and inactive users for clients.
+        $users = ttGroupHelper::getUsersForClient(); // Active and inactive users for clients.
         foreach ($users as $single_user) {
           $user_ids[] = $single_user['id'];
         }
         foreach ($users_to_adjust as $user_to_adjust) {
-          if (in_array($user_to_adjust['id'], $user_ids)) {
-            $adjusted_user_ids[] = $user_to_adjust['id'];
+          if (in_array($user_to_adjust, $user_ids)) {
+            $adjusted_user_ids[] = $user_to_adjust;
           }
         }
         $options['users'] = implode(',', $adjusted_user_ids);
@@ -378,6 +465,9 @@ class ttFavReportHelper {
       // TODO: add checking the existing user list for potentially changed access rights for user.
     }
 
+    if ($user->isPluginEnabled('ap') && $user->isClient() && !$user->can('view_client_unapproved'))
+      $options['approved'] = 1; // Restrict clients to approved records only.
+
     return $options;
   }
 }