3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Galette members controller
10 * Copyright © 2019-2021 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-2021 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 - 2019-12-02
37 namespace Galette\Controllers\Crud
;
39 use Galette\Controllers\CrudController
;
40 use Galette\DynamicFields\Boolean
;
41 use Slim\Http\Request
;
42 use Slim\Http\Response
;
43 use Galette\Core\Authentication
;
44 use Galette\Core\GaletteMail
;
45 use Galette\Core\Gaptcha
;
46 use Galette\Core\Password
;
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\Group
;
53 use Galette\Entity\Status
;
54 use Galette\Entity\FieldsConfig
;
55 use Galette\Filters\AdvancedMembersList
;
56 use Galette\Filters\MembersList
;
58 use Galette\IO\MembersCsv
;
59 use Galette\Repository\Groups
;
60 use Galette\Repository\Members
;
61 use Galette\Repository\PaymentTypes
;
62 use Galette\Repository\Titles
;
66 * Galette members controller
68 * @category Controllers
69 * @name GaletteController
71 * @author Johan Cwiklinski <johan@x-tnd.be>
72 * @copyright 2019-2020 The Galette Team
73 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
74 * @link http://galette.tuxfamily.org
75 * @since Available since 0.9.4dev - 2019-12-02
78 class MembersController
extends CrudController
81 private $is_self_membership = false;
88 * @param Request $request PSR Request
89 * @param Response $response PSR Response
93 public function add(Request
$request, Response
$response): Response
95 return $this->edit($request, $response, null, 'add');
99 * Self subscription page
101 * @param Request $request PSR Request
102 * @param Response $response PSR Response
106 public function selfSubscribe(Request
$request, Response
$response): Response
108 if (!$this->preferences
->pref_bool_selfsubscribe ||
$this->login
->isLogged()) {
111 ->withHeader('Location', $this->router
->pathFor('slash'));
114 if ($this->session
->member
!== null) {
115 $member = $this->session
->member
;
116 $this->session
->member
= null;
121 $member = new Adherent($this->zdb
, null, $deps);
124 //mark as self membership
125 $member->setSelfMembership();
127 // flagging required fields
128 $fc = $this->fields_config
;
129 $form_elements = $fc->getFormElements($this->login
, true, true);
133 $members = $m->getSelectizedMembers(
135 $member->hasParent() ?
$member->parent
->id
: null
140 'filters' => $m->getFilters(),
141 'count' => $m->getCount()
145 if (count($members)) {
146 $params['members']['list'] = $members;
149 $gaptcha = new Gaptcha($this->i18n
);
150 $this->session
->gaptcha
= $gaptcha;
156 'page_title' => _T("Subscription"),
157 'parent_tpl' => 'public_page.tpl',
160 'autocomplete' => true,
163 'titles_list' => Titles
::getList($this->zdb
),
164 'fieldsets' => $form_elements['fieldsets'],
165 'hidden_elements' => $form_elements['hiddens'],
167 'gaptcha' => $gaptcha
176 * @param Request $request PSR Request
177 * @param Response $response PSR Response
181 public function doAdd(Request
$request, Response
$response): Response
183 return $this->store($request, $response);
187 * Self subscription add action
189 * @param Request $request PSR Request
190 * @param Response $response PSR Response
194 public function doSelfSubscribe(Request
$request, Response
$response): Response
196 $this->setSelfMembership();
197 return $this->doAdd($request, $response);
204 * @param Request $request PSR Request
205 * @param Response $response PSR Response
206 * @param integer $id_adh Member ID to duplicate
210 public function duplicate(Request
$request, Response
$response, int $id_adh): Response
212 $adh = new Adherent($this->zdb
, $id_adh, ['dynamics' => true, 'parent' => true]);
213 $adh->setDuplicate();
215 //store entity in session
216 $this->session
->member
= $adh;
220 ->withHeader('Location', $this->router
->pathFor('addMember'));
227 * Display member card
229 * @param Request $request PSR Request
230 * @param Response $response PSR Response
231 * @param integer $id Member ID
235 public function show(Request
$request, Response
$response, int $id): Response
245 $member = new Adherent($this->zdb
, $id, $deps);
247 if (!$member->canEdit($this->login
)) {
248 $this->flash
->addMessage(
250 _T("You do not have permission for requested URL.")
257 $this->router
->pathFor('me')
261 if ($member->id
== null) {
262 //member does not exists!
263 $this->flash
->addMessage(
265 str_replace('%id', $id, _T("No member #%id."))
272 $this->router
->pathFor('slash')
276 // flagging fields visibility
277 $fc = $this->fields_config
;
278 $display_elements = $fc->getDisplayElements($this->login
);
285 'page_title' => _T("Member Profile"),
287 'pref_lang' => $this->i18n
->getNameFromId($member->language
),
288 'pref_card_self' => $this->preferences
->pref_card_self
,
289 'groups' => Groups
::getSimpleList(),
291 'display_elements' => $display_elements
300 * @param Request $request PSR Request
301 * @param Response $response PSR Response
305 public function showMe(Request
$request, Response
$response): Response
307 if ($this->login
->isSuperAdmin()) {
310 ->withHeader('Location', $this->router
->pathFor('slash'));
312 return $this->show($request, $response, $this->login
->id
);
316 * Public pages (trombinoscope, public list)
318 * @param Request $request PSR Request
319 * @param Response $response PSR Response
320 * @param string $option One of 'page' or 'order'
321 * @param string|integer $value Value of the option
322 * @param string $type List type (either list or trombi)
326 public function publicList(
333 $varname = 'public_filter_' . $type;
334 if (isset($this->session
->$varname)) {
335 $filters = $this->session
->$varname;
337 $filters = new MembersList();
340 if ($option !== null) {
343 $filters->current_page
= (int)$value;
346 $filters->orderby
= $value;
351 $m = new Members($filters);
352 $members = $m->getPublicList($type === 'trombi');
354 $this->session
->$varname = $filters;
356 //assign pagination variables to the template and add pagination links
357 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
362 ($type === 'list' ?
'liste_membres' : 'trombinoscope') . '.tpl',
364 'page_title' => ($type === 'list' ?
_T("Members list") : _T('Trombinoscope')),
365 'additionnal_html_class' => ($type === 'list' ?
'' : 'trombinoscope'),
367 'members' => $members,
368 'nb_members' => $m->getCount(),
369 'filters' => $filters
376 * Public pages (trombinoscope, public list)
378 * @param Request $request PSR Request
379 * @param Response $response PSR Response
380 * @param string $type Type
384 public function filterPublicList(Request
$request, Response
$response, string $type): Response
386 $post = $request->getParsedBody();
388 $varname = 'public_filter_' . $type;
389 if (isset($this->session
->$varname)) {
390 $filters = $this->session
->$varname;
392 $filters = new MembersList();
395 //reintialize filters
396 if (isset($post['clear_filter'])) {
399 //number of rows to show
400 if (isset($post['nbshow'])) {
401 $filters->show
= (int)$post['nbshow'];
405 $this->session
->$varname = $filters;
409 ->withHeader('Location', $this->router
->pathFor('publicList', ['type' => $type]));
415 * @param Request $request PSR Request
416 * @param Response $response PSR Response
417 * @param integer $id Member ID
418 * @param integer $fid Dynamic fields ID
419 * @param integer $pos Dynamic field position
420 * @param string $name File name
424 public function getDynamicFile(
440 $member = new Adherent($this->zdb
, $id, $deps);
443 if (!$member->canEdit($this->login
)) {
444 $fields = $member->getDynamicFields()->getFields();
445 if (!isset($fields[$fid])) {
446 //field does not exists or access is forbidden
453 if ($denied === true) {
454 $this->flash
->addMessage(
456 _T("You do not have permission for requested URL.")
463 $this->router
->pathFor(
470 $filename = str_replace(
481 'member_%mid_field_%fid_value_%pos'
484 if (file_exists(GALETTE_FILES_PATH
. $filename)) {
485 $type = File
::getMimeType(GALETTE_FILES_PATH
. $filename);
487 $response = $response->withHeader('Content-Description', 'File Transfer')
488 ->withHeader('Content-Type', $type)
489 ->withHeader('Content-Disposition', 'attachment;filename="' . $name . '"')
490 ->withHeader('Pragma', 'no-cache')
491 ->withHeader('Content-Transfer-Encoding', 'binary')
492 ->withHeader('Expires', '0')
493 ->withHeader('Cache-Control', 'must-revalidate')
494 ->withHeader('Pragma', 'public');
496 $stream = fopen('php://memory', 'r+');
497 fwrite($stream, file_get_contents(GALETTE_FILES_PATH
. $filename));
500 return $response->withBody(new \Slim\Http\
Stream($stream));
503 'A request has been made to get a dynamic file named `' .
504 $filename . '` that does not exists.',
508 $this->flash
->addMessage(
510 _T("The file does not exists or cannot be read :(")
517 $this->router
->pathFor('member', ['id' => $id])
525 * @param Request $request PSR Request
526 * @param Response $response PSR Response
527 * @param string $option One of 'page' or 'order'
528 * @param string|integer $value Value of the option
532 public function list(Request
$request, Response
$response, $option = null, $value = null): Response
534 if (isset($this->session
->filter_members
)) {
535 $filters = $this->session
->filter_members
;
537 $filters = new MembersList();
540 if ($option !== null) {
543 $filters->current_page
= (int)$value;
546 $filters->orderby
= $value;
551 $members = new Members($filters);
553 $members_list = array();
554 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
555 $members_list = $members->getMembersList(true);
557 $members_list = $members->getManagedMembersList(true);
560 $groups = new Groups($this->zdb
, $this->login
);
561 $groups_list = $groups->getList();
563 //assign pagination variables to the template and add pagination links
564 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
565 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
567 $this->session
->filter_members
= $filters;
572 'gestion_adherents.tpl',
574 'page_title' => _T("Members management"),
575 'require_mass' => true,
576 'members' => $members_list,
577 'filter_groups_options' => $groups_list,
578 'nb_members' => $members->getCount(),
579 'filters' => $filters,
580 'adv_filters' => $filters instanceof AdvancedMembersList
,
581 'galette_list' => $this->lists_config
->getDisplayElements($this->login
)
590 * @param Request $request PSR Request
591 * @param Response $response PSR Response
595 public function filter(Request
$request, Response
$response): Response
597 $post = $request->getParsedBody();
598 if (isset($this->session
->filter_members
)) {
599 //CAUTION: this one may be simple or advanced, display must change
600 $filters = $this->session
->filter_members
;
602 $filters = new MembersList();
605 //reintialize filters
606 if (isset($post['clear_filter'])) {
607 $filters = new MembersList();
608 } elseif (isset($post['clear_adv_filter'])) {
609 $this->session
->filter_members
= null;
610 unset($this->session
->filter_members
);
614 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
615 } elseif (isset($post['adv_criteria'])) {
618 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
621 if (isset($post['filter_str'])) { //filter search string
622 $filters->filter_str
= stripslashes(
623 htmlspecialchars($post['filter_str'], ENT_QUOTES
)
627 if (isset($post['field_filter'])) {
628 if (is_numeric($post['field_filter'])) {
629 $filters->field_filter
= $post['field_filter'];
632 //membership to filter
633 if (isset($post['membership_filter'])) {
634 if (is_numeric($post['membership_filter'])) {
635 $filters->membership_filter
636 = $post['membership_filter'];
639 //account status to filter
640 if (isset($post['filter_account'])) {
641 if (is_numeric($post['filter_account'])) {
642 $filters->filter_account
= $post['filter_account'];
646 if (isset($post['email_filter'])) {
647 $filters->email_filter
= (int)$post['email_filter'];
651 isset($post['group_filter'])
652 && $post['group_filter'] > 0
654 $filters->group_filter
= (int)$post['group_filter'];
656 //number of rows to show
657 if (isset($post['nbshow'])) {
658 $filters->show
= (int)$post['nbshow'];
661 if (isset($post['advanced_filtering'])) {
662 if (!$filters instanceof AdvancedMembersList
) {
663 $filters = new AdvancedMembersList($filters);
667 unset($post['advanced_filtering']);
669 foreach ($post as $k => $v) {
670 if (strpos($k, 'free_', 0) === 0) {
673 foreach ($post['free_field'] as $f) {
676 && trim($post['free_text'][$i]) !== ''
678 $fs_search = htmlspecialchars($post['free_text'][$i], ENT_QUOTES
);
680 = (int)$post['free_logical_operator'][$i];
682 = (int)$post['free_query_operator'][$i];
683 $type = (int)$post['free_type'][$i];
688 'search' => $fs_search,
692 $filters->free_search
= $fs;
698 } elseif ($k == 'groups_search') {
700 $filters->groups_search_log_op
= (int)$post['groups_logical_operator'];
701 foreach ($post['groups_search'] as $g) {
702 if (trim($g) !== '') {
707 $filters->groups_search
= $gs;
713 case 'contrib_min_amount':
714 case 'contrib_max_amount':
715 if (trim($v) !== '') {
728 if (isset($post['savesearch'])) {
733 $this->router
->pathFor(
740 $this->session
->filter_members
= $filters;
744 ->withHeader('Location', $this->router
->pathFor('members'));
748 * Advanced search page
750 * @param Request $request PSR Request
751 * @param Response $response PSR Response
755 public function advancedSearch(Request
$request, Response
$response): Response
757 if (isset($this->session
->filter_members
)) {
758 $filters = $this->session
->filter_members
;
759 if (!$filters instanceof AdvancedMembersList
) {
760 $filters = new AdvancedMembersList($filters);
763 $filters = new AdvancedMembersList();
766 $groups = new Groups($this->zdb
, $this->login
);
767 $groups_list = $groups->getList();
769 //we want only visibles fields
770 $fields = $this->members_fields
;
771 $fc = $this->fields_config
;
772 $fc->filterVisible($this->login
, $fields);
774 //add status label search
775 if ($pos = array_search(Status
::PK
, array_keys($fields))) {
776 $fields = array_slice($fields, 0, $pos, true) +
777 ['status_label' => ['label' => _T('Status label')]] +
778 array_slice($fields, $pos, count($fields) - 1, true);
790 $member = new Adherent($this->zdb
, $this->login
->login
, $deps);
791 $adh_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $member);
793 $contrib = new Contribution($this->zdb
, $this->login
);
794 $contrib_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $contrib);
797 $statuts = new Status($this->zdb
);
799 //Contributions types
800 $ct = new ContributionsTypes($this->zdb
);
803 $ptypes = new PaymentTypes(
808 $ptlist = $ptypes->getList();
810 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
815 'advanced_search.tpl',
817 'page_title' => _T("Advanced search"),
818 'filter_groups_options' => $groups_list,
819 'search_fields' => $fields,
820 'adh_dynamics' => $adh_dynamics->getFields(),
821 'contrib_dynamics' => $contrib_dynamics->getFields(),
822 'statuts' => $statuts->getList(),
823 'contributions_types' => $ct->getList(),
824 'filters' => $filters,
825 'payments_types' => $ptlist
832 * Members list for ajax
834 * @param Request $request PSR Request
835 * @param Response $response PSR Response
836 * @param string $option One of 'page' or 'order'
837 * @param string|integer $value Value of the option
841 public function ajaxList(Request
$request, Response
$response, string $option = null, $value = null): Response
843 $post = $request->getParsedBody();
845 if (isset($this->session
->ajax_members_filters
)) {
846 $filters = $this->session
->ajax_members_filters
;
848 $filters = new MembersList();
851 if ($option == 'page') {
852 $filters->current_page
= (int)$value;
855 //numbers of rows to display
856 if (isset($post['nbshow']) && is_numeric($post['nbshow'])) {
857 $filters->show
= (int)$post['nbshow'];
860 $members = new Members($filters);
861 if (!$this->login
->isAdmin() && !$this->login
->isStaff()) {
862 if ($this->login
->isGroupManager()) {
863 $members_list = $members->getManagedMembersList(true);
868 [$this->login
->id
, $this->login
->login
],
869 'Trying to list group members without access from #%id (%login)'
873 throw new \
Exception('Access denied.');
876 $members_list = $members->getMembersList(true);
879 //assign pagination variables to the template and add pagination links
880 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
882 $this->session
->ajax_members_filters
= $filters;
884 $selected_members = null;
885 $unreachables_members = null;
886 if (!isset($post['from'])) {
887 $mailing = $this->session
->mailing
;
888 if (!isset($post['members'])) {
889 $selected_members = $mailing->recipients
;
890 $unreachables_members = $mailing->unreachables
;
893 $selected_members = $m->getArrayList($post['members']);
894 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
895 $unreachables_members = $m->getArrayList($post['unreachables']);
899 switch ($post['from']) {
901 if (!isset($post['gid'])) {
903 'Trying to list group members with no group id provided',
906 throw new \
Exception('A group id is required.');
908 if (!isset($post['members'])) {
909 $group = new Group((int)$post['gid']);
910 $selected_members = array();
911 if (!isset($post['mode']) ||
$post['mode'] == 'members') {
912 $selected_members = $group->getMembers();
913 } elseif ($post['mode'] == 'managers') {
914 $selected_members = $group->getManagers();
917 'Trying to list group members with unknown mode',
920 throw new \
Exception('Unknown mode.');
924 $selected_members = $m->getArrayList($post['members']);
925 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
926 $unreachables_members = $m->getArrayList($post['unreachables']);
931 if (!isset($post['id_adh'])) {
932 throw new \
RuntimeException(
933 'Current selected member must be excluded while attaching!'
941 'filters' => $filters,
942 'members_list' => $members_list,
943 'selected_members' => $selected_members,
944 'unreachables_members' => $unreachables_members
947 if (isset($post['multiple'])) {
948 $params['multiple'] = true;
951 if (isset($post['gid'])) {
952 $params['the_id'] = (int)$post['gid'];
955 if (isset($post['id_adh'])) {
956 $params['excluded'] = (int)$post['id_adh'];
969 * Batch actions handler
971 * @param Request $request PSR Request
972 * @param Response $response PSR Response
976 public function handleBatch(Request
$request, Response
$response): Response
978 $post = $request->getParsedBody();
980 if (isset($post['member_sel'])) {
981 if (isset($this->session
->filter_members
)) {
982 $filters = $this->session
->filter_members
;
984 $filters = new MembersList();
987 $filters->selected
= $post['member_sel'];
988 $this->session
->filter_members
= $filters;
990 if (isset($post['cards'])) {
993 ->withHeader('Location', $this->router
->pathFor('pdf-members-cards'));
996 if (isset($post['labels'])) {
999 ->withHeader('Location', $this->router
->pathFor('pdf-members-labels'));
1002 if (isset($post['mailing'])) {
1005 ->withHeader('Location', $this->router
->pathFor('mailing') . '?mailing_new=new');
1008 if (isset($post['attendance_sheet'])) {
1011 ->withHeader('Location', $this->router
->pathFor('attendance_sheet_details'));
1014 if (isset($post['csv'])) {
1017 ->withHeader('Location', $this->router
->pathFor('csv-memberslist'));
1020 if (isset($post['delete'])) {
1023 ->withHeader('Location', $this->router
->pathFor('removeMembers'));
1026 if (isset($post['masschange'])) {
1029 ->withHeader('Location', $this->router
->pathFor('masschangeMembers'));
1032 throw new \
RuntimeException('Does not know what to batch :(');
1034 $this->flash
->addMessage(
1036 _T("No member was selected, please check at least one name.")
1041 ->withHeader('Location', $this->router
->pathFor('members'));
1051 * @param Request $request PSR Request
1052 * @param Response $response PSR Response
1053 * @param mixed $id Member id/array of members id
1054 * @param string $action null or 'add'
1058 public function edit(
1073 //instanciate member object
1074 $member = new Adherent($this->zdb
, $id, $deps);
1076 if ($this->session
->member
!== null) {
1077 //retrieve from session, in add or edit
1078 $member = $this->session
->member
;
1079 $this->session
->member
= null;
1080 } elseif ($id !== null) {
1081 //load requested member
1083 if (!$member->canEdit($this->login
)) {
1084 $this->flash
->addMessage(
1086 _T("You do not have permission for requested URL.")
1093 $this->router
->pathFor('me')
1098 // flagging required fields
1099 $fc = $this->fields_config
;
1101 // password required if we create a new member
1102 if ($member->id
!= '') {
1103 $fc->setNotRequired('mdp_adh');
1106 //handle requirements for parent fields
1107 $parent_fields = $member->getParentFields();
1108 $tpl_parent_fields = []; //for JS when detaching
1109 foreach ($parent_fields as $field) {
1110 if ($fc->isRequired($field)) {
1111 $tpl_parent_fields[] = $field;
1112 if ($member->hasParent()) {
1113 $fc->setNotRequired($field);
1118 // flagging required fields invisible to members
1119 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1120 $fc->setNotRequired('activite_adh');
1121 $fc->setNotRequired('id_statut');
1124 // template variable declaration
1125 $title = _T("Member Profile");
1126 if ($member->id
!= '') {
1127 $title .= ' (' . _T("modification") . ')';
1129 $title .= ' (' . _T("creation") . ')';
1133 $statuts = new Status($this->zdb
);
1136 $groups = new Groups($this->zdb
, $this->login
);
1137 $groups_list = $groups->getSimpleList(true);
1139 $form_elements = $fc->getFormElements(
1147 if ($member->hasParent()) {
1148 $id = ($member->parent
instanceof Adherent ?
$member->parent
->id
: $member->parent
);
1150 $members = $m->getSelectizedMembers(
1155 $route_params['members'] = [
1156 'filters' => $m->getFilters(),
1157 'count' => $m->getCount()
1160 if (count($members)) {
1161 $route_params['members']['list'] = $members;
1165 $this->view
->render(
1169 'parent_tpl' => 'page.tpl',
1170 'autocomplete' => true,
1171 'page_title' => $title,
1172 'member' => $member,
1173 'self_adh' => false,
1174 // pseudo random int
1176 'titles_list' => Titles
::getList($this->zdb
),
1177 'statuts' => $statuts->getList(),
1178 'groups' => $groups_list,
1179 'fieldsets' => $form_elements['fieldsets'],
1180 'hidden_elements' => $form_elements['hiddens'],
1181 'parent_fields' => $tpl_parent_fields
1190 * @param Request $request PSR Request
1191 * @param Response $response PSR Response
1192 * @param integer $id Member id
1196 public function doEdit(Request
$request, Response
$response, int $id): Response
1198 return $this->store($request, $response);
1202 * Massive change page
1204 * @param Request $request PSR Request
1205 * @param Response $response PSR Response
1209 public function massChange(Request
$request, Response
$response): Response
1211 $filters = $this->session
->filter_members
;
1214 'id' => $filters->selected
,
1215 'redirect_uri' => $this->router
->pathFor('members')
1218 $fc = $this->fields_config
;
1219 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1227 'children' => false,
1230 $member = new Adherent($this->zdb
, null, $deps);
1233 $statuts = new Status($this->zdb
);
1236 $this->view
->render(
1238 'mass_change_members.tpl',
1240 'mode' => $request->isXhr() ?
'ajax' : '',
1241 'page_title' => str_replace(
1244 _T('Mass change %count members')
1246 'form_url' => $this->router
->pathFor('masschangeMembersReview'),
1247 'cancel_uri' => $this->router
->pathFor('members'),
1249 'member' => $member,
1250 'fieldsets' => $form_elements['fieldsets'],
1251 'titles_list' => Titles
::getList($this->zdb
),
1252 'statuts' => $statuts->getList(),
1253 'require_mass' => true
1260 * Massive changes validation page
1262 * @param Request $request PSR Request
1263 * @param Response $response PSR Response
1267 public function validateMassChange(Request
$request, Response
$response): Response
1269 $post = $request->getParsedBody();
1271 if (!isset($post['confirm'])) {
1272 $this->flash
->addMessage(
1274 _T("Mass changes has not been confirmed!")
1277 //we want only visibles fields
1278 $fc = $this->fields_config
;
1279 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1282 foreach ($form_elements['fieldsets'] as $form_element) {
1283 foreach ($form_element->elements
as $field) {
1285 isset($post['mass_' . $field->field_id
])
1286 && (isset($post[$field->field_id
]) ||
$field->type
=== FieldsConfig
::TYPE_BOOL
)
1288 $changes[$field->field_id
] = [
1289 'label' => $field->label
,
1290 'value' => $post[$field->field_id
] ??
0
1296 //handle dynamic fields
1305 $member = new Adherent($this->zdb
, null, $deps);
1306 $member->setDependencies(
1308 $this->members_fields
,
1311 $dynamic_fields = $member->getDynamicFields()->getFields();
1312 foreach ($dynamic_fields as $field) {
1313 $mass_id = 'mass_info_field_' . $field->getId();
1314 $field_id = 'info_field_' . $field->getId() . '_1';
1316 isset($post[$mass_id])
1317 && (isset($post[$field_id]) ||
$field instanceof Boolean
)
1319 $changes[$field_id] = [
1320 'label' => $field->getName(),
1321 'value' => $post[$field_id] ??
0
1327 $filters = $this->session
->filter_members
;
1329 'id' => $filters->selected
,
1330 'redirect_uri' => $this->router
->pathFor('members')
1334 $statuts = new Status($this->zdb
);
1337 $this->view
->render(
1339 'mass_change_members.tpl',
1341 'mode' => $request->isXhr() ?
'ajax' : '',
1342 'page_title' => str_replace(
1345 _T('Review mass change %count members')
1347 'form_url' => $this->router
->pathFor('massstoremembers'),
1348 'cancel_uri' => $this->router
->pathFor('members'),
1350 'titles_list' => Titles
::getList($this->zdb
),
1351 'statuts' => $statuts->getList(),
1352 'changes' => $changes
1359 * Do massive changes
1361 * @param Request $request PSR Request
1362 * @param Response $response PSR Response
1366 public function doMassChange(Request
$request, Response
$response): Response
1368 $post = $request->getParsedBody();
1369 $redirect_url = $post['redirect_uri'];
1370 $error_detected = [];
1372 $dynamic_fields = null;
1374 unset($post['redirect_uri']);
1375 if (!isset($post['confirm'])) {
1376 $error_detected[] = _T("Mass changes has not been confirmed!");
1378 unset($post['confirm']);
1382 $fc = $this->fields_config
;
1383 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1384 $disabled = $this->members_fields
;
1385 foreach (array_keys($post) as $key) {
1387 foreach ($form_elements['fieldsets'] as $fieldset) {
1388 if (isset($fieldset->elements
[$key])) {
1395 //try on dynamic fields
1396 if ($dynamic_fields === null) {
1397 //handle dynamic fields
1406 $member = new Adherent($this->zdb
, null, $deps);
1407 $member->setDependencies(
1409 $this->members_fields
,
1412 $dynamic_fields = $member->getDynamicFields()->getFields();
1414 foreach ($dynamic_fields as $field) {
1415 $field_id = 'info_field_' . $field->getId() . '_1';
1416 if ($key == $field_id) {
1425 'Permission issue mass editing field ' . $key,
1430 unset($disabled[$key]);
1434 if (!count($post)) {
1435 $error_detected[] = _T("Nothing to do!");
1437 foreach ($ids as $id) {
1438 $is_manager = !$this->login
->isAdmin()
1439 && !$this->login
->isStaff()
1440 && $this->login
->isGroupManager();
1443 'groups' => $is_manager,
1446 'children' => false,
1449 $member = new Adherent($this->zdb
, (int)$id, $deps);
1450 $member->setDependencies(
1452 $this->members_fields
,
1455 if (!$member->canEdit($this->login
)) {
1459 $valid = $member->check($post, [], $disabled);
1460 if ($valid === true) {
1461 $done = $member->store();
1463 $error_detected[] = _T("An error occurred while storing the member.");
1468 $error_detected = array_merge($error_detected, $valid);
1474 if ($mass == 0 && !count($error_detected)) {
1475 $error_detected[] = _T('Something went wront during mass edition!');
1477 $this->flash
->addMessage(
1482 _T('%count members has been changed successfully!')
1487 if (count($error_detected) > 0) {
1488 foreach ($error_detected as $error) {
1489 $this->flash
->addMessage(
1496 if (!$request->isXhr()) {
1499 ->withHeader('Location', $redirect_url);
1501 return $response->withJson(
1503 'success' => count($error_detected) === 0
1512 * @param Request $request PSR Request
1513 * @param Response $response PSR Response
1517 public function store(Request
$request, Response
$response): Response
1519 if (!$this->preferences
->pref_bool_selfsubscribe
&& !$this->login
->isLogged()) {
1522 ->withHeader('Location', $this->router
->pathFor('slash'));
1525 $post = $request->getParsedBody();
1534 $member = new Adherent($this->zdb
, null, $deps);
1535 $member->setDependencies(
1537 $this->members_fields
,
1541 $success_detected = [];
1542 $warning_detected = [];
1543 $error_detected = [];
1545 if ($this->isSelfMembership() && !isset($post[Adherent
::PK
])) {
1546 //mark as self membership
1547 $member->setSelfMembership();
1550 $gaptcha = $this->session
->gaptcha
;
1551 if (!$gaptcha->check($post['gaptcha'])) {
1552 $error_detected[] = _T('Invalid captcha');
1557 if ($this->login
->isAdmin() ||
$this->login
->isStaff() ||
$this->login
->isGroupManager()) {
1558 if (isset($post['id_adh'])) {
1559 $member->load((int)$post['id_adh']);
1560 if (!$member->canEdit($this->login
)) {
1561 //redirection should have been done before. Just throw an Exception.
1562 throw new \
RuntimeException(
1566 'No right to store member #%id'
1572 $member->load($this->login
->id
);
1575 // flagging required fields
1576 $fc = $this->fields_config
;
1578 // password required if we create a new member but not from self subscription
1579 if ($member->id
!= '' ||
$this->isSelfMembership()) {
1580 $fc->setNotRequired('mdp_adh');
1584 $member->hasParent() && !isset($post['detach_parent'])
1585 ||
isset($post['parent_id']) && !empty($post['parent_id'])
1587 $parent_fields = $member->getParentFields();
1588 foreach ($parent_fields as $field) {
1589 if ($fc->isRequired($field)) {
1590 $fc->setNotRequired($field);
1595 // flagging required fields invisible to members
1596 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1597 $fc->setNotRequired('activite_adh');
1598 $fc->setNotRequired('id_statut');
1601 $form_elements = $fc->getFormElements(
1604 $this->isSelfMembership()
1606 $fieldsets = $form_elements['fieldsets'];
1607 $required = array();
1608 $disabled = array();
1610 foreach ($fieldsets as $category) {
1611 foreach ($category->elements
as $field) {
1612 if ($field->required
== true) {
1613 $required[$field->field_id
] = true;
1615 if ($field->disabled
== true) {
1616 $disabled[$field->field_id
] = true;
1617 } elseif (!isset($post[$field->field_id
])) {
1618 switch ($field->field_id
) {
1619 //unchecked booleans are not sent from form
1620 case 'bool_admin_adh':
1621 case 'bool_exempt_adh':
1622 case 'bool_display_info':
1623 $post[$field->field_id
] = 0;
1630 $real_requireds = array_diff(array_keys($required), array_keys($disabled));
1633 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1634 if (!count($real_requireds) ||
isset($post[array_shift($real_requireds)])) {
1636 $valid = $member->check($post, $required, $disabled);
1637 if ($valid !== true) {
1638 $error_detected = array_merge($error_detected, $valid);
1641 if (count($error_detected) == 0) {
1642 //all goes well, we can proceed
1645 if ($member->id
== '') {
1649 // send email to member
1650 if ($this->isSelfMembership() ||
isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
1651 $member->setSendmail(); //flag to send creation email
1654 $store = $member->store();
1655 if ($store === true) {
1656 //member has been stored :)
1658 if ($this->isSelfMembership()) {
1659 $success_detected[] = _T("Your account has been created!");
1661 $this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1662 && $member->getEmail() != ''
1664 $success_detected[] = _T("An email has been sent to you, check your inbox.");
1667 $success_detected[] = _T("New member has been successfully added.");
1670 $success_detected[] = _T("Member account has been modified.");
1673 //store requested groups
1674 $groups_adh = $post['groups_adh'] ??
null;
1675 $managed_groups_adh = $post['groups_managed_adh'] ??
null;
1677 //add/remove user from groups
1678 $add_groups = Groups
::addMemberToGroups(
1683 if ($add_groups === false) {
1684 $error_detected[] = _T("An error occurred adding member to its groups.");
1687 //add/remove manager from groups
1688 $add_groups = Groups
::addMemberToGroups(
1690 $managed_groups_adh,
1693 $member->loadGroups();
1695 if ($add_groups === false) {
1696 $error_detected[] = _T("An error occurred adding member to its groups as manager.");
1699 //something went wrong :'(
1700 $error_detected[] = _T("An error occurred while storing the member.");
1704 if (count($error_detected) === 0) {
1705 $files_res = $member->handleFiles($_FILES);
1706 if (is_array($files_res)) {
1707 $error_detected = array_merge($error_detected, $files_res);
1710 if (isset($post['del_photo'])) {
1711 if (!$member->picture
->delete($member->id
)) {
1712 $error_detected[] = _T("Delete failed");
1713 $str_adh = $member->id
. ' (' . $member->sname
. ' ' . ')';
1715 'Unable to delete picture for member ' . $str_adh,
1722 if (count($error_detected) > 0) {
1723 foreach ($error_detected as $error) {
1724 if (strpos($error, '%member_url_') !== false) {
1725 preg_match('/%member_url_(\d+)/', $error, $matches);
1726 $url = $this->router
->pathFor('member', ['id' => $matches[1]]);
1727 $error = str_replace(
1728 '%member_url_' . $matches[1],
1733 $this->flash
->addMessage(
1740 if (count($warning_detected) > 0) {
1741 foreach ($warning_detected as $warning) {
1742 $this->flash
->addMessage(
1748 if (count($success_detected) > 0) {
1749 foreach ($success_detected as $success) {
1750 $this->flash
->addMessage(
1757 if (count($error_detected) === 0) {
1758 if ($this->isSelfMembership()) {
1759 $redirect_url = $this->router
->pathFor('login');
1761 isset($post['redirect_on_create'])
1762 && $post['redirect_on_create'] > Adherent
::AFTER_ADD_DEFAULT
1764 switch ($post['redirect_on_create']) {
1765 case Adherent
::AFTER_ADD_TRANS
:
1766 $redirect_url = $this->router
->pathFor('addTransaction');
1768 case Adherent
::AFTER_ADD_NEW
:
1769 $redirect_url = $this->router
->pathFor('addMember');
1771 case Adherent
::AFTER_ADD_SHOW
:
1772 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1774 case Adherent
::AFTER_ADD_LIST
:
1775 $redirect_url = $this->router
->pathFor('members');
1777 case Adherent
::AFTER_ADD_HOME
:
1778 $redirect_url = $this->router
->pathFor('slash');
1781 } elseif (!isset($post['id_adh']) && !$member->isDueFree()) {
1782 $redirect_url = $this->router
->pathFor(
1785 ) . '?id_adh=' . $member->id
;
1787 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1790 //store entity in session
1791 $this->session
->member
= $member;
1793 if ($this->isSelfMembership()) {
1794 $redirect_url = $this->router
->pathFor('subscribe');
1797 $redirect_url = $this->router
->pathFor(
1799 ['id' => $member->id
]
1802 $redirect_url = $this->router
->pathFor('addMember');
1810 ->withHeader('Location', $redirect_url);
1818 * Get redirection URI
1820 * @param array $args Route arguments
1824 public function redirectUri(array $args)
1826 return $this->router
->pathFor('members');
1832 * @param array $args Route arguments
1836 public function formUri(array $args)
1838 return $this->router
->pathFor(
1848 * In simple cases, we get the ID in the route arguments; but for
1849 * batchs, it should be found elsewhere.
1850 * In post values, we look for id key, as well as all {sthing}_sel keys (like members_sel or contrib_sel)
1852 * @param array $args Request arguments
1853 * @param array $post POST values
1855 * @return null|integer|integer[]
1857 protected function getIdsToRemove(&$args, $post)
1859 if (isset($args['id'])) {
1862 $filters = $this->session
->filter_members
;
1863 return $filters->selected
;
1868 * Get confirmation removal page title
1870 * @param array $args Route arguments
1874 public function confirmRemoveTitle(array $args)
1876 if (isset($args['id_adh']) ||
isset($args['id'])) {
1877 //one member removal
1878 $id_adh = $args['id_adh'] ??
$args['id'];
1879 $adh = new Adherent($this->zdb
, (int)$id_adh);
1881 _T('Remove member %1$s'),
1885 //batch members removal
1886 $filters = $this->session
->filter_members
;
1889 count($filters->selected
),
1890 _T('You are about to remove %count members.')
1898 * @param array $args Route arguments
1899 * @param array $post POST values
1903 protected function doDelete(array $args, array $post)
1905 if (isset($this->session
->filter_members
)) {
1906 $filters = $this->session
->filter_members
;
1908 $filters = new MembersList();
1910 $members = new Members($filters);
1912 if (!is_array($post['id'])) {
1913 $ids = (array)$post['id'];
1918 return $members->removeMembers($ids);
1924 * Set self memebrship flag
1926 * @return MembersController
1928 private function setSelfMembership(): MembersController
1930 $this->is_self_membership
= true;
1935 * Is self membership?
1939 private function isSelfMembership(): bool
1941 return $this->is_self_membership
;