added export module (#538)

src/Export/Renderer/AbstractSpreadsheetRenderer.php

@@ -0,0 +1,215 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Export\Renderer;
+
+use App\Entity\Timesheet;
+use App\Repository\Query\TimesheetQuery;
+use App\Twig\DateExtensions;
+use App\Twig\Extensions;
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\ResponseHeaderBag;
+use Symfony\Component\Translation\TranslatorInterface;
+
+abstract class AbstractSpreadsheetRenderer
+{
+    /**
+     * @var DateExtensions
+     */
+    protected $dateExtension;
+
+    /**
+     * @var Extensions
+     */
+    protected $extension;
+
+    /**
+     * @var TranslatorInterface
+     */
+    protected $translator;
+
+    /**
+     * @param TranslatorInterface $translator
+     * @param DateExtensions $dateExtension
+     * @param Extensions $extensions
+     */
+    public function __construct(TranslatorInterface $translator, DateExtensions $dateExtension, Extensions $extensions)
+    {
+        $this->translator = $translator;
+        $this->dateExtension = $dateExtension;
+        $this->extension = $extensions;
+    }
+
+    /**
+     * @param \DateTime $date
+     * @return mixed
+     */
+    protected function getFormattedDateTime(\DateTime $date)
+    {
+        return $this->dateExtension->dateShort($date) . ' ' . date('H:i', $date->getTimestamp());
+    }
+
+    /**
+     * @param $amount
+     * @return mixed
+     */
+    protected function getFormattedMoney($amount, $currency)
+    {
+        return $this->extension->money($amount, $currency);
+    }
+
+    /**
+     * @param Timesheet $timesheet
+     * @return string
+     */
+    protected function getUsername(Timesheet $timesheet)
+    {
+        if (!empty($timesheet->getUser()->getAlias())) {
+            return $timesheet->getUser()->getAlias();
+        }
+
+        return $timesheet->getUser()->getUsername();
+    }
+
+    /**
+     * @param $seconds
+     * @return mixed
+     */
+    protected function getFormattedDuration($seconds)
+    {
+        return $this->extension->duration($seconds);
+    }
+
+    /**
+     * @param Timesheet[] $timesheets
+     * @param TimesheetQuery $query
+     * @return Spreadsheet
+     * @throws \PhpOffice\PhpSpreadsheet\Exception
+     */
+    protected function fromArrayToSpreadsheet(array $timesheets, TimesheetQuery $query): Spreadsheet
+    {
+        $spreadsheet = new Spreadsheet();
+        $sheet = $spreadsheet->getActiveSheet();
+
+        $recordsHeaderColumn = 1;
+        $recordsHeaderRow = 1;
+
+        $sheet->setCellValueByColumnAndRow($recordsHeaderColumn++, $recordsHeaderRow, $this->translator->trans('label.begin'));
+        $sheet->setCellValueByColumnAndRow($recordsHeaderColumn++, $recordsHeaderRow, $this->translator->trans('label.end'));
+        $sheet->setCellValueByColumnAndRow($recordsHeaderColumn++, $recordsHeaderRow, $this->translator->trans('label.user'));
+        $sheet->setCellValueByColumnAndRow($recordsHeaderColumn++, $recordsHeaderRow, $this->translator->trans('label.customer'));
+        $sheet->setCellValueByColumnAndRow($recordsHeaderColumn++, $recordsHeaderRow, $this->translator->trans('label.project'));
+        $sheet->setCellValueByColumnAndRow($recordsHeaderColumn++, $recordsHeaderRow, $this->translator->trans('label.activity'));
+        $sheet->setCellValueByColumnAndRow($recordsHeaderColumn++, $recordsHeaderRow, $this->translator->trans('label.description'));
+        $sheet->setCellValueByColumnAndRow($recordsHeaderColumn++, $recordsHeaderRow, $this->translator->trans('label.exported'));
+        $sheet->setCellValueByColumnAndRow($recordsHeaderColumn++, $recordsHeaderRow, $this->translator->trans('label.hourly_rate'));
+        $sheet->setCellValueByColumnAndRow($recordsHeaderColumn++, $recordsHeaderRow, $this->translator->trans('label.fixed_rate'));
+        $sheet->setCellValueByColumnAndRow($recordsHeaderColumn++, $recordsHeaderRow, $this->translator->trans('label.duration'));
+        $sheet->setCellValueByColumnAndRow($recordsHeaderColumn++, $recordsHeaderRow, $this->translator->trans('label.rate'));
+
+        $entryHeaderRow = $recordsHeaderRow + 1;
+
+        $durationTotal = 0;
+        $currency = false;
+        $rateTotal = 0;
+
+        foreach ($timesheets as $timesheet) {
+            $entryHeaderColumn = 1;
+
+            $durationTotal += $timesheet->getDuration();
+            $rateTotal += $timesheet->getRate();
+            if ($currency === false) {
+                $currency = $timesheet->getProject()->getCustomer()->getCurrency();
+            }
+            if ($currency !== $timesheet->getProject()->getCustomer()->getCurrency()) {
+                $currency = null;
+            }
+
+            $customerCurrency = $timesheet->getProject()->getCustomer()->getCurrency();
+
+            $exported = $timesheet->isExported() ? 'entryState.exported' : 'entryState.not_exported';
+
+            $sheet->setCellValueByColumnAndRow($entryHeaderColumn++, $entryHeaderRow, $this->getFormattedDateTime($timesheet->getBegin()));
+            $sheet->setCellValueByColumnAndRow($entryHeaderColumn++, $entryHeaderRow, $this->getFormattedDateTime($timesheet->getEnd()));
+            $sheet->setCellValueByColumnAndRow($entryHeaderColumn++, $entryHeaderRow, $this->getUsername($timesheet));
+            $sheet->setCellValueByColumnAndRow($entryHeaderColumn++, $entryHeaderRow, $timesheet->getProject()->getCustomer()->getName());
+            $sheet->setCellValueByColumnAndRow($entryHeaderColumn++, $entryHeaderRow, $timesheet->getProject()->getName());
+            $sheet->setCellValueByColumnAndRow($entryHeaderColumn++, $entryHeaderRow, $timesheet->getActivity()->getName());
+            $sheet->setCellValueByColumnAndRow($entryHeaderColumn++, $entryHeaderRow, $timesheet->getDescription());
+            $sheet->setCellValueByColumnAndRow($entryHeaderColumn++, $entryHeaderRow, $this->translator->trans($exported));
+            $sheet->setCellValueByColumnAndRow($entryHeaderColumn++, $entryHeaderRow, $this->getFormattedMoney($timesheet->getHourlyRate(), $customerCurrency));
+            $sheet->setCellValueByColumnAndRow($entryHeaderColumn++, $entryHeaderRow, $this->getFormattedMoney($timesheet->getFixedRate(), $customerCurrency));
+            $sheet->setCellValueByColumnAndRow($entryHeaderColumn++, $entryHeaderRow, $this->getFormattedDuration($timesheet->getDuration()));
+            $sheet->setCellValueByColumnAndRow($entryHeaderColumn++, $entryHeaderRow, $this->getFormattedMoney($timesheet->getRate(), $customerCurrency));
+
+            $entryHeaderRow++;
+        }
+
+        $sheet->setCellValueByColumnAndRow(11, $entryHeaderRow, $this->getFormattedDuration($durationTotal));
+        $sheet->setCellValueByColumnAndRow(12, $entryHeaderRow, $this->getFormattedMoney($rateTotal, $currency));
+        $sheet->getCellByColumnAndRow(11, $entryHeaderRow)->getStyle()->getBorders()->getTop()->setBorderStyle(\PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THIN);
+        $sheet->getCellByColumnAndRow(11, $entryHeaderRow)->getStyle()->getFont()->setBold(true);
+
+        $sheet->getCellByColumnAndRow(12, $entryHeaderRow)->getStyle()->getBorders()->getTop()->setBorderStyle(\PhpOffice\PhpSpreadsheet\Style\Border::BORDER_THIN);
+        $sheet->getCellByColumnAndRow(12, $entryHeaderRow)->getStyle()->getFont()->setBold(true);
+
+        return $spreadsheet;
+    }
+
+    /**
+     * @param Timesheet[] $timesheets
+     * @param TimesheetQuery $query
+     * @return Response
+     * @throws \PhpOffice\PhpSpreadsheet\Exception
+     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
+     */
+    public function render(array $timesheets, TimesheetQuery $query): Response
+    {
+        $spreadsheet = $this->fromArrayToSpreadsheet($timesheets, $query);
+        $filename = $this->saveSpreadsheet($spreadsheet);
+
+        return $this->getFileResponse($filename, 'kimai-export' . $this->getFileExtension());
+    }
+
+    /**
+     * @return string
+     */
+    abstract public function getFileExtension(): string;
+
+    /**
+     * @param mixed $file
+     * @param string $filename
+     * @return BinaryFileResponse
+     */
+    protected function getFileResponse($file, $filename): Response
+    {
+        $response = new BinaryFileResponse($file);
+        $disposition = $response->headers->makeDisposition(ResponseHeaderBag::DISPOSITION_ATTACHMENT, $filename);
+
+        $response->headers->set('Content-Type', $this->getContentType());
+        $response->headers->set('Content-Disposition', $disposition);
+        $response->deleteFileAfterSend(true);
+
+        return $response;
+    }
+
+    /**
+     * @return string
+     */
+    abstract protected function getContentType(): string;
+
+    /**
+     * @param Spreadsheet $spreadsheet
+     * @return string
+     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
+     */
+    abstract protected function saveSpreadsheet(Spreadsheet $spreadsheet): string;
+}

src/Export/Renderer/CsvRenderer.php

@@ -0,0 +1,71 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Export\Renderer;
+
+use App\Export\RendererInterface;
+use PhpOffice\PhpSpreadsheet\IOFactory;
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+
+class CsvRenderer extends AbstractSpreadsheetRenderer implements RendererInterface
+{
+    /**
+     * @return string
+     */
+    public function getFileExtension(): string
+    {
+        return '.csv';
+    }
+
+    /**
+     * @return string
+     */
+    protected function getContentType(): string
+    {
+        return 'text/csv';
+    }
+
+    /**
+     * @param Spreadsheet $spreadsheet
+     * @return bool|string
+     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
+     */
+    protected function saveSpreadsheet(Spreadsheet $spreadsheet): string
+    {
+        $filename = tempnam(sys_get_temp_dir(), 'kimai-export-csv');
+        $writer = IOFactory::createWriter($spreadsheet, 'Csv');
+        $writer->save($filename);
+
+        return $filename;
+    }
+
+    /**
+     * @return string
+     */
+    public function getId(): string
+    {
+        return 'csv';
+    }
+
+    /**
+     * @return string
+     */
+    public function getIcon(): string
+    {
+        return 'csv';
+    }
+
+    /**
+     * @return string
+     */
+    public function getTitle(): string
+    {
+        return 'csv';
+    }
+}

src/Export/Renderer/HtmlRenderer.php

@@ -0,0 +1,79 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Export\Renderer;
+
+use App\Entity\Timesheet;
+use App\Export\RendererInterface;
+use App\Repository\Query\TimesheetQuery;
+use Symfony\Component\HttpFoundation\Response;
+
+class HtmlRenderer implements RendererInterface
+{
+    use RendererTrait;
+
+    /**
+     * @var \Twig_Environment
+     */
+    protected $twig;
+
+    /**
+     * @param \Twig_Environment $twig
+     */
+    public function __construct(\Twig_Environment $twig)
+    {
+        $this->twig = $twig;
+    }
+
+    /**
+     * @param Timesheet[] $timesheets
+     * @param TimesheetQuery $query
+     * @return Response
+     * @throws \Twig_Error_Loader
+     * @throws \Twig_Error_Runtime
+     * @throws \Twig_Error_Syntax
+     */
+    public function render(array $timesheets, TimesheetQuery $query): Response
+    {
+        $content = $this->twig->render('export/renderer/default.html.twig', [
+            'entries' => $timesheets,
+            'query' => $query,
+            'summaries' => $this->calculateSummary($timesheets),
+        ]);
+
+        $response = new Response();
+        $response->setContent($content);
+
+        return $response;
+    }
+
+    /**
+     * @return string
+     */
+    public function getId(): string
+    {
+        return 'html';
+    }
+
+    /**
+     * @return string
+     */
+    public function getIcon(): string
+    {
+        return 'print';
+    }
+
+    /**
+     * @return string
+     */
+    public function getTitle(): string
+    {
+        return 'print';
+    }
+}

src/Export/Renderer/OdsRenderer.php

@@ -0,0 +1,71 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Export\Renderer;
+
+use App\Export\RendererInterface;
+use PhpOffice\PhpSpreadsheet\IOFactory;
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+
+class OdsRenderer extends AbstractSpreadsheetRenderer implements RendererInterface
+{
+    /**
+     * @return string
+     */
+    public function getFileExtension(): string
+    {
+        return '.ods';
+    }
+
+    /**
+     * @return string
+     */
+    protected function getContentType(): string
+    {
+        return 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
+    }
+
+    /**
+     * @param Spreadsheet $spreadsheet
+     * @return bool|string
+     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
+     */
+    protected function saveSpreadsheet(Spreadsheet $spreadsheet): string
+    {
+        $filename = tempnam(sys_get_temp_dir(), 'kimai-export-ods');
+        $writer = IOFactory::createWriter($spreadsheet, 'Ods');
+        $writer->save($filename);
+
+        return $filename;
+    }
+
+    /**
+     * @return string
+     */
+    public function getId(): string
+    {
+        return 'ods';
+    }
+
+    /**
+     * @return string
+     */
+    public function getIcon(): string
+    {
+        return 'ods';
+    }
+
+    /**
+     * @return string
+     */
+    public function getTitle(): string
+    {
+        return 'ods';
+    }
+}

src/Export/Renderer/PDFRenderer.php

@@ -0,0 +1,94 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Export\Renderer;
+
+use App\Entity\Timesheet;
+use App\Export\RendererInterface;
+use App\Repository\Query\TimesheetQuery;
+use Mpdf\Mpdf;
+use Mpdf\Output\Destination;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\ResponseHeaderBag;
+
+class PDFRenderer implements RendererInterface
+{
+    use RendererTrait;
+
+    /**
+     * @var \Twig_Environment
+     */
+    protected $twig;
+
+    /**
+     * @param \Twig_Environment $twig
+     */
+    public function __construct(\Twig_Environment $twig)
+    {
+        $this->twig = $twig;
+    }
+
+    /**
+     * @param Timesheet[] $timesheets
+     * @param TimesheetQuery $query
+     * @return Response
+     * @throws \Mpdf\MpdfException
+     * @throws \Twig_Error_Loader
+     * @throws \Twig_Error_Runtime
+     * @throws \Twig_Error_Syntax
+     */
+    public function render(array $timesheets, TimesheetQuery $query): Response
+    {
+        $content = $this->twig->render('export/renderer/pdf.html.twig', [
+            'entries' => $timesheets,
+            'query' => $query,
+            'now' => new \DateTime(),
+            'summaries' => $this->calculateSummary($timesheets),
+        ]);
+
+        //return new Response($content);
+
+        $mpdf = new Mpdf();
+        $mpdf->WriteHTML($content);
+        $content = $mpdf->Output('test', Destination::STRING_RETURN);
+
+        $response = new Response($content);
+
+        $disposition = $response->headers->makeDisposition(ResponseHeaderBag::DISPOSITION_ATTACHMENT, 'kimai-export.pdf');
+
+        $response->headers->set('Content-Type', 'application/pdf');
+        $response->headers->set('Content-Disposition', $disposition);
+
+        return $response;
+    }
+
+    /**
+     * @return string
+     */
+    public function getId(): string
+    {
+        return 'pdf';
+    }
+
+    /**
+     * @return string
+     */
+    public function getIcon(): string
+    {
+        return 'pdf';
+    }
+
+    /**
+     * @return string
+     */
+    public function getTitle(): string
+    {
+        return 'pdf';
+    }
+}

src/Export/Renderer/RendererTrait.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Export\Renderer;
+
+use App\Entity\Timesheet;
+
+trait RendererTrait
+{
+    /**
+     * @param Timesheet[] $timesheets
+     * @return array
+     */
+    protected function calculateSummary(array $timesheets)
+    {
+        $summary = [];
+
+        foreach ($timesheets as $timesheet) {
+            $id = $timesheet->getProject()->getCustomer()->getId() . '_' . $timesheet->getProject()->getId();
+            if (!isset($summary[$id])) {
+                $summary[$id] = [
+                    'customer' => $timesheet->getProject()->getCustomer()->getName(),
+                    'project' => $timesheet->getProject()->getName(),
+                    'currency' => $timesheet->getProject()->getCustomer()->getCurrency(),
+                    'rate' => 0,
+                    'duration' => 0,
+                ];
+            }
+            $summary[$id]['rate'] += $timesheet->getRate();
+            $summary[$id]['duration'] += $timesheet->getDuration();
+        }
+
+        asort($summary);
+
+        return $summary;
+    }
+}

src/Export/Renderer/XlsxRenderer.php

@@ -0,0 +1,71 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Export\Renderer;
+
+use App\Export\RendererInterface;
+use PhpOffice\PhpSpreadsheet\IOFactory;
+use PhpOffice\PhpSpreadsheet\Spreadsheet;
+
+class XlsxRenderer extends AbstractSpreadsheetRenderer implements RendererInterface
+{
+    /**
+     * @return string
+     */
+    public function getFileExtension(): string
+    {
+        return '.xlsx';
+    }
+
+    /**
+     * @return string
+     */
+    protected function getContentType(): string
+    {
+        return 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';
+    }
+
+    /**
+     * @param Spreadsheet $spreadsheet
+     * @return bool|string
+     * @throws \PhpOffice\PhpSpreadsheet\Writer\Exception
+     */
+    protected function saveSpreadsheet(Spreadsheet $spreadsheet): string
+    {
+        $filename = tempnam(sys_get_temp_dir(), 'kimai-export-xlsx');
+        $writer = IOFactory::createWriter($spreadsheet, 'Xlsx');
+        $writer->save($filename);
+
+        return $filename;
+    }
+
+    /**
+     * @return string
+     */
+    public function getId(): string
+    {
+        return 'xlsx';
+    }
+
+    /**
+     * @return string
+     */
+    public function getIcon(): string
+    {
+        return 'xlsx';
+    }
+
+    /**
+     * @return string
+     */
+    public function getTitle(): string
+    {
+        return 'xlsx';
+    }
+}

src/Export/RendererInterface.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Export;
+
+use App\Entity\Timesheet;
+use App\Repository\Query\TimesheetQuery;
+use Symfony\Component\HttpFoundation\Response;
+
+interface RendererInterface
+{
+    /**
+     * @param Timesheet[] $timesheets
+     * @param TimesheetQuery $query
+     * @return Response
+     */
+    public function render(array $timesheets, TimesheetQuery $query): Response;
+
+    /**
+     * @return string
+     */
+    public function getId(): string;
+
+    /**
+     * @return string
+     */
+    public function getIcon(): string;
+
+    /**
+     * @return string
+     */
+    public function getTitle(): string;
+}

src/Export/ServiceExport.php

@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Export;
+
+class ServiceExport
+{
+    /**
+     * @var RendererInterface[]
+     */
+    protected $renderer = [];
+
+    /**
+     * @param RendererInterface $renderer
+     * @return $this
+     */
+    public function addRenderer(RendererInterface $renderer)
+    {
+        $this->renderer[] = $renderer;
+
+        return $this;
+    }
+
+    /**
+     * Returns an array of export renderer.
+     *
+     * @return RendererInterface[]
+     */
+    public function getRenderer()
+    {
+        return $this->renderer;
+    }
+
+    /**
+     * @param string $id
+     * @return RendererInterface|null
+     */
+    public function getRendererById(string $id)
+    {
+        foreach ($this->renderer as $renderer) {
+            if ($renderer->getId() === $id) {
+                return $renderer;
+            }
+        }
+
+        return null;
+    }
+}