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