Source for file update.php

Documentation is available at update.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_joomlaupdate
  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. /**
  13.  * The Joomla! update controller for the Update view
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_joomlaupdate
  17.  * @since       2.5.4
  18.  */
  19. class JoomlaupdateControllerUpdate extends JControllerLegacy
  20. {
  21.     /**
  22.      * Performs the download of the update package
  23.      *
  24.      * @return  void 
  25.      *
  26.      * @since   2.5.4
  27.      */
  28.     public function download()
  29.     {
  30.         $options['format'] = '{DATE}\t{TIME}\t{LEVEL}\t{CODE}\t{MESSAGE}';
  31.         $options['text_file'] = 'joomla_update.php';
  32.         JLog::addLogger($options, JLog::INFO, array('Update', 'databasequery', 'jerror'));
  33.         $user = JFactory::getUser();
  34.         JLog::add(JText::sprintf('COM_JOOMLAUPDATE_UPDATE_LOG_START', $user->id, $user->name, JVERSION), JLog::INFO, 'Update');
  35.  
  36.         $this->_applyCredentials();
  37.  
  38.         $model = $this->getModel('Default');
  39.         $file = $model->download();
  40.  
  41.         $message = null;
  42.         $messageType = null;
  43.  
  44.         if ($file)
  45.         {
  46.             JFactory::getApplication()->setUserState('com_joomlaupdate.file', $file);
  47.             $url = 'index.php?option=com_joomlaupdate&task=update.install';
  48.             JLog::add(JText::sprintf('COM_JOOMLAUPDATE_UPDATE_LOG_FILE', $file), JLog::INFO, 'Update');
  49.         }
  50.         else
  51.         {
  52.             JFactory::getApplication()->setUserState('com_joomlaupdate.file', null);
  53.             $url = 'index.php?option=com_joomlaupdate';
  54.             $message = JText::_('COM_JOOMLAUPDATE_VIEW_UPDATE_DOWNLOADFAILED');
  55.         }
  56.  
  57.         $this->setRedirect($url, $message, $messageType);
  58.     }
  59.  
  60.     /**
  61.      * Start the installation of the new Joomla! version
  62.      *
  63.      * @return  void 
  64.      *
  65.      * @since   2.5.4
  66.      */
  67.     public function install()
  68.     {
  69.         $options['format'] = '{DATE}\t{TIME}\t{LEVEL}\t{CODE}\t{MESSAGE}';
  70.         $options['text_file'] = 'joomla_update.php';
  71.         JLog::addLogger($options, JLog::INFO, array('Update', 'databasequery', 'jerror'));
  72.         JLog::add(JText::_('COM_JOOMLAUPDATE_UPDATE_LOG_INSTALL'), JLog::INFO, 'Update');
  73.  
  74.         $this->_applyCredentials();
  75.  
  76.         $model = $this->getModel('Default');
  77.  
  78.         $file = JFactory::getApplication()->getUserState('com_joomlaupdate.file', null);
  79.         $model->createRestorationFile($file);
  80.  
  81.         $this->display();
  82.     }
  83.  
  84.     /**
  85.      * Finalise the upgrade by running the necessary scripts
  86.      *
  87.      * @return  void 
  88.      *
  89.      * @since   2.5.4
  90.      */
  91.     public function finalise()
  92.     {
  93.         $options['format'] = '{DATE}\t{TIME}\t{LEVEL}\t{CODE}\t{MESSAGE}';
  94.         $options['text_file'] = 'joomla_update.php';
  95.         JLog::addLogger($options, JLog::INFO, array('Update', 'databasequery', 'jerror'));
  96.         JLog::add(JText::_('COM_JOOMLAUPDATE_UPDATE_LOG_FINALISE'), JLog::INFO, 'Update');
  97.         $this->_applyCredentials();
  98.  
  99.         $model = $this->getModel('Default');
  100.  
  101.         $model->finaliseUpgrade();
  102.  
  103.         $url = 'index.php?option=com_joomlaupdate&task=update.cleanup';
  104.         $this->setRedirect($url);
  105.     }
  106.  
  107.     /**
  108.      * Clean up after ourselves
  109.      *
  110.      * @return  void 
  111.      *
  112.      * @since   2.5.4
  113.      */
  114.     public function cleanup()
  115.     {
  116.         $options['format'] = '{DATE}\t{TIME}\t{LEVEL}\t{CODE}\t{MESSAGE}';
  117.         $options['text_file'] = 'joomla_update.php';
  118.         JLog::addLogger($options, JLog::INFO, array('Update', 'databasequery', 'jerror'));
  119.         JLog::add(JText::_('COM_JOOMLAUPDATE_UPDATE_LOG_CLEANUP'), JLog::INFO, 'Update');
  120.         $this->_applyCredentials();
  121.  
  122.         $model = $this->getModel('Default');
  123.  
  124.         $model->cleanUp();
  125.  
  126.         $url = 'index.php?option=com_joomlaupdate&layout=complete';
  127.         $this->setRedirect($url);
  128.         JLog::add(JText::sprintf('COM_JOOMLAUPDATE_UPDATE_LOG_COMPLETE', JVERSION), JLog::INFO, 'Update');
  129.     }
  130.  
  131.     /**
  132.      * Purges updates.
  133.      *
  134.      * @return  void 
  135.      *
  136.      * @since    3.0
  137.      */
  138.     public function purge()
  139.     {
  140.         // Purge updates
  141.         // Check for request forgeries
  142.         JSession::checkToken() or jexit(JText::_('JINVALID_TOKEN'));
  143.         $model = $this->getModel('Default');
  144.         $model->purge();
  145.  
  146.         $url = 'index.php?option=com_joomlaupdate';
  147.         $this->setRedirect($url, $model->_message);
  148.     }
  149.  
  150.     /**
  151.      * Method to display a view.
  152.      *
  153.      * @param   boolean  $cachable   If true, the view output will be cached
  154.      * @param   array    $urlparams  An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
  155.      *
  156.      * @return  JoomlaupdateControllerUpdate  This object to support chaining.
  157.      *
  158.      * @since    2.5.4
  159.      */
  160.     public function display($cachable = false, $urlparams = array())
  161.     {
  162.         // Get the document object.
  163.         $document = JFactory::getDocument();
  164.  
  165.         // Set the default view name and format from the Request.
  166.         $vName   = $this->input->get('view', 'update');
  167.         $vFormat = $document->getType();
  168.         $lName   = $this->input->get('layout', 'default');
  169.  
  170.         // Get and render the view.
  171.         if ($view = $this->getView($vName, $vFormat))
  172.         {
  173.             // Get the model for the view.
  174.             $model = $this->getModel('Default');
  175.  
  176.             // Push the model into the view (as default).
  177.             $view->setModel($model, true);
  178.             $view->setLayout($lName);
  179.  
  180.             // Push document object into the view.
  181.             $view->document = $document;
  182.             $view->display();
  183.         }
  184.  
  185.         return $this;
  186.     }
  187.  
  188.     /**
  189.      * Applies FTP credentials to Joomla! itself, when required
  190.      *
  191.      * @return  void 
  192.      *
  193.      * @since    2.5.4
  194.      */
  195.     protected function _applyCredentials()
  196.     {
  197.         if (!JClientHelper::hasCredentials('ftp'))
  198.         {
  199.             $user = JFactory::getApplication()->getUserStateFromRequest('com_joomlaupdate.ftp_user', 'ftp_user', null, 'raw');
  200.             $pass = JFactory::getApplication()->getUserStateFromRequest('com_joomlaupdate.ftp_pass', 'ftp_pass', null, 'raw');
  201.  
  202.             if ($user != '' && $pass != '')
  203.             {
  204.                 // Add credentials to the session
  205.                 if (!JClientHelper::setCredentials('ftp', $user, $pass))
  206.                 {
  207.                     JError::raiseWarning('SOME_ERROR_CODE', JText::_('JLIB_CLIENT_ERROR_HELPER_SETCREDENTIALSFROMREQUEST_FAILED'));
  208.                 }
  209.             }
  210.         }
  211.     }
  212. }

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