Source for file update.php

Documentation is available at update.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_installer
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. jimport('joomla.updater.update');
  13.  
  14. /**
  15.  * Installer Update Model
  16.  *
  17.  * @package     Joomla.Administrator
  18.  * @subpackage  com_installer
  19.  * @since       1.6
  20.  */
  21. class InstallerModelUpdate extends JModelList
  22. {
  23.     /**
  24.      * Constructor.
  25.      *
  26.      * @param   array  $config  An optional associative array of configuration settings.
  27.      *
  28.      * @see     JController
  29.      * @since   1.6
  30.      */
  31.     public function __construct($config = array())
  32.     {
  33.         if (empty($config['filter_fields']))
  34.         {
  35.             $config['filter_fields'] = array(
  36.                 'name',
  37.                 'client_id',
  38.                 'type',
  39.                 'folder',
  40.                 'extension_id',
  41.                 'update_id',
  42.                 'update_site_id',
  43.             );
  44.         }
  45.  
  46.         parent::__construct($config);
  47.     }
  48.  
  49.     /**
  50.      * Method to auto-populate the model state.
  51.      *
  52.      * Note. Calling getState in this method will result in recursion.
  53.      *
  54.      * @param   string  $ordering   An optional ordering field.
  55.      * @param   string  $direction  An optional direction (asc|desc).
  56.      *
  57.      * @return  void 
  58.      *
  59.      * @since   1.6
  60.      */
  61.     protected function populateState($ordering = null, $direction = null)
  62.     {
  63.         $app = JFactory::getApplication();
  64.         $value = $app->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  65.         $this->setState('filter.search', $value);
  66.  
  67.         $clientId = $this->getUserStateFromRequest($this->context . '.filter.client_id', 'filter_client_id', '');
  68.         $this->setState('filter.client_id', $clientId);
  69.  
  70.         $categoryId = $this->getUserStateFromRequest($this->context . '.filter.type', 'filter_type', '');
  71.         $this->setState('filter.type', $categoryId);
  72.  
  73.         $group = $this->getUserStateFromRequest($this->context . '.filter.group', 'filter_group', '');
  74.         $this->setState('filter.group', $group);
  75.  
  76.         $this->setState('message', $app->getUserState('com_installer.message'));
  77.         $this->setState('extension_message', $app->getUserState('com_installer.extension_message'));
  78.         $app->setUserState('com_installer.message', '');
  79.         $app->setUserState('com_installer.extension_message', '');
  80.  
  81.         parent::populateState('name', 'asc');
  82.     }
  83.  
  84.     /**
  85.      * Method to get the database query
  86.      *
  87.      * @return  JDatabaseQuery  The database query
  88.      *
  89.      * @since   1.6
  90.      */
  91.     protected function getListQuery()
  92.     {
  93.         $db = $this->getDbo();
  94.         $query = $db->getQuery(true);
  95.         $type = $this->getState('filter.type');
  96.         $client = $this->getState('filter.client_id');
  97.         $group = $this->getState('filter.group');
  98.  
  99.         // Grab updates ignoring new installs
  100.         $query->select('*')
  101.             ->from('#__updates')
  102.             ->where('extension_id != 0')
  103.             ->order($this->getState('list.ordering') . ' ' . $this->getState('list.direction'));
  104.  
  105.         if ($type)
  106.         {
  107.             $query->where('type=' . $db->quote($type));
  108.         }
  109.         if ($client != '')
  110.         {
  111.             $query->where('client_id = ' . intval($client));
  112.         }
  113.         if ($group != '' && in_array($type, array('plugin', 'library', '')))
  114.         {
  115.             $query->where('folder=' . $db->quote($group == '*' ? '' : $group));
  116.         }
  117.  
  118.         // Filter by extension_id
  119.         if ($eid = $this->getState('filter.extension_id'))
  120.         {
  121.             $query->where($db->quoteName('extension_id') . ' = ' . $db->quote((int) $eid));
  122.         }
  123.         else
  124.         {
  125.             $query->where($db->quoteName('extension_id') . ' != ' . $db->quote(0))
  126.                 ->where($db->quoteName('extension_id') . ' != ' . $db->quote(700));
  127.         }
  128.  
  129.         // Filter by search
  130.         $search = $this->getState('filter.search');
  131.         if (!empty($search))
  132.         {
  133.             $query->where('name LIKE ' . $db->quote('%' . $search . '%'));
  134.         }
  135.         return $query;
  136.     }
  137.  
  138.     /**
  139.      * Finds updates for an extension.
  140.      *
  141.      * @param   int  $eid            Extension identifier to look for
  142.      * @param   int  $cache_timeout  Cache timout
  143.      *
  144.      * @return  boolean Result
  145.      *
  146.      * @since   1.6
  147.      */
  148.     public function findUpdates($eid = 0, $cache_timeout = 0)
  149.     {
  150.         // Purge the updates list
  151.         $this->purge();
  152.  
  153.         $updater = JUpdater::getInstance();
  154.         $updater->findUpdates($eid, $cache_timeout);
  155.         return true;
  156.     }
  157.  
  158.     /**
  159.      * Removes all of the updates from the table.
  160.      *
  161.      * @return  boolean result of operation
  162.      *
  163.      * @since   1.6
  164.      */
  165.     public function purge()
  166.     {
  167.         $db = JFactory::getDbo();
  168.  
  169.         // Note: TRUNCATE is a DDL operation
  170.         // This may or may not mean depending on your database
  171.         $db->setQuery('TRUNCATE TABLE #__updates');
  172.         if ($db->execute())
  173.         {
  174.             // Reset the last update check timestamp
  175.             $query = $db->getQuery(true)
  176.                 ->update($db->quoteName('#__update_sites'))
  177.                 ->set($db->quoteName('last_check_timestamp') . ' = ' . $db->quote(0));
  178.             $db->setQuery($query);
  179.             $db->execute();
  180.             $this->_message = JText::_('COM_INSTALLER_PURGED_UPDATES');
  181.             return true;
  182.         }
  183.         else
  184.         {
  185.             $this->_message = JText::_('COM_INSTALLER_FAILED_TO_PURGE_UPDATES');
  186.             return false;
  187.         }
  188.     }
  189.  
  190.     /**
  191.      * Enables any disabled rows in #__update_sites table
  192.      *
  193.      * @return  boolean result of operation
  194.      *
  195.      * @since   1.6
  196.      */
  197.     public function enableSites()
  198.     {
  199.         $db = JFactory::getDbo();
  200.         $query = $db->getQuery(true)
  201.             ->update('#__update_sites')
  202.             ->set('enabled = 1')
  203.             ->where('enabled = 0');
  204.         $db->setQuery($query);
  205.         if ($db->execute())
  206.         {
  207.             if ($rows = $db->getAffectedRows())
  208.             {
  209.                 $this->_message .= JText::plural('COM_INSTALLER_ENABLED_UPDATES', $rows);
  210.             }
  211.             return true;
  212.         }
  213.         else
  214.         {
  215.             $this->_message .= JText::_('COM_INSTALLER_FAILED_TO_ENABLE_UPDATES');
  216.             return false;
  217.         }
  218.     }
  219.  
  220.     /**
  221.      * Update function.
  222.      *
  223.      * Sets the "result" state with the result of the operation.
  224.      *
  225.      * @param   array  $uids  Array[int] List of updates to apply
  226.      *
  227.      * @return  void 
  228.      *
  229.      * @since   1.6
  230.      */
  231.     public function update($uids)
  232.     {
  233.         $result = true;
  234.         foreach ($uids as $uid)
  235.         {
  236.             $update = new JUpdate;
  237.             $instance = JTable::getInstance('update');
  238.             $instance->load($uid);
  239.             $update->loadFromXML($instance->detailsurl);
  240.  
  241.             // Install sets state and enqueues messages
  242.             $res = $this->install($update);
  243.  
  244.             if ($res)
  245.             {
  246.                 $instance->delete($uid);
  247.             }
  248.  
  249.             $result = $res & $result;
  250.         }
  251.  
  252.         // Set the final state
  253.         $this->setState('result', $result);
  254.     }
  255.  
  256.     /**
  257.      * Handles the actual update installation.
  258.      *
  259.      * @param   JUpdate  $update  An update definition
  260.      *
  261.      * @return  boolean   Result of install
  262.      *
  263.      * @since   1.6
  264.      */
  265.     private function install($update)
  266.     {
  267.         $app = JFactory::getApplication();
  268.         if (isset($update->get('downloadurl')->_data))
  269.         {
  270.             $url = $update->downloadurl->_data;
  271.         }
  272.         else
  273.         {
  274.             JError::raiseWarning('', JText::_('COM_INSTALLER_INVALID_EXTENSION_UPDATE'));
  275.             return false;
  276.         }
  277.  
  278.         $p_file = JInstallerHelper::downloadPackage($url);
  279.  
  280.         // Was the package downloaded?
  281.         if (!$p_file)
  282.         {
  283.             JError::raiseWarning('', JText::sprintf('COM_INSTALLER_PACKAGE_DOWNLOAD_FAILED', $url));
  284.             return false;
  285.         }
  286.  
  287.         $config        = JFactory::getConfig();
  288.         $tmp_dest    = $config->get('tmp_path');
  289.  
  290.         // Unpack the downloaded package file
  291.         $package    = JInstallerHelper::unpack($tmp_dest . '/' . $p_file);
  292.  
  293.         // Get an installer instance
  294.         $installer    = JInstaller::getInstance();
  295.         $update->set('type', $package['type']);
  296.  
  297.         // Install the package
  298.         if (!$installer->update($package['dir']))
  299.         {
  300.             // There was an error updating the package
  301.             $msg = JText::sprintf('COM_INSTALLER_MSG_UPDATE_ERROR', JText::_('COM_INSTALLER_TYPE_TYPE_' . strtoupper($package['type'])));
  302.             $result = false;
  303.         }
  304.         else
  305.         {
  306.             // Package updated successfully
  307.             $msg = JText::sprintf('COM_INSTALLER_MSG_UPDATE_SUCCESS', JText::_('COM_INSTALLER_TYPE_TYPE_' . strtoupper($package['type'])));
  308.             $result = true;
  309.         }
  310.  
  311.         // Quick change
  312.         $this->type = $package['type'];
  313.  
  314.         // Set some model state values
  315.         $app->enqueueMessage($msg);
  316.  
  317.         // TODO: Reconfigure this code when you have more battery life left
  318.         $this->setState('name', $installer->get('name'));
  319.         $this->setState('result', $result);
  320.         $app->setUserState('com_installer.message', $installer->message);
  321.         $app->setUserState('com_installer.extension_message', $installer->get('extension_message'));
  322.  
  323.         // Cleanup the install files
  324.         if (!is_file($package['packagefile']))
  325.         {
  326.             $config = JFactory::getConfig();
  327.             $package['packagefile'] = $config->get('tmp_path') . '/' . $package['packagefile'];
  328.         }
  329.  
  330.         JInstallerHelper::cleanupInstall($package['packagefile'], $package['extractdir']);
  331.  
  332.         return $result;
  333.     }
  334.  
  335.     /**
  336.     * Method to get the row form.
  337.     *
  338.     * @param   array    $data      Data for the form.
  339.     * @param   boolean  $loadData  True if the form is to load its own data (default case), false if not.
  340.     *
  341.     * @return  mixed  A JForm object on success, false on failure
  342.     *
  343.     * @since    2.5.2
  344.     */
  345.     public function getForm($data = array(), $loadData = true)
  346.     {
  347.         // Get the form.
  348.         JForm::addFormPath(JPATH_COMPONENT . '/models/forms');
  349.         JForm::addFieldPath(JPATH_COMPONENT . '/models/fields');
  350.         $form = JForm::getInstance('com_installer.update', 'update', array('load_data' => $loadData));
  351.  
  352.         // Check for an error.
  353.         if ($form == false)
  354.         {
  355.             $this->setError($form->getMessage());
  356.             return false;
  357.         }
  358.         // Check the session for previously entered form data.
  359.         $data = $this->loadFormData();
  360.  
  361.         // Bind the form data if present.
  362.         if (!empty($data))
  363.         {
  364.             $form->bind($data);
  365.         }
  366.  
  367.         return $form;
  368.     }
  369.  
  370.     /**
  371.      * Method to get the data that should be injected in the form.
  372.      *
  373.      * @return  mixed  The data for the form.
  374.      *
  375.      * @since    2.5.2
  376.      */
  377.     protected function loadFormData()
  378.     {
  379.         // Check the session for previously entered form data.
  380.         $data = JFactory::getApplication()->getUserState($this->context . '.data', array());
  381.         return $data;
  382.     }
  383. }

Documentation generated on Tue, 19 Nov 2013 15:16:10 +0100 by phpDocumentor 1.4.3