forked from Automattic/jetpack
-
Notifications
You must be signed in to change notification settings - Fork 0
/
class.jetpack-cli.php
1255 lines (1118 loc) · 41 KB
/
class.jetpack-cli.php
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
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
WP_CLI::add_command( 'jetpack', 'Jetpack_CLI' );
/**
* Control your local Jetpack installation.
*/
class Jetpack_CLI extends WP_CLI_Command {
// Aesthetics
public $green_open = "\033[32m";
public $red_open = "\033[31m";
public $yellow_open = "\033[33m";
public $color_close = "\033[0m";
/**
* Get Jetpack Details
*
* ## OPTIONS
*
* empty: Leave it empty for basic stats
*
* full: View full stats. It's the data from the heartbeat
*
* ## EXAMPLES
*
* wp jetpack status
* wp jetpack status full
*
*/
public function status( $args, $assoc_args ) {
WP_CLI::line( sprintf( __( 'Checking status for %s', 'jetpack' ), esc_url( get_site_url() ) ) );
if ( ! Jetpack::is_active() ) {
WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) );
}
if ( isset( $args[0] ) && 'full' !== $args[0] ) {
/* translators: %s is a command like "prompt" */
WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $args[0] ) );
}
$master_user_email = Jetpack::get_master_user_email();
/*
* Are they asking for all data?
*
* Loop through heartbeat data and organize by priority.
*/
$all_data = ( isset( $args[0] ) && 'full' == $args[0] ) ? 'full' : false;
if ( $all_data ) {
WP_CLI::success( __( 'Jetpack is currently connected to WordPress.com', 'jetpack' ) );
WP_CLI::line( sprintf( __( "The Jetpack Version is %s", 'jetpack' ), JETPACK__VERSION ) );
WP_CLI::line( sprintf( __( "The WordPress.com blog_id is %d", 'jetpack' ), Jetpack_Options::get_option( 'id' ) ) );
WP_CLI::line( sprintf( __( 'The WordPress.com account for the primary connection is %s', 'jetpack' ), $master_user_email ) );
// Heartbeat data
WP_CLI::line( "\n" . __( 'Additional data: ', 'jetpack' ) );
// Get the filtered heartbeat data.
// Filtered so we can color/list by severity
$stats = Jetpack::jetpack_check_heartbeat_data();
// Display red flags first
foreach ( $stats['bad'] as $stat => $value ) {
printf( "$this->red_open%-'.16s %s $this->color_close\n", $stat, $value );
}
// Display caution warnings next
foreach ( $stats['caution'] as $stat => $value ) {
printf( "$this->yellow_open%-'.16s %s $this->color_close\n", $stat, $value );
}
// The rest of the results are good!
foreach ( $stats['good'] as $stat => $value ) {
// Modules should get special spacing for aestetics
if ( strpos( $stat, 'odule-' ) ) {
printf( "%-'.30s %s\n", $stat, $value );
usleep( 4000 ); // For dramatic effect lolz
continue;
}
printf( "%-'.16s %s\n", $stat, $value );
usleep( 4000 ); // For dramatic effect lolz
}
} else {
// Just the basics
WP_CLI::success( __( 'Jetpack is currently connected to WordPress.com', 'jetpack' ) );
WP_CLI::line( sprintf( __( 'The Jetpack Version is %s', 'jetpack' ), JETPACK__VERSION ) );
WP_CLI::line( sprintf( __( 'The WordPress.com blog_id is %d', 'jetpack' ), Jetpack_Options::get_option( 'id' ) ) );
WP_CLI::line( sprintf( __( 'The WordPress.com account for the primary connection is %s', 'jetpack' ), $master_user_email ) );
WP_CLI::line( "\n" . _x( "View full status with 'wp jetpack status full'", '"wp jetpack status full" is a command - do not translate', 'jetpack' ) );
}
}
/**
* Tests the active connection
*
* Does a two-way test to verify that the local site can communicate with remote Jetpack/WP.com servers and that Jetpack/WP.com servers can talk to the local site.
*
* ## EXAMPLES
*
* wp jetpack test-connection
*
* @subcommand test-connection
*/
public function test_connection( $args, $assoc_args ) {
WP_CLI::line( sprintf( __( 'Testing connection for %s', 'jetpack' ), esc_url( get_site_url() ) ) );
if ( ! Jetpack::is_active() ) {
WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) );
}
$response = Jetpack_Client::wpcom_json_api_request_as_blog(
sprintf( '/jetpack-blogs/%d/test-connection', Jetpack_Options::get_option( 'id' ) ),
Jetpack_Client::WPCOM_JSON_API_VERSION
);
if ( is_wp_error( $response ) ) {
/* translators: %1$s is the error code, %2$s is the error message */
WP_CLI::error( sprintf( __( 'Failed to test connection (#%1$s: %2$s)', 'jetpack' ), $response->get_error_code(), $response->get_error_message() ) );
}
$body = wp_remote_retrieve_body( $response );
if ( ! $body ) {
WP_CLI::error( __( 'Failed to test connection (empty response body)', 'jetpack' ) );
}
$result = json_decode( $body );
$is_connected = (bool) $result->connected;
$message = $result->message;
if ( $is_connected ) {
WP_CLI::success( $message );
} else {
WP_CLI::error( $message );
}
}
/**
* Disconnect Jetpack Blogs or Users
*
* ## OPTIONS
*
* blog: Disconnect the entire blog.
*
* user <user_identifier>: Disconnect a specific user from WordPress.com.
*
* Please note, the primary account that the blog is connected
* to WordPress.com with cannot be disconnected without
* disconnecting the entire blog.
*
* ## EXAMPLES
*
* wp jetpack disconnect blog
* wp jetpack disconnect user 13
* wp jetpack disconnect user username
* wp jetpack disconnect user email@domain.com
*
* @synopsis <blog|user> [<user_identifier>]
*/
public function disconnect( $args, $assoc_args ) {
if ( ! Jetpack::is_active() ) {
WP_CLI::error( __( 'You cannot disconnect, without having first connected.', 'jetpack' ) );
}
$action = isset( $args[0] ) ? $args[0] : 'prompt';
if ( ! in_array( $action, array( 'blog', 'user', 'prompt' ) ) ) {
/* translators: %s is a command like "prompt" */
WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) );
}
if ( in_array( $action, array( 'user' ) ) ) {
if ( isset( $args[1] ) ) {
$user_id = $args[1];
if ( ctype_digit( $user_id ) ) {
$field = 'id';
$user_id = (int) $user_id;
} elseif ( is_email( $user_id ) ) {
$field = 'email';
$user_id = sanitize_user( $user_id, true );
} else {
$field = 'login';
$user_id = sanitize_user( $user_id, true );
}
if ( ! $user = get_user_by( $field, $user_id ) ) {
WP_CLI::error( __( 'Please specify a valid user.', 'jetpack' ) );
}
} else {
WP_CLI::error( __( 'Please specify a user by either ID, username, or email.', 'jetpack' ) );
}
}
switch ( $action ) {
case 'blog':
Jetpack::log( 'disconnect' );
Jetpack::disconnect();
WP_CLI::success( sprintf(
__( 'Jetpack has been successfully disconnected for %s.', 'jetpack' ),
esc_url( get_site_url() )
) );
break;
case 'user':
if ( Jetpack::unlink_user( $user->ID ) ) {
Jetpack::log( 'unlink', $user->ID );
WP_CLI::success( __( 'User has been successfully disconnected.', 'jetpack' ) );
} else {
/* translators: %s is a username */
WP_CLI::error( sprintf( __( "User %s could not be disconnected. Are you sure they're connected currently?", 'jetpack' ), "{$user->login} <{$user->email}>" ) );
}
break;
case 'prompt':
WP_CLI::error( __( 'Please specify if you would like to disconnect a blog or user.', 'jetpack' ) );
break;
}
}
/**
* Reset Jetpack options and settings to default
*
* ## OPTIONS
*
* modules: Resets modules to default state ( get_default_modules() )
*
* options: Resets all Jetpack options except:
* - All private options (Blog token, user token, etc...)
* - id (The Client ID/WP.com Blog ID of this site)
* - master_user
* - version
* - activated
*
* ## EXAMPLES
*
* wp jetpack reset options
* wp jetpack reset modules
*
* @synopsis <modules|options>
*/
public function reset( $args, $assoc_args ) {
$action = isset( $args[0] ) ? $args[0] : 'prompt';
if ( ! in_array( $action, array( 'options', 'modules' ) ) ) {
/* translators: %s is a command like "prompt" */
WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) );
}
// Are you sure?
jetpack_cli_are_you_sure();
switch ( $action ) {
case 'options':
$options_to_reset = Jetpack_Options::get_options_for_reset();
// Reset the Jetpack options
WP_CLI::line( sprintf(
__( "Resetting Jetpack Options for %s...\n", "jetpack" ),
esc_url( get_site_url() )
) );
sleep(1); // Take a breath
foreach ( $options_to_reset['jp_options'] as $option_to_reset ) {
Jetpack_Options::delete_option( $option_to_reset );
usleep( 100000 );
/* translators: This is the result of an action. The option named %s was reset */
WP_CLI::success( sprintf( __( '%s option reset', 'jetpack' ), $option_to_reset ) );
}
// Reset the WP options
WP_CLI::line( __( "Resetting the jetpack options stored in wp_options...\n", "jetpack" ) );
usleep( 500000 ); // Take a breath
foreach ( $options_to_reset['wp_options'] as $option_to_reset ) {
delete_option( $option_to_reset );
usleep( 100000 );
/* translators: This is the result of an action. The option named %s was reset */
WP_CLI::success( sprintf( __( '%s option reset', 'jetpack' ), $option_to_reset ) );
}
// Reset to default modules
WP_CLI::line( __( "Resetting default modules...\n", "jetpack" ) );
usleep( 500000 ); // Take a breath
$default_modules = Jetpack::get_default_modules();
Jetpack::update_active_modules( $default_modules );
WP_CLI::success( __( 'Modules reset to default.', 'jetpack' ) );
// Jumpstart option is special
Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
WP_CLI::success( __( 'jumpstart option reset', 'jetpack' ) );
break;
case 'modules':
$default_modules = Jetpack::get_default_modules();
Jetpack::update_active_modules( $default_modules );
WP_CLI::success( __( 'Modules reset to default.', 'jetpack' ) );
break;
case 'prompt':
WP_CLI::error( __( 'Please specify if you would like to reset your options, or modules', 'jetpack' ) );
break;
}
}
/**
* Manage Jetpack Modules
*
* ## OPTIONS
*
* list : View all available modules, and their status.
* activate all : Activate all modules
* deactivate all: Deactivate all modules
*
* activate <module_slug> : Activate a module.
* deactivate <module_slug> : Deactivate a module.
* toggle <module_slug> : Toggle a module on or off.
*
* ## EXAMPLES
*
* wp jetpack module list
* wp jetpack module activate stats
* wp jetpack module deactivate stats
* wp jetpack module toggle stats
*
* wp jetpack module activate all
* wp jetpack module deactivate all
*
* @synopsis <list|activate|deactivate|toggle> [<module_name>]
*/
public function module( $args, $assoc_args ) {
$action = isset( $args[0] ) ? $args[0] : 'list';
if ( ! in_array( $action, array( 'list', 'activate', 'deactivate', 'toggle' ) ) ) {
/* translators: %s is a command like "prompt" */
WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) );
}
if ( in_array( $action, array( 'activate', 'deactivate', 'toggle' ) ) ) {
if ( isset( $args[1] ) ) {
$module_slug = $args[1];
if ( 'all' !== $module_slug && ! Jetpack::is_module( $module_slug ) ) {
WP_CLI::error( sprintf( __( '%s is not a valid module.', 'jetpack' ), $module_slug ) );
}
if ( 'toggle' == $action ) {
$action = Jetpack::is_module_active( $module_slug ) ? 'deactivate' : 'activate';
}
// Bulk actions
if ( 'all' == $args[1] ) {
$action = ( 'deactivate' == $action ) ? 'deactivate_all' : 'activate_all';
}
} else {
WP_CLI::line( __( 'Please specify a valid module.', 'jetpack' ) );
$action = 'list';
}
}
switch ( $action ) {
case 'list':
WP_CLI::line( __( 'Available Modules:', 'jetpack' ) );
$modules = Jetpack::get_available_modules();
sort( $modules );
foreach( $modules as $module_slug ) {
if ( 'vaultpress' == $module_slug ) {
continue;
}
$active = Jetpack::is_module_active( $module_slug ) ? __( 'Active', 'jetpack' ) : __( 'Inactive', 'jetpack' );
WP_CLI::line( "\t" . str_pad( $module_slug, 24 ) . $active );
}
break;
case 'activate':
$module = Jetpack::get_module( $module_slug );
Jetpack::log( 'activate', $module_slug );
if ( Jetpack::activate_module( $module_slug, false, false ) ) {
WP_CLI::success( sprintf( __( '%s has been activated.', 'jetpack' ), $module['name'] ) );
} else {
WP_CLI::error( sprintf( __( '%s could not be activated.', 'jetpack' ), $module['name'] ) );
}
break;
case 'activate_all':
$modules = Jetpack::get_available_modules();
Jetpack::update_active_modules( $modules );
WP_CLI::success( __( 'All modules activated!', 'jetpack' ) );
break;
case 'deactivate':
$module = Jetpack::get_module( $module_slug );
Jetpack::log( 'deactivate', $module_slug );
Jetpack::deactivate_module( $module_slug );
WP_CLI::success( sprintf( __( '%s has been deactivated.', 'jetpack' ), $module['name'] ) );
break;
case 'deactivate_all':
Jetpack::delete_active_modules();
WP_CLI::success( __( 'All modules deactivated!', 'jetpack' ) );
break;
case 'toggle':
// Will never happen, should have been handled above and changed to activate or deactivate.
break;
}
}
/**
* Manage Protect Settings
*
* ## OPTIONS
*
* whitelist: Whitelist an IP address. You can also read or clear the whitelist.
*
*
* ## EXAMPLES
*
* wp jetpack protect whitelist <ip address>
* wp jetpack protect whitelist list
* wp jetpack protect whitelist clear
*
* @synopsis <whitelist> [<ip|ip_low-ip_high|list|clear>]
*/
public function protect( $args, $assoc_args ) {
$action = isset( $args[0] ) ? $args[0] : 'prompt';
if ( ! in_array( $action, array( 'whitelist' ) ) ) {
/* translators: %s is a command like "prompt" */
WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) );
}
// Check if module is active
if ( ! Jetpack::is_module_active( __FUNCTION__ ) ) {
WP_CLI::error( sprintf( _x( '%s is not active. You can activate it with "wp jetpack module activate %s"', '"wp jetpack module activate" is a command - do not translate', 'jetpack' ), __FUNCTION__, __FUNCTION__ ) );
}
if ( in_array( $action, array( 'whitelist' ) ) ) {
if ( isset( $args[1] ) ) {
$action = 'whitelist';
} else {
$action = 'prompt';
}
}
switch ( $action ) {
case 'whitelist':
$whitelist = array();
$new_ip = $args[1];
$current_whitelist = get_site_option( 'jetpack_protect_whitelist', array() );
// Build array of IPs that are already whitelisted.
// Re-build manually instead of using jetpack_protect_format_whitelist() so we can easily get
// low & high range params for jetpack_protect_ip_address_is_in_range();
foreach( $current_whitelist as $whitelisted ) {
// IP ranges
if ( $whitelisted->range ) {
// Is it already whitelisted?
if ( jetpack_protect_ip_address_is_in_range( $new_ip, $whitelisted->range_low, $whitelisted->range_high ) ) {
/* translators: %s is an IP address */
WP_CLI::error( sprintf( __( '%s has already been whitelisted', 'jetpack' ), $new_ip ) );
break;
}
$whitelist[] = $whitelisted->range_low . " - " . $whitelisted->range_high;
} else { // Individual IPs
// Check if the IP is already whitelisted (single IP only)
if ( $new_ip == $whitelisted->ip_address ) {
/* translators: %s is an IP address */
WP_CLI::error( sprintf( __( '%s has already been whitelisted', 'jetpack' ), $new_ip ) );
break;
}
$whitelist[] = $whitelisted->ip_address;
}
}
/*
* List the whitelist
* Done here because it's easier to read the $whitelist array after it's been rebuilt
*/
if ( isset( $args[1] ) && 'list' == $args[1] ) {
if ( ! empty( $whitelist ) ) {
WP_CLI::success( __( 'Here are your whitelisted IPs:', 'jetpack' ) );
foreach ( $whitelist as $ip ) {
WP_CLI::line( "\t" . str_pad( $ip, 24 ) ) ;
}
} else {
WP_CLI::line( __( 'Whitelist is empty.', "jetpack" ) ) ;
}
break;
}
/*
* Clear the whitelist
*/
if ( isset( $args[1] ) && 'clear' == $args[1] ) {
if ( ! empty( $whitelist ) ) {
$whitelist = array();
jetpack_protect_save_whitelist( $whitelist );
WP_CLI::success( __( 'Cleared all whitelisted IPs', 'jetpack' ) );
} else {
WP_CLI::line( __( 'Whitelist is empty.', "jetpack" ) ) ;
}
break;
}
// Append new IP to whitelist array
array_push( $whitelist, $new_ip );
// Save whitelist if there are no errors
$result = jetpack_protect_save_whitelist( $whitelist );
if ( is_wp_error( $result ) ) {
WP_CLI::error( __( $result, 'jetpack' ) );
}
/* translators: %s is an IP address */
WP_CLI::success( sprintf( __( '%s has been whitelisted.', 'jetpack' ), $new_ip ) );
break;
case 'prompt':
WP_CLI::error(
__( 'No command found.', 'jetpack' ) . "\n" .
__( 'Please enter the IP address you want to whitelist.', 'jetpack' ) . "\n" .
_x( 'You can save a range of IPs {low_range}-{high_range}. No spaces allowed. (example: 1.1.1.1-2.2.2.2)', 'Instructions on how to whitelist IP ranges - low_range/high_range should be translated.', 'jetpack' ) . "\n" .
_x( "You can also 'list' or 'clear' the whitelist.", "'list' and 'clear' are commands and should not be translated", 'jetpack' ) . "\n"
);
break;
}
}
/**
* Manage Jetpack Options
*
* ## OPTIONS
*
* list : List all jetpack options and their values
* delete : Delete an option
* - can only delete options that are white listed.
* update : update an option
* - can only update option strings
* get : get the value of an option
*
* ## EXAMPLES
*
* wp jetpack options list
* wp jetpack options get <option_name>
* wp jetpack options delete <option_name>
* wp jetpack options update <option_name> [<option_value>]
*
* @synopsis <list|get|delete|update> [<option_name>] [<option_value>]
*/
public function options( $args, $assoc_args ) {
$action = isset( $args[0] ) ? $args[0] : 'list';
$safe_to_modify = Jetpack_Options::get_options_for_reset();
// Jumpstart is special
array_push( $safe_to_modify, 'jumpstart' );
// Is the option flagged as unsafe?
$flagged = ! in_array( $args[1], $safe_to_modify );
if ( ! in_array( $action, array( 'list', 'get', 'delete', 'update' ) ) ) {
/* translators: %s is a command like "prompt" */
WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) );
}
if ( isset( $args[0] ) ) {
if ( 'get' == $args[0] && isset( $args[1] ) ) {
$action = 'get';
} else if ( 'delete' == $args[0] && isset( $args[1] ) ) {
$action = 'delete';
} else if ( 'update' == $args[0] && isset( $args[1] ) ) {
$action = 'update';
} else {
$action = 'list';
}
}
// Bail if the option isn't found
$option = isset( $args[1] ) ? Jetpack_Options::get_option( $args[1] ) : false;
if ( isset( $args[1] ) && ! $option && 'update' !== $args[0] ) {
WP_CLI::error( __( 'Option not found or is empty. Use "list" to list option names', 'jetpack' ) );
}
// Let's print_r the option if it's an array
// Used in the 'get' and 'list' actions
$option = is_array( $option ) ? print_r( $option ) : $option;
switch ( $action ) {
case 'get':
WP_CLI::success( "\t" . $option );
break;
case 'delete':
jetpack_cli_are_you_sure( $flagged );
Jetpack_Options::delete_option( $args[1] );
WP_CLI::success( sprintf( __( 'Deleted option: %s', 'jetpack' ), $args[1] ) );
break;
case 'update':
jetpack_cli_are_you_sure( $flagged );
// Updating arrays would get pretty tricky...
$value = Jetpack_Options::get_option( $args[1] );
if ( $value && is_array( $value ) ) {
WP_CLI::error( __( 'Sorry, no updating arrays at this time', 'jetpack' ) );
}
Jetpack_Options::update_option( $args[1], $args[2] );
WP_CLI::success( sprintf( _x( 'Updated option: %s to "%s"', 'Updating an option from "this" to "that".', 'jetpack' ), $args[1], $args[2] ) );
break;
case 'list':
$options_compact = Jetpack_Options::get_option_names();
$options_non_compact = Jetpack_Options::get_option_names( 'non_compact' );
$options_private = Jetpack_Options::get_option_names( 'private' );
$options = array_merge( $options_compact, $options_non_compact, $options_private );
// Table headers
WP_CLI::line( "\t" . str_pad( __( 'Option', 'jetpack' ), 30 ) . __( 'Value', 'jetpack' ) );
// List out the options and their values
// Tell them if the value is empty or not
// Tell them if it's an array
foreach ( $options as $option ) {
$value = Jetpack_Options::get_option( $option );
if ( ! $value ) {
WP_CLI::line( "\t" . str_pad( $option, 30 ) . 'Empty' );
continue;
}
if ( ! is_array( $value ) ) {
WP_CLI::line( "\t" . str_pad( $option, 30 ) . $value );
} else if ( is_array( $value ) ) {
WP_CLI::line( "\t" . str_pad( $option, 30 ) . 'Array - Use "get <option>" to read option array.' );
}
}
$option_text = '{' . _x( 'option', 'a variable command that a user can write, provided in the printed instructions', 'jetpack' ) . '}';
$value_text = '{' . _x( 'value', 'the value that they want to update the option to', 'jetpack' ) . '}';
WP_CLI::success(
_x( "Above are your options. You may 'get', 'delete', and 'update' them.", "'get', 'delete', and 'update' are commands - do not translate.", 'jetpack' ) . "\n" .
str_pad( 'wp jetpack options get', 26 ) . $option_text . "\n" .
str_pad( 'wp jetpack options delete', 26 ) . $option_text . "\n" .
str_pad( 'wp jetpack options update', 26 ) . "$option_text $value_text" . "\n" .
_x( "Type 'wp jetpack options' for more info.", "'wp jetpack options' is a command - do not translate.", 'jetpack' ) . "\n"
);
break;
}
}
/**
* Get the status of or start a new Jetpack sync.
*
* ## OPTIONS
*
* status : Print the current sync status
* start : Start a full sync from this site to WordPress.com
*
* ## EXAMPLES
*
* wp jetpack sync status
* wp jetpack sync start --modules=functions --sync_wait_time=5
*
* @synopsis <status|start> [--<field>=<value>]
*/
public function sync( $args, $assoc_args ) {
if ( ! Jetpack_Sync_Actions::sync_allowed() ) {
WP_CLI::error( __( 'Jetpack sync is not currently allowed for this site.', 'jetpack' ) );
}
$action = isset( $args[0] ) ? $args[0] : 'status';
switch ( $action ) {
case 'status':
$status = Jetpack_Sync_Actions::get_sync_status();
$collection = array();
foreach ( $status as $key => $item ) {
$collection[] = array(
'option' => $key,
'value' => is_scalar( $item ) ? $item : json_encode( $item )
);
}
WP_CLI\Utils\format_items( 'table', $collection, array( 'option', 'value' ) );
break;
case 'start':
// Get the original settings so that we can restore them later
$original_settings = Jetpack_Sync_Settings::get_settings();
// Initialize sync settigns so we can sync as quickly as possible
$sync_settings = wp_parse_args(
array_intersect_key( $assoc_args, Jetpack_Sync_Settings::$valid_settings ),
array(
'sync_wait_time' => 0,
'enqueue_wait_time' => 0,
'queue_max_writes_sec' => 10000,
'max_queue_size_full_sync' => 100000
)
);
Jetpack_Sync_Settings::update_settings( $sync_settings );
// Convert comma-delimited string of modules to an array
if ( ! empty( $assoc_args['modules'] ) ) {
$modules = array_map( 'trim', explode( ',', $assoc_args['modules'] ) );
// Convert the array so that the keys are the module name and the value is true to indicate
// that we want to sync the module
$modules = array_map( '__return_true', array_flip( $modules ) );
}
foreach ( array( 'posts', 'comments', 'users' ) as $module_name ) {
if (
'users' === $module_name &&
isset( $assoc_args[ $module_name ] ) &&
'initial' === $assoc_args[ $module_name ]
) {
$modules[ 'users' ] = 'initial';
} elseif ( isset( $assoc_args[ $module_name ] ) ) {
$ids = explode( ',', $assoc_args[ $module_name ] );
if ( count( $ids ) > 0 ) {
$modules[ $module_name ] = $ids;
}
}
}
if ( empty( $modules ) ) {
$modules = null;
}
// Kick off a full sync
if ( Jetpack_Sync_Actions::do_full_sync( $modules ) ) {
if ( $modules ) {
WP_CLI::log( sprintf( __( 'Initialized a new full sync with modules: %s', 'jetpack' ), join( ', ', array_keys( $modules ) ) ) );
} else {
WP_CLI::log( __( 'Initialized a new full sync', 'jetpack' ) );
}
} else {
// Reset sync settings to original.
Jetpack_Sync_Settings::update_settings( $original_settings );
if ( $modules ) {
WP_CLI::error( sprintf( __( 'Could not start a new full sync with modules: %s', 'jetpack' ), join( ', ', $modules ) ) );
} else {
WP_CLI::error( __( 'Could not start a new full sync', 'jetpack' ) );
}
}
// Keep sending to WPCOM until there's nothing to send
$i = 1;
do {
$result = Jetpack_Sync_Actions::$sender->do_full_sync();
if ( is_wp_error( $result ) ) {
$queue_empty_error = ( 'empty_queue_full_sync' == $result->get_error_code() );
if ( ! $queue_empty_error || ( $queue_empty_error && ( 1 == $i ) ) ) {
WP_CLI::error( sprintf( __( 'Sync errored with code: %s', 'jetpack' ), $result->get_error_code() ) );
}
} else {
if ( 1 == $i ) {
WP_CLI::log( __( 'Sent data to WordPress.com', 'jetpack' ) );
} else {
WP_CLI::log( __( 'Sent more data to WordPress.com', 'jetpack' ) );
}
}
$i++;
} while ( $result && ! is_wp_error( $result ) );
// Reset sync settings to original.
Jetpack_Sync_Settings::update_settings( $original_settings );
WP_CLI::success( __( 'Finished syncing to WordPress.com', 'jetpack' ) );
break;
}
}
/**
* List the contents of a specific Jetpack sync queue.
*
* ## OPTIONS
*
* peek : List the 100 front-most items on the queue.
*
* ## EXAMPLES
*
* wp jetpack sync_queue full_sync peek
*
* @synopsis <incremental|full_sync> <peek>
*/
public function sync_queue( $args, $assoc_args ) {
if ( ! Jetpack_Sync_Actions::sync_allowed() ) {
WP_CLI::error( __( 'Jetpack sync is not currently allowed for this site.', 'jetpack' ) );
}
$queue_name = isset( $args[0] ) ? $args[0] : 'sync';
$action = isset( $args[1] ) ? $args[1] : 'peek';
// We map the queue name that way we can support more friendly queue names in the commands, but still use
// the queue name that the code expects.
$queue_name_map = $allowed_queues = array(
'incremental' => 'sync',
'full' => 'full_sync',
);
$mapped_queue_name = isset( $queue_name_map[ $queue_name ] ) ? $queue_name_map[ $queue_name ] : $queue_name;
switch( $action ) {
case 'peek':
require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-queue.php';
$queue = new Jetpack_Sync_Queue( $mapped_queue_name );
$items = $queue->peek( 100 );
if ( empty( $items ) ) {
/* translators: %s is the name of the queue, either 'incremental' or 'full' */
WP_CLI::log( sprintf( __( 'Nothing is in the queue: %s', 'jetpack' ), $queue_name ) );
} else {
$collection = array();
foreach ( $items as $item ) {
$collection[] = array(
'action' => $item[0],
'args' => json_encode( $item[1] ),
'current_user_id' => $item[2],
'microtime' => $item[3],
'importing' => (string) $item[4],
);
}
WP_CLI\Utils\format_items(
'table',
$collection,
array(
'action',
'args',
'current_user_id',
'microtime',
'importing',
)
);
}
break;
}
}
/**
* Cancel's the current Jetpack plan granted by this partner, if applicable
*
* Returns success or error JSON
*
* <token_json>
* : JSON blob of WPCOM API token
* [--partner_tracking_id=<partner_tracking_id>]
* : This is an optional ID that a host can pass to help identify a site in logs on WordPress.com
*
* * @synopsis <token_json> [--partner_tracking_id=<partner_tracking_id>]
*/
public function partner_cancel( $args, $named_args ) {
list( $token_json ) = $args;
if ( ! $token_json || ! ( $token = json_decode( $token_json ) ) ) {
$this->partner_provision_error( new WP_Error( 'missing_access_token', sprintf( __( 'Invalid token JSON: %s', 'jetpack' ), $token_json ) ) );
}
if ( isset( $token->error ) ) {
$this->partner_provision_error( new WP_Error( $token->error, $token->message ) );
}
if ( ! isset( $token->access_token ) ) {
$this->partner_provision_error( new WP_Error( 'missing_access_token', __( 'Missing or invalid access token', 'jetpack' ) ) );
}
if ( Jetpack::validate_sync_error_idc_option() ) {
$this->partner_provision_error( new WP_Error(
'site_in_safe_mode',
esc_html__( 'Can not cancel a plan while in safe mode. See: https://jetpack.com/support/safe-mode/', 'jetpack' )
) );
}
$site_identifier = Jetpack_Options::get_option( 'id' );
if ( ! $site_identifier ) {
$site_identifier = Jetpack::build_raw_urls( get_home_url() );
}
$request = array(
'headers' => array(
'Authorization' => "Bearer " . $token->access_token,
'Host' => defined( 'JETPACK__WPCOM_JSON_API_HOST_HEADER' ) ? JETPACK__WPCOM_JSON_API_HOST_HEADER : 'public-api.wordpress.com',
),
'timeout' => 60,
'method' => 'POST',
);
$url = sprintf( 'https://%s/rest/v1.3/jpphp/%s/partner-cancel', $this->get_api_host(), $site_identifier );
if ( ! empty( $named_args ) && ! empty( $named_args['partner_tracking_id'] ) ) {
$url = esc_url_raw( add_query_arg( 'partner_tracking_id', $named_args['partner_tracking_id'], $url ) );
}
$result = Jetpack_Client::_wp_remote_request( $url, $request );
Jetpack_Options::delete_option( 'onboarding' );
if ( is_wp_error( $result ) ) {
$this->partner_provision_error( $result );
}
WP_CLI::log( wp_remote_retrieve_body( $result ) );
}
/**
* Provision a site using a Jetpack Partner license
*
* Returns JSON blob
*
* ## OPTIONS
*
* <token_json>
* : JSON blob of WPCOM API token
* [--plan=<plan_name>]
* : Slug of the requested plan, e.g. premium
* [--wpcom_user_id=<user_id>]
* : WordPress.com ID of user to connect as (must be whitelisted against partner key)
* [--wpcom_user_email=<wpcom_user_email>]
* : Override the email we send to WordPress.com for registration
* [--onboarding=<onboarding>]
* : Guide the user through an onboarding wizard
* [--force_register=<register>]
* : Whether to force a site to register
* [--force_connect=<force_connect>]
* : Force JPS to not reuse existing credentials
* [--home_url=<home_url>]
* : Overrides the home option via the home_url filter, or the WP_HOME constant
* [--site_url=<site_url>]
* : Overrides the siteurl option via the site_url filter, or the WP_SITEURL constant
* [--partner_tracking_id=<partner_tracking_id>]
* : This is an optional ID that a host can pass to help identify a site in logs on WordPress.com
*
* ## EXAMPLES
*
* $ wp jetpack partner_provision '{ some: "json" }' premium 1
* { success: true }
*
* @synopsis <token_json> [--wpcom_user_id=<user_id>] [--plan=<plan_name>] [--onboarding=<onboarding>] [--force_register=<register>] [--force_connect=<force_connect>] [--home_url=<home_url>] [--site_url=<site_url>] [--wpcom_user_email=<wpcom_user_email>] [--partner_tracking_id=<partner_tracking_id>]
*/
public function partner_provision( $args, $named_args ) {
list( $token_json ) = $args;
if ( ! $token_json || ! ( $token = json_decode( $token_json ) ) ) {
$this->partner_provision_error( new WP_Error( 'missing_access_token', sprintf( __( 'Invalid token JSON: %s', 'jetpack' ), $token_json ) ) );
}
if ( isset( $token->error ) ) {
$message = isset( $token->message )
? $token->message
: '';
$this->partner_provision_error( new WP_Error( $token->error, $message ) );
}
if ( ! isset( $token->access_token ) ) {
$this->partner_provision_error( new WP_Error( 'missing_access_token', __( 'Missing or invalid access token', 'jetpack' ) ) );
}
require_once JETPACK__PLUGIN_DIR . '_inc/class.jetpack-provision.php';
$body_json = Jetpack_Provision::partner_provision( $token->access_token, $named_args );
if ( is_wp_error( $body_json ) ) {
error_log( json_encode( array(
'success' => false,
'error_code' => $body_json->get_error_code(),
'error_message' => $body_json->get_error_message()
) ) );
exit( 1 );
}
WP_CLI::log( json_encode( $body_json ) );
}
/**
* Manages your Jetpack sitemap
*
* ## OPTIONS
*
* rebuild : Rebuild all sitemaps
* --purge : if set, will remove all existing sitemap data before rebuilding
*
* ## EXAMPLES
*
* wp jetpack sitemap rebuild
*
* @subcommand sitemap
* @synopsis <rebuild> [--purge]
*/
public function sitemap( $args, $assoc_args ) {
if ( ! Jetpack::is_active() ) {
WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) );
}
if ( ! Jetpack::is_module_active( 'sitemaps' ) ) {
WP_CLI::error( __( 'Jetpack Sitemaps module is not currently active. Activate it first if you want to work with sitemaps.', 'jetpack' ) );
}
if ( ! class_exists( 'Jetpack_Sitemap_Builder' ) ) {
WP_CLI::error( __( 'Jetpack Sitemaps module is active, but unavailable. This can happen if your site is set to discourage search engine indexing. Please enable search engine indexing to allow sitemap generation.', 'jetpack' ) );
}
if ( isset( $assoc_args['purge'] ) && $assoc_args['purge'] ) {
$librarian = new Jetpack_Sitemap_Librarian();
$librarian->delete_all_stored_sitemap_data();
}
$sitemap_builder = new Jetpack_Sitemap_Builder();
$sitemap_builder->update_sitemap();
}
/**
* Allows authorizing a user via the command line and will activate
*
* ## EXAMPLES
*
* wp jetpack authorize_user --token=123456789abcdef
*
* @synopsis --token=<value>
*/
public function authorize_user( $args, $named_args ) {