Repository navigation
Expand file tree
/
Copy pathAbility_Command.php
More file actions
771 lines (714 loc) · 22.9 KB
/
Copy pathAbility_Command.php
File metadata and controls
771 lines (714 loc) · 22.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
<?php
namespace WP_CLI\Ability;
use Spyc;
use WP_Ability;
use WP_CLI;
use WP_CLI\Formatter;
use WP_CLI\Utils;
use WP_CLI_Command;
/**
* Lists, inspects, and executes abilities registered via the WordPress Abilities API.
*
* The Abilities API, introduced in WordPress 6.9, provides a standardized way
* to register and discover distinct units of functionality within a WordPress site.
*
* ## EXAMPLES
*
* # List all registered abilities.
* $ wp ability list
* +---------------------------+----------------------+----------+------------------------------------------+
* | name | label | category | description |
* +---------------------------+----------------------+----------+------------------------------------------+
* | core/get-site-info | Get Site Information | site | Returns site information configured i... |
* | core/get-user-info | Get User Information | user | Returns basic profile details for the... |
* | core/get-environment-info | Get Environment Info | site | Returns core details about the site's... |
* +---------------------------+----------------------+----------+------------------------------------------+
*
* # Get details of a specific ability.
* $ wp ability get core/get-site-info --fields=name,label,category,readonly,public,show_in_rest
* +---------------+----------------------+
* | Field | Value |
* +---------------+----------------------+
* | name | core/get-site-info |
* | label | Get Site Information |
* | category | site |
* | readonly | 1 |
* | public | 1 |
* | show_in_rest | 1 |
* +---------------+----------------------+
*
* # Execute an ability with JSON input (required for array values).
* $ wp ability run core/get-site-info --input='{"fields":["name","version"]}' --user=admin
* {
* "name": "Test Blog",
* "version": "6.9"
* }
*
* # Check if an ability exists.
* $ wp ability exists core/get-site-info
* $ echo $?
* 0
*
* # Check if user can run an ability.
* $ wp ability can-run core/get-site-info
* $ echo $?
* 0
*
* # Validate input before execution.
* $ wp ability validate core/get-site-info --input='{"fields":["name","version"]}'
* Success: Input is valid.
*
* @when after_wp_load
* @package wp-cli
*/
class Ability_Command extends WP_CLI_Command {
/**
* Default fields for list output.
*
* @var string[]
*/
protected $default_fields = [
'name',
'label',
'category',
'description',
];
/**
* Default fields for get output.
*
* @var string[]
*/
protected $get_fields = [
'name',
'label',
'category',
'description',
'input_schema',
'output_schema',
'readonly',
'destructive',
'idempotent',
'public',
'show_in_rest',
];
/**
* Lists all registered abilities.
*
* ## OPTIONS
*
* [--category=<slug>]
* : Filter abilities by category slug.
*
* [--namespace=<prefix>]
* : Filter abilities by namespace prefix (e.g., 'core' for 'core/*' abilities).
*
* [--public]
* : Only list abilities flagged for client exposure. Pass --no-public to invert.
*
* [--show-in-rest]
* : Only list abilities exposed to the REST API. Pass --no-show-in-rest to invert.
*
* [--field=<field>]
* : Prints the value of a single field for each ability.
*
* [--fields=<fields>]
* : Limit the output to specific ability fields.
*
* [--format=<format>]
* : Render output in a particular format.
* ---
* default: table
* options:
* - table
* - csv
* - json
* - yaml
* - count
* - ids
* ---
*
* ## AVAILABLE FIELDS
*
* These fields will be displayed by default for each ability:
*
* * name
* * label
* * category
* * description
*
* These fields are optionally available:
*
* * readonly
* * destructive
* * idempotent
* * public
* * show_in_rest
*
* The `public` field reports the high-level client exposure flag as declared
* by the ability. As of WordPress 7.1 it seeds the default for channel-specific
* flags such as `show_in_rest`, which take precedence when set explicitly.
* On earlier versions the flag is stored but has no effect, so `public` and
* `show_in_rest` may disagree.
*
* ## EXAMPLES
*
* # List all abilities.
* $ wp ability list
* +---------------------------+----------------------+----------+------------------------------------------+
* | name | label | category | description |
* +---------------------------+----------------------+----------+------------------------------------------+
* | core/get-site-info | Get Site Information | site | Returns site information configured i... |
* | core/get-user-info | Get User Information | user | Returns basic profile details for the... |
* +---------------------------+----------------------+----------+------------------------------------------+
*
* # List abilities in a specific category.
* $ wp ability list --category=site
*
* # List abilities by namespace.
* $ wp ability list --namespace=core
*
* # List abilities exposed to REST API.
* $ wp ability list --show-in-rest
*
* # List abilities meant to be available to clients.
* $ wp ability list --public
*
* # Find abilities that opt out of REST despite being public.
* $ wp ability list --public --no-show-in-rest
*
* # List abilities as JSON.
* $ wp ability list --format=json
*
* # List only ability names.
* $ wp ability list --field=name
* core/get-site-info
* core/get-user-info
* core/get-environment-info
*
* @subcommand list
*
* @param string[] $args Positional arguments.
* @param array $assoc_args Associative arguments.
*/
public function list_( $args, $assoc_args ): void {
$abilities = wp_get_abilities();
$category_slug = Utils\get_flag_value( $assoc_args, 'category' );
$namespace = Utils\get_flag_value( $assoc_args, 'namespace' );
$public = Utils\get_flag_value( $assoc_args, 'public' );
$show_in_rest = Utils\get_flag_value( $assoc_args, 'show-in-rest' );
$items = [];
foreach ( $abilities as $ability ) {
$ability_data = $this->format_ability_for_list( $ability );
// Filter by category if specified.
if ( null !== $category_slug && $ability_data['category'] !== $category_slug ) {
continue;
}
// Filter by namespace if specified.
if ( null !== $namespace ) {
$ability_name = isset( $ability_data['name'] ) && is_string( $ability_data['name'] ) ? $ability_data['name'] : '';
$name_parts = explode( '/', $ability_name, 2 );
if ( $name_parts[0] !== $namespace ) {
continue;
}
}
// Filter by public if specified.
if ( null !== $public ) {
$ability_public = '1' === $ability_data['public'];
if ( $public !== $ability_public ) {
continue;
}
}
// Filter by show_in_rest if specified.
if ( null !== $show_in_rest ) {
$ability_rest = '1' === $ability_data['show_in_rest'];
if ( $show_in_rest !== $ability_rest ) {
continue;
}
}
$items[] = $ability_data;
}
$formatter = $this->get_formatter( $assoc_args, $this->default_fields );
$formatter->display_items( $items );
}
/**
* Gets details about a registered ability.
*
* ## OPTIONS
*
* <name>
* : The ability name (namespace/ability-name format).
*
* [--field=<field>]
* : Instead of returning the whole ability, returns the value of a single field.
*
* [--fields=<fields>]
* : Limit the output to specific fields. Defaults to all fields.
*
* [--format=<format>]
* : Render output in a particular format.
* ---
* default: table
* options:
* - table
* - csv
* - json
* - yaml
* ---
*
* ## AVAILABLE FIELDS
*
* These fields will be displayed by default:
*
* * name
* * label
* * category
* * description
* * input_schema
* * output_schema
* * readonly
* * destructive
* * idempotent
* * public
* * show_in_rest
*
* These fields are optionally available:
*
* * meta
*
* The `public` field reports the high-level client exposure flag as declared
* by the ability. As of WordPress 7.1 it seeds the default for channel-specific
* flags such as `show_in_rest`, which take precedence when set explicitly.
* On earlier versions the flag is stored but has no effect, so `public` and
* `show_in_rest` may disagree.
*
* The `meta` field renders the raw metadata as JSON. It is the only way to
* inspect channel-specific settings registered by plugins, such as `mcp`.
*
* ## EXAMPLES
*
* # Get details of a specific ability.
* $ wp ability get core/get-site-info
* +---------------+----------------------+
* | Field | Value |
* +---------------+----------------------+
* | name | core/get-site-info |
* | label | Get Site Information |
* | category | site |
* | description | Returns site info... |
* | input_schema | {"type":"object"} |
* | output_schema | {"type":"object"} |
* | readonly | 1 |
* | destructive | 0 |
* | idempotent | 1 |
* | public | 1 |
* | show_in_rest | 1 |
* +---------------+----------------------+
*
* # Inspect channel-specific settings that have no field of their own.
* $ wp ability get my-plugin/my-ability --field=meta
* {"annotations":{"readonly":true,"destructive":false,"idempotent":null},"mcp":{"public":false},"show_in_rest":true,"public":true}
*
* # Get ability as JSON.
* $ wp ability get core/get-site-info --format=json
*
* # Get only the description.
* $ wp ability get core/get-site-info --field=description
* Returns site information configured in WordPress.
*
* @param string[] $args Positional arguments.
* @param array $assoc_args Associative arguments.
*/
public function get( $args, $assoc_args ): void {
$name = $args[0];
$ability = wp_get_ability( $name );
if ( null === $ability ) {
WP_CLI::error( "Ability '{$name}' not found." );
}
$ability_data = $this->format_ability_for_get( $ability );
$formatter = $this->get_formatter( $assoc_args, $this->get_fields );
$formatter->display_item( $ability_data );
}
/**
* Executes a registered ability.
*
* ## OPTIONS
*
* <name>
* : The ability name (namespace/ability-name format).
*
* [--input=<json>]
* : JSON string containing input data for the ability. Use '-' to read from stdin.
*
* [--<field>=<value>]
* : Individual input fields. Alternative to --input for simple inputs.
*
* [--format=<format>]
* : Render output in a particular format.
* ---
* default: json
* options:
* - json
* - yaml
* - var_export
* ---
*
* ## EXAMPLES
*
* # Execute an ability.
* $ wp ability run core/get-site-info --user=admin
* {
* "name": "Test Blog",
* "description": "Just another WordPress site",
* "url": "http://example.com",
* ...
* }
*
* # Execute an ability with JSON input (required for array values).
* $ wp ability run core/get-site-info --input='{"fields":["name","version"]}' --user=admin
* {
* "name": "Test Blog",
* "version": "6.9"
* }
*
* # Execute an ability with simple string arguments.
* $ wp ability run my-plugin/greet --name=World
*
* # Execute and output as YAML.
* $ wp ability run core/get-site-info --format=yaml --user=admin
* name: Test Blog
* description: Just another WordPress site
* ...
*
* # Execute with input from stdin.
* $ echo '{"fields":["name"]}' | wp ability run core/get-site-info --input=- --user=admin
*
* @param string[] $args Positional arguments.
* @param array $assoc_args Associative arguments.
*/
public function run( $args, $assoc_args ): void {
$name = $args[0];
$ability = wp_get_ability( $name );
if ( null === $ability ) {
WP_CLI::error( "Ability '{$name}' not found." );
}
$format = Utils\get_flag_value( $assoc_args, 'format', 'json' );
// Build input data (with stdin support).
$input = $this->build_input_with_stdin( $assoc_args );
if ( null === $input && [] !== $ability->get_input_schema() ) {
$input = [];
}
// Execute the ability.
$result = $ability->execute( $input );
if ( is_wp_error( $result ) ) {
WP_CLI::error( $result->get_error_message() );
}
// Output the result.
switch ( $format ) {
case 'yaml':
WP_CLI::line( Spyc::YAMLDump( $result, 2, 0 ) );
break;
case 'var_export':
var_export( $result );
break;
case 'json':
default:
$json = wp_json_encode( $result, JSON_PRETTY_PRINT );
if ( false !== $json ) {
WP_CLI::line( $json );
}
break;
}
}
/**
* Checks whether an ability is registered.
*
* Exits with return code 0 if the ability exists, 1 if it does not.
*
* ## OPTIONS
*
* <name>
* : The ability name (namespace/ability-name format).
*
* ## EXAMPLES
*
* # Check if an ability exists.
* $ wp ability exists core/get-site-info
* $ echo $?
* 0
*
* # Check for non-existent ability.
* $ wp ability exists nonexistent/ability
* $ echo $?
* 1
*
* # Use in a script.
* $ if wp ability exists core/get-site-info; then
* > wp ability run core/get-site-info
* > fi
*
* @param string[] $args Positional arguments.
* @param array $assoc_args Associative arguments.
*/
public function exists( $args, $assoc_args ): void {
$name = $args[0];
$exists = wp_has_ability( $name );
WP_CLI::halt( $exists ? 0 : 1 );
}
/**
* Checks if the current user can execute an ability.
*
* Validates permissions without actually executing the ability.
* Exits with return code 0 if permitted, 1 if not.
*
* ## OPTIONS
*
* <name>
* : The ability name (namespace/ability-name format).
*
* [--input=<json>]
* : JSON string containing input data for permission checking.
*
* [--<field>=<value>]
* : Individual input fields for permission checking.
*
* ## EXAMPLES
*
* # Check if current user can run an ability (as admin).
* $ wp ability can-run core/get-site-info --user=admin
* $ echo $?
* 0
*
* # Check permission when not permitted.
* $ wp ability can-run core/get-site-info
* $ echo $?
* 1
*
* # Use in a script.
* $ if wp ability can-run core/get-site-info --user=admin; then
* > wp ability run core/get-site-info --user=admin
* > fi
*
* @subcommand can-run
*
* @param string[] $args Positional arguments.
* @param array $assoc_args Associative arguments.
*/
public function can_run( $args, $assoc_args ): void {
$name = $args[0];
$ability = wp_get_ability( $name );
if ( null === $ability ) {
WP_CLI::error( "Ability '{$name}' not found." );
}
// Build input data for permission check.
$input = $this->build_input( $assoc_args );
// Check permissions.
$can_run = $ability->check_permissions( $input );
if ( is_wp_error( $can_run ) ) {
WP_CLI::debug( $can_run->get_error_message() );
WP_CLI::halt( 1 );
}
WP_CLI::halt( $can_run ? 0 : 1 );
}
/**
* Validates input against an ability's schema.
*
* Validates the input data without executing the ability.
* Useful for testing input before execution.
*
* ## OPTIONS
*
* <name>
* : The ability name (namespace/ability-name format).
*
* [--input=<json>]
* : JSON string containing input data to validate.
*
* [--<field>=<value>]
* : Individual input fields to validate.
*
* ## EXAMPLES
*
* # Validate input for an ability (use JSON for array values).
* $ wp ability validate core/get-site-info --input='{"fields":["name","version"]}'
* Success: Input is valid.
*
* # Validate simple string arguments.
* $ wp ability validate my-plugin/greet --name=World
* Success: Input is valid.
*
* # Validation failure shows error message.
* $ wp ability validate core/get-site-info --input='{"fields":"invalid"}'
* Error: Ability "core/get-site-info" has invalid input. Reason: ...
*
* @param string[] $args Positional arguments.
* @param array $assoc_args Associative arguments.
*/
public function validate( $args, $assoc_args ): void {
$name = $args[0];
$ability = wp_get_ability( $name );
if ( null === $ability ) {
WP_CLI::error( "Ability '{$name}' not found." );
}
// Build input data.
$input = $this->build_input( $assoc_args );
// Normalize input (applies defaults from schema).
$input = $ability->normalize_input( $input );
// Validate input.
$is_valid = $ability->validate_input( $input );
if ( is_wp_error( $is_valid ) ) {
WP_CLI::error( $is_valid->get_error_message() );
}
WP_CLI::success( 'Input is valid.' );
}
/**
* Builds input data from associative arguments.
*
* Returns null if no input was provided, which is important for abilities
* without an input schema (validate_input returns error for non-null input
* when there's no schema).
*
* @param array $assoc_args Associative arguments.
* @return array<string,mixed>|null The input data, or null if none provided.
*/
private function build_input( $assoc_args ) {
$input = [];
// Check for JSON input first.
$json_input = Utils\get_flag_value( $assoc_args, 'input' );
if ( null !== $json_input ) {
$decoded = json_decode( (string) $json_input, true );
if ( ! is_array( $decoded ) && '' !== $json_input ) {
WP_CLI::error( 'Invalid JSON provided for --input.' );
}
if ( is_array( $decoded ) ) {
$input = $decoded;
}
}
// Collect individual field arguments.
$reserved_args = [ 'input', 'format' ];
foreach ( $assoc_args as $key => $value ) {
if ( ! is_string( $key ) || in_array( $key, $reserved_args, true ) ) {
continue;
}
$input[ $key ] = $value;
}
// Return null if no input provided (for abilities without input schema).
return empty( $input ) ? null : $input;
}
/**
* Builds input data from associative arguments with stdin support.
*
* @param array $assoc_args Associative arguments.
* @return array<string,mixed>|null The input data, or null if none provided.
*/
private function build_input_with_stdin( $assoc_args ) {
$input = [];
// Check for JSON input first.
$json_input = Utils\get_flag_value( $assoc_args, 'input' );
if ( '-' === $json_input ) {
// Read from stdin.
$stdin_content = file_get_contents( 'php://stdin' );
if ( false === $stdin_content ) {
WP_CLI::error( 'Failed to read from stdin.' );
}
$json_input = trim( $stdin_content );
}
if ( null !== $json_input && '' !== $json_input ) {
$decoded = json_decode( (string) $json_input, true );
if ( ! is_array( $decoded ) ) {
WP_CLI::error( 'Invalid JSON provided for --input.' );
}
$input = $decoded;
}
// Collect individual field arguments.
$reserved_args = [ 'input', 'format' ];
foreach ( $assoc_args as $key => $value ) {
if ( ! is_string( $key ) || in_array( $key, $reserved_args, true ) ) {
continue;
}
$input[ $key ] = $value;
}
// Return null only when no input was provided (no --input flag and no field args).
return ( empty( $input ) && null === $json_input ) ? null : $input;
}
/**
* Formats an ability for list output.
*
* @param WP_Ability $ability The ability object.
* @return array<string,mixed>
*/
private function format_ability_for_list( $ability ) {
$annotations = $this->get_annotations( $ability );
return [
'name' => $ability->get_name(),
'label' => $ability->get_label(),
'category' => $ability->get_category(),
'description' => $ability->get_description(),
'readonly' => $this->format_annotation( $annotations['readonly'] ),
'destructive' => $this->format_annotation( $annotations['destructive'] ),
'idempotent' => $this->format_annotation( $annotations['idempotent'] ),
'public' => $ability->get_meta_item( 'public', false ) ? '1' : '0',
'show_in_rest' => $ability->get_meta_item( 'show_in_rest', false ) ? '1' : '0',
];
}
/**
* Formats an ability for get output.
*
* @param WP_Ability $ability The ability object.
* @return array<string,mixed>
*/
private function format_ability_for_get( $ability ) {
$annotations = $this->get_annotations( $ability );
$meta = $ability->get_meta();
return [
'name' => $ability->get_name(),
'label' => $ability->get_label(),
'category' => $ability->get_category(),
'description' => $ability->get_description(),
'input_schema' => wp_json_encode( $ability->get_input_schema() ),
'output_schema' => wp_json_encode( $ability->get_output_schema() ),
'readonly' => $this->format_annotation( $annotations['readonly'] ),
'destructive' => $this->format_annotation( $annotations['destructive'] ),
'idempotent' => $this->format_annotation( $annotations['idempotent'] ),
'public' => $ability->get_meta_item( 'public', false ) ? '1' : '0',
'show_in_rest' => $ability->get_meta_item( 'show_in_rest', false ) ? '1' : '0',
'meta' => ! empty( $meta ) ? wp_json_encode( $meta ) : '{}',
];
}
/**
* Gets annotations from an ability with proper typing.
*
* @param WP_Ability $ability The ability object.
* @return array{readonly: bool|null, destructive: bool|null, idempotent: bool|null}
*/
private function get_annotations( $ability ) {
$meta_annotations = $ability->get_meta_item( 'annotations', [] );
$annotations = is_array( $meta_annotations ) ? $meta_annotations : [];
return [
'readonly' => isset( $annotations['readonly'] ) && is_bool( $annotations['readonly'] ) ? $annotations['readonly'] : null,
'destructive' => isset( $annotations['destructive'] ) && is_bool( $annotations['destructive'] ) ? $annotations['destructive'] : null,
'idempotent' => isset( $annotations['idempotent'] ) && is_bool( $annotations['idempotent'] ) ? $annotations['idempotent'] : null,
];
}
/**
* Formats an annotation value for output.
*
* @param bool|null $value The annotation value.
* @return string '1' for true, '0' for false, '' for null.
*/
private function format_annotation( $value ) {
if ( null === $value ) {
return '';
}
return $value ? '1' : '0';
}
/**
* Gets the formatter object.
*
* @param array $assoc_args Associative arguments.
* @param string[] $default_fields Default fields to display.
* @return Formatter
*/
private function get_formatter( &$assoc_args, $default_fields ) {
return new Formatter( $assoc_args, $default_fields );
}
}