/home/arranoyd/otours_bak/wp-content/plugins/wordpress-seo/src/initializers/migration-runner.php
<?php
/**
* Yoast SEO Plugin File.
*
* @package Yoast\YoastSEO\Config
*/
namespace Yoast\WP\SEO\Initializers;
use Exception;
use Yoast\WP\Lib\Model;
use Yoast\WP\SEO\Config\Migration_Status;
use Yoast\WP\SEO\Config\Ruckusing_Framework;
/**
* Triggers database migrations and handles results.
*/
class Migration_Runner implements Initializer_Interface {
/**
* Retrieves the conditionals for the migrations.
*
* @return array The conditionals.
*/
public static function get_conditionals() {
return [];
}
/**
* The Ruckusing framework runner.
*
* @var Ruckusing_Framework
*/
protected $framework;
/**
* The migration status.
*
* @var Migration_Status
*/
protected $migration_status;
/**
* Migrations constructor.
*
* @param Migration_Status $migration_status The migration status.
* @param Ruckusing_Framework $framework The Ruckusing framework runner.
*/
public function __construct(
Migration_Status $migration_status,
Ruckusing_Framework $framework
) {
$this->migration_status = $migration_status;
$this->framework = $framework;
}
/**
* Runs this initializer.
*
* @throws \Exception When a migration errored.
*
* @return void
*/
public function initialize() {
$this->run_free_migrations();
// The below actions is used for when queries fail, this may happen in a multisite environment when switch_to_blog is used.
\add_action( '_yoast_run_migrations', [ $this, 'run_free_migrations' ] );
}
/**
* Runs the free migrations.
*
* @throws \Exception When a migration errored.
*
* @return void
*/
public function run_free_migrations() {
$this->run_migrations( 'free', Model::get_table_name( 'migrations' ), \WPSEO_PATH . 'src/config/migrations' );
}
/**
* Initializes the migrations.
*
* @param string $name The name of the migration.
* @param string $migrations_table_name The migrations table name.
* @param string $migrations_directory The migrations directory.
*
* @return bool True on success, false on failure.
*
* @throws \Exception If the migration fails and YOAST_ENVIRONMENT is not production.
*/
public function run_migrations( $name, $migrations_table_name, $migrations_directory ) {
if ( ! $this->migration_status->should_run_migration( $name ) ) {
return true;
}
if ( ! $this->migration_status->lock_migration( $name ) ) {
return false;
}
try {
$framework_runner = $this->framework->get_framework_runner( $migrations_table_name, $migrations_directory );
/**
* This variable represents Ruckusing_Adapter_MySQL_Base adapter.
*
* @var \YoastSEO_Vendor\Ruckusing_Adapter_MySQL_Base $adapter
*/
$adapter = $framework_runner->get_adapter();
// Create our own migrations table with a 191 string limit to support older versions of MySQL.
// Run this before calling the framework runner so it doesn't create it's own.
if ( ! $adapter->has_table( $migrations_table_name ) ) {
$table = $adapter->create_table( $migrations_table_name );
$table->column( 'version', 'string', [ 'limit' => 191 ] );
$table->finish();
$adapter->add_index( $migrations_table_name, 'version', [ 'unique' => true ] );
}
// Create our own task manager so we can set RUCKUSING_BASE to a nonsense directory as it's impossible to
// determine the actual directory if the plugin is installed with composer.
$task_manager = $this->framework->get_framework_task_manager( $adapter, $migrations_table_name, $migrations_directory );
$task_manager->execute( $framework_runner, 'db:migrate', [] );
} catch ( Exception $exception ) {
// Something went wrong...
$this->migration_status->set_error( $name, $exception->getMessage() );
if ( \defined( 'YOAST_ENVIRONMENT' ) && \YOAST_ENVIRONMENT !== 'production' ) {
throw $exception;
}
return false;
}
$this->migration_status->set_success( $name );
return true;
}
}