Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add NCC trickery #487

Merged
merged 11 commits into from
May 28, 2024
Merged

Add NCC trickery #487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1cc2923
Add NCC trickery
naxoc Apr 17, 2024
9a0f654
Also allow NCC nudge in encode
naxoc Apr 17, 2024
ffe32ff
Better logging and querying
naxoc Apr 17, 2024
5b87611
Make things work with all flags and args
naxoc Apr 18, 2024
38aabdb
Some code style
naxoc Apr 18, 2024
e03a1ab
Merge branch 'trunk' into add/ncc-trickery
naxoc Apr 22, 2024
a6ccc9a
Order when processsing to avoid programmer confusion
naxoc Apr 22, 2024
0b00b92
Merge branch 'trunk' into add/ncc-trickery
naxoc May 6, 2024
f7a5f3d
Remove NCC batch resetter - it's gone in the NCC too
naxoc May 7, 2024
b42e649
Merge branch 'trunk' into add/ncc-trickery
naxoc May 21, 2024
fafdd91
Added checks in case the post update fail
naxoc May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
293 changes: 255 additions & 38 deletions src/Command/General/BlockTransformerCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,28 @@
<?php
/**
* Gutenberg Block Transformer.
*
* Methods for encoding and decoding blocks in posts as base64 to "hide" them from the NCC.
*
* @package NewspackCustomContentMigrator
*/

namespace NewspackCustomContentMigrator\Command\General;

use NewspackContentConverter\Config;
use NewspackContentConverter\Installer;
use NewspackCustomContentMigrator\Command\InterfaceCommand;
use NewspackCustomContentMigrator\Logic\GutenbergBlockTransformer;
use NewspackCustomContentMigrator\Logic\Posts;
use NewspackCustomContentMigrator\Utils\Logger;
use WP_CLI;
use WP_CLI\ExitException;

class BlockTransformerCommand implements InterfaceCommand {


private Posts $posts_logic;
private Logger $logger;

private function __construct() {
$this->posts_logic = new Posts();
$this->logger = new Logger();
}

public static function get_instance(): self {
Expand All @@ -30,97 +39,305 @@ public static function get_instance(): self {
*/
public function register_commands(): void {
$generic_args = [
'synopsis' => '[--post-id=<post-id>] [--dry-run] [--num-items=<num-items>] [--min-post-id=<post-id>] [--max-post-id=<post-id>]',
'post-id' => [
'type' => 'assoc',
'name' => 'post-id',
'description' => 'The ID of the post to process.',
'optional' => true,
'repeating' => false,
],
'num-items' => [
'type' => 'assoc',
'name' => 'num-items',
'description' => 'The number of posts to process.',
'optional' => true,
'repeating' => false,
],
'min-post-id' => [
'type' => 'assoc',
'name' => 'min-post-id',
'description' => 'The minimum post ID to process.',
'optional' => true,
'repeating' => false,
],
'max-post-id' => [
'type' => 'assoc',
'name' => 'max-post-id',
'description' => 'The maximum post ID to process.',
'optional' => true,
'repeating' => false,
],
[
'type' => 'assoc',
'name' => 'post-types',
'description' => 'Comma-separated list of post types to process. Default is "post".',
'optional' => true,
'repeating' => false,
],
];

WP_CLI::add_command(
'newspack-content-migrator transform-blocks-encode',
[ $this, 'cmd_blocks_encode' ],
[
'shortdesc' => '"Obfuscate" blocks in posts by encoding them as base64.',
...$generic_args,
'synopsis' => [
...$generic_args,
],
]
);
WP_CLI::add_command(
'newspack-content-migrator transform-blocks-decode',
[ $this, 'cmd_blocks_decode' ],
[
'shortdesc' => '"Un-obfuscate" blocks in posts by decoding them.',
...$generic_args,
'synopsis' => [
...$generic_args,
],
]
);

WP_CLI::add_command(
'newspack-content-migrator transform-blocks-nudge',
[ $this, 'cmd_blocks_nudge' ],
[
'shortdesc' => '"Nudge" posts so NCC picks them up',
'synopsis' => [
...$generic_args,
],
]
);
}

/**
* @throws ExitException
*/
public function cmd_blocks_nudge( array $pos_args, array $assoc_args ): void {
$post_range = $this->get_post_id_range( $assoc_args );
if ( empty( $post_range ) ) {
WP_CLI::log( 'No posts to nudge. Try a bigger range of post ids maybe?' );

return;
}

$post_ids_format = implode( ', ', array_fill( 0, count( $post_range ), '%d' ) );
global $wpdb;

// Nudge the posts in the range that might need it.
$sql = $wpdb->prepare(
"UPDATE {$wpdb->posts} SET post_content = CONCAT(%s, post_content)
WHERE ID IN ($post_ids_format)
AND post_content LIKE %s",
[
PHP_EOL,
...$post_range,
$wpdb->esc_like( '<!--' ) . '%',
]
);

$posts_nudged = $wpdb->query( $sql );
$high = max( $post_range );
$low = min( $post_range );

WP_CLI::log( sprintf( 'Nudged %d posts between (and including) %d and %d ID', $posts_nudged, $low, $high ) );
}


public function cmd_blocks_decode( array $pos_args, array $assoc_args ): void {
$all_posts = $this->get_all_wp_posts( [ 'publish' ], $assoc_args );
$logfile = sprintf( '%s-%s.log', __FUNCTION__, wp_date( 'Y-m-d-H-i-s' ) );

$block_transformer = GutenbergBlockTransformer::get_instance();

foreach ( $all_posts as $post ) {
$post_id_range = $this->get_post_id_range( $assoc_args );
$post_ids_format = implode( ', ', array_fill( 0, count( $post_id_range ), '%d' ) );

global $wpdb;
$sql = $wpdb->prepare(
"SELECT ID, post_content FROM {$wpdb->posts}
WHERE ID IN ($post_ids_format)
AND post_content LIKE %s
ORDER BY ID DESC",
[ ...$post_id_range, '%' . $wpdb->esc_like( '[BLOCK-TRANSFORMER:' ) . '%' ]
);
$posts_to_decode = $wpdb->get_results( $sql );

$num_posts_found = count( $posts_to_decode );
$this->logger->log( $logfile, sprintf( 'Found %d posts to decode', $num_posts_found ), Logger::INFO );

$decoded_posts_counter = 0;
foreach ( $posts_to_decode as $post ) {
$content = $block_transformer->decode_post_content( $post->post_content );
if ( $content === $post->post_content ) {
// No changes - no more to do here.
continue;
}

wp_update_post(
$updated = wp_update_post(
[
'ID' => $post->ID,
'post_content' => $content,
]
);
WP_CLI::log( sprintf( 'Decoded blocks in %s', get_permalink( $post->ID ) ) );
if ( 0 === $updated || is_wp_error( $updated ) ) {
$this->logger->log( $logfile, sprintf( 'Could not decode blocks in ID %d %s', $post->ID, get_permalink( $post->ID ) ), Logger::ERROR );
} else {
$this->logger->log( $logfile, sprintf( 'Decoded blocks in ID %d %s', $post->ID, get_permalink( $post->ID ) ), Logger::SUCCESS );
++$decoded_posts_counter;
}

if ( 0 === $decoded_posts_counter % 25 ) {
$spacer = str_repeat( ' ', 10 );
WP_CLI::log(
sprintf(
'%s ==== Decoded %d of %d posts. %d remaining ==== %s',
$spacer,
$decoded_posts_counter,
$num_posts_found,
( $num_posts_found - $decoded_posts_counter ),
$spacer
)
);
}
}

$this->logger->log( $logfile, sprintf( '%d posts have been decoded', count( $posts_to_decode ) ), Logger::SUCCESS );
wp_cache_flush();
}

/**
* Obfuscate blocks in posts and optionally reset NCC to only work on the posts in the range.
*
* @param array $pos_args The positional arguments passed to the command.
* @param array $assoc_args The associative arguments passed to the command.
*
* @return void
* @throws ExitException
*/
public function cmd_blocks_encode( array $pos_args, array $assoc_args ): void {
$all_posts = $this->get_all_wp_posts( [ 'publish' ], $assoc_args );
$logfile = sprintf( '%s-%s.log', __FUNCTION__, wp_date( 'Y-m-d-H-i-s' ) );

$block_transformer = GutenbergBlockTransformer::get_instance();

foreach ( $all_posts as $post ) {
$post_id_range = $this->get_post_id_range( $assoc_args );
$post_ids_format = implode( ', ', array_fill( 0, count( $post_id_range ), '%d' ) );

global $wpdb;
$posts_to_encode = $wpdb->get_results(
$wpdb->prepare(
"SELECT ID, post_content FROM {$wpdb->posts}
WHERE ID IN ($post_ids_format)
AND post_content LIKE %s
ORDER BY ID DESC",
[ ...$post_id_range, $wpdb->esc_like( '<!-- ' ) . '%' ]
)
);
$num_posts_found = count( $posts_to_encode );
$this->logger->log( $logfile, sprintf( 'Found %d posts to encode', $num_posts_found ), Logger::INFO );

$encoded_posts_counter = 0;
foreach ( $posts_to_encode as $post ) {
$content = $block_transformer->encode_post_content( $post->post_content );
if ( $content === $post->post_content ) {
// No changes - no more to do here.
continue;
}
wp_update_post(

$updated = wp_update_post(
[
'ID' => $post->ID,
'post_content' => $content,
]
);
WP_CLI::log( sprintf( 'Encoded blocks in %s', get_permalink( $post->ID ) ) );
if ( 0 === $updated || is_wp_error( $updated ) ) {
$this->logger->log( $logfile, sprintf( 'Could not encode blocks in post ID %d %s', $post->ID, get_permalink( $post->ID ) ), Logger::ERROR );
continue;
} else {
$this->logger->log( $logfile, sprintf( 'Encoded blocks in post ID %d %s', $post->ID, get_permalink( $post->ID ) ), Logger::SUCCESS );

++$encoded_posts_counter;
}

if ( 0 === $encoded_posts_counter % 25 ) {
$spacer = str_repeat( ' ', 10 );
WP_CLI::log(
sprintf(
'%s ==== Encoded %d of %d posts. %d remaining ==== %s',
$spacer,
$encoded_posts_counter,
$num_posts_found,
( $num_posts_found - $encoded_posts_counter ),
$spacer
)
);
}
}
}

private function get_all_wp_posts( array $post_statuses, array $assoc_args = [], bool $log_progress = true ): iterable {
if ( ! empty( $assoc_args['post-id'] ) ) {
$all_ids = [ $assoc_args['post-id'] ];
} elseif ( ! empty( $assoc_args['min-post-id'] ) || ! empty( $assoc_args['max-post-id'] ) ) {
$low = $assoc_args['min-post-id'] ?? 0;
$high = $assoc_args['max-post-id'] ?? PHP_INT_MAX;
$all_ids = $this->posts_logic->get_post_ids_in_range( $low, $high, [ 'post' ], $post_statuses );
if ( ( $assoc_args['post-id'] ?? false ) ) {
$decode_command = sprintf( 'wp newspack-content-migrator transform-blocks-decode --post-id=%s', $assoc_args['post-id'] );
} else {
$all_ids = $this->posts_logic->get_all_posts_ids( 'post', $post_statuses );
$decode_command = sprintf(
'To decode the blocks AFTER running the NCC, run this:%s wp newspack-content-migrator transform-blocks-decode --min-post-id=%d --max-post-id=%d',
PHP_EOL,
min( $post_id_range ),
max( $post_id_range )
);
}
if ( ! empty( $assoc_args['num-items'] ) ) {
$all_ids = array_slice( $all_ids, 0, $assoc_args['num-items'] );
if ( ( $assoc_args['post-types'] ?? false ) ) {
$decode_command .= ' --post-types=' . $assoc_args['post-types'];
}
$this->logger->log( $logfile, sprintf( '%d posts needed encoding', $encoded_posts_counter ), Logger::SUCCESS );
$this->logger->log( $logfile, sprintf( 'To decode the blocks AFTER running the NCC, run this:%s %s', PHP_EOL, $decode_command ), Logger::INFO );

wp_cache_flush();
}

$total_posts = count( $all_ids );
$home_url = home_url();
$counter = 0;
if ( $log_progress ) {
WP_CLI::log( sprintf( 'Processing %d posts', count( $all_ids ) ) );

/**
* Get posts within the range specified in the arguments for the commands in this class.
*
* @param array $assoc_args The associative arguments passed to the command.
*
* @return array of post IDs.
*/
private function get_post_id_range( array $assoc_args ): array {
$post_types = [ 'post' ];
if ( ! empty( $assoc_args['post-types'] ) ) {
$post_types = explode( ',', $assoc_args['post-types'] );
}
global $wpdb;

foreach ( $all_ids as $post_id ) {
$post = get_post( $post_id );
if ( $post instanceof \WP_Post ) {
if ( $log_progress ) {
WP_CLI::log( sprintf( 'Processing post %d/%d: %s', ++ $counter, $total_posts, "${home_url}?p=${post_id}" ) );
}
yield $post;
if ( ! ( $assoc_args['post-id'] ?? false ) ) {
$num_items = $assoc_args['num-items'] ?? PHP_INT_MAX;
$min_post_id = $assoc_args['min-post-id'] ?? 0;
$max_post_id = $assoc_args['max-post-id'] ?? PHP_INT_MAX;
if ($min_post_id > $max_post_id ) {
WP_CLI::error( 'min-post-id must be less than or equal to max-post-id' );
}

$post_types_format = implode( ', ', array_fill( 0, count( $post_types ), '%s' ) );

$post_range = $wpdb->get_col(
$wpdb->prepare(
"SELECT ID FROM $wpdb->posts
WHERE post_type IN ($post_types_format)
AND post_status = 'publish'
AND ID >= %d
AND ID <= %d
ORDER BY ID DESC
LIMIT %d",
[
...$post_types,
$min_post_id,
$max_post_id,
$num_items,
]
)
);
} else {
$post_range = explode( ',', $assoc_args['post-id'] );
}

return $post_range;
}

}
Loading