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_SSO 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_SSO, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
18 | class Jetpack_SSO { |
||
19 | static $instance = null; |
||
|
|||
20 | |||
21 | private function __construct() { |
||
22 | |||
23 | self::$instance = $this; |
||
24 | |||
25 | add_action( 'admin_init', array( $this, 'maybe_authorize_user_after_sso' ), 1 ); |
||
26 | add_action( 'admin_init', array( $this, 'register_settings' ) ); |
||
27 | add_action( 'login_init', array( $this, 'login_init' ) ); |
||
28 | add_action( 'delete_user', array( $this, 'delete_connection_for_user' ) ); |
||
29 | add_filter( 'jetpack_xmlrpc_methods', array( $this, 'xmlrpc_methods' ) ); |
||
30 | add_action( 'init', array( $this, 'maybe_logout_user' ), 5 ); |
||
31 | add_action( 'jetpack_modules_loaded', array( $this, 'module_configure_button' ) ); |
||
32 | add_action( 'admin_enqueue_scripts', array( $this, 'admin_enqueue_scripts' ) ); |
||
33 | add_action( 'login_form_logout', array( $this, 'store_wpcom_profile_cookies_on_logout' ) ); |
||
34 | add_action( 'wp_login', array( 'Jetpack_SSO', 'clear_wpcom_profile_cookies' ) ); |
||
35 | add_action( 'jetpack_unlinked_user', array( $this, 'delete_connection_for_user') ); |
||
36 | |||
37 | // Adding this action so that on login_init, the action won't be sanitized out of the $action global. |
||
38 | add_action( 'login_form_jetpack-sso', '__return_true' ); |
||
39 | } |
||
40 | |||
41 | /** |
||
42 | * Returns the single instance of the Jetpack_SSO object |
||
43 | * |
||
44 | * @since 2.8 |
||
45 | * @return Jetpack_SSO |
||
46 | **/ |
||
47 | public static function get_instance() { |
||
48 | if ( ! is_null( self::$instance ) ) { |
||
49 | return self::$instance; |
||
50 | } |
||
51 | |||
52 | return self::$instance = new Jetpack_SSO; |
||
53 | } |
||
54 | |||
55 | /** |
||
56 | * Add configure button and functionality to the module card on the Jetpack screen |
||
57 | **/ |
||
58 | public static function module_configure_button() { |
||
59 | Jetpack::enable_module_configurable( __FILE__ ); |
||
60 | Jetpack::module_configuration_load( __FILE__, array( __CLASS__, 'module_configuration_load' ) ); |
||
61 | Jetpack::module_configuration_head( __FILE__, array( __CLASS__, 'module_configuration_head' ) ); |
||
62 | Jetpack::module_configuration_screen( __FILE__, array( __CLASS__, 'module_configuration_screen' ) ); |
||
63 | } |
||
64 | |||
65 | public static function module_configuration_load() {} |
||
66 | |||
67 | public static function module_configuration_head() {} |
||
68 | |||
69 | public static function module_configuration_screen() { |
||
70 | ?> |
||
71 | <form method="post" action="options.php"> |
||
72 | <?php settings_fields( 'jetpack-sso' ); ?> |
||
73 | <?php do_settings_sections( 'jetpack-sso' ); ?> |
||
74 | <?php submit_button(); ?> |
||
75 | </form> |
||
76 | <?php |
||
77 | } |
||
78 | |||
79 | |||
80 | /** |
||
81 | * When the default login form is hidden, this method is called on the 'authenticate' filter with a priority of 30. |
||
82 | * This method disables the ability to submit the default login form. |
||
83 | * |
||
84 | * @param $user |
||
85 | * |
||
86 | * @return WP_Error |
||
87 | */ |
||
88 | public function disable_default_login_form( $user ) { |
||
89 | if ( is_wp_error( $user ) ) { |
||
90 | return $user; |
||
91 | } |
||
92 | |||
93 | /** |
||
94 | * Since we're returning an error that will be shown as a red notice, let's remove the |
||
95 | * informational "blue" notice. |
||
96 | */ |
||
97 | remove_filter( 'login_message', array( $this, 'msg_login_by_jetpack' ) ); |
||
98 | return new WP_Error( 'jetpack_sso_required', $this->get_sso_required_message() ); |
||
99 | } |
||
100 | |||
101 | /** |
||
102 | * If jetpack_force_logout == 1 in current user meta the user will be forced |
||
103 | * to logout and reauthenticate with the site. |
||
104 | **/ |
||
105 | public function maybe_logout_user() { |
||
106 | global $current_user; |
||
107 | |||
108 | if ( 1 == $current_user->jetpack_force_logout ) { |
||
109 | delete_user_meta( $current_user->ID, 'jetpack_force_logout' ); |
||
110 | self::delete_connection_for_user( $current_user->ID ); |
||
111 | wp_logout(); |
||
112 | wp_safe_redirect( wp_login_url() ); |
||
113 | exit; |
||
114 | } |
||
115 | } |
||
116 | |||
117 | |||
118 | /** |
||
119 | * Adds additional methods the WordPress xmlrpc API for handling SSO specific features |
||
120 | * |
||
121 | * @param array $methods |
||
122 | * @return array |
||
123 | **/ |
||
124 | public function xmlrpc_methods( $methods ) { |
||
125 | $methods['jetpack.userDisconnect'] = array( $this, 'xmlrpc_user_disconnect' ); |
||
126 | return $methods; |
||
127 | } |
||
128 | |||
129 | /** |
||
130 | * Marks a user's profile for disconnect from WordPress.com and forces a logout |
||
131 | * the next time the user visits the site. |
||
132 | **/ |
||
133 | public function xmlrpc_user_disconnect( $user_id ) { |
||
134 | $user_query = new WP_User_Query( |
||
135 | array( |
||
136 | 'meta_key' => 'wpcom_user_id', |
||
137 | 'meta_value' => $user_id, |
||
138 | ) |
||
139 | ); |
||
140 | $user = $user_query->get_results(); |
||
141 | $user = $user[0]; |
||
142 | |||
143 | if ( $user instanceof WP_User ) { |
||
144 | $user = wp_set_current_user( $user->ID ); |
||
145 | update_user_meta( $user->ID, 'jetpack_force_logout', '1' ); |
||
146 | self::delete_connection_for_user( $user->ID ); |
||
147 | return true; |
||
148 | } |
||
149 | return false; |
||
150 | } |
||
151 | |||
152 | /** |
||
153 | * Enqueues scripts and styles necessary for SSO login. |
||
154 | */ |
||
155 | public function login_enqueue_scripts() { |
||
156 | global $action; |
||
157 | |||
158 | if ( ! in_array( $action, array( 'jetpack-sso', 'login' ) ) ) { |
||
159 | return; |
||
160 | } |
||
161 | |||
162 | if ( is_rtl() ) { |
||
163 | wp_enqueue_style( 'jetpack-sso-login', plugins_url( 'modules/sso/jetpack-sso-login-rtl.css', JETPACK__PLUGIN_FILE ), array( 'login', 'genericons' ), JETPACK__VERSION ); |
||
164 | } else { |
||
165 | wp_enqueue_style( 'jetpack-sso-login', plugins_url( 'modules/sso/jetpack-sso-login.css', JETPACK__PLUGIN_FILE ), array( 'login', 'genericons' ), JETPACK__VERSION ); |
||
166 | } |
||
167 | |||
168 | wp_enqueue_script( 'jetpack-sso-login', plugins_url( 'modules/sso/jetpack-sso-login.js', JETPACK__PLUGIN_FILE ), array( 'jquery' ), JETPACK__VERSION ); |
||
169 | } |
||
170 | |||
171 | /** |
||
172 | * Enqueue styles neceessary for Jetpack SSO on users' profiles |
||
173 | */ |
||
174 | public function admin_enqueue_scripts() { |
||
175 | $screen = get_current_screen(); |
||
176 | |||
177 | if ( empty( $screen ) || ! in_array( $screen->base, array( 'edit-user', 'profile' ) ) ) { |
||
178 | return; |
||
179 | } |
||
180 | |||
181 | wp_enqueue_style( 'jetpack-sso-profile', plugins_url( 'modules/sso/jetpack-sso-profile.css', JETPACK__PLUGIN_FILE ), array( 'genericons' ), JETPACK__VERSION ); |
||
182 | } |
||
183 | |||
184 | /** |
||
185 | * Adds Jetpack SSO classes to login body |
||
186 | * |
||
187 | * @param array $classes Array of classes to add to body tag |
||
188 | * @return array Array of classes to add to body tag |
||
189 | */ |
||
190 | public function login_body_class( $classes ) { |
||
191 | global $action; |
||
192 | |||
193 | if ( ! in_array( $action, array( 'jetpack-sso', 'login' ) ) ) { |
||
194 | return $classes; |
||
195 | } |
||
196 | |||
197 | // Always add the jetpack-sso class so that we can add SSO specific styling even when the SSO form isn't being displayed. |
||
198 | $classes[] = 'jetpack-sso'; |
||
199 | |||
200 | /** |
||
201 | * Should we show the SSO login form? |
||
202 | * |
||
203 | * $_GET['jetpack-sso-default-form'] is used to provide a fallback in case JavaScript is not enabled. |
||
204 | * |
||
205 | * The default_to_sso_login() method allows us to dynamically decide whether we show the SSO login form or not. |
||
206 | * The SSO module uses the method to display the default login form if we can not find a user to log in via SSO. |
||
207 | * But, the method could be filtered by a site admin to always show the default login form if that is preferred. |
||
208 | */ |
||
209 | if ( empty( $_GET['jetpack-sso-show-default-form'] ) && Jetpack_SSO_Helpers::show_sso_login() ) { |
||
210 | $classes[] = 'jetpack-sso-form-display'; |
||
211 | } |
||
212 | |||
213 | return $classes; |
||
214 | } |
||
215 | |||
216 | /** |
||
217 | * Adds settings fields to Settings > General > Single Sign On that allows users to |
||
218 | * turn off the login form on wp-login.php |
||
219 | * |
||
220 | * @since 2.7 |
||
221 | **/ |
||
222 | public function register_settings() { |
||
223 | |||
224 | add_settings_section( |
||
225 | 'jetpack_sso_settings', |
||
226 | __( 'Single Sign On' , 'jetpack' ), |
||
227 | '__return_false', |
||
228 | 'jetpack-sso' |
||
229 | ); |
||
230 | |||
231 | /* |
||
232 | * Settings > General > Single Sign On |
||
233 | * Require two step authentication |
||
234 | */ |
||
235 | register_setting( |
||
236 | 'jetpack-sso', |
||
237 | 'jetpack_sso_require_two_step', |
||
238 | array( $this, 'validate_jetpack_sso_require_two_step' ) |
||
239 | ); |
||
240 | |||
241 | add_settings_field( |
||
242 | 'jetpack_sso_require_two_step', |
||
243 | '', // __( 'Require Two-Step Authentication' , 'jetpack' ), |
||
244 | array( $this, 'render_require_two_step' ), |
||
245 | 'jetpack-sso', |
||
246 | 'jetpack_sso_settings' |
||
247 | ); |
||
248 | |||
249 | /* |
||
250 | * Settings > General > Single Sign On |
||
251 | */ |
||
252 | register_setting( |
||
253 | 'jetpack-sso', |
||
254 | 'jetpack_sso_match_by_email', |
||
255 | array( $this, 'validate_jetpack_sso_match_by_email' ) |
||
256 | ); |
||
257 | |||
258 | add_settings_field( |
||
259 | 'jetpack_sso_match_by_email', |
||
260 | '', // __( 'Match by Email' , 'jetpack' ), |
||
261 | array( $this, 'render_match_by_email' ), |
||
262 | 'jetpack-sso', |
||
263 | 'jetpack_sso_settings' |
||
264 | ); |
||
265 | } |
||
266 | |||
267 | /** |
||
268 | * Builds the display for the checkbox allowing user to require two step |
||
269 | * auth be enabled on WordPress.com accounts before login. Displays in Settings > General |
||
270 | * |
||
271 | * @since 2.7 |
||
272 | **/ |
||
273 | public function render_require_two_step() { |
||
274 | ?> |
||
275 | <label> |
||
276 | <input |
||
277 | type="checkbox" |
||
278 | name="jetpack_sso_require_two_step" |
||
279 | <?php checked( Jetpack_SSO_Helpers::is_two_step_required() ); ?> |
||
280 | <?php disabled( Jetpack_SSO_Helpers::is_require_two_step_checkbox_disabled() ); ?> |
||
281 | > |
||
282 | <?php esc_html_e( 'Require Two-Step Authentication' , 'jetpack' ); ?> |
||
283 | </label> |
||
284 | <?php |
||
285 | } |
||
286 | |||
287 | /** |
||
288 | * Validate the require two step checkbox in Settings > General |
||
289 | * |
||
290 | * @since 2.7 |
||
291 | * @return boolean |
||
292 | **/ |
||
293 | public function validate_jetpack_sso_require_two_step( $input ) { |
||
294 | return ( ! empty( $input ) ) ? 1 : 0; |
||
295 | } |
||
296 | |||
297 | /** |
||
298 | * Builds the display for the checkbox allowing the user to allow matching logins by email |
||
299 | * Displays in Settings > General |
||
300 | * |
||
301 | * @since 2.9 |
||
302 | **/ |
||
303 | public function render_match_by_email() { |
||
304 | ?> |
||
305 | <label> |
||
306 | <input |
||
307 | type="checkbox" |
||
308 | name="jetpack_sso_match_by_email" |
||
309 | <?php checked( Jetpack_SSO_Helpers::match_by_email() ); ?> |
||
310 | <?php disabled( Jetpack_SSO_Helpers::is_match_by_email_checkbox_disabled() ); ?> |
||
311 | > |
||
312 | <?php esc_html_e( 'Match by Email', 'jetpack' ); ?> |
||
313 | </label> |
||
314 | <?php |
||
315 | } |
||
316 | |||
317 | /** |
||
318 | * Validate the match by email check in Settings > General |
||
319 | * |
||
320 | * @since 2.9 |
||
321 | * @return boolean |
||
322 | **/ |
||
323 | public function validate_jetpack_sso_match_by_email( $input ) { |
||
324 | return ( ! empty( $input ) ) ? 1 : 0; |
||
325 | } |
||
326 | |||
327 | /** |
||
328 | * Checks to determine if the user wants to login on wp-login |
||
329 | * |
||
330 | * This function mostly exists to cover the exceptions to login |
||
331 | * that may exist as other parameters to $_GET[action] as $_GET[action] |
||
332 | * does not have to exist. By default WordPress assumes login if an action |
||
333 | * is not set, however this may not be true, as in the case of logout |
||
334 | * where $_GET[loggedout] is instead set |
||
335 | * |
||
336 | * @return boolean |
||
337 | **/ |
||
338 | private function wants_to_login() { |
||
339 | $wants_to_login = false; |
||
340 | |||
341 | // Cover default WordPress behavior |
||
342 | $action = isset( $_REQUEST['action'] ) ? $_REQUEST['action'] : 'login'; |
||
343 | |||
344 | // And now the exceptions |
||
345 | $action = isset( $_GET['loggedout'] ) ? 'loggedout' : $action; |
||
346 | |||
347 | if ( 'login' == $action ) { |
||
348 | $wants_to_login = true; |
||
349 | } |
||
350 | |||
351 | return $wants_to_login; |
||
352 | } |
||
353 | |||
354 | function login_init() { |
||
355 | global $action; |
||
356 | |||
357 | if ( Jetpack_SSO_Helpers::should_hide_login_form() ) { |
||
358 | /** |
||
359 | * Since the default authenticate filters fire at priority 20 for checking username and password, |
||
360 | * let's fire at priority 30. wp_authenticate_spam_check is fired at priority 99, but since we return a |
||
361 | * WP_Error in disable_default_login_form, then we won't trigger spam processing logic. |
||
362 | */ |
||
363 | add_filter( 'authenticate', array( $this, 'disable_default_login_form' ), 30 ); |
||
364 | |||
365 | /** |
||
366 | * Filter the display of the disclaimer message appearing when default WordPress login form is disabled. |
||
367 | * |
||
368 | * @module sso |
||
369 | * |
||
370 | * @since 2.8.0 |
||
371 | * |
||
372 | * @param bool true Should the disclaimer be displayed. Default to true. |
||
373 | */ |
||
374 | $display_sso_disclaimer = apply_filters( 'jetpack_sso_display_disclaimer', true ); |
||
375 | if ( $display_sso_disclaimer ) { |
||
376 | add_filter( 'login_message', array( $this, 'msg_login_by_jetpack' ) ); |
||
377 | } |
||
378 | } |
||
379 | |||
380 | /** |
||
381 | * If the user is attempting to logout AND the auto-forward to WordPress.com |
||
382 | * login is set then we need to ensure we do not auto-forward the user and get |
||
383 | * them stuck in an infinite logout loop. |
||
384 | */ |
||
385 | if ( isset( $_GET['loggedout'] ) && Jetpack_SSO_Helpers::bypass_login_forward_wpcom() ) { |
||
386 | add_filter( 'jetpack_remove_login_form', '__return_true' ); |
||
387 | } |
||
388 | |||
389 | /** |
||
390 | * Check to see if the site admin wants to automagically forward the user |
||
391 | * to the WordPress.com login page AND that the request to wp-login.php |
||
392 | * is not something other than login (Like logout!) |
||
393 | */ |
||
394 | View Code Duplication | if ( |
|
395 | $this->wants_to_login() |
||
396 | && Jetpack_SSO_Helpers::bypass_login_forward_wpcom() |
||
397 | ) { |
||
398 | add_filter( 'allowed_redirect_hosts', array( $this, 'allowed_redirect_hosts' ) ); |
||
399 | $this->maybe_save_cookie_redirect(); |
||
400 | $reauth = ! empty( $_GET['force_reauth'] ); |
||
401 | $sso_url = $this->get_sso_url_or_die( $reauth ); |
||
402 | JetpackTracking::record_user_event( 'sso_login_redirect_bypass_success' ); |
||
403 | wp_safe_redirect( $sso_url ); |
||
404 | exit; |
||
405 | } |
||
406 | |||
407 | if ( 'login' === $action ) { |
||
408 | $this->display_sso_login_form(); |
||
409 | } elseif ( 'jetpack-sso' === $action ) { |
||
410 | if ( isset( $_GET['result'], $_GET['user_id'], $_GET['sso_nonce'] ) && 'success' == $_GET['result'] ) { |
||
411 | $this->handle_login(); |
||
412 | $this->display_sso_login_form(); |
||
413 | } else { |
||
414 | if ( Jetpack::check_identity_crisis() ) { |
||
415 | JetpackTracking::record_user_event( 'sso_login_redirect_failed', array( |
||
416 | 'error_message' => 'identity_crisis' |
||
417 | ) ); |
||
418 | wp_die( __( "Error: This site's Jetpack connection is currently experiencing problems.", 'jetpack' ) ); |
||
419 | View Code Duplication | } else { |
|
420 | $this->maybe_save_cookie_redirect(); |
||
421 | // Is it wiser to just use wp_redirect than do this runaround to wp_safe_redirect? |
||
422 | add_filter( 'allowed_redirect_hosts', array( $this, 'allowed_redirect_hosts' ) ); |
||
423 | $reauth = ! empty( $_GET['force_reauth'] ); |
||
424 | $sso_url = $this->get_sso_url_or_die( $reauth ); |
||
425 | JetpackTracking::record_user_event( 'sso_login_redirect_success' ); |
||
426 | wp_safe_redirect( $sso_url ); |
||
427 | exit; |
||
428 | } |
||
429 | } |
||
430 | } |
||
431 | } |
||
432 | |||
433 | /** |
||
434 | * Ensures that we can get a nonce from WordPress.com via XML-RPC before setting |
||
435 | * up the hooks required to display the SSO form. |
||
436 | */ |
||
437 | public function display_sso_login_form() { |
||
447 | |||
448 | /** |
||
449 | * Conditionally save the redirect_to url as a cookie. |
||
450 | */ |
||
451 | public static function maybe_save_cookie_redirect() { |
||
472 | |||
473 | /** |
||
474 | * Outputs the Jetpack SSO button and description as well as the toggle link |
||
475 | * for switching between Jetpack SSO and default login. |
||
476 | */ |
||
477 | function login_form() { |
||
478 | $site_name = get_bloginfo( 'name' ); |
||
479 | if ( ! $site_name ) { |
||
480 | $site_name = get_bloginfo( 'url' ); |
||
481 | } |
||
482 | |||
483 | $display_name = ! empty( $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ] ) |
||
484 | ? $_COOKIE[ 'jetpack_sso_wpcom_name_' . COOKIEHASH ] |
||
485 | : false; |
||
486 | $gravatar = ! empty( $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ] ) |
||
487 | ? $_COOKIE[ 'jetpack_sso_wpcom_gravatar_' . COOKIEHASH ] |
||
488 | : false; |
||
489 | |||
490 | ?> |
||
491 | <div id="jetpack-sso-wrap"> |
||
492 | <?php if ( $display_name && $gravatar ) : ?> |
||
493 | <div id="jetpack-sso-wrap__user"> |
||
494 | <img width="72" height="72" src="<?php echo esc_html( $gravatar ); ?>" /> |
||
495 | |||
496 | <h2> |
||
497 | <?php |
||
498 | echo wp_kses( |
||
499 | sprintf( __( 'Log in as <span>%s</span>', 'jetpack' ), esc_html( $display_name ) ), |
||
500 | array( 'span' => true ) |
||
501 | ); |
||
502 | ?> |
||
503 | </h2> |
||
504 | </div> |
||
505 | |||
506 | <?php endif; ?> |
||
507 | |||
508 | |||
509 | <div id="jetpack-sso-wrap__action"> |
||
510 | <?php echo $this->build_sso_button( array(), 'is_primary' ); ?> |
||
511 | |||
512 | <?php if ( $display_name && $gravatar ) : ?> |
||
513 | <a rel="nofollow" class="jetpack-sso-wrap__reauth" href="<?php echo esc_url( $this->build_sso_button_url( array( 'force_reauth' => '1' ) ) ); ?>"> |
||
514 | <?php esc_html_e( 'Log in as a different WordPress.com user', 'jetpack' ); ?> |
||
515 | </a> |
||
516 | <?php else : ?> |
||
517 | <p> |
||
518 | <?php |
||
519 | echo esc_html( |
||
520 | sprintf( |
||
521 | __( 'You can now save time spent logging in by connecting your WordPress.com account to %s.', 'jetpack' ), |
||
522 | esc_html( $site_name ) |
||
523 | ) |
||
524 | ); |
||
525 | ?> |
||
526 | </p> |
||
527 | <?php endif; ?> |
||
528 | </div> |
||
529 | |||
530 | <?php if ( ! Jetpack_SSO_Helpers::should_hide_login_form() ) : ?> |
||
531 | <div class="jetpack-sso-or"> |
||
532 | <span><?php esc_html_e( 'Or', 'jetpack' ); ?></span> |
||
533 | </div> |
||
534 | |||
535 | <a href="<?php echo add_query_arg( 'jetpack-sso-show-default-form', '1' ); ?>" class="jetpack-sso-toggle wpcom"> |
||
536 | <?php |
||
537 | esc_html_e( 'Log in with username and password', 'jetpack' ) |
||
538 | ?> |
||
539 | </a> |
||
540 | |||
541 | <a href="<?php echo add_query_arg( 'jetpack-sso-show-default-form', '0' ); ?>" class="jetpack-sso-toggle default"> |
||
542 | <?php |
||
543 | esc_html_e( 'Log in with WordPress.com', 'jetpack' ) |
||
544 | ?> |
||
545 | </a> |
||
546 | <?php endif; ?> |
||
547 | </div> |
||
548 | <?php |
||
549 | } |
||
550 | |||
551 | /** |
||
552 | * Clear the cookies that store the profile information for the last |
||
553 | * WPCOM user to connect. |
||
554 | */ |
||
555 | static function clear_wpcom_profile_cookies() { |
||
576 | |||
577 | static function delete_connection_for_user( $user_id ) { |
||
598 | |||
599 | View Code Duplication | static function request_initial_nonce() { |
|
612 | |||
613 | /** |
||
614 | * The function that actually handles the login! |
||
615 | */ |
||
616 | function handle_login() { |
||
617 | $wpcom_nonce = sanitize_key( $_GET['sso_nonce'] ); |
||
618 | $wpcom_user_id = (int) $_GET['user_id']; |
||
619 | |||
620 | Jetpack::load_xml_rpc_client(); |
||
621 | $xml = new Jetpack_IXR_Client( array( |
||
622 | 'user_id' => get_current_user_id(), |
||
623 | ) ); |
||
624 | $xml->query( 'jetpack.sso.validateResult', $wpcom_nonce, $wpcom_user_id ); |
||
625 | |||
626 | if ( $xml->isError() ) { |
||
627 | $error_message = sanitize_text_field( |
||
628 | sprintf( '%s: %s', $xml->getErrorCode(), $xml->getErrorMessage() ) |
||
629 | ); |
||
630 | JetpackTracking::record_user_event( 'sso_login_failed', array( |
||
631 | 'error_message' => $error_message |
||
632 | ) ); |
||
633 | wp_die( $error_message ); |
||
634 | } |
||
635 | |||
636 | $user_data = $xml->getResponse(); |
||
637 | |||
638 | if ( empty( $user_data ) ) { |
||
639 | JetpackTracking::record_user_event( 'sso_login_failed', array( |
||
640 | 'error_message' => 'invalid_response_data' |
||
641 | ) ); |
||
642 | wp_die( __( 'Error, invalid response data.', 'jetpack' ) ); |
||
643 | } |
||
644 | |||
645 | $user_data = (object) $user_data; |
||
646 | $user = null; |
||
647 | |||
648 | /** |
||
649 | * Fires before Jetpack's SSO modifies the log in form. |
||
650 | * |
||
651 | * @module sso |
||
652 | * |
||
653 | * @since 2.6.0 |
||
654 | * |
||
655 | * @param object $user_data WordPress.com User information. |
||
656 | */ |
||
657 | do_action( 'jetpack_sso_pre_handle_login', $user_data ); |
||
658 | |||
659 | if ( Jetpack_SSO_Helpers::is_two_step_required() && 0 === (int) $user_data->two_step_enabled ) { |
||
660 | $this->user_data = $user_data; |
||
661 | |||
662 | JetpackTracking::record_user_event( 'sso_login_failed', array( |
||
663 | 'error_message' => 'error_msg_enable_two_step' |
||
664 | ) ); |
||
665 | |||
666 | /** This filter is documented in core/src/wp-includes/pluggable.php */ |
||
667 | do_action( 'wp_login_failed', $user_data->login ); |
||
668 | add_filter( 'login_message', array( $this, 'error_msg_enable_two_step' ) ); |
||
669 | return; |
||
670 | } |
||
671 | |||
672 | $user_found_with = ''; |
||
673 | if ( empty( $user ) && isset( $user_data->external_user_id ) ) { |
||
674 | $user_found_with = 'external_user_id'; |
||
675 | $user = get_user_by( 'id', intval( $user_data->external_user_id ) ); |
||
676 | if ( $user ) { |
||
677 | update_user_meta( $user->ID, 'wpcom_user_id', $user_data->ID ); |
||
678 | } |
||
679 | } |
||
680 | |||
681 | // If we don't have one by wpcom_user_id, try by the email? |
||
682 | if ( empty( $user ) && Jetpack_SSO_Helpers::match_by_email() ) { |
||
683 | $user_found_with = 'match_by_email'; |
||
684 | $user = get_user_by( 'email', $user_data->email ); |
||
685 | if ( $user ) { |
||
686 | update_user_meta( $user->ID, 'wpcom_user_id', $user_data->ID ); |
||
687 | } |
||
688 | } |
||
689 | |||
690 | // If we've still got nothing, create the user. |
||
691 | if ( empty( $user ) && ( get_option( 'users_can_register' ) || Jetpack_SSO_Helpers::new_user_override() ) ) { |
||
692 | // If not matching by email we still need to verify the email does not exist |
||
693 | // or this blows up |
||
694 | /** |
||
695 | * If match_by_email is true, we know the email doesn't exist, as it would have |
||
696 | * been found in the first pass. If get_user_by( 'email' ) doesn't find the |
||
697 | * user, then we know that email is unused, so it's safe to add. |
||
698 | */ |
||
699 | if ( Jetpack_SSO_Helpers::match_by_email() || ! get_user_by( 'email', $user_data->email ) ) { |
||
700 | $username = $user_data->login; |
||
701 | |||
702 | if ( username_exists( $username ) ) { |
||
703 | $username = $user_data->login . '_' . $user_data->ID; |
||
704 | } |
||
705 | |||
706 | $tries = 0; |
||
707 | while ( username_exists( $username ) ) { |
||
708 | $username = $user_data->login . '_' . $user_data->ID . '_' . mt_rand(); |
||
709 | if ( $tries++ >= 5 ) { |
||
710 | JetpackTracking::record_user_event( 'sso_login_failed', array( |
||
711 | 'error_message' => 'could_not_create_username' |
||
712 | ) ); |
||
713 | wp_die( __( "Error: Couldn't create suitable username.", 'jetpack' ) ); |
||
714 | } |
||
715 | } |
||
716 | |||
717 | $user_found_with = Jetpack_SSO_Helpers::new_user_override() |
||
718 | ? 'user_created_new_user_override' |
||
719 | : 'user_created_users_can_register'; |
||
720 | |||
721 | $password = wp_generate_password( 20 ); |
||
722 | $user_id = wp_create_user( $username, $password, $user_data->email ); |
||
723 | $user = get_userdata( $user_id ); |
||
724 | |||
725 | $user->display_name = $user_data->display_name; |
||
726 | $user->first_name = $user_data->first_name; |
||
727 | $user->last_name = $user_data->last_name; |
||
728 | $user->url = $user_data->url; |
||
729 | $user->description = $user_data->description; |
||
730 | wp_update_user( $user ); |
||
731 | |||
732 | update_user_meta( $user->ID, 'wpcom_user_id', $user_data->ID ); |
||
733 | } else { |
||
734 | JetpackTracking::record_user_event( 'sso_login_failed', array( |
||
735 | 'error_message' => 'error_msg_email_already_exists' |
||
736 | ) ); |
||
737 | |||
738 | $this->user_data = $user_data; |
||
739 | add_action( 'login_message', array( $this, 'error_msg_email_already_exists' ) ); |
||
740 | return; |
||
741 | } |
||
742 | } |
||
743 | |||
744 | /** |
||
745 | * Fires after we got login information from WordPress.com. |
||
746 | * |
||
747 | * @module sso |
||
748 | * |
||
749 | * @since 2.6.0 |
||
750 | * |
||
751 | * @param array $user Local User information. |
||
752 | * @param object $user_data WordPress.com User Login information. |
||
753 | */ |
||
754 | do_action( 'jetpack_sso_handle_login', $user, $user_data ); |
||
755 | |||
756 | if ( $user ) { |
||
757 | // Cache the user's details, so we can present it back to them on their user screen |
||
758 | update_user_meta( $user->ID, 'wpcom_user_data', $user_data ); |
||
759 | |||
760 | $remember = false; |
||
761 | View Code Duplication | if ( ! empty( $_COOKIE['jetpack_sso_remember_me'] ) ) { |
|
762 | $remember = true; |
||
763 | // And then purge it |
||
764 | setcookie( 'jetpack_sso_remember_me', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN ); |
||
765 | } |
||
766 | /** |
||
767 | * Filter the remember me value. |
||
768 | * |
||
769 | * @module sso |
||
770 | * |
||
771 | * @since 2.8.0 |
||
772 | * |
||
773 | * @param bool $remember Is the remember me option checked? |
||
774 | */ |
||
775 | $remember = apply_filters( 'jetpack_remember_login', $remember ); |
||
776 | wp_set_auth_cookie( $user->ID, $remember ); |
||
777 | |||
778 | /** This filter is documented in core/src/wp-includes/user.php */ |
||
779 | do_action( 'wp_login', $user->user_login, $user ); |
||
780 | |||
781 | wp_set_current_user( $user->ID ); |
||
782 | |||
783 | $_request_redirect_to = isset( $_REQUEST['redirect_to'] ) ? esc_url_raw( $_REQUEST['redirect_to'] ) : ''; |
||
784 | $redirect_to = user_can( $user, 'edit_posts' ) ? admin_url() : self::profile_page_url(); |
||
785 | |||
786 | // If we have a saved redirect to request in a cookie |
||
787 | View Code Duplication | if ( ! empty( $_COOKIE['jetpack_sso_redirect_to'] ) ) { |
|
788 | // Set that as the requested redirect to |
||
789 | $redirect_to = $_request_redirect_to = esc_url_raw( $_COOKIE['jetpack_sso_redirect_to'] ); |
||
790 | // And then purge it |
||
791 | setcookie( 'jetpack_sso_redirect_to', ' ', time() - YEAR_IN_SECONDS, COOKIEPATH, COOKIE_DOMAIN ); |
||
792 | } |
||
793 | |||
794 | $is_user_connected = Jetpack::is_user_connected( $user->ID ); |
||
795 | JetpackTracking::record_user_event( 'sso_user_logged_in', array( |
||
796 | 'user_found_with' => $user_found_with, |
||
797 | 'user_connected' => (bool) $is_user_connected, |
||
798 | 'user_role' => Jetpack::translate_current_user_to_role() |
||
799 | ) ); |
||
800 | |||
801 | if ( ! $is_user_connected ) { |
||
802 | $calypso_env = ! empty( $_GET['calypso_env'] ) |
||
803 | ? sanitize_key( $_GET['calypso_env'] ) |
||
804 | : ''; |
||
805 | |||
806 | wp_safe_redirect( |
||
807 | add_query_arg( |
||
808 | array( |
||
809 | 'redirect_to' => $redirect_to, |
||
810 | 'request_redirect_to' => $_request_redirect_to, |
||
811 | 'calypso_env' => $calypso_env, |
||
812 | 'jetpack-sso-auth-redirect' => '1', |
||
813 | ), |
||
814 | admin_url() |
||
815 | ) |
||
816 | ); |
||
817 | exit; |
||
818 | } |
||
819 | |||
820 | wp_safe_redirect( |
||
821 | /** This filter is documented in core/src/wp-login.php */ |
||
822 | apply_filters( 'login_redirect', $redirect_to, $_request_redirect_to, $user ) |
||
823 | ); |
||
824 | exit; |
||
825 | } |
||
826 | |||
827 | add_filter( 'jetpack_sso_default_to_sso_login', '__return_false' ); |
||
828 | |||
829 | JetpackTracking::record_user_event( 'sso_login_failed', array( |
||
830 | 'error_message' => 'cant_find_user' |
||
831 | ) ); |
||
832 | |||
833 | $this->user_data = $user_data; |
||
834 | /** This filter is documented in core/src/wp-includes/pluggable.php */ |
||
835 | do_action( 'wp_login_failed', $user_data->login ); |
||
836 | add_filter( 'login_message', array( $this, 'cant_find_user' ) ); |
||
837 | } |
||
838 | |||
839 | static function profile_page_url() { |
||
842 | |||
843 | function allowed_redirect_hosts( $hosts ) { |
||
852 | |||
853 | /** |
||
854 | * Builds the "Login to WordPress.com" button that is displayed on the login page as well as user profile page. |
||
855 | * |
||
856 | * @param array $args An array of arguments to add to the SSO URL. |
||
857 | * @param boolean $is_primary Should the button have the `button-primary` class? |
||
858 | * @return string Returns the HTML markup for the button. |
||
859 | */ |
||
860 | function build_sso_button( $args = array(), $is_primary = false ) { |
||
874 | |||
875 | /** |
||
876 | * Builds a URL with `jetpack-sso` action and option args which is used to setup SSO. |
||
877 | * |
||
878 | * @param array $args An array of arguments to add to the SSO URL. |
||
879 | * @return string The URL used for SSO. |
||
880 | */ |
||
881 | function build_sso_button_url( $args = array() ) { |
||
894 | |||
895 | /** |
||
896 | * Retrieves a WordPress.com SSO URL with appropriate query parameters or dies. |
||
897 | * |
||
898 | * @param boolean $reauth Should the user be forced to reauthenticate on WordPress.com? |
||
899 | * @param array $args Optional query parameters. |
||
900 | * @return string The WordPress.com SSO URL. |
||
901 | */ |
||
902 | function get_sso_url_or_die( $reauth = false, $args = array() ) { |
||
923 | |||
924 | /** |
||
925 | * Build WordPress.com SSO URL with appropriate query parameters. |
||
926 | * |
||
927 | * @param array $args Optional query parameters. |
||
928 | * @return string WordPress.com SSO URL |
||
929 | */ |
||
930 | function build_sso_url( $args = array() ) { |
||
947 | |||
948 | /** |
||
949 | * Build WordPress.com SSO URL with appropriate query parameters, |
||
950 | * including the parameters necessary to force the user to reauthenticate |
||
951 | * on WordPress.com. |
||
952 | * |
||
953 | * @param array $args Optional query parameters. |
||
954 | * @return string WordPress.com SSO URL |
||
955 | */ |
||
956 | function build_reauth_and_sso_url( $args = array() ) { |
||
981 | |||
982 | /** |
||
983 | * Determines local user associated with a given WordPress.com user ID. |
||
984 | * |
||
985 | * @since 2.6.0 |
||
986 | * |
||
987 | * @param int $wpcom_user_id User ID from WordPress.com |
||
988 | * @return object Local user object if found, null if not. |
||
989 | */ |
||
990 | static function get_user_by_wpcom_id( $wpcom_user_id ) { |
||
1000 | |||
1001 | /** |
||
1002 | * Error message displayed on the login form when two step is required and |
||
1003 | * the user's account on WordPress.com does not have two step enabled. |
||
1004 | * |
||
1005 | * @since 2.7 |
||
1006 | * @param string $message |
||
1007 | * @return string |
||
1008 | **/ |
||
1009 | public function error_msg_enable_two_step( $message ) { |
||
1026 | |||
1027 | /** |
||
1028 | * Error message displayed when the user tries to SSO, but match by email |
||
1029 | * is off and they already have an account with their email address on |
||
1030 | * this site. |
||
1031 | * |
||
1032 | * @param string $message |
||
1033 | * @return string |
||
1034 | */ |
||
1035 | public function error_msg_email_already_exists( $message ) { |
||
1051 | |||
1052 | /** |
||
1053 | * Builds the translation ready string that is to be used when the site hides the default login form. |
||
1054 | * |
||
1055 | * @since 4.1.0 |
||
1056 | * @return string |
||
1057 | */ |
||
1058 | public function get_sso_required_message() { |
||
1072 | |||
1073 | /** |
||
1074 | * Message displayed when the site admin has disabled the default WordPress |
||
1075 | * login form in Settings > General > Single Sign On |
||
1076 | * |
||
1077 | * @since 2.7 |
||
1078 | * @param string $message |
||
1079 | * |
||
1080 | * @return string |
||
1081 | **/ |
||
1082 | public function msg_login_by_jetpack( $message ) { |
||
1092 | |||
1093 | /** |
||
1094 | * Message displayed when the user can not be found after approving the SSO process on WordPress.com |
||
1095 | * |
||
1096 | * @param string $message |
||
1097 | * @return string |
||
1098 | */ |
||
1099 | function cant_find_user( $message ) { |
||
1108 | |||
1109 | /** |
||
1110 | * When jetpack-sso-auth-redirect query parameter is set, will redirect user to |
||
1111 | * WordPress.com authorization flow. |
||
1112 | * |
||
1113 | * We redirect here instead of in handle_login() because Jetpack::init()->build_connect_url |
||
1114 | * calls menu_page_url() which doesn't work properly until admin menus are registered. |
||
1115 | */ |
||
1116 | function maybe_authorize_user_after_sso() { |
||
1143 | |||
1144 | /** |
||
1145 | * Cache user's display name and Gravatar so it can be displayed on the login screen. These cookies are |
||
1146 | * stored when the user logs out, and then deleted when the user logs in. |
||
1147 | */ |
||
1148 | function store_wpcom_profile_cookies_on_logout() { |
||
1177 | |||
1178 | /** |
||
1179 | * Determines if a local user is connected to WordPress.com |
||
1180 | * |
||
1181 | * @since 2.8 |
||
1182 | * @param integer $user_id - Local user id |
||
1183 | * @return boolean |
||
1184 | **/ |
||
1185 | public function is_user_connected( $user_id ) { |
||
1188 | |||
1189 | /** |
||
1190 | * Retrieves a user's WordPress.com data |
||
1191 | * |
||
1192 | * @since 2.8 |
||
1193 | * @param integer $user_id - Local user id |
||
1194 | * @return mixed null or stdClass |
||
1195 | **/ |
||
1196 | public function get_user_data( $user_id ) { |
||
1199 | } |
||
1200 | |||
1201 | Jetpack_SSO::get_instance(); |
||
1202 |
The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using
the property is implicitly global.
To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.