Civi/API/Subscriber/I18nSubscriber.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 namespace Civi\API\Subscriber;
  29
  30 use Civi\API\Events;
  31 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  32
  33 /**
  34  * Class I18nSubscriber
  35  * @package Civi\API\Subscriber
  36  */
  37 class I18nSubscriber implements EventSubscriberInterface {
  38
  39   /**
  40    * @return array
  41    */
  42   public static function getSubscribedEvents() {
  43     return [
  44       Events::PREPARE => ['onApiPrepare', Events::W_MIDDLE],
  45     ];
  46   }
  47
  48   /**
  49    * Support multi-lingual requests
  50    *
  51    * @param \Civi\API\Event\Event $event
  52    *   API preparation event.
  53    *
  54    * @throws \API_Exception
  55    */
  56   public function onApiPrepare(\Civi\API\Event\Event $event) {
  57     $apiRequest = $event->getApiRequest();
  58
  59     $params = $apiRequest['params'];
  60     if ($apiRequest['version'] < 4) {
  61       $language = !empty($params['options']['language']) ? $params['options']['language'] : \CRM_Utils_Array::value('option.language', $params);
  62     }
  63     else {
  64       $language = \CRM_Utils_Array::value('language', $params);
  65     }
  66     if ($language) {
  67       $this->setLocale($language);
  68     }
  69   }
  70
  71   /**
  72    * Sets the tsLocale and dbLocale for multi-lingual sites.
  73    * Some code duplication from CRM/Core/BAO/ConfigSetting.php retrieve()
  74    * to avoid regressions from refactoring.
  75    * @param $lcMessagesRequest
  76    * @throws \API_Exception
  77    */
  78   public function setLocale($lcMessagesRequest) {
  79     // We must validate whether the locale is valid, otherwise setting a bad
  80     // dbLocale could probably lead to sql-injection.
  81     $domain = new \CRM_Core_DAO_Domain();
  82     $domain->id = \CRM_Core_Config::domainID();
  83     $domain->find(TRUE);
  84
  85     // are we in a multi-language setup?
  86     $multiLang = $domain->locales ? TRUE : FALSE;
  87     $lcMessages = NULL;
  88
  89     // on multi-lang sites based on request and civicrm_uf_match
  90     if ($multiLang) {
  91       $config = \CRM_Core_Config::singleton();
  92       $languageLimit = [];
  93       if (isset($config->languageLimit) and $config->languageLimit) {
  94         $languageLimit = $config->languageLimit;
  95       }
  96
  97       if (in_array($lcMessagesRequest, array_keys($languageLimit))) {
  98         $lcMessages = $lcMessagesRequest;
  99       }
 100       else {
 101         throw new \API_Exception(ts('Language not enabled: %1', [1 => $lcMessagesRequest]));
 102       }
 103     }
 104
 105     global $dbLocale;
 106
 107     // set suffix for table names - use views if more than one language
 108     if ($lcMessages) {
 109       $dbLocale = $multiLang && $lcMessages ? "_{$lcMessages}" : '';
 110
 111       // FIXME: an ugly hack to fix CRM-4041
 112       global $tsLocale;
 113       $tsLocale = $lcMessages;
 114     }
 115   }
 116
 117 }