Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Commands;

[2] Fix | Delete

[3] Fix | Delete

use WP_CLI;

[4] Fix | Delete

use WP_CLI\ExitException;

[5] Fix | Delete

use WP_CLI\Utils;

[6] Fix | Delete

use Yoast\WP\SEO\Integrations\Cleanup_Integration;

[7] Fix | Delete

use Yoast\WP\SEO\Main;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* A WP CLI command that helps with cleaning up unwanted records from our custom tables.

[11] Fix | Delete

[12] Fix | Delete

final class Cleanup_Command implements Command_Interface {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* The integration that cleans up on cron.

[16] Fix | Delete

[17] Fix | Delete

* @var Cleanup_Integration

[18] Fix | Delete

[19] Fix | Delete

private $cleanup_integration;

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* The constructor.

[23] Fix | Delete

[24] Fix | Delete

* @param Cleanup_Integration $cleanup_integration The integration that cleans up on cron.

[25] Fix | Delete

[26] Fix | Delete

public function __construct( Cleanup_Integration $cleanup_integration ) {

[27] Fix | Delete

$this->cleanup_integration = $cleanup_integration;

[28] Fix | Delete

}

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Returns the namespace of this command.

[32] Fix | Delete

[33] Fix | Delete

* @return string

[34] Fix | Delete

[35] Fix | Delete

public static function get_namespace() {

[36] Fix | Delete

return Main::WP_CLI_NAMESPACE;

[37] Fix | Delete

}

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Performs a cleanup of custom Yoast tables.

[41] Fix | Delete

[42] Fix | Delete

* This removes unused, unwanted or orphaned database records, which ensures the best performance. Including:

[43] Fix | Delete

* - Indexables

[44] Fix | Delete

* - Indexable hierarchy

[45] Fix | Delete

* - SEO links

[46] Fix | Delete

[47] Fix | Delete

* ## OPTIONS

[48] Fix | Delete

[49] Fix | Delete

* [--batch-size=<batch-size>]

[50] Fix | Delete

* : The number of database records to clean up in a single sql query.

[51] Fix | Delete

* ---

[52] Fix | Delete

* default: 1000

[53] Fix | Delete

* ---

[54] Fix | Delete

[55] Fix | Delete

* [--interval=<interval>]

[56] Fix | Delete

* : The number of microseconds (millionths of a second) to wait between cleanup batches.

[57] Fix | Delete

* ---

[58] Fix | Delete

* default: 500000

[59] Fix | Delete

* ---

[60] Fix | Delete

[61] Fix | Delete

* [--network]

[62] Fix | Delete

* : Performs the cleanup on all sites within the network.

[63] Fix | Delete

[64] Fix | Delete

* ## EXAMPLES

[65] Fix | Delete

[66] Fix | Delete

* wp yoast cleanup

[67] Fix | Delete

[68] Fix | Delete

* @when after_wp_load

[69] Fix | Delete

[70] Fix | Delete

* @param array|null $args The arguments.

[71] Fix | Delete

* @param array|null $assoc_args The associative arguments.

[72] Fix | Delete

[73] Fix | Delete

* @return void

[74] Fix | Delete

[75] Fix | Delete

* @throws ExitException When the input args are invalid.

[76] Fix | Delete

[77] Fix | Delete

public function cleanup( $args = null, $assoc_args = null ) {

[78] Fix | Delete

if ( isset( $assoc_args['interval'] ) && (int) $assoc_args['interval'] < 0 ) {

[79] Fix | Delete

WP_CLI::error( \__( 'The value for \'interval\' must be a positive integer.', 'wordpress-seo' ) );

[80] Fix | Delete

}

[81] Fix | Delete

if ( isset( $assoc_args['batch-size'] ) && (int) $assoc_args['batch-size'] < 1 ) {

[82] Fix | Delete

WP_CLI::error( \__( 'The value for \'batch-size\' must be a positive integer higher than equal to 1.', 'wordpress-seo' ) );

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

if ( isset( $assoc_args['network'] ) && \is_multisite() ) {

[86] Fix | Delete

$total_removed = $this->cleanup_network( $assoc_args );

[87] Fix | Delete

}

[88] Fix | Delete

else {

[89] Fix | Delete

$total_removed = $this->cleanup_current_site( $assoc_args );

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

WP_CLI::success(

[93] Fix | Delete

\sprintf(

[94] Fix | Delete

/* translators: %1$d is the number of records that are removed. */

[95] Fix | Delete

\_n(

[96] Fix | Delete

'Cleaned up %1$d record.',

[97] Fix | Delete

'Cleaned up %1$d records.',

[98] Fix | Delete

$total_removed,

[99] Fix | Delete

'wordpress-seo'

[100] Fix | Delete

[101] Fix | Delete

$total_removed

[102] Fix | Delete

)

[103] Fix | Delete

);

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Performs the cleanup for the entire network.

[108] Fix | Delete

[109] Fix | Delete

* @param array|null $assoc_args The associative arguments.

[110] Fix | Delete

[111] Fix | Delete

* @return int The number of cleaned up records.

[112] Fix | Delete

[113] Fix | Delete

private function cleanup_network( $assoc_args ) {

[114] Fix | Delete

$criteria = [

[115] Fix | Delete

'fields' => 'ids',

[116] Fix | Delete

'spam' => 0,

[117] Fix | Delete

'deleted' => 0,

[118] Fix | Delete

'archived' => 0,

[119] Fix | Delete

];

[120] Fix | Delete

$blog_ids = \get_sites( $criteria );

[121] Fix | Delete

$total_removed = 0;

[122] Fix | Delete

foreach ( $blog_ids as $blog_id ) {

[123] Fix | Delete

\switch_to_blog( $blog_id );

[124] Fix | Delete

$total_removed += $this->cleanup_current_site( $assoc_args );

[125] Fix | Delete

\restore_current_blog();

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

return $total_removed;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

/**

[132] Fix | Delete

* Performs the cleanup for a single site.

[133] Fix | Delete

[134] Fix | Delete

* @param array|null $assoc_args The associative arguments.

[135] Fix | Delete

[136] Fix | Delete

* @return int The number of cleaned up records.

[137] Fix | Delete

[138] Fix | Delete

private function cleanup_current_site( $assoc_args ) {

[139] Fix | Delete

$site_url = \site_url();

[140] Fix | Delete

$total_removed = 0;

[141] Fix | Delete

[142] Fix | Delete

if ( ! \is_plugin_active( \WPSEO_BASENAME ) ) {

[143] Fix | Delete

/* translators: %1$s is the site url of the site that is skipped. %2$s is Yoast SEO. */

[144] Fix | Delete

WP_CLI::warning( \sprintf( \__( 'Skipping %1$s. %2$s is not active on this site.', 'wordpress-seo' ), $site_url, 'Yoast SEO' ) );

[145] Fix | Delete

[146] Fix | Delete

return $total_removed;

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

// Make sure the DB is up to date first.

[150] Fix | Delete

\do_action( '_yoast_run_migrations' );

[151] Fix | Delete

[152] Fix | Delete

$tasks = $this->cleanup_integration->get_cleanup_tasks();

[153] Fix | Delete

$limit = (int) $assoc_args['batch-size'];

[154] Fix | Delete

$interval = (int) $assoc_args['interval'];

[155] Fix | Delete

[156] Fix | Delete

/* translators: %1$s is the site url of the site that is cleaned up. %2$s is the name of the cleanup task that is currently running. */

[157] Fix | Delete

$progress_bar_title_format = \__( 'Cleaning up %1$s [%2$s]', 'wordpress-seo' );

[158] Fix | Delete

$progress = Utils\make_progress_bar( \sprintf( $progress_bar_title_format, $site_url, \key( $tasks ) ), \count( $tasks ) );

[159] Fix | Delete

[160] Fix | Delete

foreach ( $tasks as $task_name => $task ) {

[161] Fix | Delete

// Update the progressbar title with the current task name.

[162] Fix | Delete

$progress->tick( 0, \sprintf( $progress_bar_title_format, $site_url, $task_name ) );

[163] Fix | Delete

do {

[164] Fix | Delete

$items_cleaned = $task( $limit );

[165] Fix | Delete

if ( \is_int( $items_cleaned ) ) {

[166] Fix | Delete

$total_removed += $items_cleaned;

[167] Fix | Delete

}

[168] Fix | Delete

\usleep( $interval );

[169] Fix | Delete

[170] Fix | Delete

// Update the timer.

[171] Fix | Delete

$progress->tick( 0 );

[172] Fix | Delete

} while ( $items_cleaned !== false && $items_cleaned > 0 );

[173] Fix | Delete

$progress->tick();

[174] Fix | Delete

}

[175] Fix | Delete

$progress->finish();

[176] Fix | Delete

[177] Fix | Delete

$this->cleanup_integration->reset_cleanup();

[178] Fix | Delete

WP_CLI::log(

[179] Fix | Delete

\sprintf(

[180] Fix | Delete

/* translators: %1$d is the number of records that were removed. %2$s is the site url. */

[181] Fix | Delete

\_n(

[182] Fix | Delete

'Cleaned up %1$d record from %2$s.',

[183] Fix | Delete

'Cleaned up %1$d records from %2$s.',

[184] Fix | Delete

$total_removed,

[185] Fix | Delete

'wordpress-seo'

[186] Fix | Delete

[187] Fix | Delete

$total_removed,

[188] Fix | Delete

$site_url

[189] Fix | Delete

)

[190] Fix | Delete

);

[191] Fix | Delete

[192] Fix | Delete

return $total_removed;

[193] Fix | Delete

}

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete