3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Galette members controller
10 * Copyright © 2019-2020 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 2019-2020 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
34 * @link http://galette.tuxfamily.org
35 * @since Available since 0.9.4dev - 2019-12-02
38 namespace Galette\Controllers\Crud
;
40 use Galette\Controllers\CrudController
;
42 use Slim\Http\Request
;
43 use Slim\Http\Response
;
44 use Galette\Core\Authentication
;
45 use Galette\Core\GaletteMail
;
46 use Galette\Core\PasswordImage
;
47 use Galette\Core\Picture
;
48 use Galette\Entity\Adherent
;
49 use Galette\Entity\Contribution
;
50 use Galette\Entity\ContributionsTypes
;
51 use Galette\Entity\DynamicFieldsHandle
;
52 use Galette\Entity\Status
;
53 use Galette\Entity\FieldsConfig
;
54 use Galette\Filters\AdvancedMembersList
;
55 use Galette\Filters\MembersList
;
57 use Galette\IO\MembersCsv
;
58 use Galette\Repository\Groups
;
59 use Galette\Repository\Members
;
60 use Galette\Repository\PaymentTypes
;
61 use Galette\Repository\Titles
;
65 * Galette members controller
67 * @category Controllers
68 * @name GaletteController
70 * @author Johan Cwiklinski <johan@x-tnd.be>
71 * @copyright 2019-2020 The Galette Team
72 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
73 * @link http://galette.tuxfamily.org
74 * @since Available since 0.9.4dev - 2019-12-02
77 class MembersController
extends CrudController
84 * @param Request $request PSR Request
85 * @param Response $response PSR Response
86 * @param array $args Request arguments
90 public function add(Request
$request, Response
$response, array $args = []) :Response
92 return $this->edit($request, $response, $args);
96 * Self subscription page
98 * @param Request $request PSR Request
99 * @param Response $response PSR Response
100 * @param array $args Request arguments
104 public function selfSubscribe(Request
$request, Response
$response, array $args = []) :Response
106 if (!$this->preferences
->pref_bool_selfsubscribe ||
$this->login
->isLogged()) {
109 ->withHeader('Location', $this->router
->pathFor('slash'));
112 if ($this->session
->member
!== null) {
113 $member = $this->session
->member
;
114 $this->session
->member
= null;
119 $member = new Adherent($this->zdb
, null, $deps);
122 //mark as self membership
123 $member->setSelfMembership();
125 // flagging required fields
126 $fc = $this->fields_config
;
127 $form_elements = $fc->getFormElements($this->login
, true, true);
129 //image to defeat mass filling forms
130 $spam = new PasswordImage();
131 $spam_pass = $spam->newImage();
132 $spam_img = $spam->getImage();
136 $members = $m->getSelectizedMembers(
138 $member->hasParent() ?
$member->parent
->id
: null
141 $params['members'] = [
142 'filters' => $m->getFilters(),
143 'count' => $m->getCount()
146 if (count($members)) {
147 $params['members']['list'] = $members;
155 'page_title' => _T("Subscription"),
156 'parent_tpl' => 'public_page.tpl',
159 'autocomplete' => true,
162 'titles_list' => Titles
::getList($this->zdb
),
164 'spam_pass' => $spam_pass,
165 'spam_img' => $spam_img,
166 'fieldsets' => $form_elements['fieldsets'],
167 'hidden_elements' => $form_elements['hiddens']
176 * @param Request $request PSR Request
177 * @param Response $response PSR Response
178 * @param array $args Request arguments
182 public function doAdd(Request
$request, Response
$response, array $args = []) :Response
184 return $this->store($request, $response, $args);
190 * @param Request $request PSR Request
191 * @param Response $response PSR Response
192 * @param array $args Request arguments
196 public function duplicate(Request
$request, Response
$response, array $args = []) :Response
198 $id_adh = (int)$args[Adherent
::PK
];
199 $adh = new Adherent($this->zdb
, $id_adh, ['dynamics' => true]);
200 $adh->setDuplicate();
202 //store entity in session
203 $this->session
->member
= $adh;
207 ->withHeader('Location', $this->router
->pathFor('editmember', ['action' => 'add']));
214 * Display member card
216 * @param Request $request PSR Request
217 * @param Response $response PSR Response
218 * @param array $args Request arguments
222 public function show(Request
$request, Response
$response, array $args) :Response
224 $id = (int)$args['id'];
234 $member = new Adherent($this->zdb
, $id, $deps);
236 if (!$member->canEdit($this->login
)) {
237 $this->flash
->addMessage(
239 _T("You do not have permission for requested URL.")
246 $this->router
->pathFor('me')
250 if ($member->id
== null) {
251 //member does not exists!
252 $this->flash
->addMessage(
254 str_replace('%id', $args['id'], _T("No member #%id."))
261 $this->router
->pathFor('slash')
265 // flagging fields visibility
266 $fc = $this->fields_config
;
267 $display_elements = $fc->getDisplayElements($this->login
);
274 'page_title' => _T("Member Profile"),
276 'pref_lang' => $this->i18n
->getNameFromId($member->language
),
277 'pref_card_self' => $this->preferences
->pref_card_self
,
278 'groups' => Groups
::getSimpleList(),
280 'display_elements' => $display_elements
289 * @param Request $request PSR Request
290 * @param Response $response PSR Response
291 * @param array $args Request arguments
295 public function showMe(Request
$request, Response
$response, array $args = []) :Response
297 if ($this->login
->isSuperAdmin()) {
300 ->withHeader('Location', $this->router
->pathFor('slash'));
302 $args['show_me'] = true;
303 $args['id'] = $this->login
->id
;
304 return $this->show($request, $response, $args);
310 * @param Request $request PSR Request
311 * @param Response $response PSR Response
312 * @param array $args Request arguments
316 public function getDynamicFile(Request
$request, Response
$response, array $args) :Response
318 $id = (int)$args['id'];
327 $member = new Adherent($this->zdb
, $id, $deps);
330 if (!$member->canEdit($this->login
)) {
331 $fields = $member->getDynamicFields()->getFields();
332 if (!isset($fields[$args['fid']])) {
333 //field does not exists or access is forbidden
340 if ($denied === true) {
341 $this->flash
->addMessage(
343 _T("You do not have permission for requested URL.")
350 $this->router
->pathFor(
357 $filename = str_replace(
368 'member_%mid_field_%fid_value_%pos'
371 if (file_exists(GALETTE_FILES_PATH
. $filename)) {
372 $type = File
::getMimeType(GALETTE_FILES_PATH
. $filename);
373 $response = $response
374 ->withHeader('Content-Type', $type)
375 ->withHeader('Content-Disposition', 'attachment;filename="' . $args['name'] . '"')
376 ->withHeader('Pragma', 'no-cache');
377 $response->write(readfile(GALETTE_FILES_PATH
. $filename));
381 'A request has been made to get an exported file named `' .
382 $filename .'` that does not exists.',
386 $this->flash
->addMessage(
388 _T("The file does not exists or cannot be read :(")
395 $this->router
->pathFor('member', ['id' => $args['id']])
403 * @param Request $request PSR Request
404 * @param Response $response PSR Response
405 * @param array $args Request arguments
409 public function list(Request
$request, Response
$response, array $args = []) :Response
411 $option = $args['option'] ??
null;
412 $value = $args['value'] ??
null;
414 if (isset($this->session
->filter_members
)) {
415 $filters = $this->session
->filter_members
;
417 $filters = new MembersList();
420 if ($option !== null) {
423 $filters->current_page
= (int)$value;
426 $filters->orderby
= $value;
431 $members = new Members($filters);
433 $members_list = array();
434 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
435 $members_list = $members->getMembersList(true);
437 $members_list = $members->getManagedMembersList(true);
440 $groups = new Groups($this->zdb
, $this->login
);
441 $groups_list = $groups->getList();
443 //assign pagination variables to the template and add pagination links
444 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
445 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
447 $this->session
->filter_members
= $filters;
452 'gestion_adherents.tpl',
454 'page_title' => _T("Members management"),
455 'require_mass' => true,
456 'members' => $members_list,
457 'filter_groups_options' => $groups_list,
458 'nb_members' => $members->getCount(),
459 'filters' => $filters,
460 'adv_filters' => $filters instanceof AdvancedMembersList
469 * @param Request $request PSR Request
470 * @param Response $response PSR Response
474 public function filter(Request
$request, Response
$response) :Response
476 $post = $request->getParsedBody();
477 if (isset($this->session
->filter_members
)) {
478 //CAUTION: this one may be simple or advanced, display must change
479 $filters = $this->session
->filter_members
;
481 $filters = new MembersList();
484 //reintialize filters
485 if (isset($post['clear_filter'])) {
486 $filters = new MembersList();
487 } elseif (isset($post['clear_adv_filter'])) {
488 $this->session
->filter_members
= null;
489 unset($this->session
->filter_members
);
493 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
494 } elseif (isset($post['adv_criteria'])) {
497 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
500 if (isset($post['filter_str'])) { //filter search string
501 $filters->filter_str
= stripslashes(
502 htmlspecialchars($post['filter_str'], ENT_QUOTES
)
506 if (isset($post['field_filter'])) {
507 if (is_numeric($post['field_filter'])) {
508 $filters->field_filter
= $post['field_filter'];
511 //membership to filter
512 if (isset($post['membership_filter'])) {
513 if (is_numeric($post['membership_filter'])) {
514 $filters->membership_filter
515 = $post['membership_filter'];
518 //account status to filter
519 if (isset($post['filter_account'])) {
520 if (is_numeric($post['filter_account'])) {
521 $filters->filter_account
= $post['filter_account'];
525 if (isset($post['email_filter'])) {
526 $filters->email_filter
= (int)$post['email_filter'];
529 if (isset($post['group_filter'])
530 && $post['group_filter'] > 0
532 $filters->group_filter
= (int)$post['group_filter'];
534 //number of rows to show
535 if (isset($post['nbshow'])) {
536 $filters->show
= $post['nbshow'];
539 if (isset($post['advanced_filtering'])) {
540 if (!$filters instanceof AdvancedMembersList
) {
541 $filters = new AdvancedMembersList($filters);
545 unset($post['advanced_filtering']);
547 foreach ($post as $k => $v) {
548 if (strpos($k, 'free_', 0) === 0) {
551 foreach ($post['free_field'] as $f) {
553 && trim($post['free_text'][$i]) !== ''
555 $fs_search = $post['free_text'][$i];
557 = (int)$post['free_logical_operator'][$i];
559 = (int)$post['free_query_operator'][$i];
560 $type = (int)$post['free_type'][$i];
565 'search' => $fs_search,
569 $filters->free_search
= $fs;
575 } elseif ($k == 'groups_search') {
577 $filters->groups_search_log_op
= (int)$post['groups_logical_operator'];
578 foreach ($post['groups_search'] as $g) {
579 if (trim($g) !== '') {
584 $filters->groups_search
= $gs;
590 case 'contrib_min_amount':
591 case 'contrib_max_amount':
592 if (trim($v) !== '') {
605 if (isset($post['savesearch'])) {
610 $this->router
->pathFor(
617 $this->session
->filter_members
= $filters;
621 ->withHeader('Location', $this->router
->pathFor('members'));
625 * Advanced search page
627 * @param Request $request PSR Request
628 * @param Response $response PSR Response
632 public function advancedSearch(Request
$request, Response
$response) :Response
634 if (isset($this->session
->filter_members
)) {
635 $filters = $this->session
->filter_members
;
636 if (!$filters instanceof AdvancedMembersList
) {
637 $filters = new AdvancedMembersList($filters);
640 $filters = new AdvancedMembersList();
643 $groups = new Groups($this->zdb
, $this->login
);
644 $groups_list = $groups->getList();
646 //we want only visibles fields
647 $fields = $this->members_fields
;
648 $fc = $this->fields_config
;
649 $visibles = $fc->getVisibilities();
650 $access_level = $this->login
->getAccessLevel();
652 //remove not searchable fields
653 unset($fields['mdp_adh']);
655 foreach ($fields as $k => $f) {
656 if ($visibles[$k] == FieldsConfig
::NOBODY ||
657 ($visibles[$k] == FieldsConfig
::ADMIN
&&
658 $access_level < Authentication
::ACCESS_ADMIN
) ||
659 ($visibles[$k] == FieldsConfig
::STAFF
&&
660 $access_level < Authentication
::ACCESS_STAFF
) ||
661 ($visibles[$k] == FieldsConfig
::MANAGER
&&
662 $access_level < Authentication
::ACCESS_MANAGER
)
668 //add status label search
669 if ($pos = array_search(Status
::PK
, array_keys($fields))) {
670 $fields = array_slice($fields, 0, $pos, true) +
671 ['status_label' => ['label' => _T('Status label')]] +
672 array_slice($fields, $pos, count($fields) -1, true);
684 $member = new Adherent($this->zdb
, $this->login
->login
, $deps);
685 $adh_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $member);
687 $contrib = new Contribution($this->zdb
, $this->login
);
688 $contrib_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $contrib);
691 $statuts = new Status($this->zdb
);
693 //Contributions types
694 $ct = new ContributionsTypes($this->zdb
);
697 $ptypes = new PaymentTypes(
702 $ptlist = $ptypes->getList();
704 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
709 'advanced_search.tpl',
711 'page_title' => _T("Advanced search"),
712 'filter_groups_options' => $groups_list,
713 'search_fields' => $fields,
714 'adh_dynamics' => $adh_dynamics->getFields(),
715 'contrib_dynamics' => $contrib_dynamics->getFields(),
716 'statuts' => $statuts->getList(),
717 'contributions_types' => $ct->getList(),
718 'filters' => $filters,
719 'payments_types' => $ptlist
726 * Batch actions handler
728 * @param Request $request PSR Request
729 * @param Response $response PSR Response
733 public function handleBatch(Request
$request, Response
$response) :Response
735 $post = $request->getParsedBody();
737 if (isset($post['member_sel'])) {
738 if (isset($this->session
->filter_members
)) {
739 $filters = $this->session
->filter_members
;
741 $filters = new MembersList();
744 $filters->selected
= $post['member_sel'];
745 $this->session
->filter_members
= $filters;
747 if (isset($post['cards'])) {
750 ->withHeader('Location', $this->router
->pathFor('pdf-members-cards'));
753 if (isset($post['labels'])) {
756 ->withHeader('Location', $this->router
->pathFor('pdf-members-labels'));
759 if (isset($post['mailing'])) {
762 ->withHeader('Location', $this->router
->pathFor('mailing') . '?mailing_new=new');
765 if (isset($post['attendance_sheet'])) {
768 ->withHeader('Location', $this->router
->pathFor('attendance_sheet_details'));
771 if (isset($post['csv'])) {
774 ->withHeader('Location', $this->router
->pathFor('csv-memberslist'));
777 if (isset($post['delete'])) {
780 ->withHeader('Location', $this->router
->pathFor('removeMembers'));
783 if (isset($post['masschange'])) {
786 ->withHeader('Location', $this->router
->pathFor('masschangeMembers'));
789 throw new \
RuntimeException('Does not know what to batch :(');
791 $this->flash
->addMessage(
793 _T("No member was selected, please check at least one name.")
798 ->withHeader('Location', $this->router
->pathFor('members'));
808 * @param Request $request PSR Request
809 * @param Response $response PSR Response
810 * @param array $args Request arguments
814 public function edit(Request
$request, Response
$response, array $args = []) :Response
816 $action = $args['action'];
818 if (isset($args['id'])) {
819 $id = (int)$args['id'];
822 if ($action === 'edit' && $id === null) {
823 throw new \
RuntimeException(
824 _T("Member ID cannot ben null calling edit route!")
826 } elseif ($action === 'add' && $id !== null) {
829 ->withHeader('Location', $this->router
->pathFor('editmember', ['action' => 'add']));
840 if ($this->session
->member
!== null) {
841 $member = $this->session
->member
;
842 $this->session
->member
= null;
844 $member = new Adherent($this->zdb
, $id, $deps);
848 if (!$member->canEdit($this->login
)) {
849 $this->flash
->addMessage(
851 _T("You do not have permission for requested URL.")
858 $this->router
->pathFor('me')
862 if ($member->id
!= $id) {
863 $member->load($this->login
->id
);
867 // flagging required fields
868 $fc = $this->fields_config
;
870 // password required if we create a new member
871 if ($member->id
!= '') {
872 $fc->setNotRequired('mdp_adh');
875 //handle requirements for parent fields
876 $parent_fields = $member->getParentFields();
877 $tpl_parent_fields = []; //for JS when detaching
878 foreach ($parent_fields as $field) {
879 if ($fc->isRequired($field)) {
880 $tpl_parent_fields[] = $field;
881 if ($member->hasParent()) {
882 $fc->setNotRequired($field);
887 // flagging required fields invisible to members
888 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
889 $fc->setNotRequired('activite_adh');
890 $fc->setNotRequired('id_statut');
893 // template variable declaration
894 $title = _T("Member Profile");
895 if ($member->id
!= '') {
896 $title .= ' (' . _T("modification") . ')';
898 $title .= ' (' . _T("creation") . ')';
902 $statuts = new Status($this->zdb
);
905 $groups = new Groups($this->zdb
, $this->login
);
906 $groups_list = $groups->getSimpleList(true);
908 $form_elements = $fc->getFormElements(
916 if ($member->hasParent()) {
917 $id = ($member->parent
instanceof Adherent ?
$member->parent
->id
: $member->parent
);
919 $members = $m->getSelectizedMembers(
924 $route_params['members'] = [
925 'filters' => $m->getFilters(),
926 'count' => $m->getCount()
929 if (count($members)) {
930 $route_params['members']['list'] = $members;
938 'parent_tpl' => 'page.tpl',
939 'autocomplete' => true,
940 'page_title' => $title,
945 'titles_list' => Titles
::getList($this->zdb
),
946 'statuts' => $statuts->getList(),
947 'groups' => $groups_list,
948 'fieldsets' => $form_elements['fieldsets'],
949 'hidden_elements' => $form_elements['hiddens'],
950 'parent_fields' => $tpl_parent_fields
959 * @param Request $request PSR Request
960 * @param Response $response PSR Response
961 * @param array $args Request arguments
965 public function doEdit(Request
$request, Response
$response, array $args = []) :Response
967 return $this->store($request, $response, $args);
971 * Massive change page
973 * @param Request $request PSR Request
974 * @param Response $response PSR Response
975 * @param array $args Request arguments
979 public function massChange(Request
$request, Response
$response, array $args = []) :Response
981 $filters = $this->session
->filter_members
;
984 'id' => $filters->selected
,
985 'redirect_uri' => $this->router
->pathFor('members')
988 $fc = $this->fields_config
;
989 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1000 $member = new Adherent($this->zdb
, null, $deps);
1003 $statuts = new Status($this->zdb
);
1006 $this->view
->render(
1008 'mass_change_members.tpl',
1010 'mode' => $request->isXhr() ?
'ajax' : '',
1011 'page_title' => str_replace(
1014 _T('Mass change %count members')
1016 'form_url' => $this->router
->pathFor('masschangeMembersReview'),
1017 'cancel_uri' => $this->router
->pathFor('members'),
1019 'member' => $member,
1020 'fieldsets' => $form_elements['fieldsets'],
1021 'titles_list' => Titles
::getList($this->zdb
),
1022 'statuts' => $statuts->getList(),
1023 'require_mass' => true
1030 * Massive changes validation page
1032 * @param Request $request PSR Request
1033 * @param Response $response PSR Response
1034 * @param array $args Request arguments
1038 public function validateMassChange(Request
$request, Response
$response, array $args = []) :Response
1040 $post = $request->getParsedBody();
1042 if (!isset($post['confirm'])) {
1043 $this->flash
->addMessage(
1045 _T("Mass changes has not been confirmed!")
1048 //we want only visibles fields
1049 $fc = $this->fields_config
;
1050 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1053 foreach ($form_elements['fieldsets'] as $form_element) {
1054 foreach ($form_element->elements
as $field) {
1055 if (isset($post[$field->field_id
]) && isset($post['mass_' . $field->field_id
])) {
1056 $changes[$field->field_id
] = [
1057 'label' => $field->label
,
1058 'value' => $post[$field->field_id
]
1065 $filters = $this->session
->filter_members
;
1067 'id' => $filters->selected
,
1068 'redirect_uri' => $this->router
->pathFor('members')
1072 $statuts = new Status($this->zdb
);
1075 $this->view
->render(
1077 'mass_change_members.tpl',
1079 'mode' => $request->isXhr() ?
'ajax' : '',
1080 'page_title' => str_replace(
1083 _T('Review mass change %count members')
1085 'form_url' => $this->router
->pathFor('massstoremembers'),
1086 'cancel_uri' => $this->router
->pathFor('members'),
1088 'titles_list' => Titles
::getList($this->zdb
),
1089 'statuts' => $statuts->getList(),
1090 'changes' => $changes
1097 * Do massive changes
1099 * @param Request $request PSR Request
1100 * @param Response $response PSR Response
1101 * @param array $args Request arguments
1105 public function doMassChange(Request
$request, Response
$response, array $args = []) :Response
1107 $post = $request->getParsedBody();
1108 $redirect_url = $post['redirect_uri'];
1109 $error_detected = [];
1112 unset($post['redirect_uri']);
1113 if (!isset($post['confirm'])) {
1114 $error_detected[] = _T("Mass changes has not been confirmed!");
1116 unset($post['confirm']);
1120 $fc = $this->fields_config
;
1121 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1122 $disabled = $this->members_fields
;
1123 foreach (array_keys($post) as $key) {
1125 foreach ($form_elements['fieldsets'] as $fieldset) {
1126 if (isset($fieldset->elements
[$key])) {
1133 'Permission issue mass editing field ' . $key,
1138 unset($disabled[$key]);
1142 if (!count($post)) {
1143 $error_detected[] = _T("Nothing to do!");
1145 foreach ($ids as $id) {
1146 $is_manager = !$this->login
->isAdmin()
1147 && !$this->login
->isStaff()
1148 && $this->login
->isGroupManager();
1151 'groups' => $is_manager,
1154 'children' => false,
1157 $member = new Adherent($this->zdb
, (int)$id, $deps);
1158 $member->setDependencies(
1160 $this->members_fields
,
1163 if (!$member->canEdit($this->login
)) {
1167 $valid = $member->check($post, [], $disabled);
1168 if ($valid === true) {
1169 $done = $member->store();
1171 $error_detected[] = _T("An error occurred while storing the member.");
1176 $error_detected = array_merge($error_detected, $valid);
1182 if ($mass == 0 && !count($error_detected)) {
1183 $error_detected[] = _T('Something went wront during mass edition!');
1185 $this->flash
->addMessage(
1190 _T('%count members has been changed successfully!')
1195 if (count($error_detected) > 0) {
1196 foreach ($error_detected as $error) {
1197 $this->flash
->addMessage(
1204 if (!$request->isXhr()) {
1207 ->withHeader('Location', $redirect_url);
1209 return $response->withJson(
1211 'success' => count($error_detected) === 0
1220 * @param Request $request PSR Request
1221 * @param Response $response PSR Response
1222 * @param array $args Request arguments
1226 public function store(Request
$request, Response
$response, array $args = []) :Response
1228 if (!$this->preferences
->pref_bool_selfsubscribe
&& !$this->login
->isLogged()) {
1231 ->withHeader('Location', $this->router
->pathFor('slash'));
1234 $post = $request->getParsedBody();
1243 $member = new Adherent($this->zdb
, null, $deps);
1244 $member->setDependencies(
1246 $this->members_fields
,
1249 if (isset($args['self'])) {
1250 //mark as self membership
1251 $member->setSelfMembership();
1254 $success_detected = [];
1255 $warning_detected = [];
1256 $error_detected = [];
1259 $adherent['id_adh'] = get_numeric_form_value('id_adh', '');
1260 if ($adherent['id_adh']) {
1261 $member->load((int)$adherent['id_adh']);
1262 if (!$member->canEdit($this->login
)) {
1263 //redirection should have been done before. Just throw an Exception.
1264 throw new \
RuntimeException(
1268 'No right to store member #%id'
1273 $member->load($this->login
->id
);
1274 $adherent['id_adh'] = $this->login
->id
;
1277 // flagging required fields
1278 $fc = $this->fields_config
;
1280 // password required if we create a new member
1281 if ($member->id
!= '') {
1282 $fc->setNotRequired('mdp_adh');
1285 if ($member->hasParent() && !isset($post['detach_parent'])
1286 ||
isset($post['parent_id']) && !empty($post['parent_id'])
1288 $parent_fields = $member->getParentFields();
1289 foreach ($parent_fields as $field) {
1290 if ($fc->isRequired($field)) {
1291 $fc->setNotRequired($field);
1296 // flagging required fields invisible to members
1297 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1298 $fc->setNotRequired('activite_adh');
1299 $fc->setNotRequired('id_statut');
1302 $form_elements = $fc->getFormElements(
1305 isset($args['self'])
1307 $fieldsets = $form_elements['fieldsets'];
1308 $required = array();
1309 $disabled = array();
1311 foreach ($fieldsets as $category) {
1312 foreach ($category->elements
as $field) {
1313 if ($field->required
== true) {
1314 $required[$field->field_id
] = true;
1316 if ($field->disabled
== true) {
1317 $disabled[$field->field_id
] = true;
1318 } elseif (!isset($post[$field->field_id
])) {
1319 switch ($field->field_id
) {
1320 //unchecked booleans are not sent from form
1321 case 'bool_admin_adh':
1322 case 'bool_exempt_adh':
1323 case 'bool_display_info':
1324 $post[$field->field_id
] = 0;
1331 $real_requireds = array_diff(array_keys($required), array_keys($disabled));
1334 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1335 if (isset($post[array_shift($real_requireds)])) {
1337 $valid = $member->check($post, $required, $disabled);
1338 if ($valid !== true) {
1339 $error_detected = array_merge($error_detected, $valid);
1342 if (count($error_detected) == 0) {
1343 //all goes well, we can proceed
1346 if ($member->id
== '') {
1349 $store = $member->store();
1350 if ($store === true) {
1351 //member has been stored :)
1353 if (isset($args['self'])) {
1354 $success_detected[] = _T("Your account has been created!");
1355 if ($this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1356 && $member->getEmail() != ''
1358 $success_detected[] = _T("An email has been sent to you, check your inbox.");
1361 $success_detected[] = _T("New member has been successfully added.");
1363 //Send email to admin if preference checked
1364 if ($this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1365 && $this->preferences
->pref_bool_mailadh
1371 'name_adh' => custom_html_entity_decode(
1374 'firstname_adh' => custom_html_entity_decode(
1377 'lastname_adh' => custom_html_entity_decode(
1380 'mail_adh' => custom_html_entity_decode(
1383 'login_adh' => custom_html_entity_decode(
1388 $mtxt = $texts->getTexts(
1389 (isset($args['self']) ?
'newselfadh' : 'newadh'),
1390 $this->preferences
->pref_lang
1393 $mail = new GaletteMail($this->preferences
);
1394 $mail->setSubject($texts->getSubject());
1396 foreach ($this->preferences
->vpref_email_newadh
as $pref_email) {
1397 $recipients[$pref_email] = $pref_email;
1399 $mail->setRecipients($recipients);
1400 $mail->setMessage($texts->getBody());
1401 $sent = $mail->send();
1403 if ($sent == GaletteMail
::MAIL_SENT
) {
1404 $this->history
->add(
1407 $member->sname
. ' (' . $member->email
. ')',
1408 _T("New account email sent to admin for '%s'.")
1414 $member->sname
. ' (' . $member->email
. ')',
1415 _T("A problem happened while sending email to admin for account '%s'.")
1417 $this->history
->add($str);
1418 $warning_detected[] = $str;
1423 $success_detected[] = _T("Member account has been modified.");
1426 // send email to member
1427 if (isset($args['self']) ||
isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
1428 if ($this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
) {
1429 if ($member->getEmail() == '' && !isset($args['self'])) {
1430 $error_detected[] = _T("- You can't send a confirmation by email if the member hasn't got an address!");
1433 'name_adh' => custom_html_entity_decode(
1436 'firstname_adh' => custom_html_entity_decode(
1439 'lastname_adh' => custom_html_entity_decode(
1442 'mail_adh' => custom_html_entity_decode(
1445 'login_adh' => custom_html_entity_decode(
1450 $password = new Password($this->zdb
);
1451 $res = $password->generateNewPassword($member->id
);
1453 $link_validity = new DateTime();
1454 $link_validity->add(new DateInterval('PT24H'));
1455 $mreplaces['change_pass_uri'] = $this->preferences
->getURL() .
1456 $this->router
->pathFor(
1457 'password-recovery',
1458 ['hash' => base64_encode($password->getHash())]
1460 $mreplaces['link_validity'] = $link_validity->format(_T("Y-m-d H:i:s"));
1465 _T("An error occurred storing temporary password for %s. Please inform an admin.")
1467 $this->history
->add($str);
1468 $this->flash
->addMessage(
1475 //send email to member
1476 // Get email text in database
1482 $mlang = $this->preferences
->pref_lang
;
1483 if (isset($post['pref_lang'])) {
1484 $mlang = $post['pref_lang'];
1486 $mtxt = $texts->getTexts(
1487 (($new) ?
'sub' : 'accountedited'),
1491 $mail = new GaletteMail($this->preferences
);
1492 $mail->setSubject($texts->getSubject());
1493 $mail->setRecipients(
1495 $member->getEmail() => $member->sname
1498 $mail->setMessage($texts->getBody());
1499 $sent = $mail->send();
1501 if ($sent == GaletteMail
::MAIL_SENT
) {
1504 $member->sname
. ' (' . $member->getEmail() . ')',
1506 _T("New account email sent to '%s'.") :
1507 _T("Account modification email sent to '%s'.")
1509 $this->history
->add($msg);
1510 $success_detected[] = $msg;
1514 $member->sname
. ' (' . $member->getEmail() . ')',
1515 _T("A problem happened while sending account email to '%s'")
1517 $this->history
->add($str);
1518 $error_detected[] = $str;
1521 } elseif ($this->preferences
->pref_mail_method
== GaletteMail
::METHOD_DISABLED
) {
1522 //if email has been disabled in the preferences, we should not be here ;
1523 //we do not throw an error, just a simple warning that will be show later
1524 $msg = _T("You asked Galette to send a confirmation email to the member, but email has been disabled in the preferences.");
1525 $warning_detected[] = $msg;
1529 // send email to admin
1530 if ($this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1531 && $this->preferences
->pref_bool_mailadh
1533 && $member->id
== $this->login
->id
1536 'name_adh' => custom_html_entity_decode(
1539 'firstname_adh' => custom_html_entity_decode(
1542 'lastname_adh' => custom_html_entity_decode(
1545 'mail_adh' => custom_html_entity_decode(
1548 'login_adh' => custom_html_entity_decode(
1553 //send email to member
1554 // Get email text in database
1560 $mlang = $this->preferences
->pref_lang
;
1562 $mtxt = $texts->getTexts(
1567 $mail = new GaletteMail($this->preferences
);
1568 $mail->setSubject($texts->getSubject());
1570 foreach ($this->preferences
->vpref_email_newadh
as $pref_email) {
1571 $recipients[$pref_email] = $pref_email;
1573 $mail->setRecipients($recipients);
1575 $mail->setMessage($texts->getBody());
1576 $sent = $mail->send();
1578 if ($sent == GaletteMail
::MAIL_SENT
) {
1579 $msg = _T("Account modification email sent to admin.");
1580 $this->history
->add($msg);
1581 $success_detected[] = $msg;
1583 $str = _T("A problem happened while sending account email to admin");
1584 $this->history
->add($str);
1585 $warning_detected[] = $str;
1589 //store requested groups
1592 $managed_groups_adh = null;
1594 //add/remove user from groups
1595 if (isset($post['groups_adh'])) {
1596 $groups_adh = $post['groups_adh'];
1598 $add_groups = Groups
::addMemberToGroups(
1603 if ($add_groups === false) {
1604 $error_detected[] = _T("An error occurred adding member to its groups.");
1607 //add/remove manager from groups
1608 if (isset($post['groups_managed_adh'])) {
1609 $managed_groups_adh = $post['groups_managed_adh'];
1611 $add_groups = Groups
::addMemberToGroups(
1613 $managed_groups_adh,
1616 $member->loadGroups();
1618 if ($add_groups === false) {
1619 $error_detected[] = _T("An error occurred adding member to its groups as manager.");
1622 //something went wrong :'(
1623 $error_detected[] = _T("An error occurred while storing the member.");
1627 if (count($error_detected) == 0) {
1628 $files_res = $member->handleFiles($_FILES);
1629 if (is_array($files_res)) {
1630 $error_detected = array_merge($error_detected, $files_res);
1633 if (isset($post['del_photo'])) {
1634 if (!$member->picture
->delete($member->id
)) {
1635 $error_detected[] = _T("Delete failed");
1636 $str_adh = $member->id
. ' (' . $member->sname
. ' ' . ')';
1638 'Unable to delete picture for member ' . $str_adh,
1645 if (count($error_detected) > 0) {
1646 foreach ($error_detected as $error) {
1647 if (strpos($error, '%member_url_') !== false) {
1648 preg_match('/%member_url_(\d+)/', $error, $matches);
1649 $url = $this->router
->pathFor('member', ['id' => $matches[1]]);
1650 $error = str_replace(
1651 '%member_url_' . $matches[1],
1656 $this->flash
->addMessage(
1663 if (count($warning_detected) > 0) {
1664 foreach ($warning_detected as $warning) {
1665 $this->flash
->addMessage(
1671 if (count($success_detected) > 0) {
1672 foreach ($success_detected as $success) {
1673 $this->flash
->addMessage(
1680 if (count($error_detected) == 0) {
1681 if (isset($args['self'])) {
1682 $redirect_url = $this->router
->pathFor('login');
1683 } elseif (isset($post['redirect_on_create'])
1684 && $post['redirect_on_create'] > Adherent
::AFTER_ADD_DEFAULT
1686 switch ($post['redirect_on_create']) {
1687 case Adherent
::AFTER_ADD_TRANS
:
1688 $redirect_url = $this->router
->pathFor('transaction', ['action' => 'add']);
1690 case Adherent
::AFTER_ADD_NEW
:
1691 $redirect_url = $this->router
->pathFor('editmember', ['action' => 'add']);
1693 case Adherent
::AFTER_ADD_SHOW
:
1694 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1696 case Adherent
::AFTER_ADD_LIST
:
1697 $redirect_url = $this->router
->pathFor('members');
1699 case Adherent
::AFTER_ADD_HOME
:
1700 $redirect_url = $this->router
->pathFor('slash');
1703 } elseif (!isset($post['id_adh']) && !$member->isDueFree()) {
1704 $redirect_url = $this->router
->pathFor(
1710 ) . '?id_adh=' . $member->id
;
1712 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1715 //store entity in session
1716 $this->session
->member
= $member;
1718 if (isset($args['self'])) {
1719 $redirect_url = $this->router
->pathFor('subscribe');
1723 'id' => $member->id
,
1727 $rparams = ['action' => 'add'];
1729 $redirect_url = $this->router
->pathFor(
1739 ->withHeader('Location', $redirect_url);
1747 * Get redirection URI
1749 * @param array $args Route arguments
1753 public function redirectUri(array $args = [])
1755 return $this->router
->pathFor('members');
1761 * @param array $args Route arguments
1765 public function formUri(array $args = [])
1767 return $this->router
->pathFor(
1776 * In simple cases, we get the ID in the route arguments; but for
1777 * batchs, it should be found elsewhere.
1779 * @param array $args Request arguments
1781 * @return integer|null|array
1783 protected function getIdsToRemove($args)
1785 if (isset($args['id'])) {
1788 $filters = $this->session
->filter_members
;
1789 return $filters->selected
;
1794 * Get confirmation removal page title
1796 * @param array $args Route arguments
1800 public function confirmRemoveTitle(array $args = [])
1802 if (isset($args['id_adh'])) {
1803 //one member removal
1804 $adh = new Adherent($this->zdb
, (int)$args['id']);
1806 _T('Remove member %1$s'),
1810 //batch members removal
1811 $filters = $this->session
->filter_members
;
1814 count($filters->selected
),
1815 _T('You are about to remove %count members.')
1823 * @param array $args Route arguments
1824 * @param array $post POST values
1828 protected function doDelete(array $args, array $post)
1830 if (isset($this->session
->filter_members
)) {
1831 $filters = $this->session
->filter_members
;
1833 $filters = new MembersList();
1835 $members = new Members($filters);
1837 if (!is_array($post['id'])) {
1838 $ids = (array)$post['id'];
1843 return $members->removeMembers($ids);