@@ -221,7 +221,7 @@ class Migrations{ * Generate SQL for rename table */ function rename_table( $sTable, $sName ){ - $sSql = 'ALTER TABLE `'.$sTable.'` RENAME TO `'.$sName.'`;'; + $sSql = 'ALTER TABLE `'.$this->getPrefix().$sTable.'` RENAME TO `'.$sName.'`;'; return $sSql; } @@ -237,7 +237,7 @@ class Migrations{ * Generate SQL for truncate table */ function truncate_table($sTable){ - $sSql = 'TRUNCATE `'.$sTable.'`;'; + $sSql = 'TRUNCATE `'.$this->getPrefix().$sTable.'`;'; return $sSql; } @@ -245,7 +245,7 @@ class Migrations{ * Generate SQL for add field */ function add_field( $sTable, $aField ){ - $sSql = 'ALTER TABLE `'.$sTable.'` ADD '.$this->_buildColumn( key( $aField ), $aField[key($aField)] ); + $sSql = 'ALTER TABLE `'.$this->getPrefix().$sTable.'` ADD '.$this->_buildColumn( key( $aField ), $aField[key($aField)] ); $sSql = trim( $sSql, ", \n\t" ).';'; return $sSql; } @@ -254,7 +254,7 @@ class Migrations{ * Generate SQL for drop field */ function drop_field( $sTable, $column ){ - $sSql = 'ALTER TABLE `'.$sTable.'` DROP `'.$column.'`;'; + $sSql = 'ALTER TABLE `'.$this->getPrefix().$sTable.'` DROP `'.$column.'`;'; return $sSql; } @@ -262,7 +262,7 @@ class Migrations{ * Generate SQL for alter field */ function alter_field( $sTable, $aField ){ - $sSql = 'ALTER TABLE `'.$sTable.'` CHANGE `'.key( $aField ).'` '.$this->_buildColumn( + $sSql = 'ALTER TABLE `'.$this->getPrefix().$sTable.'` CHANGE `'.key( $aField ).'` '.$this->_buildColumn( ( !empty( $aField['name'] ) ? $aField['name'] : key( $aField ) ), $aField[key($aField)] ); $sSql = trim( $sSql, ", \n\t" ); migrations/migrations.php @@ -1,107 +1,107 @@ -<?php -/** - * Fixtures is a CakePHP shell script that imports data from your YAML files - * - * Run 'cake fixtures help' for more info and help on using this script. - * - * Licensed under The MIT License - * Redistributions of files must retain the above copyright notice. - * - * @copyright Copyright 2008, Georgi Momchilov - * @link http://ovalpixels.com - * @author Georgi Momchilov - * @since CakePHP(tm) v 1.2 - * @license http://www.opensource.org/licenses/mit-license.php The MIT License - * -*/ - -uses('file', 'folder'); -App::import('vendor','fixtures'); - - -class FixturesShell extends Shell { - - var $sConnection = 'default'; - var $oFixtures; - - /** - * Initializes some paths and checks for the required classes - */ - function startup(){ - $sPath = APP_PATH .'config' .DS. 'fixtures'; - - if(isset($this->params['p'])) $sPath = $this->params['p']; - if(isset($this->params['path'])) $sPath = $this->params['path']; - - define('FIXTURES_PATH', $sPath ); - - if(isset($this->params['c'])) $this->sConnection = $this->params['c']; - if(isset($this->params['connection'])) $this->sConnection = $this->params['connection']; - - if( !class_exists( 'Fixtures' ) ) - $this->error( 'File not found', 'Fixtures class is needed for this shell to run. Could not be found - exiting.' ); - - $this->oFixtures = new Fixtures( $this->sConnection ); - - $this->_welcome(); - } - - /** - * Main method: Imports all fixtures from the fixtures path - */ - function main(){ - if( !class_exists('Spyc') ) - $this->error( 'File not found', 'YAML class is needed for this shell to run. Could not be found - exiting.' ); - - $oFolder = new Folder(FIXTURES_PATH); - $aFixtures = $oFolder->find('.+_fixture\.yml'); - $oFixtures = new Fixtures( $this->sConnection ); - $iCount = 0; - foreach( $aFixtures as $sFixture ){ - $iCount++; - if( $oFixtures->import( FIXTURES_PATH. DS . $sFixture ) !== true ){ - $this->error( 'Import failed.', 'Sorry, there was an error inserting the data into your database' ); - } - else{ - $this->out( 'Importing '.$sFixture.'...' ); - $this->out( '' ); - } - } - $this->out($iCount. ' fixture(s) successfully imported'); - } - - /** - * Help method - */ - function help(){ - $this->hr(); - $this->out(''); - $this->out('Fixtures help you import your data into your database in a DB engine'); - $this->out('agnostic manner.'); - $this->out(''); - $this->out('Fixture files are YAML files.'); - $this->out(''); - $this->hr(); - $this->out(''); - $this->out('COMMAND LINE OPTIONS'); - $this->out(''); - $this->out(' cake fixtures'); - $this->out(' - Imports all fixture files ( .+_fixture\.yml )'); - $this->out(''); - $this->out(' cake migrate help'); - $this->out(' - Displays this Help'); - $this->out(''); - $this->out(" append '-c [connection]' to the command if you want to specify the"); - $this->out(' connection to use from database.php. By default it uses "default"'); - $this->out(''); - $this->out(" append '-p [path]' to the command if you want to specify the"); - $this->out(' path where the fixture files reside. Default is APP_PATH . \'config\' .DS. \'fixtures\' '); - $this->out(''); - $this->out(''); - $this->out('For more information and for the latest release of this and others,'); - $this->out('go to http://ovalpixels.com'); - $this->out(''); - $this->hr(); - $this->out(''); - } +<?php +/** + * Fixtures is a CakePHP shell script that imports data from your YAML files + * + * Run 'cake fixtures help' for more info and help on using this script. + * + * Licensed under The MIT License + * Redistributions of files must retain the above copyright notice. + * + * @copyright Copyright 2008, Georgi Momchilov + * @link http://ovalpixels.com + * @author Georgi Momchilov + * @since CakePHP(tm) v 1.2 + * @license http://www.opensource.org/licenses/mit-license.php The MIT License + * +*/ + +uses('file', 'folder'); +App::import('vendor','fixtures'); + + +class FixturesShell extends Shell { + + var $sConnection = 'default'; + var $oFixtures; + + /** + * Initializes some paths and checks for the required classes + */ + function startup(){ + $sPath = APP_PATH .'config' .DS. 'fixtures'; + + if(isset($this->params['p'])) $sPath = $this->params['p']; + if(isset($this->params['path'])) $sPath = $this->params['path']; + + define('FIXTURES_PATH', $sPath ); + + if(isset($this->params['c'])) $this->sConnection = $this->params['c']; + if(isset($this->params['connection'])) $this->sConnection = $this->params['connection']; + + if( !class_exists( 'Fixtures' ) ) + $this->error( 'File not found', 'Fixtures class is needed for this shell to run. Could not be found - exiting.' ); + + $this->oFixtures = new Fixtures( $this->sConnection ); + + $this->_welcome(); + } + + /** + * Main method: Imports all fixtures from the fixtures path + */ + function main(){ + if( !class_exists('Spyc') ) + $this->error( 'File not found', 'YAML class is needed for this shell to run. Could not be found - exiting.' ); + + $oFolder = new Folder(FIXTURES_PATH); + $aFixtures = $oFolder->find('.+_fixture\.yml'); + $oFixtures = new Fixtures( $this->sConnection ); + $iCount = 0; + foreach( $aFixtures as $sFixture ){ + $iCount++; + if( $oFixtures->import( FIXTURES_PATH. DS . $sFixture ) !== true ){ + $this->error( 'Import failed.', 'Sorry, there was an error inserting the data into your database' ); + } + else{ + $this->out( 'Importing '.$sFixture.'...' ); + $this->out( '' ); + } + } + $this->out($iCount. ' fixture(s) successfully imported'); + } + + /** + * Help method + */ + function help(){ + $this->hr(); + $this->out(''); + $this->out('Fixtures help you import your data into your database in a DB engine'); + $this->out('agnostic manner.'); + $this->out(''); + $this->out('Fixture files are YAML files.'); + $this->out(''); + $this->hr(); + $this->out(''); + $this->out('COMMAND LINE OPTIONS'); + $this->out(''); + $this->out(' cake fixtures'); + $this->out(' - Imports all fixture files ( .+_fixture\.yml )'); + $this->out(''); + $this->out(' cake migrate help'); + $this->out(' - Displays this Help'); + $this->out(''); + $this->out(" append '-c [connection]' to the command if you want to specify the"); + $this->out(' connection to use from database.php. By default it uses "default"'); + $this->out(''); + $this->out(" append '-p [path]' to the command if you want to specify the"); + $this->out(' path where the fixture files reside. Default is APP_PATH . \'config\' .DS. \'fixtures\' '); + $this->out(''); + $this->out(''); + $this->out('For more information and for the latest release of this and others,'); + $this->out('go to http://ovalpixels.com'); + $this->out(''); + $this->hr(); + $this->out(''); + } } \ No newline at end of file shells/fixtures.php @@ -1,480 +1,480 @@ -<?php -/** - * Migrations is a CakePHP shell script that runs your database migrations to the specified schema - * version. If no version is specified, migrations are run to the latest version. - * - * Run 'cake migrate help' for more info and help on using this script. - * - * Heavily based on Joel Moss' Migrations shell ( http://joelmoss.info ) but uses cake's internal functions instead of PEAR::MDB2 - * and doesn't have some methods I found unnecessary. - * - * Licensed under The MIT License - * Redistributions of files must retain the above copyright notice. - * - * @copyright Copyright 2008, Georgi Momchilov - * @link http://ovalpixels.com - * @author Georgi Momchilov - * @since CakePHP(tm) v 1.2 - * @license http://www.opensource.org/licenses/mit-license.php The MIT License - * -*/ - -uses('file', 'folder'); -App::import('vendor','spyc'); -App::import('vendor','migrations'); - - -class MigrateShell extends Shell { - - var $sConnection = 'default'; - var $aMigrations; - var $oMigrations; - - /** - * Initializes some paths and checks for the required classes - */ - function startup(){ - define('MIGRATIONS_PATH', APP_PATH .'config' .DS. 'migrations'); - - if(isset($this->params['c'])) $this->sConnection = $this->params['c']; - if(isset($this->params['connection'])) $this->sConnection = $this->params['connection']; - - if( !class_exists( 'Migrations' ) ) - $this->error( 'File not found', 'Migrations class is needed for this shell to run. Could not be found - exiting.' ); - - $this->oMigrations = new Migrations( $this->sConnection ); - - $this->_welcome(); - $this->out('App : '. APP_DIR); - $this->out('Path: '. ROOT . DS . APP_DIR); - $this->_getMigrationVersion(); - $this->out(''); - $this->out('Current schema version: '.$this->iCurrent_version); - $this->out(''); - $this->_getMigrations(); - } - - /** - * Main method: migrates to the latest version. - */ - function main(){ - if( !isset( $this->params['v'] ) ){ - $this->_migrate_to_version($this->iMigration_count); - } - else{ - $iTo_v = intval( $this->params['v'] ); - if( $iTo_v > $this->iMigration_count || $iTo_v < 0 ){ - $this->out(' ** Version number entered ('.$iTo_v.') does not exist. **'); - $this->out(''); - } - else{ - $this->_migrate_to_version( $iTo_v ); - } - } - $this->out('Migrations completed.'); - $this->out(''); - $this->hr(); - $this->out(''); - exit; - } - - /** - * Generates an YAML file from the current DB schema - */ - function generate(){ - $this->out('Generating full schema YAML file schema.yml...'); - $this->out(''); - $this->hr(); - $this->out(''); - $oFile = new File( MIGRATIONS_PATH . DS . 'schema.yml', true ); - if( !$oFile->writable() ){ - $this->out( '' ); - $this->out( 'Your migrations folder is not writable - I could not write the file schema.yml . Please check your permissions.' ); - $this->out(''); - exit; - } - $oFile->write( $this->oMigrations->generate() ); - $this->out( 'Schema file ( schema.yml ) successfully written!' ); - $this->out(''); - } - - /** - * Migrates down to the previous version - */ - function down(){ - $this->iTo_version = ($this->iCurrent_version === 0) ? $this->iCurrent_version : $this->iCurrent_version - 1; - $this->_run(); - $this->out('Migrations completed.'); - $this->out(''); - $this->hr(); - $this->out(''); - exit; - } - - /** - * Migrates up to the next version - */ - function up(){ - $this->iTo_version = ($this->iCurrent_version == $this->iMigration_count) ? $this->iCurrent_version : $this->iCurrent_version + 1; - $this->_run(); - $this->out('Migrations completed.'); - $this->out(''); - $this->hr(); - $this->out(''); - exit; - } - - /** - * Reset migration version to zero without running migrations up or down and drops all tables - */ - function reset(){ - $this->iTo_version = 0; - $aTables = $this->oMigrations->oDb->listSources(); - foreach( $aTables as $sTable )if( $sTable !== 'schema_info' ){ - $this->oMigrations->oDb->query( $this->oMigrations->drop_table( $sTable ) ); - } - $this->_updateVersion(0); - $this->hr(); - $this->out(''); - $this->out(' ** Schema reset **'); - $this->out(''); - $this->out(''); - $this->out('Migrations completed.'); - $this->out(''); - $this->hr(); - $this->out(''); - exit; - } - - /** - * Runs all migrations from the current version down and back up to the latest version. - */ - function all(){ - if( $this->iCurrent_version > 0 ) - $this->_migrate_to_version(0); - $this->_migrate_to_version($this->iMigration_count); - $this->out(''); - $this->hr(); - $this->out(''); - $this->out('All migrations completed.'); - $this->out(''); - $this->hr(); - $this->out(''); - exit; - } - - /** - * Modifies the out method for prettier formatting - * - * @param string $sString String to output. - * @param boolean $bNewline If true, the outputs gets an added newline. - */ - function out($sString, $bNewline = true) { - return parent::out(" ".$sString, $bNewline); - } - - /** - * Help method - */ - function help(){ - $this->hr(); - $this->out(''); - $this->out('Database migrations is a version control system for your database,'); - $this->out('allowing you to migrate your database schema between versions.'); - $this->out(''); - $this->out('Each version is depicted by a migration file written in YAML and must'); - $this->out('include an UP and DOWN section. The UP section is parsed and run when'); - $this->out('migrating up and vice versa.'); - $this->out(''); - $this->hr(); - $this->out(''); - $this->out('COMMAND LINE OPTIONS'); - $this->out(''); - $this->out(' cake migrate'); - $this->out(' - Migrates to the latest version (the last migration file)'); - $this->out(''); - $this->out(' cake migrate -v [version number]'); - $this->out(' - Migrates to the version specified [version number]'); - $this->out(''); - $this->out(' cake migrate reset'); - $this->out(' - Resets the current version to 0 and drops all tables.'); - $this->out(''); - $this->out(' cake migrate all'); - $this->out(' - Migrates down to 0 and back up to the latest version'); - $this->out(''); - $this->out(' cake migrate down'); - $this->out(' - Migrates down to the previous current version'); - $this->out(''); - $this->out(' cake migrate up'); - $this->out(' - Migrates up from the current to the next version'); - $this->out(''); - $this->out(' cake migrate generate'); - $this->out(' - Write an YAML file out of your current DB schema'); - $this->out(''); - $this->out(' cake migrate help'); - $this->out(' - Displays this Help'); - $this->out(''); - $this->out(" append '-c [connection]' to the command if you want to specify the"); - $this->out(' connection to use from database.php. By default it uses "default"'); - $this->out(''); - $this->out(''); - $this->out('For more information and for the latest release of this and others,'); - $this->out('go to http://ovalpixels.com'); - $this->out(''); - $this->hr(); - $this->out(''); - } - - /** - * Aliases for the help method - */ - function h() { $this->help(); } - - /** - * Private method used to alter the destination version and run the migrating method ( _run ) - * - * @access protected - * @param integer #iNewVersion The destination version - */ - function _migrate_to_version( $iNew_version ){ - if( !isset( $this->iTo_version ) || $iNew_version != $this->iTo_version ){ - $this->iTo_version = $iNew_version; - $this->_run(); - } - } - - /** - * Protected method which does all the dirty work. Compares the destination and current version of the schema and runs the respective UPs or DOWNs - */ - function _run(){ - $this->hr(); - - if( $this->iCurrent_version == $this->iTo_version ){ - $this->out(''); - $this->out(' ** Migration version is the same as the current version **'); - $this->out(''); - $this->hr(); - $this->out(''); - exit; - } - if ($this->iMigration_count === 0){ - $this->out(''); - $this->out(' ** No migrations found **'); - $this->out(''); - $this->hr(); - $this->out(''); - exit; - } - $iNew_version = $this->iTo_version; - - if (!is_numeric($iNew_version)){ - $this->out(''); - $this->out(' ** Migration version number ('.$iNew_version.') is invalid. **'); - $this->out(''); - $this->hr(); - $this->out(''); - exit; - } - if ($iNew_version > $this->iMigration_count){ - $this->out(''); - $this->out(' ** Version number entered ('.$iNew_version.') does not exist. **'); - $this->out(''); - $this->hr(); - $this->out(''); - exit; - } - - $sDirection = ($iNew_version < $this->iCurrent_version) ? 'down' : 'up'; - if ($sDirection == 'down') usort($this->aMigrations, array($this, '_downMigrations')); - elseif ($sDirection == 'up') usort($this->aMigrations, array($this, '_upMigrations')); - - $this->out(''); - $this->out("Migrating database $sDirection from version {$this->iCurrent_version} to $iNew_version ..."); - $this->out(''); - - foreach($this->aMigrations as $sMigration_name){ - preg_match("/^([0-9]+)\_(.+)(\.yml)$/", $sMigration_name, $aMatch); - $iNum = $this->_versionIt($aMatch[1]); - $sName = Inflector::humanize($aMatch[2]); - - if ($sDirection == 'up'){ - if ($iNum <= $this->iCurrent_version) continue; - if ($iNum > $iNew_version) break; - } - elseif( $sDirection == 'down' ){ - if ($iNum > $this->iCurrent_version) continue; - if ($iNum == $iNew_version) break; - } - - $this->out(" [$iNum] $sName ..."); - - $rRes = $this->_loadMigration(MIGRATIONS_PATH .DS. $sMigration_name, $sDirection); - if ($rRes === true){ - $this->out(''); - if ($sDirection == 'up'){ - $this->_updateVersion( 'version+1' ); - } - else{ - $this->_updateVersion( 'version-1' ); - } - } - elseif( is_numeric( $rRes ) && $rRes < 1 ){ - $this->out('Generic error: '.$rRes ); - $this->hr(); - exit; - } - else{ - $this->out(" ERROR: "); - foreach( $rRes as $aErr ){ - $this->out('Query: '.$aErr['sql']); - $this->out(''); - $this->out('Error: '.$aErr['error']); - } - $this->hr(); - exit; - } - } - } - - /** - * Loads the file with the YAML migration schema and runs the generates the SQL script for the specified direction - * - * @access protected - * @param string $sFile Path to the file - * @param string $sFile Path to the file - * @return mixed False on failure and a SQL command on success - */ - function _loadMigration( $sFile, $sDirection ){ - if( !$bLoad = $this->oMigrations->load($sFile) ){ - return $bLoad; - } - else - return $this->oMigrations->{$sDirection}(); - } - - /** - * An internal sort method - used with usort(). Sorts from top to bottom - * - * @access protected - * @param string $sA Name of a migration ( with the number in front ) - * @param string $sB Name of a migration ( with the number in front ) - * @return int < = > - */ - function _upMigrations($sA, $sB){ - list($aStr) = explode('_', $sA); - list($bStr) = explode('_', $sB); - $aNum = (int)$aStr; - $bNum = (int)$bStr; - if ($aNum == $bNum){ - return 0; - } - return ($aNum > $bNum) ? 1 : -1; - } - - /** - * An internal sort method - used with usort(). Sorts from bottom to top - * - * @access protected - * @param string $sA Name of a migration ( with the number in front ) - * @param string $sB Name of a migration ( with the number in front ) - * @return int < = > - */ - function _downMigrations($sA, $sB){ - list($aStr) = explode('_', $sA); - list($bStr) = explode('_', $sB); - $aNum = (int)$aStr; - $bNum = (int)$bStr; - if ($aNum == $bNum) { - return 0; - } - return ($aNum > $bNum) ? -1 : 1; - } - - /** - * Gets the current schema version from the DB. If schema_info doesn't exist - it tries to create it. - * - * @access protected - * @return int Current schema version - */ - function _getMigrationVersion(){ - //load tables and see if schema_info already exists. If not, create it - $sTables = $this->oMigrations->oDb->listSources(); - if( !in_array( 'schema_info', $sTables ) ){ - $this->oMigrations->oDb->query( - $this->oMigrations->create_table( - 'schema_info', - array( 0 => 'no_id', - 1 => 'no_dates', - 'version' => - array( 'type' => 'int', 'length' => 3, 'default' => '0' ) ) - ) - ); - //feed it with some data - App::import('model'); - $oTemp_model = new Model( false, 'schema_info' ); - $oTemp_model->saveField( 'version', '0' ); - $this->iCurrent_version = 0; - - } - else{ - App::import('model'); - $oTemp_model = new Model( false, 'schema_info' ); - $this->iCurrent_version = $oTemp_model->field( 'version' ); - } - } - - /** - * Update the current shchema version in the database - * - * @access protected - * @param mixed $sVersion The new schema version. Can be either an integer ( 1, 2, 3 ) or an expression ( version + 1 ) - * @return void - */ - function _updateVersion($sVersion){ - App::import('model'); - $oTemp_model = new Model( false, 'schema_info' ); - $oTemp_model->updateAll( array( 'version' => $sVersion ) ); - $this->_getMigrationVersion(); - } - - /** - * Loads the migration yaml files into an array ( self::aMigrations ) - * - * @access protected - * @return void - */ - function _getMigrations(){ - $oFolder = new Folder(MIGRATIONS_PATH, true, 0777); - $this->aMigrations = $oFolder->find("[0-9]+_.+\.yml"); - usort($this->aMigrations, array($this, '_upMigrations')); - $this->iMigration_count = count($this->aMigrations); - } - - /** - * Converts migration number to a minimum three digit number. - * - * @param $iNum The number to convert - * @return integer The converted three digit number - */ - function _versionIt($iNum){ - switch (strlen($iNum)){ - case 1: - return '00'.$iNum; - case 2: - return '0'.$iNum; - default: - return $iNum; - } - } - - /** - * Welcome method - */ - function _welcome(){ - $this->out(''); - $this->out(' __ __ _ _ __ ___ __ __ __ ___ __ _ _ __ '); - $this->out('| |__| |_/ |__ | | | | | _ |__| |__| | | | | |\ | |__ '); - $this->out('|__ | | | \_ |__ | | | | |__| | \_ | | | | |__| | \| __|'); - $this->out(''); - } +<?php +/** + * Migrations is a CakePHP shell script that runs your database migrations to the specified schema + * version. If no version is specified, migrations are run to the latest version. + * + * Run 'cake migrate help' for more info and help on using this script. + * + * Heavily based on Joel Moss' Migrations shell ( http://joelmoss.info ) but uses cake's internal functions instead of PEAR::MDB2 + * and doesn't have some methods I found unnecessary. + * + * Licensed under The MIT License + * Redistributions of files must retain the above copyright notice. + * + * @copyright Copyright 2008, Georgi Momchilov + * @link http://ovalpixels.com + * @author Georgi Momchilov + * @since CakePHP(tm) v 1.2 + * @license http://www.opensource.org/licenses/mit-license.php The MIT License + * +*/ + +uses('file', 'folder'); +App::import('vendor','spyc'); +App::import('vendor','migrations'); + + +class MigrateShell extends Shell { + + var $sConnection = 'default'; + var $aMigrations; + var $oMigrations; + + /** + * Initializes some paths and checks for the required classes + */ + function startup(){ + define('MIGRATIONS_PATH', APP_PATH .'config' .DS. 'migrations'); + + if(isset($this->params['c'])) $this->sConnection = $this->params['c']; + if(isset($this->params['connection'])) $this->sConnection = $this->params['connection']; + + if( !class_exists( 'Migrations' ) ) + $this->error( 'File not found', 'Migrations class is needed for this shell to run. Could not be found - exiting.' ); + + $this->oMigrations = new Migrations( $this->sConnection ); + + $this->_welcome(); + $this->out('App : '. APP_DIR); + $this->out('Path: '. ROOT . DS . APP_DIR); + $this->_getMigrationVersion(); + $this->out(''); + $this->out('Current schema version: '.$this->iCurrent_version); + $this->out(''); + $this->_getMigrations(); + } + + /** + * Main method: migrates to the latest version. + */ + function main(){ + if( !isset( $this->params['v'] ) ){ + $this->_migrate_to_version($this->iMigration_count); + } + else{ + $iTo_v = intval( $this->params['v'] ); + if( $iTo_v > $this->iMigration_count || $iTo_v < 0 ){ + $this->out(' ** Version number entered ('.$iTo_v.') does not exist. **'); + $this->out(''); + } + else{ + $this->_migrate_to_version( $iTo_v ); + } + } + $this->out('Migrations completed.'); + $this->out(''); + $this->hr(); + $this->out(''); + exit; + } + + /** + * Generates an YAML file from the current DB schema + */ + function generate(){ + $this->out('Generating full schema YAML file schema.yml...'); + $this->out(''); + $this->hr(); + $this->out(''); + $oFile = new File( MIGRATIONS_PATH . DS . 'schema.yml', true ); + if( !$oFile->writable() ){ + $this->out( '' ); + $this->out( 'Your migrations folder is not writable - I could not write the file schema.yml . Please check your permissions.' ); + $this->out(''); + exit; + } + $oFile->write( $this->oMigrations->generate() ); + $this->out( 'Schema file ( schema.yml ) successfully written!' ); + $this->out(''); + } + + /** + * Migrates down to the previous version + */ + function down(){ + $this->iTo_version = ($this->iCurrent_version === 0) ? $this->iCurrent_version : $this->iCurrent_version - 1; + $this->_run(); + $this->out('Migrations completed.'); + $this->out(''); + $this->hr(); + $this->out(''); + exit; + } + + /** + * Migrates up to the next version + */ + function up(){ + $this->iTo_version = ($this->iCurrent_version == $this->iMigration_count) ? $this->iCurrent_version : $this->iCurrent_version + 1; + $this->_run(); + $this->out('Migrations completed.'); + $this->out(''); + $this->hr(); + $this->out(''); + exit; + } + + /** + * Reset migration version to zero without running migrations up or down and drops all tables + */ + function reset(){ + $this->iTo_version = 0; + $aTables = $this->oMigrations->oDb->listSources(); + foreach( $aTables as $sTable )if( $sTable !== 'schema_info' ){ + $this->oMigrations->oDb->query( $this->oMigrations->drop_table( $sTable ) ); + } + $this->_updateVersion(0); + $this->hr(); + $this->out(''); + $this->out(' ** Schema reset **'); + $this->out(''); + $this->out(''); + $this->out('Migrations completed.'); + $this->out(''); + $this->hr(); + $this->out(''); + exit; + } + + /** + * Runs all migrations from the current version down and back up to the latest version. + */ + function all(){ + if( $this->iCurrent_version > 0 ) + $this->_migrate_to_version(0); + $this->_migrate_to_version($this->iMigration_count); + $this->out(''); + $this->hr(); + $this->out(''); + $this->out('All migrations completed.'); + $this->out(''); + $this->hr(); + $this->out(''); + exit; + } + + /** + * Modifies the out method for prettier formatting + * + * @param string $sString String to output. + * @param boolean $bNewline If true, the outputs gets an added newline. + */ + function out($sString, $bNewline = true) { + return parent::out(" ".$sString, $bNewline); + } + + /** + * Help method + */ + function help(){ + $this->hr(); + $this->out(''); + $this->out('Database migrations is a version control system for your database,'); + $this->out('allowing you to migrate your database schema between versions.'); + $this->out(''); + $this->out('Each version is depicted by a migration file written in YAML and must'); + $this->out('include an UP and DOWN section. The UP section is parsed and run when'); + $this->out('migrating up and vice versa.'); + $this->out(''); + $this->hr(); + $this->out(''); + $this->out('COMMAND LINE OPTIONS'); + $this->out(''); + $this->out(' cake migrate'); + $this->out(' - Migrates to the latest version (the last migration file)'); + $this->out(''); + $this->out(' cake migrate -v [version number]'); + $this->out(' - Migrates to the version specified [version number]'); + $this->out(''); + $this->out(' cake migrate reset'); + $this->out(' - Resets the current version to 0 and drops all tables.'); + $this->out(''); + $this->out(' cake migrate all'); + $this->out(' - Migrates down to 0 and back up to the latest version'); + $this->out(''); + $this->out(' cake migrate down'); + $this->out(' - Migrates down to the previous current version'); + $this->out(''); + $this->out(' cake migrate up'); + $this->out(' - Migrates up from the current to the next version'); + $this->out(''); + $this->out(' cake migrate generate'); + $this->out(' - Write an YAML file out of your current DB schema'); + $this->out(''); + $this->out(' cake migrate help'); + $this->out(' - Displays this Help'); + $this->out(''); + $this->out(" append '-c [connection]' to the command if you want to specify the"); + $this->out(' connection to use from database.php. By default it uses "default"'); + $this->out(''); + $this->out(''); + $this->out('For more information and for the latest release of this and others,'); + $this->out('go to http://ovalpixels.com'); + $this->out(''); + $this->hr(); + $this->out(''); + } + + /** + * Aliases for the help method + */ + function h() { $this->help(); } + + /** + * Private method used to alter the destination version and run the migrating method ( _run ) + * + * @access protected + * @param integer #iNewVersion The destination version + */ + function _migrate_to_version( $iNew_version ){ + if( !isset( $this->iTo_version ) || $iNew_version != $this->iTo_version ){ + $this->iTo_version = $iNew_version; + $this->_run(); + } + } + + /** + * Protected method which does all the dirty work. Compares the destination and current version of the schema and runs the respective UPs or DOWNs + */ + function _run(){ + $this->hr(); + + if( $this->iCurrent_version == $this->iTo_version ){ + $this->out(''); + $this->out(' ** Migration version is the same as the current version **'); + $this->out(''); + $this->hr(); + $this->out(''); + exit; + } + if ($this->iMigration_count === 0){ + $this->out(''); + $this->out(' ** No migrations found **'); + $this->out(''); + $this->hr(); + $this->out(''); + exit; + } + $iNew_version = $this->iTo_version; + + if (!is_numeric($iNew_version)){ + $this->out(''); + $this->out(' ** Migration version number ('.$iNew_version.') is invalid. **'); + $this->out(''); + $this->hr(); + $this->out(''); + exit; + } + if ($iNew_version > $this->iMigration_count){ + $this->out(''); + $this->out(' ** Version number entered ('.$iNew_version.') does not exist. **'); + $this->out(''); + $this->hr(); + $this->out(''); + exit; + } + + $sDirection = ($iNew_version < $this->iCurrent_version) ? 'down' : 'up'; + if ($sDirection == 'down') usort($this->aMigrations, array($this, '_downMigrations')); + elseif ($sDirection == 'up') usort($this->aMigrations, array($this, '_upMigrations')); + + $this->out(''); + $this->out("Migrating database $sDirection from version {$this->iCurrent_version} to $iNew_version ..."); + $this->out(''); + + foreach($this->aMigrations as $sMigration_name){ + preg_match("/^([0-9]+)\_(.+)(\.yml)$/", $sMigration_name, $aMatch); + $iNum = $this->_versionIt($aMatch[1]); + $sName = Inflector::humanize($aMatch[2]); + + if ($sDirection == 'up'){ + if ($iNum <= $this->iCurrent_version) continue; + if ($iNum > $iNew_version) break; + } + elseif( $sDirection == 'down' ){ + if ($iNum > $this->iCurrent_version) continue; + if ($iNum == $iNew_version) break; + } + + $this->out(" [$iNum] $sName ..."); + + $rRes = $this->_loadMigration(MIGRATIONS_PATH .DS. $sMigration_name, $sDirection); + if ($rRes === true){ + $this->out(''); + if ($sDirection == 'up'){ + $this->_updateVersion( 'version+1' ); + } + else{ + $this->_updateVersion( 'version-1' ); + } + } + elseif( is_numeric( $rRes ) && $rRes < 1 ){ + $this->out('Generic error: '.$rRes ); + $this->hr(); + exit; + } + else{ + $this->out(" ERROR: "); + foreach( $rRes as $aErr ){ + $this->out('Query: '.$aErr['sql']); + $this->out(''); + $this->out('Error: '.$aErr['error']); + } + $this->hr(); + exit; + } + } + } + + /** + * Loads the file with the YAML migration schema and runs the generates the SQL script for the specified direction + * + * @access protected + * @param string $sFile Path to the file + * @param string $sFile Path to the file + * @return mixed False on failure and a SQL command on success + */ + function _loadMigration( $sFile, $sDirection ){ + if( !$bLoad = $this->oMigrations->load($sFile) ){ + return $bLoad; + } + else + return $this->oMigrations->{$sDirection}(); + } + + /** + * An internal sort method - used with usort(). Sorts from top to bottom + * + * @access protected + * @param string $sA Name of a migration ( with the number in front ) + * @param string $sB Name of a migration ( with the number in front ) + * @return int < = > + */ + function _upMigrations($sA, $sB){ + list($aStr) = explode('_', $sA); + list($bStr) = explode('_', $sB); + $aNum = (int)$aStr; + $bNum = (int)$bStr; + if ($aNum == $bNum){ + return 0; + } + return ($aNum > $bNum) ? 1 : -1; + } + + /** + * An internal sort method - used with usort(). Sorts from bottom to top + * + * @access protected + * @param string $sA Name of a migration ( with the number in front ) + * @param string $sB Name of a migration ( with the number in front ) + * @return int < = > + */ + function _downMigrations($sA, $sB){ + list($aStr) = explode('_', $sA); + list($bStr) = explode('_', $sB); + $aNum = (int)$aStr; + $bNum = (int)$bStr; + if ($aNum == $bNum) { + return 0; + } + return ($aNum > $bNum) ? -1 : 1; + } + + /** + * Gets the current schema version from the DB. If schema_info doesn't exist - it tries to create it. + * + * @access protected + * @return int Current schema version + */ + function _getMigrationVersion(){ + //load tables and see if schema_info already exists. If not, create it + $sTables = $this->oMigrations->oDb->listSources(); + if( !in_array( $this->oMigrations->oDb->config['prefix'].'schema_info', $sTables ) ){ + $this->oMigrations->oDb->query( + $this->oMigrations->create_table( + 'schema_info', + array( 0 => 'no_id', + 1 => 'no_dates', + 'version' => + array( 'type' => 'int', 'length' => 3, 'default' => '0' ) ) + ) + ); + //feed it with some data + App::import('model'); + $oTemp_model = new Model( false, 'schema_info' ); + $oTemp_model->saveField( 'version', '0' ); + $this->iCurrent_version = 0; + + } + else{ + App::import('model'); + $oTemp_model = new Model( false, 'schema_info' ); + $this->iCurrent_version = $oTemp_model->field( 'version' ); + } + } + + /** + * Update the current shchema version in the database + * + * @access protected + * @param mixed $sVersion The new schema version. Can be either an integer ( 1, 2, 3 ) or an expression ( version + 1 ) + * @return void + */ + function _updateVersion($sVersion){ + App::import('model'); + $oTemp_model = new Model( false, 'schema_info' ); + $oTemp_model->updateAll( array( 'version' => $sVersion ) ); + $this->_getMigrationVersion(); + } + + /** + * Loads the migration yaml files into an array ( self::aMigrations ) + * + * @access protected + * @return void + */ + function _getMigrations(){ + $oFolder = new Folder(MIGRATIONS_PATH, true, 0777); + $this->aMigrations = $oFolder->find("[0-9]+_.+\.yml"); + usort($this->aMigrations, array($this, '_upMigrations')); + $this->iMigration_count = count($this->aMigrations); + } + + /** + * Converts migration number to a minimum three digit number. + * + * @param $iNum The number to convert + * @return integer The converted three digit number + */ + function _versionIt($iNum){ + switch (strlen($iNum)){ + case 1: + return '00'.$iNum; + case 2: + return '0'.$iNum; + default: + return $iNum; + } + } + + /** + * Welcome method + */ + function _welcome(){ + $this->out(''); + $this->out(' __ __ _ _ __ ___ __ __ __ ___ __ _ _ __ '); + $this->out('| |__| |_/ |__ | | | | | _ |__| |__| | | | | |\ | |__ '); + $this->out('|__ | | | \_ |__ | | | | |__| | \_ | | | | |__| | \| __|'); + $this->out(''); + } } \ No newline at end of file shells/migrate.php cda9ea229e60be72d88c91a3a2c3a0ff68c993bc Georgi Momchilov georgious@georgious-laptop.lan http://github.com/georgious/cakephp-yaml-migrations-and-fixtures/commit/758c22357482e68cd9209389735792d569242b39 758c22357482e68cd9209389735792d569242b39 2008-06-13T04:45:53-07:00 2008-06-13T04:45:53-07:00 migrations prefix fix edf31287982bd457f659d8b99eddd3aada85ce92 Georgi Momchilov georgious@georgious-laptop.lan