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
;
41 use Slim\Http\Request
;
42 use Slim\Http\Response
;
43 use Galette\Core\Authentication
;
44 use Galette\Core\GaletteMail
;
45 use Galette\Core\Password
;
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\Group
;
53 use Galette\Entity\Status
;
54 use Galette\Entity\FieldsConfig
;
55 use Galette\Entity\Texts
;
56 use Galette\Filters\AdvancedMembersList
;
57 use Galette\Filters\MembersList
;
59 use Galette\IO\MembersCsv
;
60 use Galette\Repository\Groups
;
61 use Galette\Repository\Members
;
62 use Galette\Repository\PaymentTypes
;
63 use Galette\Repository\Titles
;
67 * Galette members controller
69 * @category Controllers
70 * @name GaletteController
72 * @author Johan Cwiklinski <johan@x-tnd.be>
73 * @copyright 2019-2020 The Galette Team
74 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
75 * @link http://galette.tuxfamily.org
76 * @since Available since 0.9.4dev - 2019-12-02
79 class MembersController
extends CrudController
86 * @param Request $request PSR Request
87 * @param Response $response PSR Response
88 * @param array $args Request arguments
92 public function add(Request
$request, Response
$response, array $args = []): Response
94 return $this->edit($request, $response, $args);
98 * Self subscription page
100 * @param Request $request PSR Request
101 * @param Response $response PSR Response
102 * @param array $args Request arguments
106 public function selfSubscribe(Request
$request, Response
$response, array $args = []): 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);
131 //image to defeat mass filling forms
132 $spam = new PasswordImage();
133 $spam_pass = $spam->newImage();
134 $spam_img = $spam->getImage();
138 $members = $m->getSelectizedMembers(
140 $member->hasParent() ?
$member->parent
->id
: null
143 $params['members'] = [
144 'filters' => $m->getFilters(),
145 'count' => $m->getCount()
148 if (count($members)) {
149 $params['members']['list'] = $members;
157 'page_title' => _T("Subscription"),
158 'parent_tpl' => 'public_page.tpl',
161 'autocomplete' => true,
164 'titles_list' => Titles
::getList($this->zdb
),
166 'spam_pass' => $spam_pass,
167 'spam_img' => $spam_img,
168 'fieldsets' => $form_elements['fieldsets'],
169 'hidden_elements' => $form_elements['hiddens']
178 * @param Request $request PSR Request
179 * @param Response $response PSR Response
180 * @param array $args Request arguments
184 public function doAdd(Request
$request, Response
$response, array $args = []): Response
186 return $this->store($request, $response, $args);
192 * @param Request $request PSR Request
193 * @param Response $response PSR Response
194 * @param array $args Request arguments
198 public function duplicate(Request
$request, Response
$response, array $args = []): Response
200 $id_adh = (int)$args[Adherent
::PK
];
201 $adh = new Adherent($this->zdb
, $id_adh, ['dynamics' => true, 'parent' => true]);
202 $adh->setDuplicate();
204 //store entity in session
205 $this->session
->member
= $adh;
209 ->withHeader('Location', $this->router
->pathFor('editmember', ['action' => 'add']));
216 * Display member card
218 * @param Request $request PSR Request
219 * @param Response $response PSR Response
220 * @param array $args Request arguments
224 public function show(Request
$request, Response
$response, array $args): Response
226 $id = (int)$args['id'];
236 $member = new Adherent($this->zdb
, $id, $deps);
238 if (!$member->canEdit($this->login
)) {
239 $this->flash
->addMessage(
241 _T("You do not have permission for requested URL.")
248 $this->router
->pathFor('me')
252 if ($member->id
== null) {
253 //member does not exists!
254 $this->flash
->addMessage(
256 str_replace('%id', $args['id'], _T("No member #%id."))
263 $this->router
->pathFor('slash')
267 // flagging fields visibility
268 $fc = $this->fields_config
;
269 $display_elements = $fc->getDisplayElements($this->login
);
276 'page_title' => _T("Member Profile"),
278 'pref_lang' => $this->i18n
->getNameFromId($member->language
),
279 'pref_card_self' => $this->preferences
->pref_card_self
,
280 'groups' => Groups
::getSimpleList(),
282 'display_elements' => $display_elements
291 * @param Request $request PSR Request
292 * @param Response $response PSR Response
293 * @param array $args Request arguments
297 public function showMe(Request
$request, Response
$response, array $args = []): Response
299 if ($this->login
->isSuperAdmin()) {
302 ->withHeader('Location', $this->router
->pathFor('slash'));
304 $args['show_me'] = true;
305 $args['id'] = $this->login
->id
;
306 return $this->show($request, $response, $args);
310 * Public pages (trombinoscope, public list)
312 * @param Request $request PSR Request
313 * @param Response $response PSR Response
314 * @param array $args Request arguments
318 public function publicList(Request
$request, Response
$response, array $args = []): Response
321 $type = $args['type'];
322 if (isset($args['option'])) {
323 $option = $args['option'];
326 if (isset($args['value'])) {
327 $value = $args['value'];
330 $varname = 'public_filter_' . $type;
331 if (isset($this->session
->$varname)) {
332 $filters = $this->session
->$varname;
334 $filters = new MembersList();
337 if ($option !== null) {
340 $filters->current_page
= (int)$value;
343 $filters->orderby
= $value;
348 $m = new Members($filters);
349 $members = $m->getPublicList($type === 'trombi');
351 $this->session
->$varname = $filters;
353 //assign pagination variables to the template and add pagination links
354 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
359 ($type === 'list' ?
'liste_membres' : 'trombinoscope') . '.tpl',
361 'page_title' => ($type === 'list' ?
_T("Members list") : _T('Trombinoscope')),
362 'additionnal_html_class' => ($type === 'list' ?
'' : 'trombinoscope'),
364 'members' => $members,
365 'nb_members' => $m->getCount(),
366 'filters' => $filters
373 * Public pages (trombinoscope, public list)
375 * @param Request $request PSR Request
376 * @param Response $response PSR Response
377 * @param array $args Request arguments
381 public function filterPublicList(Request
$request, Response
$response, array $args = []): Response
383 $type = $args['type'];
384 $post = $request->getParsedBody();
386 $varname = 'public_filter_' . $type;
387 if (isset($this->session
->$varname)) {
388 $filters = $this->session
->$varname;
390 $filters = new MembersList();
393 //reintialize filters
394 if (isset($post['clear_filter'])) {
397 //number of rows to show
398 if (isset($post['nbshow'])) {
399 $filters->show
= $post['nbshow'];
403 $this->session
->$varname = $filters;
407 ->withHeader('Location', $this->router
->pathFor('publicList', ['type' => $type]));
413 * @param Request $request PSR Request
414 * @param Response $response PSR Response
415 * @param array $args Request arguments
419 public function getDynamicFile(Request
$request, Response
$response, array $args): Response
421 $id = (int)$args['id'];
430 $member = new Adherent($this->zdb
, $id, $deps);
433 if (!$member->canEdit($this->login
)) {
434 $fields = $member->getDynamicFields()->getFields();
435 if (!isset($fields[$args['fid']])) {
436 //field does not exists or access is forbidden
443 if ($denied === true) {
444 $this->flash
->addMessage(
446 _T("You do not have permission for requested URL.")
453 $this->router
->pathFor(
460 $filename = str_replace(
471 'member_%mid_field_%fid_value_%pos'
474 if (file_exists(GALETTE_FILES_PATH
. $filename)) {
475 $type = File
::getMimeType(GALETTE_FILES_PATH
. $filename);
476 $response = $response
477 ->withHeader('Content-Type', $type)
478 ->withHeader('Content-Disposition', 'attachment;filename="' . $args['name'] . '"')
479 ->withHeader('Pragma', 'no-cache');
480 $response->write(readfile(GALETTE_FILES_PATH
. $filename));
484 'A request has been made to get an exported file named `' .
485 $filename . '` that does not exists.',
489 $this->flash
->addMessage(
491 _T("The file does not exists or cannot be read :(")
498 $this->router
->pathFor('member', ['id' => $args['id']])
506 * @param Request $request PSR Request
507 * @param Response $response PSR Response
508 * @param array $args Request arguments
512 public function list(Request
$request, Response
$response, array $args = []): Response
514 $option = $args['option'] ??
null;
515 $value = $args['value'] ??
null;
517 if (isset($this->session
->filter_members
)) {
518 $filters = $this->session
->filter_members
;
520 $filters = new MembersList();
523 if ($option !== null) {
526 $filters->current_page
= (int)$value;
529 $filters->orderby
= $value;
534 $members = new Members($filters);
536 $members_list = array();
537 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
538 $members_list = $members->getMembersList(true);
540 $members_list = $members->getManagedMembersList(true);
543 $groups = new Groups($this->zdb
, $this->login
);
544 $groups_list = $groups->getList();
546 //assign pagination variables to the template and add pagination links
547 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
548 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
550 $this->session
->filter_members
= $filters;
555 'gestion_adherents.tpl',
557 'page_title' => _T("Members management"),
558 'require_mass' => true,
559 'members' => $members_list,
560 'filter_groups_options' => $groups_list,
561 'nb_members' => $members->getCount(),
562 'filters' => $filters,
563 'adv_filters' => $filters instanceof AdvancedMembersList
,
564 'galette_list' => $this->lists_config
->getDisplayElements($this->login
)
573 * @param Request $request PSR Request
574 * @param Response $response PSR Response
578 public function filter(Request
$request, Response
$response): Response
580 $post = $request->getParsedBody();
581 if (isset($this->session
->filter_members
)) {
582 //CAUTION: this one may be simple or advanced, display must change
583 $filters = $this->session
->filter_members
;
585 $filters = new MembersList();
588 //reintialize filters
589 if (isset($post['clear_filter'])) {
590 $filters = new MembersList();
591 } elseif (isset($post['clear_adv_filter'])) {
592 $this->session
->filter_members
= null;
593 unset($this->session
->filter_members
);
597 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
598 } elseif (isset($post['adv_criteria'])) {
601 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
604 if (isset($post['filter_str'])) { //filter search string
605 $filters->filter_str
= stripslashes(
606 htmlspecialchars($post['filter_str'], ENT_QUOTES
)
610 if (isset($post['field_filter'])) {
611 if (is_numeric($post['field_filter'])) {
612 $filters->field_filter
= $post['field_filter'];
615 //membership to filter
616 if (isset($post['membership_filter'])) {
617 if (is_numeric($post['membership_filter'])) {
618 $filters->membership_filter
619 = $post['membership_filter'];
622 //account status to filter
623 if (isset($post['filter_account'])) {
624 if (is_numeric($post['filter_account'])) {
625 $filters->filter_account
= $post['filter_account'];
629 if (isset($post['email_filter'])) {
630 $filters->email_filter
= (int)$post['email_filter'];
634 isset($post['group_filter'])
635 && $post['group_filter'] > 0
637 $filters->group_filter
= (int)$post['group_filter'];
639 //number of rows to show
640 if (isset($post['nbshow'])) {
641 $filters->show
= $post['nbshow'];
644 if (isset($post['advanced_filtering'])) {
645 if (!$filters instanceof AdvancedMembersList
) {
646 $filters = new AdvancedMembersList($filters);
650 unset($post['advanced_filtering']);
652 foreach ($post as $k => $v) {
653 if (strpos($k, 'free_', 0) === 0) {
656 foreach ($post['free_field'] as $f) {
659 && trim($post['free_text'][$i]) !== ''
661 $fs_search = $post['free_text'][$i];
663 = (int)$post['free_logical_operator'][$i];
665 = (int)$post['free_query_operator'][$i];
666 $type = (int)$post['free_type'][$i];
671 'search' => $fs_search,
675 $filters->free_search
= $fs;
681 } elseif ($k == 'groups_search') {
683 $filters->groups_search_log_op
= (int)$post['groups_logical_operator'];
684 foreach ($post['groups_search'] as $g) {
685 if (trim($g) !== '') {
690 $filters->groups_search
= $gs;
696 case 'contrib_min_amount':
697 case 'contrib_max_amount':
698 if (trim($v) !== '') {
711 if (isset($post['savesearch'])) {
716 $this->router
->pathFor(
723 $this->session
->filter_members
= $filters;
727 ->withHeader('Location', $this->router
->pathFor('members'));
731 * Advanced search page
733 * @param Request $request PSR Request
734 * @param Response $response PSR Response
738 public function advancedSearch(Request
$request, Response
$response): Response
740 if (isset($this->session
->filter_members
)) {
741 $filters = $this->session
->filter_members
;
742 if (!$filters instanceof AdvancedMembersList
) {
743 $filters = new AdvancedMembersList($filters);
746 $filters = new AdvancedMembersList();
749 $groups = new Groups($this->zdb
, $this->login
);
750 $groups_list = $groups->getList();
752 //we want only visibles fields
753 $fields = $this->members_fields
;
754 $fc = $this->fields_config
;
755 $visibles = $fc->getVisibilities();
756 $access_level = $this->login
->getAccessLevel();
758 //remove not searchable fields
759 unset($fields['mdp_adh']);
761 foreach ($fields as $k => $f) {
763 $visibles[$k] == FieldsConfig
::NOBODY ||
764 ($visibles[$k] == FieldsConfig
::ADMIN
&&
765 $access_level < Authentication
::ACCESS_ADMIN
) ||
766 ($visibles[$k] == FieldsConfig
::STAFF
&&
767 $access_level < Authentication
::ACCESS_STAFF
) ||
768 ($visibles[$k] == FieldsConfig
::MANAGER
&&
769 $access_level < Authentication
::ACCESS_MANAGER
)
775 //add status label search
776 if ($pos = array_search(Status
::PK
, array_keys($fields))) {
777 $fields = array_slice($fields, 0, $pos, true) +
778 ['status_label' => ['label' => _T('Status label')]] +
779 array_slice($fields, $pos, count($fields) - 1, true);
791 $member = new Adherent($this->zdb
, $this->login
->login
, $deps);
792 $adh_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $member);
794 $contrib = new Contribution($this->zdb
, $this->login
);
795 $contrib_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $contrib);
798 $statuts = new Status($this->zdb
);
800 //Contributions types
801 $ct = new ContributionsTypes($this->zdb
);
804 $ptypes = new PaymentTypes(
809 $ptlist = $ptypes->getList();
811 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
816 'advanced_search.tpl',
818 'page_title' => _T("Advanced search"),
819 'filter_groups_options' => $groups_list,
820 'search_fields' => $fields,
821 'adh_dynamics' => $adh_dynamics->getFields(),
822 'contrib_dynamics' => $contrib_dynamics->getFields(),
823 'statuts' => $statuts->getList(),
824 'contributions_types' => $ct->getList(),
825 'filters' => $filters,
826 'payments_types' => $ptlist
833 * Members list for ajax
835 * @param Request $request PSR Request
836 * @param Response $response PSR Response
837 * @param array $args Request arguments
841 public function ajaxList(Request
$request, Response
$response, array $args = []): 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 (isset($args['option']) && $args['option'] == 'page') {
852 $filters->current_page
= (int)$args['value'];
855 //numbers of rows to display
856 if (isset($post['nbshow']) && is_numeric($post['nbshow'])) {
857 $filters->show
= $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.');
909 if (!isset($post['members'])) {
910 $group = new Group((int)$post['gid']);
911 $selected_members = array();
912 if (!isset($post['mode']) ||
$post['mode'] == 'members') {
913 $selected_members = $group->getMembers();
914 } elseif ($post['mode'] == 'managers') {
915 $selected_members = $group->getManagers();
918 'Trying to list group members with unknown mode',
921 throw new \
Exception('Unknown mode.');
926 $selected_members = $m->getArrayList($post['members']);
927 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
928 $unreachables_members = $m->getArrayList($post['unreachables']);
933 if (!isset($post['id_adh'])) {
934 throw new \
RuntimeException(
935 'Current selected member must be excluded while attaching!'
944 'filters' => $filters,
945 'members_list' => $members_list,
946 'selected_members' => $selected_members,
947 'unreachables_members' => $unreachables_members
950 if (isset($post['multiple'])) {
951 $params['multiple'] = true;
954 if (isset($post['gid'])) {
955 $params['the_id'] = $post['gid'];
958 if (isset($post['id_adh'])) {
959 $params['excluded'] = $post['id_adh'];
972 * Batch actions handler
974 * @param Request $request PSR Request
975 * @param Response $response PSR Response
979 public function handleBatch(Request
$request, Response
$response): Response
981 $post = $request->getParsedBody();
983 if (isset($post['member_sel'])) {
984 if (isset($this->session
->filter_members
)) {
985 $filters = $this->session
->filter_members
;
987 $filters = new MembersList();
990 $filters->selected
= $post['member_sel'];
991 $this->session
->filter_members
= $filters;
993 if (isset($post['cards'])) {
996 ->withHeader('Location', $this->router
->pathFor('pdf-members-cards'));
999 if (isset($post['labels'])) {
1002 ->withHeader('Location', $this->router
->pathFor('pdf-members-labels'));
1005 if (isset($post['mailing'])) {
1008 ->withHeader('Location', $this->router
->pathFor('mailing') . '?mailing_new=new');
1011 if (isset($post['attendance_sheet'])) {
1014 ->withHeader('Location', $this->router
->pathFor('attendance_sheet_details'));
1017 if (isset($post['csv'])) {
1020 ->withHeader('Location', $this->router
->pathFor('csv-memberslist'));
1023 if (isset($post['delete'])) {
1026 ->withHeader('Location', $this->router
->pathFor('removeMembers'));
1029 if (isset($post['masschange'])) {
1032 ->withHeader('Location', $this->router
->pathFor('masschangeMembers'));
1035 throw new \
RuntimeException('Does not know what to batch :(');
1037 $this->flash
->addMessage(
1039 _T("No member was selected, please check at least one name.")
1044 ->withHeader('Location', $this->router
->pathFor('members'));
1054 * @param Request $request PSR Request
1055 * @param Response $response PSR Response
1056 * @param array $args Request arguments
1060 public function edit(Request
$request, Response
$response, array $args = []): Response
1062 $action = $args['action'];
1064 if (isset($args['id'])) {
1065 $id = (int)$args['id'];
1068 if ($action === 'edit' && $id === null) {
1069 throw new \
RuntimeException(
1070 _T("Member ID cannot ben null calling edit route!")
1072 } elseif ($action === 'add' && $id !== null) {
1075 ->withHeader('Location', $this->router
->pathFor('editmember', ['action' => 'add']));
1086 if ($this->session
->member
!== null) {
1087 $member = $this->session
->member
;
1088 $this->session
->member
= null;
1090 $member = new Adherent($this->zdb
, $id, $deps);
1095 if (!$member->canEdit($this->login
)) {
1096 $this->flash
->addMessage(
1098 _T("You do not have permission for requested URL.")
1105 $this->router
->pathFor('me')
1109 if ($member->id
!= $id) {
1110 $member->load($this->login
->id
);
1114 // flagging required fields
1115 $fc = $this->fields_config
;
1117 // password required if we create a new member
1118 if ($member->id
!= '') {
1119 $fc->setNotRequired('mdp_adh');
1122 //handle requirements for parent fields
1123 $parent_fields = $member->getParentFields();
1124 $tpl_parent_fields = []; //for JS when detaching
1125 foreach ($parent_fields as $field) {
1126 if ($fc->isRequired($field)) {
1127 $tpl_parent_fields[] = $field;
1128 if ($member->hasParent()) {
1129 $fc->setNotRequired($field);
1134 // flagging required fields invisible to members
1135 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1136 $fc->setNotRequired('activite_adh');
1137 $fc->setNotRequired('id_statut');
1140 // template variable declaration
1141 $title = _T("Member Profile");
1142 if ($member->id
!= '') {
1143 $title .= ' (' . _T("modification") . ')';
1145 $title .= ' (' . _T("creation") . ')';
1149 $statuts = new Status($this->zdb
);
1152 $groups = new Groups($this->zdb
, $this->login
);
1153 $groups_list = $groups->getSimpleList(true);
1155 $form_elements = $fc->getFormElements(
1163 if ($member->hasParent()) {
1164 $id = ($member->parent
instanceof Adherent ?
$member->parent
->id
: $member->parent
);
1166 $members = $m->getSelectizedMembers(
1171 $route_params['members'] = [
1172 'filters' => $m->getFilters(),
1173 'count' => $m->getCount()
1176 if (count($members)) {
1177 $route_params['members']['list'] = $members;
1181 $this->view
->render(
1185 'parent_tpl' => 'page.tpl',
1186 'autocomplete' => true,
1187 'page_title' => $title,
1188 'member' => $member,
1189 'self_adh' => false,
1190 // pseudo random int
1192 'titles_list' => Titles
::getList($this->zdb
),
1193 'statuts' => $statuts->getList(),
1194 'groups' => $groups_list,
1195 'fieldsets' => $form_elements['fieldsets'],
1196 'hidden_elements' => $form_elements['hiddens'],
1197 'parent_fields' => $tpl_parent_fields
1206 * @param Request $request PSR Request
1207 * @param Response $response PSR Response
1208 * @param array $args Request arguments
1212 public function doEdit(Request
$request, Response
$response, array $args = []): Response
1214 return $this->store($request, $response, $args);
1218 * Massive change page
1220 * @param Request $request PSR Request
1221 * @param Response $response PSR Response
1222 * @param array $args Request arguments
1226 public function massChange(Request
$request, Response
$response, array $args = []): Response
1228 $filters = $this->session
->filter_members
;
1231 'id' => $filters->selected
,
1232 'redirect_uri' => $this->router
->pathFor('members')
1235 $fc = $this->fields_config
;
1236 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1244 'children' => false,
1247 $member = new Adherent($this->zdb
, null, $deps);
1250 $statuts = new Status($this->zdb
);
1253 $this->view
->render(
1255 'mass_change_members.tpl',
1257 'mode' => $request->isXhr() ?
'ajax' : '',
1258 'page_title' => str_replace(
1261 _T('Mass change %count members')
1263 'form_url' => $this->router
->pathFor('masschangeMembersReview'),
1264 'cancel_uri' => $this->router
->pathFor('members'),
1266 'member' => $member,
1267 'fieldsets' => $form_elements['fieldsets'],
1268 'titles_list' => Titles
::getList($this->zdb
),
1269 'statuts' => $statuts->getList(),
1270 'require_mass' => true
1277 * Massive changes validation page
1279 * @param Request $request PSR Request
1280 * @param Response $response PSR Response
1281 * @param array $args Request arguments
1285 public function validateMassChange(Request
$request, Response
$response, array $args = []): Response
1287 $post = $request->getParsedBody();
1289 if (!isset($post['confirm'])) {
1290 $this->flash
->addMessage(
1292 _T("Mass changes has not been confirmed!")
1295 //we want only visibles fields
1296 $fc = $this->fields_config
;
1297 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1300 foreach ($form_elements['fieldsets'] as $form_element) {
1301 foreach ($form_element->elements
as $field) {
1302 if (isset($post[$field->field_id
]) && isset($post['mass_' . $field->field_id
])) {
1303 $changes[$field->field_id
] = [
1304 'label' => $field->label
,
1305 'value' => $post[$field->field_id
]
1312 $filters = $this->session
->filter_members
;
1314 'id' => $filters->selected
,
1315 'redirect_uri' => $this->router
->pathFor('members')
1319 $statuts = new Status($this->zdb
);
1322 $this->view
->render(
1324 'mass_change_members.tpl',
1326 'mode' => $request->isXhr() ?
'ajax' : '',
1327 'page_title' => str_replace(
1330 _T('Review mass change %count members')
1332 'form_url' => $this->router
->pathFor('massstoremembers'),
1333 'cancel_uri' => $this->router
->pathFor('members'),
1335 'titles_list' => Titles
::getList($this->zdb
),
1336 'statuts' => $statuts->getList(),
1337 'changes' => $changes
1344 * Do massive changes
1346 * @param Request $request PSR Request
1347 * @param Response $response PSR Response
1348 * @param array $args Request arguments
1352 public function doMassChange(Request
$request, Response
$response, array $args = []): Response
1354 $post = $request->getParsedBody();
1355 $redirect_url = $post['redirect_uri'];
1356 $error_detected = [];
1359 unset($post['redirect_uri']);
1360 if (!isset($post['confirm'])) {
1361 $error_detected[] = _T("Mass changes has not been confirmed!");
1363 unset($post['confirm']);
1367 $fc = $this->fields_config
;
1368 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1369 $disabled = $this->members_fields
;
1370 foreach (array_keys($post) as $key) {
1372 foreach ($form_elements['fieldsets'] as $fieldset) {
1373 if (isset($fieldset->elements
[$key])) {
1380 'Permission issue mass editing field ' . $key,
1385 unset($disabled[$key]);
1389 if (!count($post)) {
1390 $error_detected[] = _T("Nothing to do!");
1392 foreach ($ids as $id) {
1393 $is_manager = !$this->login
->isAdmin()
1394 && !$this->login
->isStaff()
1395 && $this->login
->isGroupManager();
1398 'groups' => $is_manager,
1401 'children' => false,
1404 $member = new Adherent($this->zdb
, (int)$id, $deps);
1405 $member->setDependencies(
1407 $this->members_fields
,
1410 if (!$member->canEdit($this->login
)) {
1414 $valid = $member->check($post, [], $disabled);
1415 if ($valid === true) {
1416 $done = $member->store();
1418 $error_detected[] = _T("An error occurred while storing the member.");
1423 $error_detected = array_merge($error_detected, $valid);
1429 if ($mass == 0 && !count($error_detected)) {
1430 $error_detected[] = _T('Something went wront during mass edition!');
1432 $this->flash
->addMessage(
1437 _T('%count members has been changed successfully!')
1442 if (count($error_detected) > 0) {
1443 foreach ($error_detected as $error) {
1444 $this->flash
->addMessage(
1451 if (!$request->isXhr()) {
1454 ->withHeader('Location', $redirect_url);
1456 return $response->withJson(
1458 'success' => count($error_detected) === 0
1467 * @param Request $request PSR Request
1468 * @param Response $response PSR Response
1469 * @param array $args Request arguments
1473 public function store(Request
$request, Response
$response, array $args = []): Response
1475 if (!$this->preferences
->pref_bool_selfsubscribe
&& !$this->login
->isLogged()) {
1478 ->withHeader('Location', $this->router
->pathFor('slash'));
1481 $post = $request->getParsedBody();
1490 $member = new Adherent($this->zdb
, null, $deps);
1491 $member->setDependencies(
1493 $this->members_fields
,
1496 if (isset($args['self'])) {
1497 //mark as self membership
1498 $member->setSelfMembership();
1501 $success_detected = [];
1502 $warning_detected = [];
1503 $error_detected = [];
1506 $adherent['id_adh'] = get_numeric_form_value('id_adh', '');
1507 if ($this->login
->isAdmin() ||
$this->login
->isStaff() ||
$this->login
->isGroupManager()) {
1508 if ($adherent['id_adh']) {
1509 $member->load((int)$adherent['id_adh']);
1510 if (!$member->canEdit($this->login
)) {
1511 //redirection should have been done before. Just throw an Exception.
1512 throw new \
RuntimeException(
1516 'No right to store member #%id'
1522 $member->load($this->login
->id
);
1523 $adherent['id_adh'] = $this->login
->id
;
1526 // flagging required fields
1527 $fc = $this->fields_config
;
1529 // password required if we create a new member
1530 if ($member->id
!= '') {
1531 $fc->setNotRequired('mdp_adh');
1535 $member->hasParent() && !isset($post['detach_parent'])
1536 ||
isset($post['parent_id']) && !empty($post['parent_id'])
1538 $parent_fields = $member->getParentFields();
1539 foreach ($parent_fields as $field) {
1540 if ($fc->isRequired($field)) {
1541 $fc->setNotRequired($field);
1546 // flagging required fields invisible to members
1547 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1548 $fc->setNotRequired('activite_adh');
1549 $fc->setNotRequired('id_statut');
1552 $form_elements = $fc->getFormElements(
1555 isset($args['self'])
1557 $fieldsets = $form_elements['fieldsets'];
1558 $required = array();
1559 $disabled = array();
1561 foreach ($fieldsets as $category) {
1562 foreach ($category->elements
as $field) {
1563 if ($field->required
== true) {
1564 $required[$field->field_id
] = true;
1566 if ($field->disabled
== true) {
1567 $disabled[$field->field_id
] = true;
1568 } elseif (!isset($post[$field->field_id
])) {
1569 switch ($field->field_id
) {
1570 //unchecked booleans are not sent from form
1571 case 'bool_admin_adh':
1572 case 'bool_exempt_adh':
1573 case 'bool_display_info':
1574 $post[$field->field_id
] = 0;
1581 $real_requireds = array_diff(array_keys($required), array_keys($disabled));
1584 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1585 if (isset($post[array_shift($real_requireds)])) {
1587 $valid = $member->check($post, $required, $disabled);
1588 if ($valid !== true) {
1589 $error_detected = array_merge($error_detected, $valid);
1592 if (count($error_detected) == 0) {
1593 //all goes well, we can proceed
1596 if ($member->id
== '') {
1599 $store = $member->store();
1600 if ($store === true) {
1601 //member has been stored :)
1603 if (isset($args['self'])) {
1604 $success_detected[] = _T("Your account has been created!");
1606 $this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1607 && $member->getEmail() != ''
1609 $success_detected[] = _T("An email has been sent to you, check your inbox.");
1612 $success_detected[] = _T("New member has been successfully added.");
1614 //Send email to admin if preference checked
1616 $this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1617 && $this->preferences
->pref_bool_mailadh
1623 'name_adh' => custom_html_entity_decode(
1626 'firstname_adh' => custom_html_entity_decode(
1629 'lastname_adh' => custom_html_entity_decode(
1632 'mail_adh' => custom_html_entity_decode(
1635 'login_adh' => custom_html_entity_decode(
1640 $mtxt = $texts->getTexts(
1641 (isset($args['self']) ?
'newselfadh' : 'newadh'),
1642 $this->preferences
->pref_lang
1645 $mail = new GaletteMail($this->preferences
);
1646 $mail->setSubject($texts->getSubject());
1648 foreach ($this->preferences
->vpref_email_newadh
as $pref_email) {
1649 $recipients[$pref_email] = $pref_email;
1651 $mail->setRecipients($recipients);
1652 $mail->setMessage($texts->getBody());
1653 $sent = $mail->send();
1655 if ($sent == GaletteMail
::MAIL_SENT
) {
1656 $this->history
->add(
1659 $member->sname
. ' (' . $member->email
. ')',
1660 _T("New account email sent to admin for '%s'.")
1666 $member->sname
. ' (' . $member->email
. ')',
1667 _T("A problem happened while sending email to admin for account '%s'.")
1669 $this->history
->add($str);
1670 $warning_detected[] = $str;
1675 $success_detected[] = _T("Member account has been modified.");
1678 // send email to member
1679 if (isset($args['self']) ||
isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
1680 if ($this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
) {
1681 if ($member->getEmail() == '' && !isset($args['self'])) {
1682 $error_detected[] = _T("- You can't send a confirmation by email if the member hasn't got an address!");
1685 'name_adh' => custom_html_entity_decode(
1688 'firstname_adh' => custom_html_entity_decode(
1691 'lastname_adh' => custom_html_entity_decode(
1694 'mail_adh' => custom_html_entity_decode(
1697 'login_adh' => custom_html_entity_decode(
1702 $password = new Password($this->zdb
);
1703 $res = $password->generateNewPassword($member->id
);
1705 $link_validity = new \
DateTime();
1706 $link_validity->add(new \
DateInterval('PT24H'));
1707 $mreplaces['change_pass_uri'] = $this->preferences
->getURL() .
1708 $this->router
->pathFor(
1709 'password-recovery',
1710 ['hash' => base64_encode($password->getHash())]
1712 $mreplaces['link_validity'] = $link_validity->format(_T("Y-m-d H:i:s"));
1717 _T("An error occurred storing temporary password for %s. Please inform an admin.")
1719 $this->history
->add($str);
1720 $this->flash
->addMessage(
1727 //send email to member
1728 // Get email text in database
1734 $mlang = $this->preferences
->pref_lang
;
1735 if (isset($post['pref_lang'])) {
1736 $mlang = $post['pref_lang'];
1738 $mtxt = $texts->getTexts(
1739 (($new) ?
'sub' : 'accountedited'),
1743 $mail = new GaletteMail($this->preferences
);
1744 $mail->setSubject($texts->getSubject());
1745 $mail->setRecipients(
1747 $member->getEmail() => $member->sname
1750 $mail->setMessage($texts->getBody());
1751 $sent = $mail->send();
1753 if ($sent == GaletteMail
::MAIL_SENT
) {
1756 $member->sname
. ' (' . $member->getEmail() . ')',
1758 _T("New account email sent to '%s'.") : _T("Account modification email sent to '%s'.")
1760 $this->history
->add($msg);
1761 $success_detected[] = $msg;
1765 $member->sname
. ' (' . $member->getEmail() . ')',
1766 _T("A problem happened while sending account email to '%s'")
1768 $this->history
->add($str);
1769 $error_detected[] = $str;
1772 } elseif ($this->preferences
->pref_mail_method
== GaletteMail
::METHOD_DISABLED
) {
1773 //if email has been disabled in the preferences, we should not be here ;
1774 //we do not throw an error, just a simple warning that will be show later
1775 $msg = _T("You asked Galette to send a confirmation email to the member, but email has been disabled in the preferences.");
1776 $warning_detected[] = $msg;
1780 // send email to admin
1782 $this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1783 && $this->preferences
->pref_bool_mailadh
1785 && $member->id
== $this->login
->id
1788 'name_adh' => custom_html_entity_decode(
1791 'firstname_adh' => custom_html_entity_decode(
1794 'lastname_adh' => custom_html_entity_decode(
1797 'mail_adh' => custom_html_entity_decode(
1800 'login_adh' => custom_html_entity_decode(
1805 //send email to member
1806 // Get email text in database
1812 $mlang = $this->preferences
->pref_lang
;
1814 $mtxt = $texts->getTexts(
1819 $mail = new GaletteMail($this->preferences
);
1820 $mail->setSubject($texts->getSubject());
1822 foreach ($this->preferences
->vpref_email_newadh
as $pref_email) {
1823 $recipients[$pref_email] = $pref_email;
1825 $mail->setRecipients($recipients);
1827 $mail->setMessage($texts->getBody());
1828 $sent = $mail->send();
1830 if ($sent == GaletteMail
::MAIL_SENT
) {
1831 $msg = _T("Account modification email sent to admin.");
1832 $this->history
->add($msg);
1833 $success_detected[] = $msg;
1835 $str = _T("A problem happened while sending account email to admin");
1836 $this->history
->add($str);
1837 $warning_detected[] = $str;
1841 //store requested groups
1844 $managed_groups_adh = null;
1846 //add/remove user from groups
1847 if (isset($post['groups_adh'])) {
1848 $groups_adh = $post['groups_adh'];
1850 $add_groups = Groups
::addMemberToGroups(
1855 if ($add_groups === false) {
1856 $error_detected[] = _T("An error occurred adding member to its groups.");
1859 //add/remove manager from groups
1860 if (isset($post['groups_managed_adh'])) {
1861 $managed_groups_adh = $post['groups_managed_adh'];
1863 $add_groups = Groups
::addMemberToGroups(
1865 $managed_groups_adh,
1868 $member->loadGroups();
1870 if ($add_groups === false) {
1871 $error_detected[] = _T("An error occurred adding member to its groups as manager.");
1874 //something went wrong :'(
1875 $error_detected[] = _T("An error occurred while storing the member.");
1879 if (count($error_detected) == 0) {
1880 $files_res = $member->handleFiles($_FILES);
1881 if (is_array($files_res)) {
1882 $error_detected = array_merge($error_detected, $files_res);
1885 if (isset($post['del_photo'])) {
1886 if (!$member->picture
->delete($member->id
)) {
1887 $error_detected[] = _T("Delete failed");
1888 $str_adh = $member->id
. ' (' . $member->sname
. ' ' . ')';
1890 'Unable to delete picture for member ' . $str_adh,
1897 if (count($error_detected) > 0) {
1898 foreach ($error_detected as $error) {
1899 if (strpos($error, '%member_url_') !== false) {
1900 preg_match('/%member_url_(\d+)/', $error, $matches);
1901 $url = $this->router
->pathFor('member', ['id' => $matches[1]]);
1902 $error = str_replace(
1903 '%member_url_' . $matches[1],
1908 $this->flash
->addMessage(
1915 if (count($warning_detected) > 0) {
1916 foreach ($warning_detected as $warning) {
1917 $this->flash
->addMessage(
1923 if (count($success_detected) > 0) {
1924 foreach ($success_detected as $success) {
1925 $this->flash
->addMessage(
1932 if (count($error_detected) == 0) {
1933 if (isset($args['self'])) {
1934 $redirect_url = $this->router
->pathFor('login');
1936 isset($post['redirect_on_create'])
1937 && $post['redirect_on_create'] > Adherent
::AFTER_ADD_DEFAULT
1939 switch ($post['redirect_on_create']) {
1940 case Adherent
::AFTER_ADD_TRANS
:
1941 $redirect_url = $this->router
->pathFor('transaction', ['action' => 'add']);
1943 case Adherent
::AFTER_ADD_NEW
:
1944 $redirect_url = $this->router
->pathFor('editmember', ['action' => 'add']);
1946 case Adherent
::AFTER_ADD_SHOW
:
1947 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1949 case Adherent
::AFTER_ADD_LIST
:
1950 $redirect_url = $this->router
->pathFor('members');
1952 case Adherent
::AFTER_ADD_HOME
:
1953 $redirect_url = $this->router
->pathFor('slash');
1956 } elseif (!isset($post['id_adh']) && !$member->isDueFree()) {
1957 $redirect_url = $this->router
->pathFor(
1960 ) . '?id_adh=' . $member->id
;
1962 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1965 //store entity in session
1966 $this->session
->member
= $member;
1968 if (isset($args['self'])) {
1969 $redirect_url = $this->router
->pathFor('subscribe');
1973 'id' => $member->id
,
1977 $rparams = ['action' => 'add'];
1979 $redirect_url = $this->router
->pathFor(
1989 ->withHeader('Location', $redirect_url);
1997 * Get redirection URI
1999 * @param array $args Route arguments
2003 public function redirectUri(array $args = [])
2005 return $this->router
->pathFor('members');
2011 * @param array $args Route arguments
2015 public function formUri(array $args = [])
2017 return $this->router
->pathFor(
2027 * In simple cases, we get the ID in the route arguments; but for
2028 * batchs, it should be found elsewhere.
2029 * In post values, we look for id key, as well as all {sthing}_sel keys (like members_sel or contrib_sel)
2031 * @param array $args Request arguments
2032 * @param array $post POST values
2034 * @return null|integer|integer[]
2036 protected function getIdsToRemove(&$args, $post)
2038 if (isset($args['id'])) {
2041 $filters = $this->session
->filter_members
;
2042 return $filters->selected
;
2047 * Get confirmation removal page title
2049 * @param array $args Route arguments
2053 public function confirmRemoveTitle(array $args = [])
2055 if (isset($args['id_adh'])) {
2056 //one member removal
2057 $adh = new Adherent($this->zdb
, (int)$args['id_adh']);
2059 _T('Remove member %1$s'),
2063 //batch members removal
2064 $filters = $this->session
->filter_members
;
2067 count($filters->selected
),
2068 _T('You are about to remove %count members.')
2076 * @param array $args Route arguments
2077 * @param array $post POST values
2081 protected function doDelete(array $args, array $post)
2083 if (isset($this->session
->filter_members
)) {
2084 $filters = $this->session
->filter_members
;
2086 $filters = new MembersList();
2088 $members = new Members($filters);
2090 if (!is_array($post['id'])) {
2091 $ids = (array)$post['id'];
2096 return $members->removeMembers($ids);