* @link https://github.com/ruckus/ruckusing-migrations */ /** * Task_DB_Generate * generic task which acts as a Generator for migrations. * * @category Ruckusing * @package Task * @subpackage Db * @author Cody Caughlan * @author Salimane Adjao Moustapha */ class Task_Db_Generate extends \YoastSEO_Vendor\Ruckusing_Task_Base implements \YoastSEO_Vendor\Ruckusing_Task_Interface { /** * Current Adapter * * @var Ruckusing_Adapter_Base */ private $_adapter = null; /** * Creates an instance of Task_DB_Generate * * @param Ruckusing_Adapter_Base $adapter The current adapter being used * * @return Task_DB_Generate */ public function __construct($adapter) { parent::__construct($adapter); $this->_adapter = $adapter; } /** * Primary task entry point * * @param array $args The current supplied options. */ public function execute($args) { $output = ''; // Add support for old migration style if (!\is_array($args) || !\array_key_exists('name', $args)) { $cargs = $this->parse_args($_SERVER['argv']); //input sanity check if (!\is_array($cargs) || !\array_key_exists('name', $cargs)) { $output .= $this->help(); return $output; } $migration_name = $cargs['name']; } else { $migration_name = $args['name']; } if (!\array_key_exists('module', $args)) { $args['module'] = ''; } //clear any filesystem stats cache \clearstatcache(); $framework = $this->get_framework(); $migrations_dir = $framework->migrations_directory($args['module']); if (!\is_dir($migrations_dir)) { $output .= "\n\tMigrations directory (" . $migrations_dir . " doesn't exist, attempting to create.\n"; if (\mkdir($migrations_dir, 0755, \true) === \FALSE) { $output .= "\n\tUnable to create migrations directory at " . $migrations_dir . ", check permissions?\n"; } else { $output .= "\n\tCreated OK\n"; } } //generate a complete migration file $next_version = \YoastSEO_Vendor\Ruckusing_Util_Migrator::generate_timestamp(); $class = \YoastSEO_Vendor\Ruckusing_Util_Naming::camelcase($migration_name); if (!self::classNameIsCorrect($class)) { throw new \YoastSEO_Vendor\Ruckusing_Exception("Bad migration name,PHP class can't be named as {$class}.Please, choose another name.", \YoastSEO_Vendor\Ruckusing_Exception::INVALID_ARGUMENT); } $all_dirs = $framework->migrations_directories(); if ($re = self::classNameIsDuplicated($class, $all_dirs)) { throw new \YoastSEO_Vendor\Ruckusing_Exception("This migration name is already used in the \"{$re}\" directory. Please, choose another name.", \YoastSEO_Vendor\Ruckusing_Exception::INVALID_ARGUMENT); } $file_name = $next_version . '_' . $class . '.php'; //check to make sure our destination directory is writable if (!\is_writable($migrations_dir)) { throw new \YoastSEO_Vendor\Ruckusing_Exception("ERROR: migration directory '" . $migrations_dir . "' is not writable by the current user. Check permissions and try again.", \YoastSEO_Vendor\Ruckusing_Exception::INVALID_MIGRATION_DIR); } //write it out! $full_path = $migrations_dir . \DIRECTORY_SEPARATOR . $file_name; $template_str = self::get_template($class); $file_result = \file_put_contents($full_path, $template_str); if ($file_result === \FALSE) { throw new \YoastSEO_Vendor\Ruckusing_Exception("Error writing to migrations directory/file. Do you have sufficient privileges?", \YoastSEO_Vendor\Ruckusing_Exception::INVALID_MIGRATION_DIR); } else { $output .= "\n\tCreated migration: {$file_name}\n\n"; } return $output; } /** * Parse command line arguments. * * @param array $argv The current supplied command line arguments. * * @return array ('name' => 'name') */ public function parse_args($argv) { foreach ($argv as $i => $arg) { if (\strpos($arg, '=') !== \FALSE) { unset($argv[$i]); } } $num_args = \count($argv); if ($num_args < 3) { return array(); } $migration_name = $argv[2]; return array('name' => $migration_name); } /** * Indicate if a class name is already used * * @param string $classname The class name to test * @param string $migrationsDirs The array with directories of migration files (in simplest case - just array with one element) * * @return bool */ public static function classNameIsDuplicated($classname, $migrationsDirs) { $migrationFiles = \YoastSEO_Vendor\Ruckusing_Util_Migrator::get_migration_files($migrationsDirs, 'up'); $classname = \strtolower($classname); foreach ($migrationFiles as $file) { if (\strtolower($file['class']) == $classname) { return $file['module']; } } return \false; } /** * Indicate if a class name is correct or not. * * @param string $classname The class name to test * * @return bool */ public static function classNameIsCorrect($classname) { $correct_class_name_regex = '/^[a-zA-Z_\\x7f-\\xff][a-zA-Z0-9_\\x7f-\\xff]*$/'; if (\preg_match($correct_class_name_regex, $classname)) { return \true; } return \false; } /** * generate a migration template string * * @param string $klass class name to create * @return string */ public static function get_template($klass) { $template = << \tGenerator for migrations. \t is a descriptive name of the migration, \tjoined with underscores. e.g.: add_index_to_users | create_users_table \tExample : \t\tphp {$_SERVER['argv'][0]} db:generate add_index_to_users USAGE; return $output; } }