refactored invoice and export screens (kimai#1046)

UPGRADING.md

@@ -10,13 +10,17 @@ Perform EACH version specific task between your version and the new one, otherwi
 
 ## [1.2](https://github.com/kevinpapst/kimai2/releases/tag/1.2)
 
-### BC breaks
+### Possible BC breaks
 
 - Deleted timezone conversion command. If you are still using 0.7 or below, you need to upgrade to 1.1 before upgrading to this version.
 - Minimum password length raised from 5 to 8 character (applies only for password changes and new users)
 - Maximum customer name length lowered to 150 character
 - Maximum project name length lowered to 150 character
 - Maximum activity name length lowered to 150 character
+- Added new permission: `manage_invoice_template`
+ - Removed permissions: `view_invoice_template`, `create_invoice_template`, `edit_invoice_template`, `delete_invoice_template`
+- Removed permission: `view_invoice` (using `create_export` only)
+- Export renderer need to check usage of `Timesheet::getEnd()` as running entries can now be exported as well
 
 ## [1.1](https://github.com/kevinpapst/kimai2/releases/tag/1.1)
 

config/packages/kimai.yaml

@@ -90,7 +90,7 @@ kimai:
  CUSTOMERS: ['view_customer','create_customer','edit_customer','budget_customer','delete_customer','permissions_customer']
  CUSTOMERS_TEAM: ['view_customer','edit_teamlead_customer','budget_teamlead_customer']
  INVOICE: ['view_invoice','create_invoice']
- INVOICE_TEMPLATE: ['view_invoice_template','create_invoice_template','edit_invoice_template','delete_invoice_template']
+ INVOICE_TEMPLATE: ['manage_invoice_template']
  TIMESHEET: ['view_own_timesheet','start_own_timesheet','stop_own_timesheet','create_own_timesheet','edit_own_timesheet','export_own_timesheet','delete_own_timesheet']
  TIMESHEET_OTHER: ['view_other_timesheet','start_other_timesheet','stop_other_timesheet','create_other_timesheet','edit_other_timesheet','export_other_timesheet','delete_other_timesheet']
  PROFILE: ['view_own_profile','edit_own_profile','password_own_profile','preferences_own_profile','api-token_own_profile']
@@ -99,16 +99,16 @@ kimai:
  USER: ['view_user','create_user','delete_user','role_permissions']
  RATE: ['view_rate_own_timesheet','edit_rate_own_timesheet']
  RATE_OTHER: ['view_rate_other_timesheet','edit_rate_other_timesheet']
- EXPORT: ['view_export','create_export','edit_export_own_timesheet','edit_export_other_timesheet']
+ EXPORT: ['create_export','edit_export_own_timesheet','edit_export_other_timesheet']
  TEAMS: ['view_team','create_team','edit_team','delete_team']
  # some single default definitions for roles 
  SINGLE_USER: []
- SINGLE_TEAMLEAD: ['!delete_invoice_template','view_rate_own_timesheet','view_rate_other_timesheet','hourly-rate_own_profile']
+ SINGLE_TEAMLEAD: ['view_rate_own_timesheet','view_rate_other_timesheet','hourly-rate_own_profile']
  SINGLE_ADMIN: ['hourly-rate_own_profile','edit_exported_timesheet','teams_own_profile']
  SINGLE_SUPER_ADMIN: ['hourly-rate_own_profile','hourly-rate_other_profile','delete_own_profile','roles_own_profile','system_information','system_configuration','plugins','edit_exported_timesheet','teams_own_profile']
  # link above sets to one set for each user role
  ROLE_USER: ['@TIMESHEET','@PROFILE']
- ROLE_TEAMLEAD: ['@ACTIVITIES_TEAM','@PROJECTS_TEAM','@CUSTOMERS_TEAM','@TIMESHEET_OTHER','@INVOICE','@TIMESHEET','@PROFILE','@EXPORT','@TAGS','@INVOICE_TEMPLATE','@SINGLE_TEAMLEAD']
+ ROLE_TEAMLEAD: ['@ACTIVITIES_TEAM','@PROJECTS_TEAM','@CUSTOMERS_TEAM','@TIMESHEET_OTHER','@INVOICE','@TIMESHEET','@PROFILE','@EXPORT','@TAGS','@SINGLE_TEAMLEAD']
  ROLE_ADMIN: ['@ACTIVITIES','@PROJECTS','@CUSTOMERS','@INVOICE','@INVOICE_TEMPLATE','@TIMESHEET','@TIMESHEET_OTHER','@PROFILE','@TEAMS','@RATE','@RATE_OTHER','@EXPORT','@TAGS','@SINGLE_ADMIN']
  ROLE_SUPER_ADMIN: ['@ACTIVITIES','@PROJECTS','@CUSTOMERS','@INVOICE','@INVOICE_TEMPLATE','@TIMESHEET','@TIMESHEET_OTHER','@PROFILE','@PROFILE_OTHER','@USER','@TEAMS','@RATE','@RATE_OTHER','@EXPORT','@TAGS','@SINGLE_SUPER_ADMIN']
  # mapping "sets" or permissions to user roles ("role name" = [array of "set names"])

phpstan.neon

@@ -3,6 +3,7 @@ includes:
  - vendor/phpstan/phpstan-doctrine/extension.neon
 
 parameters:
+ tmpDir: %rootDir%/../../../var/cache/phpstan
  autoload_directories:
  - %rootDir%/../../../src/Migrations
 # symfony:

src/Controller/ExportController.php

@@ -17,6 +17,7 @@
 use App\Timesheet\UserDateTimeFactory;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
 use Symfony\Component\Form\FormInterface;
+use Symfony\Component\Form\SubmitButton;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Annotation\Route;
@@ -25,7 +26,7 @@
  * Controller used to export timesheet data.
  *
  * @Route(path="/export")
- * @Security("is_granted('view_export')")
+ * @Security("is_granted('create_export')")
  */
 class ExportController extends AbstractController
 {
@@ -54,61 +55,45 @@ public function __construct(TimesheetRepository $timesheet, ServiceExport $expor
  $this->dateFactory = $dateTime;
  }
 
- /**
- * @return ExportQuery
- * @throws \Exception
- */
- protected function getDefaultQuery()
- {
- $begin = $this->dateFactory->createDateTime('first day of this month 00:00:00');
- $end = $this->dateFactory->createDateTime('last day of this month 23:59:59');
-
- $query = new ExportQuery();
- $query->setOrder(ExportQuery::ORDER_ASC);
- $query->setBegin($begin);
- $query->setEnd($end);
- $query->setState(ExportQuery::STATE_STOPPED);
- $query->setExported(ExportQuery::STATE_NOT_EXPORTED);
- $query->setCurrentUser($this->getUser());
-
- return $query;
- }
-
  /**
  * @Route(path="/", name="export", methods={"GET"})
- * @Security("is_granted('view_export')")
- *
- * @param Request $request
- * @return Response
- * @throws \Exception
  */
- public function indexAction(Request $request)
+ public function indexAction(Request $request): Response
  {
  $query = $this->getDefaultQuery();
 
+ $showPreview = false;
+ $maxItemsPreview = 500;
+ $entries = [];
+
  $form = $this->getToolbarForm($query, 'GET');
  $form->setData($query);
  $form->submit($request->query->all(), false);
 
- $entries = $this->getEntries($query);
+ if ($form->isValid()) {
+ /** @var SubmitButton $previewButton */
+ $previewButton = $form->get('preview');
+ if ($previewButton->isClicked()) {
+ $showPreview = true;
+ $query->setPageSize($maxItemsPreview);
+ $entries = $this->getEntries($query);
+ }
+ }
 
  return $this->render('export/index.html.twig', [
  'query' => $query,
  'entries' => $entries,
  'form' => $form->createView(),
  'renderer' => $this->export->getRenderer(),
+ 'preview_max' => $maxItemsPreview,
+ 'preview_show' => $showPreview,
  ]);
  }
 
  /**
  * @Route(path="/data", name="export_data", methods={"POST"})
- * @Security("is_granted('create_export')")
- *
- * @param Request $request
- * @return Response
- * @throws \Exception
  */
- public function export(Request $request)
+ public function export(Request $request): Response
  {
  $query = $this->getDefaultQuery();
 
@@ -127,8 +112,29 @@ public function export(Request $request)
  }
 
  $entries = $this->getEntries($query);
+ $response = $renderer->render($entries, $query);
+
+ if ($query->isMarkAsExported()) {
+ $this->timesheetRepository->setExported($entries);
+ }
+
+ return $response;
+ }
+
+ protected function getDefaultQuery(): ExportQuery
+ {
+ $begin = $this->dateFactory->createDateTime('first day of this month 00:00:00');
+ $end = $this->dateFactory->createDateTime('last day of this month 23:59:59');
 
- return $renderer->render($entries, $query);
+ $query = new ExportQuery();
+ $query->setOrder(ExportQuery::ORDER_ASC);
+ $query->setBegin($begin);
+ $query->setEnd($end);
+ $query->setState(ExportQuery::STATE_STOPPED);
+ $query->setExported(ExportQuery::STATE_NOT_EXPORTED);
+ $query->setCurrentUser($this->getUser());
+
+ return $query;
  }
 
  /**