OpenBuildings / timestamped-migrations

classes/Migrations.php

<?php defined('SYSPATH') OR die('No direct script access.');

/**
 * Migrations class.
 */
class Migrations
{
	protected $config;
	protected $driver;
	protected $migrations;
	public $output = NULL;

	/**
	 * Intialize migration library
	 *
	 * @param   bool   Do we want output of migration steps?
	 * @param   string Database group
	 */
	public function __construct($config = NULL)
	{
		$this->config = arr::merge(Kohana::$config->load('migrations')->as_array(), (array) $config);

		$database = Kohana::$config->load('database.'.Arr::get(Kohana::$config->load('migrations'), 'database', 'default'));

		// Set the driver class name
		$driver_name = in_array($database['type'], array('PDO', 'MySQL')) ? 'Mysql' : ucfirst($database['type']);
		$driver = 'Migration_Driver_'.$driver_name;

		// Create the database connection instance
		$this->driver = new $driver(Arr::get(Kohana::$config->load('migrations'), 'database', 'default'));

\Kohana::$config->load('migrations') is of type object<Kohana_Config_Group>, but the function expects a array.

		$this->driver->versions()->init();

		if( ! is_dir($this->config['path']))
		{
			mkdir($this->config['path'], 0777, TRUE);
		}
	}

	public function set_executed($version)
	{
		$this->driver->versions()->set($version);
	}

	public function set_unexecuted($version)
	{
		$this->driver->versions()->clear($version);
	}

	public function generate_new_migration_file($name, $actions_template = NULL)
	{
		$actions = new Migration_Actions($this->driver);

		if ($actions_template)
		{
			$actions->template(getcwd().DIRECTORY_SEPARATOR.$actions_template);
		}
		else
		{
			$actions->parse($name);
		}

		$template = file_get_contents(Kohana::find_file('templates', 'migration', 'tpl'));
		$class_name = str_replace(' ', '_', ucwords(str_replace('_',' ',$name)));
		$filename = sprintf("%d_$name.php", time());

		file_put_contents(
			$this->config['path'].DIRECTORY_SEPARATOR.$filename,
			strtr($template, array(
				'{up}' => join("\n", array_map('Migrations::indent', $actions->up)),
				'{down}' => join("\n", array_map('Migrations::indent', $actions->down)),
				'{class_name}' => $class_name
			))
		);

		return $filename;
	}

	static function indent($action)
	{
		return "\t\t$action";
	}

	/**
	 * Loads a migration
	 *
	 * @param   integer   Migration version number
	 * @return  Migration_Core  Class object
	 */
	public function load_migration($version)
	{
		$f = glob(sprintf($this->config['path'] . DIRECTORY_SEPARATOR . '%d_*.php', $version));

		if (count($f) > 1)
			throw new Migration_Exception('Only one migration per step is permitted, there are :count of version :version', array(':count' => count($f), ':version' => $version));

		if (count($f) == 0)
			throw new Migration_Exception('Migration step not found with version :version', array(":version" => $version));

		$file = basename($f[0]);
		$name = basename($f[0], EXT);

		// Filename validations
		if ( ! preg_match('/^\d+_(\w+)$/', $name, $match))
			throw new Migration_Exception('Invalid filename :file', array(':file' => $file));

		$match[1] = strtolower($match[1]);

		include_once $f[0];
		$class = ucfirst($match[1]);

		if ( ! class_exists($class))
			throw new Migration_Exception('Migration class :class does not exist', array( ':class' => $class));

		return new $class($this->config);
	}

	/**
	 * Retrieves all the timestamps of the migration files
	 *
	 * @return   array
	 */
	public function get_migrations()
	{
		if ( ! $this->migrations)
		{
			$migrations = glob($this->config['path'] . DIRECTORY_SEPARATOR . '*' . EXT);
			$ids = array();
			foreach ((array) $migrations as $file)
			{
				$name = basename($file, EXT);
				$matches = array();
				if ( preg_match('/^(\d+)_(\w+)$/', $name, $matches))
				{
					$ids[] = intval($matches[1]);
				}
			}
			$this->migrations = $ids;
		}
		return $this->migrations;
	}

	public function clear_all()
	{
		$this->driver->clear_all();
		$this->driver->versions()->clear_all();
		return $this;
	}

	public function get_executed_migrations()
	{
		return $this->driver->versions()->get();
	}

	public function get_unexecuted_migrations()
	{
		return array_diff($this->get_migrations(), $this->get_executed_migrations());
	}

	protected function execute($version, $direction, $dry_run)
	{
		$migration = $this->load_migration($version)->dry_run($dry_run);

		$this->log($version.' '.get_class($migration).' : migrating '.$direction.($dry_run ? " -- Dry Run" : ''));
		$start = microtime(TRUE);

		switch ($direction)
		{
			case 'down':
				$migration->down();
				if ( ! $dry_run)
				{
					$this->set_unexecuted($version);
				}
			break;

			case 'up':
				$migration->up();
				if ( ! $dry_run)
				{
					$this->set_executed($version);
				}
			break;
		}

		$end = microtime(TRUE);
		$this->log($version.' '.get_class($migration).' : migrated ('.number_format($end - $start, 4).'s)');
	}

	public function execute_all($up = array(), $down = array(), $dry_run = FALSE)
	{
		if ( ! count($down) AND ! count($up))
		{
			$this->log("Nothing to do");
		}
		else
		{
			foreach ($down as $version)
			{
				$this->execute($version, 'down', $dry_run);
			}

			foreach ($up as $version)
			{
				$this->execute($version, 'up', $dry_run);
			}
		}
	}

	public function log($message)
	{
		if ($this->config['log'])
		{
			call_user_func($this->config['log'], $message);
		}
		else
		{
			echo $message."\n";
			ob_flush();
		}
	}
}