X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=WEB-INF%2Flib%2FttInvoiceHelper.class.php;h=0867ee1ebc0ebbc5d186bf9efb72961570159c3f;hb=c30bd94928988ff03ade10ca872968681456e12c;hp=aecafbdb11fc6b9b8140ef0f8e92d36a89c99f12;hpb=477644e55b7496eae44f40cb75cd721c659d8e9f;p=timetracker.git diff --git a/WEB-INF/lib/ttInvoiceHelper.class.php b/WEB-INF/lib/ttInvoiceHelper.class.php index aecafbdb..0867ee1e 100644 --- a/WEB-INF/lib/ttInvoiceHelper.class.php +++ b/WEB-INF/lib/ttInvoiceHelper.class.php @@ -37,7 +37,8 @@ class ttInvoiceHelper { { $mdb2 = getConnection(); - $team_id = (int) $fields['team_id']; + $group_id = (int) $fields['group_id']; + $org_id = (int) $fields['org_id']; $name = $fields['name']; if (!$name) return false; @@ -49,18 +50,13 @@ class ttInvoiceHelper { } // Insert a new invoice record. - $sql = "insert into tt_invoices (team_id, name, date, client_id $status_f) - values($team_id, ".$mdb2->quote($name).", ".$mdb2->quote($date).", $client_id $status_v)"; + $sql = "insert into tt_invoices (group_id, org_id, name, date, client_id $status_f)". + " values($group_id, $org_id, ".$mdb2->quote($name).", ".$mdb2->quote($date).", $client_id $status_v)"; $affected = $mdb2->exec($sql); if (is_a($affected, 'PEAR_Error')) return false; - $last_id = 0; - $sql = "select last_insert_id() as last_insert_id"; - $res = $mdb2->query($sql); - $val = $res->fetchRow(); - $last_id = $val['last_insert_id']; - + $last_id = $mdb2->lastInsertID('tt_invoices', 'id'); return $last_id; } @@ -69,7 +65,10 @@ class ttInvoiceHelper { global $user; $mdb2 = getConnection(); - $sql = "select * from tt_invoices where id = $invoice_id and team_id = $user->team_id and status = 1"; + if ($user->isClient()) $client_part = " and client_id = $user->client_id"; + + $sql = "select * from tt_invoices where id = $invoice_id and group_id = ". + $user->getGroup()."$client_part and status = 1"; $res = $mdb2->query($sql); if (!is_a($res, 'PEAR_Error')) { if ($val = $res->fetchRow()) @@ -84,8 +83,8 @@ class ttInvoiceHelper { $mdb2 = getConnection(); global $user; - $sql = "select id from tt_invoices where team_id = $user->team_id and name = ".$mdb2->quote($invoice_name)." and status = 1"; - + $sql = "select id from tt_invoices where group_id = ". + $user->getGroup()." and name = ".$mdb2->quote($invoice_name)." and status = 1"; $res = $mdb2->query($sql); if (!is_a($res, 'PEAR_Error')) { $val = $res->fetchRow(); @@ -96,22 +95,68 @@ class ttInvoiceHelper { return false; } + // The isPaid determines if an invoice is paid by looking at the paid status of its items. + // If any non-paid item is found, the entire invoice is considered not paid. + // Therefore, the paid status of the invoice is a calculated value. + // This is because we maintain the paid status on individual item level. + static function isPaid($invoice_id) { + + $mdb2 = getConnection(); + global $user; + + $sql = "select count(*) as count from tt_log where invoice_id = $invoice_id and status = 1 and paid < 1"; + $res = $mdb2->query($sql); + if (!is_a($res, 'PEAR_Error')) { + $val = $res->fetchRow(); + if ($val['count'] > 0) + return false; // A non-paid time item exists. + } + $sql = "select count(*) as count from tt_expense_items where invoice_id = $invoice_id and status = 1 and paid < 1"; + $res = $mdb2->query($sql); + if (!is_a($res, 'PEAR_Error')) { + $val = $res->fetchRow(); + if ($val['count'] > 0) + return false; // A non-paid expense item exists. + else + return true; // All time and expense items in invoice are paid. + } + return false; + } + + // markPaid marks invoice items as paid. + static function markPaid($invoice_id, $mark_paid = true) { + + global $user; + $mdb2 = getConnection(); + + $paid_status = $mark_paid ? 1 : 0; + $sql = "update tt_log set paid = $paid_status where invoice_id = $invoice_id and status = 1"; + $affected = $mdb2->exec($sql); + if (is_a($affected, 'PEAR_Error')) return false; + + $sql = "update tt_expense_items set paid = $paid_status where invoice_id = $invoice_id and status = 1"; + $affected = $mdb2->exec($sql); + if (is_a($affected, 'PEAR_Error')) return false; + + return true; + } + // The getInvoiceItems retrieves tt_log items associated with the invoice. static function getInvoiceItems($invoice_id) { global $user; - global $i18n; $mdb2 = getConnection(); // At this time only detailed invoice is supported. // It is anticipated to support "totals only" option later on. // Our query is different depending on tracking mode. - if (MODE_TIME == $user->tracking_mode) { + if (MODE_TIME == $user->getTrackingMode()) { // In "time only" tracking mode there is a single user rate. $sql = "select l.date as date, 1 as type, u.name as user_name, p.name as project_name, t.name as task_name, l.comment as note, time_format(l.duration, '%k:%i') as duration, - cast(l.billable * u.rate * time_to_sec(l.duration)/3600 as decimal(10, 2)) as cost from tt_log l + cast(l.billable * u.rate * time_to_sec(l.duration)/3600 as decimal(10, 2)) as cost, + l.paid as paid from tt_log l inner join tt_users u on (l.user_id = u.id) left join tt_projects p on (p.id = l.project_id) left join tt_tasks t on (t.id = l.task_id) @@ -120,7 +165,8 @@ class ttInvoiceHelper { $sql = "select l.date as date, 1 as type, u.name as user_name, p.name as project_name, t.name as task_name, l.comment as note, time_format(l.duration, '%k:%i') as duration, - cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10, 2)) as cost from tt_log l + cast(l.billable * coalesce(upb.rate, 0) * time_to_sec(l.duration)/3600 as decimal(10, 2)) as cost, + l.paid as paid from tt_log l inner join tt_users u on (l.user_id = u.id) left join tt_projects p on (p.id = l.project_id) left join tt_tasks t on (t.id = l.task_id) @@ -129,10 +175,11 @@ class ttInvoiceHelper { } // If we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table. - if (in_array('ex', explode(',', $user->plugins))) { // if ex(penses) plugin is enabled + if ($user->isPluginEnabled('ex')) { $sql_for_expense_items = "select ei.date as date, 2 as type, u.name as user_name, p.name as project_name, null as task_name, ei.name as note, - null as duration, ei.cost as cost from tt_expense_items ei + null as duration, ei.cost as cost, + ei.paid as paid from tt_expense_items ei inner join tt_users u on (ei.user_id = u.id) left join tt_projects p on (p.id = ei.project_id) where ei.invoice_id = $invoice_id and ei.status = 1"; @@ -184,7 +231,7 @@ class ttInvoiceHelper { $affected = $mdb2->exec($sql); if (is_a($affected, 'PEAR_Error')) return false; - $sql = "update tt_invoices set status = NULL where id = $invoice_id and team_id = $user->team_id"; + $sql = "update tt_invoices set status = NULL where id = $invoice_id and group_id = ".$user->getGroup(); $affected = $mdb2->exec($sql); return (!is_a($affected, 'PEAR_Error')); } @@ -206,13 +253,13 @@ class ttInvoiceHelper { if (isset($fields['project_id'])) $project_id = (int) $fields['project_id']; // Our query is different depending on tracking mode. - if (MODE_TIME == $user->tracking_mode) { + if (MODE_TIME == $user->getTrackingMode()) { // In "time only" tracking mode there is a single user rate. $sql = "select count(*) as num from tt_log l, tt_users u where l.status = 1 and l.client_id = $client_id and l.invoice_id is NULL and l.date >= ".$mdb2->quote($start)." and l.date <= ".$mdb2->quote($end)." - and l.billable * u.rate * time_to_sec(l.duration)/3600 > 0 - and l.user_id = u.id"; + and l.user_id = u.id + and l.billable = 1"; // l.billable * u.rate * time_to_sec(l.duration)/3600 > 0 // See explanation below. } else { // sql part for project id. if ($project_id) $project_part = " and l.project_id = $project_id"; @@ -221,8 +268,14 @@ class ttInvoiceHelper { $sql = "select count(*) as num from tt_log l, tt_user_project_binds upb where l.status = 1 and l.client_id = $client_id $project_part and l.invoice_id is NULL and l.date >= ".$mdb2->quote($start)." and l.date <= ".$mdb2->quote($end)." - and l.billable * upb.rate * time_to_sec(l.duration)/3600 > 0 - and upb.user_id = l.user_id and upb.project_id = l.project_id"; + and upb.user_id = l.user_id and upb.project_id = l.project_id + and l.billable = 1"; // l.billable * upb.rate * time_to_sec(l.duration)/3600 > 0 + // Users with a lot of clients and projects (Jaro) may forget to set user rates properly. + // Specifically, user rate may be set to 0 on a project, by mistake. This leads to error.no_invoiceable_items + // and increased support cost. Commenting out allows us to include 0 cost items in invoices so that + // the problem becomes obvious. + + // TODO: If the above turns out useful, rework the query to simplify it by removing left join. } $res = $mdb2->query($sql); if (!is_a($res, 'PEAR_Error')) { @@ -273,27 +326,23 @@ class ttInvoiceHelper { if (isset($fields['project_id'])) $project_id = (int) $fields['project_id']; // Create a new invoice record. - $sql = "insert into tt_invoices (team_id, name, date, client_id) - values($user->team_id, ".$mdb2->quote($name).", ".$mdb2->quote($date).", $client_id)"; + $sql = "insert into tt_invoices (group_id, org_id, name, date, client_id) values(". + $user->getGroup().", $user->org_id, ".$mdb2->quote($name).", ".$mdb2->quote($date).", $client_id)"; $affected = $mdb2->exec($sql); if (is_a($affected, 'PEAR_Error')) return false; // Mark associated invoice items with invoice id. - $last_id = 0; - $sql = "select last_insert_id() as last_insert_id"; - $res = $mdb2->query($sql); - $val = $res->fetchRow(); - $last_id = $val['last_insert_id']; + $last_id = $mdb2->lastInsertID('tt_invoices', 'id'); // Our update sql is different depending on tracking mode. - if (MODE_TIME == $user->tracking_mode) { + if (MODE_TIME == $user->getTrackingMode()) { // In "time only" tracking mode there is a single user rate. $sql = "update tt_log l left join tt_users u on (u.id = l.user_id) set l.invoice_id = $last_id where l.status = 1 and l.client_id = $client_id and l.invoice_id is NULL and l.date >= ".$mdb2->quote($start)." and l.date <= ".$mdb2->quote($end)." - and l.billable * u.rate * time_to_sec(l.duration)/3600 > 0"; + and l.billable = 1"; // l.billable * u.rate * time_to_sec(l.duration)/3600 > 0"; // See explanation below. } else { // sql part for project id. if ($project_id) $project_part = " and l.project_id = $project_id"; @@ -304,7 +353,13 @@ class ttInvoiceHelper { set l.invoice_id = $last_id where l.status = 1 and l.client_id = $client_id $project_part and l.invoice_id is NULL and l.date >= ".$mdb2->quote($start)." and l.date <= ".$mdb2->quote($end)." - and l.billable * upb.rate * time_to_sec(l.duration)/3600 > 0"; + and l.billable = 1"; // l.billable * upb.rate * time_to_sec(l.duration)/3600 > 0"; + // Users with a lot of clients and projects (Jaro) may forget to set user rates properly. + // Specifically, user rate may be set to 0 on a project, by mistake. This leads to error.no_invoiceable_items + // and increased support cost. Commenting out allows us to include 0 cost items in invoices so that + // the problem becomes obvious. + + // TODO: If the above turns out useful, rework the query to simplify it by removing left join. } $affected = $mdb2->exec($sql); if (is_a($affected, 'PEAR_Error')) @@ -336,7 +391,7 @@ class ttInvoiceHelper { foreach($invoice_items as $item) $subtotal += $item['cost']; if ($tax_percent) { - $tax_expenses = in_array('et', explode(',', $user->plugins)); + $tax_expenses = $user->isPluginEnabled('et'); foreach($invoice_items as $item) { if ($item['type'] == 2 && !$tax_expenses) continue; @@ -362,22 +417,25 @@ class ttInvoiceHelper { $style_tableHeader = 'font-weight: bold; background-color: #a6ccf7; text-align: left;'; $style_tableHeaderCentered = 'font-weight: bold; background-color: #a6ccf7; text-align: center;'; + // Determine tracking mode once for multiple reuse below. + $trackingMode = $user->getTrackingMode(); + // Start creating email body. $body = ''; $body .= ''; $body .= ''; // Output title. - $body .= '

'.$i18n->getKey('title.invoice').' '.htmlspecialchars($invoice['name']).'

'; + $body .= '

'.$i18n->get('title.invoice').' '.htmlspecialchars($invoice['name']).'

'; // Output comment. if($comment) $body .= '

'.htmlspecialchars($comment).'

'; // Output invoice info. $body .= ''; - $body .= ''; - $body .= ''; - $body .= ''; + $body .= ''; + $body .= ''; + $body .= ''; $body .= '
'.$i18n->getKey('label.date').': '.$invoice['date'].'
'.$i18n->getKey('label.client').': '.htmlspecialchars($client['name']).'
'.$i18n->getKey('label.client_address').': '.htmlspecialchars($client['address']).'
'.$i18n->get('label.date').': '.$invoice['date'].'
'.$i18n->get('label.client').': '.htmlspecialchars($client['name']).'
'.$i18n->get('label.client_address').': '.htmlspecialchars($client['address']).'
'; $body .= '

'; @@ -385,23 +443,23 @@ class ttInvoiceHelper { // Output invoice items. $body .= ''; $body .= ''; - $body .= ''; - $body .= ''; - if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) - $body .= ''; - if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) - $body .= ''; - $body .= ''; - $body .= ''; - $body .= ''; + $body .= ''; + $body .= ''; + if (MODE_PROJECTS == $trackingMode || MODE_PROJECTS_AND_TASKS == $trackingMode) + $body .= ''; + if (MODE_PROJECTS_AND_TASKS == $trackingMode) + $body .= ''; + $body .= ''; + $body .= ''; + $body .= ''; $body .= ''; foreach ($invoice_items as $item) { $body .= ''; $body .= ''; $body .= ''; - if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode) + if (MODE_PROJECTS == $trackingMode || MODE_PROJECTS_AND_TASKS == $trackingMode) $body .= ''; - if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) + if (MODE_PROJECTS_AND_TASKS == $trackingMode) $body .= ''; $body .= ''; $body .= ''; @@ -410,20 +468,22 @@ class ttInvoiceHelper { } // Output summary. $colspan = 4; - if (MODE_PROJECTS == $user->tracking_mode) + if (MODE_PROJECTS == $trackingMode) $colspan++; - elseif (MODE_PROJECTS_AND_TASKS == $user->tracking_mode) + elseif (MODE_PROJECTS_AND_TASKS == $trackingMode) $colspan += 2; $body .= ''; if ($tax) { - $body .= ''; - $body .= ''; + $body .= ''; + $body .= ''; } - $body .= ''; + $body .= ''; $body .= '
'.$i18n->getKey('label.date').''.$i18n->getKey('form.invoice.person').''.$i18n->getKey('label.project').''.$i18n->getKey('label.task').''.$i18n->getKey('label.note').''.$i18n->getKey('label.duration').''.$i18n->getKey('label.cost').''.$i18n->get('label.date').''.$i18n->get('form.invoice.person').''.$i18n->get('label.project').''.$i18n->get('label.task').''.$i18n->get('label.note').''.$i18n->get('label.duration').''.$i18n->get('label.cost').'
'.$item['date'].''.htmlspecialchars($item['user_name']).''.htmlspecialchars($item['project_name']).''.htmlspecialchars($item['task_name']).''.htmlspecialchars($item['note']).''.$item['duration'].'
 
'.$i18n->getKey('label.subtotal').':'.$subtotal.'
'.$i18n->getKey('label.tax').':'.$tax.'
'.$i18n->get('label.subtotal').':'.$subtotal.'
'.$i18n->get('label.tax').':'.$tax.'
'.$i18n->getKey('label.total').':'.$total.'
'.$i18n->get('label.total').':'.$total.'
'; // Output footer. - $body .= '

'.$i18n->getKey('form.mail.footer').'

'; + if (!defined('REPORT_FOOTER') || !(REPORT_FOOTER == false)) + $body .= '

'.$i18n->get('form.mail.footer').'

'; + // Finish creating email body. $body .= '';