semrush-route.php
6.22 KB
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
<?php
namespace Yoast\WP\SEO\Routes;
use WP_REST_Request;
use WP_REST_Response;
use Yoast\WP\SEO\Actions\SEMrush\SEMrush_Login_Action;
use Yoast\WP\SEO\Actions\SEMrush\SEMrush_Options_Action;
use Yoast\WP\SEO\Actions\SEMrush\SEMrush_Phrases_Action;
use Yoast\WP\SEO\Conditionals\SEMrush_Enabled_Conditional;
use Yoast\WP\SEO\Main;
/**
* SEMrush_Route class.
*/
class SEMrush_Route implements Route_Interface {
/**
* The SEMrush route prefix.
*
* @var string
*/
const ROUTE_PREFIX = 'semrush';
/**
* The authenticate route constant.
*
* @var string
*/
const AUTHENTICATION_ROUTE = self::ROUTE_PREFIX . '/authenticate';
/**
* The country code option route constant.
*
* @var string
*/
const COUNTRY_CODE_OPTION_ROUTE = self::ROUTE_PREFIX . '/country_code';
/**
* The request related keyphrases route constant.
*
* @var string
*/
const RELATED_KEYPHRASES_ROUTE = self::ROUTE_PREFIX . '/related_keyphrases';
/**
* The full login route constant.
*
* @var string
*/
const FULL_AUTHENTICATION_ROUTE = Main::API_V1_NAMESPACE . '/' . self::AUTHENTICATION_ROUTE;
/**
* The full country code option route constant.
*
* @var string
*/
const FULL_COUNTRY_CODE_OPTION_ROUTE = Main::API_V1_NAMESPACE . '/' . self::COUNTRY_CODE_OPTION_ROUTE;
/**
* The login action.
*
* @var SEMrush_Login_Action
*/
private $login_action;
/**
* The options action.
*
* @var SEMrush_Options_Action
*/
private $options_action;
/**
* The phrases action.
*
* @var SEMrush_Phrases_Action
*/
private $phrases_action;
/**
* Returns the conditionals based in which this loadable should be active.
*
* @return array
*/
public static function get_conditionals() {
return [ SEMrush_Enabled_Conditional::class ];
}
/**
* SEMrush_Route constructor.
*
* @param SEMrush_Login_Action $login_action The login action.
* @param SEMrush_Options_Action $options_action The options action.
* @param SEMrush_Phrases_Action $phrases_action The phrases action.
*/
public function __construct(
SEMrush_Login_Action $login_action,
SEMrush_Options_Action $options_action,
SEMrush_Phrases_Action $phrases_action
) {
$this->login_action = $login_action;
$this->options_action = $options_action;
$this->phrases_action = $phrases_action;
}
/**
* Registers routes with WordPress.
*
* @return void
*/
public function register_routes() {
$authentication_route_args = [
'methods' => 'POST',
'callback' => [ $this, 'authenticate' ],
'permission_callback' => [ $this, 'can_use_semrush' ],
'args' => [
'code' => [
'validate_callback' => [ $this, 'has_valid_code' ],
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::AUTHENTICATION_ROUTE, $authentication_route_args );
$set_country_code_option_route_args = [
'methods' => 'POST',
'callback' => [ $this, 'set_country_code_option' ],
'permission_callback' => [ $this, 'can_use_semrush' ],
'args' => [
'country_code' => [
'validate_callback' => [ $this, 'has_valid_country_code' ],
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::COUNTRY_CODE_OPTION_ROUTE, $set_country_code_option_route_args );
$related_keyphrases_route_args = [
'methods' => 'GET',
'callback' => [ $this, 'get_related_keyphrases' ],
'permission_callback' => [ $this, 'can_use_semrush' ],
'args' => [
'keyphrase' => [
'validate_callback' => [ $this, 'has_valid_keyphrase' ],
'required' => true,
],
'country_code' => [
'required' => true,
],
],
];
\register_rest_route( Main::API_V1_NAMESPACE, self::RELATED_KEYPHRASES_ROUTE, $related_keyphrases_route_args );
}
/**
* Authenticates with SEMrush.
*
* @param WP_REST_Request $request The request. This request should have a code param set.
*
* @return WP_REST_Response The response.
*/
public function authenticate( WP_REST_Request $request ) {
$data = $this
->login_action
->authenticate( $request['code'] );
return new WP_REST_Response( $data, $data->status );
}
/**
* Sets the SEMrush country code option.
*
* @param WP_REST_Request $request The request. This request should have a country code param set.
*
* @return WP_REST_Response The response.
*/
public function set_country_code_option( WP_REST_Request $request ) {
$data = $this
->options_action
->set_country_code( $request['country_code'] );
return new WP_REST_Response( $data, $data->status );
}
/**
* Checks if a valid code was returned.
*
* @param string $code The code to check.
*
* @return bool Whether or not the code is valid.
*/
public function has_valid_code( $code ) {
return $code !== '';
}
/**
* Checks if a valid keyphrase is provided.
*
* @param string $keyphrase The keyphrase to check.
*
* @return bool Whether or not the keyphrase is valid.
*/
public function has_valid_keyphrase( $keyphrase ) {
return \trim( $keyphrase ) !== '';
}
/**
* Gets the related keyphrases based on the passed keyphrase and database code.
*
* @param WP_REST_Request $request The request. This request should have a keyphrase and country_code param set.
*
* @return WP_REST_Response The response.
*/
public function get_related_keyphrases( WP_REST_Request $request ) {
$data = $this
->phrases_action
->get_related_keyphrases(
$request['keyphrase'],
$request['country_code']
);
return new WP_REST_Response( $data, $data->status );
}
/**
* Checks if a valid country code was submitted.
*
* @param string $country_code The country code to check.
*
* @return bool Whether or not the country code is valid.
*/
public function has_valid_country_code( $country_code ) {
return ( $country_code !== '' && \preg_match( '/^[a-z]{2}$/', $country_code ) === 1 );
}
/**
* Whether or not the current user is allowed to edit post/pages and thus use the SEMrush integration.
*
* @return bool Whether or not the current user is allowed to use SEMrush.
*/
public function can_use_semrush() {
return \current_user_can( 'edit_posts' ) || \current_user_can( 'edit_pages' );
}
}