class.jetpack-sso-helpers.php — Jetpack – WP Security, Backup, Speed, & Growth 13.8.3

jetpack / modules / sso / class.jetpack-sso-helpers.php

jetpack / modules / sso Last commit date

class.jetpack-sso-helpers.php

278 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* A collection of helper functions used in the SSO module.
4	*
5	* @deprecated 13.5 Use Automattic\Jetpack\Connection\Manager\SSO instead.
6	*
7	* @package automattic/jetpack
8	*/
9
10	use Automattic\Jetpack\Connection\Manager;
11	use Automattic\Jetpack\Connection\SSO\Helpers;
12	use Automattic\Jetpack\Connection\Utils;
13
14	if ( ! class_exists( 'Jetpack_SSO_Helpers' ) ) :
15
16	/**
17	* A collection of helper functions used in the SSO module.
18	*
19	* @deprecated 13.5
20	*
21	* @since 4.1.0
22	*/
23	class Jetpack_SSO_Helpers {
24	/**
25	* Determine if the login form should be hidden or not
26	*
27	* @deprecated 13.5
28	*
29	* @return bool
30	**/
31	public static function should_hide_login_form() {
32	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::should_hide_login_form' );
33
34	return Helpers::should_hide_login_form();
35	}
36
37	/**
38	* Returns a boolean value for whether logging in by matching the WordPress.com user email to a
39	* Jetpack site user's email is allowed.
40	*
41	* @deprecated 13.5
42	*
43	* @return bool
44	*/
45	public static function match_by_email() {
46	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::match_by_email' );
47
48	return Helpers::match_by_email();
49	}
50
51	/**
52	* Returns a boolean for whether users are allowed to register on the Jetpack site with SSO,
53	* even though the site disallows normal registrations.
54	*
55	* @deprecated 13.5
56	*
57	* @param object\|null $user_data WordPress.com user information.
58	* @return bool
59	*/
60	public static function new_user_override( $user_data = null ) {
61	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::new_user_override' );
62
63	return Helpers::new_user_override( $user_data );
64	}
65
66	/**
67	* Returns a boolean value for whether two-step authentication is required for SSO.
68	*
69	* @since 4.1.0
70	*
71	* @deprecated 13.5
72	*
73	* @return bool
74	*/
75	public static function is_two_step_required() {
76	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::is_two_step_required' );
77
78	return Helpers::is_two_step_required();
79	}
80
81	/**
82	* Returns a boolean for whether a user that is attempting to log in will be automatically
83	* redirected to WordPress.com to begin the SSO flow.
84	*
85	* @deprecated 13.5
86	*
87	* @return bool
88	*/
89	public static function bypass_login_forward_wpcom() {
90	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::bypass_login_forward_wpcom' );
91
92	return Helpers::bypass_login_forward_wpcom();
93	}
94
95	/**
96	* Returns a boolean for whether the SSO login form should be displayed as the default
97	* when both the default and SSO login form allowed.
98	*
99	* @since 4.1.0
100	*
101	* @deprecated 13.5
102	*
103	* @return bool
104	*/
105	public static function show_sso_login() {
106	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::show_sso_login' );
107
108	return Helpers::show_sso_login();
109	}
110
111	/**
112	* Returns a boolean for whether the two step required checkbox, displayed on the Jetpack admin page, should be disabled.
113	*
114	* @since 4.1.0
115	*
116	* @deprecated 13.5
117	*
118	* @return bool
119	*/
120	public static function is_require_two_step_checkbox_disabled() {
121	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::is_require_two_step_checkbox_disabled' );
122
123	return Helpers::is_require_two_step_checkbox_disabled();
124	}
125
126	/**
127	* Returns a boolean for whether the match by email checkbox, displayed on the Jetpack admin page, should be disabled.
128	*
129	* @since 4.1.0
130	*
131	* @deprecated 13.5
132	*
133	* @return bool
134	*/
135	public static function is_match_by_email_checkbox_disabled() {
136	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::is_match_by_email_checkbox_disabled' );
137
138	return Helpers::is_match_by_email_checkbox_disabled();
139	}
140
141	/**
142	* Returns an array of hosts that SSO will redirect to.
143	*
144	* Instead of accessing JETPACK__API_BASE within the method directly, we set it as the
145	* default for $api_base due to restrictions with testing constants in our tests.
146	*
147	* @since 4.3.0
148	* @since 4.6.0 Added public-api.wordpress.com as an allowed redirect
149	*
150	* @deprecated 13.5
151	*
152	* @param array $hosts Allowed redirect hosts.
153	* @param string $api_base Base API URL.
154	*
155	* @return array
156	*/
157	public static function allowed_redirect_hosts( $hosts, $api_base = JETPACK__API_BASE ) {
158	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::allowed_redirect_hosts' );
159
160	return Helpers::allowed_redirect_hosts( $hosts, $api_base );
161	}
162
163	/**
164	* Generate a new user from a SSO attempt.
165	*
166	* @deprecated 13.5
167	*
168	* @param object $user_data WordPress.com user information.
169	*/
170	public static function generate_user( $user_data ) {
171	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\Utils::generate_user' );
172
173	return Utils::generate_user( $user_data );
174	}
175
176	/**
177	* Determines how long the auth cookie is valid for when a user logs in with SSO.
178	*
179	* @deprecated 13.5
180	*
181	* @return int result of the jetpack_sso_auth_cookie_expiration filter.
182	*/
183	public static function extend_auth_cookie_expiration_for_sso() {
184	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::extend_auth_cookie_expiration_for_sso' );
185
186	return Helpers::extend_auth_cookie_expiration_for_sso();
187	}
188
189	/**
190	* Determines if the SSO form should be displayed for the current action.
191	*
192	* @since 4.6.0
193	*
194	* @deprecated 13.5
195	*
196	* @param string $action SSO action being performed.
197	*
198	* @return bool Is SSO allowed for the current action?
199	*/
200	public static function display_sso_form_for_action( $action ) {
201	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::display_sso_form_for_action' );
202
203	return Helpers::display_sso_form_for_action( $action );
204	}
205
206	/**
207	* This method returns an environment array that is meant to simulate `$_REQUEST` when the initial
208	* JSON API auth request was made.
209	*
210	* @since 4.6.0
211	*
212	* @deprecated 13.5
213	*
214	* @return array\|bool
215	*/
216	public static function get_json_api_auth_environment() {
217	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::get_json_api_auth_environment' );
218
219	return Helpers::get_json_api_auth_environment();
220	}
221
222	/**
223	* Check if the site has a custom login page URL, and return it.
224	* If default login page URL is used (`wp-login.php`), `null` will be returned.
225	*
226	* @deprecated 13.5
227	*
228	* @return string\|null
229	*/
230	public static function get_custom_login_url() {
231	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::get_custom_login_url' );
232
233	return Helpers::get_custom_login_url();
234	}
235
236	/**
237	* Clear the cookies that store the profile information for the last
238	* WPCOM user to connect.
239	*
240	* @deprecated 13.5
241	*/
242	public static function clear_wpcom_profile_cookies() {
243	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::clear_wpcom_profile_cookies' );
244
245	return Helpers::clear_wpcom_profile_cookies();
246	}
247
248	/**
249	* Remove an SSO connection for a user.
250	*
251	* @deprecated 13.5
252	*
253	* @param int $user_id The local user id.
254	*/
255	public static function delete_connection_for_user( $user_id ) {
256	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\SSO\\Helpers::delete_connection_for_user' );
257
258	return Helpers::delete_connection_for_user( $user_id );
259	}
260
261	/**
262	* Check if a local user is already connected to WordPress.com.
263	*
264	* @since 13.3
265	*
266	* @deprecated 13.5
267	*
268	* @param int $user_id Local User information.
269	*/
270	public static function is_user_connected( $user_id = 0 ) {
271	_deprecated_function( __METHOD__, 'jetpack-13.5', 'Automattic\\Jetpack\\Connection\\Manager->is_user_connected' );
272
273	return ( new Manager() )->is_user_connected( $user_id );
274	}
275	}
276
277	endif;
278