Source for file languages.php

Documentation is available at languages.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_installer
  5.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  6.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  7.  */
  8.  
  9. defined('_JEXEC') or die;
  10.  
  11. jimport('joomla.updater.update');
  12.  
  13. /**
  14.  * Languages Installer Model
  15.  *
  16.  * @package     Joomla.Administrator
  17.  * @subpackage  com_installer
  18.  * @since       2.5.7
  19.  */
  20. class InstallerModelLanguages extends JModelList
  21. {
  22.     /**
  23.      * Constructor override, defines a white list of column filters.
  24.      *
  25.      * @param   array  $config  An optional associative array of configuration settings.
  26.      *
  27.      * @since   2.5.7
  28.      */
  29.     public function __construct($config = array())
  30.     {
  31.         if (empty($config['filter_fields']))
  32.         {
  33.             $config['filter_fields'] = array(
  34.                 'update_id', 'update_id',
  35.                 'name', 'name',
  36.             );
  37.         }
  38.  
  39.         parent::__construct($config);
  40.     }
  41.  
  42.     /**
  43.      * Method to get the available languages database query.
  44.      *
  45.      * @return  JDatabaseQuery  The database query
  46.      *
  47.      * @since   2.5.7
  48.      */
  49.     protected function _getListQuery()
  50.     {
  51.         $db   = JFactory::getDbo();
  52.         $query = $db->getQuery(true);
  53.  
  54.         // Select the required fields from the updates table
  55.         $query->select('update_id, name, version, detailsurl, type')
  56.  
  57.             ->from('#__updates');
  58.  
  59.         // This Where clause will avoid to list languages already installed.
  60.         $query->where('extension_id = 0');
  61.  
  62.         // Filter by search in title
  63.         $search = $this->getState('filter.search');
  64.         if (!empty($search))
  65.         {
  66.             $search = $db->quote('%' . $db->escape($search, true) . '%');
  67.             $query->where('(name LIKE ' . $search . ')');
  68.         }
  69.  
  70.         // Add the list ordering clause.
  71.         $listOrder = $this->state->get('list.ordering');
  72.         $orderDirn = $this->state->get('list.direction');
  73.         $query->order($db->escape($listOrder) . ' ' . $db->escape($orderDirn));
  74.  
  75.         return $query;
  76.     }
  77.  
  78.     /**
  79.      * Method to get a store id based on model configuration state.
  80.      *
  81.      * @param   string  $id  A prefix for the store id.
  82.      *
  83.      * @return  string  A store id.
  84.      *
  85.      * @since   2.5.7
  86.      */
  87.     protected function getStoreId($id = '')
  88.     {
  89.         // Compile the store id.
  90.         $id    .= ':' . $this->getState('filter.search');
  91.  
  92.         return parent::getStoreId($id);
  93.     }
  94.  
  95.     /**
  96.      * Method to auto-populate the model state.
  97.      *
  98.      * Note. Calling getState in this method will result in recursion.
  99.      *
  100.      * @param   string  $ordering   list order
  101.      * @param   string  $direction  direction in the list
  102.      *
  103.      * @return  void 
  104.      *
  105.      * @since   2.5.7
  106.      */
  107.     protected function populateState($ordering = 'name', $direction = 'asc')
  108.     {
  109.         $app = JFactory::getApplication();
  110.  
  111.         $value = $app->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  112.         $this->setState('filter.search', $value);
  113.  
  114.         $this->setState('extension_message', $app->getUserState('com_installer.extension_message'));
  115.  
  116.         parent::populateState($ordering, $direction);
  117.     }
  118.  
  119.     /**
  120.      * Method to find available languages in the Accredited Languages Update Site.
  121.      *
  122.      * @param   int  $cache_timeout  time before refreshing the cached updates
  123.      *
  124.      * @return  bool 
  125.      *
  126.      * @since   2.5.7
  127.      */
  128.     public function findLanguages($cache_timeout = 0)
  129.     {
  130.         $updater = JUpdater::getInstance();
  131.  
  132.         /*
  133.          * The following function uses extension_id 600, that is the english language extension id.
  134.          * In #__update_sites_extensions you should have 600 linked to the Accredited Translations Repo
  135.          */
  136.         $updater->findUpdates(array(600), $cache_timeout);
  137.  
  138.         return true;
  139.     }
  140.  
  141.     /**
  142.      * Install languages in the system.
  143.      *
  144.      * @param   array  $lids  array of language ids selected in the list
  145.      *
  146.      * @return  bool 
  147.      *
  148.      * @since   2.5.7
  149.      */
  150.     public function install($lids)
  151.     {
  152.         $app       = JFactory::getApplication();
  153.         $installer = JInstaller::getInstance();
  154.  
  155.         // Loop through every selected language
  156.         foreach ($lids as $id)
  157.         {
  158.             // Loads the update database object that represents the language
  159.             $language = JTable::getInstance('update');
  160.             $language->load($id);
  161.  
  162.             // Get the url to the XML manifest file of the selected language
  163.             $remote_manifest = $this->_getLanguageManifest($id);
  164.             if (!$remote_manifest)
  165.             {
  166.                 // Could not find the url, the information in the update server may be corrupt
  167.                 $message  = JText::sprintf('COM_INSTALLER_MSG_LANGUAGES_CANT_FIND_REMOTE_MANIFEST', $language->name);
  168.                 $message .= ' ' . JText::_('COM_INSTALLER_MSG_LANGUAGES_TRY_LATER');
  169.                 $app->enqueueMessage($message);
  170.                 continue;
  171.             }
  172.  
  173.             // Based on the language XML manifest get the url of the package to download
  174.             $package_url = $this->_getPackageUrl($remote_manifest);
  175.             if (!$package_url)
  176.             {
  177.                 // Could not find the url , maybe the url is wrong in the update server, or there is not internet access
  178.                 $message  = JText::sprintf('COM_INSTALLER_MSG_LANGUAGES_CANT_FIND_REMOTE_PACKAGE', $language->name);
  179.                 $message .= ' ' . JText::_('COM_INSTALLER_MSG_LANGUAGES_TRY_LATER');
  180.                 $app->enqueueMessage($message);
  181.                 continue;
  182.             }
  183.  
  184.             // Download the package to the tmp folder
  185.             $package = $this->_downloadPackage($package_url);
  186.  
  187.             // Install the package
  188.             if (!$installer->install($package['dir']))
  189.             {
  190.                 // There was an error installing the package
  191.                 $message  = JText::sprintf('COM_INSTALLER_INSTALL_ERROR', $language->name);
  192.                 $message .= ' ' . JText::_('COM_INSTALLER_MSG_LANGUAGES_TRY_LATER');
  193.                 $app->enqueueMessage($message);
  194.                 continue;
  195.             }
  196.  
  197.             // Package installed successfully
  198.             $app->enqueueMessage(JText::sprintf('COM_INSTALLER_INSTALL_SUCCESS', $language->name));
  199.  
  200.             // Cleanup the install files in tmp folder
  201.             if (!is_file($package['packagefile']))
  202.             {
  203.                 $config = JFactory::getConfig();
  204.                 $package['packagefile'] = $config->get('tmp_path') . '/' . $package['packagefile'];
  205.             }
  206.             JInstallerHelper::cleanupInstall($package['packagefile'], $package['extractdir']);
  207.  
  208.             // Delete the installed language from the list
  209.             $language->delete($id);
  210.         }
  211.  
  212.     }
  213.  
  214.     /**
  215.      * Gets the manifest file of a selected language from a the language list in a update server.
  216.      *
  217.      * @param   int  $uid  the id of the language in the #__updates table
  218.      *
  219.      * @return  string 
  220.      *
  221.      * @since   2.5.7
  222.      */
  223.     protected function _getLanguageManifest($uid)
  224.     {
  225.         $instance = JTable::getInstance('update');
  226.         $instance->load($uid);
  227.  
  228.         return $instance->detailsurl;
  229.     }
  230.  
  231.     /**
  232.      * Finds the url of the package to download.
  233.      *
  234.      * @param   string  $remote_manifest  url to the manifest XML file of the remote package
  235.      *
  236.      * @return  string|bool
  237.      *
  238.      * @since   2.5.7
  239.      */
  240.     protected function _getPackageUrl( $remote_manifest )
  241.     {
  242.         $update = new JUpdate;
  243.         $update->loadFromXML($remote_manifest);
  244.         $package_url = trim($update->get('downloadurl', false)->_data);
  245.  
  246.         return $package_url;
  247.     }
  248.  
  249.     /**
  250.      * Download a language package from a URL and unpack it in the tmp folder.
  251.      *
  252.      * @param   string  $url  hola
  253.      *
  254.      * @return  array|bool Package details or false on failure
  255.      *
  256.      * @since   2.5.7
  257.      */
  258.     protected function _downloadPackage($url)
  259.     {
  260.         // Download the package from the given URL
  261.         $p_file = JInstallerHelper::downloadPackage($url);
  262.  
  263.         // Was the package downloaded?
  264.         if (!$p_file)
  265.         {
  266.             JError::raiseWarning('', JText::_('COM_INSTALLER_MSG_INSTALL_INVALID_URL'));
  267.             return false;
  268.         }
  269.  
  270.         $config   = JFactory::getConfig();
  271.         $tmp_dest = $config->get('tmp_path');
  272.  
  273.         // Unpack the downloaded package file
  274.         $package = JInstallerHelper::unpack($tmp_dest . '/' . $p_file);
  275.  
  276.         return $package;
  277.     }
  278. }

Documentation generated on Tue, 19 Nov 2013 15:06:38 +0100 by phpDocumentor 1.4.3