← All changes | includes/class-cli.php +180 -125 9.2.0 → 3.2.5 View file →

		@@ -1,149 +1,204 @@
1	1	<?php
2		-/**
3		- * WP-CLI commands registration.
4		- *
5		- * @package Activitypub
6		- */
	2	+namespace Activitypub;
7	3
8		-namespace Activitypub;
	4	+use WP_CLI;
	5	+use WP_CLI_Command;
	6	+use Activitypub\Scheduler;
9	7
10		-use Activitypub\Cli\Actor_Command;
11		-use Activitypub\Cli\Blurhash_Command;
12		-use Activitypub\Cli\Cache_Command;
13		-use Activitypub\Cli\Command;
14		-use Activitypub\Cli\Comment_Command;
15		-use Activitypub\Cli\Fetch_Command;
16		-use Activitypub\Cli\Follow_Command;
17		-use Activitypub\Cli\Move_Command;
18		-use Activitypub\Cli\Outbox_Command;
19		-use Activitypub\Cli\Post_Command;
20		-use Activitypub\Cli\Self_Destruct_Command;
21		-use Activitypub\Cli\Stats_Command;
	8	+use function Activitypub\was_comment_received;
22	9
23	10	/**
24		- * ActivityPub CLI command registry.
	11	+ * WP-CLI commands
25	12	*
26		- * Registers all ActivityPub CLI subcommands with WP-CLI.
27		- *
28	13	* @package Activitypub
29	14	*/
30		-class Cli {
31		-
	15	+class Cli extends WP_CLI_Command {
32	16	/**
33		- * Register all ActivityPub CLI commands.
	17	+ * Check the Plugins Meta-Informations
34	18	*
35		- * This method registers the main 'activitypub' command namespace and all its
36		- * subcommands for managing ActivityPub functionality via WP-CLI.
	19	+ * ## OPTIONS
37	20	*
38		- * Available commands:
39		- * - wp activitypub post <delete|update> <id>
40		- * - wp activitypub comment <delete|update> <id>
41		- * - wp activitypub actor <delete|update> <id>
42		- * - wp activitypub outbox <undo|reschedule> <id>
43		- * - wp activitypub cache <clear|status> [--type=<type>]
44		- * - wp activitypub self-destruct [--status] [--yes]
45		- * - wp activitypub move <from> <to>
46		- * - wp activitypub follow <remote_user>
47		- * - wp activitypub stats <collect|compile|send>
48		- * - wp activitypub fetch <url>
49		- * - wp activitypub blurhash backfill [--dry-run] [--limit=<n>] [--force]
	21	+ * [--Name]
	22	+ * The Plugin Name
	23	+ *
	24	+ * [--PluginURI]
	25	+ * The Plugin URI
	26	+ *
	27	+ * [--Version]
	28	+ * The Plugin Version
	29	+ *
	30	+ * [--Description]
	31	+ * The Plugin Description
	32	+ *
	33	+ * [--Author]
	34	+ * The Plugin Author
	35	+ *
	36	+ * [--AuthorURI]
	37	+ * The Plugin Author URI
	38	+ *
	39	+ * [--TextDomain]
	40	+ * The Plugin Text Domain
	41	+ *
	42	+ * [--DomainPath]
	43	+ * The Plugin Domain Path
	44	+ *
	45	+ * [--Network]
	46	+ * The Plugin Network
	47	+ *
	48	+ * [--RequiresWP]
	49	+ * The Plugin Requires at least
	50	+ *
	51	+ * [--RequiresPHP]
	52	+ * The Plugin Requires PHP
	53	+ *
	54	+ * [--UpdateURI]
	55	+ * The Plugin Update URI
	56	+ *
	57	+ * See: https://developer.wordpress.org/reference/functions/get_plugin_data/#return
	58	+ *
	59	+ * ## EXAMPLES
	60	+ *
	61	+ * $ wp webmention meta
	62	+ *
	63	+ * $ wp webmention meta --Version
	64	+ * Version: 1.0.0
	65	+ *
	66	+ * @param array|null $args The arguments.
	67	+ * @param array|null $assoc_args The associative arguments.
	68	+ *
	69	+ * @return void
50	70	*/
51		- public static function register() {
52		- // Register parent command with version subcommand.
53		- \WP_CLI::add_command(
54		- 'activitypub',
55		- Command::class,
56		- array(
57		- 'shortdesc' => 'Manage ActivityPub plugin functionality and federation.',
58		- )
59		- );
	71	+ public function meta( $args, $assoc_args ) {
	72	+ $plugin_data = get_plugin_meta();
60	73
61		- \WP_CLI::add_command(
62		- 'activitypub post',
63		- Post_Command::class,
64		- array(
65		- 'shortdesc' => 'Manage ActivityPub posts (delete or update).',
66		- )
67		- );
	74	+ if ( $assoc_args ) {
	75	+ $plugin_data = array_intersect_key( $plugin_data, $assoc_args );
	76	+ } else {
	77	+ WP_CLI::line( __( "ActivityPub Plugin Meta:\n", 'activitypub' ) );
	78	+ }
68	79
69		- \WP_CLI::add_command(
70		- 'activitypub comment',
71		- Comment_Command::class,
72		- array(
73		- 'shortdesc' => 'Manage ActivityPub comments (delete or update).',
74		- )
75		- );
	80	+ foreach ( $plugin_data as $key => $value ) {
	81	+ WP_CLI::line( $key . ': ' . $value );
	82	+ }
	83	+ }
76	84
77		- \WP_CLI::add_command(
78		- 'activitypub actor',
79		- Actor_Command::class,
80		- array(
81		- 'shortdesc' => 'Manage ActivityPub actors (delete or update).',
82		- )
83		- );
	85	+ /**
	86	+ * Remove the entire blog from the Fediverse.
	87	+ *
	88	+ * ## EXAMPLES
	89	+ *
	90	+ * $ wp activitypub self-destruct
	91	+ *
	92	+ * @param array|null $args The arguments.
	93	+ * @param array|null $assoc_args The associative arguments.
	94	+ *
	95	+ * @return void
	96	+ */
	97	+ public function self_destruct( $args, $assoc_args ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
	98	+ WP_CLI::warning( __( 'Self-Destructing is not implemented yet.', 'activitypub' ) );
	99	+ }
84	100
85		- \WP_CLI::add_command(
86		- 'activitypub outbox',
87		- Outbox_Command::class,
88		- array(
89		- 'shortdesc' => 'Manage ActivityPub outbox items (undo or reschedule).',
90		- )
91		- );
	101	+ /**
	102	+ * Delete or Update a Post, Page, Custom Post Type or Attachment.
	103	+ *
	104	+ * ## OPTIONS
	105	+ *
	106	+ * <action>
	107	+ * : The action to perform. Either `delete` or `update`.
	108	+ * ---
	109	+ * options:
	110	+ * - delete
	111	+ * - update
	112	+ * ---
	113	+ *
	114	+ * <id>
	115	+ * : The id of the Post, Page, Custom Post Type or Attachment.
	116	+ *
	117	+ * ## EXAMPLES
	118	+ *
	119	+ * $ wp activitypub post delete 1
	120	+ *
	121	+ * @synopsis <action> <id>
	122	+ *
	123	+ * @param array|null $args The arguments.
	124	+ * @param array|null $assoc_args The associative arguments.
	125	+ *
	126	+ * @return void
	127	+ */
	128	+ public function post( $args, $assoc_args ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
	129	+ $post = get_post( $args[1] );
92	130
93		- \WP_CLI::add_command(
94		- 'activitypub self-destruct',
95		- Self_Destruct_Command::class,
96		- array(
97		- 'shortdesc' => 'Remove the entire blog from the Fediverse.',
98		- )
99		- );
	131	+ if ( ! $post ) {
	132	+ WP_CLI::error( __( 'Post not found.', 'activitypub' ) );
	133	+ }
100	134
101		- \WP_CLI::add_command(
102		- 'activitypub move',
103		- Move_Command::class,
104		- array(
105		- 'shortdesc' => 'Move the blog to a new URL.',
106		- )
107		- );
	135	+ switch ( $args[0] ) {
	136	+ case 'delete':
	137	+ // translators: %s is the ID of the post.
	138	+ WP_CLI::confirm( sprintf( __( 'Do you really want to delete the (Custom) Post with the ID: %s', 'activitypub' ), $args[1] ) );
	139	+ Scheduler::schedule_post_activity( 'trash', 'publish', $args[1] );
	140	+ WP_CLI::success( __( '"Delete"-Activity is queued.', 'activitypub' ) );
	141	+ break;
	142	+ case 'update':
	143	+ Scheduler::schedule_post_activity( 'publish', 'publish', $args[1] );
	144	+ WP_CLI::success( __( '"Update"-Activity is queued.', 'activitypub' ) );
	145	+ break;
	146	+ default:
	147	+ WP_CLI::error( __( 'Unknown action.', 'activitypub' ) );
	148	+ }
	149	+ }
108	150
109		- \WP_CLI::add_command(
110		- 'activitypub follow',
111		- Follow_Command::class,
112		- array(
113		- 'shortdesc' => 'Follow a remote ActivityPub user.',
114		- )
115		- );
	151	+ /**
	152	+ * Delete or Update a Comment.
	153	+ *
	154	+ * ## OPTIONS
	155	+ *
	156	+ * <action>
	157	+ * : The action to perform. Either `delete` or `update`.
	158	+ * ---
	159	+ * options:
	160	+ * - delete
	161	+ * - update
	162	+ * ---
	163	+ *
	164	+ * <id>
	165	+ * : The id of the Comment.
	166	+ *
	167	+ * ## EXAMPLES
	168	+ *
	169	+ * $ wp activitypub comment delete 1
	170	+ *
	171	+ * @synopsis <action> <id>
	172	+ *
	173	+ * @param array|null $args The arguments.
	174	+ * @param array|null $assoc_args The associative arguments.
	175	+ *
	176	+ * @return void
	177	+ */
	178	+ public function comment( $args, $assoc_args ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
	179	+ $comment = get_comment( $args[1] );
116	180
117		- \WP_CLI::add_command(
118		- 'activitypub cache',
119		- Cache_Command::class,
120		- array(
121		- 'shortdesc' => 'Manage remote media cache (clear or show status).',
122		- )
123		- );
	181	+ if ( ! $comment ) {
	182	+ WP_CLI::error( __( 'Comment not found.', 'activitypub' ) );
	183	+ }
124	184
125		- \WP_CLI::add_command(
126		- 'activitypub fetch',
127		- Fetch_Command::class,
128		- array(
129		- 'shortdesc' => 'Fetch a remote URL with a signed ActivityPub request.',
130		- )
131		- );
	185	+ if ( was_comment_received( $comment ) ) {
	186	+ WP_CLI::error( __( 'This comment was received via ActivityPub and cannot be deleted or updated.', 'activitypub' ) );
	187	+ }
132	188
133		- \WP_CLI::add_command(
134		- 'activitypub stats',
135		- Stats_Command::class,
136		- array(
137		- 'shortdesc' => 'Manage ActivityPub statistics (collect, compile or send).',
138		- )
139		- );
140		-
141		- \WP_CLI::add_command(
142		- 'activitypub blurhash',
143		- Blurhash_Command::class,
144		- array(
145		- 'shortdesc' => 'Backfill Blurhash placeholders for image attachments.',
146		- )
147		- );
	189	+ switch ( $args[0] ) {
	190	+ case 'delete':
	191	+ // translators: %s is the ID of the comment.
	192	+ WP_CLI::confirm( sprintf( __( 'Do you really want to delete the Comment with the ID: %s', 'activitypub' ), $args[1] ) );
	193	+ Scheduler::schedule_comment_activity( 'trash', 'approved', $args[1] );
	194	+ WP_CLI::success( __( '"Delete"-Activity is queued.', 'activitypub' ) );
	195	+ break;
	196	+ case 'update':
	197	+ Scheduler::schedule_comment_activity( 'approved', 'approved', $args[1] );
	198	+ WP_CLI::success( __( '"Update"-Activity is queued.', 'activitypub' ) );
	199	+ break;
	200	+ default:
	201	+ WP_CLI::error( __( 'Unknown action.', 'activitypub' ) );
	202	+ }
148	203	}
149	204	}