SiteDAO.inc.php

<?php
 
import('lib.pkp.classes.site.Site');
import('classes.core.Services');
 
class SiteDAO extends DAO {
 
   var $primaryTableColumns = [
      'redirect' => 'redirect',
      'primaryLocale' => 'primary_locale',
      'minPasswordLength' => 'min_password_length',
      'installedLocales' => 'installed_locales',
      'supportedLocales' => 'supported_locales',
   ];
 
 
   function &getSite() {
      $site = null;
      $result = $this->retrieve(
         'SELECT * FROM site'
      );
 
      if ($result->RecordCount() != 0) {
         $site = $this->_fromRow($result->GetRowAssoc(false));
      }
 
      $result->Close();
      return $site;
   }
 
   function newDataObject() {
      return new Site();
   }
 
   function _fromRow($primaryRow, $callHook = true) {
      $schemaService = Services::get('schema');
      $schema = $schemaService->get(SCHEMA_SITE);
 
      $site = $this->newDataObject();
 
      foreach ($this->primaryTableColumns as $propName => $column) {
         if (isset($primaryRow[$column])) {
            // Backwards-compatible handling of the installedLocales and
            // supportedLocales data. Before 3.2, these were stored as colon-separated
            // strings (eg - en_US:fr_CA:ar_IQ). In 3.2, these are migrated to
            // serialized arrays defined by the site.json schema. However, some of the
            // older upgrade scripts use site data before the migration is performed,
            // so SiteDAO must be able to return the correct array before the data
            // is migrated. This code checks the format and converts the old data so
            // that calls to $site->getInstalledLocales() and
            // $site->getSupportedLocales() return an appropriate array.
            if (in_array($column, ['installed_locales', 'supported_locales']) &&
                  !is_null($primaryRow[$column]) && strpos($primaryRow[$column], '{') === false) {
               $site->setData($propName, explode(':', $primaryRow[$column]));
            } else {
               $site->setData(
                  $propName,
                  $this->convertFromDb($primaryRow[$column], $schema->properties->{$propName}->type)
               );
            }
         }
      }
 
      $result = $this->retrieve("SELECT * FROM site_settings");
 
      while (!$result->EOF) {
         $settingRow = $result->getRowAssoc(false);
         if (!empty($schema->properties->{$settingRow['setting_name']})) {
            $site->setData(
               $settingRow['setting_name'],
               $this->convertFromDB(
                  $settingRow['setting_value'],
                  $schema->properties->{$settingRow['setting_name']}->type
               ),
               empty($settingRow['locale']) ? null : $settingRow['locale']
            );
         }
         $result->MoveNext();
      }
 
      return $site;
   }
 
   function insertSite(&$site) {
      $type = 'array';
      $returner = $this->update(
         'INSERT INTO site
            (redirect, min_password_length, primary_locale, installed_locales, supported_locales)
            VALUES
            (?, ?, ?, ?, ?)',
         array(
            $site->getRedirect(),
            (int) $site->getMinPasswordLength(),
            $site->getPrimaryLocale(),
            $this->convertToDB($site->getInstalledLocales(), $type),
            $this->convertToDB($site->getInstalledLocales(), $type),
         )
      );
      return $returner;
   }
 
   public function updateObject($site) {
      $schemaService = Services::get('schema');
      $schema = $schemaService->get(SCHEMA_SITE);
      $sanitizedProps = $schemaService->sanitize(SCHEMA_SITE, $site->_data);
 
      $set = $params = [];
      foreach ($this->primaryTableColumns as $propName => $column) {
         $set[] = $column . ' = ?';
         $params[] = $this->convertToDb($sanitizedProps[$propName], $schema->properties->{$propName}->type);
      }
      $this->update("UPDATE site SET " . join(',', $set), $params);
 
      $deleteSettings = [];
      $keyColumns = ['locale', 'setting_name'];
      foreach ($schema->properties as $propName => $propSchema) {
         if (array_key_exists($propName, $this->primaryTableColumns)) {
            continue;
         } elseif (!isset($sanitizedProps[$propName])) {
            $deleteSettings[] = $propName;
            continue;
         }
         if (!empty($propSchema->multilingual)) {
            foreach ($sanitizedProps[$propName] as $localeKey => $localeValue) {
               // Delete rows with a null value
               if (is_null($localeValue)) {
                  $this->update("DELETE FROM site_settings WHERE setting_name = ? AND locale = ?",[
                     $propName,
                     $localeKey,
                  ]);
               } else {
                  $updateArray = [
                     'locale' => $localeKey,
                     'setting_name' => $propName,
                     'setting_value' => $this->convertToDB($localeValue, $schema->properties->{$propName}->type),
                  ];
                  $result = $this->replace('site_settings', $updateArray, $keyColumns);
               }
            }
         } else {
            $updateArray = [
               'locale' => '',
               'setting_name' => $propName,
               'setting_value' => $this->convertToDB($sanitizedProps[$propName], $schema->properties->{$propName}->type),
            ];
            $this->replace('site_settings', $updateArray, $keyColumns);
         }
      }
 
      if (count($deleteSettings)) {
         $deleteSettingNames = join(',', array_map(function($settingName) {
            return "'$settingName'";
         }, $deleteSettings));
         $this->update("DELETE FROM site_settings WHERE setting_name in ($deleteSettingNames)");
      }
   }
}