Context Navigation

← Previous Changeset
Next Changeset →

Changeset 2165

Timestamp:

12/05/2015 05:33:32 PM (11 years ago)

Author:

iandunn

Message:

WordCamp WP-CLI: Centralize WP-CLI commands for consistency and organization.

Location:

sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins

Files:

: 4 added
: 2 edited

wcorg-json-api.php (modified) (2 diffs)
wcorg-misc.php (modified) (2 diffs)
wp-cli-commands (added)
wp-cli-commands.php (added)
wp-cli-commands/rest-api.php (added)
wp-cli-commands/rewrite-rules.php (added)

Legend:

: Unmodified
: Added
: Removed

sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/wcorg-json-api.php

-              r1553
+              r2165
+ *
  * Before making any changes to this plugin or updating the JSON API to a new version, make sure you run the
  * automated tests -- wp wcorg-json-api verify-data-is-scrubbed -- in your sandbox, and then again on production
+ * automated tests -- wp wc-rest verify-data-is-scrubbed -- in your sandbox, and then again on production
  * after you deploy any updates.
+ *
 …
+}
 add_action( 'wp_json_server_before_serve', 'wcorg_json_avoid_nested_callback_conflicts', 11 );    // after the default endpoints are added in `json_api_default_filters()`
-/*
- * WP-CLI Commands
- */
-if ( defined( 'WP_CLI' ) && WP_CLI ) {
-        /**
-         * WordCamp.org JSON API
-         */
-        class WordCamp_JSON_API_Commands extends WP_CLI_Command {
-                /**
-                 * Verify that no sensitive data is being exposed via the API.
+                 *
-                 * @subcommand verify-data-is-scrubbed
-                 */
-                public function verify_data_is_scrubbed() {
-                        $errors          = false;
-                        $start_timestamp = microtime( true );
-                        // These calls are not formatted in a more compact way because we don't want to short-circuit any of them if one fails
-                        if ( $this->post_types_exposed() ) {
-                                $errors = true;
+                        }
-                        if ( $this->post_meta_exposed() ) {
-                                $errors = true;
+                        }
-                        WP_CLI::line();
-                        WP_CLI::line( sprintf( 'Tests completed in %s seconds', number_format( microtime( true ) - $start_timestamp, 3 ) ) );
-                        if ( $errors ) {
-                                WP_CLI::error( 'Not all sensitive data has been scrubbed.' );
-                        } else {
-                                WP_CLI::success( 'All of the tests passed. If the tests are comprehensive and working properly, then all sensitive data has been properly scrubbed.' );
+                        }
+                }
-                /**
-                 * Check if any sensitive post types are being exposed.
+                 *
-                 * See note in post_meta_exposed() about test data.
+                 *
-                 * @return bool
-                 */
-                protected function post_types_exposed() {
-                        $errors = false;
-                        WP_CLI::line();
-                        WP_CLI::line( 'Checking post types.' );
-                        // Check Central and a normal site, because they can have different types loaded
-                        $post_types_endpoints = array(
-                                'http://central.wordcamp.org/wp-json/posts/types',
-                                'http://europe.wordcamp.org/2014/wp-json/posts/types',
-                        );
-                        $whitelisted_post_types = array(
-                                'post', 'page', 'attachment', 'revision', 'wcb_speaker', 'wcb_session', 'wcb_sponsor', 'mes',
-                                'mes-sponsor-level', 'wordcamp'
-                        );
-                        foreach ( $post_types_endpoints as $request_url ) {
-                                $request_url = apply_filters( 'wcorg_json_api_verify_data_scrubbed_url', $request_url );    // Use this filter to override the URLs with corresponding endpoints on your sandbox
-                                $response    = json_decode( wp_remote_retrieve_body( wp_remote_get( $request_url ) ) );
-                                if ( empty( $response->post->slug ) ) {
-                                        $errors = true;
-                                        WP_CLI::warning( "Unable to retrieve post types from $request_url", false );
-                                        continue;
+                                }
-                                foreach ( $response as $post_type ) {
-                                        if ( in_array( $post_type->slug, $whitelisted_post_types ) ) {
-                                                WP_CLI::line( "{$post_type->slug} is whitelisted." );
-                                        } else {
-                                                $errors = true;
-                                                WP_CLI::warning( "{$post_type->slug} is being exposed at $request_url" );
+                                        }
+                                }
+                        }
-                        return $errors;
+                }
-                /**
-                 * Check if any sensitive post meta is being exposed.
+                 *
-                 * If this were a proper test we'd insert the data into a test db during setup rather than relying on the
-                 * existence of production data, but this is good enough for our current needs. Just make sure to double
-                 * check that the meta where checking still exists, otherwise the tests could result in a false-negative.
+                 *
-                 * @return bool
-                 */
-                protected function post_meta_exposed() {
-                        $errors = false;
-                        WP_CLI::line();
-                        WP_CLI::line( 'Checking post meta.' );
-                        // This is just a representative sample, not a complete list
-                        $sensitive_post_meta = array(
-                                'http://central.wordcamp.org/wp-json/posts/3038288'    => array( 'Email Address', 'Telephone', 'Mailing Address' ), // A wordcamp post on Central
-                                'http://central.wordcamp.org/wp-json/posts/2347409'    => array( 'mes_email_address' ),                             // A Multi-Event Sponsor post on Central
-                                'http://europe.wordcamp.org/2014/wp-json/posts/216283' => array( '_wcb_speaker_email' ),                            // A Speaker post on a camp site
-                        );
-                        foreach ( $sensitive_post_meta as $request_url => $sensitive_meta_keys ) {
-                                $request_url = apply_filters( 'wcorg_json_api_verify_data_scrubbed_url', $request_url );    // Use this filter to override the URLs with corresponding posts on your sandbox
-                                $response    = json_decode( wp_remote_retrieve_body( wp_remote_get( esc_url_raw( $request_url ) ) ) );
-                                if ( ! isset( $response->post_meta ) ) {
-                                        $errors = true;
-                                        WP_CLI::warning( "Unable to retrieve post meta from $request_url", false );
-                                        continue;
+                                }
-                                foreach ( $response->post_meta as $post_meta ) {
-                                        if ( in_array( $post_meta->key, $sensitive_meta_keys ) ) {
-                                                $errors = true;
-                                                WP_CLI::warning( "{$post_meta->key} is being exposed at $request_url" );
-                                        } else {
-                                                WP_CLI::line( "{$post_meta->key} is whitelisted." );
+                                        }
+                                }
+                        }
-                        return $errors;
+                }
+        }
-        WP_CLI::add_command( 'wcorg-json-api', 'WordCamp_JSON_API_Commands' );
+}

sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/wcorg-misc.php

-              r2079
+              r2165
  * Flush the rewrite rules on the current site.
+ *
  * See WordCamp_Miscellaneous_Commands::flush_rewrite_rules_everywhere() for an explanation.
+ * See WordCamp_CLI_Rewrite_Rules::flush() for an explanation.
+ *
  * Requires authentication because flush_rewrite_rules() is expensive and could be used as a DoS vector.
 …
 add_action( 'wp_ajax_wcorg_flush_rewrite_rules_everywhere',        'wcorg_flush_rewrite_rules' ); // This isn't used by the wp-cli command, but is useful for manual testing
 add_action( 'wp_ajax_nopriv_wcorg_flush_rewrite_rules_everywhere', 'wcorg_flush_rewrite_rules' );
-/*
- * WP-CLI Commands
- */
-if ( defined( 'WP_CLI' ) && WP_CLI ) {
-        /**
-         * WordCamp.org Miscellaneous Commands
-         */
-        class WordCamp_Miscellaneous_Commands extends WP_CLI_Command {
-                /**
-                 * Flush rewrite rules on all sites.
+                 *
-                 * Periodically they break for various reasons and need to be reset on all sites. If we
-                 * just called flush_rewrite_rules() inside a switch_to_blog() loop then each site's
-                 * plugins wouldn't be loaded and the rewrite rules wouldn't be correct.
+                 *
-                 * So instead, this issues an HTTP request to wcorg_flush_rewrite_rules() on each site so
-                 * that flush_rewrite_rules() will run in the context of the loaded site.
+                 *
-                 * @subcommand flush-rewrite-rules-everywhere
-                 */
-                public function flush_rewrite_rules_everywhere() {
-                        $start_timestamp = microtime( true );
-                        $error           = '';
-                        $sites           = wp_get_sites( array( 'limit' => false ) );
-                        WP_CLI::line();
-                        foreach ( $sites as $site ) {
-                                $ajax_url    = sprintf( 'http://%s%swp-admin/admin-ajax.php', $site['domain'], $site['path'] );
-                                $display_url = $site['domain'] . rtrim( $site['path'], '/' );
-                                $nonce       = wp_create_nonce( 'flush-rewrite-rules-everywhere-' . $site['blog_id'] );
-                                $response = wp_remote_get( esc_url_raw( add_query_arg(
-                                        array(
-                                                'action' => 'wcorg_flush_rewrite_rules_everywhere',
-                                                'nonce'  => $nonce,
-                                        ),
-                                        $ajax_url
-                                ) ) );
-                                if ( is_wp_error( $response ) ) {
-                                        $success = false;
-                                        $error   = $response->get_error_message();
-                                } else {
-                                        $response = json_decode( wp_remote_retrieve_body( $response ) );
-                                        if ( isset( $response->success ) && $response->success ) {
-                                                $success = true;
-                                        } else {
-                                                $success = false;
-                                                $error   = isset( $response->data ) ? $response->data : 'Unknown error';
+                                        }
+                                }
-                                if ( $success ) {
-                                        WP_CLI::line( sprintf( '%s: Flushed', $display_url ) );
-                                } else {
-                                        WP_CLI::warning( sprintf( '%s: Failed with error: %s', $display_url, $error     ) );
+                                }
+                        }
-                        $execution_time = microtime( true ) - $start_timestamp;
-                        WP_CLI::line();
-                        WP_CLI::line( sprintf(
-                                'Flushed all rewrite rules in %d minute(s) and %d second(s).',
-                                floor( $execution_time / 60 ),
-                                $execution_time % 60
-                        ) );
+                }
+        }
-        WP_CLI::add_command( 'wcorg-misc', 'WordCamp_Miscellaneous_Commands' );
+}

Note: See TracChangeset for help on using the changeset viewer.

Making WordPress.org

Context Navigation

Changeset 2165

Legend:

sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/wcorg-json-api.php

sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/wcorg-misc.php

Download in other formats: