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.
11 // | There are only two ways to violate the license:
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).
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).
21 // | This license applies to this document only, not any other software
22 // | that it may be combined with.
24 // +----------------------------------------------------------------------+
26 // | https://www.anuko.com/time_tracker/credits.htm
27 // +----------------------------------------------------------------------+
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.
33 require_once('initialize.php');
35 import('form.ActionForm');
36 import('ttReportHelper');
38 // Check whether TCPDF library is available.
39 if (!file_exists('WEB-INF/lib/tcpdf/'))
40 die('TCPDF library is not found in WEB-INF/lib/tcpdf/');
42 // Include TCPDF library.
43 require_once('WEB-INF/lib/tcpdf/tcpdf.php');
46 if (!ttAccessCheck(right_view_reports)) {
47 header('Location: access_denied.php');
51 // Use custom fields plugin if it is enabled.
52 if ($user->isPluginEnabled('cf')) {
53 require_once('plugins/CustomFields.class.php');
54 $custom_fields = new CustomFields($user->team_id);
57 // Report settings are stored in session bean before we get here.
58 $bean = new ActionForm('reportBean', new Form('reportForm'), $request);
60 // There are 2 variations of report: totals only, or normal. Totals only means that the report
61 // is grouped by either date, user, client, project, task or cf_1 and user only needs to see subtotals by group.
62 $totals_only = ($bean->getAttribute('chtotalsonly') == '1');
64 // Determine group by header.
65 $group_by = $bean->getAttribute('group_by');
66 if ('no_grouping' != $group_by) {
67 if ('cf_1' == $group_by)
68 $group_by_header = $custom_fields->fields[0]['label'];
70 $key = 'label.'.$group_by;
71 $group_by_header = $i18n->getKey($key);
75 // Obtain items for report.
77 $items = ttReportHelper::getItems($bean); // Individual entries.
78 if ($totals_only || 'no_grouping' != $group_by)
79 $subtotals = ttReportHelper::getSubtotals($bean); // Subtotals for groups of items.
80 $totals = ttReportHelper::getTotals($bean); // Totals for the entire report.
82 // Assign variables that are used to print subtotals.
83 if ($items && 'no_grouping' != $group_by) {
84 $print_subtotals = true;
86 $prev_grouped_by = '';
90 // Build a string to use as filename for the files being downloaded.
91 $filename = strtolower($i18n->getKey('title.report')).'_'.$bean->mValues['start_date'].'_'.$bean->mValues['end_date'];
93 // Start preparing HTML to build PDF from.
94 $styleHeader = 'style="background-color:#a6ccf7;"';
95 $styleSubtotal = 'style="background-color:#e0e0e0;"';
96 $styleCentered = 'style="text-align:center;"';
97 $styleRightAligned = 'style="text-align:right;"';
99 $title = $i18n->getKey('title.report').": ".$totals['start_date']." - ".$totals['end_date'];
100 $html = '<h1 style="text-align:center;">'.$title.'</h1>';
101 $html .= '<table border="1" cellpadding="3" cellspacing="0" width="100%">';
104 // We are building a "totals only" report with only subtotals and total.
105 $colspan = 1; // Column span for an empty row.
108 $html .= "<tr $styleHeader>";
109 $html .= '<td>'.htmlspecialchars($group_by_header).'</td>';
110 if ($bean->getAttribute('chduration')) { $colspan++; $html .= "<td $styleCentered>".$i18n->getKey('label.duration').'</td>'; }
111 if ($bean->getAttribute('chcost')) { $colspan++; $html .= "<td $styleCentered>".$i18n->getKey('label.cost').'</td>'; }
115 foreach ($subtotals as $subtotal) {
117 $html .= '<td>'.htmlspecialchars($subtotal['name']).'</td>';
118 if ($bean->getAttribute('chduration')) $html .= "<td $styleRightAligned>".$subtotal['time'].'</td>';
119 if ($bean->getAttribute('chcost')) {
120 $html .= "<td $styleRightAligned>";
121 if ($user->canManageTeam() || $user->isClient())
122 $html .= $subtotal['cost'];
124 $html .= $subtotal['expenses'];
130 $html .= '<tr><td colspan="'.$colspan.'"> </td></tr>';
131 $html .= "<tr $styleSubtotal>";
132 $html .= '<td>'.$i18n->getKey('label.total').'</td>';
133 if ($bean->getAttribute('chduration')) $html .= "<td $styleRightAligned>".$totals['time'].'</td>';
134 if ($bean->getAttribute('chcost')) {
135 $html .= "<td $styleRightAligned>";
136 $html .= htmlspecialchars($user->currency).' ';
137 if ($user->canManageTeam() || $user->isClient())
138 $html .= $totals['cost'];
140 $html .= $totals['expenses'];
146 // We are building a normal report with items, optionally grouped with subtotals, and total.
147 $colspan = 1; // Column span for an empty row.
150 $html .= "<tr $styleHeader>";
151 $html .= '<td>'.$i18n->getKey('label.date').'</td>';
152 if ($user->canManageTeam() || $user->isClient()) { $colspan++; $html .= '<td>'.$i18n->getKey('label.user').'</td>'; }
153 if ($bean->getAttribute('chclient')) { $colspan++; $html .= '<td>'.$i18n->getKey('label.client').'</td>'; }
154 if ($bean->getAttribute('chproject')) { $colspan++; $html .= '<td>'.$i18n->getKey('label.project').'</td>'; }
155 if ($bean->getAttribute('chtask')) { $colspan++; $html .= '<td>'.$i18n->getKey('label.task').'</td>'; }
156 if ($bean->getAttribute('chcf_1')) { $colspan++; $html .= '<td>'.htmlspecialchars($custom_fields->fields[0]['label']).'</td>'; }
157 if ($bean->getAttribute('chstart')) { $colspan++; $html .= "<td $styleCentered>".$i18n->getKey('label.start').'</td>'; }
158 if ($bean->getAttribute('chfinish')) { $colspan++; $html .= "<td $styleCentered>".$i18n->getKey('label.finish').'</td>'; }
159 if ($bean->getAttribute('chduration')) { $colspan++; $html .= "<td $styleCentered>".$i18n->getKey('label.duration').'</td>'; }
160 if ($bean->getAttribute('chnote')) { $colspan++; $html .= '<td>'.$i18n->getKey('label.note').'</td>'; }
161 if ($bean->getAttribute('chcost')) { $colspan++; $html .= "<td $styleCentered>".$i18n->getKey('label.cost').'</td>'; }
162 if ($bean->getAttribute('chinvoice')) { $colspan++; $html .= '<td>'.$i18n->getKey('label.invoice').'</td>'; }
166 foreach ($items as $item) {
167 // Print a subtotal for a block of grouped values.
168 $cur_date = $item['date'];
169 if ($print_subtotals) {
170 $cur_grouped_by = $item['grouped_by'];
171 if ($cur_grouped_by != $prev_grouped_by && !$first_pass) {
172 $html .= '<tr style="background-color:#e0e0e0;">';
173 $html .= '<td>'.$i18n->getKey('label.subtotal').'</td>';
174 if ($user->canManageTeam() || $user->isClient()) {
176 if ($group_by == 'user') $html .= htmlspecialchars($subtotals[$prev_grouped_by]['name']);
179 if ($bean->getAttribute('chclient')) {
181 if ($group_by == 'client') $html .= htmlspecialchars($subtotals[$prev_grouped_by]['name']);
184 if ($bean->getAttribute('chproject')) {
186 if ($group_by == 'project') $html .= htmlspecialchars($subtotals[$prev_grouped_by]['name']);
189 if ($bean->getAttribute('chtask')) {
191 if ($group_by == 'task') $html .= htmlspecialchars($subtotals[$prev_grouped_by]['name']);
194 if ($bean->getAttribute('chcf_1')) {
196 if ($group_by == 'cf_1') $html .= htmlspecialchars($subtotals[$prev_grouped_by]['name']);
199 if ($bean->getAttribute('chstart')) $html .= '<td></td>';
200 if ($bean->getAttribute('chfinish')) $html .= '<td></td>';
201 if ($bean->getAttribute('chduration')) $html .= "<td $styleRightAligned>".$subtotals[$prev_grouped_by]['time'].'</td>';
202 if ($bean->getAttribute('chnote')) $html .= '<td></td>';
203 if ($bean->getAttribute('chcost')) {
204 $html .= "<td $styleRightAligned>";
205 if ($user->canManageTeam() || $user->isClient())
206 $html .= $subtotals[$prev_grouped_by]['cost'];
208 $html .= $subtotals[$prev_grouped_by]['expenses'];
211 if ($bean->getAttribute('chinvoice')) $html .= '<td></td>';
213 $html .= '<tr><td colspan="'.$colspan.'"> </td></tr>';
218 // Print a regular row.
220 $html .= '<td>'.$item['date'].'</td>';
221 if ($user->canManageTeam() || $user->isClient()) $html .= '<td>'.htmlspecialchars($item['user']).'</td>';
222 if ($bean->getAttribute('chclient')) $html .= '<td>'.htmlspecialchars($item['client']).'</td>';
223 if ($bean->getAttribute('chproject')) $html .= '<td>'.htmlspecialchars($item['project']).'</td>';
224 if ($bean->getAttribute('chtask')) $html .= '<td>'.htmlspecialchars($item['task']).'</td>';
225 if ($bean->getAttribute('chcf_1')) $html .= '<td>'.htmlspecialchars($item['cf_1']).'</td>';
226 if ($bean->getAttribute('chstart')) $html .= "<td $styleRightAligned>".$item['start'].'</td>';
227 if ($bean->getAttribute('chfinish')) $html .= "<td $styleRightAligned>".$item['finish'].'</td>';
228 if ($bean->getAttribute('chduration')) $html .= "<td $styleRightAligned>".$item['duration'].'</td>';
229 if ($bean->getAttribute('chnote')) $html .= '<td>'.htmlspecialchars($item['note']).'</td>';
230 if ($bean->getAttribute('chcost')) {
231 $html .= "<td $styleRightAligned>";
232 if ($user->canManageTeam() || $user->isClient())
233 $html .= $item['cost'];
235 $html .= $item['expense'];
238 if ($bean->getAttribute('chinvoice')) $html .= '<td>'.htmlspecialchars($item['invoice']).'</td>';
241 $prev_date = $item['date'];
242 if ($print_subtotals) $prev_grouped_by = $item['grouped_by'];
245 // Print a terminating subtotal.
246 if ($print_subtotals) {
247 $html .= '<tr style="background-color:#e0e0e0;">';
248 $html .= '<td>'.$i18n->getKey('label.subtotal').'</td>';
249 if ($user->canManageTeam() || $user->isClient()) {
251 if ($group_by == 'user') $html .= htmlspecialchars($subtotals[$prev_grouped_by]['name']);
254 if ($bean->getAttribute('chclient')) {
256 if ($group_by == 'client') $html .= htmlspecialchars($subtotals[$prev_grouped_by]['name']);
259 if ($bean->getAttribute('chproject')) {
261 if ($group_by == 'project') $html .= htmlspecialchars($subtotals[$prev_grouped_by]['name']);
264 if ($bean->getAttribute('chtask')) {
266 if ($group_by == 'task') $html .= htmlspecialchars($subtotals[$prev_grouped_by]['name']);
269 if ($bean->getAttribute('chcf_1')) {
271 if ($group_by == 'cf_1') $html .= htmlspecialchars($subtotals[$prev_grouped_by]['name']);
274 if ($bean->getAttribute('chstart')) $html .= '<td></td>';
275 if ($bean->getAttribute('chfinish')) $html .= '<td></td>';
276 if ($bean->getAttribute('chduration')) $html .= "<td $styleRightAligned>".$subtotals[$prev_grouped_by]['time'].'</td>';
277 if ($bean->getAttribute('chnote')) $html .= '<td></td>';
278 if ($bean->getAttribute('chcost')) {
279 $html .= "<td $styleRightAligned>";
280 if ($user->canManageTeam() || $user->isClient())
281 $html .= $subtotals[$prev_grouped_by]['cost'];
283 $html .= $subtotals[$prev_grouped_by]['expenses'];
286 if ($bean->getAttribute('chinvoice')) $html .= '<td></td>';
291 $html .= '<tr><td colspan="'.$colspan.'"> </td></tr>';
292 $html .= '<tr style="background-color:#e0e0e0;">';
293 $html .= '<td>'.$i18n->getKey('label.total').'</td>';
294 if ($user->canManageTeam() || $user->isClient()) $html .= '<td></td>';
295 if ($bean->getAttribute('chclient')) $html .= '<td></td>';
296 if ($bean->getAttribute('chproject')) $html .= '<td></td>';
297 if ($bean->getAttribute('chtask')) $html .= '<td></td>';
298 if ($bean->getAttribute('chcf_1')) $html .= '<td></td>';
299 if ($bean->getAttribute('chstart')) $html .= '<td></td>';
300 if ($bean->getAttribute('chfinish')) $html .= '<td></td>';
301 if ($bean->getAttribute('chduration')) $html .= "<td $styleRightAligned>".$totals['time'].'</td>';
302 if ($bean->getAttribute('chnote')) $html .= '<td></td>';
303 if ($bean->getAttribute('chcost')) {
304 $html .= "<td $styleRightAligned>".htmlspecialchars($user->currency).' ';
305 if ($user->canManageTeam() || $user->isClient())
306 $html .= $totals['cost'];
308 $html .= $totals['expenses'];
311 if ($bean->getAttribute('chinvoice')) $html .= '<td></td>';
317 if (!defined('REPORT_FOOTER') || !(REPORT_FOOTER == false)) // By default we print it unless explicitely defined as false.
318 $html .= '<p style="text-align: center;">'.$i18n->getKey('form.mail.footer').'</p>';
320 // By this time we have html ready.
322 // Determine title for report.
323 $title = $i18n->getKey('title.report').": ".$totals['start_date']." - ".$totals['end_date'];
325 header('Pragma: public'); // This is needed for IE8 to download files over https.
326 header('Content-Type: text/html; charset=utf-8');
327 header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
328 header('Cache-Control: no-store, no-cache, must-revalidate');
329 header('Cache-Control: post-check=0, pre-check=0', false);
330 header('Cache-Control: private', false);
332 header('Content-Type: application/pdf');
333 header('Content-Disposition: attachment; filename="'.$filename.'.pdf"');
336 // Beginning of TCPDF code here.
338 // Extend TCPDF class so that we can use custom header and footer.
339 class ttPDF extends TCPDF {
341 public $image_file = 'images/tt_logo.png'; // Image file for the logo in header.
342 public $page_word = 'Page'; // Localized "Page" word in footer, ex: Page 1/2.
344 // SetImageFile - sets image file name.
345 public function SetImageFile($imgFile) {
346 $this->image_file = $imgFile;
349 // SetPageWord - sets page word for footer.
350 public function SetPageWord($pageWord) {
351 $this->page_word = $pageWord;
355 public function Header() {
356 // Print logo, which is the only element of our custom header.
357 $this->Image($this->image_file, 10, 10, '', '', '', '', 'T', false, 300, 'C', false, false, 0, false, false, false);
361 public function Footer() {
362 // Position at 15 mm from bottom.
365 $this->SetFont('freeserif', 'I', 8);
366 // Print localized page number.
367 $this->Cell(0, 10, $this->page_word.' '.$this->getAliasNumPage().'/'.$this->getAliasNbPages(), 0, false, 'C', 0, '', 0, false, 'T', 'M');
371 // Create new PDF document.
372 $pdf = new ttPDF(PDF_PAGE_ORIENTATION, PDF_UNIT, PDF_PAGE_FORMAT, true, 'UTF-8', false);
374 // If custom logo file exists - set it.
375 if (file_exists('images/'.$user->team_id.'.png'))
376 $pdf->SetImageFile('images/'.$user->team_id.'.png');
378 // Set page word for the footer.
379 $pdf->SetPageWord($i18n->getKey('label.page'));
381 // Set document information.
382 $pdf->SetCreator(PDF_CREATOR);
383 $pdf->SetAuthor('Anuko Time Tracker');
384 $pdf->SetTitle('Anuko Time Tracker Report');
385 $pdf->SetSubject('Anuko Time Tracker Report');
386 $pdf->SetKeywords('Anuko, time, tracker, report');
389 $pdf->SetMargins(PDF_MARGIN_LEFT, PDF_MARGIN_TOP, PDF_MARGIN_RIGHT);
390 $pdf->SetHeaderMargin(PDF_MARGIN_HEADER);
391 $pdf->SetFooterMargin(PDF_MARGIN_FOOTER);
393 // Set auto page breaks.
394 $pdf->SetAutoPageBreak(TRUE, PDF_MARGIN_BOTTOM);
396 // Set image scale factor.
397 $pdf->setImageScale(PDF_IMAGE_SCALE_RATIO);
402 // Set font (freeserif seems to work for all languages).
403 $pdf->SetFont('freeserif', '', 10); // helvetica here does not work for Russian.
406 $pdf->writeHTML($html, true, false, false, false, '');
408 // Close and output PDF document.
409 // $pdf->Output('timesheet.pdf', 'I'); // This will display inline in browser.
410 $pdf->Output($filename.'.pdf', 'D'); // D is for downloads.
412 // End of of TCPDF code.