3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Galette main 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/>.
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
;
40 use Slim\Http\Request
;
41 use Slim\Http\Response
;
42 use Galette\Core\Logo
;
43 use Galette\Core\PrintLogo
;
44 use Galette\Core\GaletteMail
;
45 use Galette\Core\SysInfos
;
46 use Galette\Entity\Contribution
;
47 use Galette\Entity\FieldsCategories
;
48 use Galette\Entity\Status
;
49 use Galette\Entity\Texts
;
50 use Galette\Filters\MembersList
;
52 use Galette\IO\Charts
;
53 use Galette\IO\PdfMembersCards
;
54 use Galette\IO\PdfContribution
;
55 use Galette\Repository\Members
;
56 use Galette\Repository\Reminders
;
60 * Galette main controller
62 * @category Controllers
63 * @name GaletteController
65 * @author Johan Cwiklinski <johan@x-tnd.be>
66 * @copyright 2019-2020 The Galette Team
67 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
68 * @link http://galette.tuxfamily.org
69 * @since Available since 0.9.4dev - 2019-12-02
72 class GaletteController
extends AbstractController
77 * @param Request $request PSR Request
78 * @param Response $response PSR Response
79 * @param array $args Request arguments
83 public function slash(Request
$request, Response
$response, array $args = []): Response
85 return $this->galetteRedirect($request, $response, $args);
91 * @param Request $request PSR Request
92 * @param Response $response PSR Response
96 public function systemInformation(Request
$request, Response
$response): Response
98 $sysinfos = new SysInfos();
99 $raw_infos = $sysinfos->getRawData(
110 'page_title' => _T("System information"),
111 'rawinfos' => $raw_infos
120 * @param Request $request PSR Request
121 * @param Response $response PSR Response
125 public function dashboard(Request
$request, Response
$response): Response
127 $news = new News($this->preferences
->pref_rss_url
);
130 'page_title' => _T("Dashboard"),
131 'contentcls' => 'desktop',
132 'news' => $news->getPosts(),
133 'show_dashboard' => $_COOKIE['show_galette_dashboard']
136 $hide_telemetry = true;
137 if ($this->login
->isAdmin()) {
138 $telemetry = new \Galette\Util\
Telemetry(
143 $params['reguuid'] = $telemetry->getRegistrationUuid();
144 $params['telemetry_sent'] = $telemetry->isSent();
145 $params['registered'] = $telemetry->isRegistered();
147 $hide_telemetry = $telemetry->isSent() && $telemetry->isRegistered()
148 ||
isset($_COOKIE['hide_galette_telemetry']) && $_COOKIE['hide_galette_telemetry'];
150 $params['hide_telemetry'] = $hide_telemetry;
164 * @param Request $request PSR Request
165 * @param Response $response PSR Response
169 public function preferences(Request
$request, Response
$response): Response
171 // flagging required fields
178 'pref_etiq_marges_v' => 1,
179 'pref_etiq_marges_h' => 1,
180 'pref_etiq_hspace' => 1,
181 'pref_etiq_vspace' => 1,
182 'pref_etiq_hsize' => 1,
183 'pref_etiq_vsize' => 1,
184 'pref_etiq_cols' => 1,
185 'pref_etiq_rows' => 1,
186 'pref_etiq_corps' => 1,
187 'pref_card_abrev' => 1,
188 'pref_card_strip' => 1,
189 'pref_card_marges_v' => 1,
190 'pref_card_marges_h' => 1,
191 'pref_card_hspace' => 1,
192 'pref_card_vspace' => 1
195 if ($this->login
->isSuperAdmin() && GALETTE_MODE
!== 'DEMO') {
196 $required['pref_admin_login'] = 1;
199 $prefs_fields = $this->preferences
->getFieldsNames();
201 foreach ($prefs_fields as $fieldname) {
202 $pref[$fieldname] = $this->preferences
->$fieldname;
205 //on error, user values are stored into session
206 if ($this->session
->entered_preferences
) {
207 $pref = array_merge($pref, $this->session
->entered_preferences
);
208 $this->session
->entered_preferences
= null;
211 //List available themes
213 $d = dir(GALETTE_THEMES_PATH
);
214 while (($entry = $d->read()) !== false) {
215 $full_entry = GALETTE_THEMES_PATH
. $entry;
219 && is_dir($full_entry)
220 && file_exists($full_entry . '/page.tpl')
228 $s = new Status($this->zdb
);
235 'page_title' => _T("Settings"),
236 'staff_members' => $m->getStaffMembersList(true),
239 'pref_numrows_options' => array(
245 'print_logo' => $this->print_logo
,
246 'required' => $required,
248 'statuts' => $s->getList(),
249 'accounts_options' => array(
250 Members
::ALL_ACCOUNTS
=> _T("All accounts"),
251 Members
::ACTIVE_ACCOUNT
=> _T("Active accounts"),
252 Members
::INACTIVE_ACCOUNT
=> _T("Inactive accounts")
262 * @param Request $request PSR Request
263 * @param Response $response PSR Response
267 public function storePreferences(Request
$request, Response
$response): Response
269 $post = $request->getParsedBody();
270 $error_detected = [];
271 $warning_detected = [];
274 if (isset($post['valid']) && $post['valid'] == '1') {
275 if ($this->preferences
->check($post, $this->login
)) {
276 if (!$this->preferences
->store()) {
277 $error_detected[] = _T("An SQL error has occurred while storing preferences. Please try again, and contact the administrator if the problem persists.");
279 $this->flash
->addMessage(
281 _T("Preferences has been saved.")
284 $warning_detected = array_merge($warning_detected, $this->preferences
->checkCardsSizes());
287 if (GALETTE_MODE
!== 'DEMO' && isset($_FILES['logo'])) {
288 if ($_FILES['logo']['error'] === UPLOAD_ERR_OK
) {
289 if ($_FILES['logo']['tmp_name'] != '') {
290 if (is_uploaded_file($_FILES['logo']['tmp_name'])) {
291 $res = $this->logo
->store($_FILES['logo']);
293 $error_detected[] = $this->logo
->getErrorMessage($res);
295 $this->logo
= new Logo();
299 } elseif ($_FILES['logo']['error'] !== UPLOAD_ERR_NO_FILE
) {
301 $this->logo
->getPhpErrorMessage($_FILES['logo']['error']),
304 $error_detected[] = $this->logo
->getPhpErrorMessage(
305 $_FILES['logo']['error']
310 if (GALETTE_MODE
!== 'DEMO' && isset($post['del_logo'])) {
311 if (!$this->logo
->delete()) {
312 $error_detected[] = _T("Delete failed");
314 $this->logo
= new Logo(); //get default Logo
319 if (GALETTE_MODE
!== 'DEMO' && isset($_FILES['card_logo'])) {
320 if ($_FILES['card_logo']['error'] === UPLOAD_ERR_OK
) {
321 if ($_FILES['card_logo']['tmp_name'] != '') {
322 if (is_uploaded_file($_FILES['card_logo']['tmp_name'])) {
323 $res = $this->print_logo
->store($_FILES['card_logo']);
325 $error_detected[] = $this->print_logo
->getErrorMessage($res);
327 $this->print_logo
= new PrintLogo();
331 } elseif ($_FILES['card_logo']['error'] !== UPLOAD_ERR_NO_FILE
) {
333 $this->print_logo
->getPhpErrorMessage($_FILES['card_logo']['error']),
336 $error_detected[] = $this->print_logo
->getPhpErrorMessage(
337 $_FILES['card_logo']['error']
342 if (GALETTE_MODE
!== 'DEMO' && isset($post['del_card_logo'])) {
343 if (!$this->print_logo
->delete()) {
344 $error_detected[] = _T("Delete failed");
346 $this->print_logo
= new PrintLogo();
350 $error_detected = $this->preferences
->getErrors();
353 if (count($error_detected) > 0) {
354 $this->session
->entered_preferences
= $post;
356 foreach ($error_detected as $error) {
357 $this->flash
->addMessage(
364 if (count($warning_detected) > 0) {
366 foreach ($warning_detected as $warning) {
367 $this->flash
->addMessage(
377 ->withHeader('Location', $this->router
->pathFor('preferences'));
381 * Test mail parameters
383 * @param Request $request PSR Request
384 * @param Response $response PSR Response
388 public function testEmail(Request
$request, Response
$response): Response
391 if (!$this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
) {
392 $this->flash
->addMessage(
394 _T("You asked Galette to send a test email, but email has been disabled in the preferences.")
397 $get = $request->getQueryParams();
398 $dest = (isset($get['adress']) ?
$get['adress'] : $this->preferences
->pref_email_newadh
);
399 if (GaletteMail
::isValidEmail($dest)) {
400 $mail = new GaletteMail($this->preferences
);
401 $mail->setSubject(_T('Test message'));
402 $mail->setRecipients(
404 $dest => _T("Galette admin")
407 $mail->setMessage(_T('Test message.'));
408 $sent = $mail->send();
411 $this->flash
->addMessage(
416 _T("An email has been sent to %email")
420 $this->flash
->addMessage(
425 _T("No email sent to %email")
430 $this->flash
->addMessage(
432 _T("Invalid email adress!")
437 if (!$request->isXhr()) {
440 ->withHeader('Location', $this->router
->pathFor('preferences'));
442 return $response->withJson(
453 * @param Request $request PSR Request
454 * @param Response $response PSR Response
458 public function charts(Request
$request, Response
$response): Response
460 $charts = new Charts(
462 Charts
::MEMBERS_STATUS_PIE
,
463 Charts
::MEMBERS_STATEDUE_PIE
,
464 Charts
::CONTRIBS_TYPES_PIE
,
465 Charts
::COMPANIES_OR_NOT
,
466 Charts
::CONTRIBS_ALLTIME
475 'page_title' => _T("Charts"),
476 'charts' => $charts->getCharts(),
477 'require_charts' => true
484 * Core fields configuration page
486 * @param Request $request PSR Request
487 * @param Response $response PSR Response
491 public function configureCoreFields(Request
$request, Response
$response): Response
493 $fc = $this->fields_config
;
496 'page_title' => _T("Fields configuration"),
498 'categories' => FieldsCategories
::getList($this->zdb
),
499 'categorized_fields' => $fc->getCategorizedFields(),
500 'non_required' => $fc->getNonRequired()
513 * Process core fields configuration
515 * @param Request $request PSR Request
516 * @param Response $response PSR Response
520 public function storeCoreFieldsConfig(Request
$request, Response
$response): Response
522 $post = $request->getParsedBody();
523 $fc = $this->fields_config
;
528 foreach ($post['fields'] as $abs_pos => $field) {
529 if ($current_cat != $post[$field . '_category']) {
530 //reset position when category has changed
532 //set new current category
533 $current_cat = $post[$field . '_category'];
537 if (isset($post[$field . '_required'])) {
538 $required = $post[$field . '_required'];
543 $res[$current_cat][] = array(
544 'field_id' => $field,
545 'label' => $post[$field . '_label'],
546 'category' => $post[$field . '_category'],
547 'visible' => $post[$field . '_visible'],
548 'required' => $required
552 //okay, we've got the new array, we send it to the
553 //Object that will store it in the database
554 $success = $fc->setFields($res);
555 FieldsCategories
::setCategories($this->zdb
, $post['categories']);
556 if ($success === true) {
557 $this->flash
->addMessage(
559 _T("Fields configuration has been successfully stored")
562 $this->flash
->addMessage(
564 _T("An error occurred while storing fields configuration :(")
570 ->withHeader('Location', $this->router
->pathFor('configureCoreFields'));
574 * Core lists configuration page
576 * @param Request $request PSR Request
577 * @param Response $response PSR Response
578 * @param array $args Request arguments
582 public function configureListFields(Request
$request, Response
$response, array $args = []): Response
584 $table = $args['table'];
585 //TODO: check if type table exists
587 $lc = $this->lists_config
;
590 'page_title' => _T("Lists configuration"),
593 'listed_fields' => $lc->getListedFields(),
594 'remaining_fields' => $lc->getRemainingFields()
607 * Process list fields configuration
609 * @param Request $request PSR Request
610 * @param Response $response PSR Response
611 * @param array $args Request arguments
615 public function storeListFields(Request
$request, Response
$response, array $args = []): Response
617 $post = $request->getParsedBody();
619 $lc = $this->lists_config
;
621 foreach ($post['fields'] as $field) {
622 $fields[] = $lc->getField($field);
624 $success = $lc->setListFields($fields);
626 if ($success === true) {
627 $this->flash
->addMessage(
629 _T("List configuration has been successfully stored")
632 $this->flash
->addMessage(
634 _T("An error occurred while storing list configuration :(")
640 ->withHeader('Location', $this->router
->pathFor('configureListFields', $args));
646 * @param Request $request PSR Request
647 * @param Response $response PSR Response
651 public function fakeData(Request
$request, Response
$response): Response
654 'page_title' => _T('Generate fake data'),
655 'number_members' => \Galette\Util\FakeData
::DEFAULT_NB_MEMBERS
,
656 'number_contrib' => \Galette\Util\FakeData
::DEFAULT_NB_CONTRIB
,
657 'number_groups' => \Galette\Util\FakeData
::DEFAULT_NB_GROUPS
,
658 'number_transactions' => \Galette\Util\FakeData
::DEFAULT_NB_TRANSACTIONS
,
659 'photos' => \Galette\Util\FakeData
::DEFAULT_PHOTOS
674 * @param Request $request PSR Request
675 * @param Response $response PSR Response
679 public function doFakeData(Request
$request, Response
$response): Response
681 $post = $request->getParsedBody();
683 $fakedata = new \Galette\Util\
FakeData($this->zdb
, $this->i18n
);
685 $fakedata->setDependencies(
687 $this->members_fields
,
693 ->setNbMembers($post['number_members'])
694 ->setNbGroups($post['number_groups'])
695 ->setNbTransactions($post['number_transactions'])
696 ->setMaxContribs($post['number_contrib'])
697 ->setWithPhotos(isset($post['photos']));
699 $fakedata->generate();
701 $report = $fakedata->getReport();
703 foreach ($report['success'] as $success) {
704 $this->flash
->addMessage(
710 foreach ($report['errors'] as $error) {
711 $this->flash
->addMessage(
717 foreach ($report['warnings'] as $warning) {
718 $this->flash
->addMessage(
726 ->withHeader('Location', $this->router
->pathFor('slash'));
732 * @param Request $request PSR Request
733 * @param Response $response PSR Response
737 public function reminders(Request
$request, Response
$response): Response
739 $texts = new Texts($this->preferences
, $this->router
);
742 'impending' => $texts->getTexts('impendingduedate', $this->preferences
->pref_lang
),
743 'late' => $texts->getTexts('lateduedate', $this->preferences
->pref_lang
)
746 $members = new Members();
747 $reminders = $members->getRemindersCount();
754 'page_title' => _T("Reminders"),
755 'previews' => $previews,
756 'count_impending' => $reminders['impending'],
757 'count_impending_nomail' => $reminders['nomail']['impending'],
758 'count_late' => $reminders['late'],
759 'count_late_nomail' => $reminders['nomail']['late']
768 * @param Request $request PSR Request
769 * @param Response $response PSR Response
773 public function doReminders(Request
$request, Response
$response): Response
775 $error_detected = [];
776 $warning_detected = [];
777 $success_detected = [];
779 $post = $request->getParsedBody();
780 $texts = new Texts($this->preferences
, $this->router
);
782 if (isset($post['reminders'])) {
783 $selected = $post['reminders'];
785 $reminders = new Reminders($selected);
788 $labels_members = array();
789 if (isset($post['reminder_wo_mail'])) {
793 $list_reminders = $reminders->getList($this->zdb
, $labels);
794 if (count($list_reminders) == 0) {
795 $warning_detected[] = _T("No reminder to send for now.");
797 foreach ($list_reminders as $reminder) {
798 if ($labels === false) {
799 //send reminders by email
800 $sent = $reminder->send($texts, $this->history
, $this->zdb
);
802 if ($sent === true) {
803 $success_detected[] = $reminder->getMessage();
805 $error_detected[] = $reminder->getMessage();
808 //generate labels for members without email address
809 $labels_members[] = $reminder->member_id
;
813 if ($labels === true) {
814 if (count($labels_members) > 0) {
815 $session_var = 'filters_reminders_labels';
816 $labels_filters = new MembersList();
817 $labels_filters->selected
= $labels_members;
818 $this->session
->$session_var = $labels_filters;
823 $this->router
->pathFor('pdf-member-labels') . '?session_var=' . $session_var
826 $error_detected[] = _T("There are no member to proceed.");
830 if (count($error_detected) > 0) {
833 _T("Reminder has not been sent:")
837 if (count($success_detected) > 0) {
840 _T("Sent reminders:")
845 //flash messages if any
846 if (count($error_detected) > 0) {
847 foreach ($error_detected as $error) {
848 $this->flash
->addMessage('error_detected', $error);
851 if (count($warning_detected) > 0) {
852 foreach ($warning_detected as $warning) {
853 $this->flash
->addMessage('warning_detected', $warning);
856 if (count($success_detected) > 0) {
857 foreach ($success_detected as $success) {
858 $this->flash
->addMessage('success_detected', $success);
864 ->withHeader('Location', $this->router
->pathFor('reminders'));
870 * @param Request $request PSR Request
871 * @param Response $response PSR Response
872 * @param array $args Request arguments
876 public function filterReminders(Request
$request, Response
$response, array $args = []): Response
878 //always reset filters
879 $filters = new MembersList();
880 $filters->filter_account
= Members
::ACTIVE_ACCOUNT
;
882 $membership = ($args['membership'] === 'nearly' ?
883 Members
::MEMBERSHIP_NEARLY
:
884 Members
::MEMBERSHIP_LATE
);
885 $filters->membership_filter
= $membership;
887 //TODO: filter on reminder may take care of parent email as well
888 $mail = ($args['mail'] === 'withmail' ?
889 Members
::FILTER_W_EMAIL
:
890 Members
::FILTER_WO_EMAIL
);
891 $filters->email_filter
= $mail;
893 $this->session
->filter_members
= $filters;
897 ->withHeader('Location', $this->router
->pathFor('members'));
901 * Direct document page
903 * @param Request $request PSR Request
904 * @param Response $response PSR Response
905 * @param array $args Request arguments
909 public function documentLink(Request
$request, Response
$response, array $args = []): Response
916 'hash' => $args['hash'],
917 'page_title' => _T('Download document')