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\Password
;
47 use Galette\Core\PasswordImage
;
48 use Galette\Core\Picture
;
49 use Galette\Entity\Adherent
;
50 use Galette\Entity\Contribution
;
51 use Galette\Entity\ContributionsTypes
;
52 use Galette\Entity\DynamicFieldsHandle
;
53 use Galette\Entity\Group
;
54 use Galette\Entity\Status
;
55 use Galette\Entity\FieldsConfig
;
56 use Galette\Entity\Texts
;
57 use Galette\Filters\AdvancedMembersList
;
58 use Galette\Filters\MembersList
;
60 use Galette\IO\MembersCsv
;
61 use Galette\Repository\Groups
;
62 use Galette\Repository\Members
;
63 use Galette\Repository\PaymentTypes
;
64 use Galette\Repository\Titles
;
68 * Galette members controller
70 * @category Controllers
71 * @name GaletteController
73 * @author Johan Cwiklinski <johan@x-tnd.be>
74 * @copyright 2019-2020 The Galette Team
75 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
76 * @link http://galette.tuxfamily.org
77 * @since Available since 0.9.4dev - 2019-12-02
80 class MembersController
extends CrudController
87 * @param Request $request PSR Request
88 * @param Response $response PSR Response
89 * @param array $args Request arguments
93 public function add(Request
$request, Response
$response, array $args = []) :Response
95 return $this->edit($request, $response, $args);
99 * Self subscription page
101 * @param Request $request PSR Request
102 * @param Response $response PSR Response
103 * @param array $args Request arguments
107 public function selfSubscribe(Request
$request, Response
$response, array $args = []) :Response
109 if (!$this->preferences
->pref_bool_selfsubscribe ||
$this->login
->isLogged()) {
112 ->withHeader('Location', $this->router
->pathFor('slash'));
115 if ($this->session
->member
!== null) {
116 $member = $this->session
->member
;
117 $this->session
->member
= null;
122 $member = new Adherent($this->zdb
, null, $deps);
125 //mark as self membership
126 $member->setSelfMembership();
128 // flagging required fields
129 $fc = $this->fields_config
;
130 $form_elements = $fc->getFormElements($this->login
, true, true);
132 //image to defeat mass filling forms
133 $spam = new PasswordImage();
134 $spam_pass = $spam->newImage();
135 $spam_img = $spam->getImage();
139 $members = $m->getSelectizedMembers(
141 $member->hasParent() ?
$member->parent
->id
: null
144 $params['members'] = [
145 'filters' => $m->getFilters(),
146 'count' => $m->getCount()
149 if (count($members)) {
150 $params['members']['list'] = $members;
158 'page_title' => _T("Subscription"),
159 'parent_tpl' => 'public_page.tpl',
162 'autocomplete' => true,
165 'titles_list' => Titles
::getList($this->zdb
),
167 'spam_pass' => $spam_pass,
168 'spam_img' => $spam_img,
169 'fieldsets' => $form_elements['fieldsets'],
170 'hidden_elements' => $form_elements['hiddens']
179 * @param Request $request PSR Request
180 * @param Response $response PSR Response
181 * @param array $args Request arguments
185 public function doAdd(Request
$request, Response
$response, array $args = []) :Response
187 return $this->store($request, $response, $args);
193 * @param Request $request PSR Request
194 * @param Response $response PSR Response
195 * @param array $args Request arguments
199 public function duplicate(Request
$request, Response
$response, array $args = []) :Response
201 $id_adh = (int)$args[Adherent
::PK
];
202 $adh = new Adherent($this->zdb
, $id_adh, ['dynamics' => true, 'parent' => true]);
203 $adh->setDuplicate();
205 //store entity in session
206 $this->session
->member
= $adh;
210 ->withHeader('Location', $this->router
->pathFor('editmember', ['action' => 'add']));
217 * Display member card
219 * @param Request $request PSR Request
220 * @param Response $response PSR Response
221 * @param array $args Request arguments
225 public function show(Request
$request, Response
$response, array $args) :Response
227 $id = (int)$args['id'];
237 $member = new Adherent($this->zdb
, $id, $deps);
239 if (!$member->canEdit($this->login
)) {
240 $this->flash
->addMessage(
242 _T("You do not have permission for requested URL.")
249 $this->router
->pathFor('me')
253 if ($member->id
== null) {
254 //member does not exists!
255 $this->flash
->addMessage(
257 str_replace('%id', $args['id'], _T("No member #%id."))
264 $this->router
->pathFor('slash')
268 // flagging fields visibility
269 $fc = $this->fields_config
;
270 $display_elements = $fc->getDisplayElements($this->login
);
277 'page_title' => _T("Member Profile"),
279 'pref_lang' => $this->i18n
->getNameFromId($member->language
),
280 'pref_card_self' => $this->preferences
->pref_card_self
,
281 'groups' => Groups
::getSimpleList(),
283 'display_elements' => $display_elements
292 * @param Request $request PSR Request
293 * @param Response $response PSR Response
294 * @param array $args Request arguments
298 public function showMe(Request
$request, Response
$response, array $args = []) :Response
300 if ($this->login
->isSuperAdmin()) {
303 ->withHeader('Location', $this->router
->pathFor('slash'));
305 $args['show_me'] = true;
306 $args['id'] = $this->login
->id
;
307 return $this->show($request, $response, $args);
311 * Public pages (trombinoscope, public list)
313 * @param Request $request PSR Request
314 * @param Response $response PSR Response
315 * @param array $args Request arguments
319 public function publicList(Request
$request, Response
$response, array $args = []) :Response
322 $type = $args['type'];
323 if (isset($args['option'])) {
324 $option = $args['option'];
327 if (isset($args['value'])) {
328 $value = $args['value'];
331 $varname = 'public_filter_' . $type;
332 if (isset($this->session
->$varname)) {
333 $filters = $this->session
->$varname;
335 $filters = new MembersList();
338 if ($option !== null) {
341 $filters->current_page
= (int)$value;
344 $filters->orderby
= $value;
349 $m = new Members($filters);
350 $members = $m->getPublicList($type === 'trombi');
352 $this->session
->$varname = $filters;
354 //assign pagination variables to the template and add pagination links
355 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
360 ($type === 'list' ?
'liste_membres' : 'trombinoscope') . '.tpl',
362 'page_title' => ($type === 'list' ?
_T("Members list") : _T('Trombinoscope')),
363 'additionnal_html_class' => ($type === 'list' ?
'' : 'trombinoscope'),
365 'members' => $members,
366 'nb_members' => $m->getCount(),
367 'filters' => $filters
374 * Public pages (trombinoscope, public list)
376 * @param Request $request PSR Request
377 * @param Response $response PSR Response
378 * @param array $args Request arguments
382 public function filterPublicList(Request
$request, Response
$response, array $args = []) :Response
384 $type = $args['type'];
385 $post = $request->getParsedBody();
387 $varname = 'public_filter_' . $type;
388 if (isset($this->session
->$varname)) {
389 $filters = $this->session
->$varname;
391 $filters = new MembersList();
394 //reintialize filters
395 if (isset($post['clear_filter'])) {
398 //number of rows to show
399 if (isset($post['nbshow'])) {
400 $filters->show
= $post['nbshow'];
404 $this->session
->$varname = $filters;
408 ->withHeader('Location', $this->router
->pathFor('publicList', ['type' => $type]));
414 * @param Request $request PSR Request
415 * @param Response $response PSR Response
416 * @param array $args Request arguments
420 public function getDynamicFile(Request
$request, Response
$response, array $args) :Response
422 $id = (int)$args['id'];
431 $member = new Adherent($this->zdb
, $id, $deps);
434 if (!$member->canEdit($this->login
)) {
435 $fields = $member->getDynamicFields()->getFields();
436 if (!isset($fields[$args['fid']])) {
437 //field does not exists or access is forbidden
444 if ($denied === true) {
445 $this->flash
->addMessage(
447 _T("You do not have permission for requested URL.")
454 $this->router
->pathFor(
461 $filename = str_replace(
472 'member_%mid_field_%fid_value_%pos'
475 if (file_exists(GALETTE_FILES_PATH
. $filename)) {
476 $type = File
::getMimeType(GALETTE_FILES_PATH
. $filename);
477 $response = $response
478 ->withHeader('Content-Type', $type)
479 ->withHeader('Content-Disposition', 'attachment;filename="' . $args['name'] . '"')
480 ->withHeader('Pragma', 'no-cache');
481 $response->write(readfile(GALETTE_FILES_PATH
. $filename));
485 'A request has been made to get an exported file named `' .
486 $filename . '` that does not exists.',
490 $this->flash
->addMessage(
492 _T("The file does not exists or cannot be read :(")
499 $this->router
->pathFor('member', ['id' => $args['id']])
507 * @param Request $request PSR Request
508 * @param Response $response PSR Response
509 * @param array $args Request arguments
513 public function list(Request
$request, Response
$response, array $args = []) :Response
515 $option = $args['option'] ??
null;
516 $value = $args['value'] ??
null;
518 if (isset($this->session
->filter_members
)) {
519 $filters = $this->session
->filter_members
;
521 $filters = new MembersList();
524 if ($option !== null) {
527 $filters->current_page
= (int)$value;
530 $filters->orderby
= $value;
535 $members = new Members($filters);
537 $members_list = array();
538 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
539 $members_list = $members->getMembersList(true);
541 $members_list = $members->getManagedMembersList(true);
544 $groups = new Groups($this->zdb
, $this->login
);
545 $groups_list = $groups->getList();
547 //assign pagination variables to the template and add pagination links
548 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
549 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
551 $this->session
->filter_members
= $filters;
556 'gestion_adherents.tpl',
558 'page_title' => _T("Members management"),
559 'require_mass' => true,
560 'members' => $members_list,
561 'filter_groups_options' => $groups_list,
562 'nb_members' => $members->getCount(),
563 'filters' => $filters,
564 'adv_filters' => $filters instanceof AdvancedMembersList
,
565 'galette_list' => $this->lists_config
->getDisplayElements($this->login
)
574 * @param Request $request PSR Request
575 * @param Response $response PSR Response
579 public function filter(Request
$request, Response
$response) :Response
581 $post = $request->getParsedBody();
582 if (isset($this->session
->filter_members
)) {
583 //CAUTION: this one may be simple or advanced, display must change
584 $filters = $this->session
->filter_members
;
586 $filters = new MembersList();
589 //reintialize filters
590 if (isset($post['clear_filter'])) {
591 $filters = new MembersList();
592 } elseif (isset($post['clear_adv_filter'])) {
593 $this->session
->filter_members
= null;
594 unset($this->session
->filter_members
);
598 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
599 } elseif (isset($post['adv_criteria'])) {
602 ->withHeader('Location', $this->router
->pathFor('advanced-search'));
605 if (isset($post['filter_str'])) { //filter search string
606 $filters->filter_str
= stripslashes(
607 htmlspecialchars($post['filter_str'], ENT_QUOTES
)
611 if (isset($post['field_filter'])) {
612 if (is_numeric($post['field_filter'])) {
613 $filters->field_filter
= $post['field_filter'];
616 //membership to filter
617 if (isset($post['membership_filter'])) {
618 if (is_numeric($post['membership_filter'])) {
619 $filters->membership_filter
620 = $post['membership_filter'];
623 //account status to filter
624 if (isset($post['filter_account'])) {
625 if (is_numeric($post['filter_account'])) {
626 $filters->filter_account
= $post['filter_account'];
630 if (isset($post['email_filter'])) {
631 $filters->email_filter
= (int)$post['email_filter'];
634 if (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) {
658 && trim($post['free_text'][$i]) !== ''
660 $fs_search = $post['free_text'][$i];
662 = (int)$post['free_logical_operator'][$i];
664 = (int)$post['free_query_operator'][$i];
665 $type = (int)$post['free_type'][$i];
670 'search' => $fs_search,
674 $filters->free_search
= $fs;
680 } elseif ($k == 'groups_search') {
682 $filters->groups_search_log_op
= (int)$post['groups_logical_operator'];
683 foreach ($post['groups_search'] as $g) {
684 if (trim($g) !== '') {
689 $filters->groups_search
= $gs;
695 case 'contrib_min_amount':
696 case 'contrib_max_amount':
697 if (trim($v) !== '') {
710 if (isset($post['savesearch'])) {
715 $this->router
->pathFor(
722 $this->session
->filter_members
= $filters;
726 ->withHeader('Location', $this->router
->pathFor('members'));
730 * Advanced search page
732 * @param Request $request PSR Request
733 * @param Response $response PSR Response
737 public function advancedSearch(Request
$request, Response
$response) :Response
739 if (isset($this->session
->filter_members
)) {
740 $filters = $this->session
->filter_members
;
741 if (!$filters instanceof AdvancedMembersList
) {
742 $filters = new AdvancedMembersList($filters);
745 $filters = new AdvancedMembersList();
748 $groups = new Groups($this->zdb
, $this->login
);
749 $groups_list = $groups->getList();
751 //we want only visibles fields
752 $fields = $this->members_fields
;
753 $fc = $this->fields_config
;
754 $visibles = $fc->getVisibilities();
755 $access_level = $this->login
->getAccessLevel();
757 //remove not searchable fields
758 unset($fields['mdp_adh']);
760 foreach ($fields as $k => $f) {
761 if ($visibles[$k] == FieldsConfig
::NOBODY ||
762 ($visibles[$k] == FieldsConfig
::ADMIN
&&
763 $access_level < Authentication
::ACCESS_ADMIN
) ||
764 ($visibles[$k] == FieldsConfig
::STAFF
&&
765 $access_level < Authentication
::ACCESS_STAFF
) ||
766 ($visibles[$k] == FieldsConfig
::MANAGER
&&
767 $access_level < Authentication
::ACCESS_MANAGER
)
773 //add status label search
774 if ($pos = array_search(Status
::PK
, array_keys($fields))) {
775 $fields = array_slice($fields, 0, $pos, true) +
776 ['status_label' => ['label' => _T('Status label')]] +
777 array_slice($fields, $pos, count($fields) - 1, true);
789 $member = new Adherent($this->zdb
, $this->login
->login
, $deps);
790 $adh_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $member);
792 $contrib = new Contribution($this->zdb
, $this->login
);
793 $contrib_dynamics = new DynamicFieldsHandle($this->zdb
, $this->login
, $contrib);
796 $statuts = new Status($this->zdb
);
798 //Contributions types
799 $ct = new ContributionsTypes($this->zdb
);
802 $ptypes = new PaymentTypes(
807 $ptlist = $ptypes->getList();
809 $filters->setViewCommonsFilters($this->preferences
, $this->view
->getSmarty());
814 'advanced_search.tpl',
816 'page_title' => _T("Advanced search"),
817 'filter_groups_options' => $groups_list,
818 'search_fields' => $fields,
819 'adh_dynamics' => $adh_dynamics->getFields(),
820 'contrib_dynamics' => $contrib_dynamics->getFields(),
821 'statuts' => $statuts->getList(),
822 'contributions_types' => $ct->getList(),
823 'filters' => $filters,
824 'payments_types' => $ptlist
831 * Members list for ajax
833 * @param Request $request PSR Request
834 * @param Response $response PSR Response
835 * @param array $args Request arguments
839 public function ajaxList(Request
$request, Response
$response, array $args = []) :Response
841 $post = $request->getParsedBody();
843 if (isset($this->session
->ajax_members_filters
)) {
844 $filters = $this->session
->ajax_members_filters
;
846 $filters = new MembersList();
849 if (isset($args['option']) && $args['option'] == 'page') {
850 $filters->current_page
= (int)$args['value'];
853 //numbers of rows to display
854 if (isset($post['nbshow']) && is_numeric($post['nbshow'])) {
855 $filters->show
= $post['nbshow'];
858 $members = new Members($filters);
859 if (!$this->login
->isAdmin() && !$this->login
->isStaff()) {
860 if ($this->login
->isGroupManager()) {
861 $members_list = $members->getManagedMembersList(true);
866 [$this->login
->id
, $this->login
->login
],
867 'Trying to list group members without access from #%id (%login)'
871 throw new \
Exception('Access denied.');
874 $members_list = $members->getMembersList(true);
877 //assign pagination variables to the template and add pagination links
878 $filters->setSmartyPagination($this->router
, $this->view
->getSmarty(), false);
880 $this->session
->ajax_members_filters
= $filters;
882 $selected_members = null;
883 $unreachables_members = null;
884 if (!isset($post['from'])) {
885 $mailing = $this->session
->mailing
;
886 if (!isset($post['members'])) {
887 $selected_members = $mailing->recipients
;
888 $unreachables_members = $mailing->unreachables
;
891 $selected_members = $m->getArrayList($post['members']);
892 if (isset($post['unreachables']) && is_array($post['unreachables'])) {
893 $unreachables_members = $m->getArrayList($post['unreachables']);
897 switch ($post['from']) {
899 if (!isset($post['gid'])) {
901 'Trying to list group members with no group id provided',
904 throw new \
Exception('A group id is required.');
907 if (!isset($post['members'])) {
908 $group = new Group((int)$post['gid']);
909 $selected_members = array();
910 if (!isset($post['mode']) ||
$post['mode'] == 'members') {
911 $selected_members = $group->getMembers();
912 } elseif ($post['mode'] == 'managers') {
913 $selected_members = $group->getManagers();
916 'Trying to list group members with unknown mode',
919 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!'
942 'filters' => $filters,
943 'members_list' => $members_list,
944 'selected_members' => $selected_members,
945 'unreachables_members' => $unreachables_members
948 if (isset($post['multiple'])) {
949 $params['multiple'] = true;
952 if (isset($post['gid'])) {
953 $params['the_id'] = $post['gid'];
956 if (isset($post['id_adh'])) {
957 $params['excluded'] = $post['id_adh'];
970 * Batch actions handler
972 * @param Request $request PSR Request
973 * @param Response $response PSR Response
977 public function handleBatch(Request
$request, Response
$response) :Response
979 $post = $request->getParsedBody();
981 if (isset($post['member_sel'])) {
982 if (isset($this->session
->filter_members
)) {
983 $filters = $this->session
->filter_members
;
985 $filters = new MembersList();
988 $filters->selected
= $post['member_sel'];
989 $this->session
->filter_members
= $filters;
991 if (isset($post['cards'])) {
994 ->withHeader('Location', $this->router
->pathFor('pdf-members-cards'));
997 if (isset($post['labels'])) {
1000 ->withHeader('Location', $this->router
->pathFor('pdf-members-labels'));
1003 if (isset($post['mailing'])) {
1006 ->withHeader('Location', $this->router
->pathFor('mailing') . '?mailing_new=new');
1009 if (isset($post['attendance_sheet'])) {
1012 ->withHeader('Location', $this->router
->pathFor('attendance_sheet_details'));
1015 if (isset($post['csv'])) {
1018 ->withHeader('Location', $this->router
->pathFor('csv-memberslist'));
1021 if (isset($post['delete'])) {
1024 ->withHeader('Location', $this->router
->pathFor('removeMembers'));
1027 if (isset($post['masschange'])) {
1030 ->withHeader('Location', $this->router
->pathFor('masschangeMembers'));
1033 throw new \
RuntimeException('Does not know what to batch :(');
1035 $this->flash
->addMessage(
1037 _T("No member was selected, please check at least one name.")
1042 ->withHeader('Location', $this->router
->pathFor('members'));
1052 * @param Request $request PSR Request
1053 * @param Response $response PSR Response
1054 * @param array $args Request arguments
1058 public function edit(Request
$request, Response
$response, array $args = []) :Response
1060 $action = $args['action'];
1062 if (isset($args['id'])) {
1063 $id = (int)$args['id'];
1066 if ($action === 'edit' && $id === null) {
1067 throw new \
RuntimeException(
1068 _T("Member ID cannot ben null calling edit route!")
1070 } elseif ($action === 'add' && $id !== null) {
1073 ->withHeader('Location', $this->router
->pathFor('editmember', ['action' => 'add']));
1084 if ($this->session
->member
!== null) {
1085 $member = $this->session
->member
;
1086 $this->session
->member
= null;
1088 $member = new Adherent($this->zdb
, $id, $deps);
1093 if (!$member->canEdit($this->login
)) {
1094 $this->flash
->addMessage(
1096 _T("You do not have permission for requested URL.")
1103 $this->router
->pathFor('me')
1107 if ($member->id
!= $id) {
1108 $member->load($this->login
->id
);
1112 // flagging required fields
1113 $fc = $this->fields_config
;
1115 // password required if we create a new member
1116 if ($member->id
!= '') {
1117 $fc->setNotRequired('mdp_adh');
1120 //handle requirements for parent fields
1121 $parent_fields = $member->getParentFields();
1122 $tpl_parent_fields = []; //for JS when detaching
1123 foreach ($parent_fields as $field) {
1124 if ($fc->isRequired($field)) {
1125 $tpl_parent_fields[] = $field;
1126 if ($member->hasParent()) {
1127 $fc->setNotRequired($field);
1132 // flagging required fields invisible to members
1133 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1134 $fc->setNotRequired('activite_adh');
1135 $fc->setNotRequired('id_statut');
1138 // template variable declaration
1139 $title = _T("Member Profile");
1140 if ($member->id
!= '') {
1141 $title .= ' (' . _T("modification") . ')';
1143 $title .= ' (' . _T("creation") . ')';
1147 $statuts = new Status($this->zdb
);
1150 $groups = new Groups($this->zdb
, $this->login
);
1151 $groups_list = $groups->getSimpleList(true);
1153 $form_elements = $fc->getFormElements(
1161 if ($member->hasParent()) {
1162 $id = ($member->parent
instanceof Adherent ?
$member->parent
->id
: $member->parent
);
1164 $members = $m->getSelectizedMembers(
1169 $route_params['members'] = [
1170 'filters' => $m->getFilters(),
1171 'count' => $m->getCount()
1174 if (count($members)) {
1175 $route_params['members']['list'] = $members;
1179 $this->view
->render(
1183 'parent_tpl' => 'page.tpl',
1184 'autocomplete' => true,
1185 'page_title' => $title,
1186 'member' => $member,
1187 'self_adh' => false,
1188 // pseudo random int
1190 'titles_list' => Titles
::getList($this->zdb
),
1191 'statuts' => $statuts->getList(),
1192 'groups' => $groups_list,
1193 'fieldsets' => $form_elements['fieldsets'],
1194 'hidden_elements' => $form_elements['hiddens'],
1195 'parent_fields' => $tpl_parent_fields
1204 * @param Request $request PSR Request
1205 * @param Response $response PSR Response
1206 * @param array $args Request arguments
1210 public function doEdit(Request
$request, Response
$response, array $args = []) :Response
1212 return $this->store($request, $response, $args);
1216 * Massive change page
1218 * @param Request $request PSR Request
1219 * @param Response $response PSR Response
1220 * @param array $args Request arguments
1224 public function massChange(Request
$request, Response
$response, array $args = []) :Response
1226 $filters = $this->session
->filter_members
;
1229 'id' => $filters->selected
,
1230 'redirect_uri' => $this->router
->pathFor('members')
1233 $fc = $this->fields_config
;
1234 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1242 'children' => false,
1245 $member = new Adherent($this->zdb
, null, $deps);
1248 $statuts = new Status($this->zdb
);
1251 $this->view
->render(
1253 'mass_change_members.tpl',
1255 'mode' => $request->isXhr() ?
'ajax' : '',
1256 'page_title' => str_replace(
1259 _T('Mass change %count members')
1261 'form_url' => $this->router
->pathFor('masschangeMembersReview'),
1262 'cancel_uri' => $this->router
->pathFor('members'),
1264 'member' => $member,
1265 'fieldsets' => $form_elements['fieldsets'],
1266 'titles_list' => Titles
::getList($this->zdb
),
1267 'statuts' => $statuts->getList(),
1268 'require_mass' => true
1275 * Massive changes validation page
1277 * @param Request $request PSR Request
1278 * @param Response $response PSR Response
1279 * @param array $args Request arguments
1283 public function validateMassChange(Request
$request, Response
$response, array $args = []) :Response
1285 $post = $request->getParsedBody();
1287 if (!isset($post['confirm'])) {
1288 $this->flash
->addMessage(
1290 _T("Mass changes has not been confirmed!")
1293 //we want only visibles fields
1294 $fc = $this->fields_config
;
1295 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1298 foreach ($form_elements['fieldsets'] as $form_element) {
1299 foreach ($form_element->elements
as $field) {
1300 if (isset($post[$field->field_id
]) && isset($post['mass_' . $field->field_id
])) {
1301 $changes[$field->field_id
] = [
1302 'label' => $field->label
,
1303 'value' => $post[$field->field_id
]
1310 $filters = $this->session
->filter_members
;
1312 'id' => $filters->selected
,
1313 'redirect_uri' => $this->router
->pathFor('members')
1317 $statuts = new Status($this->zdb
);
1320 $this->view
->render(
1322 'mass_change_members.tpl',
1324 'mode' => $request->isXhr() ?
'ajax' : '',
1325 'page_title' => str_replace(
1328 _T('Review mass change %count members')
1330 'form_url' => $this->router
->pathFor('massstoremembers'),
1331 'cancel_uri' => $this->router
->pathFor('members'),
1333 'titles_list' => Titles
::getList($this->zdb
),
1334 'statuts' => $statuts->getList(),
1335 'changes' => $changes
1342 * Do massive changes
1344 * @param Request $request PSR Request
1345 * @param Response $response PSR Response
1346 * @param array $args Request arguments
1350 public function doMassChange(Request
$request, Response
$response, array $args = []) :Response
1352 $post = $request->getParsedBody();
1353 $redirect_url = $post['redirect_uri'];
1354 $error_detected = [];
1357 unset($post['redirect_uri']);
1358 if (!isset($post['confirm'])) {
1359 $error_detected[] = _T("Mass changes has not been confirmed!");
1361 unset($post['confirm']);
1365 $fc = $this->fields_config
;
1366 $form_elements = $fc->getMassiveFormElements($this->members_fields
, $this->login
);
1367 $disabled = $this->members_fields
;
1368 foreach (array_keys($post) as $key) {
1370 foreach ($form_elements['fieldsets'] as $fieldset) {
1371 if (isset($fieldset->elements
[$key])) {
1378 'Permission issue mass editing field ' . $key,
1383 unset($disabled[$key]);
1387 if (!count($post)) {
1388 $error_detected[] = _T("Nothing to do!");
1390 foreach ($ids as $id) {
1391 $is_manager = !$this->login
->isAdmin()
1392 && !$this->login
->isStaff()
1393 && $this->login
->isGroupManager();
1396 'groups' => $is_manager,
1399 'children' => false,
1402 $member = new Adherent($this->zdb
, (int)$id, $deps);
1403 $member->setDependencies(
1405 $this->members_fields
,
1408 if (!$member->canEdit($this->login
)) {
1412 $valid = $member->check($post, [], $disabled);
1413 if ($valid === true) {
1414 $done = $member->store();
1416 $error_detected[] = _T("An error occurred while storing the member.");
1421 $error_detected = array_merge($error_detected, $valid);
1427 if ($mass == 0 && !count($error_detected)) {
1428 $error_detected[] = _T('Something went wront during mass edition!');
1430 $this->flash
->addMessage(
1435 _T('%count members has been changed successfully!')
1440 if (count($error_detected) > 0) {
1441 foreach ($error_detected as $error) {
1442 $this->flash
->addMessage(
1449 if (!$request->isXhr()) {
1452 ->withHeader('Location', $redirect_url);
1454 return $response->withJson(
1456 'success' => count($error_detected) === 0
1465 * @param Request $request PSR Request
1466 * @param Response $response PSR Response
1467 * @param array $args Request arguments
1471 public function store(Request
$request, Response
$response, array $args = []) :Response
1473 if (!$this->preferences
->pref_bool_selfsubscribe
&& !$this->login
->isLogged()) {
1476 ->withHeader('Location', $this->router
->pathFor('slash'));
1479 $post = $request->getParsedBody();
1488 $member = new Adherent($this->zdb
, null, $deps);
1489 $member->setDependencies(
1491 $this->members_fields
,
1494 if (isset($args['self'])) {
1495 //mark as self membership
1496 $member->setSelfMembership();
1499 $success_detected = [];
1500 $warning_detected = [];
1501 $error_detected = [];
1504 $adherent['id_adh'] = get_numeric_form_value('id_adh', '');
1505 if ($this->login
->isAdmin() ||
$this->login
->isStaff() ||
$this->login
->isGroupManager()) {
1506 if ($adherent['id_adh']) {
1507 $member->load((int)$adherent['id_adh']);
1508 if (!$member->canEdit($this->login
)) {
1509 //redirection should have been done before. Just throw an Exception.
1510 throw new \
RuntimeException(
1514 'No right to store member #%id'
1520 $member->load($this->login
->id
);
1521 $adherent['id_adh'] = $this->login
->id
;
1524 // flagging required fields
1525 $fc = $this->fields_config
;
1527 // password required if we create a new member
1528 if ($member->id
!= '') {
1529 $fc->setNotRequired('mdp_adh');
1532 if ($member->hasParent() && !isset($post['detach_parent'])
1533 ||
isset($post['parent_id']) && !empty($post['parent_id'])
1535 $parent_fields = $member->getParentFields();
1536 foreach ($parent_fields as $field) {
1537 if ($fc->isRequired($field)) {
1538 $fc->setNotRequired($field);
1543 // flagging required fields invisible to members
1544 if ($this->login
->isAdmin() ||
$this->login
->isStaff()) {
1545 $fc->setNotRequired('activite_adh');
1546 $fc->setNotRequired('id_statut');
1549 $form_elements = $fc->getFormElements(
1552 isset($args['self'])
1554 $fieldsets = $form_elements['fieldsets'];
1555 $required = array();
1556 $disabled = array();
1558 foreach ($fieldsets as $category) {
1559 foreach ($category->elements
as $field) {
1560 if ($field->required
== true) {
1561 $required[$field->field_id
] = true;
1563 if ($field->disabled
== true) {
1564 $disabled[$field->field_id
] = true;
1565 } elseif (!isset($post[$field->field_id
])) {
1566 switch ($field->field_id
) {
1567 //unchecked booleans are not sent from form
1568 case 'bool_admin_adh':
1569 case 'bool_exempt_adh':
1570 case 'bool_display_info':
1571 $post[$field->field_id
] = 0;
1578 $real_requireds = array_diff(array_keys($required), array_keys($disabled));
1581 $redirect_url = $this->router
->pathFor('member', ['id' => $member->id
]);
1582 if (isset($post[array_shift($real_requireds)])) {
1584 $valid = $member->check($post, $required, $disabled);
1585 if ($valid !== true) {
1586 $error_detected = array_merge($error_detected, $valid);
1589 if (count($error_detected) == 0) {
1590 //all goes well, we can proceed
1593 if ($member->id
== '') {
1596 $store = $member->store();
1597 if ($store === true) {
1598 //member has been stored :)
1600 if (isset($args['self'])) {
1601 $success_detected[] = _T("Your account has been created!");
1602 if ($this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1603 && $member->getEmail() != ''
1605 $success_detected[] = _T("An email has been sent to you, check your inbox.");
1608 $success_detected[] = _T("New member has been successfully added.");
1610 //Send email to admin if preference checked
1611 if ($this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
1612 && $this->preferences
->pref_bool_mailadh
1618 'name_adh' => custom_html_entity_decode(
1621 'firstname_adh' => custom_html_entity_decode(
1624 'lastname_adh' => custom_html_entity_decode(
1627 'mail_adh' => custom_html_entity_decode(
1630 'login_adh' => custom_html_entity_decode(
1635 $mtxt = $texts->getTexts(
1636 (isset($args['self']) ?
'newselfadh' : 'newadh'),
1637 $this->preferences
->pref_lang
1640 $mail = new GaletteMail($this->preferences
);
1641 $mail->setSubject($texts->getSubject());
1643 foreach ($this->preferences
->vpref_email_newadh
as $pref_email) {
1644 $recipients[$pref_email] = $pref_email;
1646 $mail->setRecipients($recipients);
1647 $mail->setMessage($texts->getBody());
1648 $sent = $mail->send();
1650 if ($sent == GaletteMail
::MAIL_SENT
) {
1651 $this->history
->add(
1654 $member->sname
. ' (' . $member->email
. ')',
1655 _T("New account email sent to admin for '%s'.")
1661 $member->sname
. ' (' . $member->email
. ')',
1662 _T("A problem happened while sending email to admin for account '%s'.")
1664 $this->history
->add($str);
1665 $warning_detected[] = $str;
1670 $success_detected[] = _T("Member account has been modified.");
1673 // send email to member
1674 if (isset($args['self']) ||
isset($post['mail_confirm']) && $post['mail_confirm'] == '1') {
1675 if ($this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
) {
1676 if ($member->getEmail() == '' && !isset($args['self'])) {
1677 $error_detected[] = _T("- You can't send a confirmation by email if the member hasn't got an address!");
1680 'name_adh' => custom_html_entity_decode(
1683 'firstname_adh' => custom_html_entity_decode(
1686 'lastname_adh' => custom_html_entity_decode(
1689 'mail_adh' => custom_html_entity_decode(
1692 'login_adh' => custom_html_entity_decode(
1697 $password = new Password($this->zdb
);
1698 $res = $password->generateNewPassword($member->id
);
1700 $link_validity = new \
DateTime();
1701 $link_validity->add(new \
DateInterval('PT24H'));
1702 $mreplaces['change_pass_uri'] = $this->preferences
->getURL() .
1703 $this->router
->pathFor(
1704 'password-recovery',
1705 ['hash' => base64_encode($password->getHash())]
1707 $mreplaces['link_validity'] = $link_validity->format(_T("Y-m-d H:i:s"));
1712 _T("An error occurred storing temporary password for %s. Please inform an admin.")
1714 $this->history
->add($str);
1715 $this->flash
->addMessage(
1722 //send email to member
1723 // Get email text in database
1729 $mlang = $this->preferences
->pref_lang
;
1730 if (isset($post['pref_lang'])) {
1731 $mlang = $post['pref_lang'];
1733 $mtxt = $texts->getTexts(
1734 (($new) ?
'sub' : 'accountedited'),
1738 $mail = new GaletteMail($this->preferences
);
1739 $mail->setSubject($texts->getSubject());
1740 $mail->setRecipients(
1742 $member->getEmail() => $member->sname
1745 $mail->setMessage($texts->getBody());
1746 $sent = $mail->send();
1748 if ($sent == GaletteMail
::MAIL_SENT
) {
1751 $member->sname
. ' (' . $member->getEmail() . ')',
1753 _T("New account email sent to '%s'.") : _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);