topdf.php

   1 <?php
   2 // +----------------------------------------------------------------------+
   3 // | Anuko Time Tracker
   4 // +----------------------------------------------------------------------+
   5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
   6 // +----------------------------------------------------------------------+
   7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
   8 // | by anyone for any purpose, and freely redistributed alone or in
   9 // | combination with other software, provided that the license is obeyed.
  10 // |
  11 // | There are only two ways to violate the license:
  12 // |
  13 // | 1. To redistribute this code in source form, with the copyright
  14 // |    notice or license removed or altered. (Distributing in compiled
  15 // |    forms without embedded copyright notices is permitted).
  16 // |
  17 // | 2. To redistribute modified versions of this code in *any* form
  18 // |    that bears insufficient indications that the modifications are
  19 // |    not the work of the original author(s).
  20 // |
  21 // | This license applies to this document only, not any other software
  22 // | that it may be combined with.
  23 // |
  24 // +----------------------------------------------------------------------+
  25 // | Contributors:
  26 // | https://www.anuko.com/time_tracker/credits.htm
  27 // +----------------------------------------------------------------------+
  28
  29 /*
  30  * This file generates a report in PDF format using TCPDF library from http://www.tcpdf.org/.
  31  * If installed, it is expected to be in WEB-INF/lib/tcpdf/ folder.
  32  */
  33 require_once('initialize.php');
  34 import('form.Form');
  35 import('form.ActionForm');
  36 import('ttReportHelper');
  37
  38 // Access checks.
  39 if (!(ttAccessAllowed('view_own_reports') || ttAccessAllowed('view_reports') || ttAccessAllowed('view_all_reports') || ttAccessAllowed('view_client_reports'))) {
  40   header('Location: access_denied.php');
  41   exit();
  42 }
  43 // End of access checks.
  44
  45 // Check whether TCPDF library is available.
  46 if (!file_exists('WEB-INF/lib/tcpdf/'))
  47   die('TCPDF library is not found in WEB-INF/lib/tcpdf/');
  48
  49 // Include TCPDF library.
  50 require_once('WEB-INF/lib/tcpdf/tcpdf.php');
  51
  52 // Use custom fields plugin if it is enabled.
  53 if ($user->isPluginEnabled('cf')) {
  54   require_once('plugins/CustomFields.class.php');
  55   $custom_fields = new CustomFields();
  56 }
  57
  58 // Report settings are stored in session bean before we get here.
  59 $bean = new ActionForm('reportBean', new Form('reportForm'), $request);
  60
  61 // There are 2 variations of report: totals only, or normal. Totals only means that the report
  62 // is grouped by either date, user, client, project, task or cf_1 and user only needs to see subtotals by group.
  63 $totals_only = ($bean->getAttribute('chtotalsonly') == '1');
  64
  65 // Obtain items for report.
  66 $options = ttReportHelper::getReportOptions($bean);
  67 $grouping = ttReportHelper::grouping($options);
  68 if (!$totals_only)
  69   $items = ttReportHelper::getItems($options); // Individual entries.
  70 if ($totals_only || $grouping)
  71   $subtotals = ttReportHelper::getSubtotals($options); // Subtotals for groups of items.
  72 $totals = ttReportHelper::getTotals($options); // Totals for the entire report.
  73
  74 // Assign variables that are used to print subtotals.
  75 if ($items && $grouping) {
  76   $print_subtotals = true;
  77   $first_pass = true;
  78   $prev_grouped_by = '';
  79   $cur_grouped_by = '';
  80 }
  81
  82 // Build a string to use as filename for the files being downloaded.
  83 $filename = strtolower($i18n->get('title.report')).'_'.$bean->mValues['start_date'].'_'.$bean->mValues['end_date'];
  84
  85 // Start preparing HTML to build PDF from.
  86 $styleHeader = 'style="background-color:#a6ccf7;"';
  87 $styleSubtotal = 'style="background-color:#e0e0e0;"';
  88 $styleCentered = 'style="text-align:center;"';
  89 $styleRightAligned = 'style="text-align:right;"';
  90
  91 $title = $i18n->get('title.report').": ".$totals['start_date']." - ".$totals['end_date'];
  92 $html = '<h1 style="text-align:center;">'.$title.'</h1>';
  93 $html .= '<table border="1" cellpadding="3" cellspacing="0" width="100%">';
  94
  95 if ($totals_only) {
  96   // We are building a "totals only" report with only subtotals and total.
  97   $group_by_header = ttReportHelper::makeGroupByHeader($options);
  98   $colspan = 1; // Column span for an empty row.
  99   // Table header.
 100   $html .= '<thead>';
 101   $html .= "<tr $styleHeader>";
 102   $html .= '<td>'.htmlspecialchars($group_by_header).'</td>';
 103   if ($bean->getAttribute('chduration')) { $colspan++; $html .= "<td $styleCentered>".$i18n->get('label.duration').'</td>'; }
 104   if ($bean->getAttribute('chunits')) { $colspan++; $html .= "<td $styleCentered>".$i18n->get('label.work_units_short').'</td>'; }
 105   if ($bean->getAttribute('chcost')) { $colspan++; $html .= "<td $styleCentered>".$i18n->get('label.cost').'</td>'; }
 106   $html .= '</tr>';
 107   $html .= '</thead>';
 108   // Print subtotals.
 109   foreach ($subtotals as $subtotal) {
 110     $html .= '<tr>';
 111     $html .= '<td>'.htmlspecialchars($subtotal['name']).'</td>';
 112     if ($bean->getAttribute('chduration')) $html .= "<td $styleRightAligned>".$subtotal['time'].'</td>';
 113     if ($bean->getAttribute('chunits')) $html .= "<td $styleRightAligned>".$subtotal['units'].'</td>';
 114     if ($bean->getAttribute('chcost')) {
 115       $html .= "<td $styleRightAligned>";
 116       if ($user->can('manage_invoices') || $user->isClient())
 117         $html .= $subtotal['cost'];
 118       else
 119         $html .= $subtotal['expenses'];
 120       $html .= '</td>';
 121     }
 122     $html .= '</tr>';
 123   }
 124   // Print totals.
 125   $html .= '<tr><td colspan="'.$colspan.'">&nbsp;</td></tr>';
 126   $html .= "<tr $styleSubtotal>";
 127   $html .= '<td>'.$i18n->get('label.total').'</td>';
 128   if ($bean->getAttribute('chduration')) $html .= "<td $styleRightAligned>".$totals['time'].'</td>';
 129   if ($bean->getAttribute('chunits')) $html .= "<td $styleRightAligned>".$totals['units'].'</td>';
 130   if ($bean->getAttribute('chcost')) {
 131       $html .= "<td $styleRightAligned>";
 132       $html .= htmlspecialchars($user->currency).' ';
 133       if ($user->can('manage_invoices') || $user->isClient())
 134         $html .= $totals['cost'];
 135       else
 136         $html .= $totals['expenses'];
 137       $html .= '</td>';
 138     }
 139   $html .= '</tr>';
 140   $html .= '</table>';
 141 } else {
 142   // We are building a normal report with items, optionally grouped with subtotals, and total.
 143   $colspan = 1; // Column span for an empty row.
 144   // Table header.
 145   $html .= '<thead>';
 146   $html .= "<tr $styleHeader>";
 147   $html .= '<td>'.$i18n->get('label.date').'</td>';
 148   if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient()) { $colspan++; $html .= '<td>'.$i18n->get('label.user').'</td>'; }
 149   if ($bean->getAttribute('chclient')) { $colspan++; $html .= '<td>'.$i18n->get('label.client').'</td>'; }
 150   if ($bean->getAttribute('chproject')) { $colspan++; $html .= '<td>'.$i18n->get('label.project').'</td>'; }
 151   if ($bean->getAttribute('chtask')) { $colspan++; $html .= '<td>'.$i18n->get('label.task').'</td>'; }
 152   if ($bean->getAttribute('chcf_1')) { $colspan++; $html .= '<td>'.htmlspecialchars($custom_fields->fields[0]['label']).'</td>'; }
 153   if ($bean->getAttribute('chstart')) { $colspan++; $html .= "<td $styleCentered>".$i18n->get('label.start').'</td>'; }
 154   if ($bean->getAttribute('chfinish')) { $colspan++; $html .= "<td $styleCentered>".$i18n->get('label.finish').'</td>'; }
 155   if ($bean->getAttribute('chduration')) { $colspan++; $html .= "<td $styleCentered>".$i18n->get('label.duration').'</td>'; }
 156   if ($bean->getAttribute('chunits')) { $colspan++; $html .= "<td $styleCentered>".$i18n->get('label.work_units_short').'</td>'; }
 157   if ($bean->getAttribute('chnote')) { $colspan++; $html .= '<td>'.$i18n->get('label.note').'</td>'; }
 158   if ($bean->getAttribute('chcost')) { $colspan++; $html .= "<td $styleCentered>".$i18n->get('label.cost').'</td>'; }
 159   if ($bean->getAttribute('chpaid')) { $colspan++; $html .= "<td $styleCentered>".$i18n->get('label.paid').'</td>'; }
 160   if ($bean->getAttribute('chip')) { $colspan++; $html .= "<td $styleCentered>".$i18n->get('label.ip').'</td>'; }
 161   if ($bean->getAttribute('chinvoice')) { $colspan++; $html .= '<td>'.$i18n->get('label.invoice').'</td>'; }
 162   $html .= '</tr>';
 163   $html .= '</thead>';
 164
 165   foreach ($items as $item) {
 166     // Print a subtotal for a block of grouped values.
 167     $cur_date = $item['date'];
 168     if ($print_subtotals) {
 169       $cur_grouped_by = $item['grouped_by'];
 170       if ($cur_grouped_by != $prev_grouped_by && !$first_pass) {
 171         $html .= '<tr style="background-color:#e0e0e0;">';
 172         $html .= '<td>'.$i18n->get('label.subtotal').'</td>';
 173         if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient()) {
 174             $html .= '<td>';
 175             $html .= htmlspecialchars($subtotals[$prev_grouped_by]['user']);
 176             $html .= '</td>';
 177         }
 178         if ($bean->getAttribute('chclient')) {
 179             $html .= '<td>';
 180             $html .= htmlspecialchars($subtotals[$prev_grouped_by]['client']);
 181             $html .= '</td>';
 182         }
 183         if ($bean->getAttribute('chproject')) {
 184             $html .= '<td>';
 185             $html .= htmlspecialchars($subtotals[$prev_grouped_by]['project']);
 186             $html .= '</td>';
 187         }
 188         if ($bean->getAttribute('chtask')) {
 189             $html .= '<td>';
 190             $html .= htmlspecialchars($subtotals[$prev_grouped_by]['task']);
 191             $html .= '</td>';
 192         }
 193         if ($bean->getAttribute('chcf_1')) {
 194             $html .= '<td>';
 195             $html .= htmlspecialchars($subtotals[$prev_grouped_by]['cf_1']);
 196             $html .= '</td>';
 197         }
 198         if ($bean->getAttribute('chstart')) $html .= '<td></td>';
 199         if ($bean->getAttribute('chfinish')) $html .= '<td></td>';
 200         if ($bean->getAttribute('chduration')) $html .= "<td $styleRightAligned>".$subtotals[$prev_grouped_by]['time'].'</td>';
 201         if ($bean->getAttribute('chunits')) $html .= "<td $styleRightAligned>".$subtotals[$prev_grouped_by]['units'].'</td>';
 202         if ($bean->getAttribute('chnote')) $html .= '<td></td>';
 203         if ($bean->getAttribute('chcost')) {
 204           $html .= "<td $styleRightAligned>";
 205           if ($user->can('manage_invoices') || $user->isClient())
 206             $html .= $subtotals[$prev_grouped_by]['cost'];
 207           else
 208             $html .= $subtotals[$prev_grouped_by]['expenses'];
 209           $html .= '</td>';
 210         }
 211         if ($bean->getAttribute('chpaid')) $html .= '<td></td>';
 212         if ($bean->getAttribute('chip')) $html .= '<td></td>';
 213         if ($bean->getAttribute('chinvoice')) $html .= '<td></td>';
 214         $html .= '</tr>';
 215         $html .= '<tr><td colspan="'.$colspan.'">&nbsp;</td></tr>';
 216       }
 217       $first_pass = false;
 218     }
 219
 220     // Print a regular row.
 221     $html .= '<tr>';
 222     $html .= '<td>'.$item['date'].'</td>';
 223     if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient()) $html .= '<td>'.htmlspecialchars($item['user']).'</td>';
 224     if ($bean->getAttribute('chclient')) $html .= '<td>'.htmlspecialchars($item['client']).'</td>';
 225     if ($bean->getAttribute('chproject')) $html .= '<td>'.htmlspecialchars($item['project']).'</td>';
 226     if ($bean->getAttribute('chtask')) $html .= '<td>'.htmlspecialchars($item['task']).'</td>';
 227     if ($bean->getAttribute('chcf_1')) $html .= '<td>'.htmlspecialchars($item['cf_1']).'</td>';
 228     if ($bean->getAttribute('chstart')) $html .= "<td $styleRightAligned>".$item['start'].'</td>';
 229     if ($bean->getAttribute('chfinish')) $html .= "<td $styleRightAligned>".$item['finish'].'</td>';
 230     if ($bean->getAttribute('chduration')) $html .= "<td $styleRightAligned>".$item['duration'].'</td>';
 231     if ($bean->getAttribute('chunits')) $html .= "<td $styleRightAligned>".$item['units'].'</td>';
 232     if ($bean->getAttribute('chnote')) $html .= '<td>'.htmlspecialchars($item['note']).'</td>';
 233     if ($bean->getAttribute('chcost')) {
 234       $html .= "<td $styleRightAligned>";
 235       if ($user->can('manage_invoices') || $user->isClient())
 236         $html .= $item['cost'];
 237       else
 238         $html .= $item['expense'];
 239       $html .= '</td>';
 240     }
 241     if ($bean->getAttribute('chpaid')) {
 242         $html .= '<td>';
 243         $html .= $item['paid'] == 1 ? $i18n->get('label.yes') : $i18n->get('label.no');
 244         $html .= '</td>';
 245     }
 246     if ($bean->getAttribute('chip')) {
 247         $html .= '<td>';
 248         $html .= $item['modified'] ? $item['modified_ip'].' '.$item['modified'] : $item['created_ip'].' '.$item['created'];
 249         $html .= '</td>';
 250     }
 251     if ($bean->getAttribute('chinvoice')) $html .= '<td>'.htmlspecialchars($item['invoice']).'</td>';
 252     $html .= '</tr>';
 253
 254     $prev_date = $item['date'];
 255     if ($print_subtotals) $prev_grouped_by = $item['grouped_by'];
 256   }
 257
 258   // Print a terminating subtotal.
 259   if ($print_subtotals) {
 260     $html .= '<tr style="background-color:#e0e0e0;">';
 261     $html .= '<td>'.$i18n->get('label.subtotal').'</td>';
 262     if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient()) {
 263       $html .= '<td>';
 264       $html .= htmlspecialchars($subtotals[$prev_grouped_by]['user']);
 265       $html .= '</td>';
 266     }
 267     if ($bean->getAttribute('chclient')) {
 268       $html .= '<td>';
 269       $html .= htmlspecialchars($subtotals[$prev_grouped_by]['client']);
 270       $html .= '</td>';
 271     }
 272     if ($bean->getAttribute('chproject')) {
 273       $html .= '<td>';
 274       $html .= htmlspecialchars($subtotals[$prev_grouped_by]['project']);
 275       $html .= '</td>';
 276     }
 277     if ($bean->getAttribute('chtask')) {
 278       $html .= '<td>';
 279       $html .= htmlspecialchars($subtotals[$prev_grouped_by]['task']);
 280       $html .= '</td>';
 281     }
 282     if ($bean->getAttribute('chcf_1')) {
 283       $html .= '<td>';
 284       $html .= htmlspecialchars($subtotals[$prev_grouped_by]['cf_1']);
 285       $html .= '</td>';
 286     }
 287     if ($bean->getAttribute('chstart')) $html .= '<td></td>';
 288     if ($bean->getAttribute('chfinish')) $html .= '<td></td>';
 289     if ($bean->getAttribute('chduration')) $html .= "<td $styleRightAligned>".$subtotals[$prev_grouped_by]['time'].'</td>';
 290     if ($bean->getAttribute('chunits')) $html .= "<td $styleRightAligned>".$subtotals[$prev_grouped_by]['units'].'</td>';
 291     if ($bean->getAttribute('chnote')) $html .= '<td></td>';
 292     if ($bean->getAttribute('chcost')) {
 293       $html .= "<td $styleRightAligned>";
 294       if ($user->can('manage_invoices') || $user->isClient())
 295         $html .= $subtotals[$prev_grouped_by]['cost'];
 296       else
 297         $html .= $subtotals[$prev_grouped_by]['expenses'];
 298       $html .= '</td>';
 299     }
 300     if ($bean->getAttribute('chpaid')) $html .= '<td></td>';
 301     if ($bean->getAttribute('chip')) $html .= '<td></td>';
 302     if ($bean->getAttribute('chinvoice')) $html .= '<td></td>';
 303     $html .= '</tr>';
 304   }
 305
 306   // Print totals.
 307   $html .= '<tr><td colspan="'.$colspan.'">&nbsp;</td></tr>';
 308   $html .= '<tr style="background-color:#e0e0e0;">';
 309   $html .= '<td>'.$i18n->get('label.total').'</td>';
 310   if ($user->can('view_reports') || $user->can('view_all_reports') || $user->isClient()) $html .= '<td></td>';
 311   if ($bean->getAttribute('chclient')) $html .= '<td></td>';
 312   if ($bean->getAttribute('chproject')) $html .= '<td></td>';
 313   if ($bean->getAttribute('chtask')) $html .= '<td></td>';
 314   if ($bean->getAttribute('chcf_1')) $html .= '<td></td>';
 315   if ($bean->getAttribute('chstart')) $html .= '<td></td>';
 316   if ($bean->getAttribute('chfinish')) $html .= '<td></td>';
 317   if ($bean->getAttribute('chduration')) $html .= "<td $styleRightAligned>".$totals['time'].'</td>';
 318   if ($bean->getAttribute('chunits')) $html .= "<td $styleRightAligned>".$totals['units'].'</td>';
 319   if ($bean->getAttribute('chnote')) $html .= '<td></td>';
 320   if ($bean->getAttribute('chcost')) {
 321     $html .= "<td $styleRightAligned>".htmlspecialchars($user->currency).' ';
 322     if ($user->can('manage_invoices') || $user->isClient())
 323       $html .= $totals['cost'];
 324     else
 325       $html .= $totals['expenses'];
 326     $html .= '</td>';
 327   }
 328   if ($bean->getAttribute('chpaid')) $html .= '<td></td>';
 329   if ($bean->getAttribute('chip')) $html .= '<td></td>';
 330   if ($bean->getAttribute('chinvoice')) $html .= '<td></td>';
 331   $html .= '</tr>';
 332   $html .= '</table>';
 333 }
 334
 335 // Output footer.
 336 if (!defined('REPORT_FOOTER') || !(REPORT_FOOTER == false)) // By default we print it unless explicitely defined as false.
 337   $html .= '<p style="text-align: center;">'.$i18n->get('form.mail.footer').'</p>';
 338
 339 // By this time we have html ready.
 340
 341 // Determine title for report.
 342 $title = $i18n->get('title.report').": ".$totals['start_date']." - ".$totals['end_date'];
 343
 344 header('Pragma: public'); // This is needed for IE8 to download files over https.
 345 header('Content-Type: text/html; charset=utf-8');
 346 header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
 347 header('Cache-Control: no-store, no-cache, must-revalidate');
 348 header('Cache-Control: post-check=0, pre-check=0', false);
 349 header('Cache-Control: private', false);
 350
 351 header('Content-Type: application/pdf');
 352 header('Content-Disposition: attachment; filename="'.$filename.'.pdf"');
 353
 354
 355 // Beginning of TCPDF code here.
 356
 357 // Extend TCPDF class so that we can use custom header and footer.
 358 class ttPDF extends TCPDF {
 359
 360   public $image_file = 'images/tt_logo.png'; // Image file for the logo in header.
 361   public $page_word = 'Page'; // Localized "Page" word in footer, ex: Page 1/2.
 362
 363   // SetImageFile - sets image file name.
 364   public function SetImageFile($imgFile) {
 365     $this->image_file = $imgFile;
 366   }
 367
 368   // SetPageWord - sets page word for footer.
 369   public function SetPageWord($pageWord) {
 370     $this->page_word = $pageWord;
 371   }
 372
 373   // Page header.
 374   public function Header() {
 375     // Print logo, which is the only element of our custom header.
 376     $this->Image($this->image_file, 10, 10, '', '', '', '', 'T', false, 300, 'C', false, false, 0, false, false, false);
 377   }
 378
 379   // Page footer.
 380   public function Footer() {
 381     // Position at 15 mm from bottom.
 382     $this->SetY(-15);
 383     // Set font.
 384     $this->SetFont('freeserif', 'I', 8);
 385     // Print localized page number.
 386     $this->Cell(0, 10, $this->page_word.' '.$this->getAliasNumPage().'/'.$this->getAliasNbPages(), 0, false, 'C', 0, '', 0, false, 'T', 'M');
 387   }
 388 }
 389
 390 // Create new PDF document.
 391 $pdf = new ttPDF(PDF_PAGE_ORIENTATION, PDF_UNIT, PDF_PAGE_FORMAT, true, 'UTF-8', false);
 392
 393 // If custom logo file exists - set it.
 394 if (file_exists('images/'.$user->group_id.'.png'))
 395   $pdf->SetImageFile('images/'.$user->group_id.'.png');
 396
 397 // Set page word for the footer.
 398 $pdf->SetPageWord($i18n->get('label.page'));
 399
 400 // Set document information.
 401 $pdf->SetCreator(PDF_CREATOR);
 402 $pdf->SetAuthor('Anuko Time Tracker');
 403 $pdf->SetTitle('Anuko Time Tracker Report');
 404 $pdf->SetSubject('Anuko Time Tracker Report');
 405 $pdf->SetKeywords('Anuko, time, tracker, report');
 406
 407 // Set margins.
 408 $pdf->SetMargins(PDF_MARGIN_LEFT, PDF_MARGIN_TOP, PDF_MARGIN_RIGHT);
 409 $pdf->SetHeaderMargin(PDF_MARGIN_HEADER);
 410 $pdf->SetFooterMargin(PDF_MARGIN_FOOTER);
 411
 412 // Set auto page breaks.
 413 $pdf->SetAutoPageBreak(TRUE, PDF_MARGIN_BOTTOM);
 414
 415 // Set image scale factor.
 416 $pdf->setImageScale(PDF_IMAGE_SCALE_RATIO);
 417
 418 // Add a page.
 419 $pdf->AddPage();
 420
 421 // Set font (freeserif seems to work for all languages).
 422 $pdf->SetFont('freeserif', '', 10); // helvetica here does not work for Russian.
 423
 424 // Write HTML.
 425 $pdf->writeHTML($html, true, false, false, false, '');
 426
 427 // Close and output PDF document.
 428 // $pdf->Output('timesheet.pdf', 'I'); // This will display inline in browser.
 429 $pdf->Output($filename.'.pdf', 'D'); // D is for downloads.
 430
 431 // End of of TCPDF code.