From 44c10f661ee548ae08fe81ba76f47f1c8134b96f Mon Sep 17 00:00:00 2001
From: Nathan Guse <nathaniel.guse@gmail.com>
Date: Wed, 9 Jan 2013 18:59:15 -0600
Subject: [PATCH] [feature/migrations] Creating revert method to attempt
 reverting a migration

This code is in progress

PHPBB3-9737
---
 phpBB/includes/db/migration/migration.php |  23 +++++
 phpBB/includes/db/migrator.php            | 100 ++++++++++++++++++++++
 2 files changed, 123 insertions(+)

diff --git a/phpBB/includes/db/migration/migration.php b/phpBB/includes/db/migration/migration.php
index 5f1f0443db..61fbf04320 100644
--- a/phpBB/includes/db/migration/migration.php
+++ b/phpBB/includes/db/migration/migration.php
@@ -93,6 +93,16 @@ abstract class phpbb_db_migration
 		return array();
 	}
 
+	/**
+	* Reverts the database schema by providing a set of change instructions
+	*
+	* @return array Array of schema changes (compatible with db_tools->perform_schema_changes())
+	*/
+	public function revert_schema()
+	{
+		return array();
+	}
+
 	/**
 	* Updates data by returning a list of instructions to be executed
 	*
@@ -103,6 +113,19 @@ abstract class phpbb_db_migration
 		return array();
 	}
 
+	/**
+	* Reverts data by returning a list of instructions to be executed
+	*
+	* @return array Array of data instructions that will be performed on revert
+	* 	NOTE: calls to tools (such as config.add) are automatically reverted when
+	* 		possible, so you should not attempt to revert those, this is mostly for
+	* 		otherwise unrevertable calls (custom functions for example)
+	*/
+	public function revert_data()
+	{
+		return array();
+	}
+
 	/**
 	* Wrapper for running queries to generate user feedback on updates
 	*
diff --git a/phpBB/includes/db/migrator.php b/phpBB/includes/db/migrator.php
index dc2c746559..e8d3735974 100644
--- a/phpBB/includes/db/migrator.php
+++ b/phpBB/includes/db/migrator.php
@@ -289,6 +289,91 @@ class phpbb_db_migrator
 		return true;
 	}
 
+	/**
+	* Runs a single revert step from the last migration installed
+	*
+	* The revert step can either be a schema or a (partial) data revert. To
+	* check if revert() needs to be called again use the migration_installed() method.
+	*
+	* @param string $migration String migration name to revert (including any that depend on this migration)
+	* @return null
+	*/
+	public function revert($migration)
+	{
+		if (!isset($this->migration_state[$name]))
+		{
+			// Not installed
+			return;
+		}
+
+		// Iterate through all installed migrations and make sure any dependencies are removed first
+		foreach ($this->migration_state as $name => $state)
+		{
+			$migration_class = $this->get_migration($name);
+
+			if (in_array($migration, $migration_class->depends_on()))
+			{
+				$this->revert($name);
+			}
+		}
+
+		$this->try_revert($migration);
+	}
+
+	/**
+	* Attempts to apply a step of the given migration or one of its dependencies
+	*
+	* @param	string	The class name of the migration
+	* @return	bool	Whether any update step was successfully run
+	*/
+	protected function try_revert($name)
+	{
+		if (!class_exists($name))
+		{
+			return false;
+		}
+
+		$migration = $this->get_migration($name);
+
+		$state = $this->migration_state[$name];
+
+		$this->last_run_migration = array(
+			'name'	=> $name,
+			'class'	=> $migration,
+		);
+
+		// Left off here
+
+		if (!isset($this->migration_state[$name]))
+		{
+			$state['migration_start_time'] = time();
+			$this->insert_migration($name, $state);
+		}
+
+		if (!$state['migration_schema_done'])
+		{
+			$this->apply_schema_changes($migration->update_schema());
+			$state['migration_schema_done'] = true;
+		}
+		else
+		{
+			$result = $this->process_data_step($migration, $state['migration_data_state']);
+
+			$state['migration_data_state'] = ($result === true) ? '' : $result;
+			$state['migration_data_done'] = ($result === true);
+			$state['migration_end_time'] = ($result === true) ? time() : 0;
+		}
+
+		$sql = 'UPDATE ' . $this->migrations_table . '
+			SET ' . $this->db->sql_build_array('UPDATE', $state) . "
+			WHERE migration_name = '" . $this->db->sql_escape($name) . "'";
+		$this->db->sql_query($sql);
+
+		$this->migration_state[$name] = $state;
+
+		return true;
+	}
+
 	/**
 	* Apply schema changes from a migration
 	*
@@ -359,6 +444,7 @@ class phpbb_db_migrator
 					}
 				}
 
+				/** TODO Revert Schema **/
 				var_dump($step);
 				echo $e;
 				die();
@@ -567,6 +653,20 @@ class phpbb_db_migrator
 		return true;
 	}
 
+	/**
+	* Checks whether a migration is installed
+	*
+	* @param string $migration String migration name to check if it is installed
+	* @return bool Whether the migrations have been applied
+	*/
+	public function migration_installed($migration)
+	{
+		if (isset($this->migration_state[$migration]))
+		{
+			return true;
+		}
+	}
+
 	/**
 	* Helper to get a migration
 	*