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