Civi/API/Subscriber/I18nSubscriber.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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    * @return array
  40    */
  41   public static function getSubscribedEvents() {
  42     return array(
  43       Events::PREPARE => array('onApiPrepare', Events::W_MIDDLE),
  44     );
  45   }
  46
  47   /**
  48    * @param \Civi\API\Event\Event $event
  49    *   API preparation event.
  50    *
  51    * @throws \API_Exception
  52    */
  53   public function onApiPrepare(\Civi\API\Event\Event $event) {
  54     $apiRequest = $event->getApiRequest();
  55
  56     // support multi-lingual requests
  57     if ($language = \CRM_Utils_Array::value('option.language', $apiRequest['params'])) {
  58       $this->setLocale($language);
  59     }
  60   }
  61
  62   /**
  63    * Sets the tsLocale and dbLocale for multi-lingual sites.
  64    * Some code duplication from CRM/Core/BAO/ConfigSetting.php retrieve()
  65    * to avoid regressions from refactoring.
  66    */
  67   public function setLocale($lcMessagesRequest) {
  68     // We must validate whether the locale is valid, otherwise setting a bad
  69     // dbLocale could probably lead to sql-injection.
  70     $domain = new \CRM_Core_DAO_Domain();
  71     $domain->id = \CRM_Core_Config::domainID();
  72     $domain->find(TRUE);
  73
  74     if ($domain->config_backend) {
  75       $defaults = unserialize($domain->config_backend);
  76
  77       // are we in a multi-language setup?
  78       $multiLang = $domain->locales ? TRUE : FALSE;
  79       $lcMessages = NULL;
  80
  81       // on multi-lang sites based on request and civicrm_uf_match
  82       if ($multiLang) {
  83         $languageLimit = array();
  84         if (array_key_exists('languageLimit', $defaults) && is_array($defaults['languageLimit'])) {
  85           $languageLimit = $defaults['languageLimit'];
  86         }
  87
  88         if (in_array($lcMessagesRequest, array_keys($languageLimit))) {
  89           $lcMessages = $lcMessagesRequest;
  90         }
  91         else {
  92           throw new \API_Exception(ts('Language not enabled: %1', array(1 => $lcMessagesRequest)));
  93         }
  94       }
  95
  96       global $dbLocale;
  97
  98       // set suffix for table names - use views if more than one language
  99       if ($lcMessages) {
 100         $dbLocale = $multiLang && $lcMessages ? "_{$lcMessages}" : '';
 101
 102         // FIXME: an ugly hack to fix CRM-4041
 103         global $tsLocale;
 104         $tsLocale = $lcMessages;
 105       }
 106     }
 107   }
 108 }