-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add ability to migrate from IndexNow plugin in automatic mode
- Loading branch information
Showing
4 changed files
with
276 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,264 @@ | ||
| <?php | ||
| /** | ||
| * Database migrations. | ||
| * | ||
| * @package Mihdan\ReCrawler | ||
| */ | ||
|
|
||
| namespace Mihdan\ReCrawler\Migrations; | ||
|
|
||
| class Migrations { | ||
|
|
||
| /** | ||
| * Migrated versions options name. | ||
| */ | ||
| const MIGRATED_VERSIONS_OPTION_NAME = 'recrawler_versions'; | ||
|
|
||
| /** | ||
| * Plugin version. | ||
| */ | ||
| const PLUGIN_VERSION = RECRAWLER_VERSION; | ||
|
|
||
| /** | ||
| * Migration started status. | ||
| */ | ||
| const STARTED = - 1; | ||
|
|
||
| /** | ||
| * Migration failed status. | ||
| */ | ||
| const FAILED = - 2; | ||
|
|
||
| /** | ||
| * Plugin name. | ||
| */ | ||
| const PLUGIN_NAME = 'ReCrawler'; | ||
|
|
||
| /** | ||
| * Init hooks. | ||
| * | ||
| * @return void | ||
| */ | ||
| public function setup_hooks() { | ||
|
|
||
| if ( ! $this->is_allowed() ) { | ||
| return; | ||
| } | ||
|
|
||
| add_action( 'plugins_loaded', [ $this, 'migrate' ], - PHP_INT_MAX ); | ||
| } | ||
|
|
||
| /** | ||
| * Migrate. | ||
| * | ||
| * @return void | ||
| */ | ||
| public function migrate() { | ||
| $migrated = (array) get_option( self::MIGRATED_VERSIONS_OPTION_NAME, [] ); | ||
|
|
||
| //$this->check_plugin_update( $migrated ); | ||
|
|
||
| $migrations = array_filter( | ||
| get_class_methods( $this ), | ||
| static function ( $migration ) { | ||
| return false !== strpos( $migration, 'migrate_' ); | ||
| } | ||
| ); | ||
|
|
||
| $upgrade_versions = []; | ||
|
|
||
| foreach ( $migrations as $migration ) { | ||
| $upgrade_version = $this->get_upgrade_version( $migration ); | ||
|
|
||
|
|
||
|
|
||
| $upgrade_versions[] = $upgrade_version; | ||
|
|
||
| if ( | ||
| ( isset( $migrated[ $upgrade_version ] ) && $migrated[ $upgrade_version ] >= 0 ) || | ||
| version_compare( $upgrade_version, self::PLUGIN_VERSION, '>' ) | ||
| ) { | ||
| continue; | ||
| } | ||
|
|
||
| if ( ! isset( $migrated[ $upgrade_version ] ) ) { | ||
| $migrated[ $upgrade_version ] = static::STARTED; | ||
|
|
||
| $this->log( sprintf( 'Migration of %1$s to %2$s started.', self::PLUGIN_NAME, $upgrade_version ) ); | ||
| } | ||
|
|
||
| // Run migration. | ||
| $result = $this->{$migration}(); | ||
|
|
||
| // Some migration methods can be called several times to support AS action, | ||
| // so do not log their completion here. | ||
| if ( null === $result ) { | ||
| // @codeCoverageIgnoreStart | ||
| continue; | ||
| // @codeCoverageIgnoreEnd | ||
| } | ||
|
|
||
| $migrated[ $upgrade_version ] = $result ? time() : static::FAILED; | ||
|
|
||
| $this->log_migration_message( $result, $upgrade_version ); | ||
| } | ||
|
|
||
| // Remove any keys that are not in the migrations list. | ||
| $migrated = array_intersect_key( $migrated, array_flip( $upgrade_versions ) ); | ||
|
|
||
| // Store the current version. | ||
| $migrated[ self::PLUGIN_VERSION ] = $migrated[ self::PLUGIN_VERSION ] ?? time(); | ||
|
|
||
| // Sort the array by version. | ||
| uksort( $migrated, 'version_compare' ); | ||
|
|
||
| update_option( self::MIGRATED_VERSIONS_OPTION_NAME, $migrated ); | ||
| } | ||
|
|
||
| /** | ||
| * Determine if migration is allowed. | ||
| */ | ||
| public function is_allowed(): bool { | ||
| // phpcs:ignore WordPress.Security.NonceVerification.Recommended | ||
| if ( isset( $_GET['service-worker'] ) ) { | ||
| return false; | ||
| } | ||
|
|
||
| return wp_doing_cron() || is_admin() || ( defined( 'WP_CLI' ) && constant( 'WP_CLI' ) ); | ||
| } | ||
|
|
||
| /** | ||
| * Check if the plugin was updated. | ||
| * | ||
| * @param array $migrated Migrated versions. | ||
| * | ||
| * @return void | ||
| */ | ||
| private function check_plugin_update( array $migrated ) { | ||
| if ( isset( $migrated[ self::PLUGIN_VERSION ] ) ) { | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get an upgrade version from the method name. | ||
| * | ||
| * @param string $method Method name. | ||
| * | ||
| * @return string | ||
| */ | ||
| private function get_upgrade_version( string $method ): string { | ||
| // Find only the digits and underscores to get version number. | ||
| if ( ! preg_match( '/(\d_?)+/', $method, $matches ) ) { | ||
| // @codeCoverageIgnoreStart | ||
| return ''; | ||
| // @codeCoverageIgnoreEnd | ||
| } | ||
|
|
||
| $raw_version = $matches[0]; | ||
|
|
||
| if ( strpos( $raw_version, '_' ) ) { | ||
| // Modern notation: 3_10_0 means 3.10.0 version. | ||
|
|
||
| // @codeCoverageIgnoreStart | ||
| return str_replace( '_', '.', $raw_version ); | ||
| // @codeCoverageIgnoreEnd | ||
| } | ||
|
|
||
| // Legacy notation, with 1-digit subversion numbers: 360 means 3.6.0 version. | ||
| return implode( '.', str_split( $raw_version ) ); | ||
| } | ||
|
|
||
| /** | ||
| * Output message into log file. | ||
| * | ||
| * @param string $message Message to log. | ||
| * | ||
| * @return void | ||
| * @noinspection ForgottenDebugOutputInspection | ||
| */ | ||
| private function log( string $message ) { | ||
| if ( ! ( defined( 'WP_DEBUG' ) && constant( 'WP_DEBUG' ) ) ) { | ||
| // @codeCoverageIgnoreStart | ||
| return; | ||
| // @codeCoverageIgnoreEnd | ||
| } | ||
|
|
||
| // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log | ||
| error_log( self::PLUGIN_NAME . ': ' . $message ); | ||
| } | ||
|
|
||
| /** | ||
| * Log migration message. | ||
| * | ||
| * @param bool $migrated Migration status. | ||
| * @param string $upgrade_version Upgrade version. | ||
| * | ||
| * @return void | ||
| */ | ||
| private function log_migration_message( bool $migrated, string $upgrade_version ) { | ||
|
|
||
| $message = $migrated ? | ||
| sprintf( 'Migration of %1$s to %2$s completed.', self::PLUGIN_NAME, $upgrade_version ) : | ||
| // @codeCoverageIgnoreStart | ||
| sprintf( 'Migration of %1$s to %2$s failed.', self::PLUGIN_NAME, $upgrade_version ); | ||
| // @codeCoverageIgnoreEnd | ||
|
|
||
| $this->log( $message ); | ||
| } | ||
|
|
||
| /** | ||
| * Migrate to 0.1.2 | ||
| * | ||
| * @return bool|null | ||
| * @noinspection MultiAssignmentUsageInspection | ||
| * @noinspection PhpUnused | ||
| */ | ||
| protected function migrate_0_1_2() { | ||
| global $wpdb; | ||
|
|
||
| delete_option( 'mihdan_index_now_version' ); | ||
|
|
||
| $options_map = [ | ||
| 'mihdan_index_now_general' => 'recrawler_general', | ||
| 'mihdan_index_now_index_now' => 'recrawler_index_now', | ||
| 'mihdan_index_now_bing_webmaster' => 'recrawler_bing_webmaster', | ||
| 'mihdan_index_now_google_webmaster' => 'recrawler_google_webmaster', | ||
| 'mihdan_index_now_yandex_webmaster' => 'recrawler_yandex_webmaster', | ||
| 'mihdan_index_now_logs' => 'recrawler_logs', | ||
| 'mihdan_index_now_plugins' => 'recrawler_plugins', | ||
|
|
||
| ]; | ||
|
|
||
| foreach ( $options_map as $old_option_name => $new_option_name ) { | ||
| $new_option = get_option( $new_option_name, '' ); | ||
|
|
||
| if ( ! empty( $new_option ) ) { | ||
| continue; | ||
| } | ||
|
|
||
| $old_option = get_option( $old_option_name, '' ); | ||
|
|
||
| if ( empty( $old_option ) ) { | ||
| continue; | ||
| } | ||
|
|
||
| update_option( $new_option_name, $old_option ); | ||
| delete_option( $old_option_name ); | ||
| } | ||
|
|
||
| if ( is_multisite() ) { | ||
| $sites = get_sites( [ 'fields' => 'ids' ] ); | ||
|
|
||
| foreach ( $sites as $site_id ) { | ||
| switch_to_blog( $site_id ); | ||
| $wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}recrawler_log" ); // phpcs:ignore | ||
| restore_current_blog(); | ||
| } | ||
| } else { | ||
| $wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}recrawler_log" ); // phpcs:ignore | ||
| } | ||
|
|
||
| return true; | ||
| } | ||
| } |