0byt3m1n1
Path:
/
home
/
k
/
a
/
s
/
kassiope
/
OLD
/
00-OLD
/
libraries
/
joomla
/
installer
/
adapters
/
[
Home
]
File: module.php
<?php /** * @version $Id:module.php 6961 2007-03-15 16:06:53Z tcp $ * @package Joomla.Framework * @subpackage Installer * @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved. * @license GNU/GPL, see LICENSE.php * Joomla! is free software. This version may have been modified pursuant * to the GNU General Public License, and as distributed it includes or * is derivative of works licensed under the GNU General Public License or * other free or open source software licenses. * See COPYRIGHT.php for copyright notices and details. */ // Check to ensure this file is within the rest of the framework defined('JPATH_BASE') or die(); /** * Module installer * * @package Joomla.Framework * @subpackage Installer * @since 1.5 */ class JInstallerModule extends JObject { /** * Constructor * * @access protected * @param object $parent Parent object [JInstaller instance] * @return void * @since 1.5 */ function __construct(&$parent) { $this->parent =& $parent; } /** * Custom install method * * @access public * @return boolean True on success * @since 1.5 */ function install() { // Get a database connector object $db =& $this->parent->getDBO(); // Get the extension manifest object $manifest =& $this->parent->getManifest(); $this->manifest =& $manifest->document; /** * --------------------------------------------------------------------------------------------- * Manifest Document Setup Section * --------------------------------------------------------------------------------------------- */ // Set the extensions name $name =& $this->manifest->getElementByPath('name'); $name = JFilterInput::clean($name->data(), 'string'); $this->set('name', $name); // Get the component description $description = & $this->manifest->getElementByPath('description'); if (is_a($description, 'JSimpleXMLElement')) { $this->parent->set('message', $description->data()); } else { $this->parent->set('message', '' ); } /** * --------------------------------------------------------------------------------------------- * Target Application Section * --------------------------------------------------------------------------------------------- */ // Get the target application if ($cname = $this->manifest->attributes('client')) { // Attempt to map the client to a base path jimport('joomla.application.helper'); $client =& JApplicationHelper::getClientInfo($cname, true); if ($client === false) { $this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.JText::_('Unknown client type').' ['.$client->name.']'); return false; } $basePath = $client->path; $clientId = $client->id; } else { // No client attribute was found so we assume the site as the client $cname = 'site'; $basePath = JPATH_SITE; $clientId = 0; } // Set the installation path $element =& $this->manifest->getElementByPath('files'); if (is_a($element, 'JSimpleXMLElement') && count($element->children())) { $files = $element->children(); foreach ($files as $file) { if ($file->attributes('module')) { $mname = $file->attributes('module'); break; } } } if (!empty ($mname)) { $this->parent->setPath('extension_root', $basePath.DS.'modules'.DS.$mname); } else { $this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.JText::_('No module file specified')); return false; } /** * --------------------------------------------------------------------------------------------- * Filesystem Processing Section * --------------------------------------------------------------------------------------------- */ /* * If the module directory already exists, then we will assume that the * module is already installed or another module is using that * directory. */ if (file_exists($this->parent->getPath('extension_root'))&&!$this->parent->getOverwrite()) { $this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.JText::_('Another module is already using directory').': "'.$this->parent->getPath('extension_root').'"'); return false; } // If the module directory does not exist, lets 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::_('Module').' '.JText::_('Install').': '.JText::_('Failed to create directory').': "'.$this->parent->getPath('extension_root').'"'); return false; } } /* * Since we created the module directory and will want to remove it if * we have to roll back the installation, lets 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($element, -1) === false) { // Install failed, roll back changes $this->parent->abort(); return false; } // Parse optional tags $this->parent->parseMedia($this->manifest->getElementByPath('media'), $clientId); $this->parent->parseLanguages($this->manifest->getElementByPath('languages'), $clientId); // Parse deprecated tags $this->parent->parseFiles($this->manifest->getElementByPath('images'), -1); /** * --------------------------------------------------------------------------------------------- * Database Processing Section * --------------------------------------------------------------------------------------------- */ // Check to see if a module by the same name is already installed $query = 'SELECT `id`' . ' FROM `#__modules` ' . ' WHERE module = '.$db->Quote($mname) . ' AND client_id = '.(int)$clientId; $db->setQuery($query); if (!$db->Query()) { // Install failed, roll back changes $this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.$db->stderr(true)); return false; } $id = $db->loadResult(); // Was there a module already installed with the same name? // If there was then we wouldn't be here because it would have // been stopped by the above. Otherwise the files weren't there // (e.g. migration) or its an upgrade (files overwritten) // So all we need to do is create an entry when we can't find one if (!$id) { $row = & JTable::getInstance('module'); $row->title = JText::_($this->get('name')); $row->ordering = $row->getNextOrder( "position='left'" ); $row->position = 'left'; $row->showtitle = 1; $row->iscore = 0; $row->access = $clientId == 1 ? 2 : 0; $row->client_id = $clientId; $row->module = $mname; $row->params = $this->parent->getParams(); if (!$row->store()) { // Install failed, roll back changes $this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.$db->stderr(true)); return false; } // Since we have created a module item, we add it to the installation step stack // so that if we have to rollback the changes we can undo it. $this->parent->pushStep(array ('type' => 'module', 'id' => $row->id)); // Clean up possible garbage first $query = 'DELETE FROM #__modules_menu WHERE moduleid = '.(int) $row->id; $db->setQuery( $query ); if (!$db->query()) { // Install failed, roll back changes $this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.$db->stderr(true)); return false; } // Time to create a menu entry for the module $query = 'INSERT INTO `#__modules_menu` ' . ' VALUES ('.(int) $row->id.', 0 )'; $db->setQuery($query); if (!$db->query()) { // Install failed, roll back changes $this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.$db->stderr(true)); return false; } /* * Since we have created a menu item, we add it to the installation step stack * so that if we have to rollback the changes we can undo it. */ $this->parent->pushStep(array ('type' => 'menu', 'id' => $db->insertid())); } /** * --------------------------------------------------------------------------------------------- * Finalization and Cleanup Section * --------------------------------------------------------------------------------------------- */ // Lastly, we will copy the manifest file to its appropriate place. if (!$this->parent->copyManifest(-1)) { // Install failed, rollback changes $this->parent->abort(JText::_('Module').' '.JText::_('Install').': '.JText::_('Could not copy setup file')); return false; } // Load module language file $lang =& JFactory::getLanguage(); $lang->load($row->module, JPATH_BASE.DS.'..'); return true; } /** * Custom uninstall method * * @access public * @param int $id The id of the module to uninstall * @param int $clientId The id of the client (unused) * @return boolean True on success * @since 1.5 */ function uninstall( $id, $clientId ) { // Initialize variables $row = null; $retval = true; $db =& $this->parent->getDBO(); // 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('module'); if ( !$row->load((int) $id) ) { JError::raiseWarning(100, JText::_('ERRORUNKOWNEXTENSION')); return false; } // Is the module we are trying to uninstall a core one? // Because that is not a good idea... if ($row->iscore) { JError::raiseWarning(100, JText::_('Module').' '.JText::_('Uninstall').': '.JText::sprintf('WARNCOREMODULE', $row->name)."<br />".JText::_('WARNCOREMODULE2')); return false; } // Get the extension root path jimport('joomla.application.helper'); $client =& JApplicationHelper::getClientInfo($row->client_id); if ($client === false) { $this->parent->abort(JText::_('Module').' '.JText::_('Uninstall').': '.JText::_('Unknown client type').' ['.$row->client_id.']'); return false; } $this->parent->setPath('extension_root', $client->path.DS.'modules'.DS.$row->module); // Get the package manifest objecct $this->parent->setPath('source', $this->parent->getPath('extension_root')); $manifest =& $this->parent->getManifest(); if (!is_a($manifest, 'JSimpleXML')) { // Make sure we delete the folders JFolder::delete($this->parent->getPath('extension_root')); JError::raiseWarning(100, 'Module Uninstall: Package manifest file invalid or not found'); return false; } // Remove other files $root =& $manifest->document; $this->parent->removeFiles($root->getElementByPath('media')); $this->parent->removeFiles($root->getElementByPath('languages'), $clientId); $this->parent->removeFiles($root->getElementByPath('administration/languages'), 1); // Lets delete all the module copies for the type we are uninstalling $query = 'SELECT `id`' . ' FROM `#__modules`' . ' WHERE module = '.$db->Quote($row->module) . ' AND client_id = '.(int)$row->client_id; $db->setQuery($query); $modules = $db->loadResultArray(); // Do we have any module copies? if (count($modules)) { JArrayHelper::toInteger($modules); $modID = implode(',', $modules); $query = 'DELETE' . ' FROM #__modules_menu' . ' WHERE moduleid IN ('.$modID.')'; $db->setQuery($query); if (!$db->query()) { JError::raiseWarning(100, JText::_('Module').' '.JText::_('Uninstall').': '.$db->stderr(true)); $retval = false; } } // Now we will no longer need the module object, so lets delete it and free up memory $row->delete($row->id); $query = 'DELETE FROM `#__modules` WHERE module = '.$db->Quote($row->module) . ' AND client_id = ' . $row->client_id; $db->setQuery($query); $db->Query(); // clean up any other ones that might exist as well unset ($row); // Remove the installation folder if (!JFolder::delete($this->parent->getPath('extension_root'))) { // JFolder should raise an error $retval = false; } return $retval; } /** * Custom rollback method * - Roll back the menu item * * @access public * @param array $arg Installation step to rollback * @return boolean True on success * @since 1.5 */ function _rollback_menu($arg) { // Get database connector object $db =& $this->parent->getDBO(); // Remove the entry from the #__modules_menu table $query = 'DELETE' . ' FROM `#__modules_menu`' . ' WHERE moduleid='.(int)$arg['id']; $db->setQuery($query); return ($db->query() !== false); } /** * Custom rollback method * - Roll back the module item * * @access public * @param array $arg Installation step to rollback * @return boolean True on success * @since 1.5 */ function _rollback_module($arg) { // Get database connector object $db =& $this->parent->getDBO(); // Remove the entry from the #__modules table $query = 'DELETE' . ' FROM `#__modules`' . ' WHERE id='.(int)$arg['id']; $db->setQuery($query); return ($db->query() !== false); } }