<?php
/**
 * Piwik - Open source web analytics
 * 
 * @link http://piwik.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 * @version $Id: FormDatabaseSetup.php 6467 2012-06-04 19:57:49Z matt $
 * 
 * @category Piwik_Plugins
 * @package Piwik_Installation
 */

/**
 * 
 * @package Piwik_Installation
 */
class Piwik_Installation_FormDatabaseSetup extends Piwik_QuickForm2
{
	function __construct( $id = 'databasesetupform', $method = 'post', $attributes = null, $trackSubmit = false)
	{
		parent::__construct($id,  $method, $attributes = array('autocomplete' => 'off'), $trackSubmit);
	}

	function init()
	{		
		HTML_QuickForm2_Factory::registerRule('checkValidFilename', 'Piwik_Installation_FormDatabaseSetup_Rule_checkValidFilename');
		
		$checkUserPrivilegesClass = 'Piwik_Installation_FormDatabaseSetup_Rule_checkUserPrivileges';
		HTML_QuickForm2_Factory::registerRule('checkUserPrivileges', $checkUserPrivilegesClass);
		
		$availableAdapters = Piwik_Db_Adapter::getAdapters();
		$adapters = array();
		foreach($availableAdapters as $adapter => $port)
		{
			$adapters[$adapter] = $adapter;
		}

		$this->addElement('text', 'host')
		     ->setLabel(Piwik_Translate('Installation_DatabaseSetupServer'))
		     ->addRule('required', Piwik_Translate('General_Required', Piwik_Translate('Installation_DatabaseSetupServer')));
		
		$user = $this->addElement('text', 'username')
					 ->setLabel(Piwik_Translate('Installation_DatabaseSetupLogin'));
		$user->addRule('required', Piwik_Translate('General_Required', Piwik_Translate('Installation_DatabaseSetupLogin')));
		$requiredPrivileges = Piwik_Installation_FormDatabaseSetup_Rule_checkUserPrivileges::getRequiredPrivilegesPretty();
		$user->addRule('checkUserPrivileges',
			Piwik_Translate('Installation_InsufficientPrivileges', $requiredPrivileges . '<br/><br/>').
			Piwik_Translate('Installation_InsufficientPrivilegesHelp'));

		$this->addElement('password', 'password')
		     ->setLabel(Piwik_Translate('Installation_DatabaseSetupPassword'));

		$item = $this->addElement('text', 'dbname')
		     ->setLabel(Piwik_Translate('Installation_DatabaseSetupDatabaseName'));
		$item->addRule('required', Piwik_Translate('General_Required', Piwik_Translate('Installation_DatabaseSetupDatabaseName')));
		$item->addRule('checkValidFilename', Piwik_Translate('General_NotValid', Piwik_Translate('Installation_DatabaseSetupDatabaseName')));

		$this->addElement('text', 'tables_prefix')
		     ->setLabel(Piwik_Translate('Installation_DatabaseSetupTablePrefix'))
		     ->addRule('checkValidFilename', Piwik_Translate('General_NotValid', Piwik_Translate('Installation_DatabaseSetupTablePrefix')));

		$this->addElement('select', 'adapter')
		     ->setLabel(Piwik_Translate('Installation_DatabaseSetupAdapter'))
		     ->loadOptions($adapters)
		     ->addRule('required', Piwik_Translate('General_Required', Piwik_Translate('Installation_DatabaseSetupAdapter')));

		$this->addElement('submit', 'submit', array('value' => Piwik_Translate('General_Next') .' »', 'class' => 'submit'));

		// default values
		$this->addDataSource(new HTML_QuickForm2_DataSource_Array(array(
			'host' => '127.0.0.1',
			'tables_prefix' => 'piwik_',
		)));
	}
	
	/**
	 * Creates database object based on form data.
	 * 
	 * @return array The database connection info. Can be passed into Piwik::createDatabaseObject.
	 */
	public function createDatabaseObject()
	{
		$dbname = $this->getSubmitValue('dbname');
		if (empty($dbname)) // disallow database object creation w/ no selected database
		{
			throw new Exception("No database name");
		}
		
		$adapter = $this->getSubmitValue('adapter');
		$port = Piwik_Db_Adapter::getDefaultPortForAdapter($adapter);

		$dbInfos = array(
			'host'          => $this->getSubmitValue('host'),
			'username'      => $this->getSubmitValue('username'),
			'password'      => $this->getSubmitValue('password'),
			'dbname'        => $dbname,
			'tables_prefix' => $this->getSubmitValue('tables_prefix'),
			'adapter'       => $adapter,
			'port'          => $port,
		);
		
		if(($portIndex = strpos($dbInfos['host'], '/')) !== false)
		{
			// unix_socket=/path/sock.n
			$dbInfos['port'] = substr($dbInfos['host'], $portIndex);
			$dbInfos['host'] = '';
		}
		else if(($portIndex = strpos($dbInfos['host'], ':')) !== false)
		{
			// host:port
			$dbInfos['port'] = substr($dbInfos['host'], $portIndex + 1 );
			$dbInfos['host'] = substr($dbInfos['host'], 0, $portIndex);
		}

		try {
			@Piwik::createDatabaseObject($dbInfos);
		} catch (Zend_Db_Adapter_Exception $e) {
			$db = Piwik_Db_Adapter::factory($adapter, $dbInfos, $connect = false);

			// database not found, we try to create  it
			if($db->isErrNo($e, '1049'))
			{
				$dbInfosConnectOnly = $dbInfos;
				$dbInfosConnectOnly['dbname'] = null;
				@Piwik::createDatabaseObject($dbInfosConnectOnly);
				@Piwik::createDatabase($dbInfos['dbname']);
				
				// select the newly created database
				@Piwik::createDatabaseObject($dbInfos);
			}
			else
			{
				throw $e;
			}
		}
		
		return $dbInfos;
	}
}

/**
 * Validation rule that checks that the supplied DB user has enough privileges.
 * 
 * The following privileges are required for Piwik to run:
 * - CREATE
 * - ALTER
 * - SELECT
 * - INSERT
 * - UPDATE
 * - DELETE
 * - LOCK TABLES
 * - DROP
 * - CREATE TEMPORARY TABLES
 * 
 * @package Piwik_Installation
 */
class Piwik_Installation_FormDatabaseSetup_Rule_checkUserPrivileges extends HTML_QuickForm2_Rule
{
	const TEST_TABLE_NAME = 'piwik_test_table';
	const TEST_TEMP_TABLE_NAME = 'piwik_test_table_temp';
	
	/**
	 * Checks that the DB user entered in the form has the necessary privileges for Piwik
	 * to run.
	 */
	public function validateOwner()
	{
		// try and create the database object
		try
		{
			$this->createDatabaseObject();
		}
		catch (Exception $ex)
		{
			if ($this->isAccessDenied($ex))
			{
				return false;
			}
			else
			{
				return true; // if we can't create the database object, skip this validation
			}
		}
		
		$db = Zend_Registry::get('db');
		
		try
		{
			// try to drop tables before running privilege tests
			$this->dropExtraTables($db);
		}
		catch (Exception $ex)
		{
			if ($this->isAccessDenied($ex))
			{
				return false;
			}
			else
			{
				throw $ex;
			}
		}
		
		// check each required privilege by running a query that uses it
		foreach (self::getRequiredPrivileges() as $privilegeType => $queries)
		{
			if (!is_array($queries))
			{
				$queries = array($queries);
			}
			
			foreach ($queries as $sql)
			{
				try
				{
					if( in_array($privilegeType, array('SELECT'))) {
						$db->fetchAll($sql);
					} else {
						$db->exec($sql);
					}
				}
				catch (Exception $ex)
				{
					if ($this->isAccessDenied($ex))
					{
						return false;
					}
					else
					{
						throw new Exception("Test SQL failed to execute: $sql\nError: ".$ex->getMessage());
					}
				}
			}
		}
		
		// remove extra tables that were created
		$this->dropExtraTables($db);
		
		return true;
	}
	
	/**
	 * Returns an array describing the database privileges required for Piwik to run. The
	 * array maps privilege names with one or more SQL queries that can be used to test
	 * if the current user has the privilege.
	 * 
	 * NOTE: LOAD DATA INFILE privilege is not **required** so its not checked.
	 * 
	 * @return array
	 */
	public static function getRequiredPrivileges()
	{
		return array(
			'CREATE' => 'CREATE TABLE '.self::TEST_TABLE_NAME.' (
								   id INT AUTO_INCREMENT,
								   value INT,
								   PRIMARY KEY (id),
								   KEY index_value (value)
							   )',
			'ALTER' => 'ALTER TABLE '.self::TEST_TABLE_NAME.' 
								ADD COLUMN other_value INT DEFAULT 0',
			'SELECT' => 'SELECT * FROM '.self::TEST_TABLE_NAME,
			'INSERT' => 'INSERT INTO '.self::TEST_TABLE_NAME.' (value) VALUES (123)',
			'UPDATE' => 'UPDATE '.self::TEST_TABLE_NAME.' SET value = 456 WHERE id = 1',
			'DELETE' => 'DELETE FROM '.self::TEST_TABLE_NAME.' WHERE id = 1',
			'LOCK TABLES' => array('LOCK TABLES '.self::TEST_TABLE_NAME.' WRITE', 'UNLOCK TABLES'),
			'DROP' => 'DROP TABLE '.self::TEST_TABLE_NAME,
			'CREATE TEMPORARY TABLES' => 'CREATE TEMPORARY TABLE '.self::TEST_TEMP_TABLE_NAME.' (
											id INT AUTO_INCREMENT,
											PRIMARY KEY (id)
										 )',
		);
	}
	
	/**
	 * Returns a string description of the database privileges required for Piwik to run.
	 * 
	 * @return string
	 */
	public static function getRequiredPrivilegesPretty()
	{
		return implode('<br/>', array_keys(self::getRequiredPrivileges()));
	}
	
	/**
	 * Checks if an exception that was thrown after running a query represents an 'access denied'
	 * error.
	 * 
	 * @param Exception $ex The exception to check.
	 * @return bool
	 */
	private function isAccessDenied( $ex )
	{
		return $ex->getCode() == 1044 || $ex->getCode() == 42000;
	}
	
	/**
	 * Creates a database object using the connection information entered in the form.
	 * 
	 * @return array
	 */
	private function createDatabaseObject()
	{
		return $this->owner->getContainer()->createDatabaseObject();
	}
	
	/**
	 * Drops the tables created by the privilege checking queries, if they exist.
	 * 
	 * @param $db The database object to use.
	 */
	private function dropExtraTables( $db )
	{
		$db->query('DROP TABLE IF EXISTS '.self::TEST_TABLE_NAME.', '.self::TEST_TEMP_TABLE_NAME);
	}
}

/**
 * Filename check for prefix/DB name
 *
 * @package Piwik_Installation
 */
class Piwik_Installation_FormDatabaseSetup_Rule_checkValidFilename extends HTML_QuickForm2_Rule
{
	function validateOwner()
	{
		return Piwik_Common::isValidFilename($this->owner->getValue());
	}
}

