plugins/system/jsntplframework/libraries/joomlashine/helper.php

<?php
/**
 * @version     $Id$
 * @package     JSNExtension
 * @subpackage  JSNTplFramework
 * @author      JoomlaShine Team <support@joomlashine.com>
 * @copyright   Copyright (C) 2012 JoomlaShine.com. All Rights Reserved.
 * @license     GNU/GPL v2 or later http://www.gnu.org/licenses/gpl-2.0.html
 *
 * Websites: http://www.joomlashine.com
 * Technical Support:  Feedback - http://www.joomlashine.com/contact-us/get-support.html
 */

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// Import necessary Joomla libraries
jimport('joomla.filesystem.folder');
jimport('joomla.filesystem.file');
jimport('joomla.registry.registry');

/**
 * This class contains common method will be used in
 * the template framework
 *
 * @package     JSNTplFramework
 * @since       1.0.0
 */
abstract class JSNTplHelper
{
	/**
	 * JVersion instance
	 *
	 * @var  JVersion
	 */
	private static $_version;

	private static $_versionData;

	private static $_disabledFunctions;

	/**
	 * Load templateDetails.xml using simplexml and return it
	 *
	 * @param   string   $template  The template name.
	 * @param   boolean  $reRead    Re-read manifest file if already read before.
	 *
	 * @return  object
	 */
	public static function getManifest ($template, $reRead = false)
	{
		$registry = JRegistry::getInstance('JSNTplFramework');

		if ( ! $reRead AND $registry->exists('template.manifest'))
		{
			return $registry->get('template.manifest');
		}

		$xmlDocument = simplexml_load_file(JPATH_SITE . "/templates/{$template}/templateDetails.xml");
		$registry->set('template.manifest', $xmlDocument);

		return $xmlDocument;
	}

	/**
	 *
	 * @return boolean [description]
	 */
	public static function isDisabledFunction ($name)
	{
		return ! (function_exists($name) AND ! ini_get('safe_mode'));
	}

	/**
	 * Retrieve cached manifest from the database
	 *
	 * @param   string  $template  Template name
	 * @return  array
	 */
	public static function getManifestCache ($template)
	{
		$registry = JRegistry::getInstance('JSNTplFramework');

		$dbo = JFactory::getDBO();
		$query = $dbo->getQuery(true);
		$query->select('manifest_cache')
			->from('#__extensions')
			->where('element LIKE \'' . $template . '\'');
		$dbo->setQuery($query);

		return json_decode($dbo->loadResult());
	}

	/**
	 * Retrieve current version of Joomla
	 *
	 * @return  string
	 */
	public static function getJoomlaVersion ($size = null, $includeDot = true)
	{
		$joomlaVersion = new JVersion();
		$versionPieces = explode('.', $joomlaVersion->getShortVersion());

		if (is_numeric($size) && $size > 0 && $size < count($versionPieces)) {
			$versionPieces = array_slice($versionPieces, 0, $size);
		}

		return implode($includeDot === true ? '.' : '', $versionPieces);
	}

	/**
	 * Return the template ID
	 *
	 * @param   string  $name  The template name
	 *
	 * @return  string
	 */
	public static function getTemplateId ($name)
	{
		if ($details = JSNTplTemplateRecognization::detect($name))
		{
			return strtolower("tpl_{$details->name}");
		}

		// Backward compatible
		$manifest = self::getManifest($name);

		if (isset($manifest->identifiedName)) {
			return (string) $manifest->identifiedName;
		}

		if (preg_match('/^jsn_(.*)_(free|pro)$/i', $name, $matched)) {
			return sprintf('tpl_%s', $matched[1]);
		}
	}

	/**
	 * Get template version.
	 *
	 * @param   string  $template  Name of template directory.
	 *
	 * @return  string
	 */
	public static function getTemplateVersion($template)
	{
		if (class_exists('JSNTplTemplateRecognization') AND $details = JSNTplTemplateRecognization::detect($template))
		{
			return $details->version;
		}

		// Backward compatible
		$const = strtoupper(preg_replace('/(free|pro)$/i', 'version', $template));

		if ( ! defined($const) AND is_readable(JPATH_ROOT . '/templates/' . $template . '/template.defines.php'))
		{
			require_once JPATH_ROOT . '/templates/' . $template . '/template.defines.php';
		}

		// Get template version from constant if defined
		if (defined($const))
		{
			eval('$version = ' . $const . ';');
		}
		// Get template version from manifest cache if constant is not defined
		else
		{
			$version = self::getManifestCache($template);
			$version = $version->version;
		}

		return $version;
	}

	/**
	 * Retrieve edition of the template that determined by name
	 *
	 * @param   string  $name  The template name to retrieve edition
	 * @return  string
	 */
	public static function getTemplateEdition ($name)
	{
		if ($details = JSNTplTemplateRecognization::detect($name))
		{
			return $details->edition;
		}

		// Backward compatible
		$registry = JRegistry::getInstance('JSNTplFramework');

		if ($registry->exists('template.edition')) {
			return $registry->get('template.edition');
		}

		$manifest = JSNTplHelper::getManifest($name);
		$edition  = isset($manifest->edition) ? (string) $manifest->edition : 'FREE';

		$registry->set('template.edition', $edition);
		return $edition;
	}

	/**
	 * Fetch all installed extensions from the database
	 *
	 * @return  array
	 */
	public static function findInstalledExtensions ()
	{
		$registry = JRegistry::getInstance('JSNTplFramework');
		$installedExtensions = $registry->get('extension.installed', array());

		if (empty($installedExtensions))
		{
			$db	= JFactory::getDbo();
			$q	= $db->getQuery(true);

			$q->select('element, manifest_cache');
			$q->from('#__extensions');
			$q->where('type IN ("component", "plugin", "module")');

			$db->setQuery($q);

			foreach ($db->loadObjectList() AS $extension)
			{
				$installedExtensions[$extension->element] = json_decode($extension->manifest_cache);
			}

			$registry->set('extension.installed', $installedExtensions);
		}

		return $installedExtensions;
	}

	/**
	 * Return TRUE when PRO Edition of the template is installed
	 *
	 * @param   string  $template  The template name
	 *
	 * @return  boolean
	 */
	public static function isInstalledProEdition ($template)
	{
		if (preg_match('/^jsn_(.*)_(free|pro)$/i', $template, $matched)) {
			$nameOfProEdition = sprintf('jsn_%s_pro', $matched[1]);

			$db	= JFactory::getDbo();
			$q	= $db->getQuery(true);

			$q->select('COUNT(*)');
			$q->from('#__extensions');
			$q->where('type = ' . $q->quote('template'));
			$q->where('element = ' . $q->quote($nameOfProEdition));

			$db->setQuery($q);

			return intval($db->loadResult()) > 0;
		}

		return false;
	}

	/**
	 * Return TRUE when extension with name=$name is installed
	 *
	 * @param   string   $name  The name of extension
	 *
	 * @return  boolean
	 */
	public static function isInstalledExtension ($name)
	{
		$installedExtensions = self::findInstalledExtensions();
		return isset($installedExtensions[$name]);
	}

	/**
	 * List all modified files of the template
	 *
	 * @param   string  $template  The template name
	 *
	 * @return  mixed
	 */
	public static function getModifiedFiles ($template)
	{
		jimport('joomla.filesystem.folder');

		$templatePath = JPATH_SITE . "/templates/{$template}";
		$checksumFile = $templatePath . '/template.checksum';

		if ( ! is_file($checksumFile))
		{
			return false;
		}

		$files = JFile::read($checksumFile);
		$hashTable = array();

		// Parse all hash data from checksum file
		foreach (explode("\n", $files) AS $line)
		{
			$line = trim($line);

			if ( ! empty($line) AND strpos($line, "\t") !== false)
			{
				list($path, $hash) = explode("\t", $line);
				$hashTable[$path] = $hash;
			}
		}

		// Define regex pattern of file to be excluded
		$exclude = '#(/*backups?/|template\.checksum|template\.defines\.php|templateDetails\.xml|editions\.json|\.svn|CVS|language)#';

		// Find all files in template folder and check it state
		$files = JFolder::files($templatePath, '.', true, true);

		$addedFiles = array();
		$changedFiles = array();
		$deletedFiles = array();
		$originalFiles = array();

		foreach ($files AS $file)
		{
			// Fine-tune file path
			$file = str_replace('\\', '/', $file);

			if ( ! preg_match($exclude, $file))
			{
				$fileMd5 = md5_file($file);
				$file = str_replace(DIRECTORY_SEPARATOR, '/', $file);
				$file = ltrim(substr($file, strlen($templatePath)), '/');

				// Checking file is added
				if ( ! isset($hashTable[$file]))
				{
					$addedFiles[] = $file;
				}
				// Checking file is changed
				elseif (isset($hashTable[$file]) && $fileMd5 != $hashTable[$file])
				{
					$changedFiles[] = $file;
				}
				// Checking file is original
				elseif (isset($hashTable[$file]) && $fileMd5 == $hashTable[$file])
				{
					$originalFiles[] = $file;
				}
			}
		}

		$templateFiles = array_merge($addedFiles, $changedFiles, $originalFiles);
		$templateFiles = array_unique($templateFiles);

		// Find all deleted files
		foreach (array_keys($hashTable) AS $item)
		{
			if ( ! preg_match($exclude, $item))
			{
				if ( ! in_array($item, $templateFiles))
				{
					$deletedFiles[] = $item;
				}
			}
		}

		return array(
			'add'		=> $addedFiles,
			'edit'		=> $changedFiles,
			'delete'	=> $deletedFiles
		);
	}

	/**
	 * List all files that are being updated.
	 *
	 * @param   string  $template  The template name
	 * @param   string  $path      Path to downloaded template update package
	 *
	 * @return  mixed
	 */
	public static function getFilesBeingUpdated($template, $path)
	{
		jimport('joomla.filesystem.archive');

		// Extract template update package
		$file = $path;
		$path = dirname($file) . '/' . substr(basename($file), 0, -4);

		if ( ! JArchive::extract($file, $path))
		{
			throw new Exception(JText::_('JSN_TPLFW_ERROR_DOWNLOAD_PACKAGE_FILE_NOT_FOUND'));
		}

		// Read checksum file included in update package
		$checksumFile = $path . '/template/template.checksum';

		if ( ! is_readable($checksumFile))
		{
			return false;
		}

		$files = JFile::read($checksumFile);
		$newHash = array();

		// Parse all hash data from checksum file
		foreach (explode("\n", $files) AS $line)
		{
			$line = trim($line);

			if ( ! empty($line) AND strpos($line, "\t") !== false)
			{
				list($path, $hash) = explode("\t", $line);
				$newHash[$path] = $hash;
			}
		}

		// Read checksum file of currently installed template
		$checksumFile = JPATH_SITE . "/templates/{$template}/template.checksum";

		if ( ! is_readable($checksumFile))
		{
			return false;
		}

		$files = JFile::read($checksumFile);
		$oldHash = array();

		// Parse all hash data from checksum file
		foreach (explode("\n", $files) AS $line)
		{
			$line = trim($line);

			if ( ! empty($line) AND strpos($line, "\t") !== false)
			{
				list($path, $hash) = explode("\t", $line);
				$oldHash[$path] = $hash;
			}
		}

		// Preset some arrays
		$addedFiles		= array();
		$changedFiles	= array();
		$removedFiles	= array();

		foreach ($oldHash AS $path => $checkum)
		{
			// Check if file is removed
			if ( ! isset($newHash[$path]))
			{
				$removedFiles[] = $path;
			}
			// Check if file is changed
			elseif (isset($newHash[$path]) && $checkum != $newHash[$path])
			{
				$changedFiles[] = $path;
			}
		}

		foreach ($newHash AS $path => $checkum)
		{
			// Check if file is newly added
			if ( ! isset($oldHash[$path]))
			{
				$addedFiles[] = $path;
			}
		}

		return array(
			'add'		=> $addedFiles,
			'edit'		=> $changedFiles,
			'delete'	=> $removedFiles
		);
	}

	/**
	 * List all modified files that are being updated.
	 *
	 * @param   string  $template  The template name
	 * @param   string  $path      Path to downloaded template update package
	 *
	 * @return  mixed
	 */
	public static function getModifiedFilesBeingUpdated($template, $path)
	{
		$modifiedFiles = array();

		// Get list of files being updated
		if ($filesBeingUpdated = self::getFilesBeingUpdated($template, $path))
		{
			// Merge difference type of modification
			$filesBeingUpdated = call_user_func_array('array_merge', $filesBeingUpdated);

			// Now check if any file being updated is manually modified by user
			foreach (self::getModifiedFiles($template) AS $k => $v)
			{
				if ($k != 'delete')
				{
					foreach ($v AS $file)
					{
						if (in_array($file, $filesBeingUpdated))
						{
							$modifiedFiles[] = $file;
						}
					}
				}
			}
		}

		return $modifiedFiles;
	}

	/**
	 * Find latest backup file
	 *
	 * @param   string  $template  Name of template to find backup files
	 *
	 * @return  array
	 */
	public static function findLatestBackup($template)
	{
		$templatePath = JPATH_ROOT . '/templates/' . $template . '/backups';
		$backupFile = null;

		$zipFiles = glob($templatePath . '/*_modified_files.zip');

		if ($zipFiles !== false)
		{
			foreach ($zipFiles AS $file)
			{
				if ($backupFile == null OR filemtime($backupFile) < filemtime($file))
				{
					$backupFile = $file;
				}
			}
		}

		return $backupFile;
	}

	/**
	 * Download templates information data from JoomlaShine server
	 *
	 * @return  object
	 */
	public static function getVersionData ()
	{
		if (empty(self::$_versionData))
		{
			try
			{
				$response = JSNTplHttpRequest::get(JSN_TPLFRAMEWORK_VERSIONING_URL . '?category=cat_template');
			}
			catch (Exception $e)
			{
				throw $e;
			}

			self::$_versionData = json_decode($response['body'], true);
		}

		// Return result
		return self::$_versionData;
	}

	/**
	 * Make a nested path , creating directories down the path
	 * recursion !!
	 *
	 * @param   string  $path  Path to create directories
	 *
	 * @return  void
	 */
	public static function makePath ($path)
	{
		// Check if directory already exists
		if (is_dir($path) OR empty($path))
		{
			return true;
		}

		// Ensure a file does not already exist with the same name
		$path = str_replace(array('/', '\\'), DIRECTORY_SEPARATOR, $path);

		if (is_file($path))
		{
			trigger_error('A file with the same name already exists', E_USER_WARNING);
			return false;
		}

		// Crawl up the directory tree
		$nextPath = substr($path, 0, strrpos($path, DIRECTORY_SEPARATOR));

		if (self::makePath($nextPath))
		{
			if ( ! is_dir($path))
			{
				return JFolder::create($path);
			}
		}

		return false;
	}
}