3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Galette dynamic fields controller
10 * Copyright © 2020-2023 The Galette Team
12 * This file is part of Galette (http://galette.tuxfamily.org).
14 * Galette is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
19 * Galette is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with Galette. If not, see <http://www.gnu.org/licenses/>.
27 * @category Controllers
30 * @author Johan Cwiklinski <johan@x-tnd.be>
31 * @copyright 2020-2023 The Galette Team
32 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
33 * @link http://galette.tuxfamily.org
34 * @since Available since 0.9.4dev - 2020-05-02
37 namespace Galette\Controllers\Crud
;
40 use Galette\Repository\DynamicFieldsSet
;
42 use Galette\Controllers\CrudController
;
43 use Slim\Psr7\Request
;
44 use Slim\Psr7\Response
;
45 use Galette\DynamicFields\DynamicField
;
49 * Galette dynamic fields controller
51 * @category Controllers
52 * @name DynamicFieldsController
54 * @author Johan Cwiklinski <johan@x-tnd.be>
55 * @copyright 2020-2023 The Galette Team
56 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
57 * @link http://galette.tuxfamily.org
58 * @since Available since 0.9.4dev - 2020-05-02
61 class DynamicFieldsController
extends CrudController
68 * @param Request $request PSR Request
69 * @param Response $response PSR Response
70 * @param string $form_name Form name
74 public function add(Request
$request, Response
$response, string $form_name = null): Response
77 'page_title' => _T("Add field"),
78 'form_name' => $form_name,
80 'perm_names' => DynamicField
::getPermsNames(),
81 'mode' => (($request->getHeaderLine('X-Requested-With') === 'XMLHttpRequest') ?
'ajax' : ''),
82 'field_type_names' => DynamicField
::getFieldsTypesNames()
85 if ($this->session
->dynamicfieldtype
) {
86 $params['df'] = $this->session
->dynamicfieldtype
;
87 $this->session
->dynamicfieldtype
= null;
93 'pages/configuration_dynamic_field_form.html.twig',
102 * @param Request $request PSR Request
103 * @param Response $response PSR Response
104 * @param string $form_name Form name
108 public function doAdd(Request
$request, Response
$response, string $form_name = null): Response
110 $post = $request->getParsedBody();
111 $post['form_name'] = $form_name;
113 $error_detected = [];
114 $warning_detected = [];
116 if (isset($post['cancel'])) {
119 ->withHeader('Location', $this->cancelUri($this->getArgs($request)));
122 $df = DynamicField
::getFieldType($this->zdb
, $post['field_type']);
126 $error_detected = $df->getErrors();
127 $warning_detected = $df->getWarnings();
128 } catch (Throwable
$e) {
129 $msg = 'An error occurred adding new dynamic field.';
135 if (GALETTE_MODE
== 'DEV') {
138 $error_detected[] = _T('An error occurred adding dynamic field :(');
142 if (count($error_detected) > 0) {
143 foreach ($error_detected as $error) {
144 $this->flash
->addMessage(
150 $this->flash
->addMessage(
152 _T('Dynamic field has been successfully stored!')
156 if (count($warning_detected) > 0) {
157 foreach ($warning_detected as $warning) {
158 $this->flash
->addMessage(
165 //handle redirections
166 if (count($error_detected) > 0) {
167 //something went wrong :'(
168 $this->session
->dynamicfieldtype
= $df;
173 $this->routeparser
->urlFor(
175 ['form_name' => $form_name]
179 if (!$df instanceof \Galette\DynamicFields\Separator
) {
184 $this->routeparser
->urlFor(
187 'form_name' => $form_name,
198 $this->routeparser
->urlFor(
199 'configureDynamicFields',
200 ['form_name' => $form_name]
212 * @param Request $request PSR Request
213 * @param Response $response PSR Response
214 * @param string $option One of 'page' or 'order'
215 * @param string|integer $value Value of the option
216 * @param string $form_name Form name
220 public function list(
227 if (isset($_POST['form_name']) && trim($_POST['form_name']) != '') {
228 $form_name = $_POST['form_name'];
230 $fields = new DynamicFieldsSet($this->zdb
, $this->login
);
231 $fields_list = $fields->getList($form_name);
234 'fields_list' => $fields_list,
235 'form_name' => $form_name,
236 'form_title' => DynamicField
::getFormTitle($form_name),
237 'page_title' => _T("Dynamic fields configuration")
240 $tpl = 'pages/configuration_dynamic_fields.html.twig';
241 //Render directly template if we called from ajax,
242 //render in a full page otherwise
244 ($request->getHeaderLine('X-Requested-With') === 'XMLHttpRequest')
245 ||
isset($request->getQueryParams()['ajax'])
246 && $request->getQueryParams()['ajax'] == 'true'
248 $tpl = 'elements/edit_dynamic_fields.html.twig';
250 $all_forms = DynamicField
::getFormsNames();
251 $params['all_forms'] = $all_forms;
266 * @param Request $request PSR Request
267 * @param Response $response PSR Response
271 public function filter(Request
$request, Response
$response): Response
280 * @param Request $request PSR Request
281 * @param Response $response PSR Response
282 * @param string $form_name Form name
283 * @param integer $id Object ID
284 * @param integer $fid Dynamic fields ID
285 * @param integer $pos Dynamic field position
286 * @param string $name File name
290 public function getDynamicFile(
299 $object_class = DynamicFieldsSet
::getClasses()[$form_name];
300 if ($object_class === 'Galette\Entity\Adherent') {
301 $object = new $object_class($this->zdb
);
303 $object = new $object_class($this->zdb
, $this->login
);
308 ->enableDep('dynamics')
312 if (!$object->canShow($this->login
)) {
313 $fields = $object->getDynamicFields()->getFields();
314 if (!isset($fields[$fid])) {
315 //field does not exist or access is forbidden
322 if ($denied === true) {
323 $this->flash
->addMessage(
325 _T("You do not have permission for requested URL.")
328 $route_name = 'member';
329 if ($form_name == 'contrib') {
330 $route_name = 'contribution';
331 } elseif ($route_name == 'trans') {
332 $route_name = 'transaction';
337 $this->routeparser
->urlFor(
344 if ($form_name === 'adh') {
345 $form_name = 'member'; //for compatibility with existing files
347 $filename = str_replace(
360 '%form_%oid_field_%fid_value_%pos'
363 if ($form_name !== 'member' && !file_exists(GALETTE_FILES_PATH
. $filename)) {
364 //handle old names for non adh dynamic files
365 $test_filename = str_replace(
378 '%form_%oid_field_%fid_value_%pos'
380 if (file_exists(GALETTE_FILES_PATH
. $test_filename)) {
381 //rename old file to new name
382 rename(GALETTE_FILES_PATH
. $test_filename, GALETTE_FILES_PATH
. $filename);
386 if (file_exists(GALETTE_FILES_PATH
. $filename)) {
387 $type = File
::getMimeType(GALETTE_FILES_PATH
. $filename);
389 $response = $response->withHeader('Content-Description', 'File Transfer')
390 ->withHeader('Content-Type', $type)
391 ->withHeader('Content-Disposition', 'attachment;filename="' . $name . '"')
392 ->withHeader('Pragma', 'no-cache')
393 ->withHeader('Content-Transfer-Encoding', 'binary')
394 ->withHeader('Expires', '0')
395 ->withHeader('Cache-Control', 'must-revalidate')
396 ->withHeader('Pragma', 'public');
398 $stream = fopen('php://memory', 'r+');
399 fwrite($stream, file_get_contents(GALETTE_FILES_PATH
. $filename));
402 return $response->withBody(new \Slim\Psr7\
Stream($stream));
405 'A request has been made to get a dynamic file named `' .
406 $filename . '` that does not exists.',
410 $this->flash
->addMessage(
412 _T("The file does not exists or cannot be read :(")
418 $this->routeparser
->urlFor('member', ['id' => $id])
429 * @param Request $request PSR Request
430 * @param Response $response PSR Response
431 * @param integer $id Dynamic field id
432 * @param string $form_name Form name
436 public function edit(Request
$request, Response
$response, int $id, $form_name = null): Response
439 if ($this->session
->dynamicfieldtype
) {
440 $df = $this->session
->dynamicfieldtype
;
441 $this->session
->dynamicfieldtype
= null;
443 $df = DynamicField
::loadFieldType($this->zdb
, $id);
445 $this->flash
->addMessage(
447 _T("Unable to retrieve field information.")
451 ->withHeader('Location', $this->routeparser
->urlFor('configureDynamicFields'));
456 'page_title' => _T("Edit field"),
458 'form_name' => $form_name,
459 'perm_names' => DynamicField
::getPermsNames(),
460 'mode' => (($request->getHeaderLine('X-Requested-With') === 'XMLHttpRequest') ?
'ajax' : ''),
467 'pages/configuration_dynamic_field_form.html.twig',
476 * @param Request $request PSR Request
477 * @param Response $response PSR Response
478 * @param integer $id Dynamic field id
479 * @param string $form_name Form name
483 public function doEdit(Request
$request, Response
$response, int $id = null, string $form_name = null): Response
485 $post = $request->getParsedBody();
486 $post['form_name'] = $form_name;
488 if (isset($post['cancel'])) {
491 ->withHeader('Location', $this->cancelUri($this->getArgs($request)));
494 $error_detected = [];
495 $warning_detected = [];
498 $df = DynamicField
::loadFieldType($this->zdb
, $field_id);
502 $error_detected = $df->getErrors();
503 $warning_detected = $df->getWarnings();
504 } catch (Throwable
$e) {
505 $msg = 'An error occurred storing dynamic field ' . $df->getId() . '.';
511 if (GALETTE_MODE
== 'DEV') {
514 $error_detected[] = _T('An error occurred editing dynamic field :(');
518 if (count($error_detected) > 0) {
519 foreach ($error_detected as $error) {
520 $this->flash
->addMessage(
526 $this->flash
->addMessage(
528 _T('Dynamic field has been successfully stored!')
532 if (count($warning_detected) > 0) {
533 foreach ($warning_detected as $warning) {
534 $this->flash
->addMessage(
541 //handle redirections
542 if (count($error_detected) > 0) {
543 //something went wrong :'(
544 $this->session
->dynamicfieldtype
= $df;
549 $this->routeparser
->urlFor(
552 'form_name' => $form_name,
562 $this->routeparser
->urlFor(
563 'configureDynamicFields',
564 ['form_name' => $form_name]
574 * Get redirection URI
576 * @param array $args Route arguments
580 public function redirectUri(array $args)
582 return $this->routeparser
->urlFor('configureDynamicFields', ['form_name' => $args['form_name']]);
588 * @param array $args Route arguments
592 public function formUri(array $args)
594 return $this->routeparser
->urlFor(
595 'doRemoveDynamicField',
596 ['id' => $args['id'], 'form_name' => $args['form_name']]
601 * Get confirmation removal page title
603 * @param array $args Route arguments
607 public function confirmRemoveTitle(array $args)
609 $field = DynamicField
::loadFieldType($this->zdb
, (int)$args['id']);
610 if ($field === false) {
611 $this->flash
->addMessage(
613 _T("Requested field does not exists!")
615 return _T("Requested field does not exists!");
619 _T('Remove dynamic field %1$s'),
627 * @param array $args Route arguments
628 * @param array $post POST values
632 protected function doDelete(array $args, array $post)
634 $field_id = (int)$post['id'];
635 $field = DynamicField
::loadFieldType($this->zdb
, $field_id);
636 return $field->remove();
645 * @param Request $request PSR Request
646 * @param Response $response PSR Response
647 * @param integer $id Field id
648 * @param string $form_name Form name
649 * @param string $direction One of DynamicField::MOVE_*
653 public function move(
660 $field = DynamicField
::loadFieldType($this->zdb
, $id);
661 if ($field->move($direction)) {
662 $this->flash
->addMessage(
664 _T("Field has been successfully moved")
667 $this->flash
->addMessage(
669 _T("An error occurred moving field :(")
675 ->withHeader('Location', $this->routeparser
->urlFor('configureDynamicFields', ['form_name' => $form_name]));