Add wp-cli command to delete guest authors, with option to reassign their posts. #588

smistephen · 2018-08-14T21:09:30Z

Currently, there is no way to delete guest authors from the command line. This command fills that need.

It is activated using delete-guest-authors, and passing in the path to a CSV file containing a list of two columns: the ID to delete, and the login to assign the posts to (or "false" to not reassign).

The command runs dry by default, showing the end user the guest authors it would have attempted to delete, and the user login it would have attempted to transfer the posts to.

Passing --no-dry-run, and confirming that you really do want to delete guest authors, actively modifies the database.

Script was stopping after no co-authors was find. Now script will display an error message and continue to the next post.

This reverts commit f759744.

This reverts commit 6e7da2b.

Script was stopping after no co-authors was find. Now script will display an error message and continue to the next post.

Resolves Automattic#417 * Removed duplicate left join for optimization

…bled() should do the trick now

This reverts commit 525f211.

This reverts commit 5ac7d9a.

Reduce amount of sleep

…r-posts Fixed WP CLI create-terms-for-posts if no co-authors found

Terminology updated throughout

…uthor Replace hardcoded 'author' with $this->$coauthor_taxonomy

Fixes warning: `Warning: sprintf(): Too few arguments in /path/wp-content/plugins/co-authors-plus/php/class-coauthors-guest-authors.php on line 487` Warning surfaces when deleting a guest author that is mapped to a WP user

Move parenthesis to fix esc_html and sprintf

smistephen · 2018-08-14T21:46:38Z

Perfect

smistephen · 2018-08-14T21:49:47Z

Looking at #550, it seems like it could be its own independent PR. Am I reading it right?

sboisvert

A few questions :)

php/class-wp-cli.php

This commit adds additional information on success and failure, telling the end user not only the ID of the guest author that was deleted, but also (if applicable) the login their posts were assigned to.

sboisvert · 2018-08-14T22:57:05Z

Nod, it might be useful for the comment to explain the intent behind this since I wouldn't say it's a common pattern :)

…

On 14 August 2018 at 18:40, Stephen Smith ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In php/class-wp-cli.php <#588 (comment)> : > + ); + + $assoc_args = wp_parse_args( $assoc_args, $defaults ); + + $dry_run = $assoc_args['dry-run']; + + // Safety first. + $filename_status = validate_file( $args[0] ); + + if ( 0 !== $filename_status ) { + WP_CLI::error( __( 'The provided file cannot be accessed. Please use either relative or absolute pathnames, and avoid using directory traversal such as ../ and other methods.', 'co-authors-plus' ) ); + } + + $filename = $args[0]; + + // Add custom error handling on fopen error. Ah. The custom error handling is there to avoid an ugly PHP warning and stack trace from being thrown to the console if the CSV file can't be opened, doesn't exist, or some other error. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#588 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AARpqYPBy7Pw6eRbB4T6uFU6dxWvrJgzks5uQ1HagaJpZM4V9Lsf> .

This commit utilizes the CAP API during dry runs to pull out information about the guest authors about to be deleted, to make sure they're the right ones.

This commit utilizes the CAP API to pull out information about the guest authors about to be deleted, to make sure they're the right ones.

philipjohn

This is looking good - I've left some comment.

One overall question - how can we check this code is going to work as expected in production?

php/class-wp-cli.php

smistephen · 2018-08-15T11:09:21Z

One overall question - how can we check this code is going to work as expected in production?

Checks I've performed so far:

run phpunit (passes)
run phpcs (passes)
look for performance problems and security vulnerabilities (nothing obvious)
test function return values and variable existence (added appropriate error handling code)
test on a sample WordPress instance (seems to work as promised)
try to break it with faulty data (seems to fail gracefully as predicted)

And I'm always open to more opportunities 👍

Allow for remapping to user named "false". The CAP delete function takes, as its second parameter, either a string containing the login of the user you wish to reassign the deleted guest author's posts to, or a boolean false stating that you do wish to reassign. But what if you want to reassign to a user named false? Before that was not possible. Now, the code specifically looks for if the instance has a user named false, and if so, allows it to be reassigned to. If not, it assumes the boolean was intended.

smistephen · 2018-08-15T13:40:21Z

Hooray for @philipjohn pulling the gremlin out of Travis, builds pass now, as they should 👍

philipjohn · 2018-08-15T14:06:08Z

run phpunit (passes)

Which unit tests did you look at when trying to assess whether this code works as intended?

try to break it with faulty data (seems to fail gracefully as predicted)

That's a good idea! What kind of faulty data did you use here?

smistephen · 2018-08-15T14:20:43Z

Which unit tests did you look at when trying to assess whether this code works as intended?

I examined the test_delete_* tests (https://github.com/Automattic/Co-Authors-Plus/blob/master/tests/test-coauthors-guest-authors.php#L722), as well as running the entire unit test suite locally before creating the PR.

That's a good idea! What kind of faulty data did you use here?

I used:

non-existent guest authors
malformed guest author IDs (various strings containing characters and punctuation)
non-existent assignees
malformed assignees (same as the IDs)

As well as:

filepaths that should work (testFile.csv, ~/testFile.csv, /home/steve/testFile.csv)
filepaths that shouldn't work (../../../../mwahahahaha.csv) work
files that don't exist
files that do exist but can't be read (I set the file's permissions to 111 to test this).

php/class-wp-cli.php

chrissy-dev · 2022-06-13T09:51:00Z

@rebeccahum I appreciate this is an old PR but is there a reason this PR never got merged? Happy to help get this over the line if possible.

rebeccahum · 2022-06-14T17:00:55Z

@chrissy-dev I think this just slipped the radar. First step would be to resolve any merge conflicts and test if the current PR still works please!

GaryJones · 2023-07-27T23:18:28Z

Overlaps with #696.

Rebecca Hum and others added 30 commits May 29, 2017 19:48

Merge branch 'master' of https://github.com/Automattic/Co-Authors-Plus

1387ae1

Fixed WP CLI create-terms-for-posts if no co-authors found

f759744

Script was stopping after no co-authors was find. Now script will display an error message and continue to the next post.

Revert "Fixed WP CLI create-terms-for-posts if no co-authors found"

76c59ef

This reverts commit f759744.

Revert "Removed duplicate left join for optimization"

9f8a1d5

This reverts commit 6e7da2b.

Fixed WP CLI create-terms-for-posts if no co-authors found

68bcb6e

Script was stopping after no co-authors was find. Now script will display an error message and continue to the next post.

Removed double left join on posts_join_filter (Automattic#419)

a5222a9

Resolves Automattic#417 * Removed duplicate left join for optimization

Merge remote-tracking branch 'upstream/master'

8ab4751

CoAuthors display now for Pages and JS is being enqueued on Pages

ea4ef62

JS error goes away from js_vars()

bcc875b

changed is_post_type_enabled() to clean up code

f226e9c

removed extra whitespace

29e1e90

removed all traces of $post_type in functions, since is_post_type_ena…

6b3ea35

…bled() should do the trick now

Revert "Update version constant"

5ac7d9a

This reverts commit 525f211.

Edited words to match glossary

8f498c4

Removed continue because the script would stop running.

8ba4611

Added better consistencies with glossary

4c23011

Merge branch 'master' into reduce-sleep

8c23eeb

Revert "Revert "Update version constant""

586dcdc

This reverts commit 5ac7d9a.

doesn't return false after quick edit saves

1a272fa

replaced hardcoded 'author' with $this->coauthor_taxonomy

84d8394

Tested tag to 4.8

5206a53

Merge pull request Automattic#400 from Automattic/reduce-sleep

20efecf

Reduce amount of sleep

Merge pull request Automattic#420 from rebeccahum/cli-create-terms-fo…

7bdae3c

…r-posts Fixed WP CLI create-terms-for-posts if no co-authors found

Merge pull request Automattic#423 from rebeccahum/terminology

1f61855

Terminology updated throughout

Merge pull request Automattic#426 from rebeccahum/replace_hardcoded_a…

39276d1

…uthor Replace hardcoded 'author' with $this->$coauthor_taxonomy

Move parenthesis to fix esc_html and sprintf

830987b

Fixes warning: `Warning: sprintf(): Too few arguments in /path/wp-content/plugins/co-authors-plus/php/class-coauthors-guest-authors.php on line 487` Warning surfaces when deleting a guest author that is mapped to a WP user

Added progress so users have an idea of how long it will take

06c123d

Merge pull request Automattic#430 from Automattic/trepmal-patch-1

832ac30

Move parenthesis to fix esc_html and sprintf

Added a better style of progress bar!

b91e7d4

Deleting guest authors is less confusing

d404fec

sboisvert reviewed Aug 14, 2018

View reviewed changes

php/class-wp-cli.php Show resolved Hide resolved

php/class-wp-cli.php Outdated Show resolved Hide resolved

php/class-wp-cli.php Show resolved Hide resolved

sboisvert reviewed Aug 14, 2018

View reviewed changes

php/class-wp-cli.php Outdated Show resolved Hide resolved

Add additional log output.

917593a

This commit adds additional information on success and failure, telling the end user not only the ID of the guest author that was deleted, but also (if applicable) the login their posts were assigned to.

smistephen added 3 commits August 14, 2018 20:05

Add more information to dry run output.

e3e9155

This commit utilizes the CAP API during dry runs to pull out information about the guest authors about to be deleted, to make sure they're the right ones.

Add more information to command output.

9604de2

This commit utilizes the CAP API to pull out information about the guest authors about to be deleted, to make sure they're the right ones.

Add additional explanatory comments about the custom error handling code

78ce17c

philipjohn reviewed Aug 15, 2018

View reviewed changes

php/class-wp-cli.php Outdated Show resolved Hide resolved

php/class-wp-cli.php Outdated Show resolved Hide resolved

php/class-wp-cli.php Outdated Show resolved Hide resolved

smistephen added 2 commits August 15, 2018 08:43

Break documentation comment onto multiple lines for readability

a1c4e08

Add existence checking for assignee value

a44b5c1

sboisvert reviewed Aug 15, 2018

View reviewed changes

php/class-wp-cli.php Outdated Show resolved Hide resolved

Rearrange dry run command output for greater clarity

36bc3f6

rebeccahum force-pushed the master branch from 4e1b2d4 to f37f410 Compare March 26, 2019 05:42

GaryJones added Type: enhancement Status: awaiting reporter feedback labels Jul 22, 2023

GaryJones mentioned this pull request Jul 27, 2023

Add subcommand to delete guest authors #696

Closed

GaryJones added this to the 3.6 milestone Jul 27, 2023

GaryJones changed the base branch from main to develop August 25, 2023 15:23

alecgeatches modified the milestones: 3.6, 3.7 Apr 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add wp-cli command to delete guest authors, with option to reassign their posts. #588

Add wp-cli command to delete guest authors, with option to reassign their posts. #588

smistephen commented Aug 14, 2018

smistephen commented Aug 14, 2018

smistephen commented Aug 14, 2018

sboisvert left a comment

sboisvert commented Aug 14, 2018 via email

philipjohn left a comment

smistephen commented Aug 15, 2018 •

edited

smistephen commented Aug 15, 2018

philipjohn commented Aug 15, 2018

smistephen commented Aug 15, 2018

chrissy-dev commented Jun 13, 2022

rebeccahum commented Jun 14, 2022

GaryJones commented Jul 27, 2023

Add wp-cli command to delete guest authors, with option to reassign their posts. #588

Are you sure you want to change the base?

Add wp-cli command to delete guest authors, with option to reassign their posts. #588

Conversation

smistephen commented Aug 14, 2018

smistephen commented Aug 14, 2018

smistephen commented Aug 14, 2018

sboisvert left a comment

Choose a reason for hiding this comment

sboisvert commented Aug 14, 2018 via email

philipjohn left a comment

Choose a reason for hiding this comment

smistephen commented Aug 15, 2018 • edited

smistephen commented Aug 15, 2018

philipjohn commented Aug 15, 2018

smistephen commented Aug 15, 2018

chrissy-dev commented Jun 13, 2022

rebeccahum commented Jun 14, 2022

GaryJones commented Jul 27, 2023

smistephen commented Aug 15, 2018 •

edited