3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
6 * Galette main controller
10 * Copyright © 2019-2023 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-2023 The Galette Team
32 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
33 * @link http://galette.tuxfamily.org
34 * @since Available since 0.9.4dev - 2019-12-02
37 namespace Galette\Controllers
;
39 use Galette\Entity\Social
;
40 use Galette\Repository\PaymentTypes
;
41 use Slim\Psr7\Request
;
42 use Slim\Psr7\Response
;
43 use Galette\Core\Logo
;
44 use Galette\Core\PrintLogo
;
45 use Galette\Core\Galette
;
46 use Galette\Core\GaletteMail
;
47 use Galette\Core\SysInfos
;
48 use Galette\Entity\FieldsCategories
;
49 use Galette\Entity\Status
;
50 use Galette\Entity\Texts
;
51 use Galette\Filters\MembersList
;
53 use Galette\IO\Charts
;
54 use Galette\Repository\Members
;
55 use Galette\Repository\Reminders
;
59 * Galette main controller
61 * @category Controllers
62 * @name GaletteController
64 * @author Johan Cwiklinski <johan@x-tnd.be>
65 * @copyright 2019-2023 The Galette Team
66 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
67 * @link http://galette.tuxfamily.org
68 * @since Available since 0.9.4dev - 2019-12-02
71 class GaletteController
extends AbstractController
76 * @param Request $request PSR Request
77 * @param Response $response PSR Response
81 public function slash(Request
$request, Response
$response): Response
83 return $this->galetteRedirect($request, $response);
89 * @param Request $request PSR Request
90 * @param Response $response PSR Response
94 public function systemInformation(Request
$request, Response
$response): Response
96 $sysinfos = new SysInfos();
97 $raw_infos = $sysinfos->getRawData(
106 'pages/sysinfos.html.twig',
108 'page_title' => _T("System information"),
109 'rawinfos' => $raw_infos
118 * @param Request $request PSR Request
119 * @param Response $response PSR Response
123 public function dashboard(Request
$request, Response
$response): Response
125 $news = new News($this->preferences
->pref_rss_url
);
128 'page_title' => _T("Dashboard"),
129 'contentcls' => 'desktop',
130 'news' => $news->getPosts(),
131 'show_dashboard' => $_COOKIE['show_galette_dashboard']
134 $hide_telemetry = true;
135 if ($this->login
->isAdmin()) {
136 $telemetry = new \Galette\Util\
Telemetry(
141 $params['reguuid'] = $telemetry->getRegistrationUuid();
142 $params['telemetry_sent'] = $telemetry->isSent();
143 $params['registered'] = $telemetry->isRegistered();
145 $hide_telemetry = $telemetry->isSent() && $telemetry->isRegistered()
146 ||
isset($_COOKIE['hide_galette_telemetry']) && $_COOKIE['hide_galette_telemetry'];
148 $params['hide_telemetry'] = $hide_telemetry;
153 'pages/desktop.html.twig',
162 * @param Request $request PSR Request
163 * @param Response $response PSR Response
167 public function preferences(Request
$request, Response
$response): Response
169 // flagging required fields
176 'pref_etiq_marges_v' => 1,
177 'pref_etiq_marges_h' => 1,
178 'pref_etiq_hspace' => 1,
179 'pref_etiq_vspace' => 1,
180 'pref_etiq_hsize' => 1,
181 'pref_etiq_vsize' => 1,
182 'pref_etiq_cols' => 1,
183 'pref_etiq_rows' => 1,
184 'pref_etiq_corps' => 1,
185 'pref_card_abrev' => 1,
186 'pref_card_strip' => 1,
187 'pref_card_marges_v' => 1,
188 'pref_card_marges_h' => 1,
189 'pref_card_hspace' => 1,
190 'pref_card_vspace' => 1
193 if ($this->login
->isSuperAdmin() && GALETTE_MODE
!== Galette
::MODE_DEMO
) {
194 $required['pref_admin_login'] = 1;
197 $prefs_fields = $this->preferences
->getFieldsNames();
200 foreach ($prefs_fields as $fieldname) {
201 $pref[$fieldname] = $this->preferences
->$fieldname;
204 //on error, user values are stored into session
205 if ($this->session
->entered_preferences
) {
206 $pref = array_merge($pref, $this->session
->entered_preferences
);
207 $this->session
->entered_preferences
= null;
210 //List available themes
212 $d = dir(GALETTE_THEMES_PATH
);
213 while (($entry = $d->read()) !== false) {
214 $full_entry = GALETTE_THEMES_PATH
. $entry;
218 && is_dir($full_entry)
219 && file_exists($full_entry . '/page.html.twig')
226 //List payment types for default to be selected
227 $ptypes = new PaymentTypes(
232 $ptlist = $ptypes->getList();
235 $s = new Status($this->zdb
);
238 $tab = $request->getQueryParams()['tab'] ??
'general';
243 'pages/preferences.html.twig',
245 'page_title' => _T("Settings"),
246 'staff_members' => $m->getStaffMembersList(true),
249 'pref_numrows_options' => array(
255 'print_logo' => $this->print_logo
,
256 'required' => $required,
258 'statuts' => $s->getList(),
259 'accounts_options' => array(
260 Members
::ALL_ACCOUNTS
=> _T("All accounts"),
261 Members
::ACTIVE_ACCOUNT
=> _T("Active accounts"),
262 Members
::INACTIVE_ACCOUNT
=> _T("Inactive accounts")
264 'paymenttypes' => $ptlist,
265 'osocials' => new Social($this->zdb
),
275 * @param Request $request PSR Request
276 * @param Response $response PSR Response
280 public function storePreferences(Request
$request, Response
$response): Response
282 $post = $request->getParsedBody();
283 $error_detected = [];
284 $warning_detected = [];
287 if (isset($post['valid']) && $post['valid'] == '1') {
288 if ($this->preferences
->check($post, $this->login
)) {
289 if (!$this->preferences
->store()) {
290 $error_detected[] = _T("An SQL error has occurred while storing preferences. Please try again, and contact the administrator if the problem persists.");
292 $this->flash
->addMessage(
294 _T("Preferences has been saved.")
297 $warning_detected = array_merge($warning_detected, $this->preferences
->checkCardsSizes());
300 if (GALETTE_MODE
!== Galette
::MODE_DEMO
&& isset($_FILES['logo'])) {
301 if ($_FILES['logo']['error'] === UPLOAD_ERR_OK
) {
302 if ($_FILES['logo']['tmp_name'] != '') {
303 if (is_uploaded_file($_FILES['logo']['tmp_name'])) {
304 $res = $this->logo
->store($_FILES['logo']);
306 $error_detected[] = $this->logo
->getErrorMessage($res);
308 $this->logo
= new Logo();
312 } elseif ($_FILES['logo']['error'] !== UPLOAD_ERR_NO_FILE
) {
314 $this->logo
->getPhpErrorMessage($_FILES['logo']['error']),
317 $error_detected[] = $this->logo
->getPhpErrorMessage(
318 $_FILES['logo']['error']
323 if (GALETTE_MODE
!== Galette
::MODE_DEMO
&& isset($post['del_logo'])) {
324 if (!$this->logo
->delete()) {
325 $error_detected[] = _T("Delete failed");
327 $this->logo
= new Logo(); //get default Logo
332 if (GALETTE_MODE
!== Galette
::MODE_DEMO
&& isset($_FILES['card_logo'])) {
333 if ($_FILES['card_logo']['error'] === UPLOAD_ERR_OK
) {
334 if ($_FILES['card_logo']['tmp_name'] != '') {
335 if (is_uploaded_file($_FILES['card_logo']['tmp_name'])) {
336 $res = $this->print_logo
->store($_FILES['card_logo']);
338 $error_detected[] = $this->print_logo
->getErrorMessage($res);
340 $this->print_logo
= new PrintLogo();
344 } elseif ($_FILES['card_logo']['error'] !== UPLOAD_ERR_NO_FILE
) {
346 $this->print_logo
->getPhpErrorMessage($_FILES['card_logo']['error']),
349 $error_detected[] = $this->print_logo
->getPhpErrorMessage(
350 $_FILES['card_logo']['error']
355 if (GALETTE_MODE
!== Galette
::MODE_DEMO
&& isset($post['del_card_logo'])) {
356 if (!$this->print_logo
->delete()) {
357 $error_detected[] = _T("Delete failed");
359 $this->print_logo
= new PrintLogo();
363 $error_detected = $this->preferences
->getErrors();
366 if (count($error_detected) > 0) {
367 $this->session
->entered_preferences
= $post;
369 foreach ($error_detected as $error) {
370 $this->flash
->addMessage(
377 if (count($warning_detected) > 0) {
379 foreach ($warning_detected as $warning) {
380 $this->flash
->addMessage(
387 if (isset($post['tab']) && $post['tab'] != 'general') {
388 $tab = '?tab=' . $post['tab'];
394 ->withHeader('Location', $this->routeparser
->urlFor('preferences') . $tab);
398 * Test mail parameters
400 * @param Request $request PSR Request
401 * @param Response $response PSR Response
405 public function testEmail(Request
$request, Response
$response): Response
408 if (!$this->preferences
->pref_mail_method
> GaletteMail
::METHOD_DISABLED
) {
409 $this->flash
->addMessage(
411 _T("You asked Galette to send a test email, but email has been disabled in the preferences.")
414 $get = $request->getQueryParams();
415 $dest = (isset($get['adress']) ?
$get['adress'] : $this->preferences
->pref_email_newadh
);
416 if (GaletteMail
::isValidEmail($dest)) {
417 $mail = new GaletteMail($this->preferences
);
418 $mail->setSubject(_T('Test message'));
419 $mail->setRecipients(
421 $dest => _T("Galette admin")
424 $mail->setMessage(_T('Test message.'));
425 $sent = $mail->send();
428 $this->flash
->addMessage(
433 _T("An email has been sent to %email")
437 $this->flash
->addMessage(
442 _T("No email sent to %email")
447 $this->flash
->addMessage(
449 _T("Invalid email adress!")
454 if (!($request->getHeaderLine('X-Requested-With') === 'XMLHttpRequest')) {
457 ->withHeader('Location', $this->routeparser
->urlFor('preferences'));
459 return $this->withJson(
471 * @param Request $request PSR Request
472 * @param Response $response PSR Response
476 public function charts(Request
$request, Response
$response): Response
478 $charts = new Charts(
480 Charts
::MEMBERS_STATUS_PIE
,
481 Charts
::MEMBERS_STATEDUE_PIE
,
482 Charts
::CONTRIBS_TYPES_PIE
,
483 Charts
::COMPANIES_OR_NOT
,
484 Charts
::CONTRIBS_ALLTIME
491 'pages/charts.html.twig',
493 'page_title' => _T("Charts"),
494 'charts' => $charts->getCharts(),
495 'require_charts' => true
502 * Core fields configuration page
504 * @param Request $request PSR Request
505 * @param Response $response PSR Response
509 public function configureCoreFields(Request
$request, Response
$response): Response
511 $fc = $this->fields_config
;
514 'page_title' => _T("Fields configuration"),
516 'categories' => FieldsCategories
::getList($this->zdb
),
517 'categorized_fields' => $fc->getCategorizedFields(),
518 'non_required' => $fc->getNonRequired()
524 'pages/configuration_core_fields.html.twig',
531 * Process core fields configuration
533 * @param Request $request PSR Request
534 * @param Response $response PSR Response
538 public function storeCoreFieldsConfig(Request
$request, Response
$response): Response
540 $post = $request->getParsedBody();
541 $fc = $this->fields_config
;
546 foreach ($post['fields'] as $abs_pos => $field) {
547 if ($current_cat != $post[$field . '_category']) {
548 //reset position when category has changed
550 //set new current category
551 $current_cat = $post[$field . '_category'];
555 if (isset($post[$field . '_required'])) {
556 $required = $post[$field . '_required'];
561 $res[$current_cat][] = array(
562 'field_id' => $field,
563 'label' => htmlspecialchars($post[$field . '_label'], ENT_QUOTES
),
564 'category' => $post[$field . '_category'],
565 'visible' => $post[$field . '_visible'],
566 'required' => $required
570 //okay, we've got the new array, we send it to the
571 //Object that will store it in the database
572 $success = $fc->setFields($res);
573 FieldsCategories
::setCategories($this->zdb
, $post['categories']);
574 if ($success === true) {
575 $this->flash
->addMessage(
577 _T("Fields configuration has been successfully stored")
580 $this->flash
->addMessage(
582 _T("An error occurred while storing fields configuration :(")
588 ->withHeader('Location', $this->routeparser
->urlFor('configureCoreFields'));
592 * Core lists configuration page
594 * @param Request $request PSR Request
595 * @param Response $response PSR Response
596 * @param string $table Tbale name
600 public function configureListFields(Request
$request, Response
$response, string $table): Response
602 //TODO: check if type table exists
604 $lc = $this->lists_config
;
607 'page_title' => _T("Lists configuration"),
610 'listed_fields' => $lc->getListedFields(),
611 'remaining_fields' => $lc->getRemainingFields()
617 'pages/configuration_core_lists.html.twig',
624 * Process list fields configuration
626 * @param Request $request PSR Request
627 * @param Response $response PSR Response
631 public function storeListFields(Request
$request, Response
$response): Response
633 $post = $request->getParsedBody();
635 $lc = $this->lists_config
;
637 foreach ($post['fields'] as $field) {
638 $fields[] = $lc->getField($field);
640 $success = $lc->setListFields($fields);
642 if ($success === true) {
643 $this->flash
->addMessage(
645 _T("List configuration has been successfully stored")
648 $this->flash
->addMessage(
650 _T("An error occurred while storing list configuration :(")
656 ->withHeader('Location', $this->routeparser
->urlFor('configureListFields', $this->getArgs($request)));
662 * @param Request $request PSR Request
663 * @param Response $response PSR Response
667 public function reminders(Request
$request, Response
$response): Response
669 $texts = new Texts($this->preferences
, $this->routeparser
);
672 'impending' => $texts->getTexts('impendingduedate', $this->preferences
->pref_lang
),
673 'late' => $texts->getTexts('lateduedate', $this->preferences
->pref_lang
)
676 $members = new Members();
677 $reminders = $members->getRemindersCount();
682 'pages/reminder.html.twig',
684 'page_title' => _T("Reminders"),
685 'previews' => $previews,
686 'count_impending' => $reminders['impending'],
687 'count_impending_nomail' => $reminders['nomail']['impending'],
688 'count_late' => $reminders['late'],
689 'count_late_nomail' => $reminders['nomail']['late']
698 * @param Request $request PSR Request
699 * @param Response $response PSR Response
703 public function doReminders(Request
$request, Response
$response): Response
705 $error_detected = [];
706 $warning_detected = [];
707 $success_detected = [];
709 $post = $request->getParsedBody();
710 $texts = new Texts($this->preferences
, $this->routeparser
);
712 if (isset($post['reminders'])) {
713 $selected = $post['reminders'];
715 $reminders = new Reminders($selected);
718 $labels_members = array();
719 if (isset($post['reminder_wo_mail'])) {
723 $list_reminders = $reminders->getList($this->zdb
, $labels);
724 if (count($list_reminders) == 0) {
725 $warning_detected[] = _T("No reminder to send for now.");
727 foreach ($list_reminders as $reminder) {
728 if ($labels === false) {
731 ->setLogin($this->login
)
732 ->setPreferences($this->preferences
)
733 ->setRouteParser($this->routeparser
)
735 //send reminders by email
736 $sent = $reminder->send($texts, $this->history
, $this->zdb
);
738 if ($sent === true) {
739 $success_detected[] = $reminder->getMessage();
741 $error_detected[] = $reminder->getMessage();
744 //generate labels for members without email address
745 $labels_members[] = $reminder->member_id
;
749 if ($labels === true) {
750 if (count($labels_members) > 0) {
751 $session_var = 'filters_reminders_labels';
752 $labels_filters = new MembersList();
753 $labels_filters->selected
= $labels_members;
754 $this->session
->$session_var = $labels_filters;
759 $this->routeparser
->urlFor('pdf-members-labels') . '?session_var=' . $session_var
762 $error_detected[] = _T("There are no member to proceed.");
766 if (count($error_detected) > 0) {
769 _T("Reminder has not been sent:")
773 if (count($success_detected) > 0) {
776 _T("Sent reminders:")
781 //flash messages if any
782 if (count($error_detected) > 0) {
783 foreach ($error_detected as $error) {
784 $this->flash
->addMessage('error_detected', $error);
787 if (count($warning_detected) > 0) {
788 foreach ($warning_detected as $warning) {
789 $this->flash
->addMessage('warning_detected', $warning);
792 if (count($success_detected) > 0) {
793 foreach ($success_detected as $success) {
794 $this->flash
->addMessage('success_detected', $success);
800 ->withHeader('Location', $this->routeparser
->urlFor('reminders'));
806 * @param Request $request PSR Request
807 * @param Response $response PSR Response
808 * @param string $membership Either 'late' or 'nearly'
809 * @param string $mail Either 'withmail' or 'withoutmail'
813 public function filterReminders(Request
$request, Response
$response, string $membership, string $mail): Response
815 //always reset filters
816 $filters = new MembersList();
817 $filters->filter_account
= Members
::ACTIVE_ACCOUNT
;
819 $membership = ($membership === 'nearly' ?
820 Members
::MEMBERSHIP_NEARLY
: Members
::MEMBERSHIP_LATE
);
821 $filters->membership_filter
= $membership;
823 //TODO: filter on reminder may take care of parent email as well
824 $mail = ($mail === 'withmail' ?
825 Members
::FILTER_W_EMAIL
: Members
::FILTER_WO_EMAIL
);
826 $filters->email_filter
= $mail;
828 $this->session
->filter_members
= $filters;
832 ->withHeader('Location', $this->routeparser
->urlFor('members'));
836 * Direct document page
838 * @param Request $request PSR Request
839 * @param Response $response PSR Response
840 * @param string $hash Hash
844 public function documentLink(Request
$request, Response
$response, string $hash): Response
849 'pages/directlink.html.twig',
852 'page_title' => _T('Download document')
861 * @param Request $request PSR Request
862 * @param Response $response PSR Response
866 public function favicon(Request
$request, Response
$response): Response