<?php
/**
 * Akeeba Engine
 * The modular PHP5 site backup engine
 * @copyright Copyright (c)2009-2011 Nicholas K. Dionysopoulos
 * @license GNU GPL version 3 or, at your option, any later version
 * @package akeebaengine
 * @version $Id: quirks.php 409 2011-01-24 09:30:22Z nikosdion $
 */

// Protection against direct access
defined('AKEEBAENGINE') or die('Restricted access');

/**
 * Quirk detection helper class
 */
class AEUtilQuirks
{

	/**
	 * Returns the output & temporary folder writability status
	 * @return array A hash array with the writability status
	 */
	public static function get_folder_status()
	{
		static $status = null;

		if(is_null($status))
		{
			$stock_dirs = AEPlatform::get_stock_directories();

			// Get output writable status
			$registry =& AEFactory::getConfiguration();
			$outdir = $registry->get('akeeba.basic.output_directory');
			foreach( $stock_dirs as $macro => $replacement )
			{
				$outdir = str_replace($macro, $replacement, $outdir);
			}
			$status['output']= @is_writable($outdir);

			// Get temp writable status
			$tempdir = $registry->get('akeeba.basic.temporary_directory');
			foreach( $stock_dirs as $macro => $replacement )
			{
				$tempdir = str_replace($macro, $replacement, $tempdir);
			}
			$status['temporary'] = @is_writable($tempdir);
		}

		return $status;
	}

	/**
	 * Returns the overall status. It's true when both the temporary and
	 * output directories are writable and no critical severity quirks have
	 * been detected.
	 * @return bool
	 */
	public static function get_status()
	{
		// Base the status on directory writability
		$status = self::get_folder_status();
		$ret = $status['temporary'] && $status['output'];

		// Scan for high severity quirks
		$quirks = self::get_quirks();
		if(!empty($quirks))
		{
			foreach($quirks as $quirk)
			{
				if($quirk['severity'] == 'critical') $ret = false;
			}
		}

		// Return status
		return $ret;
	}

	/**
	 * Runs the "quirks" detection scripts. These are potential problems related to server
	 * configuration, out of Akeeba's control. They are intended to give the user a
	 * chance to fix them before they cause the backup to fail, eventually saving both
	 * the user's and support personel's time.
	 *
	 * "Quirks" numbering scheme:
	 * Q0xx No-go errors
	 * Q1xx	Critical system configuration errors
	 * Q2xx	Medium and low system configuration warnings
	 * Q3xx	Critical software configuration errors
	 * Q4xx	Medium and low component configuration warnings
	 *
	 * It populates and returns the $quirks array.
	 *
	 * @return array
	 */
	public static function get_quirks($low_priority = false)
	{
		static $quirks = null;

		if(is_null($quirks))
		{
			$quirks = array();
			self::getQuirk($quirks, '001', 'critical');
			self::getQuirk($quirks, '002', 'critical');
			self::getQuirk($quirks, '003', 'critical');

			self::getQuirk($quirks, '101', 'high');
			self::getQuirk($quirks, '102', 'high');
			self::getQuirk($quirks, '103', 'high');
			self::getQuirk($quirks, '104', 'high');

			self::getQuirk($quirks, '201', 'high');
			self::getQuirk($quirks, '202', 'medium');
			self::getQuirk($quirks, '204', 'medium');

			if($low_priority)
			{
				self::getQuirk($quirks, '203', 'low');
				self::getQuirk($quirks, '401', 'low');
			}
		}

		return $quirks;
	}

	/**
	 * Gets a "quirk" status and adds it to the list if it is active
	 *
	 * @param array $quirks The quirks array
	 * @param string $code The Quirks code, without the Q
	 * @param string $severity Severity: 'low','medium','high'
	 */
	private static function getQuirk( &$quirks, $code, $severity )
	{
		$methodName = 'q'.$code;
		if(self::$methodName())
		{
			$description = AEPlatform::translate('Q'.$code);
			$quirks[] = array(
				'code'			=> $code,
				'severity'		=> $severity,
				'description'	=> $description,
				'help_url'		=> 'http://www.akeebabackup.com/help-support-documentation/warnings/q'.$code.'.html'
				);
		}
	}

	/**
	 * Q001 - HIGH - Output directory unwritable
	 *
	 * @return bool
	 */
	private static function q001()
	{
		$status = self::get_folder_status();
		return !$status['output'];
	}

	/**
	 * Q002 - HIGH - Temporary directory unwritable
	 *
	 * @return bool
	 */
	private static function q002()
	{
		$status = self::get_folder_status();
		return !$status['temporary'];
	}

	/**
	 * Q003 - HIGH - Backup output or temporary set to site's root
	 *
	 * @return bool
	 */
	private static function q003()
	{
		$stock_dirs = AEPlatform::get_stock_directories();

		$registry =& AEFactory::getConfiguration();
		$outdir = $registry->get('akeeba.basic.output_directory');
		foreach( $stock_dirs as $macro => $replacement )
		{
			$outdir = str_replace($macro, $replacement, $outdir);
		}
		$tempdir = $registry->get('akeeba.basic.temporary_directory');
		foreach( $stock_dirs as $macro => $replacement )
		{
			$tempdir = str_replace($macro, $replacement, $tempdir);
		}

		$outdir_real = @realpath($outdir);
		if(!empty($outdir_real)) $outdir = $outdir_real;
		$tempdir_real = @realpath($tempdir);
		if(!empty($tempdir_real)) $tempdir = $tempdir_real;

		$siteroot = AEPlatform::get_site_root();
		$siteroot_real = @realpath($siteroot);
		if(!empty($siteroot_real)) $siteroot = $siteroot_real;

		return ($siteroot == $outdir) || ($siteroot == $tempdir);
	}

	/**
	 * Q101 - HIGH - open_basedir on output directory
	 *
	 * @return bool
	 */
	private static function q101()
	{
		$stock_dirs = AEPlatform::get_stock_directories();

		// Get output writable status
		$registry =& AEFactory::getConfiguration();
		$outdir = $registry->get('akeeba.basic.output_directory');
		foreach( $stock_dirs as $macro => $replacement )
		{
			$outdir = str_replace($macro, $replacement, $outdir);
		}
		return self::checkOpenBasedirs($outdir);
	}

	/**
	 * Q102 - HIGH - open_basedir on temporary directory (is it necessary?)
	 *
	 * @return bool
	 */
	private static function q102()
	{
		$stock_dirs = AEPlatform::get_stock_directories();

		// Get output writable status
		$registry =& AEFactory::getConfiguration();
		$tempdir = $registry->get('akeeba.basic.temporary_directory');
		foreach( $stock_dirs as $macro => $replacement )
		{
			$tempdir = str_replace($macro, $replacement, $tempdir);
		}
		return self::checkOpenBasedirs($tempdir);
	}

	/**
	 * Q103 - HIGH - Less than 10" of max_execution_time with PHP Safe Mode enabled
	 *
	 * @return bool
	 */
	private static function q103()
	{
		$exectime = ini_get('max_execution_time');
		$safemode = ini_get('safe_mode');
		if(!$safemode) return false;
		if(!is_numeric($exectime)) return false;
		if($exectime <= 0) return false;
		return $exectime < 10;
	}

	/**
	 * Q104 - HIGH - Using /tmp as temporary directory
	 *
	 * @return bool
	 */
	private static function q104()
	{
		$systemp = self::sys_get_temp_dir();
		if(empty($systemp)) return false;

		$stock_dirs = AEPlatform::get_stock_directories();

		// Get output writable status
		$registry =& AEFactory::getConfiguration();
		$tempdir = $registry->get('akeeba.basic.temporary_directory');
		foreach( $stock_dirs as $macro => $replacement )
		{
			$tempdir = str_replace($macro, $replacement, $tempdir);
		}

		$tempdir_real = @realpath($tempdir);
		if(!empty($tempdir_real)) $tempdir = $tempdir_real;

		return ($systemp == $tempdir);
	}

	/**
	 * Gets the system temporary directory's real path... or at least it tries hard to do so!
	 * @return unknown_type
	 */
	private static function sys_get_temp_dir() {
		// Try system environment variables
		if(function_exists('getenv'))
		{
			if( $temp=getenv('TMP') )		return $temp;
			if( $temp=getenv('TEMP') )		return $temp;
			if( $temp=getenv('TMPDIR') )	return $temp;
		}
		// Try sys_get_temp_dir()
		if(function_exists('sys_get_temp_dir'))
		{
			$temp = sys_get_temp_dir();
			if(!empty($temp))
			{
				$temp_real = @realpath($temp);
				if(!empty($temp_real)) $temp = $temp_real;
				return $temp;
			}
		}
		// Try creating a temp file
		$temp=@tempnam(__FILE__,'');
		if (file_exists($temp)) {
			unlink($temp);
			return dirname($temp);
		}

		// If all else fails...
		return '';
	}


	/**
	 * Q201 - HIGH  - PHP4 detected
	 * Note: Q201 was originally a LOW severity quirk, but Akeeba Engine 3 no longer
	 * works on PHP4.
	 * @return bool
	 */
	private static function q201()
	{
		return version_compare(PHP_VERSION,'5.0.0') < 0;
	}

	/**
	 * Q202 - MED  - CRC problems with hash extension not present
	 *
	 * @return bool
	 */
	private static function q202()
	{
		$registry =& AEFactory::getConfiguration();
		$archiver = $registry->get('akeeba.advanced.archiver_engine');
		if($archiver != 'zip') return false;
		return !function_exists('hash_file');
	}

	/**
	 * Q203 - MED  - Default output directory in use
	 *
	 * @return bool
	 */
	private static function q203()
	{
		$stock_dirs = AEPlatform::get_stock_directories();

		$registry =& AEFactory::getConfiguration();
		$outdir = $registry->get('akeeba.basic.output_directory');
		foreach( $stock_dirs as $macro => $replacement )
		{
			$outdir = str_replace($macro, $replacement, $outdir);
		}

		$default = $stock_dirs['[DEFAULT_OUTPUT]'];

		$outdir = AEUtilFilesystem::TranslateWinPath($outdir);
		$default = AEUtilFilesystem::TranslateWinPath($default);

		return $outdir == $default;
	}

	/**
	 * Q204 - MED  - Disabled functions may affect operation
	 *
	 * @return bool
	 */
	private static function q204()
	{
		$disabled = ini_get('disabled_functions');
		return (!empty($disabled));
	}

	/**
	 * Q401 - LOW  - ZIP format selected
	 *
	 * @return bool
	 */
	private static function q401()
	{
		$registry =& AEFactory::getConfiguration();
		$archiver = $registry->get('akeeba.advanced.archiver_engine');
		return $archiver == 'zip';
	}

	/**
	 * Checks if a path is restricted by open_basedirs
	 *
	 * @param string $check The path to check
	 * @return bool True if the path is restricted (which is bad)
	 */
	public static function checkOpenBasedirs($check)
	{
		static $paths;

		if(empty($paths))
		{
			$open_basedir = ini_get('open_basedir');
			if(empty($open_basedir)) return false;
			$delimiter = strpos($open_basedir, ';') !== false ? ';' : ':';
			$paths_temp = explode($delimiter, $open_basedir);

			// Some open_basedirs are using environemtn variables
			$paths = array();
			foreach($paths_temp as $path)
			{
				if(array_key_exists($path, $_ENV))
				{
					$paths[] = $_ENV[$path];
				}
				else
				{
					$paths[] = $path;
				}
			}
		}

		if(empty($paths))
		{
			return false; // no restrictions
		}
		else
		{
			$newcheck = @realpath($check); // Resolve symlinks, like PHP does
			if(!($newcheck === false)) $check = $newcheck;
			$included = false;
			foreach($paths as $path)
			{
				$newpath = @realpath($path);
				if(!($newpath === false)) $path = $newpath;
				if(strlen($check) >= strlen($path))
				{
					// Only check if the path to check is longer than the inclusion path.
					// Otherwise, I guarantee it's not included!!
					// If the path to check begins with an inclusion path, it's permitted. Easy, huh?
					if(substr($check,0,strlen($path)) == $path) $included = true;
				}
			}

			return !$included;
		}
	}
}