/lib/Ruckusing/FrameworkRunner.php

<?php

/**
 * Ruckusing
 *
 * @category  Ruckusing
 * @package   Ruckusing
 * @author    Cody Caughlan <codycaughlan % gmail . com>
 * @link      https://github.com/ruckus/ruckusing-migrations
 */

require_once RUCKUSING_BASE . '/lib/Ruckusing/Task/Manager.php';
require_once RUCKUSING_BASE . '/lib/Ruckusing/Exception.php';

/**
 * Ruckusing_FrameworkRunner
 *
 * Primary work-horse class. This class bootstraps the framework by loading
 * all adapters and tasks.
 *
 * @category Ruckusing
 * @package  Ruckusing
 * @author   Cody Caughlan <codycaughlan % gmail . com>
 * @link     https://github.com/ruckus/ruckusing-migrations
 */
class Ruckusing_FrameworkRunner
{
    /**
     * reference to our DB connection
     *
     * @var array
     */
    private $_db = null;

    /**
     * The currently active config
     *
     * @var array
     */
    private $_active_db_config;

    /**
     * Available DB config (e.g. test,development, production)
     *
     * @var array
     */
    private $_config = array();

    /**
     * Task manager
     *
     * @var Ruckusing_Task_Manager
     */
    private $_task_mgr = null;

    /**
     * adapter
     *
     * @var Ruckusing_Adapter_Base
     */
    private $_adapter = null;

    /**
     * current task name
     *
     * @var string
     */
    private $_cur_task_name = "";

    /**
     * task options
     *
     * @var string
     */
    private $_task_options = "";

    /**
     * Environment
     * default is development
     * but can also be one 'test', 'production', etc...
     *
     * @var string
     */
    private $_env = "development";

    /**
     * set up some defaults
     *
     * @var array
     */
    private $_opt_map = array(
            'env' => 'development'
    );

    /**
     * Flag to display help of task
     * @see Ruckusing_FrameworkRunner::parse_args
     *
     * @var boolean
     */
    private $_showhelp = false;

    /**
     * Creates an instance of Ruckusing_Adapters_Base
     *
     * @param array $config The current config
     * @param array $argv   the supplied command line arguments
     *
     * @return Ruckusing_FrameworkRunner
     */
    public function __construct($config, $argv)
    {
        set_error_handler(array('Ruckusing_Exception', 'errorHandler'), E_ALL);
        set_exception_handler(array('Ruckusing_Exception', 'exceptionHandler'));

        //parse arguments
        $this->parse_args($argv);

        //set config variables
        $this->_config = $config;

        //verify config array
        $this->verify_db_config();

        //initialize logger
        $this->initialize_logger();

        //include all adapters
        $this->load_all_adapters(RUCKUSING_BASE . '/lib/Ruckusing/Adapter');

        //initialize logger
        $this->initialize_db();

        //initialize tasks
        $this->init_tasks();

    }

    /**
     * Execute the current task
     */
    public function execute()
    {
        if (empty($this->_cur_task_name)) {
            if (isset($_SERVER["argv"][1]) && stripos($_SERVER["argv"][1], '=') === false) {
                echo sprintf("\n\tWrong Task format: %s\n", $_SERVER["argv"][1]);
            }
            echo $this->help();
        } else {
            if ($this->_task_mgr->has_task($this->_cur_task_name)) {
                if ($this->_showhelp) {
                    echo $this->_task_mgr->help($this->_cur_task_name);
                } else {
                    $output = $this->_task_mgr->execute($this, $this->_cur_task_name, $this->_task_options);

                }
            } else {
                echo sprintf("\n\tTask not found: %s\n", $this->_cur_task_name);
                echo $this->help();
            }
        }

        if ($this->logger) {
            $this->logger->close();
        }
    }

    /**
     * Get the current adapter
     *
     * @return object
     */
    public function get_adapter()
    {
        return $this->_adapter;
    }

    /**
     * Initialize the task
     */
    public function init_tasks()
    {
        $this->_task_mgr = new Ruckusing_Task_Manager($this->_adapter);
    }

    /**
     * Get the current migration dir
     *
     * @return string
     */
    public function migrations_directory()
    {
        return $this->_config['migrations_dir'] . DIRECTORY_SEPARATOR . $this->_config['db'][$this->_env]['database'];
    }

    /**
     * Get the current db schema dir
     *
     * @return string
     */
    public function db_directory()
    {
        return $this->_config['db_dir'] . DIRECTORY_SEPARATOR . $this->_config['db'][$this->_env]['database'];
    }

    /**
     * Initialize the db
     */
    public function initialize_db()
    {
        $db = $this->_config['db'][$this->_env];
        $adapter = $this->get_adapter_class($db['type']);

        if (empty($adapter)) {
            throw new Ruckusing_Exception(
                    sprintf("No adapter available for DB type: %s", $db['type']),
                    Ruckusing_Exception::INVALID_ADAPTER
            );
        }
        //construct our adapter
        $this->_adapter = new $adapter($db, $this->logger);

    }

    /**
     * Initialize the logger
     */
    public function initialize_logger()
    {
        if (is_dir($this->_config['log_dir']) && !is_writable($this->_config['log_dir'])) {
            throw new Ruckusing_Exception(
                    "\n\nCannot write to log directory: " . $this->_config['log_dir'] . "\n\nCheck permissions.\n\n",
                    Ruckusing_Exception::INVALID_LOG
            );
        } elseif (!is_dir($this->_config['log_dir'])) {
            //try and create the log directory
            mkdir($this->_config['log_dir'], 0755, true);
        }
        $log_name = sprintf("%s.log", $this->_env);
        $this->logger = Ruckusing_Util_Logger::instance($this->_config['log_dir'] . "/" . $log_name);
    }

    /**
     * $argv is our complete command line argument set.
     * PHP gives us:
     * [0] = the actual file name we're executing
     * [1..N] = all other arguments
     *
     * Our task name should be at slot [1]
     * Anything else are additional parameters that we can pass
     * to our task and they can deal with them as they see fit.
     *
     * @param array $argv the current command line arguments
     */
    private function parse_args($argv)
    {
        $num_args = count($argv);

        $options = array();
        for ($i = 0; $i < $num_args; $i++) {
            $arg = $argv[$i];
            if (stripos($arg, ':') !== false) {
                $this->_cur_task_name = $arg;
            } elseif ($arg == 'help') {
                $this->_showhelp = true;
                continue;
            } elseif (stripos($arg, '=') !== false) {
                list($key, $value) = explode('=', $arg);
                $key = strtolower($key); // Allow both upper and lower case parameters
                $options[$key] = $value;
                if ($key == 'env') {
                    $this->_env = $value;
                }
            }
        }
        $this->_task_options = $options;

    }

    /**
     * Update the local schema to handle multiple records versus the prior architecture
     * of storing a single version. In addition take all existing migration files
     * and register them in our new table, as they have already been executed.
     */
    public function update_schema_for_timestamps()
    {
        //only create the table if it doesnt already exist
        $this->_adapter->create_schema_version_table();
        //insert all existing records into our new table
        $migrator_util = new Ruckusing_Util_Migrator($this->_adapter);
        $files = $migrator_util->get_migration_files($this->migrations_directory(), 'up');
        foreach ($files as $file) {
            if ((int) $file['version'] >= PHP_INT_MAX) {
                //its new style like '20081010170207' so its not a candidate
                continue;
            }
            //query old table, if it less than or equal to our max version, then its a candidate for insertion
            $query_sql = sprintf("SELECT version FROM %s WHERE version >= %d", RUCKUSING_SCHEMA_TBL_NAME, $file['version']);
            $existing_version_old_style = $this->_adapter->select_one($query_sql);
            if (count($existing_version_old_style) > 0) {
                //make sure it doesnt exist in our new table, who knows how it got inserted?
                $new_vers_sql = sprintf("SELECT version FROM %s WHERE version = %d", RUCKUSING_TS_SCHEMA_TBL_NAME, $file['version']);
                $existing_version_new_style = $this->_adapter->select_one($new_vers_sql);
                if (empty($existing_version_new_style)) {
                    // use printf & %d to force it to be stripped of any leading zeros, we *know* this represents an old version style
                    // so we dont have to worry about PHP and integer overflow
                    $insert_sql = sprintf("INSERT INTO %s (version) VALUES (%d)", RUCKUSING_TS_SCHEMA_TBL_NAME, $file['version']);
                    $this->_adapter->query($insert_sql);
                }
            }
        }
    }

    /**
     * Set an option
     *
     * @param string $key   the key to set
     * @param string $value the value to set
     */
    private function set_opt($key, $value)
    {
        if (!$key) {
            return;
        }
        $this->_opt_map[$key] = $value;
    }

    /**
     * Verify db config
     */
    private function verify_db_config()
    {
        if ( !array_key_exists($this->_env, $this->_config['db'])) {
            throw new Ruckusing_Exception(
                    sprintf("Error: '%s' DB is not configured", $this->_env),
                    Ruckusing_Exception::INVALID_CONFIG
            );
        }
        $env = $this->_env;
        $this->_active_db_config = $this->_config['db'][$this->_env];
        if (!array_key_exists("type",$this->_active_db_config)) {
            throw new Ruckusing_Exception(
                    sprintf("Error: 'type' is not set for '%s' DB", $this->_env),
                    Ruckusing_Exception::INVALID_CONFIG
            );
        }
        if (!array_key_exists("host",$this->_active_db_config)) {
            throw new Ruckusing_Exception(
                    sprintf("Error: 'host' is not set for '%s' DB", $this->_env),
                    Ruckusing_Exception::INVALID_CONFIG
            );
        }
        if (!array_key_exists("database",$this->_active_db_config)) {
            throw new Ruckusing_Exception(
                    sprintf("Error: 'database' is not set for '%s' DB", $this->_env),
                    Ruckusing_Exception::INVALID_CONFIG
            );
        }
        if (!array_key_exists("user",$this->_active_db_config)) {
            throw new Ruckusing_Exception(
                    sprintf("Error: 'user' is not set for '%s' DB", $this->_env),
                    Ruckusing_Exception::INVALID_CONFIG
            );
        }
        if (!array_key_exists("password",$this->_active_db_config)) {
            throw new Ruckusing_Exception(
                    sprintf("Error: 'password' is not set for '%s' DB", $this->_env),
                    Ruckusing_Exception::INVALID_CONFIG
            );
        }
        if (empty($this->_config['migrations_dir'])) {
            throw new Ruckusing_Exception(
                    "Error: 'migrations_dir' is not set in config.",
                    Ruckusing_Exception::INVALID_CONFIG
            );
        }
        if (empty($this->_config['db_dir'])) {
            throw new Ruckusing_Exception(
                    "Error: 'db_dir' is not set in config.",
                    Ruckusing_Exception::INVALID_CONFIG
            );
        }
        if (empty($this->_config['log_dir'])) {
            throw new Ruckusing_Exception(
                    "Error: 'log_dir' is not set in config.",
                    Ruckusing_Exception::INVALID_CONFIG
            );
        }
    }

    /**
     * Get the adapter class
     *
     * @param string $db_type the database type
     *
     * @return string
     */
    private function get_adapter_class($db_type)
    {
        $adapter_class = null;
        switch ($db_type) {
            case 'mysql':
                $adapter_class = "Ruckusing_Adapter_MySQL_Base";
                break;
            case 'mssql':
                $adapter_class = "Ruckusing_Adapter_MSSQL_Base";
                break;
            case 'pgsql':
                $adapter_class = "Ruckusing_Adapter_PgSQL_Base";
                break;
        }

        return $adapter_class;
    }

    /**
     * DB adapters are classes in lib/Ruckusing/Adapter
     * and they follow the file name syntax of "<DB Name>/Base.php".
     *
     * See the function "get_adapter_class" in this class for examples.
     *
     * @param string $adapter_dir the adapter dir
     */
    private function load_all_adapters($adapter_dir)
    {
        if (!is_dir($adapter_dir)) {
            throw new Ruckusing_Exception(
                    sprintf("Adapter dir: %s does not exist", $adapter_dir),
                    Ruckusing_Exception::INVALID_ADAPTER
            );

            return false;
        }
        $files = scandir($adapter_dir);
        foreach ($files as $f) {
            //skip over invalid files
            if ($f == '.' || $f == ".." || !is_dir($adapter_dir . '/' . $f)) {
                continue;
            }
            require_once $adapter_dir . '/' . $f . '/Base.php';
        }
    }

    /**
     * Return the usage of the task
     *
     * @return string
     */
    public function help()
    {
        // TODO: dynamically list all available tasks
        $output =<<<USAGE

\tUsage: php {$_SERVER['argv'][0]} <task> [help] [task parameters] [env=environment]

\thelp: Display this message

\tenv: The env command line parameter can be used to specify a different
\tdatabase to run against, as specific in the configuration file
\t(config/database.inc.php).
\tBy default, env is "development"

\ttask: In a nutshell, task names are pseudo-namespaced. The tasks that come
\twith the framework are namespaced to "db" (e.g. the tasks are "db:migrate",
\t"db:setup", etc).
\tAll tasks available actually :

\t- db:setup : A basic task to initialize your DB for migrations is
\tavailable. One should always run this task when first starting out.

\t- db:generate : A generic task which acts as a Generator for migrations.

\t- db:migrate : The primary purpose of the framework is to run migrations,
\tand the execution of migrations is all handled by just a regular ol' task.

\t- db:version : It is always possible to ask the framework (really the DB)
\twhat version it is currently at.

\t- db:status : With this taks you'll get an overview of the already
\texecuted migrations and which will be executed when running db:migrate

\t- db:schema : It can be beneficial to get a dump of the DB in raw SQL
\tformat which represents the current version.

USAGE;

        return $output;
    }

}