/libraries/cms/installer/adapter/template.php
PHP | 664 lines | 397 code | 107 blank | 160 comment | 43 complexity | 88c9d2096b3db6b5e44d10cc8409b5d9 MD5 | raw file
- <?php
- /**
- * @package Joomla.Libraries
- * @subpackage Installer
- *
- * @copyright Copyright (C) 2005 - 2013 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.base.adapterinstance');
- jimport('joomla.filesystem.folder');
- /**
- * Template installer
- *
- * @package Joomla.Libraries
- * @subpackage Installer
- * @since 3.1
- */
- class JInstallerAdapterTemplate extends JAdapterInstance
- {
- /**
- * Copy of the XML manifest file
- *
- * @var string
- * @since 3.1
- */
- protected $manifest = null;
- /**
- * Name of the extension
- *
- * @var string
- * @since 3.1
- * */
- protected $name = null;
- /**
- * The unique identifier for the extension (e.g. mod_login)
- *
- * @var string
- * @since 3.1
- * */
- protected $element = null;
- /**
- * Method of system
- *
- * @var string
- *
- * @since 3.1
- */
- protected $route = 'install';
- /**
- * Custom loadLanguage method
- *
- * @param string $path The path where to find language files.
- *
- * @return JInstallerTemplate
- *
- * @since 3.1
- */
- public function loadLanguage($path = null)
- {
- $source = $this->parent->getPath('source');
- if (!$source)
- {
- $this->parent
- ->setPath(
- 'source',
- ($this->parent->extension->client_id ? JPATH_ADMINISTRATOR : JPATH_SITE) . '/templates/' . $this->parent->extension->element
- );
- }
- $this->manifest = $this->parent->getManifest();
- $name = strtolower(JFilterInput::getInstance()->clean((string) $this->manifest->name, 'cmd'));
- $client = (string) $this->manifest->attributes()->client;
- // Load administrator language if not set.
- if (!$client)
- {
- $client = 'ADMINISTRATOR';
- }
- $extension = "tpl_$name";
- $lang = JFactory::getLanguage();
- $source = $path ? $path : ($this->parent->extension->client_id ? JPATH_ADMINISTRATOR : JPATH_SITE) . '/templates/' . $name;
- $lang->load($extension . '.sys', $source, null, false, false)
- || $lang->load($extension . '.sys', constant('JPATH_' . strtoupper($client)), null, false, false)
- || $lang->load($extension . '.sys', $source, $lang->getDefault(), false, false)
- || $lang->load($extension . '.sys', constant('JPATH_' . strtoupper($client)), $lang->getDefault(), false, false);
- }
- /**
- * Custom install method
- *
- * @return boolean True on success
- *
- * @since 3.1
- */
- public function install()
- {
- // Get a database connector object
- $db = $this->parent->getDbo();
- $lang = JFactory::getLanguage();
- $xml = $this->parent->getManifest();
- // Get the client application target
- if ($cname = (string) $xml->attributes()->client)
- {
- // Attempt to map the client to a base path
- $client = JApplicationHelper::getClientInfo($cname, true);
- if ($client === false)
- {
- $this->parent->abort(JText::sprintf('JLIB_INSTALLER_ABORT_TPL_INSTALL_UNKNOWN_CLIENT', $cname));
- 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 extension's name
- $name = JFilterInput::getInstance()->clean((string) $xml->name, 'cmd');
- $element = strtolower(str_replace(" ", "_", $name));
- $this->set('name', $name);
- $this->set('element', $element);
- // Check to see if a template by the same name is already installed.
- $query = $db->getQuery(true)
- ->select($db->quoteName('extension_id'))
- ->from($db->quoteName('#__extensions'))
- ->where($db->quoteName('type') . ' = ' . $db->quote('template'))
- ->where($db->quoteName('element') . ' = ' . $db->quote($element));
- $db->setQuery($query);
- try
- {
- $id = $db->loadResult();
- }
- catch (RuntimeException $e)
- {
- // Install failed, roll back changes
- $this->parent->abort(JText::sprintf('JLIB_INSTALLER_ABORT_TPL_INSTALL_ROLLBACK'), $e->getMessage());
- return false;
- }
- // Set the template root path
- $this->parent->setPath('extension_root', $basePath . '/templates/' . $element);
- // If it's on the fs...
- if (file_exists($this->parent->getPath('extension_root')) && (!$this->parent->isOverwrite() || $this->parent->isUpgrade()))
- {
- $updateElement = $xml->update;
- // Upgrade manually set or update tag detected
- if ($this->parent->isUpgrade() || $updateElement)
- {
- // Force this one
- $this->parent->setOverwrite(true);
- $this->parent->setUpgrade(true);
- if ($id)
- {
- // If there is a matching extension mark this as an update; semantics really
- $this->route = 'update';
- }
- }
- elseif (!$this->parent->isOverwrite())
- {
- // Overwrite is not set
- // If we didn't have overwrite set, find an update function or find an update tag so let's call it safe
- $this->parent
- ->abort(
- JText::sprintf(
- 'JLIB_INSTALLER_ABORT_TPL_INSTALL_ANOTHER_TEMPLATE_USING_DIRECTORY', JText::_('JLIB_INSTALLER_' . $this->route),
- $this->parent->getPath('extension_root')
- )
- );
- return false;
- }
- }
- /*
- * If the template directory already exists, then we will assume that the template is already
- * installed or another template is using that directory.
- */
- if (file_exists($this->parent->getPath('extension_root')) && !$this->parent->isOverwrite())
- {
- JLog::add(
- JText::sprintf('JLIB_INSTALLER_ABORT_TPL_INSTALL_ANOTHER_TEMPLATE_USING_DIRECTORY', $this->parent->getPath('extension_root')),
- JLog::WARNING, 'jerror'
- );
- return false;
- }
- // If the template 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_TPL_INSTALL_FAILED_CREATE_DIRECTORY', $this->parent->getPath('extension_root')));
- return false;
- }
- }
- // If we created the template 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 the necessary files
- if ($this->parent->parseFiles($xml->files, -1) === false)
- {
- // Install failed, rollback changes
- $this->parent->abort();
- return false;
- }
- if ($this->parent->parseFiles($xml->images, -1) === false)
- {
- // Install failed, rollback changes
- $this->parent->abort();
- return false;
- }
- if ($this->parent->parseFiles($xml->css, -1) === false)
- {
- // Install failed, rollback changes
- $this->parent->abort();
- return false;
- }
- // Parse optional tags
- $this->parent->parseMedia($xml->media);
- $this->parent->parseLanguages($xml->languages, $clientId);
- // Get the template description
- $this->parent->set('message', JText::_((string) $xml->description));
- // Lastly, we will copy the manifest file to its appropriate place.
- if (!$this->parent->copyManifest(-1))
- {
- // Install failed, rollback changes
- $this->parent->abort(JText::_('JLIB_INSTALLER_ABORT_TPL_INSTALL_COPY_SETUP'));
- return false;
- }
- /**
- * ---------------------------------------------------------------------------------------------
- * Extension Registration
- * ---------------------------------------------------------------------------------------------
- */
- $row = JTable::getInstance('extension');
- if ($this->route == 'update' && $id)
- {
- $row->load($id);
- }
- else
- {
- $row->type = 'template';
- $row->element = $this->get('element');
- // There is no folder for templates
- $row->folder = '';
- $row->enabled = 1;
- $row->protected = 0;
- $row->access = 1;
- $row->client_id = $clientId;
- $row->params = $this->parent->getParams();
- // Custom data
- $row->custom_data = '';
- }
- // Name might change in an update
- $row->name = $this->get('name');
- $row->manifest_cache = $this->parent->generateManifestCache();
- if (!$row->store())
- {
- // Install failed, roll back changes
- $this->parent->abort(JText::sprintf('JLIB_INSTALLER_ABORT_TPL_INSTALL_ROLLBACK', $db->stderr(true)));
- return false;
- }
- if ($this->route == 'install')
- {
- $debug = $lang->setDebug(false);
- $columns = array($db->quoteName('template'),
- $db->quoteName('client_id'),
- $db->quoteName('home'),
- $db->quoteName('title'),
- $db->quoteName('params')
- );
- $values = array(
- $db->quote($row->element), $clientId, $db->quote(0),
- $db->quote(JText::sprintf('JLIB_INSTALLER_DEFAULT_STYLE', JText::_($this->get('name')))),
- $db->quote($row->params) );
- $lang->setDebug($debug);
- // Insert record in #__template_styles
- $query = $db->getQuery(true)
- ->insert($db->quoteName('#__template_styles'))
- ->columns($columns)
- ->values(implode(',', $values));
- $db->setQuery($query);
- // There is a chance this could fail but we don't care...
- $db->execute();
- }
- return $row->get('extension_id');
- }
- /**
- * Custom update method for components
- *
- * @return boolean True on success
- *
- * @since 3.1
- */
- public function update()
- {
- $this->route = 'update';
- return $this->install();
- }
- /**
- * Custom uninstall method
- *
- * @param integer $id The extension ID
- *
- * @return boolean True on success
- *
- * @since 3.1
- */
- public function uninstall($id)
- {
- $retval = true;
- // First order of business will be to load the template 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))
- {
- JLog::add(JText::_('JLIB_INSTALLER_ERROR_TPL_UNINSTALL_ERRORUNKOWNEXTENSION'), JLog::WARNING, 'jerror');
- return false;
- }
- // Is the template we are trying to uninstall a core one?
- // Because that is not a good idea...
- if ($row->protected)
- {
- JLog::add(JText::sprintf('JLIB_INSTALLER_ERROR_TPL_UNINSTALL_WARNCORETEMPLATE', $row->name), JLog::WARNING, 'jerror');
- return false;
- }
- $name = $row->element;
- $clientId = $row->client_id;
- // For a template the id will be the template name which represents the subfolder of the templates folder that the template resides in.
- if (!$name)
- {
- JLog::add(JText::_('JLIB_INSTALLER_ERROR_TPL_UNINSTALL_TEMPLATE_ID_EMPTY'), JLog::WARNING, 'jerror');
- return false;
- }
- // Deny remove default template
- $db = $this->parent->getDbo();
- $query = "SELECT COUNT(*) FROM #__template_styles WHERE home = '1' AND template = " . $db->quote($name);
- $db->setQuery($query);
- if ($db->loadResult() != 0)
- {
- JLog::add(JText::_('JLIB_INSTALLER_ERROR_TPL_UNINSTALL_TEMPLATE_DEFAULT'), JLog::WARNING, 'jerror');
- return false;
- }
- // Get the template root path
- $client = JApplicationHelper::getClientInfo($clientId);
- if (!$client)
- {
- JLog::add(JText::_('JLIB_INSTALLER_ERROR_TPL_UNINSTALL_INVALID_CLIENT'), JLog::WARNING, 'jerror');
- return false;
- }
- $this->parent->setPath('extension_root', $client->path . '/templates/' . strtolower($name));
- $this->parent->setPath('source', $this->parent->getPath('extension_root'));
- // We do findManifest to avoid problem when uninstalling a list of extensions: getManifest cache its manifest file
- $this->parent->findManifest();
- $manifest = $this->parent->getManifest();
- if (!($manifest instanceof SimpleXMLElement))
- {
- // Kill the extension entry
- $row->delete($row->extension_id);
- unset($row);
- // Make sure we delete the folders
- JFolder::delete($this->parent->getPath('extension_root'));
- JLog::add(JText::_('JLIB_INSTALLER_ERROR_TPL_UNINSTALL_INVALID_NOTFOUND_MANIFEST'), JLog::WARNING, 'jerror');
- return false;
- }
- // Remove files
- $this->parent->removeFiles($manifest->media);
- $this->parent->removeFiles($manifest->languages, $clientId);
- // Delete the template directory
- if (JFolder::exists($this->parent->getPath('extension_root')))
- {
- $retval = JFolder::delete($this->parent->getPath('extension_root'));
- }
- else
- {
- JLog::add(JText::_('JLIB_INSTALLER_ERROR_TPL_UNINSTALL_TEMPLATE_DIRECTORY'), JLog::WARNING, 'jerror');
- $retval = false;
- }
- // Set menu that assigned to the template back to default template
- $query = 'UPDATE #__menu'
- . ' SET template_style_id = 0'
- . ' WHERE template_style_id in ('
- . ' SELECT s.id FROM #__template_styles s'
- . ' WHERE s.template = ' . $db->quote(strtolower($name)) . ' AND s.client_id = ' . $clientId . ')';
- $db->setQuery($query);
- $db->execute();
- $query = 'DELETE FROM #__template_styles WHERE template = ' . $db->quote($name) . ' AND client_id = ' . $clientId;
- $db->setQuery($query);
- $db->execute();
- $row->delete($row->extension_id);
- unset($row);
- return $retval;
- }
- /**
- * Discover existing but uninstalled templates
- *
- * @return array JExtensionTable list
- */
- public function discover()
- {
- $results = array();
- $site_list = JFolder::folders(JPATH_SITE . '/templates');
- $admin_list = JFolder::folders(JPATH_ADMINISTRATOR . '/templates');
- $site_info = JApplicationHelper::getClientInfo('site', true);
- $admin_info = JApplicationHelper::getClientInfo('administrator', true);
- foreach ($site_list as $template)
- {
- if ($template == 'system')
- {
- // Ignore special system template
- continue;
- }
- $manifest_details = JInstaller::parseXMLInstallFile(JPATH_SITE . "/templates/$template/templateDetails.xml");
- $extension = JTable::getInstance('extension');
- $extension->set('type', 'template');
- $extension->set('client_id', $site_info->id);
- $extension->set('element', $template);
- $extension->set('folder', '');
- $extension->set('name', $template);
- $extension->set('state', -1);
- $extension->set('manifest_cache', json_encode($manifest_details));
- $extension->set('params', '{}');
- $results[] = $extension;
- }
- foreach ($admin_list as $template)
- {
- if ($template == 'system')
- {
- // Ignore special system template
- continue;
- }
- $manifest_details = JInstaller::parseXMLInstallFile(JPATH_ADMINISTRATOR . "/templates/$template/templateDetails.xml");
- $extension = JTable::getInstance('extension');
- $extension->set('type', 'template');
- $extension->set('client_id', $admin_info->id);
- $extension->set('element', $template);
- $extension->set('folder', '');
- $extension->set('name', $template);
- $extension->set('state', -1);
- $extension->set('manifest_cache', json_encode($manifest_details));
- $extension->set('params', '{}');
- $results[] = $extension;
- }
- return $results;
- }
- /**
- * Discover_install
- * Perform an install for a discovered extension
- *
- * @return boolean
- *
- * @since 3.1
- */
- public function discover_install()
- {
- // Templates are one of the easiest
- // If its not in the extensions table we just add it
- $client = JApplicationHelper::getClientInfo($this->parent->extension->client_id);
- $manifestPath = $client->path . '/templates/' . $this->parent->extension->element . '/templateDetails.xml';
- $this->parent->manifest = $this->parent->isManifest($manifestPath);
- $description = (string) $this->parent->manifest->description;
- if ($description)
- {
- $this->parent->set('message', JText::_($description));
- }
- else
- {
- $this->parent->set('message', '');
- }
- $this->parent->setPath('manifest', $manifestPath);
- $manifest_details = JInstaller::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;
- $data = new JObject;
- foreach ($manifest_details as $key => $value)
- {
- $data->set($key, $value);
- }
- $this->parent->extension->params = $this->parent->getParams();
- if ($this->parent->extension->store())
- {
- $db = $this->parent->getDbo();
- // Insert record in #__template_styles
- $lang = JFactory::getLanguage();
- $debug = $lang->setDebug(false);
- $columns = array($db->quoteName('template'),
- $db->quoteName('client_id'),
- $db->quoteName('home'),
- $db->quoteName('title'),
- $db->quoteName('params')
- );
- $query = $db->getQuery(true)
- ->insert($db->quoteName('#__template_styles'))
- ->columns($columns)
- ->values(
- $db->quote($this->parent->extension->element)
- . ',' . $db->quote($this->parent->extension->client_id)
- . ',' . $db->quote(0)
- . ',' . $db->quote(JText::sprintf('JLIB_INSTALLER_DEFAULT_STYLE', $this->parent->extension->name))
- . ',' . $db->quote($this->parent->extension->params)
- );
- $lang->setDebug($debug);
- $db->setQuery($query);
- $db->execute();
- return $this->parent->extension->get('extension_id');
- }
- else
- {
- JLog::add(JText::_('JLIB_INSTALLER_ERROR_TPL_DISCOVER_STORE_DETAILS'), JLog::WARNING, 'jerror');
- return false;
- }
- }
- /**
- * Refreshes the extension table cache
- *
- * @return boolean Result of operation, true if updated, false on failure
- *
- * @since 3.1
- */
- public function refreshManifestCache()
- {
- // Need to find to find where the XML file is since we don't store this normally.
- $client = JApplicationHelper::getClientInfo($this->parent->extension->client_id);
- $manifestPath = $client->path . '/templates/' . $this->parent->extension->element . '/templateDetails.xml';
- $this->parent->manifest = $this->parent->isManifest($manifestPath);
- $this->parent->setPath('manifest', $manifestPath);
- $manifest_details = JInstaller::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 (RuntimeException $e)
- {
- JLog::add(JText::_('JLIB_INSTALLER_ERROR_TPL_REFRESH_MANIFEST_CACHE'), JLog::WARNING, 'jerror');
- return false;
- }
- }
- }
- /**
- * Deprecated class placeholder. You should use JInstallerAdapterTemplate instead.
- *
- * @package Joomla.Libraries
- * @subpackage Installer
- * @since 3.1
- * @deprecated 4.0
- * @codeCoverageIgnore
- */
- class JInstallerTemplate extends JInstallerAdapterTemplate
- {
- }