Mail translations 2nd attempt

* Remove *-custom.tpl from repo - should only be provided by the user
* Ignore custom translation files
* defaultPath is a fallback path - The name is misleading, as it's not the default.language setting
* Remove dead code
  * DisplayLocalized in SmartyPage was never called
  * DisplayLocalized in Page was only a copy, which is still called, but the languageCode parameter is not used.
* Fix save custom email template for selected language - fixes LibreBooking#424
* Fallback to default lang for missing custom templates ..but only when custom template is available for default lang.
* Add config description
* Change ReservationShareMail property name - It conflicts with the now protected email property
* Fix unit test for updating email template
* closes LibreBooking#416

.gitignore

@@ -25,6 +25,7 @@
 # Customization Files
 /Web/custom-favicon.png
 /Web/img/custom-logo.png
+lang/*/*-custom.tpl
 
 # Upload Directories
 /uploads/*

Pages/Admin/ManageEmailTemplatesPage.php

@@ -44,6 +44,8 @@ public function SetSaveResult($saveResult);
      * @return string
      */
     public function GetUpdatedTemplateName();
+
+    public function GetUpdatedLanguage(): string;
 }
 
 class ManageEmailTemplatesPage extends ActionPage implements IManageEmailTemplatesPage
@@ -75,6 +77,11 @@ public function ProcessPageLoad()
         $this->Display('Admin/Configuration/manage_email_templates.tpl');
     }
 
+    public function GetUpdatedLanguage(): string 
+    { 
+        return $this->GetForm(FormKeys::EMAIL_TEMPLATE_LANGUAGE);
+    }
+
     public function GetLanguage()
     {
         return $this->GetQuerystring(QueryStringKeys::LANGUAGE);

Pages/HelpPage.php

@@ -18,20 +18,5 @@ public function PageLoad()
         $this->Set('ServerTimezone', date_default_timezone_get());
 
         $this->DisplayLocalized('support-and-credits.tpl');
-
-        //		$helpType = $this->GetQuerystring('ht');
-//
-//		if ($helpType == 'about')
-//		{
-//
-//		}
-//		else if ($helpType == 'admin')
-//		{
-//			$this->DisplayLocalized('help-admin.tpl');
-//		}
-//		else
-//		{
-//			$this->DisplayLocalized('help.tpl');
-//		}
     }
 }

Pages/Page.php

@@ -395,13 +395,10 @@ protected function DisplayCsv($templateName, $fileName)
 
     /**
      * @param string $templateName
-     * @param null $languageCode uses current language is nothing is passed in
      */
-    protected function DisplayLocalized($templateName, $languageCode = null)
+    protected function DisplayLocalized($templateName)
     {
-        if (empty($languageCode)) {
-            $languageCode = $this->GetVar('CurrentLanguage');
-        }
+        $languageCode = $this->GetVar('CurrentLanguage');        
         $localizedPath = ROOT_DIR . 'lang/' . $languageCode;
         $defaultPath = ROOT_DIR . 'lang/en_us/';
 

Presenters/Admin/ManageEmailTemplatesPresenter.php

@@ -117,7 +117,7 @@ public function UpdateEmailTemplate()
         try {
             Log::Debug('Updating email template. Template=%s', $templateName);
 
-            $templatePath = Paths::EmailTemplates($this->GetSelectedLanguage());
+            $templatePath = Paths::EmailTemplates($this->page->GetUpdatedLanguage());
             $saveResult = $this->filesystem->Save($templatePath, str_replace('.tpl', '-custom.tpl', $templateName), $this->page->GetTemplateContents());
 
             $this->filesystem->FlushSmartyCache();

config/config.dist.php

@@ -18,6 +18,7 @@
 $conf['settings']['default.page.size'] = '50';                  // number of records per page
 $conf['settings']['enable.email'] = 'true';                     // global configuration to enable if any emails will be sent
 $conf['settings']['default.language'] = 'en_us';                // find your language in the lang directory
+$conf['settings']['enforce.custom.mail.template'] = 'false';    // Fallback to default.language for missing custom templates, bu only when custom template is available for default.language
 $conf['settings']['script.url'] = '';                           // public URL to the Web directory of this instance. this is the URL that appears when you are logging in. leave http: or https: off to auto-detect
 $conf['settings']['image.upload.directory'] = 'Web/uploads/images'; // full or relative path to where images will be stored
 $conf['settings']['image.upload.url'] = 'uploads/images';       // full or relative path to show uploaded images from
@@ -212,7 +213,7 @@
  * Error logging
  */
 $conf['settings']['logging']['folder'] = '/var/log/librebooking/log'; //Absolute path to folder were the log will be written, writing permissions to the folder are required
-$conf['settings']['logging']['level'] = 'none'; //Set to none disable logs, error to only log errors or debug to log all messages to the app.log file 
+$conf['settings']['logging']['level'] = 'none'; //Set to none disable logs, error to only log errors or debug to log all messages to the app.log file
 $conf['settings']['logging']['sql'] = 'false'; //Set to true no enable the creation of and sql.log file
 
 // IN THE REDIRECT URI'S (OF THE AUTHENTICATION YOU ARE USING) YOU NEED TO ADD THE PATH FROM THE WEBSITE DOMAIN TO THE

lib/Common/SmartyPage.php

@@ -76,46 +76,41 @@ public function AddTemplateDirectory($templateDirectory)
     }
 
     /**
+     * Fetches template in a specific language. A custom template file might override the default template.
+     * In case the template is not available in the target language it will fall back to en_us.
      * @param string $templateName
-     * @param null $languageCode uses current language is nothing is passed in
-     */
-    public function DisplayLocalized($templateName, $languageCode = null)
-    {
-        if (empty($languageCode)) {
-            $languageCode = $this->getTemplateVars('CurrentLanguage');
-        }
-        $localizedPath = ROOT_DIR . 'lang/' . $languageCode;
-        $defaultPath = ROOT_DIR . 'lang/en_us/' . $templateName;
-
-        if (file_exists($localizedPath . '/' . $templateName)) {
-            $this->AddTemplateDirectory($localizedPath);
-        } else {
-            $this->AddTemplateDirectory($defaultPath);
-        }
-
-        $this->Display($templateName);
-    }
-
-    /**
-     * @param string $templateName
-     * @param null $languageCode uses current language is nothing is passed in
+     * @param string $languageCode Will be set to template var CurrentLanguage if null
+     * @param bool $enforceCustomTemplate if true uses custom language from default language
+     * if custom template of the target language is not available.
      * @return string
      */
-    public function FetchLocalized($templateName, $languageCode = null)
+    public function FetchLocalized($templateName, bool $enforceCustomTemplate, string $languageCode = null)
     {
-        if (empty($languageCode)) {
+        if ($languageCode == null) {
             $languageCode = $this->getTemplateVars('CurrentLanguage');
         }
-        $localizedPath = ROOT_DIR . 'lang/' . $languageCode;
-        $defaultPath = ROOT_DIR . 'lang/en_us/';
+        $langPath = ROOT_DIR . 'lang/';
+        $localizedPath = $langPath . $languageCode;
         $customTemplateName = str_replace('.tpl', '-custom.tpl', $templateName);
+        $hasCustomTemplate = file_exists($localizedPath . '/' . $customTemplateName);
+
+        if ($enforceCustomTemplate && !$hasCustomTemplate) {
+            $defaultLanguageCode = Configuration::Instance()->GetKey(ConfigKeys::LANGUAGE);
+            $defaultLocalizedPath = $langPath . $defaultLanguageCode;
+            $hasCustomDefaultTemplate = file_exists($defaultLocalizedPath . '/' . $customTemplateName);
+            if ($languageCode != $defaultLanguageCode && $hasCustomDefaultTemplate) {
+                $hasCustomTemplate = true;
+                $localizedPath = $defaultLocalizedPath;
+            }
+        }
 
-        if (file_exists($localizedPath . '/' . $templateName) || file_exists($localizedPath . '/' . $customTemplateName)) {
+        if (file_exists($localizedPath . '/' . $templateName) || $hasCustomTemplate) {
             $path = $localizedPath;
             $this->AddTemplateDirectory($localizedPath);
         } else {
-            $path = $defaultPath;
-            $this->AddTemplateDirectory($defaultPath);
+            // Fallback path
+            $path = ROOT_DIR . 'lang/en_us/';
+            $this->AddTemplateDirectory($path);
         }
 
         if (file_exists($path . '/' . $customTemplateName)) {

lib/Config/ConfigKeys.php

@@ -18,6 +18,7 @@ class ConfigKeys
     public const HOME_URL = 'home.url';
     public const INACTIVITY_TIMEOUT = 'inactivity.timeout';
     public const LANGUAGE = 'default.language';
+    public const ENFORCE_CUSTOM_MAIL_TEMPLATE = 'enforce.custom.mail.template';
     public const LOGOUT_URL = 'logout.url';
     public const NAME_FORMAT = 'name.format';
     public const SCRIPT_URL = 'script.url';

lib/Email/EmailMessage.php

@@ -5,7 +5,7 @@ abstract class EmailMessage implements IEmailMessage
     /**
      * @var SmartyPage
      */
-    private $email;
+    protected $to;
     /**
      * @var string|null
      */
@@ -15,9 +15,12 @@ abstract class EmailMessage implements IEmailMessage
      */
     private $attachmentFileName;
 
+    protected bool $enforceCustomTemplate;
+
     protected function __construct($languageCode = null)
     {
-        $this->email = new SmartyPage($resources);
+        $this->enforceCustomTemplate = Configuration::Instance()->GetKey(ConfigKeys::ENFORCE_CUSTOM_MAIL_TEMPLATE, new BooleanConverter());
+        $this->to = new SmartyPage($resources);
         $resources = Resources::GetInstance();
         if (!empty($languageCode)) {
             $resources->SetLanguage($languageCode);
@@ -31,14 +34,14 @@ protected function __construct($languageCode = null)
 
     protected function Set($var, $value)
     {
-        $this->email->assign($var, $value);
+        $this->to->assign($var, $value);
     }
 
     protected function FetchTemplate($templateName, $includeHeaders = true)
     {
-        $header = $includeHeaders ? $this->email->fetch('Email/emailheader.tpl') : '';
-        $body = $this->email->FetchLocalized($templateName);
-        $footer = $includeHeaders ? $this->email->fetch('Email/emailfooter.tpl') : '';
+        $header = $includeHeaders ? $this->to->fetch('Email/emailheader.tpl') : '';
+        $body = $this->to->FetchLocalized($templateName, $this->enforceCustomTemplate);
+        $footer = $includeHeaders ? $this->to->fetch('Email/emailfooter.tpl') : '';
 
         return $header . $body . $footer;
     }
@@ -48,7 +51,7 @@ protected function Translate($key, $args = [])
         if (!is_array($args)) {
             $args = [$args];
         }
-        return $this->email->SmartyTranslate(['key' => $key, 'args' => implode(',', $args)], $this->email);
+        return $this->to->SmartyTranslate(['key' => $key, 'args' => implode(',', $args)], $this->to);
     }
 
     public function ReplyTo()
@@ -73,7 +76,7 @@ public function BCC()
 
     public function Charset()
     {
-        return $this->email->getTemplateVars('Charset');
+        return $this->to->getTemplateVars('Charset');
     }
 
     public function AddStringAttachment($contents, $fileName)

lib/Email/Messages/ReportEmailMessage.php

@@ -32,7 +32,7 @@ public function __construct($report, $definition, $toAddress, $reportUser, $sele
         $this->Set('Definition', $definition);
         $this->Set('Report', $report);
         $this->Set('ReportCsvColumnView', new ReportCsvColumnView($selectedColumns));
-        $contents = $this->FetchTemplate('Reports/custom-csv.tpl', false);
+        $contents = $this->to->FetchLocalized('Reports/custom-csv.tpl', false);
 
         $name = $report->ReportName();
         if (!empty($name)) {

lib/Email/Messages/ReservationSeriesEndingEmail.php

@@ -7,7 +7,7 @@ class ReservationSeriesEndingEmail extends EmailMessage
     /**
      * @var string
      */
-    private $email;
+    private $to;
 
     /**
      * @var ExistingReservationSeries
@@ -24,19 +24,19 @@ class ReservationSeriesEndingEmail extends EmailMessage
      */
     private $currentInstance;
 
-    public function __construct(ExistingReservationSeries $reservationSeries, $language, $timezone, $email)
+    public function __construct(ExistingReservationSeries $reservationSeries, $language, $timezone, $to)
     {
         parent::__construct($language);
 
         $this->reservationSeries = $reservationSeries;
         $this->timezone = $timezone;
-        $this->email = $email;
+        $this->to = $to;
         $this->currentInstance = $this->reservationSeries->CurrentInstance();
     }
 
     public function To()
     {
-        return [new EmailAddress($this->email)];
+        return [new EmailAddress($this->to)];
     }
 
     public function Subject()

lib/Email/Messages/ReservationShareEmail.php

@@ -7,7 +7,7 @@ class ReservationShareEmail extends ReservationEmailMessage
     /**
      * @var string
      */
-    private $email;
+    private $emailToShare;
 
     public function __construct(User $reservationOwner, $emailToShare, ReservationSeries $reservationSeries, IAttributeRepository $attributeRepository, IUserRepository $userRepository)
     {
@@ -16,12 +16,12 @@ public function __construct(User $reservationOwner, $emailToShare, ReservationSe
         $this->reservationOwner = $reservationOwner;
         $this->reservationSeries = $reservationSeries;
         $this->timezone = $reservationOwner->Timezone();
-        $this->email = $emailToShare;
+        $this->emailToShare = $emailToShare;
     }
 
     public function To()
     {
-        return [new EmailAddress($this->email)];
+        return [new EmailAddress($this->emailToShare)];
     }
 
     public function Subject()