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\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]);
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'];
633 if (isset($post['group_filter'])
634 && $post['group_filter'] > 0
636 $filters->group_filter
= (int)$post['group_filter'];
638 //number of rows to show
639 if (isset($post['nbshow'])) {
640 $filters->show
= $post['nbshow'];
643 if (isset($post['advanced_filtering'])) {
644 if (!$filters instanceof AdvancedMembersList
) {
645 $filters = new AdvancedMembersList($filters);
649 unset($post['advanced_filtering']);
651 foreach ($post as $k => $v) {
652 if (strpos($k, 'free_', 0) === 0) {
655 foreach ($post['free_field'] as $f) {
657 && trim($post['free_text'][$i]) !== ''
659 $fs_search = $post['free_text'][$i];
661 = (int)$post['free_logical_operator'][$i];
663 = (int)$post['free_query_operator'][$i];
664 $type = (int)$post['free_type'][$i];
669 'search' => $fs_search,
673 $filters->free_search
= $fs;
679 } elseif ($k == 'groups_search') {
681 $filters->groups_search_log_op
= (int)$post['groups_logical_operator'];
682 foreach ($post['groups_search'] as $g) {
683 if (trim($g) !== '') {
688 $filters->groups_search
= $gs;
694 case 'contrib_min_amount':
695 case 'contrib_max_amount':
696 if (trim($v) !== '') {
709 if (isset($post['savesearch'])) {
714 $this->router
->pathFor(
721 $this->session
->filter_members
= $filters;
725 ->withHeader('Location', $this->router
->pathFor('members'));
729 * Advanced search page
731 * @param Request $request PSR Request
732 * @param Response $response PSR Response
736 public function advancedSearch(Request
$request, Response
$response) :Response
738 if (isset($this->session
->filter_members
)) {
739 $filters = $this->session
->filter_members
;
740 if (!$filters instanceof AdvancedMembersList
) {
741 $filters = new AdvancedMembersList($filters);
744 $filters = new AdvancedMembersList();
747 $groups = new Groups($this->zdb
, $this->login
);
748 $groups_list = $groups->getList();
750 //we want only visibles fields
751 $fields = $this->members_fields
;
752 $fc = $this->fields_config
;
753 $visibles = $fc->getVisibilities();
754 $access_level = $this->login
->getAccessLevel();
756 //remove not searchable fields
757 unset($fields['mdp_adh']);
759 foreach ($fields as $k => $f) {
760 if ($visibles[$k] == FieldsConfig
::NOBODY ||
761 ($visibles[$k] == FieldsConfig
::ADMIN
&&
762 $access_level < Authentication
::ACCESS_ADMIN
) ||
763 ($visibles[$k] == FieldsConfig
::STAFF
&&
764 $access_level < Authentication
::ACCESS_STAFF
) ||
765 ($visibles[$k] == FieldsConfig
::MANAGER
&&
766 $access_level < Authentication
::ACCESS_MANAGER
)
772 //add status label search
773 if ($pos = array_search(Status
::PK
, array_keys($fields))) {
774 $fields = array_slice($fields, 0, $pos, true) +
775 ['status_label' => ['label' => _T('Status label')]] +
776 array_slice($fields, $pos, count($fields) -1, true);
788 $member = new Adherent($this->zdb
, $this->login
->login
, $deps);
789 $adh_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $member);
791 $contrib = new Contribution($this->zdb
, $this->login
);
792 $contrib_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $contrib);
795 $statuts = new Status($this->zdb
);
797 //Contributions types
798 $ct = new ContributionsTypes($this->zdb
);
801 $ptypes = new PaymentTypes(
806 $ptlist = $ptypes->getList();
808 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
813 'advanced_search.tpl',
815 'page_title' => _T("Advanced search"),
816 'filter_groups_options' => $groups_list,
817 'search_fields' => $fields,
818 'adh_dynamics' => $adh_dynamics->getFields(),
819 'contrib_dynamics' => $contrib_dynamics->getFields(),
820 'statuts' => $statuts->getList(),
821 'contributions_types' => $ct->getList(),
822 'filters' => $filters,
823 'payments_types' => $ptlist
830 * Members list for ajax
832 * @param Request $request PSR Request
833 * @param Response $response PSR Response
834 * @param array $args Request arguments
838 public function ajaxList(Request
$request, Response
$response, array $args = []) :Response
840 $post = $request->getParsedBody();
842 if (isset($this->session
->ajax_members_filters
)) {
843 $filters = $this->session
->ajax_members_filters
;
845 $filters = new MembersList();
848 if (isset($args['option']) && $args['option'] == 'page') {
849 $filters->current_page
= (int)$args['value'];
852 //numbers of rows to display
853 if (isset($post['nbshow']) && is_numeric($post['nbshow'])) {
854 $filters->show
= $post['nbshow'];
857 $members = new Members($filters);
858 if (!$this->login
->isAdmin() && !$this->login
->isStaff()) {
859 if ($this->login
->isGroupManager()) {
860 $members_list = $members->getManagedMembersList(true);
865 [$this->login
->id
, $this->login
->login
],
866 'Trying to list group members without access from #%id (%login)'
870 throw new \
Exception('Access denied.');
873 $members_list = $members->getMembersList(true);
876 //assign pagination variables to the template and add pagination links
877 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
879 $this->session
->ajax_members_filters
= $filters;
881 $selected_members = null;
882 $unreachables_members = null;
883 if (!isset($post['from'])) {
884 $mailing = $this->session
->mailing
;
885 if (!isset($post['members'])) {
886 $selected_members = $mailing->recipients
;
887 $unreachables_members = $mailing->unreachables
;
890 $selected_members = $m->getArrayList($post['members']);
891 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
892 $unreachables_members = $m->getArrayList($post['unreachables']);
896 switch ($post['from']) {
898 if (!isset($post['gid'])) {
900 'Trying to list group members with no group id provided',
903 throw new \
Exception('A group id is required.');
906 if (!isset($post['members'])) {
907 $group = new Group((int)$post['gid']);
908 $selected_members = array();
909 if (!isset($post['mode']) ||
$post['mode'] == 'members') {
910 $selected_members = $group->getMembers();
911 } elseif ($post['mode'] == 'managers') {
912 $selected_members = $group->getManagers();
915 'Trying to list group members with unknown mode',
918 throw new \
Exception('Unknown mode.');
923 $selected_members = $m->getArrayList($post['members']);
924 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
925 $unreachables_members = $m->getArrayList($post['unreachables']);
930 if (!isset($post['id_adh'])) {
931 throw new \
RuntimeException(
932 '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'] = $post['gid'];
955 if (isset($post['id_adh'])) {
956 $params['excluded'] = $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 array $args Request arguments
1057 public function edit(Request
$request, Response
$response, array $args = []) :Response
1059 $action = $args['action'];
1061 if (isset($args['id'])) {
1062 $id = (int)$args['id'];
1065 if ($action === 'edit' && $id === null) {
1066 throw new \
RuntimeException(
1067 _T("Member ID cannot ben null calling edit route!")
1069 } elseif ($action === 'add' && $id !== null) {
1072 ->withHeader('Location', $this->router
->pathFor('editmember', ['action' => 'add']));
1083 if ($this->session
->member
!== null) {
1084 $member = $this->session
->member
;
1085 $this->session
->member
= null;
1087 $member = new Adherent($this->zdb
, $id, $deps);
1092 if (!$member->canEdit($this->login
)) {
1093 $this->flash
->addMessage(
1095 _T("You do not have permission for requested URL.")
1102 $this->router
->pathFor('me')
1106 if ($member->id
!= $id) {
1107 $member->load($this->login
->id
);
1111 // flagging required fields
1112 $fc = $this->fields_config
;
1114 // password required if we create a new member
1115 if ($member->id
!= '') {
1116 $fc->setNotRequired('mdp_adh');
1119 //handle requirements for parent fields
1120 $parent_fields = $member->getParentFields();
1121 $tpl_parent_fields = []; //for JS when detaching
1122 foreach ($parent_fields as $field) {
1123 if ($fc->isRequired($field)) {
1124 $tpl_parent_fields[] = $field;
1125 if ($member->hasParent()) {
1126 $fc->setNotRequired($field);
1131 // flagging required fields invisible to members
1132 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1133 $fc->setNotRequired('activite_adh');
1134 $fc->setNotRequired('id_statut');
1137 // template variable declaration
1138 $title = _T("Member Profile");
1139 if ($member->id
!= '') {
1140 $title .= ' (' . _T("modification") . ')';
1142 $title .= ' (' . _T("creation") . ')';
1146 $statuts = new Status($this->zdb
);
1149 $groups = new Groups($this->zdb
, $this->login
);
1150 $groups_list = $groups->getSimpleList(true);
1152 $form_elements = $fc->getFormElements(
1160 if ($member->hasParent()) {
1161 $id = ($member->parent
instanceof Adherent ?
$member->parent
->id
: $member->parent
);
1163 $members = $m->getSelectizedMembers(
1168 $route_params['members'] = [
1169 'filters' => $m->getFilters(),
1170 'count' => $m->getCount()
1173 if (count($members)) {
1174 $route_params['members']['list'] = $members;
1178 $this->view
->render(
1182 'parent_tpl' => 'page.tpl',
1183 'autocomplete' => true,
1184 'page_title' => $title,
1185 'member' => $member,
1186 'self_adh' => false,
1187 // pseudo random int
1189 'titles_list' => Titles
::getList($this->zdb
),
1190 'statuts' => $statuts->getList(),
1191 'groups' => $groups_list,
1192 'fieldsets' => $form_elements['fieldsets'],
1193 'hidden_elements' => $form_elements['hiddens'],
1194 'parent_fields' => $tpl_parent_fields
1203 * @param Request $request PSR Request
1204 * @param Response $response PSR Response
1205 * @param array $args Request arguments
1209 public function doEdit(Request
$request, Response
$response, array $args = []) :Response
1211 return $this->store($request, $response, $args);
1215 * Massive change page
1217 * @param Request $request PSR Request
1218 * @param Response $response PSR Response
1219 * @param array $args Request arguments
1223 public function massChange(Request
$request, Response
$response, array $args = []) :Response
1225 $filters = $this->session
->filter_members
;
1228 'id' => $filters->selected
,
1229 'redirect_uri' => $this->router
->pathFor('members')
1232 $fc = $this->fields_config
;
1233 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1241 'children' => false,
1244 $member = new Adherent($this->zdb
, null, $deps);
1247 $statuts = new Status($this->zdb
);
1250 $this->view
->render(
1252 'mass_change_members.tpl',
1254 'mode' => $request->isXhr() ?
'ajax' : '',
1255 'page_title' => str_replace(
1258 _T('Mass change %count members')
1260 'form_url' => $this->router
->pathFor('masschangeMembersReview'),
1261 'cancel_uri' => $this->router
->pathFor('members'),
1263 'member' => $member,
1264 'fieldsets' => $form_elements['fieldsets'],
1265 'titles_list' => Titles
::getList($this->zdb
),
1266 'statuts' => $statuts->getList(),
1267 'require_mass' => true
1274 * Massive changes validation page
1276 * @param Request $request PSR Request
1277 * @param Response $response PSR Response
1278 * @param array $args Request arguments
1282 public function validateMassChange(Request
$request, Response
$response, array $args = []) :Response
1284 $post = $request->getParsedBody();
1286 if (!isset($post['confirm'])) {
1287 $this->flash
->addMessage(
1289 _T("Mass changes has not been confirmed!")
1292 //we want only visibles fields
1293 $fc = $this->fields_config
;
1294 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1297 foreach ($form_elements['fieldsets'] as $form_element) {
1298 foreach ($form_element->elements
as $field) {
1299 if (isset($post[$field->field_id
]) && isset($post['mass_' . $field->field_id
])) {
1300 $changes[$field->field_id
] = [
1301 'label' => $field->label
,
1302 'value' => $post[$field->field_id
]
1309 $filters = $this->session
->filter_members
;
1311 'id' => $filters->selected
,
1312 'redirect_uri' => $this->router
->pathFor('members')
1316 $statuts = new Status($this->zdb
);
1319 $this->view
->render(
1321 'mass_change_members.tpl',
1323 'mode' => $request->isXhr() ?
'ajax' : '',
1324 'page_title' => str_replace(
1327 _T('Review mass change %count members')
1329 'form_url' => $this->router
->pathFor('massstoremembers'),
1330 'cancel_uri' => $this->router
->pathFor('members'),
1332 'titles_list' => Titles
::getList($this->zdb
),
1333 'statuts' => $statuts->getList(),
1334 'changes' => $changes
1341 * Do massive changes
1343 * @param Request $request PSR Request
1344 * @param Response $response PSR Response
1345 * @param array $args Request arguments
1349 public function doMassChange(Request
$request, Response
$response, array $args = []) :Response
1351 $post = $request->getParsedBody();
1352 $redirect_url = $post['redirect_uri'];
1353 $error_detected = [];
1356 unset($post['redirect_uri']);
1357 if (!isset($post['confirm'])) {
1358 $error_detected[] = _T("Mass changes has not been confirmed!");
1360 unset($post['confirm']);
1364 $fc = $this->fields_config
;
1365 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1366 $disabled = $this->members_fields
;
1367 foreach (array_keys($post) as $key) {
1369 foreach ($form_elements['fieldsets'] as $fieldset) {
1370 if (isset($fieldset->elements
[$key])) {
1377 'Permission issue mass editing field ' . $key,
1382 unset($disabled[$key]);
1386 if (!count($post)) {
1387 $error_detected[] = _T("Nothing to do!");
1389 foreach ($ids as $id) {
1390 $is_manager = !$this->login
->isAdmin()
1391 && !$this->login
->isStaff()
1392 && $this->login
->isGroupManager();
1395 'groups' => $is_manager,
1398 'children' => false,
1401 $member = new Adherent($this->zdb
, (int)$id, $deps);
1402 $member->setDependencies(
1404 $this->members_fields
,
1407 if (!$member->canEdit($this->login
)) {
1411 $valid = $member->check($post, [], $disabled);
1412 if ($valid === true) {
1413 $done = $member->store();
1415 $error_detected[] = _T("An error occurred while storing the member.");
1420 $error_detected = array_merge($error_detected, $valid);
1426 if ($mass == 0 && !count($error_detected)) {
1427 $error_detected[] = _T('Something went wront during mass edition!');
1429 $this->flash
->addMessage(
1434 _T('%count members has been changed successfully!')
1439 if (count($error_detected) > 0) {
1440 foreach ($error_detected as $error) {
1441 $this->flash
->addMessage(
1448 if (!$request->isXhr()) {
1451 ->withHeader('Location', $redirect_url);
1453 return $response->withJson(
1455 'success' => count($error_detected) === 0
1464 * @param Request $request PSR Request
1465 * @param Response $response PSR Response
1466 * @param array $args Request arguments
1470 public function store(Request
$request, Response
$response, array $args = []) :Response
1472 if (!$this->preferences
->pref_bool_selfsubscribe
&& !$this->login
->isLogged()) {
1475 ->withHeader('Location', $this->router
->pathFor('slash'));
1478 $post = $request->getParsedBody();
1487 $member = new Adherent($this->zdb
, null, $deps);
1488 $member->setDependencies(
1490 $this->members_fields
,
1493 if (isset($args['self'])) {
1494 //mark as self membership
1495 $member->setSelfMembership();
1498 $success_detected = [];
1499 $warning_detected = [];
1500 $error_detected = [];
1503 $adherent['id_adh'] = get_numeric_form_value('id_adh', '');
1504 if ($this->login
->isAdmin() ||
$this->login
->isStaff() ||
$this->login
->isGroupManager()) {
1505 if ($adherent['id_adh']) {
1506 $member->load((int)$adherent['id_adh']);
1507 if (!$member->canEdit($this->login
)) {
1508 //redirection should have been done before. Just throw an Exception.
1509 throw new \
RuntimeException(
1513 'No right to store member #%id'
1519 $member->load($this->login
->id
);
1520 $adherent['id_adh'] = $this->login
->id
;
1523 // flagging required fields
1524 $fc = $this->fields_config
;
1526 // password required if we create a new member
1527 if ($member->id
!= '') {
1528 $fc->setNotRequired('mdp_adh');
1531 if ($member->hasParent() && !isset($post['detach_parent'])
1532 ||
isset($post['parent_id']) && !empty($post['parent_id'])
1534 $parent_fields = $member->getParentFields();
1535 foreach ($parent_fields as $field) {
1536 if ($fc->isRequired($field)) {
1537 $fc->setNotRequired($field);
1542 // flagging required fields invisible to members
1543 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1544 $fc->setNotRequired('activite_adh');
1545 $fc->setNotRequired('id_statut');
1548 $form_elements = $fc->getFormElements(
1551 isset($args['self'])
1553 $fieldsets = $form_elements['fieldsets'];
1554 $required = array();
1555 $disabled = array();
1557 foreach ($fieldsets as $category) {
1558 foreach ($category->elements
as $field) {
1559 if ($field->required
== true) {
1560 $required[$field->field_id
] = true;
1562 if ($field->disabled
== true) {
1563 $disabled[$field->field_id
] = true;
1564 } elseif (!isset($post[$field->field_id
])) {
1565 switch ($field->field_id
) {
1566 //unchecked booleans are not sent from form
1567 case 'bool_admin_adh':
1568 case 'bool_exempt_adh':
1569 case 'bool_display_info':
1570 $post[$field->field_id
] = 0;
1577 $real_requireds = array_diff(array_keys($required), array_keys($disabled));
1580 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1581 if (isset($post[array_shift($real_requireds)])) {
1583 $valid = $member->check($post, $required, $disabled);
1584 if ($valid !== true) {
1585 $error_detected = array_merge($error_detected, $valid);
1588 if (count($error_detected) == 0) {
1589 //all goes well, we can proceed
1592 if ($member->id
== '') {
1595 $store = $member->store();
1596 if ($store === true) {
1597 //member has been stored :)
1599 if (isset($args['self'])) {
1600 $success_detected[] = _T("Your account has been created!");
1601 if ($this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1602 && $member->getEmail() != ''
1604 $success_detected[] = _T("An email has been sent to you, check your inbox.");
1607 $success_detected[] = _T("New member has been successfully added.");
1609 //Send email to admin if preference checked
1610 if ($this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1611 && $this->preferences
->pref_bool_mailadh
1617 'name_adh' => custom_html_entity_decode(
1620 'firstname_adh' => custom_html_entity_decode(
1623 'lastname_adh' => custom_html_entity_decode(
1626 'mail_adh' => custom_html_entity_decode(
1629 'login_adh' => custom_html_entity_decode(
1634 $mtxt = $texts->getTexts(
1635 (isset($args['self']) ?
'newselfadh' : 'newadh'),
1636 $this->preferences
->pref_lang
1639 $mail = new GaletteMail($this->preferences
);
1640 $mail->setSubject($texts->getSubject());
1642 foreach ($this->preferences
->vpref_email_newadh
as $pref_email) {
1643 $recipients[$pref_email] = $pref_email;
1645 $mail->setRecipients($recipients);
1646 $mail->setMessage($texts->getBody());
1647 $sent = $mail->send();
1649 if ($sent == GaletteMail
::MAIL_SENT
) {
1650 $this->history
->add(
1653 $member->sname
. ' (' . $member->email
. ')',
1654 _T("New account email sent to admin for '%s'.")
1660 $member->sname
. ' (' . $member->email
. ')',
1661 _T("A problem happened while sending email to admin for account '%s'.")
1663 $this->history
->add($str);
1664 $warning_detected[] = $str;
1669 $success_detected[] = _T("Member account has been modified.");
1672 // send email to member
1673 if (isset($args['self']) ||
isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
1674 if ($this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
) {
1675 if ($member->getEmail() == '' && !isset($args['self'])) {
1676 $error_detected[] = _T("- You can't send a confirmation by email if the member hasn't got an address!");
1679 'name_adh' => custom_html_entity_decode(
1682 'firstname_adh' => custom_html_entity_decode(
1685 'lastname_adh' => custom_html_entity_decode(
1688 'mail_adh' => custom_html_entity_decode(
1691 'login_adh' => custom_html_entity_decode(
1696 $password = new Password($this->zdb
);
1697 $res = $password->generateNewPassword($member->id
);
1699 $link_validity = new DateTime();
1700 $link_validity->add(new DateInterval('PT24H'));
1701 $mreplaces['change_pass_uri'] = $this->preferences
->getURL() .
1702 $this->router
->pathFor(
1703 'password-recovery',
1704 ['hash' => base64_encode($password->getHash())]
1706 $mreplaces['link_validity'] = $link_validity->format(_T("Y-m-d H:i:s"));
1711 _T("An error occurred storing temporary password for %s. Please inform an admin.")
1713 $this->history
->add($str);
1714 $this->flash
->addMessage(
1721 //send email to member
1722 // Get email text in database
1728 $mlang = $this->preferences
->pref_lang
;
1729 if (isset($post['pref_lang'])) {
1730 $mlang = $post['pref_lang'];
1732 $mtxt = $texts->getTexts(
1733 (($new) ?
'sub' : 'accountedited'),
1737 $mail = new GaletteMail($this->preferences
);
1738 $mail->setSubject($texts->getSubject());
1739 $mail->setRecipients(
1741 $member->getEmail() => $member->sname
1744 $mail->setMessage($texts->getBody());
1745 $sent = $mail->send();
1747 if ($sent == GaletteMail
::MAIL_SENT
) {
1750 $member->sname
. ' (' . $member->getEmail() . ')',
1752 _T("New account email sent to '%s'.") :
1753 _T("Account modification email sent to '%s'.")
1755 $this->history
->add($msg);
1756 $success_detected[] = $msg;
1760 $member->sname
. ' (' . $member->getEmail() . ')',
1761 _T("A problem happened while sending account email to '%s'")
1763 $this->history
->add($str);
1764 $error_detected[] = $str;
1767 } elseif ($this->preferences
->pref_mail_method
== GaletteMail
::METHOD_DISABLED
) {
1768 //if email has been disabled in the preferences, we should not be here ;
1769 //we do not throw an error, just a simple warning that will be show later
1770 $msg = _T("You asked Galette to send a confirmation email to the member, but email has been disabled in the preferences.");
1771 $warning_detected[] = $msg;
1775 // send email to admin
1776 if ($this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1777 && $this->preferences
->pref_bool_mailadh
1779 && $member->id
== $this->login
->id
1782 'name_adh' => custom_html_entity_decode(
1785 'firstname_adh' => custom_html_entity_decode(
1788 'lastname_adh' => custom_html_entity_decode(
1791 'mail_adh' => custom_html_entity_decode(
1794 'login_adh' => custom_html_entity_decode(
1799 //send email to member
1800 // Get email text in database
1806 $mlang = $this->preferences
->pref_lang
;
1808 $mtxt = $texts->getTexts(
1813 $mail = new GaletteMail($this->preferences
);
1814 $mail->setSubject($texts->getSubject());
1816 foreach ($this->preferences
->vpref_email_newadh
as $pref_email) {
1817 $recipients[$pref_email] = $pref_email;
1819 $mail->setRecipients($recipients);
1821 $mail->setMessage($texts->getBody());
1822 $sent = $mail->send();
1824 if ($sent == GaletteMail
::MAIL_SENT
) {
1825 $msg = _T("Account modification email sent to admin.");
1826 $this->history
->add($msg);
1827 $success_detected[] = $msg;
1829 $str = _T("A problem happened while sending account email to admin");
1830 $this->history
->add($str);
1831 $warning_detected[] = $str;
1835 //store requested groups
1838 $managed_groups_adh = null;
1840 //add/remove user from groups
1841 if (isset($post['groups_adh'])) {
1842 $groups_adh = $post['groups_adh'];
1844 $add_groups = Groups
::addMemberToGroups(
1849 if ($add_groups === false) {
1850 $error_detected[] = _T("An error occurred adding member to its groups.");
1853 //add/remove manager from groups
1854 if (isset($post['groups_managed_adh'])) {
1855 $managed_groups_adh = $post['groups_managed_adh'];
1857 $add_groups = Groups
::addMemberToGroups(
1859 $managed_groups_adh,
1862 $member->loadGroups();
1864 if ($add_groups === false) {
1865 $error_detected[] = _T("An error occurred adding member to its groups as manager.");
1868 //something went wrong :'(
1869 $error_detected[] = _T("An error occurred while storing the member.");
1873 if (count($error_detected) == 0) {
1874 $files_res = $member->handleFiles($_FILES);
1875 if (is_array($files_res)) {
1876 $error_detected = array_merge($error_detected, $files_res);
1879 if (isset($post['del_photo'])) {
1880 if (!$member->picture
->delete($member->id
)) {
1881 $error_detected[] = _T("Delete failed");
1882 $str_adh = $member->id
. ' (' . $member->sname
. ' ' . ')';
1884 'Unable to delete picture for member ' . $str_adh,
1891 if (count($error_detected) > 0) {
1892 foreach ($error_detected as $error) {
1893 if (strpos($error, '%member_url_') !== false) {
1894 preg_match('/%member_url_(\d+)/', $error, $matches);
1895 $url = $this->router
->pathFor('member', ['id' => $matches[1]]);
1896 $error = str_replace(
1897 '%member_url_' . $matches[1],
1902 $this->flash
->addMessage(
1909 if (count($warning_detected) > 0) {
1910 foreach ($warning_detected as $warning) {
1911 $this->flash
->addMessage(
1917 if (count($success_detected) > 0) {
1918 foreach ($success_detected as $success) {
1919 $this->flash
->addMessage(
1926 if (count($error_detected) == 0) {
1927 if (isset($args['self'])) {
1928 $redirect_url = $this->router
->pathFor('login');
1929 } elseif (isset($post['redirect_on_create'])
1930 && $post['redirect_on_create'] > Adherent
::AFTER_ADD_DEFAULT
1932 switch ($post['redirect_on_create']) {
1933 case Adherent
::AFTER_ADD_TRANS
:
1934 $redirect_url = $this->router
->pathFor('transaction', ['action' => 'add']);
1936 case Adherent
::AFTER_ADD_NEW
:
1937 $redirect_url = $this->router
->pathFor('editmember', ['action' => 'add']);
1939 case Adherent
::AFTER_ADD_SHOW
:
1940 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1942 case Adherent
::AFTER_ADD_LIST
:
1943 $redirect_url = $this->router
->pathFor('members');
1945 case Adherent
::AFTER_ADD_HOME
:
1946 $redirect_url = $this->router
->pathFor('slash');
1949 } elseif (!isset($post['id_adh']) && !$member->isDueFree()) {
1950 $redirect_url = $this->router
->pathFor(
1953 ) . '?id_adh=' . $member->id
;
1955 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1958 //store entity in session
1959 $this->session
->member
= $member;
1961 if (isset($args['self'])) {
1962 $redirect_url = $this->router
->pathFor('subscribe');
1966 'id' => $member->id
,
1970 $rparams = ['action' => 'add'];
1972 $redirect_url = $this->router
->pathFor(
1982 ->withHeader('Location', $redirect_url);
1990 * Get redirection URI
1992 * @param array $args Route arguments
1996 public function redirectUri(array $args = [])
1998 return $this->router
->pathFor('members');
2004 * @param array $args Route arguments
2008 public function formUri(array $args = [])
2010 return $this->router
->pathFor(
2020 * In simple cases, we get the ID in the route arguments; but for
2021 * batchs, it should be found elsewhere.
2022 * In post values, we look for id key, as well as all {sthing}_sel keys (like members_sel or contrib_sel)
2024 * @param array $args Request arguments
2025 * @param array $post POST values
2027 * @return null|integer|integer[]
2029 protected function getIdsToRemove(&$args, $post)
2031 if (isset($args['id'])) {
2034 $filters = $this->session
->filter_members
;
2035 return $filters->selected
;
2040 * Get confirmation removal page title
2042 * @param array $args Route arguments
2046 public function confirmRemoveTitle(array $args = [])
2048 if (isset($args['id_adh'])) {
2049 //one member removal
2050 $adh = new Adherent($this->zdb
, (int)$args['id_adh']);
2052 _T('Remove member %1$s'),
2056 //batch members removal
2057 $filters = $this->session
->filter_members
;
2060 count($filters->selected
),
2061 _T('You are about to remove %count members.')
2069 * @param array $args Route arguments
2070 * @param array $post POST values
2074 protected function doDelete(array $args, array $post)
2076 if (isset($this->session
->filter_members
)) {
2077 $filters = $this->session
->filter_members
;
2079 $filters = new MembersList();
2081 $members = new Members($filters);
2083 if (!is_array($post['id'])) {
2084 $ids = (array)$post['id'];
2089 return $members->removeMembers($ids);