X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=WEB-INF%2Flib%2FttReportHelper.class.php;h=d46e783f758a12c822a032019d8312e7775ca609;hb=1c55e1b9d6da2173f7e946011908c02dd80df26d;hp=67f1da26326a0d0668ead26aad202c3afe28ddf0;hpb=45c855269d952873285f7a835e82fc2b3eff3971;p=timetracker.git diff --git a/WEB-INF/lib/ttReportHelper.class.php b/WEB-INF/lib/ttReportHelper.class.php index 67f1da26..d46e783f 100644 --- a/WEB-INF/lib/ttReportHelper.class.php +++ b/WEB-INF/lib/ttReportHelper.class.php @@ -37,44 +37,47 @@ require_once(dirname(__FILE__).'/../../plugins/CustomFields.class.php'); class ttReportHelper { // getWhere prepares a WHERE clause for a report query. - static function getWhere($bean) { + // Note: $options is a future replacement of $bean, which is work in progress. + static function getWhere($bean, $options) { global $user; // Prepare dropdown parts. $dropdown_parts = ''; - if ($bean->getAttribute('client')) - $dropdown_parts .= ' and l.client_id = '.$bean->getAttribute('client'); + if ($options['client_id']) + $dropdown_parts .= ' and l.client_id = '.$options['client_id']; elseif ($user->isClient() && $user->client_id) $dropdown_parts .= ' and l.client_id = '.$user->client_id; - if ($bean->getAttribute('option')) $dropdown_parts .= ' and l.id in(select log_id from tt_custom_field_log where status = 1 and option_id = '.$bean->getAttribute('option').')'; - if ($bean->getAttribute('project')) $dropdown_parts .= ' and l.project_id = '.$bean->getAttribute('project'); - if ($bean->getAttribute('task')) $dropdown_parts .= ' and l.task_id = '.$bean->getAttribute('task'); - if ($bean->getAttribute('include_records')=='1') $dropdown_parts .= ' and l.billable = 1'; - if ($bean->getAttribute('include_records')=='2') $dropdown_parts .= ' and l.billable = 0'; - if ($bean->getAttribute('invoice')=='1') $dropdown_parts .= ' and l.invoice_id is not NULL'; - if ($bean->getAttribute('invoice')=='2') $dropdown_parts .= ' and l.invoice_id is NULL'; - if ($bean->getAttribute('paid_status')=='1') $dropdown_parts .= ' and l.paid = 1'; - if ($bean->getAttribute('paid_status')=='2') $dropdown_parts .= ' and l.paid = 0'; + 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'].')'; + if ($options['project_id']) $dropdown_parts .= ' and l.project_id = '.$options['project_id']; + if ($options['task_id']) $dropdown_parts .= ' and l.task_id = '.$options['task_id']; + if ($options['billable']=='1') $dropdown_parts .= ' and l.billable = 1'; + if ($options['billable']=='2') $dropdown_parts .= ' and l.billable = 0'; + if ($options['invoice']=='1') $dropdown_parts .= ' and l.invoice_id is not NULL'; + if ($options['invoice']=='2') $dropdown_parts .= ' and l.invoice_id is NULL'; + if ($options['paid_status']=='1') $dropdown_parts .= ' and l.paid = 1'; + if ($options['paid_status']=='2') $dropdown_parts .= ' and l.paid = 0'; + + // Note: "Prepare sql query part for user list" is different in getFavWhere because of + // special meaning of NULL value (all "active" users). + // + // If we are merging into one function, one needs to take care of this, perhaps, with redesign. - // Prepare user list part. - $userlist = -1; - if (($user->can('view_reports') || $user->isClient()) && is_array($bean->getAttribute('users'))) - $userlist = join(',', $bean->getAttribute('users')); // Prepare sql query part for user list. - $user_list_part = null; - if ($user->can('view_reports') || $user->isClient()) + $userlist = $options['users'] ? $options['users'] : '-1'; + if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient()) $user_list_part = " and l.user_id in ($userlist)"; else $user_list_part = " and l.user_id = ".$user->id; + $user_list_part .= " and l.group_id = ".$user->getActiveGroup(); // Prepare sql query part for where. - if ($bean->getAttribute('period')) - $period = new Period($bean->getAttribute('period'), new DateAndTime($user->date_format)); + if ($options['period']) + $period = new Period($options['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'))); + new DateAndTime($user->date_format, $options['period_start']), + new DateAndTime($user->date_format, $options['period_end'])); } $where = " where l.status = 1 and l.date >= '".$period->getStartDate(DB_DATEFORMAT)."' and l.date <= '".$period->getEndDate(DB_DATEFORMAT)."'". " $user_list_part $dropdown_parts"; @@ -82,52 +85,52 @@ class ttReportHelper { } // getFavWhere prepares a WHERE clause for a favorite report query. - static function getFavWhere($report) { + static function getFavWhere($options) { global $user; // Prepare dropdown parts. $dropdown_parts = ''; - if ($report['client_id']) - $dropdown_parts .= ' and l.client_id = '.$report['client_id']; + if ($options['client_id']) + $dropdown_parts .= ' and l.client_id = '.$options['client_id']; elseif ($user->isClient() && $user->client_id) $dropdown_parts .= ' and l.client_id = '.$user->client_id; - if ($report['cf_1_option_id']) $dropdown_parts .= ' and l.id in(select log_id from tt_custom_field_log where status = 1 and option_id = '.$report['cf_1_option_id'].')'; - if ($report['project_id']) $dropdown_parts .= ' and l.project_id = '.$report['project_id']; - if ($report['task_id']) $dropdown_parts .= ' and l.task_id = '.$report['task_id']; - if ($report['billable']=='1') $dropdown_parts .= ' and l.billable = 1'; - if ($report['billable']=='2') $dropdown_parts .= ' and l.billable = 0'; - if ($report['invoice']=='1') $dropdown_parts .= ' and l.invoice_id is not NULL'; - if ($report['invoice']=='2') $dropdown_parts .= ' and l.invoice_id is NULL'; - if ($report['paid_status']=='1') $dropdown_parts .= ' and l.paid = 1'; - if ($report['paid_status']=='2') $dropdown_parts .= ' and l.paid = 0'; + 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'].')'; + if ($options['project_id']) $dropdown_parts .= ' and l.project_id = '.$options['project_id']; + if ($options['task_id']) $dropdown_parts .= ' and l.task_id = '.$options['task_id']; + if ($options['billable']=='1') $dropdown_parts .= ' and l.billable = 1'; + if ($options['billable']=='2') $dropdown_parts .= ' and l.billable = 0'; + if ($options['invoice']=='1') $dropdown_parts .= ' and l.invoice_id is not NULL'; + if ($options['invoice']=='2') $dropdown_parts .= ' and l.invoice_id is NULL'; + if ($options['paid_status']=='1') $dropdown_parts .= ' and l.paid = 1'; + if ($options['paid_status']=='2') $dropdown_parts .= ' and l.paid = 0'; // Prepare user list part. $userlist = -1; - if (($user->can('view_reports') || $user->isClient())) { - if ($report['users']) - $userlist = $report['users']; + if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient()) { + if ($options['users']) + $userlist = $options['users']; else { - $active_users = ttTeamHelper::getActiveUsers(); - foreach ($active_users as $single_user) + $group_users = ttTeamHelper::getUsers(); // active and inactive users + foreach ($group_users as $single_user) $users[] = $single_user['id']; $userlist = join(',', $users); } } // Prepare sql query part for user list. - $user_list_part = null; - if ($user->can('view_reports') || $user->isClient()) + if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient()) $user_list_part = " and l.user_id in ($userlist)"; else $user_list_part = " and l.user_id = ".$user->id; + $user_list_part .= " and l.group_id = ".$user->getActiveGroup(); // Prepare sql query part for where. - if ($report['period']) - $period = new Period($report['period'], new DateAndTime($user->date_format)); + if ($options['period']) + $period = new Period($options['period'], new DateAndTime($user->date_format)); else { $period = new Period(); $period->setPeriod( - new DateAndTime($user->date_format, $report['period_start']), - new DateAndTime($user->date_format, $report['period_end'])); + new DateAndTime($user->date_format, $options['period_start']), + new DateAndTime($user->date_format, $options['period_end'])); } $where = " where l.status = 1 and l.date >= '".$period->getStartDate(DB_DATEFORMAT)."' and l.date <= '".$period->getEndDate(DB_DATEFORMAT)."'". " $user_list_part $dropdown_parts"; @@ -135,40 +138,37 @@ class ttReportHelper { } // getExpenseWhere prepares WHERE clause for expenses query in a report. - static function getExpenseWhere($bean) { + static function getExpenseWhere($bean, $options) { global $user; // Prepare dropdown parts. $dropdown_parts = ''; - if ($bean->getAttribute('client')) - $dropdown_parts .= ' and ei.client_id = '.$bean->getAttribute('client'); + if ($options['client_id']) + $dropdown_parts .= ' and l.client_id = '.$options['client_id']; elseif ($user->isClient() && $user->client_id) $dropdown_parts .= ' and ei.client_id = '.$user->client_id; - if ($bean->getAttribute('project')) $dropdown_parts .= ' and ei.project_id = '.$bean->getAttribute('project'); - if ($bean->getAttribute('invoice')=='1') $dropdown_parts .= ' and ei.invoice_id is not NULL'; - if ($bean->getAttribute('invoice')=='2') $dropdown_parts .= ' and ei.invoice_id is NULL'; - if ($bean->getAttribute('paid_status')=='1') $dropdown_parts .= ' and ei.paid = 1'; - if ($bean->getAttribute('paid_status')=='2') $dropdown_parts .= ' and ei.paid = 0'; + if ($options['project_id']) $dropdown_parts .= ' and ei.project_id = '.$options['project_id']; + if ($options['invoice']=='1') $dropdown_parts .= ' and ei.invoice_id is not NULL'; + if ($options['invoice']=='2') $dropdown_parts .= ' and ei.invoice_id is NULL'; + if ($options['paid_status']=='1') $dropdown_parts .= ' and ei.paid = 1'; + if ($options['paid_status']=='2') $dropdown_parts .= ' and ei.paid = 0'; - // Prepare user list part. - $userlist = -1; - if (($user->can('view_reports') || $user->isClient()) && is_array($bean->getAttribute('users'))) - $userlist = join(',', $bean->getAttribute('users')); // Prepare sql query part for user list. - $user_list_part = null; - if ($user->can('view_reports') || $user->isClient()) + $userlist = $options['users'] ? $options['users'] : '-1'; + if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient()) $user_list_part = " and ei.user_id in ($userlist)"; else $user_list_part = " and ei.user_id = ".$user->id; + $user_list_part .= " and ei.group_id = ".$user->getActiveGroup(); // Prepare sql query part for where. - if ($bean->getAttribute('period')) - $period = new Period($bean->getAttribute('period'), new DateAndTime($user->date_format)); + if ($options['period']) + $period = new Period($options['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'))); + new DateAndTime($user->date_format, $options['period_start']), + new DateAndTime($user->date_format, $options['period_end'])); } $where = " where ei.status = 1 and ei.date >= '".$period->getStartDate(DB_DATEFORMAT)."' and ei.date <= '".$period->getEndDate(DB_DATEFORMAT)."'". " $user_list_part $dropdown_parts"; @@ -176,26 +176,26 @@ class ttReportHelper { } // getFavExpenseWhere prepares a WHERE clause for expenses query in a favorite report. - static function getFavExpenseWhere($report) { + static function getFavExpenseWhere($options) { global $user; // Prepare dropdown parts. $dropdown_parts = ''; - if ($report['client_id']) - $dropdown_parts .= ' and ei.client_id = '.$report['client_id']; + if ($options['client_id']) + $dropdown_parts .= ' and ei.client_id = '.$options['client_id']; elseif ($user->isClient() && $user->client_id) $dropdown_parts .= ' and ei.client_id = '.$user->client_id; - if ($report['project_id']) $dropdown_parts .= ' and ei.project_id = '.$report['project_id']; - if ($report['invoice']=='1') $dropdown_parts .= ' and ei.invoice_id is not NULL'; - if ($report['invoice']=='2') $dropdown_parts .= ' and ei.invoice_id is NULL'; - if ($report['paid_status']=='1') $dropdown_parts .= ' and ei.paid = 1'; - if ($report['paid_status']=='2') $dropdown_parts .= ' and ei.paid = 0'; + if ($options['project_id']) $dropdown_parts .= ' and ei.project_id = '.$options['project_id']; + if ($options['invoice']=='1') $dropdown_parts .= ' and ei.invoice_id is not NULL'; + if ($options['invoice']=='2') $dropdown_parts .= ' and ei.invoice_id is NULL'; + if ($options['paid_status']=='1') $dropdown_parts .= ' and ei.paid = 1'; + if ($options['paid_status']=='2') $dropdown_parts .= ' and ei.paid = 0'; // Prepare user list part. $userlist = -1; if (($user->can('view_reports') || $user->isClient())) { - if ($report['users']) - $userlist = $report['users']; + if ($options['users']) + $userlist = $options['users']; else { $active_users = ttTeamHelper::getActiveUsers(); foreach ($active_users as $single_user) @@ -204,20 +204,20 @@ class ttReportHelper { } } // Prepare sql query part for user list. - $user_list_part = null; - if ($user->can('view_reports') || $user->isClient()) + if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient()) $user_list_part = " and ei.user_id in ($userlist)"; else $user_list_part = " and ei.user_id = ".$user->id; + $user_list_part .= " and ei.group_id = ".$user->getActiveGroup(); // Prepare sql query part for where. - if ($report['period']) - $period = new Period($report['period'], new DateAndTime($user->date_format)); + if ($options['period']) + $period = new Period($options['period'], new DateAndTime($user->date_format)); else { $period = new Period(); $period->setPeriod( - new DateAndTime($user->date_format, $report['period_start']), - new DateAndTime($user->date_format, $report['period_end'])); + new DateAndTime($user->date_format, $options['period_start']), + new DateAndTime($user->date_format, $options['period_end'])); } $where = " where ei.status = 1 and ei.date >= '".$period->getStartDate(DB_DATEFORMAT)."' and ei.date <= '".$period->getEndDate(DB_DATEFORMAT)."'". " $user_list_part $dropdown_parts"; @@ -227,7 +227,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) { + static function getItems($bean, $options) { global $user; $mdb2 = getConnection(); @@ -276,6 +276,13 @@ class ttReportHelper { // Add duration. if ($bean->getAttribute('chduration')) array_push($fields, "TIME_FORMAT(l.duration, '%k:%i') as duration"); + // Add work units. + if ($bean->getAttribute('chunits')) { + 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 ($bean->getAttribute('chnote')) array_push($fields, 'l.comment as note'); @@ -326,7 +333,7 @@ class ttReportHelper { 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($bean); + $where = ttReportHelper::getWhere($bean, $options); // Construct sql query for tt_log items. $sql = "select ".join(', ', $fields)." from tt_log l $left_joins $where"; @@ -360,6 +367,9 @@ class ttReportHelper { array_push($fields, 'null'); // null for finish. if ($bean->getAttribute('chduration')) array_push($fields, 'null'); // null for duration. + // Add work units. + if ($bean->getAttribute('chunits')) + array_push($fields, 'null as units'); // null for work units. // Use the note field to print item name. if ($bean->getAttribute('chnote')) array_push($fields, 'ei.name as note'); @@ -391,7 +401,7 @@ class ttReportHelper { if (($canViewReports || $isClient) && $bean->getAttribute('chinvoice')) $left_joins .= " left join tt_invoices i on (i.id = ei.invoice_id and i.status = 1)"; - $where = ttReportHelper::getExpenseWhere($bean); + $where = ttReportHelper::getExpenseWhere($bean, $options); // Construct sql query for expense items. $sql_for_expense_items = "select ".join(', ', $fields)." from tt_expense_items ei $left_joins $where"; @@ -492,7 +502,7 @@ class ttReportHelper { // 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($report) { + static function getFavItems($options) { global $user; $mdb2 = getConnection(); @@ -500,8 +510,8 @@ class ttReportHelper { $canViewReports = $user->can('view_reports'); $isClient = $user->isClient(); - $group_by_option = $report['group_by']; - $convertTo12Hour = ('%I:%M %p' == $user->time_format) && ($report['show_start'] || $report['show_end']); + $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. @@ -511,16 +521,16 @@ class ttReportHelper { if($canViewReports || $isClient) array_push($fields, 'u.name as user'); // Add client name if it is selected. - if ($report['show_client'] || 'client' == $group_by_option) + if ($options['show_client'] || 'client' == $group_by_option) array_push($fields, 'c.name as client'); // Add project name if it is selected. - if ($report['show_project'] || 'project' == $group_by_option) + if ($options['show_project'] || 'project' == $group_by_option) array_push($fields, 'p.name as project'); // Add task name if it is selected. - if ($report['show_task'] || 'task' == $group_by_option) + if ($options['show_task'] || 'task' == $group_by_option) array_push($fields, 't.name as task'); // Add custom field. - $include_cf_1 = $report['show_custom_field_1'] || 'cf_1' == $group_by_option; + $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']; @@ -531,21 +541,29 @@ class ttReportHelper { } } // Add start time. - if ($report['show_start']) { + 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 ($report['show_end']) + 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 ($report['show_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 ($report['show_note']) + if ($options['show_note']) array_push($fields, 'l.comment as note'); // Handle cost. - $includeCost = $report['show_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. @@ -554,30 +572,30 @@ class ttReportHelper { array_push($fields, "null as expense"); } // Add paid status. - if ($canViewReports && $report['show_paid']) + if ($canViewReports && $options['show_paid']) array_push($fields, 'l.paid as paid'); // Add IP address. - if ($canViewReports && $report['show_ip']) { + 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) && $report['show_invoice']) + if (($canViewReports || $isClient) && $options['show_invoice']) array_push($fields, 'i.name as invoice'); // Prepare sql query part for left joins. $left_joins = null; - if ($report['show_client'] || 'client' == $group_by_option) + if ($options['show_client'] || 'client' == $group_by_option) $left_joins .= " left join tt_clients c on (c.id = l.client_id)"; - if (($canViewReports || $isClient) && $report['show_invoice']) + 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 ($report['show_project'] || 'project' == $group_by_option) + if ($options['show_project'] || 'project' == $group_by_option) $left_joins .= " left join tt_projects p on (p.id = l.project_id)"; - if ($report['show_task'] || 'task' == $group_by_option) + 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) @@ -590,7 +608,7 @@ class ttReportHelper { 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::getFavWhere($report); + $where = ttReportHelper::getFavWhere($options); // Construct sql query for tt_log items. $sql = "select ".join(', ', $fields)." from tt_log l $left_joins $where"; @@ -598,7 +616,7 @@ class ttReportHelper { // 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 ($report['show_cost'] && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled + 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'); @@ -607,54 +625,56 @@ class ttReportHelper { if($canViewReports || $isClient) array_push($fields, 'u.name as user'); // Add client name if it is selected. - if ($report['show_client'] || 'client' == $group_by_option) + if ($options['show_client'] || 'client' == $group_by_option) array_push($fields, 'c.name as client'); // Add project name if it is selected. - if ($report['show_project'] || 'project' == $group_by_option) + if ($options['show_project'] || 'project' == $group_by_option) array_push($fields, 'p.name as project'); - if ($report['show_task'] || 'task' == $group_by_option) + 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 ($report['show_custom_field_1'] || 'cf_1' == $group_by_option) + if ($options['show_custom_field_1'] || 'cf_1' == $group_by_option) array_push($fields, 'null'); // null for cf_1. - if ($report['show_start']) { + if ($options['show_start']) { array_push($fields, 'null'); // null for unformatted_start. array_push($fields, 'null'); // null for start. } - if ($report['show_end']) + if ($options['show_end']) array_push($fields, 'null'); // null for finish. - if ($report['show_duration']) + 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 ($report['show_note']) + 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 && $report['show_paid']) + if ($canViewReports && $options['show_paid']) array_push($fields, 'ei.paid as paid'); // Add IP address. - if ($canViewReports && $report['show_ip']) { + 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) && $report['show_invoice']) + 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 ($report['show_client'] || 'client' == $group_by_option) + if ($options['show_client'] || 'client' == $group_by_option) $left_joins .= " left join tt_clients c on (c.id = ei.client_id)"; - if ($report['show_project'] || 'project' == $group_by_option) + if ($options['show_project'] || 'project' == $group_by_option) $left_joins .= " left join tt_projects p on (p.id = ei.project_id)"; - if (($canViewReports || $isClient) && $report['show_invoice']) + 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::getFavExpenseWhere($report); + $where = ttReportHelper::getFavExpenseWhere($options); // Construct sql query for expense items. $sql_for_expense_items = "select ".join(', ', $fields)." from tt_expense_items ei $left_joins $where"; @@ -671,7 +691,7 @@ class ttReportHelper { $sort_part .= $group_by_option.', date'; if (($canViewReports || $isClient) /*&& is_array($bean->getAttribute('users'))*/ && 'user' != $group_by_option) $sort_part .= ', user, type'; - if ($report['show_start']) + if ($options['show_start']) $sort_part .= ', unformatted_start'; $sort_part .= ', id'; @@ -722,7 +742,7 @@ class ttReportHelper { // 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) { + static function getSubtotals($bean, $options) { global $user; $group_by_option = $bean->getAttribute('group_by'); @@ -764,26 +784,45 @@ class ttReportHelper { break; } - $where = ttReportHelper::getWhere($bean); + $where = ttReportHelper::getWhere($bean, $options); if ($bean->getAttribute('chcost')) { 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, - sum(cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10, 2))) as cost, + $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time"; + if ($bean->getAttribute('chunits')) { + 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(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, - sum(cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost, + $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time"; + if ($bean->getAttribute('chunits')) { + 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, null as expenses from tt_log l - $group_join $where group by $group_field"; + $sql = "select $group_field as group_field, sum(time_to_sec(l.duration)) as time"; + if ($bean->getAttribute('chunits')) { + 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. @@ -812,14 +851,18 @@ class ttReportHelper { break; } - $where = ttReportHelper::getExpenseWhere($bean); - $sql_for_expenses = "select $group_field as group_field, null as time, sum(ei.cost) as cost, sum(ei.cost) as expenses from tt_expense_items ei - $group_join $where"; + $where = ttReportHelper::getExpenseWhere($bean, $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"; // Create a combined query. - $sql = "select group_field, sum(time) as time, sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t group by group_field"; + $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"; + $sql = $combined; } // Execute query. @@ -839,9 +882,9 @@ class ttReportHelper { $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,'cost'=>$val['cost'],'expenses'=>$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); + $subtotals[$val['group_field']] = array('name'=>$val['group_field'],'time'=>$time, 'units'=> $val['units']); } return $subtotals; @@ -850,10 +893,10 @@ class ttReportHelper { // 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($report) { + static function getFavSubtotals($options) { global $user; - $group_by_option = $report['group_by']; + $group_by_option = $options['group_by']; if ('no_grouping' == $group_by_option) return null; $mdb2 = getConnection(); @@ -892,31 +935,51 @@ class ttReportHelper { break; } - $where = ttReportHelper::getFavWhere($report); - if ($report['show_cost']) { + $where = ttReportHelper::getFavWhere($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, - sum(cast(l.billable * coalesce(u.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10, 2))) as cost, + $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, - sum(cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10,2))) as cost, + $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, null as expenses from tt_log l - $group_join $where group by $group_field"; + $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 ($report['show_cost'] && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled + if ($options['show_cost'] && $user->isPluginEnabled('ex')) { // if ex(penses) plugin is enabled // Determine group by field and a required join. $group_join = null; @@ -940,14 +1003,18 @@ class ttReportHelper { break; } - $where = ttReportHelper::getFavExpenseWhere($report); - $sql_for_expenses = "select $group_field as group_field, null as time, sum(ei.cost) as cost, sum(ei.cost) as expenses from tt_expense_items ei - $group_join $where"; + $where = ttReportHelper::getFavExpenseWhere($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. - $sql = "select group_field, sum(time) as time, sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t group by group_field"; + $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. @@ -962,52 +1029,63 @@ class ttReportHelper { unset($o_date); } $time = $val['time'] ? sec_to_time_fmt_hm($val['time']) : null; - if ($report['show_cost']) { + 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,'cost'=>$val['cost'],'expenses'=>$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); + $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) + static function getTotals($bean, $options) { global $user; $mdb2 = getConnection(); - $where = ttReportHelper::getWhere($bean); + $where = ttReportHelper::getWhere($bean, $options); - // Start with a query for time items. + // 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) { - $sql = "select sum(time_to_sec(l.duration)) as time, - 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 - left join tt_users u on (l.user_id = u.id) $where"; + $left_joins = "left join tt_users u on (l.user_id = u.id)"; } else { - $sql = "select sum(time_to_sec(l.duration)) as time, - 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 - left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id) $where"; + $left_joins = "left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)"; } - } else - $sql = "select sum(time_to_sec(l.duration)) as time, null as cost, null as expenses from tt_log l $where"; + } + // 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($bean); - $sql_for_expenses = "select null as time, sum(cost) as cost, sum(cost) as expenses from tt_expense_items ei $where"; + $where = ttReportHelper::getExpenseWhere($bean, $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. - $sql = "select sum(time) as time, sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t"; + $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. @@ -1039,6 +1117,7 @@ class ttReportHelper { $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; @@ -1046,38 +1125,49 @@ class ttReportHelper { } // getFavTotals calculates total hours and cost for all favorite report items. - static function getFavTotals($report) + static function getFavTotals($options) { global $user; $mdb2 = getConnection(); - $where = ttReportHelper::getFavWhere($report); + $where = ttReportHelper::getFavWhere($options); - // Start with a query for time items. - if ($report['show_cost']) { + // Prepare parts. + $time_part = "sum(time_to_sec(l.duration)) as time"; + if ($options['show_work_units']) { + $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 ($options['show_cost']) { + 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 ($options['show_cost']) { if (MODE_TIME == $user->tracking_mode) { - $sql = "select sum(time_to_sec(l.duration)) as time, - 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 - left join tt_users u on (l.user_id = u.id) $where"; + $left_joins = "left join tt_users u on (l.user_id = u.id)"; } else { - $sql = "select sum(time_to_sec(l.duration)) as time, - 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 - left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id) $where"; + $left_joins = "left join tt_user_project_binds upb on (l.user_id = upb.user_id and l.project_id = upb.project_id)"; } - } else - $sql = "select sum(time_to_sec(l.duration)) as time, null as cost, null as expenses from tt_log l $where"; + } + // 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 ($report['show_cost'] && $user->isPluginEnabled('ex')) { - $where = ttReportHelper::getFavExpenseWhere($report); - $sql_for_expenses = "select null as time, sum(cost) as cost, sum(cost) as expenses from tt_expense_items ei $where"; + if ($options['show_cost'] && $user->isPluginEnabled('ex')) { + $where = ttReportHelper::getFavExpenseWhere($options); + $sql_for_expenses = "select null as time"; + if ($options['show_work_units']) $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. - $sql = "select sum(time) as time, sum(cost) as cost, sum(expenses) as expenses from (($sql) union all ($sql_for_expenses)) t"; + $combined = "select 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"; + $sql = $combined; } // Execute query. @@ -1086,7 +1176,7 @@ class ttReportHelper { $val = $res->fetchRow(); $total_time = $val['time'] ? sec_to_time_fmt_hm($val['time']) : null; - if ($report['show_cost']) { + if ($options['show_cost']) { $total_cost = $val['cost']; if (!$total_cost) $total_cost = '0.00'; if ('.' != $user->decimal_mark) @@ -1097,18 +1187,19 @@ class ttReportHelper { $total_expenses = str_replace('.', $user->decimal_mark, $total_expenses); } - if ($report['period']) - $period = new Period($report['period'], new DateAndTime($user->date_format)); + if ($options['period']) + $period = new Period($options['period'], new DateAndTime($user->date_format)); else { $period = new Period(); $period->setPeriod( - new DateAndTime($user->date_format, $report['period_start']), - new DateAndTime($user->date_format, $report['period_end'])); + new DateAndTime($user->date_format, $options['period_start']), + new DateAndTime($user->date_format, $options['period_end'])); } $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; @@ -1159,12 +1250,13 @@ class ttReportHelper { // Determine these once as they are used in multiple places in this function. $canViewReports = $user->can('view_reports'); $isClient = $user->isClient(); + $options = ttReportHelper::getReportOptions($bean); - $items = ttReportHelper::getItems($bean); + $items = ttReportHelper::getItems($bean, $options); $group_by = $bean->getAttribute('group_by'); if ($group_by && 'no_grouping' != $group_by) - $subtotals = ttReportHelper::getSubtotals($bean); - $totals = ttReportHelper::getTotals($bean); + $subtotals = ttReportHelper::getSubtotals($bean, $options); + $totals = ttReportHelper::getTotals($bean, $options); // Use custom fields plugin if it is enabled. if ($user->isPluginEnabled('cf')) @@ -1209,6 +1301,8 @@ class ttReportHelper { $body .= ''.$group_by_header.''; if ($bean->getAttribute('chduration')) $body .= ''.$i18n->get('label.duration').''; + if ($bean->getAttribute('chunits')) + $body .= ''.$i18n->get('label.work_units_short').''; if ($bean->getAttribute('chcost')) $body .= ''.$i18n->get('label.cost').''; $body .= ''; @@ -1220,6 +1314,11 @@ class ttReportHelper { if ($subtotal['time'] <> '0:00') $body .= $subtotal['time']; $body .= ''; } + if ($bean->getAttribute('chunits')) { + $body .= ''; + $body .= $subtotal['units']; + $body .= ''; + } if ($bean->getAttribute('chcost')) { $body .= ''; $body .= ($canViewReports || $isClient) ? $subtotal['cost'] : $subtotal['expenses']; @@ -1237,6 +1336,11 @@ class ttReportHelper { if ($totals['time'] <> '0:00') $body .= $totals['time']; $body .= ''; } + if ($bean->getAttribute('chunits')) { + $body .= ''; + $body .= $totals['units']; + $body .= ''; + } if ($bean->getAttribute('chcost')) { $body .= ''.htmlspecialchars($user->currency).' '; $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses']; @@ -1268,6 +1372,8 @@ class ttReportHelper { $body .= ''.$i18n->get('label.finish').''; if ($bean->getAttribute('chduration')) $body .= ''.$i18n->get('label.duration').''; + if ($bean->getAttribute('chunits')) + $body .= ''.$i18n->get('label.work_units_short').''; if ($bean->getAttribute('chnote')) $body .= ''.$i18n->get('label.note').''; if ($bean->getAttribute('chcost')) @@ -1311,6 +1417,7 @@ class ttReportHelper { 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')) { $body .= ''; @@ -1347,6 +1454,8 @@ class ttReportHelper { $body .= ''.$record['finish'].''; if ($bean->getAttribute('chduration')) $body .= ''.$record['duration'].''; + if ($bean->getAttribute('chunits')) + $body .= ''.$record['units'].''; if ($bean->getAttribute('chnote')) $body .= ''.htmlspecialchars($record['note']).''; if ($bean->getAttribute('chcost')) @@ -1384,6 +1493,7 @@ class ttReportHelper { 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')) { $body .= ''; @@ -1408,6 +1518,7 @@ class ttReportHelper { 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')) { $body .= ''.htmlspecialchars($user->currency).' '; @@ -1433,9 +1544,9 @@ class ttReportHelper { } // checkFavReportCondition - checks whether it is okay to send fav report. - static function checkFavReportCondition($report, $condition) + static function checkFavReportCondition($options, $condition) { - $items = ttReportHelper::getFavItems($report); + $items = ttReportHelper::getFavItems($options); $condition = str_replace('count', '', $condition); $count_required = (int) trim(str_replace('>', '', $condition)); @@ -1447,7 +1558,7 @@ class ttReportHelper { } // prepareFavReportBody - prepares an email body for a favorite report. - static function prepareFavReportBody($report) + static function prepareFavReportBody($options) { global $user; global $i18n; @@ -1456,11 +1567,11 @@ class ttReportHelper { $canViewReports = $user->can('view_reports'); $isClient = $user->isClient(); - $items = ttReportHelper::getFavItems($report); - $group_by = $report['group_by']; + $items = ttReportHelper::getFavItems($options); + $group_by = $options['group_by']; if ($group_by && 'no_grouping' != $group_by) - $subtotals = ttReportHelper::getFavSubtotals($report); - $totals = ttReportHelper::getFavTotals($report); + $subtotals = ttReportHelper::getFavSubtotals($options); + $totals = ttReportHelper::getFavTotals($options); // Use custom fields plugin if it is enabled. if ($user->isPluginEnabled('cf')) @@ -1489,7 +1600,7 @@ class ttReportHelper { // Output comment. // if ($comment) $body .= '

'.htmlspecialchars($comment).'

'; // No comment for fav. reports. - if ($report['show_totals_only']) { + if ($options['show_totals_only']) { // Totals only report. Output subtotals. // Determine group_by header. @@ -1503,20 +1614,27 @@ class ttReportHelper { $body .= ''; $body .= ''; $body .= ''; - if ($report['show_duration']) + if ($options['show_duration']) $body .= ''; - if ($report['show_cost']) + if ($options['show_work_units']) + $body .= ''; + if ($options['show_cost']) $body .= ''; $body .= ''; foreach($subtotals as $subtotal) { $body .= ''; $body .= ''; - if ($report['show_duration']) { + if ($options['show_duration']) { $body .= ''; } - if ($report['show_cost']) { + if ($options['show_work_units']) { + $body .= ''; + } + if ($options['show_cost']) { $body .= ''; @@ -1528,12 +1646,17 @@ class ttReportHelper { $body .= ''; $body .= ''; $body .= ''; - if ($report['show_duration']) { + if ($options['show_duration']) { $body .= ''; } - if ($report['show_cost']) { + if ($options['show_work_units']) { + $body .= ''; + } + if ($options['show_cost']) { $body .= ''; @@ -1550,29 +1673,31 @@ class ttReportHelper { $body .= ''; if ($canViewReports || $isClient) $body .= ''; - if ($report['show_client']) + if ($options['show_client']) $body .= ''; - if ($report['show_project']) + if ($options['show_project']) $body .= ''; - if ($report['show_task']) + if ($options['show_task']) $body .= ''; - if ($report['show_custom_field_1']) + if ($options['show_custom_field_1']) $body .= ''; - if ($report['show_start']) + if ($options['show_start']) $body .= ''; - if ($report['show_end']) + if ($options['show_end']) $body .= ''; - if ($report['show_duration']) + if ($options['show_duration']) $body .= ''; - if ($report['show_note']) + if ($options['show_work_units']) + $body .= ''; + if ($options['show_note']) $body .= ''; - if ($report['show_cost']) + if ($options['show_cost']) $body .= ''; - if ($report['show_paid']) + if ($options['show_paid']) $body .= ''; - if ($report['show_ip']) + if ($options['show_ip']) $body .= ''; - if ($report['show_invoice']) + if ($options['show_invoice']) $body .= ''; $body .= ''; @@ -1600,22 +1725,23 @@ class ttReportHelper { $body .= ''; $subtotal_name = htmlspecialchars($subtotals[$prev_grouped_by]['name']); if ($canViewReports || $isClient) $body .= ''; - if ($report['show_client']) $body .= ''; - if ($report['show_project']) $body .= ''; - if ($report['show_task']) $body .= ''; - if ($report['show_custom_field_1']) $body .= ''; - if ($report['show_start']) $body .= ''; - if ($report['show_end']) $body .= ''; - if ($report['show_duration']) $body .= ''; - if ($report['show_note']) $body .= ''; - if ($report['show_cost']) { + 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 .= ''; + if ($options['show_work_units']) $body .= ''; + if ($options['show_note']) $body .= ''; + if ($options['show_cost']) { $body .= ''; } - if ($report['show_paid']) $body .= ''; - if ($report['show_ip']) $body .= ''; - if ($report['show_invoice']) $body .= ''; + if ($options['show_paid']) $body .= ''; + if ($options['show_ip']) $body .= ''; + if ($options['show_invoice']) $body .= ''; $body .= ''; $body .= ''; } @@ -1629,35 +1755,37 @@ class ttReportHelper { $body .= ''; if ($canViewReports || $isClient) $body .= ''; - if ($report['show_client']) + if ($options['show_client']) $body .= ''; - if ($report['show_project']) + if ($options['show_project']) $body .= ''; - if ($report['show_task']) + if ($options['show_task']) $body .= ''; - if ($report['show_custom_field_1']) + if ($options['show_custom_field_1']) $body .= ''; - if ($report['show_start']) + if ($options['show_start']) $body .= ''; - if ($report['show_end']) + if ($options['show_end']) $body .= ''; - if ($report['show_duration']) + if ($options['show_duration']) $body .= ''; - if ($report['show_note']) + if ($options['show_work_units']) + $body .= ''; + if ($options['show_note']) $body .= ''; - if ($report['show_cost']) + if ($options['show_cost']) $body .= ''; - if ($report['show_paid']) { + if ($options['show_paid']) { $body .= ''; } - if ($report['show_ip']) { + if ($options['show_ip']) { $body .= ''; } - if ($report['show_invoice']) + if ($options['show_invoice']) $body .= ''; $body .= ''; @@ -1673,22 +1801,23 @@ class ttReportHelper { $body .= ''; $subtotal_name = htmlspecialchars($subtotals[$cur_grouped_by]['name']); if ($canViewReports || $isClient) $body .= ''; - if ($report['show_client']) $body .= ''; - if ($report['show_project']) $body .= ''; - if ($report['show_task']) $body .= ''; - if ($report['show_custom_field_1']) $body .= ''; - if ($report['show_start']) $body .= ''; - if ($report['show_end']) $body .= ''; - if ($report['show_duration']) $body .= ''; - if ($report['show_note']) $body .= ''; - if ($report['show_cost']) { + 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 .= ''; + if ($options['show_work_units']) $body .= ''; + if ($options['show_note']) $body .= ''; + if ($options['show_cost']) { $body .= ''; } - if ($report['show_paid']) $body .= ''; - if ($report['show_ip']) $body .= ''; - if ($report['show_invoice']) $body .= ''; + if ($options['show_paid']) $body .= ''; + if ($options['show_ip']) $body .= ''; + if ($options['show_invoice']) $body .= ''; $body .= ''; } @@ -1697,22 +1826,23 @@ class ttReportHelper { $body .= ''; $body .= ''; if ($canViewReports || $isClient) $body .= ''; - if ($report['show_client']) $body .= ''; - if ($report['show_project']) $body .= ''; - if ($report['show_task']) $body .= ''; - if ($report['show_custom_field_1']) $body .= ''; - if ($report['show_start']) $body .= ''; - if ($report['show_end']) $body .= ''; - if ($report['show_duration']) $body .= ''; - if ($report['show_note']) $body .= ''; - if ($report['show_cost']) { + 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 .= ''; + if ($options['show_work_units']) $body .= ''; + if ($options['show_note']) $body .= ''; + if ($options['show_cost']) { $body .= ''; } - if ($report['show_paid']) $body .= ''; - if ($report['show_ip']) $body .= ''; - if ($report['show_invoice']) $body .= ''; + if ($options['show_paid']) $body .= ''; + if ($options['show_ip']) $body .= ''; + if ($options['show_invoice']) $body .= ''; $body .= ''; $body .= '
'.$group_by_header.''.$i18n->get('label.duration').''.$i18n->get('label.work_units_short').''.$i18n->get('label.cost').'
'.($subtotal['name'] ? htmlspecialchars($subtotal['name']) : ' ').''; if ($subtotal['time'] <> '0:00') $body .= $subtotal['time']; $body .= ''; + $body .= $subtotal['units']; + $body .= ''; $body .= ($canViewReports || $isClient) ? $subtotal['cost'] : $subtotal['expenses']; $body .= '
 
'.$i18n->get('label.total').''; if ($totals['time'] <> '0:00') $body .= $totals['time']; $body .= ''; + $body .= $totals['units']; + $body .= ''.htmlspecialchars($user->currency).' '; $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses']; $body .= ''.$i18n->get('label.date').''.$i18n->get('label.user').''.$i18n->get('label.client').''.$i18n->get('label.project').''.$i18n->get('label.task').''.htmlspecialchars($custom_fields->fields[0]['label']).''.$i18n->get('label.start').''.$i18n->get('label.finish').''.$i18n->get('label.duration').''.$i18n->get('label.work_units_short').''.$i18n->get('label.note').''.$i18n->get('label.cost').''.$i18n->get('label.paid').''.$i18n->get('label.ip').''.$i18n->get('label.invoice').'
'.$i18n->get('label.subtotal').''.($group_by == 'user' ? $subtotal_name : '').''.($group_by == 'client' ? $subtotal_name : '').''.($group_by == 'project' ? $subtotal_name : '').''.($group_by == 'task' ? $subtotal_name : '').''.($group_by == 'cf_1' ? $subtotal_name : '').''.$subtotals[$prev_grouped_by]['time'].''.($group_by == 'client' ? $subtotal_name : '').''.($group_by == 'project' ? $subtotal_name : '').''.($group_by == 'task' ? $subtotal_name : '').''.($group_by == 'cf_1' ? $subtotal_name : '').''.$subtotals[$prev_grouped_by]['time'].''.$subtotals[$prev_grouped_by]['units'].''; $body .= ($canViewReports || $isClient) ? $subtotals[$prev_grouped_by]['cost'] : $subtotals[$prev_grouped_by]['expenses']; $body .= '
 
'.$record['date'].''.htmlspecialchars($record['user']).''.htmlspecialchars($record['client']).''.htmlspecialchars($record['project']).''.htmlspecialchars($record['task']).''.htmlspecialchars($record['cf_1']).''.$record['start'].''.$record['finish'].''.$record['duration'].''.$record['units'].''.htmlspecialchars($record['note']).''.$record['cost'].''; $body .= $record['paid'] == 1 ? $i18n->get('label.yes') : $i18n->get('label.no'); $body .= ''; $body .= $record['modified'] ? $record['modified_ip'].' '.$record['modified'] : $record['created_ip'].' '.$record['created']; $body .= ''.htmlspecialchars($record['invoice']).'
'.$i18n->get('label.subtotal').''.($group_by == 'user' ? $subtotal_name : '').''.($group_by == 'client' ? $subtotal_name : '').''.($group_by == 'project' ? $subtotal_name : '').''.($group_by == 'task' ? $subtotal_name : '').''.($group_by == 'cf_1' ? $subtotal_name : '').''.$subtotals[$cur_grouped_by]['time'].''.($group_by == 'client' ? $subtotal_name : '').''.($group_by == 'project' ? $subtotal_name : '').''.($group_by == 'task' ? $subtotal_name : '').''.($group_by == 'cf_1' ? $subtotal_name : '').''.$subtotals[$cur_grouped_by]['time'].''.$subtotals[$cur_grouped_by]['units'].''; $body .= ($canViewReports || $isClient) ? $subtotals[$cur_grouped_by]['cost'] : $subtotals[$cur_grouped_by]['expenses']; $body .= '
'.$i18n->get('label.total').''.$totals['time'].''.$totals['time'].''.$totals['units'].''.htmlspecialchars($user->currency).' '; $body .= ($canViewReports || $isClient) ? $totals['cost'] : $totals['expenses']; $body .= '
'; @@ -1729,14 +1859,14 @@ class ttReportHelper { } // sendFavReport - sends a favorite report to a specified email, called from cron.php - static function sendFavReport($report, $subject, $email, $cc) { + 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; // Prepare report body. - $body = ttReportHelper::prepareFavReportBody($report); + $body = ttReportHelper::prepareFavReportBody($options); import('mail.Mailer'); $mailer = new Mailer(); @@ -1749,10 +1879,83 @@ class ttReportHelper { $mailer->setReceiverBCC($user->bcc_email); $mailer->setReceiver($email); $mailer->setMailMode(MAIL_MODE); - if (empty($subject)) $subject = $report['name']; + if (empty($subject)) $subject = $options['name']; if (!$mailer->send($subject, $body)) return false; return true; } + + // 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'); + +/* + * TODO: remaining fields to fill in... + `show_client` tinyint(4) NOT NULL default 0, # whether to show client column + `show_invoice` tinyint(4) NOT NULL default 0, # whether to show invoice column + `show_paid` tinyint(4) NOT NULL default 0, # whether to show paid column + `show_ip` tinyint(4) NOT NULL default 0, # whether to show ip column + `show_project` tinyint(4) NOT NULL default 0, # whether to show project column + `show_start` tinyint(4) NOT NULL default 0, # whether to show start field + `show_duration` tinyint(4) NOT NULL default 0, # whether to show duration field + `show_cost` tinyint(4) NOT NULL default 0, # whether to show cost field + `show_task` tinyint(4) NOT NULL default 0, # whether to show task column + `show_end` tinyint(4) NOT NULL default 0, # whether to show end field + `show_note` tinyint(4) NOT NULL default 0, # whether to show note column + `show_custom_field_1` tinyint(4) NOT NULL default 0, # whether to show custom field 1 + `show_work_units` tinyint(4) NOT NULL default 0, # whether to show work units + `show_totals_only` tinyint(4) NOT NULL default 0, # whether to show totals only + `group_by` varchar(20) default NULL, # group by field + `status` tinyint(4) default 1, # favorite report status + PRIMARY KEY (`id`) +); + */ + 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']; + } + foreach ($users_in_bean as $user_in_bean) { + if (!in_array($user_in_bean, $valid_ids)) { + return false; + } + } + } + + // TODO: add additional checks here. Perhaps do it before saving the bean for consistency. + return true; + } }