mirror of
https://gitlab.com/Chill-Projet/chill-bundles.git
synced 2025-06-07 18:44:08 +00:00
550 lines
19 KiB
PHP
550 lines
19 KiB
PHP
<?php
|
|
|
|
/*
|
|
* Chill is a software for social workers
|
|
*
|
|
* Copyright (C) 2014-2015, Champs Libres Cooperative SCRLFS,
|
|
* <http://www.champs-libres.coop>
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
namespace Chill\MainBundle\Controller;
|
|
|
|
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
|
|
use Symfony\Component\HttpFoundation\Request;
|
|
use Chill\MainBundle\Form\Type\Export\ExportType;
|
|
use Chill\MainBundle\Form\Type\Export\FormatterType;
|
|
use Symfony\Component\Form\Extension\Core\Type\FormType;
|
|
use Chill\MainBundle\Form\Type\Export\PickCenterType;
|
|
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
|
|
use Chill\MainBundle\Export\ExportManager;
|
|
use Psr\Log\LoggerInterface;
|
|
use Symfony\Component\HttpFoundation\Session\SessionInterface;
|
|
use Symfony\Component\Form\FormFactoryInterface;
|
|
use Chill\MainBundle\Redis\ChillRedis;
|
|
use Symfony\Component\Translation\TranslatorInterface;
|
|
|
|
/**
|
|
* Class ExportController
|
|
* Controller used for exporting data.
|
|
*
|
|
* @package Chill\MainBundle\Controller
|
|
*/
|
|
class ExportController extends AbstractController
|
|
{
|
|
|
|
/**
|
|
*
|
|
* @var ExportManager
|
|
*/
|
|
protected $exportManager;
|
|
|
|
/**
|
|
*
|
|
* @var LoggerInterface
|
|
*/
|
|
protected $logger;
|
|
|
|
/**
|
|
*
|
|
* @var SessionInterface
|
|
*/
|
|
protected $session;
|
|
|
|
/**
|
|
*
|
|
* @var FormFactoryInterface
|
|
*/
|
|
protected $formFactory;
|
|
|
|
/**
|
|
*
|
|
* @var ChillRedis
|
|
*/
|
|
protected $redis;
|
|
|
|
/**
|
|
*
|
|
* @var TranslatorInterface
|
|
*/
|
|
protected $translator;
|
|
|
|
public function __construct(
|
|
ChillRedis $chillRedis,
|
|
ExportManager $exportManager,
|
|
FormFactoryInterface $formFactory,
|
|
LoggerInterface $logger,
|
|
SessionInterface $session,
|
|
TranslatorInterface $translator
|
|
) {
|
|
$this->redis = $chillRedis;
|
|
$this->exportManager = $exportManager;
|
|
$this->formFactory = $formFactory;
|
|
$this->logger = $logger;
|
|
$this->session = $session;
|
|
$this->translator = $translator;
|
|
}
|
|
|
|
|
|
/**
|
|
* Render the list of available exports
|
|
*
|
|
* @param Request $request
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
public function indexAction(Request $request)
|
|
{
|
|
$exportManager = $this->exportManager;
|
|
|
|
$exports = $exportManager->getExportsGrouped(true);
|
|
|
|
return $this->render('@ChillMain/Export/layout.html.twig', array(
|
|
'grouped_exports' => $exports
|
|
));
|
|
}
|
|
|
|
/**
|
|
* handle the step to build a query for an export
|
|
*
|
|
* This action has three steps :
|
|
*
|
|
* 1.'export', the export form. When the form is posted, the data is stored
|
|
* in the session (if valid), and then a redirection is done to next step.
|
|
* 2. 'formatter', the formatter form. When the form is posted, the data is
|
|
* stored in the session (if valid), and then a redirection is done to next step.
|
|
* 3. 'generate': gather data from session from the previous steps, and
|
|
* make a redirection to the "generate" action with data in query (HTTP GET)
|
|
*
|
|
* @param string $request
|
|
* @param Request $alias
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
public function newAction(Request $request, $alias)
|
|
{
|
|
// first check for ACL
|
|
$exportManager = $this->exportManager;
|
|
$export = $exportManager->getExport($alias);
|
|
|
|
if ($exportManager->isGrantedForElement($export) === FALSE) {
|
|
throw $this->createAccessDeniedException('The user does not have access to this export');
|
|
}
|
|
|
|
$step = $request->query->getAlpha('step', 'centers');
|
|
|
|
switch ($step) {
|
|
case 'centers':
|
|
return $this->selectCentersStep($request, $export, $alias);
|
|
case 'export':
|
|
return $this->exportFormStep($request, $export, $alias);
|
|
break;
|
|
case 'formatter':
|
|
return $this->formatterFormStep($request, $export, $alias);
|
|
break;
|
|
case 'generate':
|
|
return $this->forwardToGenerate($request, $export, $alias);
|
|
break;
|
|
default:
|
|
throw $this->createNotFoundException("The given step '$step' is invalid");
|
|
}
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param Request $request
|
|
* @param \Chill\MainBundle\Export\ExportInterface|\Chill\MainBundle\Export\DirectExportInterface $export
|
|
* @param string $alias
|
|
* @return Response
|
|
* @throws type
|
|
*/
|
|
protected function selectCentersStep(Request $request, $export, $alias)
|
|
{
|
|
/* @var $exportManager \Chill\MainBundle\Export\ExportManager */
|
|
$exportManager = $this->exportManager;
|
|
|
|
$form = $this->createCreateFormExport($alias, 'centers');
|
|
|
|
if ($request->getMethod() === 'POST') {
|
|
$form->handleRequest($request);
|
|
if ($form->isValid()) {
|
|
$this->logger->debug('form centers is valid', array(
|
|
'location' => __METHOD__));
|
|
|
|
$data = $form->getData();
|
|
|
|
// check ACL
|
|
if ($exportManager->isGrantedForElement($export, NULL,
|
|
$exportManager->getPickedCenters($data['centers'])) === FALSE) {
|
|
throw $this->createAccessDeniedException('you do not have '
|
|
. 'access to this export for those centers');
|
|
}
|
|
|
|
$this->session->set('centers_step_raw',
|
|
$request->request->all());
|
|
$this->session->set('centers_step', $data);
|
|
|
|
return $this->redirectToRoute('chill_main_export_new', array(
|
|
'step' => $this->getNextStep('centers', $export),
|
|
'alias' => $alias
|
|
));
|
|
|
|
}
|
|
}
|
|
|
|
return $this->render('@ChillMain/Export/new_centers_step.html.twig',
|
|
array(
|
|
'form' => $form->createView(),
|
|
'export' => $export
|
|
));
|
|
}
|
|
|
|
/**
|
|
* Render the export form
|
|
*
|
|
* When the method is POST, the form is stored if valid, and a redirection
|
|
* is done to next step.
|
|
*
|
|
* @param string $alias
|
|
* @param \Chill\MainBundle\Export\ExportInterface|\Chill\MainBundle\Export\DirectExportInterface $export
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
protected function exportFormStep(Request $request, $export, $alias)
|
|
{
|
|
$exportManager = $this->exportManager;
|
|
|
|
// check we have data from the previous step (export step)
|
|
$data = $this->session->get('centers_step', null);
|
|
|
|
if ($data === null) {
|
|
|
|
return $this->redirectToRoute('chill_main_export_new', array(
|
|
'step' => $this->getNextStep('export', $export, true),
|
|
'alias' => $alias
|
|
));
|
|
}
|
|
|
|
$export = $exportManager->getExport($alias);
|
|
|
|
$form = $this->createCreateFormExport($alias, 'export', $data);
|
|
|
|
if ($request->getMethod() === 'POST') {
|
|
$form->handleRequest($request);
|
|
if ($form->isValid()) {
|
|
|
|
$this->logger->debug('form export is valid', array(
|
|
'location' => __METHOD__));
|
|
|
|
// store data for reusing in next steps
|
|
$data = $form->getData();
|
|
$this->session->set('export_step_raw',
|
|
$request->request->all());
|
|
$this->session->set('export_step', $data);
|
|
|
|
//redirect to next step
|
|
return $this->redirect(
|
|
$this->generateUrl('chill_main_export_new', array(
|
|
'step' => $this->getNextStep('export', $export),
|
|
'alias' => $alias
|
|
)));
|
|
} else {
|
|
$this->logger->debug('form export is invalid', array(
|
|
'location' => __METHOD__));
|
|
}
|
|
}
|
|
|
|
return $this->render('@ChillMain/Export/new.html.twig', array(
|
|
'form' => $form->createView(),
|
|
'export_alias' => $alias,
|
|
'export' => $export
|
|
));
|
|
}
|
|
|
|
/**
|
|
* create a form to show on different steps.
|
|
*
|
|
* @param string $alias
|
|
* @param string $step, can either be 'export', 'formatter', 'generate_export' or 'generate_formatter' (last two are used by generate action)
|
|
* @param array $data the data from previous step. Required for steps 'formatter' and 'generate_formatter'
|
|
* @return \Symfony\Component\Form\Form
|
|
*/
|
|
protected function createCreateFormExport($alias, $step, $data = array())
|
|
{
|
|
/* @var $exportManager \Chill\MainBundle\Export\ExportManager */
|
|
$exportManager = $this->exportManager;
|
|
$isGenerate = strpos($step, 'generate_') === 0;
|
|
|
|
$builder = $this->formFactory
|
|
->createNamedBuilder(null, FormType::class, array(), array(
|
|
'method' => $isGenerate ? 'GET' : 'POST',
|
|
'csrf_protection' => $isGenerate ? false : true,
|
|
));
|
|
|
|
if ($step === 'centers' or $step === 'generate_centers') {
|
|
$builder->add('centers', PickCenterType::class, array(
|
|
'export_alias' => $alias
|
|
));
|
|
}
|
|
|
|
if ($step === 'export' or $step === 'generate_export') {
|
|
$builder->add('export', ExportType::class, array(
|
|
'export_alias' => $alias,
|
|
'picked_centers' => $exportManager->getPickedCenters($data['centers'])
|
|
));
|
|
}
|
|
|
|
if ($step === 'formatter' or $step === 'generate_formatter') {
|
|
$builder->add('formatter', FormatterType::class, array(
|
|
'formatter_alias' => $exportManager
|
|
->getFormatterAlias($data['export']),
|
|
'export_alias' => $alias,
|
|
'aggregator_aliases' => $exportManager
|
|
->getUsedAggregatorsAliases($data['export'])
|
|
));
|
|
}
|
|
|
|
$builder->add('submit', SubmitType::class, array(
|
|
'label' => 'Generate'
|
|
));
|
|
|
|
return $builder->getForm();
|
|
}
|
|
|
|
/**
|
|
* get the next step. If $reverse === true, the previous step is returned.
|
|
*
|
|
* This method provides a centralized way of handling next/previous step.
|
|
*
|
|
* @param string $step the current step
|
|
* @param \Chill\MainBundle\Export\ExportInterface|\Chill\MainBundle\Export\DirectExportInterface $export
|
|
* @param boolean $reverse set to true to get the previous step
|
|
* @return string the next/current step
|
|
* @throws \LogicException if there is no step before or after the given step
|
|
*/
|
|
private function getNextStep($step, $export, $reverse = false)
|
|
{
|
|
switch($step) {
|
|
case 'centers':
|
|
if ($reverse !== false) {
|
|
throw new \LogicException("there is no step before 'export'");
|
|
}
|
|
return 'export';
|
|
case 'export':
|
|
if ($export instanceof \Chill\MainBundle\Export\ExportInterface) {
|
|
return $reverse ? 'centers' : 'formatter';
|
|
} elseif ($export instanceof \Chill\MainBundle\Export\DirectExportInterface) {
|
|
return $reverse ? 'centers' : 'generate';
|
|
}
|
|
|
|
case 'formatter' :
|
|
return $reverse ? 'export' : 'generate';
|
|
case 'generate' :
|
|
if ($reverse === false) {
|
|
throw new \LogicException("there is no step after 'generate'");
|
|
}
|
|
return 'formatter';
|
|
|
|
default:
|
|
throw new \LogicException("the step $step is not defined.");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Render the form for formatter.
|
|
*
|
|
* If the form is posted and valid, store the data in session and
|
|
* redirect to the next step.
|
|
*
|
|
* @param Request $request
|
|
* @param \Chill\MainBundle\Export\ExportInterface|\Chill\MainBundle\Export\DirectExportInterface $export
|
|
* @param string $alias
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
protected function formatterFormStep(Request $request, $export, $alias)
|
|
{
|
|
|
|
// check we have data from the previous step (export step)
|
|
$data = $this->session->get('export_step', null);
|
|
|
|
if ($data === null) {
|
|
|
|
return $this->redirectToRoute('chill_main_export_new', array(
|
|
'step' => $this->getNextStep('formatter', $export, true),
|
|
'alias' => $alias
|
|
));
|
|
}
|
|
|
|
$form = $this->createCreateFormExport($alias, 'formatter', $data);
|
|
|
|
if ($request->getMethod() === 'POST') {
|
|
$form->handleRequest($request);
|
|
|
|
if ($form->isValid()) {
|
|
$dataFormatter = $form->getData();
|
|
$this->session->set('formatter_step', $dataFormatter);
|
|
$this->session->set('formatter_step_raw',
|
|
$request->request->all());
|
|
|
|
//redirect to next step
|
|
return $this->redirect($this->generateUrl('chill_main_export_new',
|
|
array(
|
|
'alias' => $alias,
|
|
'step' => $this->getNextStep('formatter', $export)
|
|
)));
|
|
}
|
|
}
|
|
|
|
return $this->render('@ChillMain/Export/new_formatter_step.html.twig',
|
|
array(
|
|
'form' => $form->createView(),
|
|
'export' => $export
|
|
));
|
|
}
|
|
|
|
/**
|
|
* Gather data stored in session from previous steps, store it inside redis
|
|
* and redirect to the `generate` action.
|
|
*
|
|
* The data from previous steps is removed from session.
|
|
*
|
|
* @param Request $request
|
|
* @param \Chill\MainBundle\Export\ExportInterface|\Chill\MainBundle\Export\DirectExportInterface $export
|
|
* @param string $alias
|
|
* @return \Symfony\Component\HttpFoundation\RedirectResponse
|
|
*/
|
|
protected function forwardToGenerate(Request $request, $export, $alias)
|
|
{
|
|
$dataCenters = $this->session->get('centers_step_raw', null);
|
|
$dataFormatter = $this->session->get('formatter_step_raw', null);
|
|
$dataExport = $this->session->get('export_step_raw', null);
|
|
|
|
if ($dataFormatter === NULL and $export instanceof \Chill\MainBundle\Export\ExportInterface) {
|
|
return $this->redirectToRoute('chill_main_export_new', array(
|
|
'alias' => $alias, 'step' => $this->getNextStep('generate', $export, true)
|
|
));
|
|
}
|
|
|
|
$parameters = [
|
|
'formatter' => $dataFormatter ?? [],
|
|
'export' => $dataExport ?? [],
|
|
'centers' => $dataCenters ?? [],
|
|
'alias' => $alias
|
|
];
|
|
unset($parameters['_token']);
|
|
$key = md5(uniqid(rand(), false));
|
|
|
|
$this->redis->setEx($key, 3600, \serialize($parameters));
|
|
|
|
// remove data from session
|
|
$this->session->remove('export_step_raw');
|
|
$this->session->remove('export_step');
|
|
$this->session->remove('formatter_step_raw');
|
|
$this->session->remove('formatter_step');
|
|
|
|
return $this->redirectToRoute('chill_main_export_download', [ 'key' => $key, 'alias' => $alias ]);
|
|
}
|
|
|
|
/**
|
|
* Generate a report.
|
|
*
|
|
* This action must work with GET queries.
|
|
*
|
|
* @param Request $request
|
|
* @param string $alias
|
|
* @return \Symfony\Component\HttpFoundation\Response
|
|
*/
|
|
public function generateAction(Request $request, $alias)
|
|
{
|
|
/* @var $exportManager \Chill\MainBundle\Export\ExportManager */
|
|
$exportManager = $this->exportManager;
|
|
$key = $request->query->get('key', null);
|
|
|
|
list($dataCenters, $dataExport, $dataFormatter) = $this->rebuildData($key);
|
|
|
|
$r = $exportManager->generate(
|
|
$alias,
|
|
$dataCenters['centers'],
|
|
$dataExport['export'],
|
|
$dataFormatter !== NULL ? $dataFormatter['formatter'] : []
|
|
);
|
|
|
|
return $r;
|
|
}
|
|
|
|
protected function rebuildData($key)
|
|
{
|
|
if ($key === NULL) {
|
|
throw $this->createNotFoundException("key does not exists");
|
|
}
|
|
|
|
if ($this->redis->exists($key) !== 1) {
|
|
$this->addFlash('error', $this->translator->trans("This report is not available any more"));
|
|
throw $this->createNotFoundException("key does not exists");
|
|
}
|
|
|
|
$serialized = $this->redis->get($key);
|
|
|
|
if ($serialized === false) {
|
|
throw new \LogicException("the key could not be reached from redis");
|
|
}
|
|
|
|
$rawData = \unserialize($serialized);
|
|
$alias = $rawData['alias'];
|
|
|
|
$formCenters = $this->createCreateFormExport($alias, 'generate_centers');
|
|
$formCenters->submit($rawData['centers']);
|
|
$dataCenters = $formCenters->getData();
|
|
|
|
$formExport = $this->createCreateFormExport($alias, 'generate_export', $dataCenters);
|
|
$formExport->submit($rawData['export']);
|
|
$dataExport = $formExport->getData();
|
|
|
|
if (count($rawData['formatter']) > 0) {
|
|
$formFormatter = $this->createCreateFormExport($alias, 'generate_formatter',
|
|
$dataExport);
|
|
$formFormatter->submit($rawData['formatter']);
|
|
$dataFormatter = $formFormatter->getData();
|
|
}
|
|
|
|
return [$dataCenters, $dataExport, $dataFormatter ?? null];
|
|
}
|
|
|
|
public function downloadResultAction(Request $request, $alias)
|
|
{
|
|
/* @var $exportManager \Chill\MainBundle\Export\ExportManager */
|
|
$exportManager = $this->exportManager;
|
|
$key = $request->query->get('key', null);
|
|
|
|
list($dataCenters, $dataExport, $dataFormatter) = $this->rebuildData($key);
|
|
|
|
$formatterAlias = $exportManager->getFormatterAlias($dataExport['export']);
|
|
if ($formatterAlias !== null) {
|
|
$formater = $exportManager->getFormatter($formatterAlias);
|
|
} else {
|
|
$formater = null;
|
|
}
|
|
|
|
$viewVariables = [
|
|
'alias' => $alias,
|
|
'export' => $exportManager->getExport($alias)
|
|
];
|
|
|
|
if ($formater instanceof \Chill\MainBundle\Export\Formatter\CSVListFormatter) {
|
|
// due to a bug in php, we add the mime type in the download view
|
|
$viewVariables['mime_type'] = 'text/csv';
|
|
}
|
|
|
|
return $this->render("@ChillMain/Export/download.html.twig", $viewVariables);
|
|
}
|
|
}
|