X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;ds=sidebyside;f=WEB-INF%2Flib%2FttReportHelper.class.php;h=11f8841fe265fb30e93de4a88833e830a555d2b0;hb=03c03896828d818303c12dfe2e368f5bd9e7dbae;hp=641282758f0cd2b62c3a8bf4b067e4b35b9953aa;hpb=85d475278111ea1ed81fcd0dd5eef7140d1cd493;p=timetracker.git diff --git a/WEB-INF/lib/ttReportHelper.class.php b/WEB-INF/lib/ttReportHelper.class.php index 64128275..11f8841f 100644 --- a/WEB-INF/lib/ttReportHelper.class.php +++ b/WEB-INF/lib/ttReportHelper.class.php @@ -119,7 +119,7 @@ class ttReportHelper { // getItems retrieves all items associated with a report. // It combines tt_log and tt_expense_items in one array for presentation in one table using mysql union all. // Expense items use the "note" field for item name. - static function getItems($bean, $options) { + static function getItems($options) { global $user; $mdb2 = getConnection(); @@ -127,7 +127,15 @@ class ttReportHelper { $canViewReports = $user->can('view_reports') || $user->can('view_all_reports'); $isClient = $user->isClient(); - $group_by_option = $options['group_by']; + $grouping = ttReportHelper::grouping($options); + $grouping_by_date = ($options['group_by1'] == 'date'|| $options['group_by2'] == 'date' || $options['group_by3'] == 'date'); + $grouping_by_client = ($options['group_by1'] == 'client'|| $options['group_by2'] == 'client' || $options['group_by3'] == 'client'); + $grouping_by_project = ($options['group_by1'] == 'project'|| $options['group_by2'] == 'project' || $options['group_by3'] == 'project'); + $grouping_by_task = ($options['group_by1'] == 'task'|| $options['group_by2'] == 'task' || $options['group_by3'] == 'task'); + $grouping_by_user = ($options['group_by1'] == 'user'|| $options['group_by2'] == 'user' || $options['group_by3'] == 'user'); + $grouping_by_cf_1 = ($options['group_by1'] == 'cf_1'|| $options['group_by2'] == 'cf_1' || $options['group_by3'] == 'cf_1'); + + $group_by_option = $options['group_by1']; $convertTo12Hour = ('%I:%M %p' == $user->time_format) && ($options['show_start'] || $options['show_end']); // Prepare a query for time items in tt_log table. @@ -138,16 +146,16 @@ class ttReportHelper { if($canViewReports || $isClient) array_push($fields, 'u.name as user'); // Add client name if it is selected. - if ($options['show_client'] || 'client' == $group_by_option) + if ($options['show_client'] || $grouping_by_client) array_push($fields, 'c.name as client'); // Add project name if it is selected. - if ($options['show_project'] || 'project' == $group_by_option) + if ($options['show_project'] || $grouping_by_project) array_push($fields, 'p.name as project'); // Add task name if it is selected. - if ($options['show_task'] || 'task' == $group_by_option) + if ($options['show_task'] || $grouping_by_task) array_push($fields, 't.name as task'); // Add custom field. - $include_cf_1 = $options['show_custom_field_1'] || 'cf_1' == $group_by_option; + $include_cf_1 = $options['show_custom_field_1'] || $grouping_by_cf_1; if ($include_cf_1) { $custom_fields = new CustomFields($user->group_id); $cf_1_type = $custom_fields->fields[0]['type']; @@ -203,15 +211,15 @@ class ttReportHelper { // Prepare sql query part for left joins. $left_joins = null; - if ($options['show_client'] || 'client' == $group_by_option) + if ($options['show_client'] || $grouping_by_client) $left_joins .= " left join tt_clients c on (c.id = l.client_id)"; if (($canViewReports || $isClient) && $options['show_invoice']) $left_joins .= " left join tt_invoices i on (i.id = l.invoice_id and i.status = 1)"; if ($canViewReports || $isClient || $user->isPluginEnabled('ex')) $left_joins .= " left join tt_users u on (u.id = l.user_id)"; - if ($options['show_project'] || 'project' == $group_by_option) + if ($options['show_project'] || $grouping_by_project) $left_joins .= " left join tt_projects p on (p.id = l.project_id)"; - if ($options['show_task'] || 'task' == $group_by_option) + if ($options['show_task'] || $grouping_by_task) $left_joins .= " left join tt_tasks t on (t.id = l.task_id)"; if ($include_cf_1) { if ($cf_1_type == CustomFields::TYPE_TEXT) @@ -228,7 +236,7 @@ class ttReportHelper { // Construct sql query for tt_log items. $sql = "select ".join(', ', $fields)." from tt_log l $left_joins $where"; - // If we don't have expense items (such as when the Expenses plugin is desabled), the above is all sql we need, + // If we don't have expense items (such as when the Expenses plugin is disabled), the above is all sql we need, // with an exception of sorting part, that is added in the end. // However, when we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table. @@ -241,14 +249,14 @@ class ttReportHelper { if($canViewReports || $isClient) array_push($fields, 'u.name as user'); // Add client name if it is selected. - if ($options['show_client'] || 'client' == $group_by_option) + if ($options['show_client'] || $grouping_by_client) array_push($fields, 'c.name as client'); // Add project name if it is selected. - if ($options['show_project'] || 'project' == $group_by_option) + if ($options['show_project'] || $grouping_by_project) array_push($fields, 'p.name as project'); - if ($options['show_task'] || 'task' == $group_by_option) + if ($options['show_task'] || $grouping_by_task) array_push($fields, 'null'); // null for task name. We need to match column count for union. - if ($options['show_custom_field_1'] || 'cf_1' == $group_by_option) + if ($options['show_custom_field_1'] || $grouping_by_cf_1) array_push($fields, 'null'); // null for cf_1. if ($options['show_start']) { array_push($fields, 'null'); // null for unformatted_start. @@ -283,9 +291,9 @@ class ttReportHelper { $left_joins = null; if ($canViewReports || $isClient) $left_joins .= " left join tt_users u on (u.id = ei.user_id)"; - if ($options['show_client'] || 'client' == $group_by_option) + if ($options['show_client'] || $grouping_by_client) $left_joins .= " left join tt_clients c on (c.id = ei.client_id)"; - if ($options['show_project'] || 'project' == $group_by_option) + if ($options['show_project'] || $grouping_by_project) $left_joins .= " left join tt_projects p on (p.id = ei.project_id)"; if (($canViewReports || $isClient) && $options['show_invoice']) $left_joins .= " left join tt_invoices i on (i.id = ei.invoice_id and i.status = 1)"; @@ -301,11 +309,16 @@ class ttReportHelper { // Determine sort part. $sort_part = ' order by '; - if ($group_by_option == null || 'no_grouping' == $group_by_option || 'date' == $group_by_option) + if ($grouping) { + $sort_part2 .= ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') ? ', '.$options['group_by1'] : ''; + $sort_part2 .= ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') ? ', '.$options['group_by2'] : ''; + $sort_part2 .= ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') ? ', '.$options['group_by3'] : ''; + if (!$grouping_by_date) $sort_part2 .= ', date'; + $sort_part .= ltrim($sort_part2, ', '); // Remove leading comma and space. + } else { $sort_part .= 'date'; - else - $sort_part .= $group_by_option.', date'; - if (($canViewReports || $isClient) && $options['users'] && 'user' != $group_by_option) + } + if (($canViewReports || $isClient) && $options['users'] && !$grouping_by_user) $sort_part .= ', user, type'; if ($options['show_start']) $sort_part .= ', unformatted_start'; @@ -333,23 +346,11 @@ class ttReportHelper { if ('.' != $user->decimal_mark) $val['expense'] = str_replace('.', $user->decimal_mark, $val['expense']); } - if ('no_grouping' != $group_by_option) { - $val['grouped_by'] = $val[$group_by_option]; - if ('date' == $group_by_option) { - // This is needed to get the date in user date format. - $o_date = new DateAndTime(DB_DATEFORMAT, $val['grouped_by']); - $val['grouped_by'] = $o_date->toString($user->date_format); - unset($o_date); - } - } - // This is needed to get the date in user date format. - $o_date = new DateAndTime(DB_DATEFORMAT, $val['date']); - $val['date'] = $o_date->toString($user->date_format); - unset($o_date); + if ($grouping) $val['grouped_by'] = ttReportHelper::makeGroupByKey($options, $val); + $val['date'] = ttDateToUserFormat($val['date']); - $row = $val; - $report_items[] = $row; + $report_items[] = $val; } return $report_items; @@ -388,297 +389,24 @@ class ttReportHelper { return $items; } - // getFavItems retrieves all items associated with a favorite report. - // It combines tt_log and tt_expense_items in one array for presentation in one table using mysql union all. - // Expense items use the "note" field for item name. - static function getFavItems($options) { - global $user; - $mdb2 = getConnection(); - - // Determine these once as they are used in multiple places in this function. - $canViewReports = $user->can('view_reports') || $user->can('view_all_reports'); - $isClient = $user->isClient(); - - $group_by_option = $options['group_by']; - $convertTo12Hour = ('%I:%M %p' == $user->time_format) && ($options['show_start'] || $options['show_end']); - - // Prepare a query for time items in tt_log table. - $fields = array(); // An array of fields for database query. - array_push($fields, 'l.id as id'); - array_push($fields, '1 as type'); // Type 1 is for tt_log entries. - array_push($fields, 'l.date as date'); - if($canViewReports || $isClient) - array_push($fields, 'u.name as user'); - // Add client name if it is selected. - if ($options['show_client'] || 'client' == $group_by_option) - array_push($fields, 'c.name as client'); - // Add project name if it is selected. - if ($options['show_project'] || 'project' == $group_by_option) - array_push($fields, 'p.name as project'); - // Add task name if it is selected. - if ($options['show_task'] || 'task' == $group_by_option) - array_push($fields, 't.name as task'); - // Add custom field. - $include_cf_1 = $options['show_custom_field_1'] || 'cf_1' == $group_by_option; - if ($include_cf_1) { - $custom_fields = new CustomFields($user->group_id); - $cf_1_type = $custom_fields->fields[0]['type']; - if ($cf_1_type == CustomFields::TYPE_TEXT) { - array_push($fields, 'cfl.value as cf_1'); - } elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) { - array_push($fields, 'cfo.value as cf_1'); - } - } - // Add start time. - if ($options['show_start']) { - array_push($fields, "l.start as unformatted_start"); - array_push($fields, "TIME_FORMAT(l.start, '%k:%i') as start"); - } - // Add finish time. - if ($options['show_end']) - array_push($fields, "TIME_FORMAT(sec_to_time(time_to_sec(l.start) + time_to_sec(l.duration)), '%k:%i') as finish"); - // Add duration. - if ($options['show_duration']) - array_push($fields, "TIME_FORMAT(l.duration, '%k:%i') as duration"); - // Add work units. - if ($options['show_work_units']) { - if ($user->unit_totals_only) - array_push($fields, "null as units"); - else - 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"); - } - // Add note. - if ($options['show_note']) - array_push($fields, 'l.comment as note'); - // Handle cost. - $includeCost = $options['show_cost']; - if ($includeCost) { - if (MODE_TIME == $user->tracking_mode) - 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. - else - 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. - array_push($fields, "null as expense"); - } - // Add paid status. - if ($canViewReports && $options['show_paid']) - array_push($fields, 'l.paid as paid'); - // Add IP address. - if ($canViewReports && $options['show_ip']) { - array_push($fields, 'l.created as created'); - array_push($fields, 'l.created_ip as created_ip'); - array_push($fields, 'l.modified as modified'); - array_push($fields, 'l.modified_ip as modified_ip'); - } - // Add invoice name if it is selected. - if (($canViewReports || $isClient) && $options['show_invoice']) - array_push($fields, 'i.name as invoice'); - - // Prepare sql query part for left joins. - $left_joins = null; - if ($options['show_client'] || 'client' == $group_by_option) - $left_joins .= " left join tt_clients c on (c.id = l.client_id)"; - if (($canViewReports || $isClient) && $options['show_invoice']) - $left_joins .= " left join tt_invoices i on (i.id = l.invoice_id and i.status = 1)"; - if ($canViewReports || $isClient || $user->isPluginEnabled('ex')) - $left_joins .= " left join tt_users u on (u.id = l.user_id)"; - if ($options['show_project'] || 'project' == $group_by_option) - $left_joins .= " left join tt_projects p on (p.id = l.project_id)"; - if ($options['show_task'] || 'task' == $group_by_option) - $left_joins .= " left join tt_tasks t on (t.id = l.task_id)"; - if ($include_cf_1) { - if ($cf_1_type == CustomFields::TYPE_TEXT) - $left_joins .= " left join tt_custom_field_log cfl on (l.id = cfl.log_id and cfl.status = 1)"; - elseif ($cf_1_type == CustomFields::TYPE_DROPDOWN) { - $left_joins .= " 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)"; - } - } - if ($includeCost && MODE_TIME != $user->tracking_mode) - $left_joins .= " left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)"; - - $where = ttReportHelper::getWhere($options); - - // Construct sql query for tt_log items. - $sql = "select ".join(', ', $fields)." from tt_log l $left_joins $where"; - // If we don't have expense items (such as when the Expenses plugin is desabled), the above is all sql we need, - // with an exception of sorting part, that is added in the end. - - // However, when we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table. - if ($options['show_cost'] && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled - - $fields = array(); // An array of fields for database query. - array_push($fields, 'ei.id'); - array_push($fields, '2 as type'); // Type 2 is for tt_expense_items entries. - array_push($fields, 'ei.date'); - if($canViewReports || $isClient) - array_push($fields, 'u.name as user'); - // Add client name if it is selected. - if ($options['show_client'] || 'client' == $group_by_option) - array_push($fields, 'c.name as client'); - // Add project name if it is selected. - if ($options['show_project'] || 'project' == $group_by_option) - array_push($fields, 'p.name as project'); - if ($options['show_task'] || 'task' == $group_by_option) - array_push($fields, 'null'); // null for task name. We need to match column count for union. - if ($options['show_custom_field_1'] || 'cf_1' == $group_by_option) - array_push($fields, 'null'); // null for cf_1. - if ($options['show_start']) { - array_push($fields, 'null'); // null for unformatted_start. - array_push($fields, 'null'); // null for start. - } - if ($options['show_end']) - array_push($fields, 'null'); // null for finish. - if ($options['show_duration']) - array_push($fields, 'null'); // null for duration. - if ($options['show_work_units']) - array_push($fields, 'null as units'); // null for work units. - // Use the note field to print item name. - if ($options['show_note']) - array_push($fields, 'ei.name as note'); - array_push($fields, 'ei.cost as cost'); - array_push($fields, 'ei.cost as expense'); - // Add paid status. - if ($canViewReports && $options['show_paid']) - array_push($fields, 'ei.paid as paid'); - // Add IP address. - if ($canViewReports && $options['show_ip']) { - array_push($fields, 'ei.created as created'); - array_push($fields, 'ei.created_ip as created_ip'); - array_push($fields, 'ei.modified as modified'); - array_push($fields, 'ei.modified_ip as modified_ip'); - } - // Add invoice name if it is selected. - if (($canViewReports || $isClient) && $options['show_invoice']) - array_push($fields, 'i.name as invoice'); - - // Prepare sql query part for left joins. - $left_joins = null; - if ($canViewReports || $isClient) - $left_joins .= " left join tt_users u on (u.id = ei.user_id)"; - if ($options['show_client'] || 'client' == $group_by_option) - $left_joins .= " left join tt_clients c on (c.id = ei.client_id)"; - if ($options['show_project'] || 'project' == $group_by_option) - $left_joins .= " left join tt_projects p on (p.id = ei.project_id)"; - if (($canViewReports || $isClient) && $options['show_invoice']) - $left_joins .= " left join tt_invoices i on (i.id = ei.invoice_id and i.status = 1)"; - - $where = ttReportHelper::getExpenseWhere($options); - - // Construct sql query for expense items. - $sql_for_expense_items = "select ".join(', ', $fields)." from tt_expense_items ei $left_joins $where"; - - // Construct a union. - $sql = "($sql) union all ($sql_for_expense_items)"; - } - - // Determine sort part. - $sort_part = ' order by '; - if ($group_by_option == null || 'no_grouping' == $group_by_option || 'date' == $group_by_option) - $sort_part .= 'date'; - else - $sort_part .= $group_by_option.', date'; - if (($canViewReports || $isClient) && $options['users'] && 'user' != $group_by_option) - $sort_part .= ', user, type'; - if ($options['show_start']) - $sort_part .= ', unformatted_start'; - $sort_part .= ', id'; - - $sql .= $sort_part; - // By now we are ready with sql. - - // Obtain items for report. - $res = $mdb2->query($sql); - if (is_a($res, 'PEAR_Error')) die($res->getMessage()); - - while ($val = $res->fetchRow()) { - if ($convertTo12Hour) { - if($val['start'] != '') - $val['start'] = ttTimeHelper::to12HourFormat($val['start']); - if($val['finish'] != '') - $val['finish'] = ttTimeHelper::to12HourFormat($val['finish']); - } - if (isset($val['cost'])) { - if ('.' != $user->decimal_mark) - $val['cost'] = str_replace('.', $user->decimal_mark, $val['cost']); - } - if (isset($val['expense'])) { - if ('.' != $user->decimal_mark) - $val['expense'] = str_replace('.', $user->decimal_mark, $val['expense']); - } - if ('no_grouping' != $group_by_option) { - $val['grouped_by'] = $val[$group_by_option]; - if ('date' == $group_by_option) { - // This is needed to get the date in user date format. - $o_date = new DateAndTime(DB_DATEFORMAT, $val['grouped_by']); - $val['grouped_by'] = $o_date->toString($user->date_format); - unset($o_date); - } - } - - // This is needed to get the date in user date format. - $o_date = new DateAndTime(DB_DATEFORMAT, $val['date']); - $val['date'] = $o_date->toString($user->date_format); - unset($o_date); - - $row = $val; - $report_items[] = $row; - } - - return $report_items; - } - // getSubtotals calculates report items subtotals when a report is grouped by. // Without expenses, it's a simple select with group by. // With expenses, it becomes a select with group by from a combined set of records obtained with "union all". - static function getSubtotals($bean, $options) { + static function getSubtotals($options) { global $user; - $group_by_option = $bean->getAttribute('group_by'); - if ('no_grouping' == $group_by_option) return null; - $mdb2 = getConnection(); - // Start with sql to obtain subtotals for time items. This simple sql will be used when we have no expenses. - - // Determine group by field and a required join. - switch ($group_by_option) { - case 'date': - $group_field = 'l.date'; - $group_join = ''; - break; - case 'user': - $group_field = 'u.name'; - $group_join = 'left join tt_users u on (l.user_id = u.id) '; - break; - case 'client': - $group_field = 'c.name'; - $group_join = 'left join tt_clients c on (l.client_id = c.id) '; - break; - case 'project': - $group_field = 'p.name'; - $group_join = 'left join tt_projects p on (l.project_id = p.id) '; - break; - case 'task': - $group_field = 't.name'; - $group_join = 'left join tt_tasks t on (l.task_id = t.id) '; - break; - case 'cf_1': - $group_field = 'cfo.value'; - $custom_fields = new CustomFields($user->group_id); - if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT) - $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) '; - elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) - $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) '; - break; - } - + $concat_part = ttReportHelper::makeConcatPart($options); + $join_part = ttReportHelper::makeJoinPart($options); $where = ttReportHelper::getWhere($options); - if ($bean->getAttribute('chcost')) { + $group_by_part = ttReportHelper::makeGroupByPart($options); + if ($options['show_cost']) { if (MODE_TIME == $user->tracking_mode) { - if ($group_by_option != 'user') + if (!ttReportHelper::groupingByUser($options)) $left_join = 'left join tt_users u on (l.user_id = u.id)'; - $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time"; - if ($bean->getAttribute('chunits')) { + $sql = "select $concat_part, sum(time_to_sec(l.duration)) as time"; + if ($options['show_work_units']) { if ($user->unit_totals_only) $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"; else @@ -686,340 +414,81 @@ class ttReportHelper { } $sql .= ", sum(cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10, 2))) as cost, null as expenses from tt_log l - $group_join $left_join $where group by $group_field"; + $join_part $left_join $where $group_by_part"; } else { // If we are including cost and tracking projects, our query (the same as above) needs to join the tt_user_project_binds table. - $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time"; - if ($bean->getAttribute('chunits')) { + $sql = "select $concat_part, sum(time_to_sec(l.duration)) as time"; + if ($options['show_work_units']) { if ($user->unit_totals_only) $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"; else $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"; } $sql .= ", sum(cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost, - null as expenses from tt_log l - $group_join - 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"; + null as expenses from tt_log l + $join_part + 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"; } - } else { - $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time"; - if ($bean->getAttribute('chunits')) { + } else { + // $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time"; + $sql = "select $concat_part, sum(time_to_sec(l.duration)) as time"; + if ($options['show_work_units']) { if ($user->unit_totals_only) $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"; else $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"; } - $sql .= ", null as expenses from tt_log l - $group_join $where group by $group_field"; + $sql .= ", null as expenses from tt_log l + $join_part $where $group_by_part"; } // By now we have sql for time items. // However, when we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table. - if ($bean->getAttribute('chcost') && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled - - // Determine group by field and a required join. - $group_join = null; - $group_field = 'null'; - switch ($group_by_option) { - case 'date': - $group_field = 'ei.date'; - $group_join = ''; - break; - case 'user': - $group_field = 'u.name'; - $group_join = 'left join tt_users u on (ei.user_id = u.id) '; - break; - case 'client': - $group_field = 'c.name'; - $group_join = 'left join tt_clients c on (ei.client_id = c.id) '; - break; - case 'project': - $group_field = 'p.name'; - $group_join = 'left join tt_projects p on (ei.project_id = p.id) '; - break; - } + if ($options['show_cost'] && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled + $concat_part = ttReportHelper::makeConcatExpensesPart($options); + $join_part = ttReportHelper::makeJoinExpensesPart($options); $where = ttReportHelper::getExpenseWhere($options); - $sql_for_expenses = "select $group_field as group_field, null as time"; - if ($bean->getAttribute('chunits')) $sql_for_expenses .= ", null as units"; - $sql_for_expenses .= ", sum(ei.cost) as cost, sum(ei.cost) as expenses from tt_expense_items ei $group_join $where"; - // Add a "group by" clause if we are grouping. - if ('null' != $group_field) $sql_for_expenses .= " group by $group_field"; + $group_by_expenses_part = ttReportHelper::makeGroupByExpensesPart($options); + $sql_for_expenses = "select $concat_part, null as time"; + if ($options['show_work_units']) $sql_for_expenses .= ", null as units"; + $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"; // Create a combined query. - $combined = "select group_field, sum(time) as time"; - if ($bean->getAttribute('chunits')) $combined .= ", sum(units) as units"; - $combined .= ", sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t group by group_field"; + $fields = ttReportHelper::makeCombinedSelectPart($options); + $combined = "select $fields, sum(time) as time"; + if ($options['show_work_units']) $combined .= ", sum(units) as units"; + $combined .= ", sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t group by $fields"; $sql = $combined; } // Execute query. $res = $mdb2->query($sql); if (is_a($res, 'PEAR_Error')) die($res->getMessage()); - while ($val = $res->fetchRow()) { - if ('date' == $group_by_option) { - // This is needed to get the date in user date format. - $o_date = new DateAndTime(DB_DATEFORMAT, $val['group_field']); - $val['group_field'] = $o_date->toString($user->date_format); - unset($o_date); - } $time = $val['time'] ? sec_to_time_fmt_hm($val['time']) : null; - if ($bean->getAttribute('chcost')) { + $rowLabel = ttReportHelper::makeGroupByLabel($val['group_field'], $options); + if ($options['show_cost']) { if ('.' != $user->decimal_mark) { $val['cost'] = str_replace('.', $user->decimal_mark, $val['cost']); $val['expenses'] = str_replace('.', $user->decimal_mark, $val['expenses']); } - $subtotals[$val['group_field']] = array('name'=>$val['group_field'],'time'=>$time, 'units'=> $val['units'],'cost'=>$val['cost'],'expenses'=>$val['expenses']); + $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']); } else - $subtotals[$val['group_field']] = array('name'=>$val['group_field'],'time'=>$time, 'units'=> $val['units']); + $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']); } return $subtotals; } - // getFavSubtotals calculates report items subtotals when a favorite report is grouped by. - // Without expenses, it's a simple select with group by. - // With expenses, it becomes a select with group by from a combined set of records obtained with "union all". - static function getFavSubtotals($options) { + // getTotals calculates total hours and cost for all report items. + static function getTotals($options) + { global $user; - $group_by_option = $options['group_by']; - if ('no_grouping' == $group_by_option) return null; - $mdb2 = getConnection(); - // Start with sql to obtain subtotals for time items. This simple sql will be used when we have no expenses. - - // Determine group by field and a required join. - switch ($group_by_option) { - case 'date': - $group_field = 'l.date'; - $group_join = ''; - break; - case 'user': - $group_field = 'u.name'; - $group_join = 'left join tt_users u on (l.user_id = u.id) '; - break; - case 'client': - $group_field = 'c.name'; - $group_join = 'left join tt_clients c on (l.client_id = c.id) '; - break; - case 'project': - $group_field = 'p.name'; - $group_join = 'left join tt_projects p on (l.project_id = p.id) '; - break; - case 'task': - $group_field = 't.name'; - $group_join = 'left join tt_tasks t on (l.task_id = t.id) '; - break; - case 'cf_1': - $group_field = 'cfo.value'; - $custom_fields = new CustomFields($user->group_id); - if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT) - $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) '; - elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) - $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) '; - break; - } - - $where = ttReportHelper::getWhere($options); - if ($options['show_cost']) { - if (MODE_TIME == $user->tracking_mode) { - if ($group_by_option != 'user') - $left_join = 'left join tt_users u on (l.user_id = u.id)'; - $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time"; - if ($options['show_work_units']) { - if ($user->unit_totals_only) - $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"; - else - $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"; - } - $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"; - $sql .= ", sum(cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10, 2))) as cost, - null as expenses from tt_log l - $group_join $left_join $where group by $group_field"; - } else { - // If we are including cost and tracking projects, our query (the same as above) needs to join the tt_user_project_binds table. - $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time"; - if ($options['show_work_units']) { - if ($user->unit_totals_only) - $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"; - else - $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"; - } - $sql .= ", sum(cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost, - null as expenses from tt_log l - $group_join - 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"; - } - } else { - $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time"; - if ($options['show_work_units']) { - if ($user->unit_totals_only) - $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"; - else - $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"; - } - $sql .= ", null as expenses from tt_log l - $group_join $where group by $group_field"; - } - // By now we have sql for time items. - - // However, when we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table. - if ($options['show_cost'] && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled - - // Determine group by field and a required join. - $group_join = null; - $group_field = 'null'; - switch ($group_by_option) { - case 'date': - $group_field = 'ei.date'; - $group_join = ''; - break; - case 'user': - $group_field = 'u.name'; - $group_join = 'left join tt_users u on (ei.user_id = u.id) '; - break; - case 'client': - $group_field = 'c.name'; - $group_join = 'left join tt_clients c on (ei.client_id = c.id) '; - break; - case 'project': - $group_field = 'p.name'; - $group_join = 'left join tt_projects p on (ei.project_id = p.id) '; - break; - } - - $where = ttReportHelper::getExpenseWhere($options); - $sql_for_expenses = "select $group_field as group_field, null as time"; - if ($options['show_work_units']) $sql_for_expenses .= ", null as units"; - $sql_for_expenses .= ", sum(ei.cost) as cost, sum(ei.cost) as expenses from tt_expense_items ei $group_join $where"; - // Add a "group by" clause if we are grouping. - if ('null' != $group_field) $sql_for_expenses .= " group by $group_field"; - - // Create a combined query. - $combined = "select group_field, sum(time) as time"; - if ($options['show_work_units']) $combined .= ", sum(units) as units"; - $combined .= ", sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t group by group_field"; - $sql = $combined; - } - - // Execute query. - $res = $mdb2->query($sql); - if (is_a($res, 'PEAR_Error')) die($res->getMessage()); - - while ($val = $res->fetchRow()) { - if ('date' == $group_by_option) { - // This is needed to get the date in user date format. - $o_date = new DateAndTime(DB_DATEFORMAT, $val['group_field']); - $val['group_field'] = $o_date->toString($user->date_format); - unset($o_date); - } - $time = $val['time'] ? sec_to_time_fmt_hm($val['time']) : null; - if ($options['show_cost']) { - if ('.' != $user->decimal_mark) { - $val['cost'] = str_replace('.', $user->decimal_mark, $val['cost']); - $val['expenses'] = str_replace('.', $user->decimal_mark, $val['expenses']); - } - $subtotals[$val['group_field']] = array('name'=>$val['group_field'],'time'=>$time, 'units'=> $val['units'], 'cost'=>$val['cost'],'expenses'=>$val['expenses']); - } else - $subtotals[$val['group_field']] = array('name'=>$val['group_field'],'time'=>$time, 'units'=> $val['units']); - } - - return $subtotals; - } - - // getTotals calculates total hours and cost for all report items. - static function getTotals($bean, $options) - { - global $user; - - $mdb2 = getConnection(); - - $where = ttReportHelper::getWhere($options); - - // Prepare parts. - $time_part = "sum(time_to_sec(l.duration)) as time"; - if ($bean->getAttribute('chunits')) { - $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"; - } - if ($bean->getAttribute('chcost')) { - if (MODE_TIME == $user->tracking_mode) - $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"; - else - $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"; - } else { - $cost_part = ", null as cost, null as expenses"; - } - if ($bean->getAttribute('chcost')) { - if (MODE_TIME == $user->tracking_mode) { - $left_joins = "left join tt_users u on (l.user_id = u.id)"; - } else { - $left_joins = "left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)"; - } - } - // Prepare a query for time items. - $sql = "select $time_part $units_part $cost_part from tt_log l $left_joins $where"; - - // If we have expenses, query becomes a bit more complex. - if ($bean->getAttribute('chcost') && $user->isPluginEnabled('ex')) { - $where = ttReportHelper::getExpenseWhere($options); - $sql_for_expenses = "select null as time"; - if ($bean->getAttribute('chunits')) $sql_for_expenses .= ", null as units"; - $sql_for_expenses .= ", sum(cost) as cost, sum(cost) as expenses from tt_expense_items ei $where"; - - // Create a combined query. - $combined = "select sum(time) as time"; - if ($bean->getAttribute('chunits')) $combined .= ", sum(units) as units"; - $combined .= ", sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t"; - $sql = $combined; - } - - // Execute query. - $res = $mdb2->query($sql); - if (is_a($res, 'PEAR_Error')) die($res->getMessage()); - - $val = $res->fetchRow(); - $total_time = $val['time'] ? sec_to_time_fmt_hm($val['time']) : null; - if ($bean->getAttribute('chcost')) { - $total_cost = $val['cost']; - if (!$total_cost) $total_cost = '0.00'; - if ('.' != $user->decimal_mark) - $total_cost = str_replace('.', $user->decimal_mark, $total_cost); - $total_expenses = $val['expenses']; - if (!$total_expenses) $total_expenses = '0.00'; - if ('.' != $user->decimal_mark) - $total_expenses = str_replace('.', $user->decimal_mark, $total_expenses); - } - - if ($bean->getAttribute('period')) - $period = new Period($bean->getAttribute('period'), new DateAndTime($user->date_format)); - else { - $period = new Period(); - $period->setPeriod( - new DateAndTime($user->date_format, $bean->getAttribute('start_date')), - new DateAndTime($user->date_format, $bean->getAttribute('end_date'))); - } - - $totals['start_date'] = $period->getStartDate(); - $totals['end_date'] = $period->getEndDate(); - $totals['time'] = $total_time; - $totals['units'] = $val['units']; - $totals['cost'] = $total_cost; - $totals['expenses'] = $total_expenses; - - return $totals; - } - - // getFavTotals calculates total hours and cost for all favorite report items. - static function getFavTotals($options) - { - global $user; - - $mdb2 = getConnection(); - - $where = ttReportHelper::getWhere($options); + $where = ttReportHelper::getWhere($options); // Prepare parts. $time_part = "sum(time_to_sec(l.duration)) as time"; @@ -1130,21 +599,20 @@ class ttReportHelper { } // prepareReportBody - prepares an email body for report. - static function prepareReportBody($bean, $comment) + static function prepareReportBody($options, $comment = null) { global $user; global $i18n; // Determine these once as they are used in multiple places in this function. - $canViewReports = $user->can('view_reports'); + $canViewReports = $user->can('view_reports') || $user->can('view_all_reports'); $isClient = $user->isClient(); - $options = ttReportHelper::getReportOptions($bean); - $items = ttReportHelper::getItems($bean, $options); - $group_by = $bean->getAttribute('group_by'); + $items = ttReportHelper::getItems($options); + $group_by = $options['group_by1']; if ($group_by && 'no_grouping' != $group_by) - $subtotals = ttReportHelper::getSubtotals($bean, $options); - $totals = ttReportHelper::getTotals($bean, $options); + $subtotals = ttReportHelper::getSubtotals($options); + $totals = ttReportHelper::getTotals($options); // Use custom fields plugin if it is enabled. if ($user->isPluginEnabled('cf')) @@ -1173,7 +641,7 @@ class ttReportHelper { // Output comment. if ($comment) $body .= '
'.htmlspecialchars($comment).'
'; - if ($bean->getAttribute('chtotalsonly')) { + if ($options['show_totals_only']) { // Totals only report. Output subtotals. // Determine group_by header. @@ -1187,27 +655,27 @@ class ttReportHelper { $body .= ''.$group_by_header.' | '; - if ($bean->getAttribute('chduration')) + if ($options['show_duration']) $body .= ''.$i18n->get('label.duration').' | '; - if ($bean->getAttribute('chunits')) + if ($options['show_work_units']) $body .= ''.$i18n->get('label.work_units_short').' | '; - if ($bean->getAttribute('chcost')) + if ($options['show_cost']) $body .= ''.$i18n->get('label.cost').' | '; $body .= '|||||||||||||||||||||||
'.($subtotal['name'] ? htmlspecialchars($subtotal['name']) : ' ').' | '; - if ($bean->getAttribute('chduration')) { + if ($options['show_duration']) { $body .= ''; if ($subtotal['time'] <> '0:00') $body .= $subtotal['time']; $body .= ' | '; } - if ($bean->getAttribute('chunits')) { + if ($options['show_work_units']) { $body .= ''; $body .= $subtotal['units']; $body .= ' | '; } - if ($bean->getAttribute('chcost')) { + if ($options['show_cost']) { $body .= ''; $body .= ($canViewReports || $isClient) ? $subtotal['cost'] : $subtotal['expenses']; $body .= ' | '; @@ -1219,17 +687,17 @@ class ttReportHelper { $body .= '|||||||||||||||||||||||
'.$i18n->get('label.total').' | '; - if ($bean->getAttribute('chduration')) { + if ($options['show_duration']) { $body .= ''; if ($totals['time'] <> '0:00') $body .= $totals['time']; $body .= ' | '; } - if ($bean->getAttribute('chunits')) { + if ($options['show_work_units']) { $body .= ''; $body .= $totals['units']; $body .= ' | '; } - if ($bean->getAttribute('chcost')) { + if ($options['show_cost']) { $body .= ''.htmlspecialchars($user->currency).' '; $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses']; $body .= ' | '; @@ -1246,31 +714,31 @@ class ttReportHelper { $body .= ''.$i18n->get('label.date').' | '; if ($canViewReports || $isClient) $body .= ''.$i18n->get('label.user').' | '; - if ($bean->getAttribute('chclient')) + if ($options['show_client']) $body .= ''.$i18n->get('label.client').' | '; - if ($bean->getAttribute('chproject')) + if ($options['show_project']) $body .= ''.$i18n->get('label.project').' | '; - if ($bean->getAttribute('chtask')) + if ($options['show_task']) $body .= ''.$i18n->get('label.task').' | '; - if ($bean->getAttribute('chcf_1')) + if ($options['show_custom_field_1']) $body .= ''.htmlspecialchars($custom_fields->fields[0]['label']).' | '; - if ($bean->getAttribute('chstart')) + if ($options['show_start']) $body .= ''.$i18n->get('label.start').' | '; - if ($bean->getAttribute('chfinish')) + if ($options['show_end']) $body .= ''.$i18n->get('label.finish').' | '; - if ($bean->getAttribute('chduration')) + if ($options['show_duration']) $body .= ''.$i18n->get('label.duration').' | '; - if ($bean->getAttribute('chunits')) + if ($options['show_work_units']) $body .= ''.$i18n->get('label.work_units_short').' | '; - if ($bean->getAttribute('chnote')) + if ($options['show_note']) $body .= ''.$i18n->get('label.note').' | '; - if ($bean->getAttribute('chcost')) + if ($options['show_cost']) $body .= ''.$i18n->get('label.cost').' | '; - if ($bean->getAttribute('chpaid')) + if ($options['show_paid']) $body .= ''.$i18n->get('label.paid').' | '; - if ($bean->getAttribute('chip')) + if ($options['show_ip']) $body .= ''.$i18n->get('label.ip').' | '; - if ($bean->getAttribute('chinvoice')) + if ($options['show_invoice']) $body .= ''.$i18n->get('label.invoice').' | '; $body .= ''.$i18n->get('label.subtotal').' | '; $subtotal_name = htmlspecialchars($subtotals[$prev_grouped_by]['name']); if ($canViewReports || $isClient) $body .= ''.($group_by == 'user' ? $subtotal_name : '').' | '; - if ($bean->getAttribute('chclient')) $body .= ''.($group_by == 'client' ? $subtotal_name : '').' | '; - if ($bean->getAttribute('chproject')) $body .= ''.($group_by == 'project' ? $subtotal_name : '').' | '; - if ($bean->getAttribute('chtask')) $body .= ''.($group_by == 'task' ? $subtotal_name : '').' | '; - if ($bean->getAttribute('chcf_1')) $body .= ''.($group_by == 'cf_1' ? $subtotal_name : '').' | '; - if ($bean->getAttribute('chstart')) $body .= ''; - if ($bean->getAttribute('chfinish')) $body .= ' | '; - if ($bean->getAttribute('chduration')) $body .= ' | '.$subtotals[$prev_grouped_by]['time'].' | '; - if ($bean->getAttribute('chunits')) $body .= ''.$subtotals[$prev_grouped_by]['units'].' | '; - if ($bean->getAttribute('chnote')) $body .= ''; - if ($bean->getAttribute('chcost')) { + if ($options['show_client']) $body .= ' | '.($group_by == 'client' ? $subtotal_name : '').' | '; + if ($options['show_project']) $body .= ''.($group_by == 'project' ? $subtotal_name : '').' | '; + if ($options['show_task']) $body .= ''.($group_by == 'task' ? $subtotal_name : '').' | '; + if ($options['show_custom_field_1']) $body .= ''.($group_by == 'cf_1' ? $subtotal_name : '').' | '; + if ($options['show_start']) $body .= ''; + if ($options['show_end']) $body .= ' | '; + if ($options['show_duration']) $body .= ' | '.$subtotals[$prev_grouped_by]['time'].' | '; + if ($options['show_work_units']) $body .= ''.$subtotals[$prev_grouped_by]['units'].' | '; + if ($options['show_note']) $body .= ''; + if ($options['show_cost']) { $body .= ' | '; $body .= ($canViewReports || $isClient) ? $subtotals[$prev_grouped_by]['cost'] : $subtotals[$prev_grouped_by]['expenses']; $body .= ' | '; } - if ($bean->getAttribute('chpaid')) $body .= ''; - if ($bean->getAttribute('chip')) $body .= ' | '; - if ($bean->getAttribute('chinvoice')) $body .= ' | '; + if ($options['show_paid']) $body .= ' | '; + if ($options['show_ip']) $body .= ' | '; + if ($options['show_invoice']) $body .= ' | '; $body .= ''; $body .= ' |
'.$record['date'].' | '; if ($canViewReports || $isClient) $body .= ''.htmlspecialchars($record['user']).' | '; - if ($bean->getAttribute('chclient')) + if ($options['show_client']) $body .= ''.htmlspecialchars($record['client']).' | '; - if ($bean->getAttribute('chproject')) + if ($options['show_project']) $body .= ''.htmlspecialchars($record['project']).' | '; - if ($bean->getAttribute('chtask')) + if ($options['show_task']) $body .= ''.htmlspecialchars($record['task']).' | '; - if ($bean->getAttribute('chcf_1')) + if ($options['show_custom_field_1']) $body .= ''.htmlspecialchars($record['cf_1']).' | '; - if ($bean->getAttribute('chstart')) + if ($options['show_start']) $body .= ''.$record['start'].' | '; - if ($bean->getAttribute('chfinish')) + if ($options['show_end']) $body .= ''.$record['finish'].' | '; - if ($bean->getAttribute('chduration')) + if ($options['show_duration']) $body .= ''.$record['duration'].' | '; - if ($bean->getAttribute('chunits')) + if ($options['show_work_units']) $body .= ''.$record['units'].' | '; - if ($bean->getAttribute('chnote')) + if ($options['show_note']) $body .= ''.htmlspecialchars($record['note']).' | '; - if ($bean->getAttribute('chcost')) + if ($options['show_cost']) $body .= ''.$record['cost'].' | '; - if ($bean->getAttribute('chpaid')) { + if ($options['show_paid']) { $body .= ''; $body .= $record['paid'] == 1 ? $i18n->get('label.yes') : $i18n->get('label.no'); $body .= ' | '; } - if ($bean->getAttribute('chip')) { + if ($options['show_ip']) { $body .= ''; $body .= $record['modified'] ? $record['modified_ip'].' '.$record['modified'] : $record['created_ip'].' '.$record['created']; $body .= ' | '; } - if ($bean->getAttribute('chinvoice')) + if ($options['show_invoice']) $body .= ''.htmlspecialchars($record['invoice']).' | '; $body .= ''; @@ -1374,23 +842,23 @@ class ttReportHelper { $body .= ''.$i18n->get('label.subtotal').' | '; $subtotal_name = htmlspecialchars($subtotals[$cur_grouped_by]['name']); if ($canViewReports || $isClient) $body .= ''.($group_by == 'user' ? $subtotal_name : '').' | '; - if ($bean->getAttribute('chclient')) $body .= ''.($group_by == 'client' ? $subtotal_name : '').' | '; - if ($bean->getAttribute('chproject')) $body .= ''.($group_by == 'project' ? $subtotal_name : '').' | '; - if ($bean->getAttribute('chtask')) $body .= ''.($group_by == 'task' ? $subtotal_name : '').' | '; - if ($bean->getAttribute('chcf_1')) $body .= ''.($group_by == 'cf_1' ? $subtotal_name : '').' | '; - if ($bean->getAttribute('chstart')) $body .= ''; - if ($bean->getAttribute('chfinish')) $body .= ' | '; - if ($bean->getAttribute('chduration')) $body .= ' | '.$subtotals[$cur_grouped_by]['time'].' | '; - if ($bean->getAttribute('chunits')) $body .= ''.$subtotals[$cur_grouped_by]['units'].' | '; - if ($bean->getAttribute('chnote')) $body .= ''; - if ($bean->getAttribute('chcost')) { + if ($options['show_client']) $body .= ' | '.($group_by == 'client' ? $subtotal_name : '').' | '; + if ($options['show_project']) $body .= ''.($group_by == 'project' ? $subtotal_name : '').' | '; + if ($options['show_task']) $body .= ''.($group_by == 'task' ? $subtotal_name : '').' | '; + if ($options['show_custom_field_1']) $body .= ''.($group_by == 'cf_1' ? $subtotal_name : '').' | '; + if ($options['show_start']) $body .= ''; + if ($options['show_end']) $body .= ' | '; + if ($options['show_duration']) $body .= ' | '.$subtotals[$cur_grouped_by]['time'].' | '; + if ($options['show_work_units']) $body .= ''.$subtotals[$cur_grouped_by]['units'].' | '; + if ($options['show_note']) $body .= ''; + if ($options['show_cost']) { $body .= ' | '; $body .= ($canViewReports || $isClient) ? $subtotals[$cur_grouped_by]['cost'] : $subtotals[$cur_grouped_by]['expenses']; $body .= ' | '; } - if ($bean->getAttribute('chpaid')) $body .= ''; - if ($bean->getAttribute('chip')) $body .= ' | '; - if ($bean->getAttribute('chinvoice')) $body .= ' | '; + if ($options['show_paid']) $body .= ' | '; + if ($options['show_ip']) $body .= ' | '; + if ($options['show_invoice']) $body .= ' | '; $body .= ''; } @@ -1399,23 +867,23 @@ class ttReportHelper { $body .= ' |
'.$i18n->get('label.total').' | '; if ($canViewReports || $isClient) $body .= ''; - if ($bean->getAttribute('chclient')) $body .= ' | '; - if ($bean->getAttribute('chproject')) $body .= ' | '; - if ($bean->getAttribute('chtask')) $body .= ' | '; - if ($bean->getAttribute('chcf_1')) $body .= ' | '; - if ($bean->getAttribute('chstart')) $body .= ' | '; - if ($bean->getAttribute('chfinish')) $body .= ' | '; - if ($bean->getAttribute('chduration')) $body .= ' | '.$totals['time'].' | '; - if ($bean->getAttribute('chunits')) $body .= ''.$totals['units'].' | '; - if ($bean->getAttribute('chnote')) $body .= ''; - if ($bean->getAttribute('chcost')) { + if ($options['show_client']) $body .= ' | '; + if ($options['show_project']) $body .= ' | '; + if ($options['show_task']) $body .= ' | '; + if ($options['show_custom_field_1']) $body .= ' | '; + if ($options['show_start']) $body .= ' | '; + if ($options['show_end']) $body .= ' | '; + if ($options['show_duration']) $body .= ' | '.$totals['time'].' | '; + if ($options['show_work_units']) $body .= ''.$totals['units'].' | '; + if ($options['show_note']) $body .= ''; + if ($options['show_cost']) { $body .= ' | '.htmlspecialchars($user->currency).' '; $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses']; $body .= ' | '; } - if ($bean->getAttribute('chpaid')) $body .= ''; - if ($bean->getAttribute('chip')) $body .= ' | '; - if ($bean->getAttribute('chinvoice')) $body .= ' | '; + if ($options['show_paid']) $body .= ' | '; + if ($options['show_ip']) $body .= ' | '; + if ($options['show_invoice']) $body .= ' | '; $body .= ' |
'.$i18n->get('form.mail.report_subject').': '.$totals['start_date'].' - '.$totals['end_date'].'
'; + return false; + } - // Output comment. - // if ($comment) $body .= ''.htmlspecialchars($comment).'
'; // No comment for fav. reports. + // sendFavReport - sends a favorite report to a specified email, called from cron.php + static function sendFavReport($options, $subject, $email, $cc) { + // We are called from cron.php, we have no $bean in session. + // cron.php sets global $user and $i18n objects to match our favorite report user. + global $user; + global $i18n; - if ($options['show_totals_only']) { - // Totals only report. Output subtotals. + // Prepare report body. + $body = ttReportHelper::prepareReportBody($options); - // Determine group_by header. - if ('cf_1' == $group_by) - $group_by_header = htmlspecialchars($custom_fields->fields[0]['label']); - else { - $key = 'label.'.$group_by; - $group_by_header = $i18n->get($key); - } + import('mail.Mailer'); + $mailer = new Mailer(); + $mailer->setCharSet(CHARSET); + $mailer->setContentType('text/html'); + $mailer->setSender(SENDER); + if (!empty($cc)) + $mailer->setReceiverCC($cc); + if (!empty($user->bcc_email)) + $mailer->setReceiverBCC($user->bcc_email); + $mailer->setReceiver($email); + $mailer->setMailMode(MAIL_MODE); + if (empty($subject)) $subject = $options['name']; + if (!$mailer->send($subject, $body)) + return false; - $body .= ''.$group_by_header.' | '; - if ($options['show_duration']) - $body .= ''.$i18n->get('label.duration').' | '; - if ($options['show_work_units']) - $body .= ''.$i18n->get('label.work_units_short').' | '; - if ($options['show_cost']) - $body .= ''.$i18n->get('label.cost').' | '; - $body .= '
'.($subtotal['name'] ? htmlspecialchars($subtotal['name']) : ' ').' | '; - if ($options['show_duration']) { - $body .= ''; - if ($subtotal['time'] <> '0:00') $body .= $subtotal['time']; - $body .= ' | '; - } - if ($options['show_work_units']) { - $body .= ''; - $body .= $subtotal['units']; - $body .= ' | '; - } - if ($options['show_cost']) { - $body .= ''; - $body .= ($canViewReports || $isClient) ? $subtotal['cost'] : $subtotal['expenses']; - $body .= ' | '; - } - $body .= '
'.$i18n->get('label.total').' | '; - if ($options['show_duration']) { - $body .= ''; - if ($totals['time'] <> '0:00') $body .= $totals['time']; - $body .= ' | '; - } - if ($options['show_work_units']) { - $body .= ''; - $body .= $totals['units']; - $body .= ' | '; + // getReportOptions - returns an array of report options constructed from session bean. + // + // Note: similarly to ttFavReportHelper::getReportOptions, this function is a part of + // refactoring to simplify maintenance of report generating functions, as we currently + // have 2 sets: normal reporting (from bean), and fav report emailing (from db fields). + // Using options obtained from either db or bean shall allow us to use only one set of functions. + static function getReportOptions($bean) { + global $user; + + // Prepare an array of report options. + $options = array(); + + // Construct one by one. + $options['name'] = null; // No name required. + $options['user_id'] = $user->id; // Not sure if we need user_id here. Fav reports use it to recycle $user object in cron.php. + $options['client_id'] = $bean->getAttribute('client'); + $options['cf_1_option_id'] = $bean->getAttribute('option'); + $options['project_id'] = $bean->getAttribute('project'); + $options['task_id'] = $bean->getAttribute('task'); + $options['billable'] = $bean->getAttribute('include_records'); + $options['invoice'] = $bean->getAttribute('invoice'); + $options['paid_status'] = $bean->getAttribute('paid_status'); + if (is_array($bean->getAttribute('users'))) $options['users'] = join(',', $bean->getAttribute('users')); + $options['period'] = $bean->getAttribute('period'); + $options['period_start'] = $bean->getAttribute('start_date'); + $options['period_end'] = $bean->getAttribute('end_date'); + $options['show_client'] = $bean->getAttribute('chclient'); + $options['show_invoice'] = $bean->getAttribute('chinvoice'); + $options['show_paid'] = $bean->getAttribute('chpaid'); + $options['show_ip'] = $bean->getAttribute('chip'); + $options['show_project'] = $bean->getAttribute('chproject'); + $options['show_start'] = $bean->getAttribute('chstart'); + $options['show_duration'] = $bean->getAttribute('chduration'); + $options['show_cost'] = $bean->getAttribute('chcost'); + $options['show_task'] = $bean->getAttribute('chtask'); + $options['show_end'] = $bean->getAttribute('chfinish'); + $options['show_note'] = $bean->getAttribute('chnote'); + $options['show_custom_field_1'] = $bean->getAttribute('chcf_1'); + $options['show_work_units'] = $bean->getAttribute('chunits'); + $options['show_totals_only'] = $bean->getAttribute('chtotalsonly'); + $options['group_by1'] = $bean->getAttribute('group_by1'); + $options['group_by2'] = $bean->getAttribute('group_by2'); + $options['group_by3'] = $bean->getAttribute('group_by3'); + return $options; + } + + // verifyBean is a security function to make sure data in bean makes sense for a group. + static function verifyBean($bean) { + global $user; + + // Check users. + $users_in_bean = $bean->getAttribute('users'); + if (is_array($users_in_bean)) { + $users_in_group = ttTeamHelper::getUsers(); + foreach ($users_in_group as $user_in_group) { + $valid_ids[] = $user_in_group['id']; } - if ($options['show_cost']) { - $body .= ''.htmlspecialchars($user->currency).' '; - $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses']; - $body .= ' | '; + foreach ($users_in_bean as $user_in_bean) { + if (!in_array($user_in_bean, $valid_ids)) { + return false; + } } - $body .= '
'.$i18n->get('label.date').' | '; - if ($canViewReports || $isClient) - $body .= ''.$i18n->get('label.user').' | '; - if ($options['show_client']) - $body .= ''.$i18n->get('label.client').' | '; - if ($options['show_project']) - $body .= ''.$i18n->get('label.project').' | '; - if ($options['show_task']) - $body .= ''.$i18n->get('label.task').' | '; - if ($options['show_custom_field_1']) - $body .= ''.htmlspecialchars($custom_fields->fields[0]['label']).' | '; - if ($options['show_start']) - $body .= ''.$i18n->get('label.start').' | '; - if ($options['show_end']) - $body .= ''.$i18n->get('label.finish').' | '; - if ($options['show_duration']) - $body .= ''.$i18n->get('label.duration').' | '; - if ($options['show_work_units']) - $body .= ''.$i18n->get('label.work_units_short').' | '; - if ($options['show_note']) - $body .= ''.$i18n->get('label.note').' | '; - if ($options['show_cost']) - $body .= ''.$i18n->get('label.cost').' | '; - if ($options['show_paid']) - $body .= ''.$i18n->get('label.paid').' | '; - if ($options['show_ip']) - $body .= ''.$i18n->get('label.ip').' | '; - if ($options['show_invoice']) - $body .= ''.$i18n->get('label.invoice').' | '; - $body .= '
'.$i18n->get('label.subtotal').' | '; - $subtotal_name = htmlspecialchars($subtotals[$prev_grouped_by]['name']); - if ($canViewReports || $isClient) $body .= ''.($group_by == 'user' ? $subtotal_name : '').' | '; - if ($options['show_client']) $body .= ''.($group_by == 'client' ? $subtotal_name : '').' | '; - if ($options['show_project']) $body .= ''.($group_by == 'project' ? $subtotal_name : '').' | '; - if ($options['show_task']) $body .= ''.($group_by == 'task' ? $subtotal_name : '').' | '; - if ($options['show_custom_field_1']) $body .= ''.($group_by == 'cf_1' ? $subtotal_name : '').' | '; - if ($options['show_start']) $body .= ''; - if ($options['show_end']) $body .= ' | '; - if ($options['show_duration']) $body .= ' | '.$subtotals[$prev_grouped_by]['time'].' | '; - if ($options['show_work_units']) $body .= ''.$subtotals[$prev_grouped_by]['units'].' | '; - if ($options['show_note']) $body .= ''; - if ($options['show_cost']) { - $body .= ' | '; - $body .= ($canViewReports || $isClient) ? $subtotals[$prev_grouped_by]['cost'] : $subtotals[$prev_grouped_by]['expenses']; - $body .= ' | '; - } - if ($options['show_paid']) $body .= ''; - if ($options['show_ip']) $body .= ' | '; - if ($options['show_invoice']) $body .= ' | '; - $body .= ' |
'.$record['date'].' | '; - if ($canViewReports || $isClient) - $body .= ''.htmlspecialchars($record['user']).' | '; - if ($options['show_client']) - $body .= ''.htmlspecialchars($record['client']).' | '; - if ($options['show_project']) - $body .= ''.htmlspecialchars($record['project']).' | '; - if ($options['show_task']) - $body .= ''.htmlspecialchars($record['task']).' | '; - if ($options['show_custom_field_1']) - $body .= ''.htmlspecialchars($record['cf_1']).' | '; - if ($options['show_start']) - $body .= ''.$record['start'].' | '; - if ($options['show_end']) - $body .= ''.$record['finish'].' | '; - if ($options['show_duration']) - $body .= ''.$record['duration'].' | '; - if ($options['show_work_units']) - $body .= ''.$record['units'].' | '; - if ($options['show_note']) - $body .= ''.htmlspecialchars($record['note']).' | '; - if ($options['show_cost']) - $body .= ''.$record['cost'].' | '; - if ($options['show_paid']) { - $body .= ''; - $body .= $record['paid'] == 1 ? $i18n->get('label.yes') : $i18n->get('label.no'); - $body .= ' | '; - } - if ($options['show_ip']) { - $body .= ''; - $body .= $record['modified'] ? $record['modified_ip'].' '.$record['modified'] : $record['created_ip'].' '.$record['created']; - $body .= ' | '; - } - if ($options['show_invoice']) - $body .= ''.htmlspecialchars($record['invoice']).' | '; - $body .= '
'.$i18n->get('label.subtotal').' | '; - $subtotal_name = htmlspecialchars($subtotals[$cur_grouped_by]['name']); - if ($canViewReports || $isClient) $body .= ''.($group_by == 'user' ? $subtotal_name : '').' | '; - if ($options['show_client']) $body .= ''.($group_by == 'client' ? $subtotal_name : '').' | '; - if ($options['show_project']) $body .= ''.($group_by == 'project' ? $subtotal_name : '').' | '; - if ($options['show_task']) $body .= ''.($group_by == 'task' ? $subtotal_name : '').' | '; - if ($options['show_custom_field_1']) $body .= ''.($group_by == 'cf_1' ? $subtotal_name : '').' | '; - if ($options['show_start']) $body .= ''; - if ($options['show_end']) $body .= ' | '; - if ($options['show_duration']) $body .= ' | '.$subtotals[$cur_grouped_by]['time'].' | '; - if ($options['show_work_units']) $body .= ''.$subtotals[$cur_grouped_by]['units'].' | '; - if ($options['show_note']) $body .= ''; - if ($options['show_cost']) { - $body .= ' | '; - $body .= ($canViewReports || $isClient) ? $subtotals[$cur_grouped_by]['cost'] : $subtotals[$cur_grouped_by]['expenses']; - $body .= ' | '; - } - if ($options['show_paid']) $body .= ''; - if ($options['show_ip']) $body .= ' | '; - if ($options['show_invoice']) $body .= ' | '; - $body .= ' |
'.$i18n->get('label.total').' | '; - if ($canViewReports || $isClient) $body .= ''; - if ($options['show_client']) $body .= ' | '; - if ($options['show_project']) $body .= ' | '; - if ($options['show_task']) $body .= ' | '; - if ($options['show_custom_field_1']) $body .= ' | '; - if ($options['show_start']) $body .= ' | '; - if ($options['show_end']) $body .= ' | '; - if ($options['show_duration']) $body .= ' | '.$totals['time'].' | '; - if ($options['show_work_units']) $body .= ''.$totals['units'].' | '; - if ($options['show_note']) $body .= ''; - if ($options['show_cost']) { - $body .= ' | '.htmlspecialchars($user->currency).' '; - $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses']; - $body .= ' | '; - } - if ($options['show_paid']) $body .= ''; - if ($options['show_ip']) $body .= ' | '; - if ($options['show_invoice']) $body .= ' | '; - $body .= ' |
'.$i18n->get('form.mail.footer').'
'; + case 'task': + $what_to_concat .= ", ' - ', 'Null'"; + $fields_part .= ', null as task'; + break; - // Finish creating email body. - $body .= ''; + case 'cf_1': + $what_to_concat .= ", ' - ', 'Null'"; + $fields_part .= ', null as cf_1'; + break; + } + switch ($group_by3) { + case 'date': + $what_to_concat .= ", ' - ', ei.date"; + break; + case 'user': + $what_to_concat .= ", ' - ', u.name"; + $fields_part .= ', u.name as user'; + break; + case 'client': + $what_to_concat .= ", ' - ', coalesce(c.name, 'Null')"; + $fields_part .= ', c.name as client'; + break; + case 'project': + $what_to_concat .= ", ' - ', coalesce(p.name, 'Null')"; + $fields_part .= ', p.name as project'; + break; - return $body; + case 'task': + $what_to_concat .= ", ' - ', 'Null'"; + $fields_part .= ', null as task'; + break; + + case 'cf_1': + $what_to_concat .= ", ' - ', 'Null'"; + $fields_part .= ', null as cf_1'; + break; + } + // Remove garbage from the beginning. + if ($what_to_concat) + $what_to_concat = substr($what_to_concat, 8); + $concat_part = "concat($what_to_concat) as group_field"; + return "$concat_part $fields_part"; } - // sendFavReport - sends a favorite report to a specified email, called from cron.php - static function sendFavReport($options, $subject, $email, $cc) { - // We are called from cron.php, we have no $bean in session. - // cron.php sets global $user and $i18n objects to match our favorite report user. - global $user; - global $i18n; + // makeCombinedSelectPart builds a list of fields for a combined select on a union for getSubtotals. + // This is used when we include expenses. + static function makeCombinedSelectPart($options) { + $group_by1 = $options['group_by1']; + $group_by2 = $options['group_by2']; + $group_by3 = $options['group_by3']; - // Prepare report body. - $body = ttReportHelper::prepareFavReportBody($options); + $fields = "group_field"; - import('mail.Mailer'); - $mailer = new Mailer(); - $mailer->setCharSet(CHARSET); - $mailer->setContentType('text/html'); - $mailer->setSender(SENDER); - if (!empty($cc)) - $mailer->setReceiverCC($cc); - if (!empty($user->bcc_email)) - $mailer->setReceiverBCC($user->bcc_email); - $mailer->setReceiver($email); - $mailer->setMailMode(MAIL_MODE); - if (empty($subject)) $subject = $options['name']; - if (!$mailer->send($subject, $body)) - return false; + switch ($group_by1) { + case 'user': + $fields .= ', user'; + break; + case 'client': + $fields_part .= ', client'; + break; + case 'project': + $fields .= ', project'; + break; - return true; + case 'task': + $fields .= ', task'; + break; + + case 'cf_1': + $fields .= ', cf_1'; + break; + } + switch ($group_by2) { + case 'user': + $fields .= ', user'; + break; + case 'client': + $fields_part .= ', client'; + break; + case 'project': + $fields .= ', project'; + break; + + case 'task': + $fields .= ', task'; + break; + + case 'cf_1': + $fields .= ', cf_1'; + break; + } + switch ($group_by3) { + case 'user': + $fields .= ', user'; + break; + case 'client': + $fields_part .= ', client'; + break; + case 'project': + $fields .= ', project'; + break; + + case 'task': + $fields .= ', task'; + break; + + case 'cf_1': + $fields .= ', cf_1'; + break; + } + return $fields; } - // getReportOptions - returns an array of report options constructed from session bean. - // - // Note: similarly to ttFavReportHelper::getReportOptions, this function is a part of - // refactoring to simplify maintenance of report generating functions, as we currently - // have 2 sets: normal reporting (from bean), and fav report emailing (from db fields). - // Using options obtained from either db or bean shall allow us to use only one set of functions. - static function getReportOptions($bean) { - global $user; + // makeJoinPart builds a left join part for getSubtotals query (for time items). + static function makeJoinPart($options) { + global $custom_fields; // TODO: is it safe to assume the object is there when needed? - // Prepare an array of report options. - $options = array(); + $group_by_fields = ttReportHelper::makeGroupByFieldsPart($options); // TODO: refactor this, perhaps? + if (strpos($group_by_fields, 'user') !== false) { + // Grouping by user, add a join on tt_users table. + $join .= ' left join tt_users u on (l.user_id = u.id)'; + } + if (strpos($group_by_fields, 'client') !== false) { + // Grouping by client, add a join on tt_clients table. + $join .= ' left join tt_clients c on (l.client_id = c.id)'; + } + if (strpos($group_by_fields, 'project') !== false) { + // Grouping by project, add a join on tt_projects table. + $join .= ' left join tt_projects p on (l.project_id = p.id)'; + } + if (strpos($group_by_fields, 'task') !== false) { + // Grouping by task, add a join on tt_tasks table. + $join .= ' left join tt_tasks t on (l.task_id = t.id)'; + } + if (strpos($group_by_fields, 'cf_1') !== false) { + // Grouping by custom field 1, add a join for it. + // $custom_fields = new CustomFields($user->group_id); + if ($custom_fields->fields[0]['type'] == CustomFields::TYPE_TEXT) + $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)'; + elseif ($custom_fields->fields[0]['type'] == CustomFields::TYPE_DROPDOWN) + $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)'; + } + return $join; + } - // Construct one by one. - $options['name'] = null; // No name required. - $options['user_id'] = $user->id; // Not sure if we need user_id here. Fav reports use it to recycle $user object in cron.php. - $options['client_id'] = $bean->getAttribute('client'); - $options['cf_1_option_id'] = $bean->getAttribute('option'); - $options['project_id'] = $bean->getAttribute('project'); - $options['task_id'] = $bean->getAttribute('task'); - $options['billable'] = $bean->getAttribute('include_records'); - $options['invoice'] = $bean->getAttribute('invoice'); - $options['paid_status'] = $bean->getAttribute('paid_status'); - if (is_array($bean->getAttribute('users'))) $options['users'] = join(',', $bean->getAttribute('users')); - $options['period'] = $bean->getAttribute('period'); - $options['period_start'] = $bean->getAttribute('start_date'); - $options['period_end'] = $bean->getAttribute('end_date'); - $options['show_client'] = $bean->getAttribute('chclient'); - $options['show_invoice'] = $bean->getAttribute('chinvoice'); - $options['show_paid'] = $bean->getAttribute('chpaid'); - $options['show_ip'] = $bean->getAttribute('chip'); - $options['show_project'] = $bean->getAttribute('chproject'); - $options['show_start'] = $bean->getAttribute('chstart'); - $options['show_duration'] = $bean->getAttribute('chduration'); - $options['show_cost'] = $bean->getAttribute('chcost'); - $options['show_task'] = $bean->getAttribute('chtask'); - $options['show_end'] = $bean->getAttribute('chfinish'); - $options['show_note'] = $bean->getAttribute('chnote'); - $options['show_custom_field_1'] = $bean->getAttribute('chcf_1'); - $options['show_work_units'] = $bean->getAttribute('chunits'); - $options['show_totals_only'] = $bean->getAttribute('chtotalsonly'); - $options['group_by'] = $bean->getAttribute('group_by'); - return $options; + // makeJoinExpensesPart builds a left join part for getSubtotals query for expense items. + static function makeJoinExpensesPart($options) { + $group_by_fields = ttReportHelper::makeGroupByFieldsPart($options); // TODO: refactor this, perhaps? + if (strpos($group_by_fields, 'user') !== false) { + // Grouping by user, add a join on tt_users table. + $join .= ' left join tt_users u on (ei.user_id = u.id)'; + } + if (strpos($group_by_fields, 'client') !== false) { + // Grouping by client, add a join on tt_clients table. + $join .= ' left join tt_clients c on (ei.client_id = c.id)'; + } + if (strpos($group_by_fields, 'project') !== false) { + // Grouping by project, add a join on tt_projects table. + $join .= ' left join tt_projects p on (ei.project_id = p.id)'; + } + return $join; + } + + // makeGroupByFieldsPart builds a commma-separated list of fields for sql query using group_by1, + // group_by2, and group_by3 values passed in $options. + static function makeGroupByFieldsPart($options) { + $no_grouping = ($options['group_by1'] == null || $options['group_by1'] == 'no_grouping') && + ($options['group_by2'] == null || $options['group_by2'] == 'no_grouping') && + ($options['group_by3'] == null || $options['group_by3'] == 'no_grouping'); + if ($no_grouping) return null; + + if ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') { + // We have group_by1. + $group_by_fields .= ', '.$options['group_by1']; + } + if ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') { + // We have group_by2. + $group_by_fields .= ', '.$options['group_by2']; + } + if ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') { + // We have group_by3. + $group_by_fields .= ', '.$options['group_by3']; + } + $group_by_fields = ltrim($group_by_fields, ', '); + return $group_by_fields; } - // verifyBean is a security function to make sure data in bean makes sense for a group. - static function verifyBean($bean) { - global $user; + // grouping determines if we are grouping the report by either group_by1, + // group_by2, or group_by3 values passed in $options. + static function grouping($options) { + $grouping = ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') || + ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') || + ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping'); + return $grouping; + } - // Check users. - $users_in_bean = $bean->getAttribute('users'); - if (is_array($users_in_bean)) { - $users_in_group = ttTeamHelper::getUsers(); - foreach ($users_in_group as $user_in_group) { - $valid_ids[] = $user_in_group['id']; + // groupingByUser determines if we are grouping a report by user. + static function groupingByUser($options) { + if ($options['group_by1'] == 'user' || $options['group_by2'] == 'user' || $options['group_by3'] == 'user') return true; + + return false; + } + + // groupingBy determines if we are grouping a report by a value of $what + // ('user', 'project', etc.) by checking group_by1, group_by2, and group_by3 + // values passed in $options. + static function groupingBy($what, $options) { + $grouping = ($options['group_by1'] != null && $options['group_by1'] != $what) || + ($options['group_by2'] != null && $options['group_by2'] != $what) || + ($options['group_by3'] != null && $options['group_by3'] != $what); + return $grouping; + } + + // makeGroupByHeader builds a column header for a totals-only report using group_by1, + // group_by2, and group_by3 values passed in $options. + static function makeGroupByHeader($options) { + global $i18n; + global $custom_fields; + + $no_grouping = ($options['group_by1'] == null || $options['group_by1'] == 'no_grouping') && + ($options['group_by2'] == null || $options['group_by2'] == 'no_grouping') && + ($options['group_by3'] == null || $options['group_by3'] == 'no_grouping'); + if ($no_grouping) return null; + + if ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') { + // We have group_by1. + $group_by1 = $options['group_by1']; + if ('cf_1' == $group_by1) + $group_by_header .= ' - '.$custom_fields->fields[0]['label']; + else { + $key = 'label.'.$group_by1; + $group_by_header .= ' - '.$i18n->get($key); } - foreach ($users_in_bean as $user_in_bean) { - if (!in_array($user_in_bean, $valid_ids)) { - return false; - } + } + if ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') { + // We have group_by2. + $group_by2 = $options['group_by2']; + if ('cf_1' == $group_by2) + $group_by_header .= ' - '.$custom_fields->fields[0]['label']; + else { + $key = 'label.'.$group_by2; + $group_by_header .= ' - '.$i18n->get($key); + } + } + if ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') { + // We have group_by3. + $group_by3 = $options['group_by3']; + if ('cf_1' == $group_by3) + $group_by_header .= ' - '.$custom_fields->fields[0]['label']; + else { + $key = 'label.'.$group_by3; + $group_by_header .= ' - '.$i18n->get($key); } } + $group_by_header = ltrim($group_by_header, ' -'); + return $group_by_header; + } - // TODO: add additional checks here. Perhaps do it before saving the bean for consistency. - return true; + // makeGroupByXmlTag creates an xml tag for a totals only report using group_by1, + // group_by2, and group_by3 values passed in $options. + static function makeGroupByXmlTag($options) { + if ($options['group_by1'] != null && $options['group_by1'] != 'no_grouping') { + // We have group_by1. + $tag .= '_'.$options['group_by1']; + } + if ($options['group_by2'] != null && $options['group_by2'] != 'no_grouping') { + // We have group_by2. + $tag .= '_'.$options['group_by2']; + } + if ($options['group_by3'] != null && $options['group_by3'] != 'no_grouping') { + // We have group_by3. + $tag .= '_'.$options['group_by3']; + } + $tag = ltrim($tag, '_'); + return $tag; + } + + // makeGroupByLabel builds a label for one row in a "Totals only" report of grouped by items. + // It does one thing: if we are grouping by date, the date format is converted for user. + static function makeGroupByLabel($key, $options) { + if (!ttReportHelper::groupingBy('date', $options)) + return $key; // No need to format. + + global $user; + if ($user->date_format == DB_DATEFORMAT) + return $key; // No need to format. + + $label = $key; + if (preg_match('/\d\d\d\d-\d\d-\d\d/', $key, $matches)) { + // Replace the first found match of a date in DB_DATEFORMAT. + // This is not entirely clean but better than nothing for a label in a row. + $userDate = ttDateToUserFormat($matches[0]); + $label = str_replace($matches[0], $userDate, $key); + } + return $label; } }