1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
|
<?php
/**
* WPSEO plugin file.
*
* @package WPSEO\Admin
*/
/**
* Represents the route for MyYoast.
*/
class WPSEO_MyYoast_Route implements WPSEO_WordPress_Integration {
/**
* @var string
*/
const PAGE_IDENTIFIER = 'wpseo_myyoast';
/**
* The instance of the MyYoast client.
*
* @var WPSEO_MyYoast_Client
*/
protected $client;
/**
* The actions that are supported.
*
* Each action should have a method named equally to the action.
*
* For example:
* The connect action is handled by a method named 'connect'.
*
* @var array
*/
protected static $allowed_actions = array( 'connect', 'authorize', 'complete' );
/**
* Sets the hooks when the user has enough rights and is on the right page.
*
* @return void
*/
public function register_hooks() {
$route = filter_input( INPUT_GET, 'page' );
if ( ! ( $this->is_myyoast_route( $route ) && $this->can_access_route() ) ) {
return;
}
if ( ! $this->is_valid_action( $this->get_action() ) ) {
return;
}
add_action( 'admin_menu', array( $this, 'register_route' ) );
add_action( 'admin_init', array( $this, 'handle_route' ) );
}
/**
* Registers the page for the MyYoast route.
*
* @codeCoverageIgnore
*
* @return void
*/
public function register_route() {
add_dashboard_page(
'', // Is empty because we don't render a page.
'', // Is empty because we don't want a menu item.
'wpseo_manage_options',
self::PAGE_IDENTIFIER
);
}
/**
* Abstracts the action from the URL and follows the appropriate route.
*
* @return void
*/
public function handle_route() {
$action = $this->get_action();
if ( ! $this->is_valid_action( $action ) || ! method_exists( $this, $action ) ) {
return;
}
// Dynamically call the method.
$this->$action();
}
/**
* Checks if the current page is the MyYoast route.
*
* @param string $route The MyYoast route.
*
* @return bool True when url is the MyYoast route.
*/
protected function is_myyoast_route( $route ) {
return ( $route === self::PAGE_IDENTIFIER );
}
/**
* Compares an action to a list of allowed actions to see if it is valid.
*
* @param string $action The action to check.
*
* @return bool True if the action is valid.
*/
protected function is_valid_action( $action ) {
return in_array( $action, self::$allowed_actions, true );
}
/**
* Connects to MyYoast and generates a new clientId.
*
* @return void
*/
protected function connect() {
$client_id = $this->generate_uuid();
$this->save_client_id( $client_id );
$this->redirect(
'https://my.yoast.com/connect',
array(
'url' => WPSEO_Utils::get_home_url(),
'client_id' => $client_id,
'extensions' => $this->get_extensions(),
'redirect_url' => admin_url( 'admin.php?page=' . self::PAGE_IDENTIFIER . '&action=complete' ),
'credentials_url' => rest_url( 'yoast/v1/myyoast/connect' ),
'type' => 'wordpress',
)
);
}
/**
* Redirects the user to the oAuth authorization page.
*
* @return void
*/
protected function authorize() {
$client = $this->get_client();
if ( ! $client->has_configuration() ) {
return;
}
$this->redirect(
$client->get_provider()->getAuthorizationUrl()
);
}
/**
* Completes the oAuth connection flow.
*
* @return void
*/
protected function complete() {
$client = $this->get_client();
if ( ! $client->has_configuration() ) {
return;
}
try {
$access_token = $client
->get_provider()
->getAccessToken(
'authorization_code',
array(
'code' => $this->get_authorization_code(),
)
);
$client->save_access_token(
$this->get_current_user_id(),
$access_token
);
}
// @codingStandardsIgnoreLine Generic.CodeAnalysis.EmptyStatement.DetectedCATCH -- There is nothing to do.
catch ( Exception $e ) {
// Do nothing.
}
$this->redirect_to_premium_page();
}
/**
* Saves the client id.
*
* @codeCoverageIgnore
*
* @param string $client_id The client id to save.
*
* @return void
*/
protected function save_client_id( $client_id ) {
$this->get_client()->save_configuration(
array(
'clientId' => $client_id,
)
);
}
/**
* Creates a new MyYoast Client instance.
*
* @codeCoverageIgnore
*
* @return WPSEO_MyYoast_Client Instance of the myyoast client.
*/
protected function get_client() {
if ( ! $this->client ) {
$this->client = new WPSEO_MyYoast_Client();
}
return $this->client;
}
/**
* Abstracts the action from the url.
*
* @codeCoverageIgnore
*
* @return string The action from the url.
*/
protected function get_action() {
return filter_input( INPUT_GET, 'action' );
}
/**
* Abstracts the authorization code from the url.
*
* @codeCoverageIgnore
*
* @return string The action from the url.
*/
protected function get_authorization_code() {
return filter_input( INPUT_GET, 'code' );
}
/**
* Retrieves a list of activated extensions slugs.
*
* @codeCoverageIgnore
*
* @return array The extensions slugs.
*/
protected function get_extensions() {
$addon_manager = new WPSEO_Addon_Manager();
return array_keys( $addon_manager->get_subscriptions_for_active_addons() );
}
/**
* Generates an URL-encoded query string, redirects there.
*
* @codeCoverageIgnore
*
* @param string $url The url to redirect to.
* @param array $query_args The additional arguments to build the url from.
*
* @return void
*/
protected function redirect( $url, $query_args = array() ) {
if ( ! empty( $query_args ) ) {
$url .= '?' . http_build_query( $query_args );
}
wp_redirect( $url );
exit;
}
/**
* Checks if current user is allowed to access the route.
*
* @codeCoverageIgnore
*
* @return bool True when current user has rights to manage options.
*/
protected function can_access_route() {
return WPSEO_Utils::has_access_token_support() && current_user_can( 'wpseo_manage_options' );
}
/**
* Generates an unique user id.
*
* @codeCoverageIgnore
*
* @return string The generated unique user id.
*/
protected function generate_uuid() {
return wp_generate_uuid4();
}
/**
* Retrieves the current user id.
*
* @codeCoverageIgnore
*
* @return int The user id.
*/
protected function get_current_user_id() {
return get_current_user_id();
}
/**
* Redirects to the premium page.
*
* @codeCoverageIgnore
*
* @return void
*/
protected function redirect_to_premium_page() {
wp_safe_redirect( admin_url( 'admin.php?page=wpseo_licenses' ) );
exit;
}
}
|