WEB-INF/lib/ttReportHelper.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('ttClientHelper');
  30 import('DateAndTime');
  31 import('Period');
  32 import('ttTimeHelper');
  33
  34 require_once(dirname(__FILE__).'/../../plugins/CustomFields.class.php');
  35
  36 // Definitions of types for timesheet dropdown.
  37 define('TIMESHEET_ALL', 0); // Include all records.
  38 define('TIMESHEET_NOT_ASSIGNED', 1); // Include records not assigned to timesheets.
  39 define('TIMESHEET_ASSIGNED', 2); // Include records assigned to timesheets.
  40 define('TIMESHEET_PENDING', 3); // Include records in submitted timesheets that are pending manager approval.
  41 define('TIMESHEET_APPROVED', 4); // Include records in approved timesheets.
  42 define('TIMESHEET_NOT_APPROVED', 5); // Include records in disapproved timesheets.
  43
  44 // Class ttReportHelper is used for help with reports.
  45 class ttReportHelper {
  46
  47   // getWhere prepares a WHERE clause for a report query.
  48   static function getWhere($options) {
  49     global $user;
  50
  51     $group_id = $user->getGroup();
  52     $org_id = $user->org_id;
  53
  54     // A shortcut for timesheets.
  55     if ($options['timesheet_id']) {
  56       $where = " where l.timesheet_id = ".$options['timesheet_id']." and l.group_id = $group_id and l.org_id = $org_id";
  57       return $where;
  58     }
  59
  60     // Prepare dropdown parts.
  61     $dropdown_parts = '';
  62     if ($options['client_id'])
  63       $dropdown_parts .= ' and l.client_id = '.$options['client_id'];
  64     elseif ($user->isClient() && $user->client_id)
  65       $dropdown_parts .= ' and l.client_id = '.$user->client_id;
  66     if ($options['cf_1_option_id']) $dropdown_parts .= ' and l.id in(select log_id from tt_custom_field_log where status = 1 and option_id = '.$options['cf_1_option_id'].')';
  67     if ($options['project_id']) $dropdown_parts .= ' and l.project_id = '.$options['project_id'];
  68     if ($options['task_id']) $dropdown_parts .= ' and l.task_id = '.$options['task_id'];
  69     if ($options['billable']=='1') $dropdown_parts .= ' and l.billable = 1';
  70     if ($options['billable']=='2') $dropdown_parts .= ' and l.billable = 0';
  71     if ($options['invoice']=='1') $dropdown_parts .= ' and l.invoice_id is not null';
  72     if ($options['invoice']=='2') $dropdown_parts .= ' and l.invoice_id is null';
  73     if ($options['timesheet']==TIMESHEET_NOT_ASSIGNED) $dropdown_parts .= ' and l.timesheet_id is null';
  74     if ($options['timesheet']==TIMESHEET_ASSIGNED) $dropdown_parts .= ' and l.timesheet_id is not null';
  75     if ($options['approved']=='1') $dropdown_parts .= ' and l.approved = 1';
  76     if ($options['approved']=='2') $dropdown_parts .= ' and l.approved = 0';
  77     if ($options['paid_status']=='1') $dropdown_parts .= ' and l.paid = 1';
  78     if ($options['paid_status']=='2') $dropdown_parts .= ' and l.paid = 0';
  79
  80     // Prepare sql query part for user list.
  81     $userlist = $options['users'] ? $options['users'] : '-1';
  82     if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient())
  83       $user_list_part = " and l.user_id in ($userlist)";
  84     else
  85       $user_list_part = " and l.user_id = ".$user->getUser();
  86     $user_list_part .= " and l.group_id = $group_id and l.org_id = $org_id";
  87
  88     // Prepare sql query part for where.
  89     $dateFormat = $user->getDateFormat();
  90     if ($options['period'])
  91       $period = new Period($options['period'], new DateAndTime($dateFormat));
  92     else {
  93       $period = new Period();
  94       $period->setPeriod(
  95         new DateAndTime($dateFormat, $options['period_start']),
  96         new DateAndTime($dateFormat, $options['period_end']));
  97     }
  98     $where = " where l.status = 1 and l.date >= '".$period->getStartDate(DB_DATEFORMAT)."' and l.date <= '".$period->getEndDate(DB_DATEFORMAT)."'".
  99       " $user_list_part $dropdown_parts";
 100     return $where;
 101   }
 102
 103   // getExpenseWhere prepares WHERE clause for expenses query in a report.
 104   static function getExpenseWhere($options) {
 105     global $user;
 106
 107     $group_id = $user->getGroup();
 108     $org_id = $user->org_id;
 109
 110     // Prepare dropdown parts.
 111     $dropdown_parts = '';
 112     if ($options['client_id'])
 113       $dropdown_parts .= ' and ei.client_id = '.$options['client_id'];
 114     elseif ($user->isClient() && $user->client_id)
 115       $dropdown_parts .= ' and ei.client_id = '.$user->client_id;
 116     if ($options['project_id']) $dropdown_parts .= ' and ei.project_id = '.$options['project_id'];
 117     if ($options['invoice']=='1') $dropdown_parts .= ' and ei.invoice_id is not null';
 118     if ($options['invoice']=='2') $dropdown_parts .= ' and ei.invoice_id is null';
 119     if (isset($options['timesheet']) && ($options['timesheet']!=TIMESHEET_ALL && $options['timesheet']!=TIMESHEET_NOT_ASSIGNED)) {
 120         $dropdown_parts .= ' and 0 = 1'; // Expense items do not have a timesheet_id.
 121     }
 122     if ($options['approved']=='1') $dropdown_parts .= ' and ei.approved = 1';
 123     if ($options['approved']=='2') $dropdown_parts .= ' and ei.approved = 0';
 124     if ($options['paid_status']=='1') $dropdown_parts .= ' and ei.paid = 1';
 125     if ($options['paid_status']=='2') $dropdown_parts .= ' and ei.paid = 0';
 126
 127     // Prepare sql query part for user list.
 128     $userlist = $options['users'] ? $options['users'] : '-1';
 129     if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient())
 130       $user_list_part = " and ei.user_id in ($userlist)";
 131     else
 132       $user_list_part = " and ei.user_id = ".$user->getUser();
 133     $user_list_part .= " and ei.group_id = $group_id and ei.org_id = $org_id";
 134
 135     // Prepare sql query part for where.
 136     $dateFormat = $user->getDateFormat();
 137     if ($options['period'])
 138       $period = new Period($options['period'], new DateAndTime($dateFormat));
 139     else {
 140       $period = new Period();
 141       $period->setPeriod(
 142         new DateAndTime($dateFormat, $options['period_start']),
 143         new DateAndTime($dateFormat, $options['period_end']));
 144     }
 145     $where = " where ei.status = 1 and ei.date >= '".$period->getStartDate(DB_DATEFORMAT)."' and ei.date <= '".$period->getEndDate(DB_DATEFORMAT)."'".
 146       " $user_list_part $dropdown_parts";
 147     return $where;
 148   }
 149
 150   // getItems retrieves all items associated with a report.
 151   // It combines tt_log and tt_expense_items in one array for presentation in one table using mysql union all.
 152   // Expense items use the "note" field for item name.
 153   static function getItems($options) {
 154     global $user;
 155     $mdb2 = getConnection();
 156
 157     // Determine these once as they are used in multiple places in this function.
 158     $canViewReports = $user->can('view_reports') || $user->can('view_all_reports');
 159     $isClient = $user->isClient();
 160
 161     $grouping = ttReportHelper::grouping($options);
 162     if ($grouping) {
 163       $grouping_by_date = ttReportHelper::groupingBy('date', $options);
 164       $grouping_by_client = ttReportHelper::groupingBy('client', $options);
 165       $grouping_by_project = ttReportHelper::groupingBy('project', $options);
 166       $grouping_by_task = ttReportHelper::groupingBy('task', $options);
 167       $grouping_by_user = ttReportHelper::groupingBy('user', $options);
 168       $grouping_by_cf_1 = ttReportHelper::groupingBy('cf_1', $options);
 169     }
 170     $convertTo12Hour = ('%I:%M %p' == $user->getTimeFormat()) && ($options['show_start'] || $options['show_end']);
 171     $trackingMode = $user->getTrackingMode();
 172     $decimalMark = $user->getDecimalMark();
 173
 174     // Prepare a query for time items in tt_log table.
 175     $fields = array(); // An array of fields for database query.
 176     array_push($fields, 'l.id');
 177     array_push($fields, 'l.user_id');
 178     array_push($fields, '1 as type'); // Type 1 is for tt_log entries.
 179     array_push($fields, 'l.date');
 180     if($canViewReports || $isClient)
 181       array_push($fields, 'u.name as user');
 182     // Add client name if it is selected.
 183     if ($options['show_client'] || $grouping_by_client)
 184       array_push($fields, 'c.name as client');
 185     // Add project name if it is selected.
 186     if ($options['show_project'] || $grouping_by_project)
 187       array_push($fields, 'p.name as project');
 188     // Add task name if it is selected.
 189     if ($options['show_task'] || $grouping_by_task)
 190       array_push($fields, 't.name as task');
 191     // Add custom field.
 192     $include_cf_1 = $options['show_custom_field_1'] || $grouping_by_cf_1;
 193     if ($include_cf_1) {
 194       $custom_fields = new CustomFields();
 195       $cf_1_type = $custom_fields->fields[0]['type'];
 196       if ($cf_1_type == CustomFields::TYPE_TEXT) {
 197         array_push($fields, 'cfl.value as cf_1');
 198       } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
 199         array_push($fields, 'cfo.value as cf_1');
 200       }
 201     }
 202     // Add start time.
 203     if ($options['show_start']) {
 204       array_push($fields, "l.start as unformatted_start");
 205       array_push($fields, "TIME_FORMAT(l.start, '%k:%i') as start");
 206     }
 207     // Add finish time.
 208     if ($options['show_end'])
 209       array_push($fields, "TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), '%k:%i') as finish");
 210     // Add duration.
 211     if ($options['show_duration'])
 212       array_push($fields, "TIME_FORMAT(l.duration, '%k:%i') as duration");
 213     // Add work units.
 214     if ($options['show_work_units']) {
 215       if ($user->getConfigOption('unit_totals_only'))
 216         array_push($fields, "null as units");
 217       else {
 218         $firstUnitThreshold = $user->getConfigInt('1st_unit_threshold', 0);
 219         $minutesInUnit = $user->getConfigInt('minutes_in_unit', 15);
 220         array_push($fields, "if(l.billable = 0 or time_to_sec(l.duration)/60 < $firstUnitThreshold, 0, ceil(time_to_sec(l.duration)/60/$minutesInUnit)) as units");
 221       }
 222     }
 223     // Add note.
 224     if ($options['show_note'])
 225       array_push($fields, 'l.comment as note');
 226     // Handle cost.
 227     $includeCost = $options['show_cost'];
 228     if ($includeCost) {
 229       if (MODE_TIME == $trackingMode)
 230         array_push($fields, "cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2)) as cost");   // Use default user rate.
 231       else
 232         array_push($fields, "cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2)) as cost"); // Use project rate for user.
 233       array_push($fields, "null as expense");
 234     }
 235     // Add approved.
 236     if ($options['show_approved'])
 237       array_push($fields, 'l.approved');
 238     // Add paid status.
 239     if ($canViewReports && $options['show_paid'])
 240       array_push($fields, 'l.paid');
 241     // Add IP address.
 242     if ($canViewReports && $options['show_ip']) {
 243       array_push($fields, 'l.created');
 244       array_push($fields, 'l.created_ip');
 245       array_push($fields, 'l.modified');
 246       array_push($fields, 'l.modified_ip');
 247     }
 248     // Add invoice name if it is selected.
 249     if (($canViewReports || $isClient) && $options['show_invoice'])
 250       array_push($fields, 'i.name as invoice');
 251     // Add timesheet name if it is selected.
 252     if ($options['show_timesheet'])
 253       array_push($fields, 'ts.name as timesheet_name');
 254
 255     // Prepare sql query part for left joins.
 256     $left_joins = null;
 257     if ($options['show_client'] || $grouping_by_client)
 258       $left_joins .= " left join tt_clients c on (c.id = l.client_id)";
 259     if (($canViewReports || $isClient) && $options['show_invoice'])
 260       $left_joins .= " left join tt_invoices i on (i.id = l.invoice_id and i.status = 1)";
 261     if ($canViewReports || $isClient || $user->isPluginEnabled('ex'))
 262        $left_joins .= " left join tt_users u on (u.id = l.user_id)";
 263     if ($options['show_project'] || $grouping_by_project)
 264       $left_joins .= " left join tt_projects p on (p.id = l.project_id)";
 265     if ($options['show_task'] || $grouping_by_task)
 266       $left_joins .= " left join tt_tasks t on (t.id = l.task_id)";
 267     if ($include_cf_1) {
 268       if ($cf_1_type == CustomFields::TYPE_TEXT)
 269         $left_joins .= " left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1)";
 270       elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) {
 271         $left_joins .=  " left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1)".
 272           " left join tt_custom_field_options cfo on (cfl.option_id = cfo.id)";
 273       }
 274     }
 275     if ($includeCost && MODE_TIME != $trackingMode)
 276       $left_joins .= " left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)";
 277
 278     // Prepare sql query part for inner joins.
 279     $inner_joins = null;
 280     if ($user->isPluginEnabled('ts')) {
 281       $timesheet_option = $options['timesheet'];
 282       if ($timesheet_option == TIMESHEET_PENDING)
 283         $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.submit_status = 1 and ts.approve_status is null)";
 284       else if ($timesheet_option == TIMESHEET_APPROVED)
 285         $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.approve_status = 1)";
 286       else if ($timesheet_option == TIMESHEET_NOT_APPROVED)
 287         $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.approve_status = 0)";
 288       else if ($options['show_timesheet'])
 289         $inner_joins .= " left join tt_timesheets ts on (l.timesheet_id = ts.id)"; // Left join for timesheet nme.
 290     }
 291
 292     $where = ttReportHelper::getWhere($options);
 293
 294     // Construct sql query for tt_log items.
 295     $sql = "select ".join(', ', $fields)." from tt_log l $left_joins $inner_joins $where";
 296     // If we don't have expense items (such as when the Expenses plugin is disabled), the above is all sql we need,
 297     // with an exception of sorting part, that is added in the end.
 298
 299     // However, when we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table.
 300     if ($options['show_cost'] && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled
 301
 302       $fields = array(); // An array of fields for database query.
 303       array_push($fields, 'ei.id');
 304       array_push($fields, 'ei.user_id');
 305       array_push($fields, '2 as type'); // Type 2 is for tt_expense_items entries.
 306       array_push($fields, 'ei.date');
 307       if($canViewReports || $isClient)
 308         array_push($fields, 'u.name as user');
 309       // Add client name if it is selected.
 310       if ($options['show_client'] || $grouping_by_client)
 311         array_push($fields, 'c.name as client');
 312       // Add project name if it is selected.
 313       if ($options['show_project'] || $grouping_by_project)
 314         array_push($fields, 'p.name as project');
 315       if ($options['show_task'] || $grouping_by_task)
 316         array_push($fields, 'null'); // null for task name. We need to match column count for union.
 317       if ($options['show_custom_field_1'] || $grouping_by_cf_1)
 318         array_push($fields, 'null'); // null for cf_1.
 319       if ($options['show_start']) {
 320         array_push($fields, 'null'); // null for unformatted_start.
 321         array_push($fields, 'null'); // null for start.
 322       }
 323       if ($options['show_end'])
 324         array_push($fields, 'null'); // null for finish.
 325       if ($options['show_duration'])
 326         array_push($fields, 'null'); // null for duration.
 327       if ($options['show_work_units'])
 328         array_push($fields, 'null as units'); // null for work units.
 329       // Use the note field to print item name.
 330       if ($options['show_note'])
 331         array_push($fields, 'ei.name as note');
 332       array_push($fields, 'ei.cost as cost');
 333       array_push($fields, 'ei.cost as expense');
 334       // Add approved.
 335       if ($options['show_approved'])
 336         array_push($fields, 'ei.approved');
 337       // Add paid status.
 338       if ($canViewReports && $options['show_paid'])
 339         array_push($fields, 'ei.paid');
 340       // Add IP address.
 341       if ($canViewReports && $options['show_ip']) {
 342         array_push($fields, 'ei.created');
 343         array_push($fields, 'ei.created_ip');
 344         array_push($fields, 'ei.modified');
 345         array_push($fields, 'ei.modified_ip');
 346       }
 347       // Add invoice name if it is selected.
 348       if (($canViewReports || $isClient) && $options['show_invoice'])
 349         array_push($fields, 'i.name as invoice');
 350       if ($options['show_timesheet'])
 351         array_push($fields, 'null as timesheet_name');
 352
 353       // Prepare sql query part for left joins.
 354       $left_joins = null;
 355       if ($canViewReports || $isClient)
 356         $left_joins .= " left join tt_users u on (u.id = ei.user_id)";
 357       if ($options['show_client'] || $grouping_by_client)
 358         $left_joins .= " left join tt_clients c on (c.id = ei.client_id)";
 359       if ($options['show_project'] || $grouping_by_project)
 360         $left_joins .= " left join tt_projects p on (p.id = ei.project_id)";
 361       if (($canViewReports || $isClient) && $options['show_invoice'])
 362         $left_joins .= " left join tt_invoices i on (i.id = ei.invoice_id and i.status = 1)";
 363
 364       $where = ttReportHelper::getExpenseWhere($options);
 365
 366       // Construct sql query for expense items.
 367       $sql_for_expense_items = "select ".join(', ', $fields)." from tt_expense_items ei $left_joins $where";
 368
 369       // Construct a union.
 370       $sql = "($sql) union all ($sql_for_expense_items)";
 371     }
 372
 373     // Determine sort part.
 374     $sort_part = ' order by ';
 375     if ($grouping) {
 376       $sort_part2 .= ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') ? ', '.$options['group_by1'] : '';
 377       $sort_part2 .= ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') ? ', '.$options['group_by2'] : '';
 378       $sort_part2 .= ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') ? ', '.$options['group_by3'] : '';
 379       if (!$grouping_by_date) $sort_part2 .= ', date';
 380       $sort_part .= ltrim($sort_part2, ', '); // Remove leading comma and space.
 381     } else {
 382       $sort_part .= 'date';
 383     }
 384     if (($canViewReports || $isClient) && $options['users'] && !$grouping_by_user)
 385       $sort_part .= ', user, type';
 386     if ($options['show_start'])
 387       $sort_part .= ', unformatted_start';
 388     $sort_part .= ', id';
 389
 390     $sql .= $sort_part;
 391     // By now we are ready with sql.
 392
 393     // Obtain items for report.
 394     $res = $mdb2->query($sql);
 395     if (is_a($res, 'PEAR_Error')) die($res->getMessage());
 396
 397     while ($val = $res->fetchRow()) {
 398       if ($convertTo12Hour) {
 399         if($val['start'] != '')
 400           $val['start'] = ttTimeHelper::to12HourFormat($val['start']);
 401         if($val['finish'] != '')
 402           $val['finish'] = ttTimeHelper::to12HourFormat($val['finish']);
 403       }
 404       if (isset($val['cost'])) {
 405         if ('.' != $decimalMark)
 406           $val['cost'] = str_replace('.', $decimalMark, $val['cost']);
 407       }
 408       if (isset($val['expense'])) {
 409         if ('.' != $decimalMark)
 410           $val['expense'] = str_replace('.', $decimalMark, $val['expense']);
 411       }
 412
 413       if ($grouping) $val['grouped_by'] = ttReportHelper::makeGroupByKey($options, $val);
 414       $val['date'] = ttDateToUserFormat($val['date']);
 415
 416       $report_items[] = $val;
 417     }
 418
 419     return $report_items;
 420   }
 421
 422   // putInSession stores tt_log and tt_expense_items ids from a report in user session
 423   // as 2 comma-separated lists.
 424   static function putInSession($report_items) {
 425     unset($_SESSION['report_item_ids']);
 426     unset($_SESSION['report_item_expense_ids']);
 427
 428     // Iterate through records and build 2 comma-separated lists.
 429     foreach($report_items as $item) {
 430       if ($item['type'] == 1)
 431         $report_item_ids .= ','.$item['id'];
 432       else if ($item['type'] == 2)
 433          $report_item_expense_ids .= ','.$item['id'];
 434     }
 435     $report_item_ids = trim($report_item_ids, ',');
 436     $report_item_expense_ids = trim($report_item_expense_ids, ',');
 437
 438     // The lists are reqdy. Put them in session.
 439     if ($report_item_ids) $_SESSION['report_item_ids'] = $report_item_ids;
 440     if ($report_item_expense_ids) $_SESSION['report_item_expense_ids'] = $report_item_expense_ids;
 441   }
 442
 443   // getFromSession obtains tt_log and tt_expense_items ids stored in user session.
 444   static function getFromSession() {
 445     $items = array();
 446     $report_item_ids = $_SESSION['report_item_ids'];
 447     if ($report_item_ids)
 448       $items['report_item_ids'] = explode(',', $report_item_ids);
 449     $report_item_expense_ids = $_SESSION['report_item_expense_ids'];
 450     if ($report_item_expense_ids)
 451       $items['report_item_expense_ids'] = explode(',', $report_item_expense_ids);
 452     return $items;
 453   }
 454
 455   // getSubtotals calculates report items subtotals when a report is grouped by.
 456   // Without expenses, it's a simple select with group by.
 457   // With expenses, it becomes a select with group by from a combined set of records obtained with "union all".
 458   static function getSubtotals($options) {
 459     global $user;
 460     $mdb2 = getConnection();
 461
 462     $concat_part = ttReportHelper::makeConcatPart($options);
 463     $work_unit_part = ttReportHelper::makeWorkUnitPart($options);
 464     $join_part = ttReportHelper::makeJoinPart($options);
 465     $cost_part = ttReportHelper::makeCostPart($options);
 466     $where = ttReportHelper::getWhere($options);
 467     $group_by_part = ttReportHelper::makeGroupByPart($options);
 468
 469     $parts = "$concat_part, sum(time_to_sec(l.duration)) as time, null as expenses".$work_unit_part.$cost_part;
 470     $sql = "select $parts from tt_log l $join_part $where $group_by_part";
 471     // By now we have sql for time items.
 472
 473     // However, when we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table.
 474     if ($options['show_cost'] && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled
 475
 476       $concat_part = ttReportHelper::makeConcatExpensesPart($options);
 477       $join_part = ttReportHelper::makeJoinExpensesPart($options);
 478       $where = ttReportHelper::getExpenseWhere($options);
 479       $group_by_expenses_part = ttReportHelper::makeGroupByExpensesPart($options);
 480       $sql_for_expenses = "select $concat_part, null as time";
 481       if ($options['show_work_units']) $sql_for_expenses .= ", null as units";
 482       $sql_for_expenses .= ", sum(ei.cost) as cost, sum(ei.cost) as expenses from tt_expense_items ei $join_part $where $group_by_expenses_part";
 483
 484       // Create a combined query.
 485       $fields = ttReportHelper::makeCombinedSelectPart($options);
 486       $combined = "select $fields, sum(time) as time";
 487       if ($options['show_work_units']) $combined .= ", sum(units) as units";
 488       $combined .= ", sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t group by $fields";
 489       $sql = $combined;
 490     }
 491
 492     // Execute query.
 493     $res = $mdb2->query($sql);
 494     if (is_a($res, 'PEAR_Error')) die($res->getMessage());
 495     while ($val = $res->fetchRow()) {
 496       $time = $val['time'] ? sec_to_time_fmt_hm($val['time']) : null;
 497       $rowLabel = ttReportHelper::makeGroupByLabel($val['group_field'], $options);
 498       if ($options['show_cost']) {
 499         $decimalMark = $user->getDecimalMark();
 500         if ('.' != $decimalMark) {
 501           $val['cost'] = str_replace('.', $decimalMark, $val['cost']);
 502           $val['expenses'] = str_replace('.', $decimalMark, $val['expenses']);
 503         }
 504         $subtotals[$val['group_field']] = array('name'=>$rowLabel,'user'=>$val['user'],'project'=>$val['project'],'task'=>$val['task'],'client'=>$val['client'],'cf_1'=>$val['cf_1'],'time'=>$time,'units'=> $val['units'],'cost'=>$val['cost'],'expenses'=>$val['expenses']);
 505       } else
 506         $subtotals[$val['group_field']] = array('name'=>$rowLabel,'user'=>$val['user'],'project'=>$val['project'],'task'=>$val['task'],'client'=>$val['client'],'cf_1'=>$val['cf_1'],'time'=>$time, 'units'=> $val['units']);
 507     }
 508
 509     return $subtotals;
 510   }
 511
 512   // getTotals calculates total hours and cost for all report items.
 513   static function getTotals($options)
 514   {
 515     global $user;
 516     $mdb2 = getConnection();
 517
 518     $trackingMode = $user->getTrackingMode();
 519     $decimalMark = $user->getDecimalMark();
 520     $where = ttReportHelper::getWhere($options);
 521
 522     // Prepare parts.
 523     $time_part = "sum(time_to_sec(l.duration)) as time";
 524     if ($options['show_work_units']) {
 525       $unitTotalsOnly = $user->getConfigOption('unit_totals_only');
 526       $firstUnitThreshold = $user->getConfigInt('1st_unit_threshold', 0);
 527       $minutesInUnit = $user->getConfigInt('minutes_in_unit', 15);
 528       $units_part = $unitTotalsOnly ? ", null as units" : ", sum(if(l.billable = 0 or time_to_sec(l.duration)/60 < $firstUnitThreshold, 0, ceil(time_to_sec(l.duration)/60/$minutesInUnit))) as units";
 529     }
 530     if ($options['show_cost']) {
 531       if (MODE_TIME == $trackingMode)
 532         $cost_part = ", sum(cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost, null as expenses";
 533       else
 534         $cost_part = ", sum(cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost, null as expenses";
 535     } else {
 536       $cost_part = ", null as cost, null as expenses";
 537     }
 538     if ($options['show_cost']) {
 539       if (MODE_TIME == $trackingMode) {
 540         $left_joins = "left join tt_users u on (l.user_id = u.id)";
 541       } else {
 542         $left_joins = "left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)";
 543       }
 544     }
 545     // Prepare sql query part for inner joins.
 546     $inner_joins = null;
 547     if ($user->isPluginEnabled('ts') && $options['timesheet']) {
 548       $timesheet_option = $options['timesheet'];
 549       if ($timesheet_option == TIMESHEET_PENDING)
 550         $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.submit_status = 1 and ts.approve_status is null)";
 551       else if ($timesheet_option == TIMESHEET_APPROVED)
 552         $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.approve_status = 1)";
 553       else if ($timesheet_option == TIMESHEET_NOT_APPROVED)
 554         $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.approve_status = 0)";
 555     }
 556     // Prepare a query for time items.
 557     $sql = "select $time_part $units_part $cost_part from tt_log l $left_joins $inner_joins $where";
 558
 559     // If we have expenses, query becomes a bit more complex.
 560     if ($options['show_cost'] && $user->isPluginEnabled('ex')) {
 561       $where = ttReportHelper::getExpenseWhere($options);
 562       $sql_for_expenses = "select null as time";
 563       if ($options['show_work_units']) $sql_for_expenses .= ", null as units";
 564       $sql_for_expenses .= ", sum(cost) as cost, sum(cost) as expenses from tt_expense_items ei $where";
 565
 566       // Create a combined query.
 567       $combined = "select sum(time) as time";
 568       if ($options['show_work_units']) $combined .= ", sum(units) as units";
 569       $combined .= ", sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t";
 570       $sql = $combined;
 571     }
 572
 573     // Execute query.
 574     $res = $mdb2->query($sql);
 575     if (is_a($res, 'PEAR_Error')) die($res->getMessage());
 576
 577     $val = $res->fetchRow();
 578     $total_time = $val['time'] ? sec_to_time_fmt_hm($val['time']) : null;
 579     if ($options['show_cost']) {
 580       $total_cost = $val['cost'];
 581       if (!$total_cost) $total_cost = '0.00';
 582       if ('.' != $decimalMark)
 583         $total_cost = str_replace('.', $decimalMark, $total_cost);
 584       $total_expenses = $val['expenses'];
 585       if (!$total_expenses) $total_expenses = '0.00';
 586       if ('.' != $decimalMark)
 587         $total_expenses = str_replace('.', $decimalMark, $total_expenses);
 588     }
 589
 590     $dateFormat = $user->getDateFormat();
 591     if ($options['period'])
 592       $period = new Period($options['period'], new DateAndTime($dateFormat));
 593     else {
 594       $period = new Period();
 595       $period->setPeriod(
 596         new DateAndTime($dateFormat, $options['period_start']),
 597         new DateAndTime($dateFormat, $options['period_end']));
 598     }
 599
 600     $totals['start_date'] = $period->getStartDate();
 601     $totals['end_date'] = $period->getEndDate();
 602     $totals['time'] = $total_time;
 603     $totals['units'] = $val['units'];
 604     $totals['cost'] = $total_cost;
 605     $totals['expenses'] = $total_expenses;
 606
 607     return $totals;
 608   }
 609
 610   // The assignToInvoice assigns a set of records to a specific invoice.
 611   static function assignToInvoice($invoice_id, $time_log_ids, $expense_item_ids) {
 612     global $user;
 613     $mdb2 = getConnection();
 614
 615     $group_id = $user->getGroup();
 616     $org_id = $user->org_id;
 617
 618     if ($time_log_ids) {
 619       $sql = "update tt_log set invoice_id = ".$mdb2->quote($invoice_id).
 620         " where id in(".join(', ', $time_log_ids).") and group_id = $group_id and org_id = $org_id";
 621       $affected = $mdb2->exec($sql);
 622       if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
 623     }
 624     if ($expense_item_ids) {
 625       $sql = "update tt_expense_items set invoice_id = ".$mdb2->quote($invoice_id).
 626         " where id in(".join(', ', $expense_item_ids).") and group_id = $group_id and org_id = $org_id";
 627       $affected = $mdb2->exec($sql);
 628       if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
 629     }
 630   }
 631
 632   // The assignToTimesheet assigns a set of tt_log records to a specific timesheet.
 633   static function assignToTimesheet($timesheet_id, $time_log_ids) {
 634     global $user;
 635     $mdb2 = getConnection();
 636
 637     $user_id = $user->getUser();
 638     $group_id = $user->getGroup();
 639     $org_id = $user->org_id;
 640
 641     if ($time_log_ids) {
 642       // Use inner join as a protection mechanism not to do anything with "acted upon" timesheets.
 643       // Allow oprations only with pending timesheets.
 644       if ($timesheet_id) {
 645         // Assigning a timesheet to records.
 646         $inner_join = " inner join tt_timesheets ts on (ts.id = $timesheet_id".
 647           " and ts.user_id = $user_id and ts.approve_status is null". // Timesheet to assign to is pending.
 648           // Part below: existing timesheet either not exists or is also pending.
 649           " and (l.timesheet_id is null or (l.timesheet_id = ts.id and ts.approve_status is null)))";
 650       } else {
 651         $inner_join = " inner join tt_timesheets ts on (ts.id = l.timesheet_id".
 652           " and ts.user_id = $user_id and ts.approve_status is null)"; // Do not deassign from acted-upon timesheets.
 653       }
 654
 655       $sql = "update tt_log l $inner_join".
 656         " set l.timesheet_id = ".$mdb2->quote($timesheet_id).
 657         " where l.id in(".join(', ', $time_log_ids).") and l.user_id = $user_id and l.group_id = $group_id and l.org_id = $org_id";
 658       $affected = $mdb2->exec($sql);
 659       if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
 660     }
 661   }
 662
 663   // The markApproved marks a set of records as either approved or unapproved.
 664   static function markApproved($time_log_ids, $expense_item_ids, $approved = true) {
 665     global $user;
 666     $mdb2 = getConnection();
 667
 668     $group_id = $user->getGroup();
 669     $org_id = $user->org_id;
 670
 671     $approved_val = (int) $approved;
 672     if ($time_log_ids) {
 673       $sql = "update tt_log set approved = $approved_val".
 674         " where id in(".join(', ', $time_log_ids).") and group_id = $group_id and org_id = $org_id";
 675       $affected = $mdb2->exec($sql);
 676       if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
 677     }
 678     if ($expense_item_ids) {
 679       $sql = "update tt_expense_items set approved = $approved_val".
 680         " where id in(".join(', ', $expense_item_ids).") and group_id = $group_id and org_id = $org_id";
 681       $affected = $mdb2->exec($sql);
 682       if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
 683     }
 684   }
 685
 686   // The markPaid marks a set of records as either paid or unpaid.
 687   static function markPaid($time_log_ids, $expense_item_ids, $paid = true) {
 688     global $user;
 689     $mdb2 = getConnection();
 690
 691     $group_id = $user->getGroup();
 692     $org_id = $user->org_id;
 693
 694     $paid_val = (int) $paid;
 695     if ($time_log_ids) {
 696       $sql = "update tt_log set paid = $paid_val".
 697         " where id in(".join(', ', $time_log_ids).") and group_id = $group_id and org_id = $org_id";
 698       $affected = $mdb2->exec($sql);
 699       if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
 700     }
 701     if ($expense_item_ids) {
 702       $sql = "update tt_expense_items set paid = $paid_val".
 703         " where id in(".join(', ', $expense_item_ids).") and group_id = $group_id and org_id = $org_id";
 704       $affected = $mdb2->exec($sql);
 705       if (is_a($affected, 'PEAR_Error')) die($affected->getMessage());
 706     }
 707   }
 708
 709   // prepareReportBody - prepares an email body for report.
 710   static function prepareReportBody($options, $comment = null)
 711   {
 712     global $user;
 713     global $i18n;
 714
 715     // Determine these once as they are used in multiple places in this function.
 716     $canViewReports = $user->can('view_reports') || $user->can('view_all_reports');
 717     $isClient = $user->isClient();
 718
 719     $items = ttReportHelper::getItems($options);
 720     $grouping = ttReportHelper::grouping($options);
 721     if ($grouping)
 722       $subtotals = ttReportHelper::getSubtotals($options);
 723     $totals = ttReportHelper::getTotals($options);
 724
 725     // Use custom fields plugin if it is enabled.
 726     if ($user->isPluginEnabled('cf'))
 727       $custom_fields = new CustomFields();
 728
 729     // Define some styles to use in email.
 730     $style_title = 'text-align: center; font-size: 15pt; font-family: Arial, Helvetica, sans-serif;';
 731     $tableHeader = 'font-weight: bold; background-color: #a6ccf7; text-align: left;';
 732     $tableHeaderCentered = 'font-weight: bold; background-color: #a6ccf7; text-align: center;';
 733     $rowItem = 'background-color: #ffffff;';
 734     $rowItemAlt = 'background-color: #f5f5f5;';
 735     $rowSubtotal = 'background-color: #e0e0e0;';
 736     $cellLeftAligned = 'text-align: left; vertical-align: top;';
 737     $cellRightAligned = 'text-align: right; vertical-align: top;';
 738     $cellLeftAlignedSubtotal = 'font-weight: bold; text-align: left; vertical-align: top;';
 739     $cellRightAlignedSubtotal = 'font-weight: bold; text-align: right; vertical-align: top;';
 740
 741     // Start creating email body.
 742     $body = '<html>';
 743     $body .= '<head><meta http-equiv="content-type" content="text/html; charset='.CHARSET.'"></head>';
 744     $body .= '<body>';
 745
 746     // Output title.
 747     $body .= '<p style="'.$style_title.'">'.$i18n->get('form.mail.report_subject').': '.$totals['start_date'].' - '.$totals['end_date'].'</p>';
 748
 749     // Output comment.
 750     if ($comment) $body .= '<p>'.htmlspecialchars($comment).'</p>';
 751
 752     if ($options['show_totals_only']) {
 753       // Totals only report. Output subtotals.
 754       $group_by_header = ttReportHelper::makeGroupByHeader($options);
 755
 756       $body .= '<table border="0" cellpadding="4" cellspacing="0" width="100%">';
 757       $body .= '<tr>';
 758       $body .= '<td style="'.$tableHeader.'">'.$group_by_header.'</td>';
 759       if ($options['show_duration'])
 760         $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.duration').'</td>';
 761       if ($options['show_work_units'])
 762         $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.work_units_short').'</td>';
 763       if ($options['show_cost'])
 764         $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.cost').'</td>';
 765       $body .= '</tr>';
 766       foreach($subtotals as $subtotal) {
 767         $body .= '<tr style="'.$rowSubtotal.'">';
 768         $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.($subtotal['name'] ? htmlspecialchars($subtotal['name']) : '&nbsp;').'</td>';
 769         if ($options['show_duration']) {
 770           $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
 771           if ($subtotal['time'] <> '0:00') $body .= $subtotal['time'];
 772           $body .= '</td>';
 773         }
 774         if ($options['show_work_units']) {
 775           $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
 776           $body .= $subtotal['units'];
 777           $body .= '</td>';
 778         }
 779         if ($options['show_cost']) {
 780           $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
 781           $body .= ($canViewReports || $isClient) ? $subtotal['cost'] : $subtotal['expenses'];
 782           $body .= '</td>';
 783         }
 784         $body .= '</tr>';
 785       }
 786
 787       // Print totals.
 788       $body .= '<tr><td>&nbsp;</td></tr>';
 789       $body .= '<tr style="'.$rowSubtotal.'">';
 790       $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.total').'</td>';
 791       if ($options['show_duration']) {
 792         $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
 793         if ($totals['time'] <> '0:00') $body .= $totals['time'];
 794         $body .= '</td>';
 795       }
 796       if ($options['show_work_units']) {
 797         $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
 798         $body .= $totals['units'];
 799         $body .= '</td>';
 800       }
 801       if ($options['show_cost']) {
 802         $body .= '<td nowrap style="'.$cellRightAlignedSubtotal.'">'.htmlspecialchars($user->currency).' ';
 803         $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses'];
 804         $body .= '</td>';
 805       }
 806       $body .= '</tr>';
 807
 808       $body .= '</table>';
 809     } else {
 810       // Regular report.
 811
 812       // Print table header.
 813       $body .= '<table border="0" cellpadding="4" cellspacing="0" width="100%">';
 814       $body .= '<tr>';
 815       $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.date').'</td>';
 816       if ($canViewReports || $isClient)
 817         $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.user').'</td>';
 818       if ($options['show_client'])
 819         $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.client').'</td>';
 820       if ($options['show_project'])
 821         $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.project').'</td>';
 822       if ($options['show_task'])
 823         $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.task').'</td>';
 824       if ($options['show_custom_field_1'])
 825         $body .= '<td style="'.$tableHeader.'">'.htmlspecialchars($custom_fields->fields[0]['label']).'</td>';
 826       if ($options['show_start'])
 827         $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.start').'</td>';
 828       if ($options['show_end'])
 829         $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.finish').'</td>';
 830       if ($options['show_duration'])
 831         $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.duration').'</td>';
 832       if ($options['show_work_units'])
 833         $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.work_units_short').'</td>';
 834       if ($options['show_note'])
 835         $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.note').'</td>';
 836       if ($options['show_cost'])
 837         $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.cost').'</td>';
 838       if ($options['show_approved'])
 839         $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.approved').'</td>';
 840       if ($options['show_paid'])
 841         $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.paid').'</td>';
 842       if ($options['show_ip'])
 843         $body .= '<td style="'.$tableHeaderCentered.'" width="5%">'.$i18n->get('label.ip').'</td>';
 844       if ($options['show_invoice'])
 845         $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.invoice').'</td>';
 846       if ($options['show_timesheet'])
 847         $body .= '<td style="'.$tableHeader.'">'.$i18n->get('label.timesheet').'</td>';
 848       $body .= '</tr>';
 849
 850       // Initialize variables to print subtotals.
 851       if ($items && $grouping) {
 852         $print_subtotals = true;
 853         $first_pass = true;
 854         $prev_grouped_by = '';
 855         $cur_grouped_by = '';
 856       }
 857       // Initialize variables to alternate color of rows for different dates.
 858       $prev_date = '';
 859       $cur_date = '';
 860       $row_style = $rowItem;
 861
 862       // Print report items.
 863       if (is_array($items)) {
 864         foreach ($items as $record) {
 865           $cur_date = $record['date'];
 866           // Print a subtotal row after a block of grouped items.
 867           if ($print_subtotals) {
 868             $cur_grouped_by = $record['grouped_by'];
 869             if ($cur_grouped_by != $prev_grouped_by && !$first_pass) {
 870               $body .= '<tr style="'.$rowSubtotal.'">';
 871               $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.subtotal').'</td>';
 872               $subtotal_name = htmlspecialchars($subtotals[$prev_grouped_by]['name']);
 873               if ($canViewReports || $isClient) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['user'].'</td>';
 874               if ($options['show_client']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['client'].'</td>';
 875               if ($options['show_project']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['project'].'</td>';
 876               if ($options['show_task']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['task'].'</td>';
 877               if ($options['show_custom_field_1']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['cf_1'].'</td>';
 878               if ($options['show_start']) $body .= '<td></td>';
 879               if ($options['show_end']) $body .= '<td></td>';
 880               if ($options['show_duration']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['time'].'</td>';
 881               if ($options['show_work_units']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['units'].'</td>';
 882               if ($options['show_note']) $body .= '<td></td>';
 883               if ($options['show_cost']) {
 884                 $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
 885                 $body .= ($canViewReports || $isClient) ? $subtotals[$prev_grouped_by]['cost'] : $subtotals[$prev_grouped_by]['expenses'];
 886                 $body .= '</td>';
 887               }
 888               if ($options['show_approved']) $body .= '<td></td>';
 889               if ($options['show_paid']) $body .= '<td></td>';
 890               if ($options['show_ip']) $body .= '<td></td>';
 891               if ($options['show_invoice']) $body .= '<td></td>';
 892               if ($options['show_timesheet']) $body .= '<td></td>';
 893               $body .= '</tr>';
 894               $body .= '<tr><td>&nbsp;</td></tr>';
 895             }
 896             $first_pass = false;
 897           }
 898
 899           // Print a regular row.
 900           if ($cur_date != $prev_date)
 901             $row_style = ($row_style == $rowItem) ? $rowItemAlt : $rowItem;
 902           $body .= '<tr style="'.$row_style.'">';
 903           $body .= '<td style="'.$cellLeftAligned.'">'.$record['date'].'</td>';
 904           if ($canViewReports || $isClient)
 905             $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['user']).'</td>';
 906           if ($options['show_client'])
 907             $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['client']).'</td>';
 908           if ($options['show_project'])
 909             $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['project']).'</td>';
 910           if ($options['show_task'])
 911             $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['task']).'</td>';
 912           if ($options['show_custom_field_1'])
 913             $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['cf_1']).'</td>';
 914           if ($options['show_start'])
 915             $body .= '<td nowrap style="'.$cellRightAligned.'">'.$record['start'].'</td>';
 916           if ($options['show_end'])
 917             $body .= '<td nowrap style="'.$cellRightAligned.'">'.$record['finish'].'</td>';
 918           if ($options['show_duration'])
 919             $body .= '<td style="'.$cellRightAligned.'">'.$record['duration'].'</td>';
 920           if ($options['show_work_units'])
 921             $body .= '<td style="'.$cellRightAligned.'">'.$record['units'].'</td>';
 922           if ($options['show_note'])
 923             $body .= '<td style="'.$cellLeftAligned.'">'.htmlspecialchars($record['note']).'</td>';
 924           if ($options['show_cost'])
 925             $body .= '<td style="'.$cellRightAligned.'">'.$record['cost'].'</td>';
 926           if ($options['show_approved']) {
 927             $body .= '<td style="'.$cellRightAligned.'">';
 928             $body .= $record['approved'] == 1 ? $i18n->get('label.yes') : $i18n->get('label.no');
 929             $body .= '</td>';
 930           }
 931           if ($options['show_paid']) {
 932             $body .= '<td style="'.$cellRightAligned.'">';
 933             $body .= $record['paid'] == 1 ? $i18n->get('label.yes') : $i18n->get('label.no');
 934             $body .= '</td>';
 935           }
 936           if ($options['show_ip']) {
 937             $body .= '<td style="'.$cellRightAligned.'">';
 938             $body .= $record['modified'] ? $record['modified_ip'].' '.$record['modified'] : $record['created_ip'].' '.$record['created'];
 939             $body .= '</td>';
 940           }
 941           if ($options['show_invoice'])
 942             $body .= '<td style="'.$cellRightAligned.'">'.htmlspecialchars($record['invoice']).'</td>';
 943           if ($options['show_timesheet'])
 944             $body .= '<td style="'.$cellRightAligned.'">'.htmlspecialchars($record['timesheet']).'</td>';
 945           $body .= '</tr>';
 946
 947           $prev_date = $record['date'];
 948           if ($print_subtotals)
 949             $prev_grouped_by = $record['grouped_by'];
 950         }
 951       }
 952
 953       // Print a terminating subtotal.
 954       if ($print_subtotals) {
 955         $body .= '<tr style="'.$rowSubtotal.'">';
 956         $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.subtotal').'</td>';
 957         $subtotal_name = htmlspecialchars($subtotals[$cur_grouped_by]['name']);
 958         if ($canViewReports || $isClient) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['user'].'</td>';
 959         if ($options['show_client']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['client'].'</td>';
 960         if ($options['show_project']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['project'].'</td>';
 961         if ($options['show_task']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['task'].'</td>';
 962         if ($options['show_custom_field_1']) $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$subtotals[$prev_grouped_by]['cf_1'].'</td>';
 963         if ($options['show_start']) $body .= '<td></td>';
 964         if ($options['show_end']) $body .= '<td></td>';
 965         if ($options['show_duration']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$cur_grouped_by]['time'].'</td>';
 966         if ($options['show_work_units']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$subtotals[$cur_grouped_by]['units'].'</td>';
 967         if ($options['show_note']) $body .= '<td></td>';
 968         if ($options['show_cost']) {
 969           $body .= '<td style="'.$cellRightAlignedSubtotal.'">';
 970           $body .= ($canViewReports || $isClient) ? $subtotals[$cur_grouped_by]['cost'] : $subtotals[$cur_grouped_by]['expenses'];
 971           $body .= '</td>';
 972         }
 973         if ($options['show_approved']) $body .= '<td></td>';
 974         if ($options['show_paid']) $body .= '<td></td>';
 975         if ($options['show_ip']) $body .= '<td></td>';
 976         if ($options['show_invoice']) $body .= '<td></td>';
 977         if ($options['show_timesheet']) $body .= '<td></td>';
 978         $body .= '</tr>';
 979       }
 980
 981       // Print totals.
 982       $body .= '<tr><td>&nbsp;</td></tr>';
 983       $body .= '<tr style="'.$rowSubtotal.'">';
 984       $body .= '<td style="'.$cellLeftAlignedSubtotal.'">'.$i18n->get('label.total').'</td>';
 985       if ($canViewReports || $isClient) $body .= '<td></td>';
 986       if ($options['show_client']) $body .= '<td></td>';
 987       if ($options['show_project']) $body .= '<td></td>';
 988       if ($options['show_task']) $body .= '<td></td>';
 989       if ($options['show_custom_field_1']) $body .= '<td></td>';
 990       if ($options['show_start']) $body .= '<td></td>';
 991       if ($options['show_end']) $body .= '<td></td>';
 992       if ($options['show_duration']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$totals['time'].'</td>';
 993       if ($options['show_work_units']) $body .= '<td style="'.$cellRightAlignedSubtotal.'">'.$totals['units'].'</td>';
 994       if ($options['show_note']) $body .= '<td></td>';
 995       if ($options['show_cost']) {
 996         $body .= '<td nowrap style="'.$cellRightAlignedSubtotal.'">'.htmlspecialchars($user->currency).' ';
 997         $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses'];
 998         $body .= '</td>';
 999       }
1000       if ($options['show_approved']) $body .= '<td></td>';
1001       if ($options['show_paid']) $body .= '<td></td>';
1002       if ($options['show_ip']) $body .= '<td></td>';
1003       if ($options['show_invoice']) $body .= '<td></td>';
1004       if ($options['show_timesheet']) $body .= '<td></td>';
1005       $body .= '</tr>';
1006
1007       $body .= '</table>';
1008     }
1009
1010     // Output footer.
1011     if (!defined('REPORT_FOOTER') || !(REPORT_FOOTER == false))
1012       $body .= '<p style="text-align: center;">'.$i18n->get('form.mail.footer').'</p>';
1013
1014     // Finish creating email body.
1015     $body .= '</body></html>';
1016
1017     return $body;
1018   }
1019
1020   // checkFavReportCondition - checks whether it is okay to send fav report.
1021   static function checkFavReportCondition($options, $condition)
1022   {
1023     $items = ttReportHelper::getItems($options);
1024
1025     $condition = trim(str_replace('count', '', $condition));
1026
1027     $greater_or_equal = ttStartsWith($condition, '>=');
1028     if ($greater_or_equal) $condition = trim(str_replace('>=', '', $condition));
1029
1030     $less_or_equal = ttStartsWith($condition, '<=');
1031     if ($less_or_equal) $condition = trim(str_replace('<=', '', $condition));
1032
1033     $not_equal = ttStartsWith($condition, '<>');
1034     if ($not_equal) $condition = trim(str_replace('<>', '', $condition));
1035
1036     $greater = ttStartsWith($condition, '>');
1037     if ($greater) $condition = trim(str_replace('>', '', $condition));
1038
1039     $less = ttStartsWith($condition, '<');
1040     if ($less) $condition = trim(str_replace('<', '', $condition));
1041
1042     $equal = ttStartsWith($condition, '=');
1043     if ($equal) $condition = trim(str_replace('=', '', $condition));
1044
1045     $count_required = (int) $condition;
1046
1047     if ($greater && count($items) > $count_required) return true;
1048     if ($greater_or_equal && count($items) >= $count_required) return true;
1049     if ($less && count($items) < $count_required) return true;
1050     if ($less_or_equal && count($items) <= $count_required) return true;
1051     if ($equal && count($items) == $count_required) return true;
1052     if ($not_equal && count($items) <> $count_required) return true;
1053
1054     return false;
1055   }
1056
1057   // sendFavReport - sends a favorite report to a specified email, called from cron.php
1058   static function sendFavReport($options, $subject, $email, $cc) {
1059     // We are called from cron.php, we have no $bean in session.
1060     // cron.php sets global $user and $i18n objects to match our favorite report user.
1061     global $user;
1062     global $i18n;
1063
1064     // Prepare report body.
1065     $body = ttReportHelper::prepareReportBody($options);
1066
1067     import('mail.Mailer');
1068     $mailer = new Mailer();
1069     $mailer->setCharSet(CHARSET);
1070     $mailer->setContentType('text/html');
1071     $mailer->setSender(SENDER);
1072     if (!empty($cc))
1073       $mailer->setReceiverCC($cc);
1074     if (!empty($user->bcc_email))
1075       $mailer->setReceiverBCC($user->bcc_email);
1076     $mailer->setReceiver($email);
1077     $mailer->setMailMode(MAIL_MODE);
1078     if (empty($subject)) $subject = $options['name'];
1079     if (!$mailer->send($subject, $body))
1080       return false;
1081
1082     return true;
1083   }
1084
1085   // getReportOptions - returns an array of report options constructed from session bean.
1086   //
1087   // Note: similarly to ttFavReportHelper::getReportOptions, this function is a part of
1088   // refactoring to simplify maintenance of report generating functions, as we currently
1089   // have 2 sets: normal reporting (from bean), and fav report emailing (from db fields).
1090   // Using options obtained from either db or bean shall allow us to use only one set of functions.
1091   static function getReportOptions($bean) {
1092     global $user;
1093
1094     // Prepare an array of report options.
1095     $options = array();
1096
1097     // Construct one by one.
1098     $options['name'] = null; // No name required.
1099     $options['user_id'] = $user->id; // Not sure if we need user_id here. Fav reports use it to recycle $user object in cron.php.
1100     $options['client_id'] = $bean->getAttribute('client');
1101     $options['cf_1_option_id'] = $bean->getAttribute('option');
1102     $options['project_id'] = $bean->getAttribute('project');
1103     $options['task_id'] = $bean->getAttribute('task');
1104     $options['billable'] = $bean->getAttribute('include_records');
1105     $options['invoice'] = $bean->getAttribute('invoice');
1106     $options['paid_status'] = $bean->getAttribute('paid_status');
1107     $options['approved'] = $bean->getAttribute('approved');
1108     if ($user->isPluginEnabled('ap') && $user->isClient() && !$user->can('view_client_unapproved'))
1109       $options['approved'] = 1; // Restrict clients to approved records only.
1110     $options['timesheet'] = $bean->getAttribute('timesheet');
1111     if (is_array($bean->getAttribute('users'))) $options['users'] = join(',', $bean->getAttribute('users'));
1112     $options['period'] = $bean->getAttribute('period');
1113     $options['period_start'] = $bean->getAttribute('start_date');
1114     $options['period_end'] = $bean->getAttribute('end_date');
1115     $options['show_client'] = $bean->getAttribute('chclient');
1116     $options['show_invoice'] = $bean->getAttribute('chinvoice');
1117     $options['show_approved'] = $bean->getAttribute('chapproved');
1118     $options['show_paid'] = $bean->getAttribute('chpaid');
1119     $options['show_ip'] = $bean->getAttribute('chip');
1120     $options['show_project'] = $bean->getAttribute('chproject');
1121     $options['show_start'] = $bean->getAttribute('chstart');
1122     $options['show_duration'] = $bean->getAttribute('chduration');
1123     $options['show_cost'] = $bean->getAttribute('chcost');
1124     $options['show_task'] = $bean->getAttribute('chtask');
1125     $options['show_end'] = $bean->getAttribute('chfinish');
1126     $options['show_note'] = $bean->getAttribute('chnote');
1127     $options['show_custom_field_1'] = $bean->getAttribute('chcf_1');
1128     $options['show_work_units'] = $bean->getAttribute('chunits');
1129     $options['show_timesheet'] = $bean->getAttribute('chtimesheet');
1130     $options['show_totals_only'] = $bean->getAttribute('chtotalsonly');
1131     $options['group_by1'] = $bean->getAttribute('group_by1');
1132     $options['group_by2'] = $bean->getAttribute('group_by2');
1133     $options['group_by3'] = $bean->getAttribute('group_by3');
1134     return $options;
1135   }
1136
1137   // verifyBean is a security function to make sure data in bean makes sense for a group.
1138   static function verifyBean($bean) {
1139     global $user;
1140
1141     // Check users.
1142     $users_in_bean = $bean->getAttribute('users');
1143     if (is_array($users_in_bean)) {
1144       $users_in_group = ttGroupHelper::getUsers();
1145       foreach ($users_in_group as $user_in_group) {
1146         $valid_ids[] = $user_in_group['id'];
1147       }
1148       foreach ($users_in_bean as $user_in_bean) {
1149         if (!in_array($user_in_bean, $valid_ids)) {
1150           return false;
1151         }
1152       }
1153     }
1154
1155     // TODO: add additional checks here. Perhaps do it before saving the bean for consistency.
1156     return true;
1157   }
1158
1159   // makeGroupByKey builds a combined group by key from group_by1, group_by2 and group_by3 values
1160   // (passed in $options) and a row of data ($row obtained from a db query).
1161   static function makeGroupByKey($options, $row) {
1162     if ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') {
1163       // We have group_by1.
1164       $group_by1 = $options['group_by1'];
1165       $group_by1_value = $row[$group_by1];
1166       //if ($group_by1 == 'date') $group_by1_value = ttDateToUserFormat($group_by1_value);
1167       if (empty($group_by1_value)) $group_by1_value = 'Null'; // To match what comes out of makeConcatPart.
1168       $group_by_key .= ' - '.$group_by1_value;
1169     }
1170     if ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') {
1171       // We have group_by2.
1172       $group_by2 = $options['group_by2'];
1173       $group_by2_value = $row[$group_by2];
1174       //if ($group_by2 == 'date') $group_by2_value = ttDateToUserFormat($group_by2_value);
1175       if (empty($group_by2_value)) $group_by2_value = 'Null'; // To match what comes out of makeConcatPart.
1176       $group_by_key .= ' - '.$group_by2_value;
1177     }
1178     if ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') {
1179       // We have group_by3.
1180       $group_by3 = $options['group_by3'];
1181       $group_by3_value = $row[$group_by3];
1182       //if ($group_by3 == 'date') $group_by3_value = ttDateToUserFormat($group_by3_value);
1183       if (empty($group_by3_value)) $group_by3_value = 'Null'; // To match what comes out of makeConcatPart.
1184       $group_by_key .= ' - '.$group_by3_value;
1185     }
1186     $group_by_key = trim($group_by_key, ' -');
1187     return $group_by_key;
1188   }
1189
1190   // makeGroupByPart builds a combined group by part for sql query for time items using group_by1,
1191   // group_by2, and group_by3 values passed in $options.
1192   static function makeGroupByPart($options) {
1193     if (!ttReportHelper::grouping($options)) return null;
1194
1195     $group_by1 = $options['group_by1'];
1196     $group_by2 = $options['group_by2'];
1197     $group_by3 = $options['group_by3'];
1198
1199     switch ($group_by1) {
1200       case 'date':
1201         $group_by_parts .= ', l.date';
1202         break;
1203       case 'user':
1204         $group_by_parts .= ', u.name';
1205         break;
1206       case 'client':
1207         $group_by_parts .= ', c.name';
1208         break;
1209       case 'project':
1210         $group_by_parts .= ', p.name';
1211         break;
1212       case 'task':
1213         $group_by_parts .= ', t.name';
1214         break;
1215       case 'cf_1':
1216         $group_by_parts .= ', cfo.value';
1217         break;
1218     }
1219     switch ($group_by2) {
1220       case 'date':
1221         $group_by_parts .= ', l.date';
1222         break;
1223       case 'user':
1224         $group_by_parts .= ', u.name';
1225         break;
1226       case 'client':
1227         $group_by_parts .= ', c.name';
1228         break;
1229       case 'project':
1230         $group_by_parts .= ', p.name';
1231         break;
1232       case 'task':
1233         $group_by_parts .= ', t.name';
1234         break;
1235       case 'cf_1':
1236         $group_by_parts .= ', cfo.value';
1237         break;
1238     }
1239     switch ($group_by3) {
1240       case 'date':
1241         $group_by_parts .= ', l.date';
1242         break;
1243       case 'user':
1244         $group_by_parts .= ', u.name';
1245         break;
1246       case 'client':
1247         $group_by_parts .= ', c.name';
1248         break;
1249       case 'project':
1250         $group_by_parts .= ', p.name';
1251         break;
1252       case 'task':
1253         $group_by_parts .= ', t.name';
1254         break;
1255       case 'cf_1':
1256         $group_by_parts .= ', cfo.value';
1257         break;
1258     }
1259     // Remove garbage from the beginning.
1260     $group_by_parts = ltrim($group_by_parts, ', ');
1261     $group_by_part = "group by $group_by_parts";
1262     return $group_by_part;
1263   }
1264
1265   // makeGroupByExpensesPart builds a combined group by part for sql query for expense items using
1266   // group_by1, group_by2, and group_by3 values passed in $options.
1267   static function makeGroupByExpensesPart($options) {
1268     $no_grouping = ($options['group_by1'] == null || $options['group_by1'] == 'no_grouping') &&
1269       ($options['group_by2'] == null || $options['group_by2'] == 'no_grouping') &&
1270       ($options['group_by3'] == null || $options['group_by3'] == 'no_grouping');
1271     if ($no_grouping) return null;
1272
1273     $group_by1 = $options['group_by1'];
1274     $group_by2 = $options['group_by2'];
1275     $group_by3 = $options['group_by3'];
1276
1277     switch ($group_by1) {
1278       case 'date':
1279         $group_by_parts .= ', ei.date';
1280         break;
1281       case 'user':
1282         $group_by_parts .= ', u.name';
1283         break;
1284       case 'client':
1285         $group_by_parts .= ', c.name';
1286         break;
1287       case 'project':
1288         $group_by_parts .= ', p.name';
1289         break;
1290     }
1291     switch ($group_by2) {
1292       case 'date':
1293         $group_by_parts .= ', ei.date';
1294         break;
1295       case 'user':
1296         $group_by_parts .= ', u.name';
1297         break;
1298       case 'client':
1299         $group_by_parts .= ', c.name';
1300         break;
1301       case 'project':
1302         $group_by_parts .= ', p.name';
1303         break;
1304     }
1305     switch ($group_by3) {
1306       case 'date':
1307         $group_by_parts .= ', ei.date';
1308         break;
1309       case 'user':
1310         $group_by_parts .= ', u.name';
1311         break;
1312       case 'client':
1313         $group_by_parts .= ', c.name';
1314         break;
1315       case 'project':
1316         $group_by_parts .= ', p.name';
1317         break;
1318     }
1319     // Remove garbage from the beginning.
1320     $group_by_parts = ltrim($group_by_parts, ', ');
1321     if ($group_by_parts)
1322       $group_by_part = "group by $group_by_parts";
1323     return $group_by_part;
1324   }
1325
1326   // makeConcatPart builds a concatenation part for getSubtotals query (for time items).
1327   static function makeConcatPart($options) {
1328     $group_by1 = $options['group_by1'];
1329     $group_by2 = $options['group_by2'];
1330     $group_by3 = $options['group_by3'];
1331
1332     switch ($group_by1) {
1333       case 'date':
1334         $what_to_concat .= ", ' - ', l.date";
1335         break;
1336       case 'user':
1337         $what_to_concat .= ", ' - ', u.name";
1338         $fields_part .= ', u.name as user';
1339         break;
1340       case 'client':
1341         $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')";
1342         $fields_part .= ', c.name as client';
1343         break;
1344       case 'project':
1345         $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')";
1346         $fields_part .= ', p.name as project';
1347         break;
1348       case 'task':
1349         $what_to_concat .= ", ' - ', coalesce(t.name, 'Null')";
1350         $fields_part .= ', t.name as task';
1351         break;
1352       case 'cf_1':
1353         $what_to_concat .= ", ' - ', coalesce(cfo.value, 'Null')";
1354         $fields_part .= ', cfo.value as cf_1';
1355         break;
1356     }
1357     switch ($group_by2) {
1358       case 'date':
1359         $what_to_concat .= ", ' - ', l.date";
1360         break;
1361       case 'user':
1362         $what_to_concat .= ", ' - ', u.name";
1363         $fields_part .= ', u.name as user';
1364         break;
1365       case 'client':
1366         $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')";
1367         $fields_part .= ', c.name as client';
1368         break;
1369       case 'project':
1370         $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')";
1371         $fields_part .= ', p.name as project';
1372         break;
1373       case 'task':
1374         $what_to_concat .= ", ' - ', coalesce(t.name, 'Null')";
1375         $fields_part .= ', t.name as task';
1376         break;
1377       case 'cf_1':
1378         $what_to_concat .= ", ' - ', coalesce(cfo.value, 'Null')";
1379         $fields_part .= ', cfo.value as cf_1';
1380         break;
1381     }
1382     switch ($group_by3) {
1383       case 'date':
1384         $what_to_concat .= ", ' - ', l.date";
1385         break;
1386       case 'user':
1387         $what_to_concat .= ", ' - ', u.name";
1388         $fields_part .= ', u.name as user';
1389         break;
1390       case 'client':
1391         $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')";
1392         $fields_part .= ', c.name as client';
1393         break;
1394       case 'project':
1395         $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')";
1396         $fields_part .= ', p.name as project';
1397         break;
1398       case 'task':
1399         $what_to_concat .= ", ' - ', coalesce(t.name, 'Null')";
1400         $fields_part .= ', t.name as task';
1401         break;
1402       case 'cf_1':
1403         $what_to_concat .= ", ' - ', coalesce(cfo.value, 'Null')";
1404         $fields_part .= ', cfo.value as cf_1';
1405         break;
1406     }
1407     // Remove garbage from both ends.
1408     $what_to_concat = trim($what_to_concat, "', -");
1409     $concat_part = "concat($what_to_concat) as group_field";
1410     $concat_part = trim($concat_part, ' -');
1411     return "$concat_part $fields_part";
1412   }
1413
1414   // makeConcatPart builds a concatenation part for getSubtotals query (for expense items).
1415   static function makeConcatExpensesPart($options) {
1416     $group_by1 = $options['group_by1'];
1417     $group_by2 = $options['group_by2'];
1418     $group_by3 = $options['group_by3'];
1419
1420     switch ($group_by1) {
1421       case 'date':
1422         $what_to_concat .= ", ' - ', ei.date";
1423         break;
1424       case 'user':
1425         $what_to_concat .= ", ' - ', u.name";
1426         $fields_part .= ', u.name as user';
1427         break;
1428       case 'client':
1429         $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')";
1430         $fields_part .= ', c.name as client';
1431         break;
1432       case 'project':
1433         $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')";
1434         $fields_part .= ', p.name as project';
1435         break;
1436
1437       case 'task':
1438         $what_to_concat .= ", ' - ', 'Null'";
1439         $fields_part .= ', null as task';
1440         break;
1441
1442       case 'cf_1':
1443         $what_to_concat .= ", ' - ', 'Null'";
1444         $fields_part .= ', null as cf_1';
1445         break;
1446     }
1447     switch ($group_by2) {
1448       case 'date':
1449         $what_to_concat .= ", ' - ', ei.date";
1450         break;
1451       case 'user':
1452         $what_to_concat .= ", ' - ', u.name";
1453         $fields_part .= ', u.name as user';
1454         break;
1455       case 'client':
1456         $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')";
1457         $fields_part .= ', c.name as client';
1458         break;
1459       case 'project':
1460         $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')";
1461         $fields_part .= ', p.name as project';
1462         break;
1463
1464       case 'task':
1465         $what_to_concat .= ", ' - ', 'Null'";
1466         $fields_part .= ', null as task';
1467         break;
1468
1469       case 'cf_1':
1470         $what_to_concat .= ", ' - ', 'Null'";
1471         $fields_part .= ', null as cf_1';
1472         break;
1473     }
1474     switch ($group_by3) {
1475       case 'date':
1476         $what_to_concat .= ", ' - ', ei.date";
1477         break;
1478       case 'user':
1479         $what_to_concat .= ", ' - ', u.name";
1480         $fields_part .= ', u.name as user';
1481         break;
1482       case 'client':
1483         $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')";
1484         $fields_part .= ', c.name as client';
1485         break;
1486       case 'project':
1487         $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')";
1488         $fields_part .= ', p.name as project';
1489         break;
1490
1491       case 'task':
1492         $what_to_concat .= ", ' - ', 'Null'";
1493         $fields_part .= ', null as task';
1494         break;
1495
1496       case 'cf_1':
1497         $what_to_concat .= ", ' - ', 'Null'";
1498         $fields_part .= ', null as cf_1';
1499         break;
1500     }
1501     // Remove garbage from the beginning.
1502     if ($what_to_concat)
1503         $what_to_concat = substr($what_to_concat, 8);
1504     $concat_part = "concat($what_to_concat) as group_field";
1505     return "$concat_part $fields_part";
1506   }
1507
1508   // makeCombinedSelectPart builds a list of fields for a combined select on a union for getSubtotals.
1509   // This is used when we include expenses.
1510   static function makeCombinedSelectPart($options) {
1511     $group_by1 = $options['group_by1'];
1512     $group_by2 = $options['group_by2'];
1513     $group_by3 = $options['group_by3'];
1514
1515     $fields = "group_field";
1516
1517     switch ($group_by1) {
1518       case 'user':
1519         $fields .= ', user';
1520         break;
1521       case 'client':
1522         $fields_part .= ', client';
1523         break;
1524       case 'project':
1525         $fields .= ', project';
1526         break;
1527
1528       case 'task':
1529         $fields .= ', task';
1530         break;
1531
1532       case 'cf_1':
1533         $fields .= ', cf_1';
1534         break;
1535     }
1536     switch ($group_by2) {
1537       case 'user':
1538         $fields .= ', user';
1539         break;
1540       case 'client':
1541         $fields_part .= ', client';
1542         break;
1543       case 'project':
1544         $fields .= ', project';
1545         break;
1546
1547       case 'task':
1548         $fields .= ', task';
1549         break;
1550
1551       case 'cf_1':
1552         $fields .= ', cf_1';
1553         break;
1554     }
1555     switch ($group_by3) {
1556       case 'user':
1557         $fields .= ', user';
1558         break;
1559       case 'client':
1560         $fields_part .= ', client';
1561         break;
1562       case 'project':
1563         $fields .= ', project';
1564         break;
1565
1566       case 'task':
1567         $fields .= ', task';
1568         break;
1569
1570       case 'cf_1':
1571         $fields .= ', cf_1';
1572         break;
1573     }
1574     return $fields;
1575   }
1576
1577   // makeJoinPart builds a left join part for getSubtotals query (for time items).
1578   static function makeJoinPart($options) {
1579     global $user;
1580
1581     $trackingMode = $user->getTrackingMode();
1582     if (ttReportHelper::groupingBy('user', $options) || MODE_TIME == $trackingMode) {
1583       $join .= ' left join tt_users u on (l.user_id = u.id)';
1584     }
1585     if (ttReportHelper::groupingBy('client', $options)) {
1586       $join .= ' left join tt_clients c on (l.client_id = c.id)';
1587     }
1588     if (ttReportHelper::groupingBy('project', $options)) {
1589       $join .= ' left join tt_projects p on (l.project_id = p.id)';
1590     }
1591     if (ttReportHelper::groupingBy('task', $options)) {
1592       $join .= ' left join tt_tasks t on (l.task_id = t.id)';
1593     }
1594     if (ttReportHelper::groupingBy('cf_1', $options)) {
1595       $custom_fields = new CustomFields();
1596       if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT)
1597         $join .= ' 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.value = cfo.id)';
1598       elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN)
1599         $join .= ' 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)';
1600     }
1601     if ($options['show_cost'] && $trackingMode != MODE_TIME) {
1602       $join .= ' left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)';
1603     }
1604     // Prepare inner joins.
1605     $inner_joins = null;
1606     if ($user->isPluginEnabled('ts') && $options['timesheet']) {
1607       $timesheet_option = $options['timesheet'];
1608       if ($timesheet_option == TIMESHEET_PENDING)
1609         $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.submit_status = 1 and ts.approve_status is null)";
1610       else if ($timesheet_option == TIMESHEET_APPROVED)
1611         $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.approve_status = 1)";
1612       else if ($timesheet_option == TIMESHEET_NOT_APPROVED)
1613         $inner_joins .= " inner join tt_timesheets ts on (l.timesheet_id = ts.id and ts.approve_status = 0)";
1614     }
1615     $join .= $inner_joins;
1616     return $join;
1617   }
1618
1619   // makeWorkUnitPart builds an sql part for work units for time items.
1620   static function makeWorkUnitPart($options) {
1621     global $user;
1622
1623     $workUnits = $options['show_work_units'];
1624     if ($workUnits) {
1625       $unitTotalsOnly = $user->getConfigOption('unit_totals_only');
1626       $firstUnitThreshold = $user->getConfigInt('1st_unit_threshold', 0);
1627       $minutesInUnit = $user->getConfigInt('minutes_in_unit', 15);
1628       if ($unitTotalsOnly)
1629         $work_unit_part = ", if (sum(l.billable * time_to_sec(l.duration)/60) < $firstUnitThreshold, 0, ceil(sum(l.billable * time_to_sec(l.duration)/60/$minutesInUnit))) as units";
1630       else
1631         $work_unit_part = ", sum(if(l.billable = 0 or time_to_sec(l.duration)/60 < $firstUnitThreshold, 0, ceil(time_to_sec(l.duration)/60/$minutesInUnit))) as units";
1632     }
1633     return $work_unit_part;
1634   }
1635
1636   // makeCostPart builds a cost part for time items.
1637   static function makeCostPart($options) {
1638     global $user;
1639
1640     if ($options['show_cost']) {
1641       if (MODE_TIME == $user->getTrackingMode())
1642         $cost_part = ", sum(cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10, 2))) as cost";
1643       else
1644         $cost_part .= ", sum(cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost";
1645     }
1646     return $cost_part;
1647   }
1648
1649   // makeJoinExpensesPart builds a left join part for getSubtotals query for expense items.
1650   static function makeJoinExpensesPart($options) {
1651     global $user;
1652
1653     if (ttReportHelper::groupingBy('user', $options)) {
1654       $join .= ' left join tt_users u on (ei.user_id = u.id)';
1655     }
1656     if (ttReportHelper::groupingBy('client', $options)) {
1657       $join .= ' left join tt_clients c on (ei.client_id = c.id)';
1658     }
1659     if (ttReportHelper::groupingBy('project', $options)) {
1660       $join .= ' left join tt_projects p on (ei.project_id = p.id)';
1661     }
1662     return $join;
1663   }
1664
1665   // grouping determines if we are grouping the report by either group_by1,
1666   // group_by2, or group_by3 values passed in $options.
1667   static function grouping($options) {
1668     $grouping = ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') ||
1669       ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') ||
1670       ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping');
1671     return $grouping;
1672   }
1673
1674   // groupingBy determines if we are grouping a report by a value of $what
1675   // ('date', 'user', 'project', etc.) by checking group_by1, group_by2,
1676   // and group_by3 values passed in $options.
1677   static function groupingBy($what, $options) {
1678     $grouping = ($options['group_by1'] == $what) || ($options['group_by2'] == $what) || ($options['group_by3'] == $what);
1679     return $grouping;
1680   }
1681
1682   // makeGroupByHeader builds a column header for a totals-only report using group_by1,
1683   // group_by2, and group_by3 values passed in $options.
1684   static function makeGroupByHeader($options) {
1685     global $i18n;
1686     global $custom_fields;
1687
1688     $no_grouping = ($options['group_by1'] == null || $options['group_by1'] == 'no_grouping') &&
1689       ($options['group_by2'] == null || $options['group_by2'] == 'no_grouping') &&
1690       ($options['group_by3'] == null || $options['group_by3'] == 'no_grouping');
1691     if ($no_grouping) return null;
1692
1693     if ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') {
1694       // We have group_by1.
1695       $group_by1 = $options['group_by1'];
1696       if ('cf_1' == $group_by1)
1697         $group_by_header .= ' - '.$custom_fields->fields[0]['label'];
1698       else {
1699         $key = 'label.'.$group_by1;
1700         $group_by_header .= ' - '.$i18n->get($key);
1701       }
1702     }
1703     if ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') {
1704       // We have group_by2.
1705       $group_by2 = $options['group_by2'];
1706       if ('cf_1' == $group_by2)
1707         $group_by_header .= ' - '.$custom_fields->fields[0]['label'];
1708       else {
1709         $key = 'label.'.$group_by2;
1710         $group_by_header .= ' - '.$i18n->get($key);
1711       }
1712     }
1713     if ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') {
1714       // We have group_by3.
1715       $group_by3 = $options['group_by3'];
1716       if ('cf_1' == $group_by3)
1717         $group_by_header .= ' - '.$custom_fields->fields[0]['label'];
1718       else {
1719         $key = 'label.'.$group_by3;
1720         $group_by_header .= ' - '.$i18n->get($key);
1721       }
1722     }
1723     $group_by_header = ltrim($group_by_header, ' -');
1724     return $group_by_header;
1725   }
1726
1727   // makeGroupByXmlTag creates an xml tag for a totals only report using group_by1,
1728   // group_by2, and group_by3 values passed in $options.
1729   static function makeGroupByXmlTag($options) {
1730     if ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') {
1731       // We have group_by1.
1732       $tag .= '_'.$options['group_by1'];
1733     }
1734     if ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') {
1735       // We have group_by2.
1736       $tag .= '_'.$options['group_by2'];
1737     }
1738     if ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') {
1739       // We have group_by3.
1740       $tag .= '_'.$options['group_by3'];
1741     }
1742     $tag = ltrim($tag, '_');
1743     return $tag;
1744   }
1745
1746   // makeGroupByLabel builds a label for one row in a "Totals only" report of grouped by items.
1747   // It does one thing: if we are grouping by date, the date format is converted for user.
1748   static function makeGroupByLabel($key, $options) {
1749     if (!ttReportHelper::groupingBy('date', $options))
1750       return $key; // No need to format.
1751
1752     global $user;
1753     if ($user->getDateFormat() == DB_DATEFORMAT)
1754       return $key; // No need to format.
1755
1756     $label = $key;
1757     if (preg_match('/\d\d\d\d-\d\d-\d\d/', $key, $matches)) {
1758       // Replace the first found match of a date in DB_DATEFORMAT.
1759       // This is not entirely clean but better than nothing for a label in a row.
1760       $userDate = ttDateToUserFormat($matches[0]);
1761       $label = str_replace($matches[0], $userDate, $key);
1762     }
1763     return $label;
1764   }
1765 }