EmailTemplateDAO.inc.php

<?php
 
import('lib.pkp.classes.mail.EmailTemplate');
import('lib.pkp.classes.db.SchemaDAO');
import('classes.core.Services');
 
class EmailTemplateDAO extends SchemaDAO {
   var $schemaName = SCHEMA_EMAIL_TEMPLATE;
 
   var $tableName = 'email_templates';
 
   var $settingsTableName = 'email_templates_settings';
 
   var $primaryKeyColumn = 'email_id';
 
   var $primaryTableColumns = [
      'id' => 'email_id',
      'key' => 'email_key',
      'contextId' => 'context_id',
      'enabled' => 'enabled',
      'canDisable' => 'can_disable',
      'canEdit' => 'can_edit',
      'fromRoleId' => 'from_role_id',
      'toRoleId' => 'to_role_id',
      'stageId' => 'stage_id',
   ];
 
   public function newDataObject() {
      return new EmailTemplate();
   }
 
   public function insertObject($object) {
      // The object contains custom template information as well as the default data.
      // Strip default data from the object before calling insertObject so that it
      // doesn't try to write this data to the email templates settings table.
      $partialObject = clone $object;
      unset($partialObject->_data['canDisable']);
      unset($partialObject->_data['canEdit']);
      unset($partialObject->_data['description']);
      unset($partialObject->_data['fromRoleId']);
      unset($partialObject->_data['toRoleId']);
      unset($partialObject->_data['stageId']);
 
      parent::insertObject($partialObject);
   }
 
   public function updateObject($object) {
      // The object contains custom template information as well as the default data.
      // Strip default data from the object before calling updateObject so that it
      // doesn't try to write this data to the email templates settings table.
      $partialObject = clone $object;
      unset($partialObject->_data['canDisable']);
      unset($partialObject->_data['canEdit']);
      unset($partialObject->_data['description']);
      unset($partialObject->_data['fromRoleId']);
      unset($partialObject->_data['toRoleId']);
      unset($partialObject->_data['stageId']);
 
      parent::updateObject($partialObject);
   }
 
   public function _fromRow($primaryRow) {
      $emailTemplate = parent::_fromRow($primaryRow);
      $schema = Services::get('schema')->get($this->schemaName);
 
      $result = $this->retrieve(
         "SELECT * FROM email_templates_default_data WHERE email_key = ?",
         [$emailTemplate->getData('key')]
      );
      $props = ['subject', 'body', 'description'];
      while (!$result->EOF) {
         $settingRow = $result->getRowAssoc(false);
         foreach ($props as $prop) {
            // Don't allow default data to override custom template data
            if ($emailTemplate->getData($prop, $settingRow['locale'])) {
               continue;
            }
            $emailTemplate->setData(
               $prop,
               $this->convertFromDB(
                  $settingRow[$prop],
                  $schema->properties->{$prop}->type
               ),
               $settingRow['locale']
            );
         }
         $result->MoveNext();
      }
      $result->Close();
 
      return $emailTemplate;
   }
 
   function deleteEmailTemplatesByLocale($locale) {
      $this->update(
         'DELETE FROM email_templates_settings WHERE locale = ?', $locale
      );
   }
 
   function deleteDefaultEmailTemplatesByLocale($locale) {
      $this->update(
         'DELETE FROM email_templates_default_data WHERE locale = ?', $locale
      );
   }
 
   function defaultTemplateIsInstalled($key) {
      $result = $this->retrieve(
         'SELECT COUNT(*)
            FROM email_templates_default
            WHERE email_key = ?',
         $key
      );
      $returner = isset($result->fields[0]) && $result->fields[0] != 0;
      $result->Close();
      return $returner;
   }
 
   function getMainEmailTemplatesFilename() {
      return 'registry/emailTemplates.xml';
   }
 
   function installEmailTemplates($templatesFile, $locales = array(), $returnSql = false, $emailKey = null, $skipExisting = false) {
      $xmlDao = new XMLDAO();
      $sql = array();
      $data = $xmlDao->parseStruct($templatesFile, array('email'));
      if (!isset($data['email'])) return false;
      foreach ($data['email'] as $entry) {
         $attrs = $entry['attributes'];
         if ($emailKey && $emailKey != $attrs['key']) continue;
         if ($skipExisting && $this->defaultTemplateIsInstalled($attrs['key'])) continue;
         $dataSource = $this->getDataSource();
         $sql[] = 'DELETE FROM email_templates_default WHERE email_key = ' . $dataSource->qstr($attrs['key']);
         if (!$returnSql) {
            $this->update(array_shift($sql));
         }
         $sql[] = 'INSERT INTO email_templates_default
            (email_key, can_disable, can_edit, from_role_id, to_role_id, stage_id)
            VALUES
            (' .
            $dataSource->qstr($attrs['key']) . ', ' .
            ($attrs['can_disable']?1:0) . ', ' .
            ($attrs['can_edit']?1:0) . ', ' .
            (isset($attrs['from_role_id'])?((int) $attrs['from_role_id']):'null') . ', ' .
            (isset($attrs['to_role_id'])?((int) $attrs['to_role_id']):'null') . ', ' .
            (isset($attrs['stage_id'])?((int) $attrs['stage_id']):'null') .
            ")";
         if (!$returnSql) {
            $this->update(array_shift($sql));
         }
 
         // Add localized data
         $additionalQueries = $this->installEmailTemplateLocaleData($templatesFile, $locales, $returnSql, $attrs['key']);
         if ($returnSql) $sql = array_merge($sql, $additionalQueries);
      }
      if ($returnSql) return $sql;
      return true;
   }
 
   function installEmailTemplateLocaleData($templatesFile, $locales = array(), $returnSql = false, $emailKey = null) {
      $xmlDao = new XMLDAO();
      $sql = array();
      $data = $xmlDao->parseStruct($templatesFile, array('email'));
      if (!isset($data['email'])) return false;
      $dataSource = $this->getDataSource();
      foreach ($data['email'] as $entry) {
         $attrs = $entry['attributes'];
         if ($emailKey && $emailKey != $attrs['key']) continue;
 
         $subject = $attrs['subject']??null;
         $body = $attrs['body']??null;
         $description = $attrs['description']??null;
         if ($subject && $body) foreach ($locales as $locale) {
            $sql[] = 'DELETE FROM email_templates_default_data WHERE email_key = ' . $dataSource->qstr($attrs['key']) . ' AND locale = ' . $dataSource->qstr($locale);
            if (!$returnSql) {
               $this->update(array_shift($sql));
            }
 
            $keyNotFoundHandler = function($key) {
               return null;
            };
            $translatedSubject = __($subject, [], $locale, $keyNotFoundHandler);
            $translatedBody = __($body, [], $locale, $keyNotFoundHandler);
            if ($translatedSubject !== null && $translatedBody !==  null) {
               $sql[] = 'INSERT INTO email_templates_default_data
                  (email_key, locale, subject, body, description)
                  VALUES
                  (' .
                  $dataSource->qstr($attrs['key']) . ', ' .
                  $dataSource->qstr($locale) . ', ' .
                  $dataSource->qstr($translatedSubject) . ', ' .
                  $dataSource->qstr($translatedBody) . ', ' .
                  $dataSource->qstr(__($description, [], $locale)) .
                  ")";
               if (!$returnSql) {
                  $this->update(array_shift($sql));
               }
            }
         }
      }
      if ($returnSql) return $sql;
      return true;
   }
 
   function installEmailTemplateData($templateDataFile, $locale, $returnSql = false, $emailKey = null) {
      $xmlDao = new XMLDAO();
      $sql = array();
      $data = $xmlDao->parse($templateDataFile, array('email_texts', 'email_text', 'subject', 'body', 'description'));
      if (!$data) return false;
 
      foreach ($data->getChildren() as $emailNode) {
         $subject = $emailNode->getChildValue('subject');
         $body = $emailNode->getChildValue('body');
         $description = $emailNode->getChildValue('description');
 
         // Translate variable contents
         foreach (array(&$subject, &$body, &$description) as &$var) {
            $var = preg_replace_callback('{{translate key="([^"]+)"}}', function($matches) {
               return __($matches[1], array(), $locale);
            }, $var);
         }
 
         if ($emailKey && $emailKey != $emailNode->getAttribute('key')) continue;
         $dataSource = $this->getDataSource();
         $sql[] = 'DELETE FROM email_templates_default_data WHERE email_key = ' . $dataSource->qstr($emailNode->getAttribute('key')) . ' AND locale = ' . $dataSource->qstr($locale);
         if (!$returnSql) {
            $this->update(array_shift($sql));
         }
 
         $sql[] = 'INSERT INTO email_templates_default_data
            (email_key, locale, subject, body, description)
            VALUES
            (' .
            $dataSource->qstr($emailNode->getAttribute('key')) . ', ' .
            $dataSource->qstr($locale) . ', ' .
            $dataSource->qstr($subject) . ', ' .
            $dataSource->qstr($body) . ', ' .
            $dataSource->qstr($description) .
            ")";
         if (!$returnSql) {
            $this->update(array_shift($sql));
         }
      }
      if ($returnSql) return $sql;
      return true;
   }
}