3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
10 * Copyright © 2020-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 2020-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.eu
37 namespace Galette\Features
;
40 use Galette\Core\Login
;
41 use Galette\Core\Logo
;
42 use Galette\Core\Preferences
;
43 use Galette\DynamicFields\Choice
;
44 use Galette\DynamicFields\Separator
;
45 use Galette\Entity\Adherent
;
46 use Galette\Entity\Contribution
;
47 use Galette\Entity\PdfModel
;
48 use Galette\Entity\Reminder
;
49 use Galette\Entity\Texts
;
50 use Galette\Repository\DynamicFieldsSet
;
51 use Galette\DynamicFields\DynamicField
;
54 use Slim\Routing\RouteParser
;
57 * Replacements feature
62 * @author Johan Cwiklinski <johan@x-tnd.be>
63 * @copyright 2020-2023 The Galette Team
64 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
65 * @link http://galette.eu
71 private $patterns = [];
72 private $replaces = [];
73 private $dynamic_patterns = [];
90 #[Inject("preferences")]
91 protected $preferences;
96 protected $routeparser;
99 * Get dynamic patterns
101 * @param string $form_name Dynamic form name
102 * @param boolean $legacy Whether to load legacy patterns
106 public function getDynamicPatterns(string $form_name, bool $legacy = true): array
108 $fields = new DynamicFieldsSet($this->zdb
, $this->login
);
109 $dynamic_fields = $fields->getList($form_name);
111 $dynamic_patterns = [];
112 foreach ($dynamic_fields as $dynamic_field) {
113 //no pattern for separators
114 if ($dynamic_field instanceof Separator
) {
117 $key = strtoupper('DYNFIELD_' . $dynamic_field->getId() . '_' . $form_name);
122 if (!($this instanceof Texts
) && ($legacy === true ||
$dynamic_field instanceof Choice
)) {
123 $capabilities[] = 'INPUT';
125 foreach ($capabilities as $capability) {
126 $skey = sprintf('%s_%s', $capability, $key);
127 switch ($capability) {
129 $title = _T('Label for dynamic field "%s"');
132 $title = _T('Form entry for dynamic field "%s"');
138 $title = _T('Value for dynamic field "%s"');
141 $dynamic_patterns[strtolower($skey)] = [
144 $dynamic_field->getName()
146 'pattern' => sprintf('/{%s}/', $skey)
151 $this->dynamic_patterns
[$form_name] = $dynamic_patterns;
152 return $this->dynamic_patterns
[$form_name];
158 * @param array $patterns Patterns to add
162 protected function setPatterns(array $patterns): self
165 foreach ($patterns as $key => $info) {
166 if (is_array($info)) {
167 $toset[$key] = $info['pattern'];
169 $toset[$key] = $info;
173 $this->patterns
= array_merge(
184 * @param array $replaces Replacements to add
188 public function setReplacements(array $replaces): void
190 $this->replaces
= array_merge(
201 protected function getMainPatterns(): array
205 'title' => _T('Your organisation name'),
206 'pattern' => '/{ASSO_NAME}/'
209 'title' => _T('Your organisation slogan'),
210 'pattern' => '/{ASSO_SLOGAN}/'
213 'title' => _T('Your organisation address'),
214 'pattern' => '/{ASSO_ADDRESS}/',
216 'asso_address_multi' => [
217 'title' => sprintf('%s (%s)', _T('Your organisation address'), _T('with break lines')),
218 'pattern' => '/{ASSO_ADDRESS_MULTI}/',
221 'title' => _T('Your organisation website'),
222 'pattern' => '/{ASSO_WEBSITE}/',
225 'title' => _T('Your organisation logo'),
226 'pattern' => '/{ASSO_LOGO}/',
229 //TRANS: see https://www.php.net/manual/datetime.format.php
230 'title' => _T('Current date (Y-m-d)'),
231 'pattern' => '/{DATE_NOW}/'
234 'title' => _T("Galette's login URI"),
235 'pattern' => '/{LOGIN_URI}/'
241 * Get patterns for a member
243 * @param boolean $legacy Whether to load legacy patterns
247 protected function getMemberPatterns(bool $legacy = true): array
249 $dynamic_patterns = $this->getDynamicPatterns('adh', $legacy);
252 'title' => _('Title'),
253 'pattern' => '/{TITLE_ADH}/',
256 'title' => _T("Member's ID"),
257 'pattern' => '/{ID_ADH}/',
260 'title' => _T("Member number"),
261 'pattern' => '/{NUM_ADH}/',
264 'title' => _T("Name"),
265 'pattern' => '/{NAME_ADH}/',
268 'title' => _T('Last name'),
269 'pattern' => '/{LAST_NAME_ADH}/',
271 'adh_first_name' => [
272 'title' => _T('First name'),
273 'pattern' => '/{FIRST_NAME_ADH}/',
276 'title' => _T('Nickname'),
277 'pattern' => '/{NICKNAME_ADH}/',
280 'title' => _T('Gender'),
281 'pattern' => '/{GENDER_ADH}/',
283 'adh_birth_date' => [
284 'title' => _T('Birth date'),
285 'pattern' => '/{ADH_BIRTH_DATE}/',
287 'adh_birth_place' => [
288 'title' => _T('Birth place'),
289 'pattern' => '/{ADH_BIRTH_PLACE}/',
291 'adh_profession' => [
292 'title' => _T('Profession'),
293 'pattern' => '/{PROFESSION_ADH}/',
296 'title' => _T("Company name"),
297 'pattern' => '/{COMPANY_ADH}/',
300 'title' => _T("Address"),
301 'pattern' => '/{ADDRESS_ADH}/',
303 'adh_address_multi' => [
304 'title' => sprintf('%s (%s)', _T('Address'), _T('with break lines')),
305 'pattern' => '/{ADDRESS_ADH_MULTI}/',
308 'title' => _T("Zipcode"),
309 'pattern' => '/{ZIP_ADH}/',
312 'title' => _T("Town"),
313 'pattern' => '/{TOWN_ADH}/',
316 'title' => _T('Country'),
317 'pattern' => '/{COUNTRY_ADH}/',
320 'title' => _T('Phone'),
321 'pattern' => '/{PHONE_ADH}/',
324 'title' => _T('GSM'),
325 'pattern' => '/{MOBILE_ADH}/',
328 'title' => _T('Email'),
329 'pattern' => '/{EMAIL_ADH}/',
332 'title' => _T('Login'),
333 'pattern' => '/{LOGIN_ADH}/',
335 'adh_main_group' => [
336 'title' => _T("Member's main group"),
337 'pattern' => '/{GROUP_ADH}/',
340 'title' => _T("Member's groups (as list)"),
341 'pattern' => '/{GROUPS_ADH}/'
344 'title' => _T('Member state of dues'),
345 'pattern' => '/{ADH_DUES}/'
347 'days_remaining' => [
348 'title' => _T('Membership remaining days'),
349 'pattern' => '/{DAYS_REMAINING}/',
352 'title' => _T('Membership expired since'),
353 'pattern' => '/{DAYS_EXPIRED}/',
357 if ($legacy === true) {
360 'title' => _T("Company name"),
361 'pattern' => '/{COMPANY_NAME_ADH}/',
363 '_adh_last_name' => [
364 'title' => _T('Last name'),
365 'pattern' => '/{LASTNAME_ADH}/',
367 '_adh_first_name' => [
368 'title' => _T('First name'),
369 'pattern' => '/{FIRSTNAME_ADH}/',
372 'title' => _T('Login'),
373 'pattern' => '/{LOGIN}/',
376 'title' => _T('Email'),
377 'pattern' => '/{MAIL_ADH}/',
382 return $m_patterns +
$dynamic_patterns;
386 * Get patterns for a contribution
388 * @param boolean $legacy Whether to load legacy patterns
392 protected function getContributionPatterns($legacy = true): array
394 $dynamic_patterns = $this->getDynamicPatterns('contrib', $legacy);
398 'title' => _T('Contribution label'),
399 'pattern' => '/{CONTRIB_LABEL}/',
401 'contrib_amount' => [
402 'title' => _T('Amount'),
403 'pattern' => '/{CONTRIB_AMOUNT}/',
405 'contrib_amount_letters' => [
406 'title' => _T('Amount (in letters)'),
407 'pattern' => '/{CONTRIB_AMOUNT_LETTERS}/',
410 'title' => _T('Full date'),
411 'pattern' => '/{CONTRIB_DATE}/',
414 'title' => _T('Contribution year'),
415 'pattern' => '/{CONTRIB_YEAR}/',
417 'contrib_comment' => [
418 'title' => _T('Comment'),
419 'pattern' => '/{CONTRIB_COMMENT}/',
422 'title' => _T('Begin date'),
423 'pattern' => '/{CONTRIB_BEGIN_DATE}/',
426 'title' => _T('End date'),
427 'pattern' => '/{CONTRIB_END_DATE}/',
430 'title' => _T('Contribution id'),
431 'pattern' => '/{CONTRIB_ID}/',
433 'contrib_payment' => [
434 'title' => _T('Payment type'),
435 'pattern' => '/{CONTRIB_PAYMENT_TYPE}/'
438 'title' => _T('Contribution information'),
439 'pattern' => '/{CONTRIB_INFO}/'
443 if ($legacy === true) {
444 foreach ($c_patterns as $key => $pattern) {
446 $pattern['pattern'] = str_replace(
451 $c_patterns[$nkey] = $pattern;
454 $c_patterns['__contrib_label'] = [
455 'title' => $c_patterns['contrib_label']['title'],
456 'pattern' => '/{CONTRIB_TYPE}/'
460 //handle DEADLINE alias
461 $c_patterns['deadline'] = [
462 'title' => $c_patterns['contrib_edate']['title'],
463 'pattern' => '/{DEADLINE}/'
466 return $c_patterns +
$dynamic_patterns;
470 * Set main replacements
474 public function setMain(): self
476 $address = $this->preferences
->getPostalAddress();
477 $address_multi = preg_replace("/\n/", "<br>", $address);
480 if ($this->preferences
->pref_website
!== '') {
481 $website = '<a href="' . $this->preferences
->pref_website
. '">' .
482 $this->preferences
->pref_website
. '</a>';
488 '<img src="%1$s" width="%2$s" height="%3$s" />',
489 '@' . base64_encode(file_get_contents($logo->getPath())),
490 $logo->getOptimalWidth(),
491 $logo->getOptimalHeight()
494 $this->setReplacements(
496 'asso_name' => $this->preferences
->pref_nom
,
497 'asso_slogan' => $this->preferences
->pref_slogan
,
498 'asso_address' => $address,
499 'asso_address_multi' => $address_multi,
500 'asso_website' => $website,
501 'asso_logo' => $logo_elt,
502 //TRANS: see https://www.php.net/manual/datetime.format.php
503 'date_now' => date(_T('Y-m-d')),
504 'login_uri' => $this->preferences
->getURL() . $this->routeparser
->urlFor('login'),
512 * Set contribution and proceed related replacements
516 public function setNoContribution(): self
521 'contrib_label' => null,
522 'contrib_amount' => null,
523 'contrib_amount_letters' => null,
524 'contrib_date' => null,
525 'contrib_year' => null,
526 'contrib_comment' => null,
527 'contrib_bdate' => null,
528 'contrib_edate' => null,
529 'contrib_id' => null,
530 'contrib_payment' => null,
531 'contrib_info' => null
534 foreach ($c_replacements as $key => $replacement) {
536 $c_replacements[$nkey] = $replacement;
538 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
540 //handle DEADLINE alias
541 $c_replacements['deadline'] = null;
543 $this->setReplacements($c_replacements);
545 /** the list of all dynamic fields */
546 $fields = new DynamicFieldsSet($this->zdb
, $login);
547 $dynamic_fields = $fields->getList('contrib');
548 $this->setDynamicFields('contrib', $dynamic_fields, null);
554 * Set contribution and proceed related replacements
556 * @param Contribution $contrib Contribution
560 public function setContribution(Contribution
$contrib): self
562 global $login, $i18n;
564 $formatter = new NumberFormatter($i18n->getID(), NumberFormatter
::SPELLOUT
);
567 'contrib_label' => $contrib->type
->libelle
,
568 'contrib_amount' => $contrib->amount
,
569 'contrib_amount_letters' => $formatter->format($contrib->amount
),
570 'contrib_date' => $contrib->date
,
571 'contrib_year' => $contrib->raw_date
->format('Y'),
572 'contrib_comment' => $contrib->info
,
573 'contrib_bdate' => $contrib->begin_date
,
574 'contrib_edate' => $contrib->end_date
,
575 'contrib_id' => $contrib->id
,
576 'contrib_payment' => $contrib->spayment_type
,
577 'contrib_info' => $contrib->info
580 foreach ($c_replacements as $key => $replacement) {
582 $c_replacements[$nkey] = $replacement;
584 $c_replacements['__contrib_label'] = $c_replacements['contrib_label'];
586 //handle DEADLINE alias
587 $c_replacements['deadline'] = $c_replacements['contrib_edate'];
589 $this->setReplacements($c_replacements);
591 /** the list of all dynamic fields */
592 $fields = new DynamicFieldsSet($this->zdb
, $login);
593 $dynamic_fields = $fields->getList('contrib');
594 $this->setDynamicFields('contrib', $dynamic_fields, $contrib);
600 * Set member and proceed related replacements
602 * @param Adherent $member Member
606 public function setMember(Adherent
$member): self
610 $address = $member->getAddress();
611 $address_multi = preg_replace("/\n/", "<br>", $address);
613 if ($member->isMan()) {
615 } elseif ($member->isWoman()) {
616 $gender = _T("Woman");
618 $gender = _T("Unspecified");
621 $member_groups = $member->groups
;
622 $main_group = _T("None");
623 $group_list = _T("None");
624 if (is_array($member_groups) && count($member_groups) > 0) {
625 $main_group = $member_groups[0]->getName();
626 $group_list = '<ul>';
627 foreach ($member_groups as $group) {
628 $group_list .= '<li>' . $group->getName() . '</li>';
630 $group_list .= '</ul>';
633 $this->setReplacements(
635 'adh_title' => $member->stitle
,
636 'adh_id' => $member->id
,
637 'adh_num' => $member->number
,
638 'adh_name' => $member->sfullname
,
639 'adh_last_name' => $member->name
,
640 'adh_first_name' => $member->surname
,
641 'adh_nickname' => $member->nickname
,
642 'adh_gender' => $gender,
643 'adh_birth_date' => $member->birthdate
,
644 'adh_birth_place' => $member->birth_place
,
645 'adh_profession' => $member->job
,
646 'adh_company' => $member->company_name
,
647 'adh_address' => $address,
648 'adh_address_multi' => $address_multi,
649 'adh_zip' => $member->getZipcode(),
650 'adh_town' => $member->getTown(),
651 'adh_country' => $member->getCountry(),
652 'adh_phone' => $member->phone
,
653 'adh_mobile' => $member->gsm
,
654 //always take current member email, to be sure.
655 'adh_email' => $member->email
,
656 'adh_login' => $member->login
,
657 'adh_main_group' => $main_group,
658 'adh_groups' => $group_list,
659 'adh_dues' => $member->getDues(),
660 'days_remaining' => $member->days_remaining
,
661 'days_expired' => (int)$member->days_remaining +
1,
662 //Handle COMPANY_NAME_ADH... https://bugs.galette.eu/issues/1530
663 '_adh_company' => $member->company_name
,
664 //Handle old names for variables ... https://bugs.galette.eu/issues/1393
665 '_adh_last_name' => $member->name
,
666 '_adh_first_name' => $member->surname
,
667 '_adh_login' => $member->login
,
668 '_adh_email' => $member->email
672 /** the list of all dynamic fields */
673 $fields = new DynamicFieldsSet($this->zdb
, $login);
674 $dynamic_fields = $fields->getList('adh');
675 $this->setDynamicFields('adh', $dynamic_fields, $member);
681 * Set dynamic fields and proceed related replacements
683 * @param string $form_name Form name
684 * @param array $dynamic_fields Dynamic fields
685 * @param mixed $object Related object (Adherent, Contribution, ...)
689 public function setDynamicFields(string $form_name, array $dynamic_fields, $object): self
691 $uform_name = strtoupper($form_name);
693 $dynamic_patterns = $this->getDynamicPatterns($form_name);
694 foreach ($dynamic_patterns as $dynamic_pattern) {
695 $pattern = trim($dynamic_pattern['pattern'], '/');
696 $key = strtolower(rtrim(ltrim($pattern, '{'), '}'));
699 if (preg_match("/^{LABEL_DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
700 /** dynamic field label */
701 $field_id = $match[1];
702 $value = $dynamic_fields[$field_id]->getName();
704 if (preg_match("/^{(INPUT_|VALUE_)?DYNFIELD_([0-9]+)_$uform_name}$/", $pattern, $match)) {
705 /** dynamic field value */
706 $capacity = trim($match[1], '_');
707 $field_id = $match[2];
708 $field_name = $dynamic_fields[$field_id]->getName();
709 $field_type = $dynamic_fields[$field_id]->getType();
711 if ($object !== null) {
712 $all_values = $object->getDynamicFields()->getValues($field_id);
713 foreach ($all_values as $field_value) {
714 $field_values[$field_value['field_val']] = $field_value['text_val'] ??
$field_value['field_val'];
720 switch ($field_type) {
721 case DynamicField
::CHOICE
:
722 $choice_values = $dynamic_fields[$field_id]->getValues();
723 if ($capacity == 'INPUT') {
724 foreach ($choice_values as $choice_idx => $choice_value) {
725 $value .= '<input type="radio" class="box" name="' . $field_name . '" value="' . $field_id . '"';
726 if (isset($field_values[$choice_idx])) {
727 $value .= ' checked="checked"';
729 $value .= ' disabled="disabled">' . $choice_value . ' ';
732 foreach ($field_values as $field_value) {
733 $value .= $field_value;
737 case DynamicField
::BOOLEAN
:
738 foreach ($field_values as $field_value) {
739 $value .= ($field_value ?
_T("Yes") : _T("No"));
742 case DynamicField
::FILE
:
744 foreach ($field_values as $field_value) {
745 if (empty($field_value)) {
748 $spattern = (($this instanceof Texts
) ?
750 '<a href="%1$s%2$s">%3$s</a>'
754 $this->preferences
->getURL(),
755 $this->routeparser
->urlFor(
758 'form_name' => $form_name,
762 'name' => $field_value
769 case DynamicField
::TEXT
:
770 case DynamicField
::LINE
:
771 case DynamicField
::DATE
:
772 $value .= implode('<br/>', $field_values);
777 $this->setReplacements(array($key => $value));
778 Analog
::log("adding dynamic replacement $key => $value", Analog
::DEBUG
);
789 public function getLegend(): array
794 'title' => _T('Main information'),
795 'patterns' => $this->getMainPatterns()
798 $legend['member'] = [
799 'title' => _T('Member information'),
800 'patterns' => $this->getMemberPatterns(false)
807 * Get configured replacements
811 public function getReplacements(): array
813 return $this->replaces
;
819 * @param Db $db Db instance
823 public function setDb(Db
$db): self
830 * Set Login dependency
832 * @param Login $login Login instance
836 public function setLogin(Login
$login): self
838 $this->login
= $login;
843 * Set Preferences dependency
845 * @param Preferences $preferences Preferences instance
849 public function setPreferences(Preferences
$preferences): self
851 $this->preferences
= $preferences;
856 * Set RouteParser dependency
858 * @param RouteParser $routeparser RouteParser instance
862 public function setRouteparser(RouteParser
$routeparser): self
864 $this->routeparser
= $routeparser;
869 * Proceed replacement on given entry
871 * @param string $source Source string
875 protected function proceedReplacements(string $source): string
877 //handle translations
878 $callback = static function ($matches) {
879 return _T($matches[1]);
881 $replaced = preg_replace_callback(
882 '/_T\("([^\"]+)"\)/',
888 ksort($this->patterns
, SORT_NATURAL
);
889 ksort($this->replaces
, SORT_NATURAL
);
891 if (array_keys($this->patterns
) !== array_keys($this->replaces
)) {
892 throw new \
RuntimeException('Patterns and replacements does not match!');
895 //handle replacements
896 $replaced = preg_replace(
902 //handle translations with replacements
903 $repl_callback = static function ($matches) {
910 $replaced = preg_replace_callback(
911 '/str_replace\(\'([^,]+)\', ?\'([^,]+)\', ?\'(.*)\'\)/',
924 public function getPatterns(): array
926 return $this->patterns
;