Skip to content

Feat/migrate guest authors #3068

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

Merged
adekbadek merged 2 commits into from
May 16, 2024
Merged

Feat/migrate guest authors #3068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13ebbca
feat(cli): migrate linked guest authors
adekbadek Apr 16, 2024
38f8917
feat(cli): migrate unlinked guest authors
adekbadek Apr 17, 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
385 changes: 385 additions & 0 deletions includes/cli/class-co-authors-plus.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,385 @@
<?php
/**
* Co-Authors Plus CLI commands.
*
* @package Newspack
*/

namespace Newspack\CLI;

use WP_CLI;

defined( 'ABSPATH' ) || exit;

/**
* Co-Authors Plus CLI commands.
*/
class Co_Authors_Plus {
private static $live = false; // phpcs:ignore Squiz.Commenting.VariableComment.Missing
private static $verbose = true; // phpcs:ignore Squiz.Commenting.VariableComment.Missing

/**
* Migrate Co-Authors Plus guest authors to regular users.
*
* ## OPTIONS
*
* [--live]
* : Run the command in live mode, updating the subscriptions.
*
* [--verbose]
* : Produce more output.
*
* @param array $args Positional arguments.
* @param array $assoc_args Assoc arguments.
* @return void
*/
public function migrate_guest_authors( $args, $assoc_args ) {
WP_CLI::line( '' );

self::$live = isset( $assoc_args['live'] ) ? true : false;
self::$verbose = isset( $assoc_args['verbose'] ) ? true : false;

if ( self::$live ) {
WP_CLI::line( 'Live mode - data will be changed.' );
} else {
WP_CLI::line( 'Dry run. Use --live flag to run in live mode.' );
}
WP_CLI::line( '' );

if ( ! class_exists( 'CoAuthors_Guest_Authors' ) ) {
WP_CLI::error( 'Co-Authors Plus plugin is not active.' );
WP_CLI::line( '' );
}

self::migrate_linked_guest_authors();
self::migrate_unlinked_guest_authors();

WP_CLI::line( '' );
}


/**
* Migrate unlinked guest authors to regular users.
*
* For all unlinked guest authors, copy the guest author's data to a new WP user,
* reassign the posts, and remove the guest author.
*/
private static function migrate_unlinked_guest_authors() {
$unlinked_guest_authors = get_posts(
[
'post_type' => 'guest-author',
'posts_per_page' => -1,
'post_status' => 'any',
'meta_query' => [ // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
'relation' => 'OR',
[
'key' => 'cap-linked_account',
'compare' => 'NOT EXISTS',
],
[
'key' => 'cap-linked_account',
'compare' => '=',
'value' => '',
],
],
]
);
WP_CLI::line( sprintf( 'Found %d guest author(s) not linked to any WP User.', count( $unlinked_guest_authors ) ) );

foreach ( $unlinked_guest_authors as $guest_author ) {
WP_CLI::line( '' );
$post_meta = array_map(
function( $value ) {
return $value[0];
},
get_post_meta( $guest_author->ID )
);
if ( self::$verbose ) {
WP_CLI::line( sprintf( 'Creating user %s from Guest Author #%d.', $post_meta['cap-display_name'], $guest_author->ID ) );
}

$user_login = $post_meta['cap-user_login'];

$user_data = [
'user_login' => $user_login,
'user_nicename' => $post_meta['cap-user_login'],
'user_url' => $post_meta['cap-website'],
'user_pass' => wp_generate_password(),
'role' => \Newspack\Co_Authors_Plus::CONTRIBUTOR_NO_EDIT_ROLE_NAME,
'user_email' => $post_meta['cap-user_email'],
'display_name' => $post_meta['cap-display_name'],
'first_name' => $post_meta['cap-first_name'],
'last_name' => $post_meta['cap-last_name'],
'description' => $post_meta['cap-description'],
'user_registered' => $guest_author->post_date,
'meta_input' => [
'_np_migrated_cap_guest_author' => $guest_author->ID,
],
];

$existing_user = get_user_by( 'login', $user_login );
if ( $existing_user !== false ) {
WP_CLI::warning( sprintf( 'User with login %s already exists, it will be updated.', $user_login ) );
$user_data['ID'] = $existing_user->ID;
}

foreach ( array_values( \Newspack\Authors_Custom_Fields::USER_META_NAMES ) as $meta_key ) {
$user_data['meta_input'][ $meta_key ] = $post_meta[ 'cap-' . $meta_key ];
}
if ( self::$live ) {
$user_id = \wp_insert_user( $user_data );
if ( is_wp_error( $user_id ) ) {
WP_CLI::warning( sprintf( 'Could not create user: %s', $user_id->get_error_message() ) );
continue;
}
WP_CLI::success( sprintf( 'User created successfully (#%d).', $user_id ) );

self::assign_user_avatar( $guest_author, $user_id );
self::delete_guest_author_post( $guest_author->ID );
}
}
}

/**
* Migrate linked guest authors to regular users.
*
* For all linked guest authors, copy the guest author's data to the linked user,
* reassign the posts, and remove the guest author.
*/
private static function migrate_linked_guest_authors() {
$linked_guest_authors = get_posts(
[
'post_type' => 'guest-author',
'posts_per_page' => -1,
'post_status' => 'any',
'meta_query' => [ // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
[
'key' => 'cap-linked_account',
'compare' => '!=',
'value' => '',
],
],
]
);
WP_CLI::line( sprintf( 'Found %d guest author(s) linked to a WP User.', count( $linked_guest_authors ) ) );
foreach ( $linked_guest_authors as $guest_author ) {
WP_CLI::line( '' );
$linked_user_slug = get_post_meta( $guest_author->ID, 'cap-linked_account', true );
$linked_user = get_user_by( 'login', $linked_user_slug );
if ( ! $linked_user ) {
WP_CLI::warning( sprintf( 'User with login %s not found.', $linked_user_slug ) );
continue;
}

$user_id = $linked_user->ID;

WP_CLI::line( sprintf( 'Guest Author %s (#%d) is linked to user %s (#%d).', $guest_author->post_title, $guest_author->ID, $linked_user->data->display_name, $user_id ) );

$guest_author_data = get_post_meta( $guest_author->ID );

// Avatar is assigned first, since the original will be removed when the guest author is deleted.
self::assign_user_avatar( $guest_author, $user_id );

global $coauthors_plus;

$guest_term = $coauthors_plus->get_author_term( (object) [ 'user_nicename' => $guest_author->post_name ] );
$wp_user_term = $coauthors_plus->get_author_term( $linked_user );
if ( ! $guest_term ) {
WP_CLI::warning( sprintf( 'No term found for guest author %d. This will make post reassignement impossible. Skipping!', $guest_author->ID ) );
continue;
}
if ( ! $wp_user_term ) {
// This happens when the WP User is created first, then the Guest Author, and then a post is assigned to the GA.
// The term is then created based on the GA name, not the WP User name.
WP_CLI::warning( sprintf( 'No term found for user %d.', $user_id ) );
}

if ( self::$live ) {
if ( $wp_user_term ) {
// If the WP User term exists, delete the Guest Author term and reassign the posts.
$result = $coauthors_plus->guest_authors->delete( $guest_author->ID, $linked_user->data->user_login );
if ( $result === true ) {
WP_CLI::success( 'Deleted the guest author and reassigned the posts.' );
} else {
WP_CLI::warning( 'Could not delete the guest author and reassign the posts: ' . $result->get_error_message() );
}
} else {
// Otherwise, only delete the Guest Author post and cache, leaving the term intact.
self::delete_guest_author_post( $guest_author->ID );
}

if ( $wp_user_term ) {
// Update the user term to match the guest author term's name, so the author archive URL is preserved.
$result = wp_update_term(
$wp_user_term->term_id,
'author',
[
'name' => $guest_term->name,
'slug' => $guest_term->slug,
]
);
if ( is_wp_error( $result ) ) {
WP_CLI::warning( 'Could not update the WP User CAP term: ' . $result->get_error_message() );
} else {
WP_CLI::success( sprintf( 'Updated the WP User CAP term %d.', $result['term_id'] ) );
}
}
}

self::assign_user_props( $guest_author_data, $user_id );
self::assign_user_meta( $guest_author, $user_id );
}
}

/**
* Delete a Guest Author, without deleting the related term.
*
* @param int $guest_author_id The guest author post ID.
*/
private static function delete_guest_author_post( $guest_author_id ) {
global $coauthors_plus;
$guest_author_object = $coauthors_plus->guest_authors->get_guest_author_by( 'ID', $guest_author_id );
$result = wp_delete_post( $guest_author_id, true );
$coauthors_plus->guest_authors->delete_guest_author_cache( $guest_author_object );
if ( ! $result ) {
WP_CLI::warning( 'Could not delete the guest author post: ' . $result->get_error_message() );
} else {
WP_CLI::success( sprintf( 'Deleted the guest author post (#%d).', $guest_author_id ) );
}
return $result;
}

/**
* Assign user props from guest author post's data.
*
* @param array $guest_author_data The guest author post's data.
* @param int $user_id The user ID to update the avatar for.
* @return bool True if the user meta was updated, false otherwise.
*/
private static function assign_user_props( $guest_author_data, $user_id ) {
$display_name = $guest_author_data['cap-display_name'][0];
$user_login = $guest_author_data['cap-user_login'][0];

if ( self::$verbose ) {
WP_CLI::line( sprintf( 'Update display_name to %s and user_nicename to %s.', $display_name, $user_login ) );
}
if ( self::$live ) {
wp_update_user(
[
'ID' => $user_id,
'display_name' => $display_name,
'user_nicename' => $display_name,
]
);
}
return true;
}

/**
* Assign user meta from guest author post's meta.
*
* @param WP_Post $guest_author The guest author post.
* @param int $user_id The user ID to update the avatar for.
* @return bool True if the user meta was updated, false otherwise.
*/
private static function assign_user_meta( $guest_author, $user_id ) {
$guest_author_data = get_post_meta( $guest_author->ID );
$assignable_meta = array_merge(
[
'display_name',
'first_name',
'last_name',
'description',
],
array_values( \Newspack\Authors_Custom_Fields::USER_META_NAMES )
);

foreach ( $guest_author_data as $meta_key => $meta_value ) {
if ( strpos( $meta_key, 'cap-' ) === false ) {
continue;
}
$user_meta_key = str_replace( 'cap-', '', $meta_key );
if ( ! in_array( $user_meta_key, $assignable_meta ) ) {
continue;
}
$user_meta_value = $meta_value[0];
if ( empty( $user_meta_value ) ) {
continue;
}
if ( self::$verbose ) {
WP_CLI::line( sprintf( 'User meta key: %s, value: %s', $user_meta_key, $user_meta_value ) );
}
$existing_meta_value = get_user_meta( $user_id, $user_meta_key, true );
if ( $existing_meta_value && self::$verbose ) {
WP_CLI::line( sprintf( ' - existing value: %s', $existing_meta_value ) );
}
if ( self::$live ) {
if ( $existing_meta_value ) {
update_user_meta( $user_id, '_np_original_' . $user_meta_key, $existing_meta_value );
}
update_user_meta( $user_id, $user_meta_key, $user_meta_value );
}
}
return true;
}

/**
* Update the user avatar from guest author post's featured image.
*
* @param WP_Post $guest_author The guest author post.
* @param int $user_id The user ID to update the avatar for.
* @return bool True if the avatar was updated, false otherwise.
*/
private static function assign_user_avatar( $guest_author, $user_id ) {
global $simple_local_avatars;
if ( ! $simple_local_avatars || ! is_a( $simple_local_avatars, 'Simple_Local_Avatars' ) ) {
WP_CLI::warning( 'Simple Local Avatars plugin not active.' );
return false;
}
$guest_author_featured_image_id = get_post_thumbnail_id( $guest_author->ID );
if ( ! $guest_author_featured_image_id ) {
if ( self::$verbose ) {
WP_CLI::line( sprintf( 'No guest author image found for post %d, skipping.', $guest_author->ID ) );
}
return false;
}
$guest_author_featured_image_url = wp_get_attachment_image_url( $guest_author_featured_image_id, 'full' );
if ( ! $guest_author_featured_image_url ) {
WP_CLI::warning( 'Guest author image URL not found.' );
return false;
}

$existing_avatar = get_user_meta( $user_id, 'simple_local_avatar', true );
if ( ! empty( $existing_avatar ) ) {
WP_CLI::warning( 'User already has an avatar, skipping' );
return false;
}

if ( self::$verbose ) {
WP_CLI::line( sprintf( 'Will assign image #%d to user #%d.', $guest_author_featured_image_id, $user_id ) );
}

if ( ! self::$live ) {
return false;
}

if ( ! function_exists( 'media_sideload_image' ) ) {
require_once ABSPATH . 'wp-admin/includes/media.php';
require_once ABSPATH . 'wp-admin/includes/file.php';
require_once ABSPATH . 'wp-admin/includes/image.php';
}
$avatar_id = media_sideload_image( $guest_author_featured_image_url, 0, null, 'id' );

if ( is_wp_error( $avatar_id ) ) {
WP_CLI::warning( 'Error sideloading avatar: ' . $avatar_id->get_error_message() );
return false;
}
if ( is_int( $avatar_id ) ) {
$simple_local_avatars->assign_new_user_avatar( $avatar_id, $user_id );
if ( self::$verbose ) {
WP_CLI::success( sprintf( 'Assigned new image with ID #%d to user #%d', $avatar_id, $user_id ) );
}
return true;
}
}
}
Loading