/libraries/joomla/installer/adapters/library.php
PHP | 426 lines | 258 code | 46 blank | 122 comment | 27 complexity | 3fd04c070e49572d1c9fe2ee9babcb1d MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1
- <?php
- /**
- * @package Joomla.Platform
- * @subpackage Installer
- *
- * @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
- * @license GNU General Public License version 2 or later; see LICENSE
- */
- defined('JPATH_PLATFORM') or die;
- jimport('joomla.installer.librarymanifest');
- jimport('joomla.base.adapterinstance');
- /**
- * Library installer
- *
- * @package Joomla.Platform
- * @subpackage Installer
- * @since 11.1
- */
- class JInstallerLibrary extends JAdapterInstance
- {
- /**
- * Custom loadLanguage method
- *
- * @param string $path The path where to find language files.
- *
- * @return void
- *
- * @since 11.1
- */
- public function loadLanguage($path = null)
- {
- $source = $this->parent->getPath('source');
- if (!$source)
- {
- $this->parent->setPath('source', JPATH_PLATFORM . '/' . $this->parent->extension->element);
- }
- $this->manifest = $this->parent->getManifest();
- $extension = 'lib_' . strtolower(JFilterInput::getInstance()->clean((string) $this->manifest->name, 'cmd'));
- $name = strtolower((string) $this->manifest->libraryname);
- $lang = JFactory::getLanguage();
- $source = $path ? $path : JPATH_PLATFORM . "/$name";
- $lang->load($extension . '.sys', $source, null, false, false)
- || $lang->load($extension . '.sys', JPATH_SITE, null, false, false)
- || $lang->load($extension . '.sys', $source, $lang->getDefault(), false, false)
- || $lang->load($extension . '.sys', JPATH_SITE, $lang->getDefault(), false, false);
- }
- /**
- * Custom install method
- *
- * @return boolean True on success
- *
- * @since 11.1
- */
- public function install()
- {
- // Get the extension manifest object
- $this->manifest = $this->parent->getManifest();
- // Manifest Document Setup Section
- // Set the extensions name
- $name = JFilterInput::getInstance()->clean((string) $this->manifest->name, 'string');
- $element = str_replace('.xml', '', basename($this->parent->getPath('manifest')));
- $this->set('name', $name);
- $this->set('element', $element);
- $db = $this->parent->getDbo();
- $query = $db->getQuery(true);
- $query->select($db->quoteName('extension_id'));
- $query->from($db->quoteName('#__extensions'));
- $query->where($db->quoteName('type') . ' = ' . $db->quote('library'));
- $query->where($db->quoteName('element') . ' = ' . $db->quote($element));
- $db->setQuery($query);
- $result = $db->loadResult();
- if ($result)
- {
- // Already installed, can we upgrade?
- if ($this->parent->isOverwrite() || $this->parent->isUpgrade())
- {
- // We can upgrade, so uninstall the old one
- $installer = new JInstaller; // we don't want to compromise this instance!
- $installer->uninstall('library', $result);
- }
- else
- {
- // Abort the install, no upgrade possible
- $this->parent->abort(JText::_('JLIB_INSTALLER_ABORT_LIB_INSTALL_ALREADY_INSTALLED'));
- return false;
- }
- }
- // Get the libraries description
- $description = (string) $this->manifest->description;
- if ($description)
- {
- $this->parent->set('message', JText::_($description));
- }
- else
- {
- $this->parent->set('message', '');
- }
- // Set the installation path
- $group = (string) $this->manifest->libraryname;
- if (!$group)
- {
- $this->parent->abort(JText::_('JLIB_INSTALLER_ABORT_LIB_INSTALL_NOFILE'));
- return false;
- }
- else
- {
- $this->parent->setPath('extension_root', JPATH_PLATFORM . '/' . implode(DIRECTORY_SEPARATOR, explode('/', $group)));
- }
- // Filesystem Processing Section
- // If the plugin directory does not exist, let's create it
- $created = false;
- if (!file_exists($this->parent->getPath('extension_root')))
- {
- if (!$created = JFolder::create($this->parent->getPath('extension_root')))
- {
- $this->parent->abort(
- JText::sprintf('JLIB_INSTALLER_ABORT_LIB_INSTALL_FAILED_TO_CREATE_DIRECTORY', $this->parent->getPath('extension_root'))
- );
- return false;
- }
- }
- /*
- * If we created the plugin directory and will want to remove it if we
- * have to roll back the installation, let's add it to the installation
- * step stack
- */
- if ($created)
- {
- $this->parent->pushStep(array('type' => 'folder', 'path' => $this->parent->getPath('extension_root')));
- }
- // Copy all necessary files
- if ($this->parent->parseFiles($this->manifest->files, -1) === false)
- {
- // Install failed, roll back changes
- $this->parent->abort();
- return false;
- }
- // Parse optional tags
- $this->parent->parseLanguages($this->manifest->languages);
- $this->parent->parseMedia($this->manifest->media);
- // Extension Registration
- $row = JTable::getInstance('extension');
- $row->name = $this->get('name');
- $row->type = 'library';
- $row->element = $this->get('element');
- // There is no folder for modules
- $row->folder = '';
- $row->enabled = 1;
- $row->protected = 0;
- $row->access = 1;
- $row->client_id = 0;
- $row->params = $this->parent->getParams();
- // Custom data
- $row->custom_data = '';
- $row->manifest_cache = $this->parent->generateManifestCache();
- if (!$row->store())
- {
- // Install failed, roll back changes
- $this->parent->abort(JText::sprintf('JLIB_INSTALLER_ABORT_LIB_INSTALL_ROLLBACK', $db->stderr(true)));
- return false;
- }
- // Finalization and Cleanup Section
- // Lastly, we will copy the manifest file to its appropriate place.
- $manifest = array();
- $manifest['src'] = $this->parent->getPath('manifest');
- $manifest['dest'] = JPATH_MANIFESTS . '/libraries/' . basename($this->parent->getPath('manifest'));
- if (!$this->parent->copyFiles(array($manifest), true))
- {
- // Install failed, rollback changes
- $this->parent->abort(JText::_('JLIB_INSTALLER_ABORT_LIB_INSTALL_COPY_SETUP'));
- return false;
- }
- return $row->get('extension_id');
- }
- /**
- * Custom update method
- *
- * @return boolean True on success
- *
- * @since 11.1
- */
- public function update()
- {
- // Since this is just files, an update removes old files
- // Get the extension manifest object
- $this->manifest = $this->parent->getManifest();
- // Manifest Document Setup Section
- // Set the extensions name
- $name = (string) $this->manifest->name;
- $name = JFilterInput::getInstance()->clean($name, 'string');
- $element = str_replace('.xml', '', basename($this->parent->getPath('manifest')));
- $this->set('name', $name);
- $this->set('element', $element);
- // We don't want to compromise this instance!
- $installer = new JInstaller;
- $db = $this->parent->getDbo();
- $query = $db->getQuery(true);
- $query->select($db->quoteName('extension_id'));
- $query->from($db->quoteName('#__extensions'));
- $query->where($db->quoteName('type') . ' = ' . $db->quote('library'));
- $query->where($db->quoteName('element') . ' = ' . $db->quote($element));
- $db->setQuery($query);
- $result = $db->loadResult();
- if ($result)
- {
- // Already installed, which would make sense
- $installer->uninstall('library', $result);
- }
- // Now create the new files
- return $this->install();
- }
- /**
- * Custom uninstall method
- *
- * @param string $id The id of the library to uninstall.
- *
- * @return boolean True on success
- *
- * @since 11.1
- */
- public function uninstall($id)
- {
- // Initialise variables.
- $retval = true;
- // First order of business will be to load the module object table from the database.
- // This should give us the necessary information to proceed.
- $row = JTable::getInstance('extension');
- if (!$row->load((int) $id) || !strlen($row->element))
- {
- JError::raiseWarning(100, JText::_('ERRORUNKOWNEXTENSION'));
- return false;
- }
- // Is the library we are trying to uninstall a core one?
- // Because that is not a good idea...
- if ($row->protected)
- {
- JError::raiseWarning(100, JText::_('JLIB_INSTALLER_ERROR_LIB_UNINSTALL_WARNCORELIBRARY'));
- return false;
- }
- $manifestFile = JPATH_MANIFESTS . '/libraries/' . $row->element . '.xml';
- // Because libraries may not have their own folders we cannot use the standard method of finding an installation manifest
- if (file_exists($manifestFile))
- {
- $manifest = new JLibraryManifest($manifestFile);
- // Set the plugin root path
- $this->parent->setPath('extension_root', JPATH_PLATFORM . '/' . $manifest->libraryname);
- $xml = JFactory::getXML($manifestFile);
- // If we cannot load the XML file return null
- if (!$xml)
- {
- JError::raiseWarning(100, JText::_('JLIB_INSTALLER_ERROR_LIB_UNINSTALL_LOAD_MANIFEST'));
- return false;
- }
- // Check for a valid XML root tag.
- if ($xml->getName() != 'extension')
- {
- JError::raiseWarning(100, JText::_('JLIB_INSTALLER_ERROR_LIB_UNINSTALL_INVALID_MANIFEST'));
- return false;
- }
- $this->parent->removeFiles($xml->files, -1);
- JFile::delete($manifestFile);
- }
- else
- {
- // Remove this row entry since its invalid
- $row->delete($row->extension_id);
- unset($row);
- JError::raiseWarning(100, JText::_('JLIB_INSTALLER_ERROR_LIB_UNINSTALL_INVALID_NOTFOUND_MANIFEST'));
- return false;
- }
- // TODO: Change this so it walked up the path backwards so we clobber multiple empties
- // If the folder is empty, let's delete it
- if (JFolder::exists($this->parent->getPath('extension_root')))
- {
- if (is_dir($this->parent->getPath('extension_root')))
- {
- $files = JFolder::files($this->parent->getPath('extension_root'));
- if (!count($files))
- {
- JFolder::delete($this->parent->getPath('extension_root'));
- }
- }
- }
- $this->parent->removeFiles($xml->media);
- $this->parent->removeFiles($xml->languages);
- $row->delete($row->extension_id);
- unset($row);
- return $retval;
- }
- /**
- * Custom discover method
- *
- * @return array JExtension list of extensions available
- *
- * @since 11.1
- */
- public function discover()
- {
- $results = array();
- $file_list = JFolder::files(JPATH_MANIFESTS . '/libraries', '\.xml$');
- foreach ($file_list as $file)
- {
- $manifest_details = JApplicationHelper::parseXMLInstallFile(JPATH_MANIFESTS . '/libraries/' . $file);
- $file = JFile::stripExt($file);
- $extension = JTable::getInstance('extension');
- $extension->set('type', 'library');
- $extension->set('client_id', 0);
- $extension->set('element', $file);
- $extension->set('name', $file);
- $extension->set('state', -1);
- $extension->set('manifest_cache', json_encode($manifest_details));
- $results[] = $extension;
- }
- return $results;
- }
- /**
- * Custom discover_install method
- *
- * @return boolean True on success
- *
- * @since 11.1
- */
- public function discover_install()
- {
- /* Libraries are a strange beast; they are actually references to files
- * There are two parts to a library which are disjunct in their locations
- * 1) The manifest file (stored in /JPATH_MANIFESTS/libraries)
- * 2) The actual files (stored in /JPATH_PLATFORM/libraryname)
- * Thus installation of a library is the process of dumping files
- * in two different places. As such it is impossible to perform
- * any operation beyond mere registration of a library under the presumption
- * that the files exist in the appropriate location so that come uninstall
- * time they can be adequately removed.
- */
- $manifestPath = JPATH_MANIFESTS . '/libraries/' . $this->parent->extension->element . '.xml';
- $this->parent->manifest = $this->parent->isManifest($manifestPath);
- $this->parent->setPath('manifest', $manifestPath);
- $manifest_details = JApplicationHelper::parseXMLInstallFile($this->parent->getPath('manifest'));
- $this->parent->extension->manifest_cache = json_encode($manifest_details);
- $this->parent->extension->state = 0;
- $this->parent->extension->name = $manifest_details['name'];
- $this->parent->extension->enabled = 1;
- $this->parent->extension->params = $this->parent->getParams();
- if ($this->parent->extension->store())
- {
- return true;
- }
- else
- {
- JError::raiseWarning(101, JText::_('JLIB_INSTALLER_ERROR_LIB_DISCOVER_STORE_DETAILS'));
- return false;
- }
- }
- /**
- * Refreshes the extension table cache
- *
- * @return boolean Result of operation, true if updated, false on failure
- *
- * @since 11.1
- */
- public function refreshManifestCache()
- {
- // Need to find to find where the XML file is since we don't store this normally
- $manifestPath = JPATH_MANIFESTS . '/libraries/' . $this->parent->extension->element . '.xml';
- $this->parent->manifest = $this->parent->isManifest($manifestPath);
- $this->parent->setPath('manifest', $manifestPath);
- $manifest_details = JApplicationHelper::parseXMLInstallFile($this->parent->getPath('manifest'));
- $this->parent->extension->manifest_cache = json_encode($manifest_details);
- $this->parent->extension->name = $manifest_details['name'];
- try
- {
- return $this->parent->extension->store();
- }
- catch (JException $e)
- {
- JError::raiseWarning(101, JText::_('JLIB_INSTALLER_ERROR_LIB_REFRESH_MANIFEST_CACHE'));
- return false;
- }
- }
- }