class-social-facebook.php
13.3 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
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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
<?php
/**
* @package WPSEO
* @subpackage Admin
*/
/**
* The Facebook insights class, this will add some listeners to fetch GET params
*/
class Yoast_Social_Facebook {
/**
* @var array - The options for social
*/
private $options;
/**
* @var Yoast_Social_Facebook_Form
*/
private $form;
/**
* Setting the options and define the listener to fetch $_GET values
*/
public function __construct() {
$this->options = get_option( 'wpseo_social' );
$this->get_listener();
$this->form = new Yoast_Social_Facebook_Form();
}
/**
* Returns the output from the form class
*/
public function show_form() {
$this->form->show_form();
}
/**
* Adding a new admin
*
* @param string $admin_name Name string.
* @param string $admin_id ID string.
*
* @return string
*/
public function add_admin( $admin_name, $admin_id ) {
$success = 0;
// If one of the fields is empty.
if ( empty( $admin_name ) || empty( $admin_id ) ) {
$response_body = $this->get_response_body( 'not_present' );
}
else {
$admin_id = $this->parse_admin_id( $admin_id );
if ( ! isset( $this->options['fb_admins'][ $admin_id ] ) ) {
$name = sanitize_text_field( urldecode( $admin_name ) );
$admin_id = sanitize_text_field( $admin_id );
if ( preg_match( '/[0-9]+?/', $admin_id ) && preg_match( '/[\w\s]+?/', $name ) ) {
$this->options['fb_admins'][ $admin_id ]['name'] = $name;
$this->options['fb_admins'][ $admin_id ]['link'] = urldecode( 'http://www.facebook.com/' . $admin_id );
$this->save_options();
$success = 1;
$response_body = $this->form->get_admin_link( $admin_id, $this->options['fb_admins'][ $admin_id ] );
}
else {
$response_body = $this->get_response_body( 'invalid_format' );
}
}
else {
$response_body = $this->get_response_body( 'already_exists' );
}
}
return wp_json_encode(
array(
'success' => $success,
'html' => $response_body,
)
);
}
/**
* Fetches the id if the full meta tag or a full url was given
*
* @param string $admin_id Admin ID input string to process.
*
* @return string
*/
private function parse_admin_id( $admin_id ) {
if ( preg_match( '/^\<meta property\=\"fb:admins\" content\=\"(\d+?)\"/', $admin_id, $matches_full_meta ) ) {
return $matches_full_meta[1];
}
return trim( parse_url( $admin_id, PHP_URL_PATH ), '/' );
}
/**
* Returns a different response body depending on the response type
*
* @param string $type Type string.
*
* @return string
*/
private function get_response_body( $type ) {
switch ( $type ) {
case 'not_present':
$return = "<p class='notice-error notice'><span>" . __( 'Please make sure both fields are filled.', 'wordpress-seo' ) . '</span></p>';
break;
case 'invalid_format':
$return = "<p class='notice-error notice'><span>" . __( 'Your input contains invalid characters. Please make sure both fields are filled in correctly.', 'wordpress-seo' ) . '</span></p>';
break;
case 'already_exists':
$return = "<p class='notice-error notice'><span>" . __( 'This Facebook user has already been added as an admin.', 'wordpress-seo' ) . '</span></p>';
break;
default:
$return = '';
break;
}
return $return;
}
/**
* This method will hook into the defined get params
*/
private function get_listener() {
if ( $delfbadmin = filter_input( INPUT_GET, 'delfbadmin' ) ) {
$this->delete_admin( $delfbadmin );
}
elseif ( filter_input( INPUT_GET, 'fbclearall' ) ) {
$this->clear_all();
}
}
/**
* Deletes the admin from the options
*
* @param string $delfbadmin Facebook admin ID.
*/
private function delete_admin( $delfbadmin ) {
$this->verify_nonce( 'delfbadmin' );
$admin_id = sanitize_text_field( $delfbadmin );
if ( isset( $this->options['fb_admins'][ $admin_id ] ) ) {
$fbadmin = $this->options['fb_admins'][ $admin_id ]['name'];
unset( $this->options['fb_admins'][ $admin_id ] );
$this->save_options();
$this->success_notice( sprintf( __( 'Successfully removed admin %s', 'wordpress-seo' ), $fbadmin ) );
unset( $fbadmin );
}
unset( $admin_id );
// Clean up the referrer url for later use.
if ( ! empty( $_SERVER['REQUEST_URI'] ) ) {
$this->cleanup_referrer_url( 'nonce', 'delfbadmin' );
}
}
/**
* Clear all the facebook that has been set already
*/
private function clear_all() {
$this->verify_nonce( 'fbclearall' );
// Reset to defaults, don't unset as otherwise the old values will be retained.
$this->options['fb_admins'] = WPSEO_Options::get_default( 'wpseo_social', 'fb_admins' );
$this->save_options();
$this->success_notice( __( 'Successfully cleared all Facebook Data', 'wordpress-seo' ) );
// Clean up the referrer url for later use.
if ( ! empty( $_SERVER['REQUEST_URI'] ) ) {
$this->cleanup_referrer_url( 'nonce', 'fbclearall' );
}
}
/**
* Clean up the request_uri. The given params are the params that will be removed from the URL
*/
private function cleanup_referrer_url() {
$_SERVER['REQUEST_URI'] = remove_query_arg(
func_get_args(),
sanitize_text_field( $_SERVER['REQUEST_URI'] )
);
}
/**
* When something is going well, show a success notice
*
* @param string $notice_text Message string.
*/
private function success_notice( $notice_text ) {
add_settings_error( 'yoast_wpseo_social_options', 'success', $notice_text, 'updated' );
}
/**
* Verify the nonce from the URL with the saved nonce
*
* @param string $nonce_name Nonce name string.
*/
private function verify_nonce( $nonce_name ) {
if ( wp_verify_nonce( filter_input( INPUT_GET, 'nonce' ), $nonce_name ) != 1 ) {
die( "I don't think that's really nice of you!." );
}
}
/**
* Saving the options
*/
private function save_options() {
update_option( 'wpseo_social', $this->options );
}
}
/**
* This will display the HTML for the facebook insights part
*/
class Yoast_Social_Facebook_Form {
/**
* @var array - The options for social
*/
private $options;
/**
* @var array - The repository for the buttons that will be shown
*/
private $buttons = array();
/**
* @var string - The URL to link to
*/
private $admin_url = 'admin.php?page=wpseo_social';
/**
* Setting the options and call the methods to display everything
*/
public function __construct() {
$this->options = get_option( 'wpseo_social' );
}
/**
* Returns the output-property
*/
public function show_form() {
$this
->form_head()
->manage_user_admin()
->form_thickbox()
->show_buttons()
->manage_app_as_admin();
}
/**
* Parses the admin_link
*
* @param string $admin_id Facebook admin ID string.
* @param array $admin Admin data array.
* @param string|bool $nonce Optional nonce string.
*
* @return string
*/
public function get_admin_link( $admin_id, $admin, $nonce = false ) {
if ( $nonce === false ) {
$nonce = $this->get_delete_nonce();
}
$return = '<li><a target="_blank" href="' . esc_url( $admin['link'] ) . '">' . esc_html( $admin['name'] ) . '</a>';
$return .= ' - <strong><a href="' . $this->admin_delete_link( $admin_id, $nonce ) . '">X</a></strong></li>';
return $return;
}
/**
* SHow the top of the social insights part of the page
*
* @return $this
*/
private function form_head() {
echo '<h2>' . esc_html__( 'Facebook Insights and Admins', 'wordpress-seo' ) . '</h2>';
echo '<p>', sprintf(
/* translators: %1$s and %2$s expand to a link to Facebook Insights */
esc_html__( 'To be able to access %1$sFacebook Insights%2$s for your site, you need to specify a Facebook Admin. This can be a user. If you have an app for your site, you could use that as well.', 'wordpress-seo' ),
'<a target="_blank" href="https://www.facebook.com/insights">',
'</a>'
);
echo ' ';
/* translators: %1$s and %2$s expand to a link to the Yoast Knowledge Base */
printf( __( 'More info can be found %1$son our knowledge base%2$s.', 'wordpress-seo' ), '<a target="_blank" href="http://kb.yoast.com/article/254-gaining-access-to-facebook-insights">', '</a>' );
echo '</p>';
return $this;
}
/**
* Show the form inside the thickbox
*/
private function form_thickbox() {
// Adding the thickbox.
add_thickbox();
echo '<div id="add_facebook_admin" class="hidden">';
echo "<div class='form-wrap wpseo_content_wrapper wpseo-add-fb-admin-form-wrap'>";
echo '<p>';
/* translators: %1$s and %2$s expand to a link to Facebook Insights */
printf( __( 'To be able to access %1$sFacebook Insights%2$s, you need to add a user here. The name is used for reference only, the ID is used for verification.', 'wordpress-seo' ), '<a target="_blank" href="https://www.facebook.com/insights">', '</a>' );
echo '</p>';
echo '<p>';
/* translators: %1$s and %2$s expand to a link to the Yoast Knowledge Base */
printf( __( 'If you don\'t know where to find the needed ID, see %1$sthis knowledge base article%2$s.', 'wordpress-seo' ), '<a target="_blank" href="http://kb.yoast.com/article/254-gaining-access-to-facebook-insights">', '</a>' );
echo '</p>';
echo '<div class="form-field form-required">';
echo '<label for="fb_admin_name">' . __( 'Admin\'s name:', 'wordpress-seo' ) . '</label>';
echo '<input type="text" id="fb_admin_name" name="fb_admin_name" value="" maxlength="255" />';
echo '</div>';
echo '<div class="form-field form-required">';
echo '<label for="fb_admin_id">' . __( 'Admin\'s Facebook user ID:', 'wordpress-seo' ) . '</label>';
echo '<input type="text" id="fb_admin_id" name="fb_admin_id" value="" maxlength="255" />';
echo '</div>';
echo "<p class='submit'>";
echo '<input type="hidden" name="fb_admin_nonce" value="' . wp_create_nonce( 'wpseo_fb_admin_nonce' ) . '" />';
echo '<input type="submit" value="' . __( 'Add Facebook admin', 'wordpress-seo' ) . '" class="button button-primary" onclick="javascript:wpseo_add_fb_admin();" />';
echo '</p>';
echo '</div>';
echo '</div>';
return $this;
}
/**
* Display the buttons to add an admin or add another admin from Facebook and display the admin that has been added already.
*
* @return $this
*/
private function manage_user_admin() {
$button_text = __( 'Add Facebook admin', 'wordpress-seo' );
$nonce = false;
$class_attr = ' class="hidden"';
if ( is_array( $this->options['fb_admins'] ) && $this->options['fb_admins'] !== array() ) {
$nonce = $this->get_delete_nonce();
$button_text = __( 'Add Another Facebook Admin', 'wordpress-seo' );
$class_attr = '';
}
echo "<div id='connected_fb_admins'{$class_attr}>";
echo '<p>' . __( 'Currently connected Facebook admins:', 'wordpress-seo' ) . '</p>';
echo '<ul id="user_admin">';
$this->show_user_admins( $nonce );
echo '</ul>';
echo '</div>';
unset( $nonce );
$this->add_button(
array(
'url' => '#TB_inline?width=600&height=350&inlineId=add_facebook_admin',
'value' => $button_text,
'class' => 'thickbox',
'title' => $button_text,
)
);
return $this;
}
/**
* Show input field to set a facebook apps as an admin
*
* @return $this
*/
private function manage_app_as_admin() {
echo '<div class="clear"></div><br />';
Yoast_Form::get_instance()->textinput( 'fbadminapp', __( 'Facebook App ID', 'wordpress-seo' ) );
return $this;
}
/**
* Loop through the fb-admins to parse the output for them
*
* @param string $nonce Nonce string.
*/
private function show_user_admins( $nonce ) {
foreach ( $this->options['fb_admins'] as $admin_id => $admin ) {
echo $this->get_admin_link( $admin_id, $admin, $nonce );
}
}
/**
* Parsing the link that directs to the admin removal
*
* @param string $admin_id Facebook admin ID.
* @param string $nonce Nonce string.
*
* @return string
*/
private function admin_delete_link( $admin_id, $nonce ) {
return esc_url(
add_query_arg(
array(
'delfbadmin' => esc_attr( $admin_id ),
'nonce' => $nonce,
),
admin_url( $this->admin_url . '#top#facebook' )
)
);
}
/**
* Adding a button to the button property
*
* @param array $args Arguments data array.
*/
private function add_button( $args ) {
$args = wp_parse_args(
$args,
array(
'url' => '',
'value' => '',
'class' => '',
'id' => '',
'title' => '',
)
);
$this->buttons[] = '<a title="' . esc_attr( $args['title'] ) . '" id="' . esc_attr( $args['id'] ) . '" class="button' . ' ' . esc_attr( $args['class'] ) . '" href="' . esc_url( $args['url'] ) . '">' . esc_html( $args['value'] ) . '</a>';
}
/**
* Showing the buttons
*/
private function show_buttons() {
if ( $this->get_clearall() ) {
$this->add_button(
array(
'url' => add_query_arg( array(
'nonce' => wp_create_nonce( 'fbclearall' ),
'fbclearall' => 'true',
), admin_url( $this->admin_url . '#top#facebook' ) ),
'value' => __( 'Clear all Facebook Data', 'wordpress-seo' ),
)
);
}
if ( is_array( $this->buttons ) && $this->buttons !== array() ) {
echo '<p class="fb-buttons">' . implode( '', $this->buttons ) . '</p>';
}
return $this;
}
/**
* Check if the clear button should be displayed. This is based on the set options.
*
* @return bool
*/
private function get_clearall() {
return is_array( $this->options['fb_admins'] ) && $this->options['fb_admins'] !== array();
}
/**
* Creates nonce for removal link
*
* @return mixed
*/
private function get_delete_nonce() {
return wp_create_nonce( 'delfbadmin' );
}
}