Complex classes like Jetpack_Client_Server 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_Client_Server, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 7 | class Jetpack_Client_Server { |
||
| 8 | |||
| 9 | /** |
||
| 10 | * Authorizations |
||
| 11 | */ |
||
| 12 | function client_authorize() { |
||
| 13 | $data = stripslashes_deep( $_GET ); |
||
| 14 | $data['auth_type'] = 'client'; |
||
| 15 | $role = Jetpack::translate_current_user_to_role(); |
||
| 16 | $redirect = isset( $data['redirect'] ) ? esc_url_raw( (string) $data['redirect'] ) : ''; |
||
| 17 | |||
| 18 | $this->check_admin_referer( "jetpack-authorize_{$role}_{$redirect}" ); |
||
| 19 | |||
| 20 | $result = $this->authorize( $data ); |
||
| 21 | if ( is_wp_error( $result ) ) { |
||
| 22 | Jetpack::state( 'error', $result->get_error_code() ); |
||
| 23 | } |
||
| 24 | |||
| 25 | if ( wp_validate_redirect( $redirect ) ) { |
||
| 26 | $this->wp_safe_redirect( $redirect ); |
||
| 27 | } else { |
||
| 28 | $this->wp_safe_redirect( Jetpack::admin_url() ); |
||
| 29 | } |
||
| 30 | |||
| 31 | /** |
||
| 32 | * Fires after the Jetpack client is authorized to communicate with WordPress.com. |
||
| 33 | * |
||
| 34 | * @since 4.2.0 |
||
| 35 | * |
||
| 36 | * @param int Jetpack Blog ID. |
||
| 37 | */ |
||
| 38 | do_action( 'jetpack_client_authorized', Jetpack_Options::get_option( 'id' ) ); |
||
| 39 | |||
| 40 | $this->do_exit(); |
||
| 41 | } |
||
| 42 | |||
| 43 | function authorize( $data = array() ) { |
||
| 44 | $redirect = isset( $data['redirect'] ) ? esc_url_raw( (string) $data['redirect'] ) : ''; |
||
|
|
|||
| 45 | |||
| 46 | $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ); |
||
| 47 | // Checking if site has been active/connected previously before recording unique connection |
||
| 48 | if ( ! $jetpack_unique_connection ) { |
||
| 49 | // jetpack_unique_connection option has never been set |
||
| 50 | $jetpack_unique_connection = array( |
||
| 51 | 'connected' => 0, |
||
| 52 | 'disconnected' => 0, |
||
| 53 | 'version' => '3.6.1', |
||
| 54 | ); |
||
| 55 | |||
| 56 | update_option( 'jetpack_unique_connection', $jetpack_unique_connection ); |
||
| 57 | |||
| 58 | //track unique connection |
||
| 59 | $jetpack = $this->get_jetpack();; |
||
| 60 | |||
| 61 | $jetpack->stat( 'connections', 'unique-connection' ); |
||
| 62 | $jetpack->do_stats( 'server_side' ); |
||
| 63 | } |
||
| 64 | |||
| 65 | // increment number of times connected |
||
| 66 | $jetpack_unique_connection['connected'] += 1; |
||
| 67 | Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection ); |
||
| 68 | |||
| 69 | $role = Jetpack::translate_current_user_to_role(); |
||
| 70 | |||
| 71 | if ( ! $role ) { |
||
| 72 | return new Jetpack_Error( 'no_role', 'Invalid request.', 400 ); |
||
| 73 | } |
||
| 74 | |||
| 75 | $cap = Jetpack::translate_role_to_cap( $role ); |
||
| 76 | if ( ! $cap ) { |
||
| 77 | return new Jetpack_Error( 'no_cap', 'Invalid request.', 400 ); |
||
| 78 | } |
||
| 79 | |||
| 80 | if ( ! empty( $data['error'] ) ) { |
||
| 81 | return new Jetpack_Error( $data['error'], 'Error included in the request.', 400 ); |
||
| 82 | } |
||
| 83 | |||
| 84 | if ( ! isset( $data['state'] ) ) { |
||
| 85 | return new Jetpack_Error( 'no_state', 'Request must include state.', 400 ); |
||
| 86 | } |
||
| 87 | |||
| 88 | if ( ! ctype_digit( $data['state'] ) ) { |
||
| 89 | return new Jetpack_Error( $data['error'], 'State must be an integer.', 400 ); |
||
| 90 | } |
||
| 91 | |||
| 92 | $current_user_id = get_current_user_id(); |
||
| 93 | if ( $current_user_id != $data['state'] ) { |
||
| 94 | return new Jetpack_Error( 'wrong_state', 'State does not match current user.', 400 ); |
||
| 95 | } |
||
| 96 | |||
| 97 | if ( empty( $data['code'] ) ) { |
||
| 98 | return new Jetpack_Error( 'no_code', 'Request must include an authorization code.', 400 ); |
||
| 99 | } |
||
| 100 | |||
| 101 | $token = $this->get_token( $data ); |
||
| 102 | |||
| 103 | if ( is_wp_error( $token ) ) { |
||
| 104 | $code = $token->get_error_code(); |
||
| 105 | if ( empty( $code ) ) { |
||
| 106 | $code = 'invalid_token'; |
||
| 107 | } |
||
| 108 | return new Jetpack_Error( $code, $token->get_error_message(), 400 ); |
||
| 109 | } |
||
| 110 | |||
| 111 | if ( ! $token ) { |
||
| 112 | return new Jetpack_Error( 'no_token', 'Error generating token.', 400 ); |
||
| 113 | } |
||
| 114 | |||
| 115 | $is_master_user = ! Jetpack::is_active(); |
||
| 116 | |||
| 117 | Jetpack::update_user_token( $current_user_id, sprintf( '%s.%d', $token, $current_user_id ), $is_master_user ); |
||
| 118 | |||
| 119 | if ( ! $is_master_user ) { |
||
| 120 | Jetpack::state( 'message', 'linked' ); |
||
| 121 | // Don't activate anything since we are just connecting a user. |
||
| 122 | return 'linked'; |
||
| 123 | } |
||
| 124 | |||
| 125 | $redirect_on_activation_error = ( 'client' === $data['auth_type'] ) ? true : false; |
||
| 126 | if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) { |
||
| 127 | Jetpack::delete_active_modules(); |
||
| 128 | |||
| 129 | Jetpack::activate_default_modules( 999, 1, $active_modules, $redirect_on_activation_error ); |
||
| 130 | } else { |
||
| 131 | Jetpack::activate_default_modules( false, false, array(), $redirect_on_activation_error ); |
||
| 132 | } |
||
| 133 | |||
| 134 | // Start nonce cleaner |
||
| 135 | wp_clear_scheduled_hook( 'jetpack_clean_nonces' ); |
||
| 136 | wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' ); |
||
| 137 | |||
| 138 | Jetpack::state( 'message', 'authorized' ); |
||
| 139 | return 'authorized'; |
||
| 140 | } |
||
| 141 | |||
| 142 | public static function deactivate_plugin( $probable_file, $probable_title ) { |
||
| 161 | |||
| 162 | /** |
||
| 163 | * @return object|WP_Error |
||
| 164 | */ |
||
| 165 | function get_token( $data ) { |
||
| 166 | $role = Jetpack::translate_current_user_to_role(); |
||
| 167 | |||
| 168 | if ( ! $role ) { |
||
| 169 | return new Jetpack_Error( 'role', __( 'An administrator for this blog must set up the Jetpack connection.', 'jetpack' ) ); |
||
| 170 | } |
||
| 171 | |||
| 172 | $client_secret = Jetpack_Data::get_access_token(); |
||
| 173 | if ( ! $client_secret ) { |
||
| 174 | return new Jetpack_Error( 'client_secret', __( 'You need to register your Jetpack before connecting it.', 'jetpack' ) ); |
||
| 175 | } |
||
| 176 | |||
| 177 | $redirect = isset( $data['redirect'] ) ? esc_url_raw( (string) $data['redirect'] ) : ''; |
||
| 178 | $redirect_uri = ( 'calypso' === $data['auth_type'] ) |
||
| 179 | ? $data['redirect_uri'] |
||
| 180 | : add_query_arg( array( |
||
| 181 | 'action' => 'authorize', |
||
| 182 | '_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ), |
||
| 183 | 'redirect' => $redirect ? urlencode( $redirect ) : false, |
||
| 184 | ), menu_page_url( 'jetpack', false ) ); |
||
| 185 | |||
| 186 | $body = array( |
||
| 187 | 'client_id' => Jetpack_Options::get_option( 'id' ), |
||
| 188 | 'client_secret' => $client_secret->secret, |
||
| 189 | 'grant_type' => 'authorization_code', |
||
| 190 | 'code' => $data['code'], |
||
| 191 | 'redirect_uri' => $redirect_uri, |
||
| 192 | ); |
||
| 193 | |||
| 194 | $args = array( |
||
| 195 | 'method' => 'POST', |
||
| 196 | 'body' => $body, |
||
| 197 | 'headers' => array( |
||
| 198 | 'Accept' => 'application/json', |
||
| 199 | ), |
||
| 200 | ); |
||
| 201 | $response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'token' ) ), $args ); |
||
| 202 | |||
| 203 | if ( is_wp_error( $response ) ) { |
||
| 204 | return new Jetpack_Error( 'token_http_request_failed', $response->get_error_message() ); |
||
| 205 | } |
||
| 206 | |||
| 207 | $code = wp_remote_retrieve_response_code( $response ); |
||
| 208 | $entity = wp_remote_retrieve_body( $response ); |
||
| 209 | |||
| 210 | if ( $entity ) { |
||
| 211 | $json = json_decode( $entity ); |
||
| 212 | } else { |
||
| 213 | $json = false; |
||
| 214 | } |
||
| 215 | |||
| 216 | if ( 200 != $code || ! empty( $json->error ) ) { |
||
| 217 | if ( empty( $json->error ) ) { |
||
| 218 | return new Jetpack_Error( 'unknown', '', $code ); |
||
| 219 | } |
||
| 220 | |||
| 221 | $error_description = isset( $json->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $json->error_description ) : ''; |
||
| 222 | |||
| 223 | return new Jetpack_Error( (string) $json->error, $error_description, $code ); |
||
| 224 | } |
||
| 225 | |||
| 226 | if ( empty( $json->access_token ) || ! is_scalar( $json->access_token ) ) { |
||
| 227 | return new Jetpack_Error( 'access_token', '', $code ); |
||
| 228 | } |
||
| 229 | |||
| 230 | if ( empty( $json->token_type ) || 'X_JETPACK' != strtoupper( $json->token_type ) ) { |
||
| 231 | return new Jetpack_Error( 'token_type', '', $code ); |
||
| 232 | } |
||
| 233 | |||
| 234 | if ( empty( $json->scope ) ) { |
||
| 235 | return new Jetpack_Error( 'scope', 'No Scope', $code ); |
||
| 236 | } |
||
| 237 | |||
| 238 | @list( $role, $hmac ) = explode( ':', $json->scope ); |
||
| 239 | if ( empty( $role ) || empty( $hmac ) ) { |
||
| 240 | return new Jetpack_Error( 'scope', 'Malformed Scope', $code ); |
||
| 241 | } |
||
| 242 | |||
| 243 | if ( Jetpack::sign_role( $role ) !== $json->scope ) { |
||
| 244 | return new Jetpack_Error( 'scope', 'Invalid Scope', $code ); |
||
| 245 | } |
||
| 246 | |||
| 247 | if ( ! $cap = Jetpack::translate_role_to_cap( $role ) ) { |
||
| 248 | return new Jetpack_Error( 'scope', 'No Cap', $code ); |
||
| 249 | } |
||
| 250 | |||
| 251 | if ( ! current_user_can( $cap ) ) { |
||
| 252 | return new Jetpack_Error( 'scope', 'current_user_cannot', $code ); |
||
| 253 | } |
||
| 254 | |||
| 255 | /** |
||
| 256 | * Fires after user has successfully received an auth token. |
||
| 257 | * |
||
| 258 | * @since 3.9.0 |
||
| 259 | */ |
||
| 260 | do_action( 'jetpack_user_authorized' ); |
||
| 261 | |||
| 262 | return (string) $json->access_token; |
||
| 263 | } |
||
| 264 | |||
| 265 | public function get_jetpack() { |
||
| 268 | |||
| 269 | public function check_admin_referer( $action ) { |
||
| 272 | |||
| 273 | public function wp_safe_redirect( $redirect ) { |
||
| 276 | |||
| 277 | public function do_exit() { |
||
| 280 | } |
||
| 281 |
This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.
Both the
$myVarassignment in line 1 and the$higherassignment in line 2 are dead. The first because$myVaris never used and the second because$higheris always overwritten for every possible time line.