Automattic /
jetpack
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Jetpack_CLI often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Jetpack_CLI, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 8 | class Jetpack_CLI extends WP_CLI_Command { |
||
| 9 | |||
| 10 | // Aesthetics |
||
| 11 | public $green_open = "\033[32m"; |
||
| 12 | public $red_open = "\033[31m"; |
||
| 13 | public $yellow_open = "\033[33m"; |
||
| 14 | public $color_close = "\033[0m"; |
||
| 15 | |||
| 16 | /** |
||
| 17 | * Get Jetpack Details |
||
| 18 | * |
||
| 19 | * ## OPTIONS |
||
| 20 | * |
||
| 21 | * empty: Leave it empty for basic stats |
||
| 22 | * |
||
| 23 | * full: View full stats. It's the data from the heartbeat |
||
| 24 | * |
||
| 25 | * ## EXAMPLES |
||
| 26 | * |
||
| 27 | * wp jetpack status |
||
| 28 | * wp jetpack status full |
||
| 29 | * |
||
| 30 | */ |
||
| 31 | public function status( $args, $assoc_args ) { |
||
| 32 | |||
| 33 | WP_CLI::line( sprintf( __( 'Checking status for %s', 'jetpack' ), esc_url( get_site_url() ) ) ); |
||
| 34 | |||
| 35 | if ( ! Jetpack::is_active() ) { |
||
| 36 | WP_CLI::error( __( 'Jetpack is not currently connected to WordPress.com', 'jetpack' ) ); |
||
| 37 | } |
||
| 38 | |||
| 39 | View Code Duplication | if ( isset( $args[0] ) && 'full' !== $args[0] ) { |
|
| 40 | /* translators: %s is a command like "prompt" */ |
||
| 41 | WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $args[0] ) ); |
||
| 42 | } |
||
| 43 | |||
| 44 | $master_user_email = Jetpack::get_master_user_email(); |
||
| 45 | |||
| 46 | /* |
||
| 47 | * Are they asking for all data? |
||
| 48 | * |
||
| 49 | * Loop through heartbeat data and organize by priority. |
||
| 50 | */ |
||
| 51 | $all_data = ( isset( $args[0] ) && 'full' == $args[0] ) ? 'full' : false; |
||
| 52 | if ( $all_data ) { |
||
|
|
|||
| 53 | WP_CLI::success( __( 'Jetpack is currently connected to WordPress.com', 'jetpack' ) ); |
||
| 54 | WP_CLI::line( sprintf( __( "The Jetpack Version is %s", 'jetpack' ), JETPACK__VERSION ) ); |
||
| 55 | WP_CLI::line( sprintf( __( "The WordPress.com blog_id is %d", 'jetpack' ), Jetpack_Options::get_option( 'id' ) ) ); |
||
| 56 | WP_CLI::line( sprintf( __( 'The WordPress.com account for the primary connection is %s', 'jetpack' ), $master_user_email ) ); |
||
| 57 | |||
| 58 | // Heartbeat data |
||
| 59 | WP_CLI::line( "\n" . __( 'Additional data: ', 'jetpack' ) ); |
||
| 60 | |||
| 61 | // Get the filtered heartbeat data. |
||
| 62 | // Filtered so we can color/list by severity |
||
| 63 | $stats = Jetpack::jetpack_check_heartbeat_data(); |
||
| 64 | |||
| 65 | // Display red flags first |
||
| 66 | foreach ( $stats['bad'] as $stat => $value ) { |
||
| 67 | printf( "$this->red_open%-'.16s %s $this->color_close\n", $stat, $value ); |
||
| 68 | } |
||
| 69 | |||
| 70 | // Display caution warnings next |
||
| 71 | foreach ( $stats['caution'] as $stat => $value ) { |
||
| 72 | printf( "$this->yellow_open%-'.16s %s $this->color_close\n", $stat, $value ); |
||
| 73 | } |
||
| 74 | |||
| 75 | // The rest of the results are good! |
||
| 76 | foreach ( $stats['good'] as $stat => $value ) { |
||
| 77 | |||
| 78 | // Modules should get special spacing for aestetics |
||
| 79 | if ( strpos( $stat, 'odule-' ) ) { |
||
| 80 | printf( "%-'.30s %s\n", $stat, $value ); |
||
| 81 | usleep( 4000 ); // For dramatic effect lolz |
||
| 82 | continue; |
||
| 83 | } |
||
| 84 | printf( "%-'.16s %s\n", $stat, $value ); |
||
| 85 | usleep( 4000 ); // For dramatic effect lolz |
||
| 86 | } |
||
| 87 | } else { |
||
| 88 | // Just the basics |
||
| 89 | WP_CLI::success( __( 'Jetpack is currently connected to WordPress.com', 'jetpack' ) ); |
||
| 90 | WP_CLI::line( sprintf( __( 'The Jetpack Version is %s', 'jetpack' ), JETPACK__VERSION ) ); |
||
| 91 | WP_CLI::line( sprintf( __( 'The WordPress.com blog_id is %d', 'jetpack' ), Jetpack_Options::get_option( 'id' ) ) ); |
||
| 92 | WP_CLI::line( sprintf( __( 'The WordPress.com account for the primary connection is %s', 'jetpack' ), $master_user_email ) ); |
||
| 93 | WP_CLI::line( "\n" . _x( "View full status with 'wp jetpack status full'", '"wp jetpack status full" is a command - do not translate', 'jetpack' ) ); |
||
| 94 | } |
||
| 95 | } |
||
| 96 | |||
| 97 | /** |
||
| 98 | * Tests the active connection |
||
| 99 | * |
||
| 100 | * 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. |
||
| 101 | * |
||
| 102 | * ## EXAMPLES |
||
| 103 | * |
||
| 104 | * wp jetpack test-connection |
||
| 105 | * |
||
| 106 | * @subcommand test-connection |
||
| 107 | */ |
||
| 108 | public function test_connection( $args, $assoc_args ) { |
||
| 141 | |||
| 142 | /** |
||
| 143 | * Disconnect Jetpack Blogs or Users |
||
| 144 | * |
||
| 145 | * ## OPTIONS |
||
| 146 | * |
||
| 147 | * blog: Disconnect the entire blog. |
||
| 148 | * |
||
| 149 | * user <user_identifier>: Disconnect a specific user from WordPress.com. |
||
| 150 | * |
||
| 151 | * Please note, the primary account that the blog is connected |
||
| 152 | * to WordPress.com with cannot be disconnected without |
||
| 153 | * disconnecting the entire blog. |
||
| 154 | * |
||
| 155 | * ## EXAMPLES |
||
| 156 | * |
||
| 157 | * wp jetpack disconnect blog |
||
| 158 | * wp jetpack disconnect user 13 |
||
| 159 | * wp jetpack disconnect user username |
||
| 160 | * wp jetpack disconnect user [email protected] |
||
| 161 | * |
||
| 162 | * @synopsis <blog|user> [<user_identifier>] |
||
| 163 | */ |
||
| 164 | public function disconnect( $args, $assoc_args ) { |
||
| 219 | |||
| 220 | /** |
||
| 221 | * Reset Jetpack options and settings to default |
||
| 222 | * |
||
| 223 | * ## OPTIONS |
||
| 224 | * |
||
| 225 | * modules: Resets modules to default state ( get_default_modules() ) |
||
| 226 | * |
||
| 227 | * options: Resets all Jetpack options except: |
||
| 228 | * - All private options (Blog token, user token, etc...) |
||
| 229 | * - id (The Client ID/WP.com Blog ID of this site) |
||
| 230 | * - master_user |
||
| 231 | * - version |
||
| 232 | * - activated |
||
| 233 | * |
||
| 234 | * ## EXAMPLES |
||
| 235 | * |
||
| 236 | * wp jetpack reset options |
||
| 237 | * wp jetpack reset modules |
||
| 238 | * |
||
| 239 | * @synopsis <modules|options> |
||
| 240 | */ |
||
| 241 | public function reset( $args, $assoc_args ) { |
||
| 299 | |||
| 300 | /** |
||
| 301 | * Manage Jetpack Modules |
||
| 302 | * |
||
| 303 | * ## OPTIONS |
||
| 304 | * |
||
| 305 | * list : View all available modules, and their status. |
||
| 306 | * activate all : Activate all modules |
||
| 307 | * deactivate all: Deactivate all modules |
||
| 308 | * |
||
| 309 | * activate <module_slug> : Activate a module. |
||
| 310 | * deactivate <module_slug> : Deactivate a module. |
||
| 311 | * toggle <module_slug> : Toggle a module on or off. |
||
| 312 | * |
||
| 313 | * ## EXAMPLES |
||
| 314 | * |
||
| 315 | * wp jetpack module list |
||
| 316 | * wp jetpack module activate stats |
||
| 317 | * wp jetpack module deactivate stats |
||
| 318 | * wp jetpack module toggle stats |
||
| 319 | * |
||
| 320 | * wp jetpack module activate all |
||
| 321 | * wp jetpack module deactivate all |
||
| 322 | * |
||
| 323 | * @synopsis <list|activate|deactivate|toggle> [<module_name>] |
||
| 324 | */ |
||
| 325 | public function module( $args, $assoc_args ) { |
||
| 388 | |||
| 389 | /** |
||
| 390 | * Manage Protect Settings |
||
| 391 | * |
||
| 392 | * ## OPTIONS |
||
| 393 | * |
||
| 394 | * whitelist: Whitelist an IP address. You can also read or clear the whitelist. |
||
| 395 | * |
||
| 396 | * |
||
| 397 | * ## EXAMPLES |
||
| 398 | * |
||
| 399 | * wp jetpack protect whitelist <ip address> |
||
| 400 | * wp jetpack protect whitelist list |
||
| 401 | * wp jetpack protect whitelist clear |
||
| 402 | * |
||
| 403 | * @synopsis <whitelist> [<ip|ip_low-ip_high|list|clear>] |
||
| 404 | */ |
||
| 405 | public function protect( $args, $assoc_args ) { |
||
| 509 | |||
| 510 | /** |
||
| 511 | * Manage Jetpack Options |
||
| 512 | * |
||
| 513 | * ## OPTIONS |
||
| 514 | * |
||
| 515 | * list : List all jetpack options and their values |
||
| 516 | * delete : Delete an option |
||
| 517 | * - can only delete options that are white listed. |
||
| 518 | * update : update an option |
||
| 519 | * - can only update option strings |
||
| 520 | * get : get the value of an option |
||
| 521 | * |
||
| 522 | * ## EXAMPLES |
||
| 523 | * |
||
| 524 | * wp jetpack options list |
||
| 525 | * wp jetpack options get <option_name> |
||
| 526 | * wp jetpack options delete <option_name> |
||
| 527 | * wp jetpack options update <option_name> [<option_value>] |
||
| 528 | * |
||
| 529 | * @synopsis <list|get|delete|update> [<option_name>] [<option_value>] |
||
| 530 | */ |
||
| 531 | public function options( $args, $assoc_args ) { |
||
| 532 | $action = isset( $args[0] ) ? $args[0] : 'list'; |
||
| 533 | $safe_to_modify = Jetpack_Options::get_options_for_reset(); |
||
| 534 | |||
| 535 | // Jumpstart is special |
||
| 536 | array_push( $safe_to_modify, 'jumpstart' ); |
||
| 537 | |||
| 538 | // Is the option flagged as unsafe? |
||
| 539 | $flagged = ! in_array( $args[1], $safe_to_modify ); |
||
| 540 | |||
| 541 | View Code Duplication | if ( ! in_array( $action, array( 'list', 'get', 'delete', 'update' ) ) ) { |
|
| 542 | /* translators: %s is a command like "prompt" */ |
||
| 543 | WP_CLI::error( sprintf( __( '%s is not a valid command.', 'jetpack' ), $action ) ); |
||
| 544 | } |
||
| 545 | |||
| 546 | if ( isset( $args[0] ) ) { |
||
| 547 | if ( 'get' == $args[0] && isset( $args[1] ) ) { |
||
| 548 | $action = 'get'; |
||
| 549 | } else if ( 'delete' == $args[0] && isset( $args[1] ) ) { |
||
| 550 | $action = 'delete'; |
||
| 551 | View Code Duplication | } else if ( 'update' == $args[0] && isset( $args[1] ) ) { |
|
| 552 | $action = 'update'; |
||
| 553 | } else { |
||
| 554 | $action = 'list'; |
||
| 555 | } |
||
| 556 | } |
||
| 557 | |||
| 558 | // Bail if the option isn't found |
||
| 559 | $option = isset( $args[1] ) ? Jetpack_Options::get_option( $args[1] ) : false; |
||
| 560 | View Code Duplication | if ( isset( $args[1] ) && ! $option && 'update' !== $args[0] ) { |
|
| 561 | WP_CLI::error( __( 'Option not found or is empty. Use "list" to list option names', 'jetpack' ) ); |
||
| 562 | } |
||
| 563 | |||
| 564 | // Let's print_r the option if it's an array |
||
| 565 | // Used in the 'get' and 'list' actions |
||
| 566 | $option = is_array( $option ) ? print_r( $option ) : $option; |
||
| 567 | |||
| 568 | switch ( $action ) { |
||
| 569 | case 'get': |
||
| 570 | WP_CLI::success( "\t" . $option ); |
||
| 571 | break; |
||
| 572 | case 'delete': |
||
| 573 | jetpack_cli_are_you_sure( $flagged ); |
||
| 574 | |||
| 575 | Jetpack_Options::delete_option( $args[1] ); |
||
| 576 | WP_CLI::success( sprintf( __( 'Deleted option: %s', 'jetpack' ), $args[1] ) ); |
||
| 577 | break; |
||
| 578 | case 'update': |
||
| 579 | jetpack_cli_are_you_sure( $flagged ); |
||
| 580 | |||
| 581 | // Updating arrays would get pretty tricky... |
||
| 582 | $value = Jetpack_Options::get_option( $args[1] ); |
||
| 583 | if ( $value && is_array( $value ) ) { |
||
| 584 | WP_CLI::error( __( 'Sorry, no updating arrays at this time', 'jetpack' ) ); |
||
| 585 | } |
||
| 586 | |||
| 587 | Jetpack_Options::update_option( $args[1], $args[2] ); |
||
| 588 | WP_CLI::success( sprintf( _x( 'Updated option: %s to "%s"', 'Updating an option from "this" to "that".', 'jetpack' ), $args[1], $args[2] ) ); |
||
| 589 | break; |
||
| 590 | case 'list': |
||
| 591 | $options_compact = Jetpack_Options::get_option_names(); |
||
| 592 | $options_non_compact = Jetpack_Options::get_option_names( 'non_compact' ); |
||
| 593 | $options_private = Jetpack_Options::get_option_names( 'private' ); |
||
| 594 | $options = array_merge( $options_compact, $options_non_compact, $options_private ); |
||
| 595 | |||
| 596 | // Table headers |
||
| 597 | WP_CLI::line( "\t" . str_pad( __( 'Option', 'jetpack' ), 30 ) . __( 'Value', 'jetpack' ) ); |
||
| 598 | |||
| 599 | // List out the options and their values |
||
| 600 | // Tell them if the value is empty or not |
||
| 601 | // Tell them if it's an array |
||
| 602 | foreach ( $options as $option ) { |
||
| 603 | $value = Jetpack_Options::get_option( $option ); |
||
| 604 | if ( ! $value ) { |
||
| 605 | WP_CLI::line( "\t" . str_pad( $option, 30 ) . 'Empty' ); |
||
| 606 | continue; |
||
| 607 | } |
||
| 608 | |||
| 609 | if ( ! is_array( $value ) ) { |
||
| 610 | WP_CLI::line( "\t" . str_pad( $option, 30 ) . $value ); |
||
| 611 | } else if ( is_array( $value ) ) { |
||
| 612 | WP_CLI::line( "\t" . str_pad( $option, 30 ) . 'Array - Use "get <option>" to read option array.' ); |
||
| 613 | } |
||
| 614 | } |
||
| 615 | $option_text = '{' . _x( 'option', 'a variable command that a user can write, provided in the printed instructions', 'jetpack' ) . '}'; |
||
| 616 | $value_text = '{' . _x( 'value', 'the value that they want to update the option to', 'jetpack' ) . '}'; |
||
| 617 | |||
| 618 | WP_CLI::success( |
||
| 619 | _x( "Above are your options. You may 'get', 'delete', and 'update' them.", "'get', 'delete', and 'update' are commands - do not translate.", 'jetpack' ) . "\n" . |
||
| 620 | str_pad( 'wp jetpack options get', 26 ) . $option_text . "\n" . |
||
| 621 | str_pad( 'wp jetpack options delete', 26 ) . $option_text . "\n" . |
||
| 622 | str_pad( 'wp jetpack options update', 26 ) . "$option_text $value_text" . "\n" . |
||
| 623 | _x( "Type 'wp jetpack options' for more info.", "'wp jetpack options' is a command - do not translate.", 'jetpack' ) . "\n" |
||
| 624 | ); |
||
| 625 | break; |
||
| 626 | } |
||
| 627 | } |
||
| 628 | |||
| 629 | /** |
||
| 630 | * Get the status of or start a new Jetpack sync. |
||
| 631 | * |
||
| 632 | * ## OPTIONS |
||
| 633 | * |
||
| 634 | * status : Print the current sync status |
||
| 635 | * start : Start a full sync from this site to WordPress.com |
||
| 636 | * |
||
| 637 | * ## EXAMPLES |
||
| 638 | * |
||
| 639 | * wp jetpack sync status |
||
| 640 | * wp jetpack sync start --modules=functions --sync_wait_time=5 |
||
| 641 | * |
||
| 642 | * @synopsis <status|start> [--<field>=<value>] |
||
| 643 | */ |
||
| 644 | public function sync( $args, $assoc_args ) { |
||
| 753 | |||
| 754 | /** |
||
| 755 | * List the contents of a specific Jetpack sync queue. |
||
| 756 | * |
||
| 757 | * ## OPTIONS |
||
| 758 | * |
||
| 759 | * peek : List the 100 front-most items on the queue. |
||
| 760 | * |
||
| 761 | * ## EXAMPLES |
||
| 762 | * |
||
| 763 | * wp jetpack sync_queue full_sync peek |
||
| 764 | * |
||
| 765 | * @synopsis <incremental|full_sync> <peek> |
||
| 766 | */ |
||
| 767 | public function sync_queue( $args, $assoc_args ) { |
||
| 818 | |||
| 819 | /** |
||
| 820 | * Cancel's the current Jetpack plan granted by this partner, if applicable |
||
| 821 | * |
||
| 822 | * Returns success or error JSON |
||
| 823 | * |
||
| 824 | * <token_json> |
||
| 825 | * : JSON blob of WPCOM API token |
||
| 826 | * [--partner-tracking-id=<partner_tracking_id>] |
||
| 827 | * : This is an optional ID that a host can pass to help identify a site in logs on WordPress.com |
||
| 828 | * |
||
| 829 | * * @synopsis <token_json> [--partner-tracking-id=<partner_tracking_id>] |
||
| 830 | */ |
||
| 831 | public function partner_cancel( $args, $named_args ) { |
||
| 876 | |||
| 877 | /** |
||
| 878 | * Provision a site using a Jetpack Partner license |
||
| 879 | * |
||
| 880 | * Returns JSON blob |
||
| 881 | * |
||
| 882 | * ## OPTIONS |
||
| 883 | * |
||
| 884 | * <token_json> |
||
| 885 | * : JSON blob of WPCOM API token |
||
| 886 | * [--plan=<plan_name>] |
||
| 887 | * : Slug of the requested plan, e.g. premium |
||
| 888 | * [--wpcom_user_id=<user_id>] |
||
| 889 | * : WordPress.com ID of user to connect as (must be whitelisted against partner key) |
||
| 890 | * [--wpcom_user_email=<wpcom_user_email>] |
||
| 891 | * : Override the email we send to WordPress.com for registration |
||
| 892 | * [--onboarding=<onboarding>] |
||
| 893 | * : Guide the user through an onboarding wizard |
||
| 894 | * [--force_register=<register>] |
||
| 895 | * : Whether to force a site to register |
||
| 896 | * [--force_connect=<force_connect>] |
||
| 897 | * : Force JPS to not reuse existing credentials |
||
| 898 | * [--home_url=<home_url>] |
||
| 899 | * : Overrides the home option via the home_url filter, or the WP_HOME constant |
||
| 900 | * [--site_url=<site_url>] |
||
| 901 | * : Overrides the siteurl option via the site_url filter, or the WP_SITEURL constant |
||
| 902 | * [--partner-tracking-id=<partner_tracking_id>] |
||
| 903 | * : This is an optional ID that a host can pass to help identify a site in logs on WordPress.com |
||
| 904 | * |
||
| 905 | * ## EXAMPLES |
||
| 906 | * |
||
| 907 | * $ wp jetpack partner_provision '{ some: "json" }' premium 1 |
||
| 908 | * { success: true } |
||
| 909 | * |
||
| 910 | * @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>] |
||
| 911 | */ |
||
| 912 | public function partner_provision( $args, $named_args ) { |
||
| 945 | |||
| 946 | /** |
||
| 947 | * Manages your Jetpack sitemap |
||
| 948 | * |
||
| 949 | * ## OPTIONS |
||
| 950 | * |
||
| 951 | * rebuild : Rebuild all sitemaps |
||
| 952 | * --purge : if set, will remove all existing sitemap data before rebuilding |
||
| 953 | * |
||
| 954 | * ## EXAMPLES |
||
| 955 | * |
||
| 956 | * wp jetpack sitemap rebuild |
||
| 957 | * |
||
| 958 | * @subcommand sitemap |
||
| 959 | * @synopsis <rebuild> [--purge] |
||
| 960 | */ |
||
| 961 | public function sitemap( $args, $assoc_args ) { |
||
| 980 | |||
| 981 | private function get_api_host() { |
||
| 985 | |||
| 986 | private function partner_provision_error( $error ) { |
||
| 994 | } |
||
| 995 | |||
| 1032 |
Loading history...
In PHP, under loose comparison (like
==, or!=, orswitchconditions), values of different types might be equal.For
stringvalues, the empty string''is a special case, in particular the following results might be unexpected: