Some more refactoring in invoices for subgroups.
[timetracker.git] / WEB-INF / lib / ttInvoiceHelper.class.php
index fd701fe..3e29e0e 100644 (file)
@@ -32,46 +32,18 @@ import('DateAndTime');
 // Class ttInvoiceHelper is used for help with invoices.
 class ttInvoiceHelper {
 
-  // insert - inserts an invoice in database.
-  static function insert($fields)
-  {
-    $mdb2 = getConnection();
-
-    $team_id = (int) $fields['team_id'];
-    $name = $fields['name'];
-    if (!$name) return false;
-
-    $client_id = (int) $fields['client_id'];
-    $date = $fields['date'];
-    if (array_key_exists('status', $fields)) { // Key exists and may be NULL during migration of data.
-      $status_f = ', status';
-      $status_v = ', '.$mdb2->quote($fields['status']);
-    }
-
-    // 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)"; 
-    $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'];
-
-    return $last_id;
-  }
-
   // getInvoice - obtains invoice data from the database.
   static function getInvoice($invoice_id) {
     global $user;
     $mdb2 = getConnection();
 
-    if ($user->isClient()) $client_part = " and client_id = $user->client_id";
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    if ($user->isClient()) $client_part = "and client_id = $user->client_id";
 
-    $sql = "select * from tt_invoices where id = $invoice_id and team_id = $user->team_id $client_part and status = 1";
+    $sql = "select * from tt_invoices".
+      " where id = $invoice_id and group_id = $group_id and org_id = $org_id $client_part and status = 1";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       if ($val = $res->fetchRow())
@@ -82,11 +54,14 @@ class ttInvoiceHelper {
 
   // The getInvoiceByName looks up an invoice by name.
   static function getInvoiceByName($invoice_name) {
-
-    $mdb2 = getConnection();
     global $user;
+    $mdb2 = getConnection();
 
-    $sql = "select id from tt_invoices where team_id = $user->team_id and name = ".$mdb2->quote($invoice_name)." and status = 1";
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
+    $sql = "select id from tt_invoices where group_id = $group_id and org_id = $org_id".
+      " and name = ".$mdb2->quote($invoice_name)." and status = 1";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       $val = $res->fetchRow();
@@ -102,18 +77,22 @@ class ttInvoiceHelper {
   // 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;
+    $mdb2 = getConnection();
+
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
 
-    $sql = "select count(*) as count from tt_log where invoice_id = $invoice_id and status = 1 and paid < 1";
+    $sql = "select count(*) as count from tt_log".
+      " where invoice_id = $invoice_id and group_id = $group_id and org_id = $org_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";
+    $sql = "select count(*) as count from tt_expense_items".
+      " where invoice_id = $invoice_id and group_id = $group_id and org_id = $org_id and status = 1 and paid < 1";
     $res = $mdb2->query($sql);
     if (!is_a($res, 'PEAR_Error')) {
       $val = $res->fetchRow();
@@ -127,16 +106,20 @@ class ttInvoiceHelper {
 
   // markPaid marks invoice items as paid.
   static function markPaid($invoice_id, $mark_paid = true) {
-
     global $user;
     $mdb2 = getConnection();
 
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
     $paid_status = $mark_paid ? 1 : 0;
-    $sql = "update tt_log set paid = $paid_status where invoice_id = $invoice_id and status = 1";
+    $sql = "update tt_log set paid = $paid_status".
+      " where invoice_id = $invoice_id and group_id = $group_id and org_id = $org_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";
+    $sql = "update tt_expense_items set paid = $paid_status".
+      " where invoice_id = $invoice_id and group_id = $group_id and org_id = $org_id and status = 1";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error')) return false;
 
@@ -148,43 +131,46 @@ class ttInvoiceHelper {
     global $user;
     $mdb2 = getConnection();
 
+    $group_id = $user->getGroup();
+    $org_id = $user->org_id;
+
     // 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,
-      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)
-      where l.status = 1 and l.billable = 1 and l.invoice_id = $invoice_id order by l.date, u.name";
+      $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,".
+        " 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)".
+        " where l.status = 1 and l.billable = 1 and l.invoice_id = $invoice_id".
+        " and l.group_id = $group_id and l.org_id = $org_id order by l.date, u.name";
     } else {
-      $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,
-        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)
-        left join tt_user_project_binds upb on (upb.user_id = l.user_id and upb.project_id = l.project_id)
-        where l.status = 1 and l.billable = 1 and l.invoice_id = $invoice_id order by l.date, u.name";
+      $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,".
+        " 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)".
+        " left join tt_user_project_binds upb on (upb.user_id = l.user_id and upb.project_id = l.project_id)".
+        " where l.status = 1 and l.billable = 1 and l.invoice_id = $invoice_id".
+        " and l.group_id = $group_id and l.org_id = $org_id order by l.date, u.name";
     }
 
     // If we have expenses, we need to do a union with a separate query for expense items from tt_expense_items table.
     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,
-        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";
+      $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,".
+        " 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.group_id = $group_id and ei.org_id = $org_id and ei.status = 1";
 
       // Construct a union.
       $sql = "($sql) union all ($sql_for_expense_items)";
@@ -233,7 +219,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'));
   }
@@ -255,7 +241,7 @@ 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
@@ -287,18 +273,20 @@ class ttInvoiceHelper {
       }
     }
 
-    // sql part for project id.
-    if ($project_id) $project_part = " and ei.project_id = $project_id";
-
-    $sql = "select count(*) as num from tt_expense_items ei
-      where ei.client_id = $client_id $project_part and ei.invoice_id is NULL
-      and ei.date >= ".$mdb2->quote($start)." and ei.date <= ".$mdb2->quote($end)."
-      and ei.cost <> 0 and ei.status = 1";
-    $res = $mdb2->query($sql);
-    if (!is_a($res, 'PEAR_Error')) {
-      $val = $res->fetchRow();
-      if ($val['num']) {
-        return true;
+    if ($user->isPluginEnabled('ex')) {
+      // sql part for project id.
+      if ($project_id) $project_part = " and ei.project_id = $project_id";
+
+      $sql = "select count(*) as num from tt_expense_items ei
+        where ei.client_id = $client_id $project_part and ei.invoice_id is NULL
+        and ei.date >= ".$mdb2->quote($start)." and ei.date <= ".$mdb2->quote($end)."
+        and ei.cost <> 0 and ei.status = 1";
+      $res = $mdb2->query($sql);
+      if (!is_a($res, 'PEAR_Error')) {
+        $val = $res->fetchRow();
+        if ($val['num']) {
+          return true;
+        }
       }
     }
 
@@ -328,20 +316,16 @@ 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)
@@ -423,22 +407,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 = '<html>';
     $body .= '<head><meta http-equiv="content-type" content="text/html; charset='.CHARSET.'"></head>';
     $body .= '<body>';
 
     // Output title.
-    $body .= '<p style="'.$style_title.'">'.$i18n->getKey('title.invoice').' '.htmlspecialchars($invoice['name']).'</p>';
+    $body .= '<p style="'.$style_title.'">'.$i18n->get('title.invoice').' '.htmlspecialchars($invoice['name']).'</p>';
 
     // Output comment.
     if($comment) $body .= '<p>'.htmlspecialchars($comment).'</p>';
 
     // Output invoice info.
     $body .= '<table>';
-    $body .= '<tr><td><b>'.$i18n->getKey('label.date').':</b> '.$invoice['date'].'</td></tr>';
-    $body .= '<tr><td><b>'.$i18n->getKey('label.client').':</b> '.htmlspecialchars($client['name']).'</td></tr>';
-    $body .= '<tr><td><b>'.$i18n->getKey('label.client_address').':</b> '.htmlspecialchars($client['address']).'</td></tr>';
+    $body .= '<tr><td><b>'.$i18n->get('label.date').':</b> '.$invoice['date'].'</td></tr>';
+    $body .= '<tr><td><b>'.$i18n->get('label.client').':</b> '.htmlspecialchars($client['name']).'</td></tr>';
+    $body .= '<tr><td><b>'.$i18n->get('label.client_address').':</b> '.htmlspecialchars($client['address']).'</td></tr>';
     $body .= '</table>';
 
     $body .= '<p></p>';
@@ -446,23 +433,23 @@ class ttInvoiceHelper {
     // Output invoice items.
     $body .= '<table border="0" cellpadding="4" cellspacing="0" width="100%">';
     $body .= '<tr>';
-    $body .= '<td style="'.$style_tableHeader.'">'.$i18n->getKey('label.date').'</td>';
-    $body .= '<td style="'.$style_tableHeader.'">'.$i18n->getKey('form.invoice.person').'</td>';
-    if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode)
-      $body .= '<td style="'.$style_tableHeader.'">'.$i18n->getKey('label.project').'</td>';
-    if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode)
-      $body .= '<td style="'.$style_tableHeader.'">'.$i18n->getKey('label.task').'</td>';
-    $body .= '<td style="'.$style_tableHeader.'">'.$i18n->getKey('label.note').'</td>';
-    $body .= '<td style="'.$style_tableHeaderCentered.'" width="5%">'.$i18n->getKey('label.duration').'</td>';
-    $body .= '<td style="'.$style_tableHeaderCentered.'" width="5%">'.$i18n->getKey('label.cost').'</td>';
+    $body .= '<td style="'.$style_tableHeader.'">'.$i18n->get('label.date').'</td>';
+    $body .= '<td style="'.$style_tableHeader.'">'.$i18n->get('form.invoice.person').'</td>';
+    if (MODE_PROJECTS == $trackingMode || MODE_PROJECTS_AND_TASKS == $trackingMode)
+      $body .= '<td style="'.$style_tableHeader.'">'.$i18n->get('label.project').'</td>';
+    if (MODE_PROJECTS_AND_TASKS == $trackingMode)
+      $body .= '<td style="'.$style_tableHeader.'">'.$i18n->get('label.task').'</td>';
+    $body .= '<td style="'.$style_tableHeader.'">'.$i18n->get('label.note').'</td>';
+    $body .= '<td style="'.$style_tableHeaderCentered.'" width="5%">'.$i18n->get('label.duration').'</td>';
+    $body .= '<td style="'.$style_tableHeaderCentered.'" width="5%">'.$i18n->get('label.cost').'</td>';
     $body .= '</tr>';
     foreach ($invoice_items as $item) {
       $body .= '<tr>';
       $body .= '<td>'.$item['date'].'</td>';
       $body .= '<td>'.htmlspecialchars($item['user_name']).'</td>';
-      if (MODE_PROJECTS == $user->tracking_mode || MODE_PROJECTS_AND_TASKS == $user->tracking_mode)
+      if (MODE_PROJECTS == $trackingMode || MODE_PROJECTS_AND_TASKS == $trackingMode)
         $body .= '<td>'.htmlspecialchars($item['project_name']).'</td>';
-      if (MODE_PROJECTS_AND_TASKS == $user->tracking_mode)
+      if (MODE_PROJECTS_AND_TASKS == $trackingMode)
         $body .= '<td>'.htmlspecialchars($item['task_name']).'</td>';
       $body .= '<td>'.htmlspecialchars($item['note']).'</td>';
       $body .= '<td align="right">'.$item['duration'].'</td>';
@@ -471,21 +458,21 @@ 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 .= '<tr><td>&nbsp;</td></tr>';
     if ($tax) {
-      $body .= '<tr><td colspan="'.$colspan.'" align="right"><b>'.$i18n->getKey('label.subtotal').':</b></td><td nowrap align="right">'.$subtotal.'</td></tr>';
-      $body .= '<tr><td colspan="'.$colspan.'" align="right"><b>'.$i18n->getKey('label.tax').':</b></td><td nowrap align="right">'.$tax.'</td></tr>';
+      $body .= '<tr><td colspan="'.$colspan.'" align="right"><b>'.$i18n->get('label.subtotal').':</b></td><td nowrap align="right">'.$subtotal.'</td></tr>';
+      $body .= '<tr><td colspan="'.$colspan.'" align="right"><b>'.$i18n->get('label.tax').':</b></td><td nowrap align="right">'.$tax.'</td></tr>';
     }
-    $body .= '<tr><td colspan="'.$colspan.'" align="right"><b>'.$i18n->getKey('label.total').':</b></td><td nowrap align="right">'.$total.'</td></tr>';
+    $body .= '<tr><td colspan="'.$colspan.'" align="right"><b>'.$i18n->get('label.total').':</b></td><td nowrap align="right">'.$total.'</td></tr>';
     $body .= '</table>';
 
     // Output footer.
     if (!defined('REPORT_FOOTER') || !(REPORT_FOOTER == false))
-      $body .= '<p style="text-align: center;">'.$i18n->getKey('form.mail.footer').'</p>';
+      $body .= '<p style="text-align: center;">'.$i18n->get('form.mail.footer').'</p>';
 
     // Finish creating email body.
     $body .= '</body></html>';