Source for file install.php

Documentation is available at install.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. /**
  13.  * Extension Manager Install Model
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_installer
  17.  * @since       1.5
  18.  */
  19. class InstallerModelInstall extends JModelLegacy
  20. {
  21.     /**
  22.      * @var object JTable object
  23.      */
  24.     protected $_table = null;
  25.  
  26.     /**
  27.      * @var object JTable object
  28.      */
  29.     protected $_url = null;
  30.  
  31.     /**
  32.      * Model context string.
  33.      *
  34.      * @var        string 
  35.      */
  36.     protected $_context = 'com_installer.install';
  37.  
  38.     /**
  39.      * Method to auto-populate the model state.
  40.      *
  41.      * Note. Calling getState in this method will result in recursion.
  42.      *
  43.      * @return  void 
  44.      *
  45.      * @since   1.6
  46.      */
  47.     protected function populateState()
  48.     {
  49.         $app = JFactory::getApplication('administrator');
  50.  
  51.         $this->setState('message', $app->getUserState('com_installer.message'));
  52.         $this->setState('extension_message', $app->getUserState('com_installer.extension_message'));
  53.         $app->setUserState('com_installer.message', '');
  54.         $app->setUserState('com_installer.extension_message', '');
  55.  
  56.         // Recall the 'Install from Directory' path.
  57.         $path = $app->getUserStateFromRequest($this->_context . '.install_directory', 'install_directory', $app->getCfg('tmp_path'));
  58.         $this->setState('install.directory', $path);
  59.         parent::populateState();
  60.     }
  61.  
  62.     /**
  63.      * Install an extension from either folder, url or upload.
  64.      *
  65.      * @return  boolean result of install
  66.      *
  67.      * @since   1.5
  68.      */
  69.     public function install()
  70.     {
  71.         $this->setState('action', 'install');
  72.  
  73.         // Set FTP credentials, if given.
  74.         JClientHelper::setCredentialsFromRequest('ftp');
  75.         $app = JFactory::getApplication();
  76.  
  77.         // Load installer plugins for assistance if required:
  78.         JPluginHelper::importPlugin('installer');
  79.         $dispatcher = JEventDispatcher::getInstance();
  80.  
  81.         $package = null;
  82.  
  83.         // This event allows an input pre-treatment, a custom pre-packing or custom installation (e.g. from a JSON description)
  84.         $results = $dispatcher->trigger('onInstallerBeforeInstallation', array($this, &$package));
  85.  
  86.         if (in_array(true, $results, true))
  87.         {
  88.             return true;
  89.         }
  90.         elseif (in_array(false, $results, true))
  91.         {
  92.             return false;
  93.         }
  94.  
  95.         $installType = $app->input->getWord('installtype');
  96.  
  97.         if ($package === null)
  98.         {
  99.             switch ($installType)
  100.             {
  101.                 case 'folder':
  102.                     // Remember the 'Install from Directory' path.
  103.                     $app->getUserStateFromRequest($this->_context . '.install_directory', 'install_directory');
  104.                     $package = $this->_getPackageFromFolder();
  105.                     break;
  106.  
  107.                 case 'upload':
  108.                     $package = $this->_getPackageFromUpload();
  109.                     break;
  110.  
  111.                 case 'url':
  112.                     $package = $this->_getPackageFromUrl();
  113.                     break;
  114.  
  115.                 default:
  116.                     $app->setUserState('com_installer.message', JText::_('COM_INSTALLER_NO_INSTALL_TYPE_FOUND'));
  117.  
  118.                     return false;
  119.                     break;
  120.             }
  121.         }
  122.  
  123.         // This event allows a custom installation of the package or a customization of the package:
  124.         $results = $dispatcher->trigger('onInstallerBeforeInstaller', array($this, &$package));
  125.  
  126.         if (in_array(true, $results, true))
  127.         {
  128.             return true;
  129.         }
  130.         elseif (in_array(false, $results, true))
  131.         {
  132.             if (in_array($installType, array('upload', 'url')))
  133.             {
  134.                 JInstallerHelper::cleanupInstall($package['packagefile'], $package['extractdir']);
  135.             }
  136.  
  137.             return false;
  138.         }
  139.  
  140.         // Was the package unpacked?
  141.         if (!$package || !$package['type'])
  142.         {
  143.             if (in_array($installType, array('upload', 'url')))
  144.             {
  145.                 JInstallerHelper::cleanupInstall($package['packagefile'], $package['extractdir']);
  146.             }
  147.  
  148.             $app->setUserState('com_installer.message', JText::_('COM_INSTALLER_UNABLE_TO_FIND_INSTALL_PACKAGE'));
  149.             return false;
  150.         }
  151.  
  152.         // Get an installer instance
  153.         $installer = JInstaller::getInstance();
  154.  
  155.         // Install the package
  156.         if (!$installer->install($package['dir']))
  157.         {
  158.             // There was an error installing the package
  159.             $msg = JText::sprintf('COM_INSTALLER_INSTALL_ERROR', JText::_('COM_INSTALLER_TYPE_TYPE_' . strtoupper($package['type'])));
  160.             $result = false;
  161.         }
  162.         else
  163.         {
  164.             // Package installed sucessfully
  165.             $msg = JText::sprintf('COM_INSTALLER_INSTALL_SUCCESS', JText::_('COM_INSTALLER_TYPE_TYPE_' . strtoupper($package['type'])));
  166.             $result = true;
  167.         }
  168.  
  169.         // This event allows a custom a post-flight:
  170.         $dispatcher->trigger('onInstallerAfterInstaller', array($this, &$package, $installer, &$result, &$msg));
  171.  
  172.         // Set some model state values
  173.         $app    = JFactory::getApplication();
  174.         $app->enqueueMessage($msg);
  175.         $this->setState('name', $installer->get('name'));
  176.         $this->setState('result', $result);
  177.         $app->setUserState('com_installer.message', $installer->message);
  178.         $app->setUserState('com_installer.extension_message', $installer->get('extension_message'));
  179.         $app->setUserState('com_installer.redirect_url', $installer->get('redirect_url'));
  180.  
  181.         // Cleanup the install files
  182.         if (!is_file($package['packagefile']))
  183.         {
  184.             $config = JFactory::getConfig();
  185.             $package['packagefile'] = $config->get('tmp_path') . '/' . $package['packagefile'];
  186.         }
  187.  
  188.         JInstallerHelper::cleanupInstall($package['packagefile'], $package['extractdir']);
  189.  
  190.         return $result;
  191.     }
  192.  
  193.     /**
  194.      * Works out an installation package from a HTTP upload
  195.      *
  196.      * @return package definition or false on failure
  197.      */
  198.     protected function _getPackageFromUpload()
  199.     {
  200.         // Get the uploaded file information
  201.         $userfile = JRequest::getVar('install_package', null, 'files', 'array');
  202.  
  203.         // Make sure that file uploads are enabled in php
  204.         if (!(bool) ini_get('file_uploads'))
  205.         {
  206.             JError::raiseWarning('', JText::_('COM_INSTALLER_MSG_INSTALL_WARNINSTALLFILE'));
  207.             return false;
  208.         }
  209.  
  210.         // Make sure that zlib is loaded so that the package can be unpacked
  211.         if (!extension_loaded('zlib'))
  212.         {
  213.             JError::raiseWarning('', JText::_('COM_INSTALLER_MSG_INSTALL_WARNINSTALLZLIB'));
  214.             return false;
  215.         }
  216.  
  217.         // If there is no uploaded file, we have a problem...
  218.         if (!is_array($userfile))
  219.         {
  220.             JError::raiseWarning('', JText::_('COM_INSTALLER_MSG_INSTALL_NO_FILE_SELECTED'));
  221.             return false;
  222.         }
  223.  
  224.         // Check if there was a problem uploading the file.
  225.         if ($userfile['error'] || $userfile['size'] < 1)
  226.         {
  227.             JError::raiseWarning('', JText::_('COM_INSTALLER_MSG_INSTALL_WARNINSTALLUPLOADERROR'));
  228.             return false;
  229.         }
  230.  
  231.         // Build the appropriate paths
  232.         $config        = JFactory::getConfig();
  233.         $tmp_dest    = $config->get('tmp_path') . '/' . $userfile['name'];
  234.         $tmp_src    = $userfile['tmp_name'];
  235.  
  236.         // Move uploaded file
  237.         jimport('joomla.filesystem.file');
  238.         JFile::upload($tmp_src, $tmp_dest);
  239.  
  240.         // Unpack the downloaded package file
  241.         $package = JInstallerHelper::unpack($tmp_dest, true);
  242.  
  243.         return $package;
  244.     }
  245.  
  246.     /**
  247.      * Install an extension from a directory
  248.      *
  249.      * @return  array  Package details or false on failure
  250.      *
  251.      * @since   1.5
  252.      */
  253.     protected function _getPackageFromFolder()
  254.     {
  255.         $input = JFactory::getApplication()->input;
  256.  
  257.         // Get the path to the package to install
  258.         $p_dir = $input->getString('install_directory');
  259.         $p_dir = JPath::clean($p_dir);
  260.  
  261.         // Did you give us a valid directory?
  262.         if (!is_dir($p_dir))
  263.         {
  264.             JError::raiseWarning('', JText::_('COM_INSTALLER_MSG_INSTALL_PLEASE_ENTER_A_PACKAGE_DIRECTORY'));
  265.             return false;
  266.         }
  267.  
  268.         // Detect the package type
  269.         $type = JInstallerHelper::detectType($p_dir);
  270.  
  271.         // Did you give us a valid package?
  272.         if (!$type)
  273.         {
  274.             JError::raiseWarning('', JText::_('COM_INSTALLER_MSG_INSTALL_PATH_DOES_NOT_HAVE_A_VALID_PACKAGE'));
  275.         }
  276.  
  277.         $package['packagefile'] = null;
  278.         $package['extractdir'] = null;
  279.         $package['dir'] = $p_dir;
  280.         $package['type'] = $type;
  281.  
  282.         return $package;
  283.     }
  284.  
  285.     /**
  286.      * Install an extension from a URL
  287.      *
  288.      * @return  Package details or false on failure
  289.      *
  290.      * @since   1.5
  291.      */
  292.     protected function _getPackageFromUrl()
  293.     {
  294.         $input = JFactory::getApplication()->input;
  295.  
  296.         // Get the URL of the package to install
  297.         $url = $input->getString('install_url');
  298.  
  299.         // Did you give us a URL?
  300.         if (!$url)
  301.         {
  302.             JError::raiseWarning('', JText::_('COM_INSTALLER_MSG_INSTALL_ENTER_A_URL'));
  303.             return false;
  304.         }
  305.  
  306.         // Handle updater XML file case:
  307.         if (preg_match('/\.xml\s*$/', $url))
  308.         {
  309.             jimport('joomla.updater.update');
  310.             $update = new JUpdate;
  311.             $update->loadFromXML($url);
  312.             $package_url = trim($update->get('downloadurl', false)->_data);
  313.             if ($package_url)
  314.             {
  315.                 $url = $package_url;
  316.             }
  317.             unset($update);
  318.         }
  319.  
  320.         // Download the package at the URL given
  321.         $p_file = JInstallerHelper::downloadPackage($url);
  322.  
  323.         // Was the package downloaded?
  324.         if (!$p_file)
  325.         {
  326.             JError::raiseWarning('', JText::_('COM_INSTALLER_MSG_INSTALL_INVALID_URL'));
  327.             return false;
  328.         }
  329.  
  330.         $config   = JFactory::getConfig();
  331.         $tmp_dest = $config->get('tmp_path');
  332.  
  333.         // Unpack the downloaded package file
  334.         $package = JInstallerHelper::unpack($tmp_dest . '/' . $p_file, true);
  335.  
  336.         return $package;
  337.     }
  338. }

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