PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 13.4.4
Jetpack – WP Security, Backup, Speed, & Growth v13.4.4
16.2-beta 12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 13.9.2 14.0.1 14.1.1 14.2.2 14.3.1 All 501 releases
jetpack / modules / sharedaddy / sharing-service.php

sharing-service.php in Jetpack – WP Security, Backup, Speed, & Growth 13.4.4, at modules/sharedaddy/sharing-service.php

1,278 lines 34.1 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2 /**
3 * Utilities to register and interact with a sharing service.
4 *
5 * Sharing_Service gets info about a service.
6 * Sharing_Service_Total and Sharing_Post_Total get stats data.
7 *
8 * @package automattic/jetpack
9 *
10 * phpcs:disable Generic.Files.OneObjectStructurePerFile.MultipleFound
11 */
12
13 // phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files.
14
15 use Automattic\Jetpack\Assets;
16 use Automattic\Jetpack\Redirect;
17 use Automattic\Jetpack\Status;
18 use Automattic\Jetpack\Sync\Settings;
19
20 require_once __DIR__ . '/sharing-sources.php';
21
22 define( 'WP_SHARING_PLUGIN_VERSION', JETPACK__VERSION );
23
24 /**
25 * Interact with a sharing service.
26 */
27 class Sharing_Service {
28 /**
29 * Should the service be available globally?
30 *
31 * @var bool
32 */
33 private $global = false;
34
35 /**
36 * Default sharing label.
37 *
38 * @var string
39 */
40 public $default_sharing_label = '';
41
42 /**
43 * Initialize the sharing service.
44 * Only run this method once upon module loading.
45 *
46 * @return void
47 */
48 public static function init() {
49 add_filter( 'the_content', 'sharing_display', 19 );
50 add_filter( 'the_excerpt', 'sharing_display', 19 );
51 }
52
53 /**
54 * Constructor.
55 */
56 public function __construct() {
57 $this->default_sharing_label = __( 'Share this:', 'jetpack' );
58 }
59
60 /**
61 * Gets a generic list of all services, without any config
62 *
63 * @return array
64 */
65 public function get_all_services_blog() {
66 $options = get_option( 'sharing-options' );
67 $all = $this->get_all_services();
68 $services = array();
69
70 foreach ( $all as $id => $name ) {
71 if ( isset( $all[ $id ] ) ) {
72 $config = array();
73
74 // Pre-load custom modules otherwise they won't know who they are
75 if ( str_starts_with( $id, 'custom-' ) && is_array( $options[ $id ] ) ) {
76 $config = $options[ $id ];
77 }
78
79 $services[ $id ] = new $all[ $id ]( $id, $config );
80 }
81 }
82
83 return $services;
84 }
85
86 /**
87 * Gets a list of all available service names and classes
88 *
89 * @param bool $include_custom Include custom sharing services.
90 *
91 * @return array
92 */
93 public function get_all_services( $include_custom = true ) {
94 // Default services
95 // if you update this list, please update the REST API tests
96 // in bin/tests/api/suites/SharingTest.php
97 $services = array(
98 'print' => 'Share_Print',
99 'email' => 'Share_Email',
100 'facebook' => 'Share_Facebook',
101 'linkedin' => 'Share_LinkedIn',
102 'reddit' => 'Share_Reddit',
103 'twitter' => 'Share_Twitter',
104 'tumblr' => 'Share_Tumblr',
105 'pinterest' => 'Share_Pinterest',
106 'pocket' => 'Share_Pocket',
107 'telegram' => 'Share_Telegram',
108 'threads' => 'Share_Threads',
109 'jetpack-whatsapp' => 'Jetpack_Share_WhatsApp',
110 'mastodon' => 'Share_Mastodon',
111 'nextdoor' => 'Share_Nextdoor',
112 'x' => 'Share_X',
113 'bluesky' => 'Share_Bluesky',
114 // deprecated.
115 'skype' => 'Share_Skype',
116 );
117
118 if ( is_multisite() && is_plugin_active( 'press-this/press-this-plugin.php' ) ) {
119 $services['press-this'] = 'Share_PressThis';
120 }
121
122 if ( $include_custom ) {
123 // Add any custom services in
124 $options = $this->get_global_options();
125 foreach ( (array) $options['custom'] as $custom_id ) {
126 $services[ $custom_id ] = 'Share_Custom';
127 }
128 }
129
130 /**
131 * Filters the list of available Sharing Services.
132 *
133 * @module sharedaddy
134 *
135 * @since 1.1.0
136 *
137 * @param array $services Array of all available Sharing Services.
138 */
139 return apply_filters( 'sharing_services', $services );
140 }
141
142 /**
143 * Save a new custom sharing service.
144 *
145 * @param string $label Service name.
146 * @param string $url Service sharing URL.
147 * @param string $icon Service icon.
148 *
149 * @return bool|Share_Custom
150 */
151 public function new_service( $label, $url, $icon ) {
152 // Validate.
153 $label = trim( wp_html_excerpt( wp_kses( $label, array() ), 30 ) );
154 $url = trim( esc_url_raw( $url ) );
155 $icon = trim( esc_url_raw( $icon ) );
156
157 if ( $label && $url && $icon ) {
158 $options = get_option( 'sharing-options' );
159 if ( ! is_array( $options ) ) {
160 $options = array();
161 }
162
163 $service_id = 'custom-' . time();
164
165 // Add a new custom service
166 $options['global']['custom'][] = $service_id;
167 if ( false !== $this->global ) {
168 $this->global['custom'][] = $service_id;
169 }
170
171 update_option( 'sharing-options', $options );
172
173 // Create a custom service and set the options for it
174 $service = new Share_Custom(
175 $service_id,
176 array(
177 'name' => $label,
178 'url' => $url,
179 'icon' => $icon,
180 )
181 );
182 $this->set_service( $service_id, $service );
183
184 // Return the service
185 return $service;
186 }
187
188 return false;
189 }
190
191 /**
192 * Delete a sharing service.
193 *
194 * @param string $service_id Service ID.
195 *
196 * @return bool
197 */
198 public function delete_service( $service_id ) {
199 $options = get_option( 'sharing-options' );
200 if ( isset( $options[ $service_id ] ) ) {
201 unset( $options[ $service_id ] );
202 }
203
204 $key = array_search( $service_id, $options['global']['custom'], true );
205 if ( $key !== false ) {
206 unset( $options['global']['custom'][ $key ] );
207 }
208
209 update_option( 'sharing-options', $options );
210 return true;
211 }
212
213 /**
214 * Save enabled sharing services.
215 *
216 * @param array $visible Visible sharing services.
217 * @param array $hidden Hidden sharing services (available under a dropdown).
218 *
219 * @return bool
220 */
221 public function set_blog_services( array $visible, array $hidden ) {
222 $services = $this->get_all_services();
223 // Validate the services
224 $available = array_keys( $services );
225
226 // Only allow services that we have defined
227 $hidden = array_intersect( $hidden, $available );
228 $visible = array_intersect( $visible, $available );
229
230 // Ensure we don't have the same ones in hidden and visible
231 $hidden = array_diff( $hidden, $visible );
232
233 /**
234 * Control the state of the list of sharing services.
235 *
236 * @module sharedaddy
237 *
238 * @since 1.1.0
239 *
240 * @param array $args {
241 * Array of options describing the state of the sharing services.
242 *
243 * @type array $services List of all available service names and classes.
244 * @type array $available Validated list of all available service names and classes.
245 * @type array $hidden List of services hidden behind a "More" button.
246 * @type array $visible List of visible services.
247 * @type array $this->get_blog_services() Array of Sharing Services currently enabled.
248 * }
249 */
250 do_action(
251 'sharing_get_services_state',
252 array(
253 'services' => $services,
254 'available' => $available,
255 'hidden' => $hidden,
256 'visible' => $visible,
257 'currently_enabled' => $this->get_blog_services(),
258 )
259 );
260
261 return update_option(
262 'sharing-services',
263 array(
264 'visible' => $visible,
265 'hidden' => $hidden,
266 )
267 );
268 }
269
270 /**
271 * Get information about enabled sharing services on the site.
272 *
273 * @return array
274 */
275 public function get_blog_services() {
276 $options = get_option( 'sharing-options' );
277 $enabled = get_option( 'sharing-services' );
278 $services = $this->get_all_services();
279
280 /**
281 * Check if options exist and are well formatted.
282 * This avoids issues on sites with corrupted options.
283 *
284 * @see https://github.com/Automattic/jetpack/issues/6121
285 */
286 if ( ! is_array( $options ) || ! isset( $options['button_style'] ) || ! isset( $options['global'] ) ) {
287 $global_options = array( 'global' => $this->get_global_options() );
288 $options = is_array( $options )
289 ? array_merge( $options, $global_options )
290 : $global_options;
291 }
292
293 $global = $options['global'];
294
295 // Default services
296 if ( ! is_array( $enabled ) ) {
297 $enabled = array(
298 'visible' => array(
299 'facebook',
300 'x',
301 ),
302 'hidden' => array(),
303 );
304
305 /**
306 * Filters the list of default Sharing Services.
307 *
308 * @module sharedaddy
309 *
310 * @since 1.1.0
311 *
312 * @param array $enabled Array of default Sharing Services.
313 */
314 $enabled = apply_filters( 'sharing_default_services', $enabled );
315 }
316
317 // Cleanup after any filters that may have produced duplicate services
318 if ( is_array( $enabled['visible'] ) ) {
319 $enabled['visible'] = array_unique( $enabled['visible'] );
320 } else {
321 $enabled['visible'] = array();
322 }
323
324 if ( is_array( $enabled['hidden'] ) ) {
325 $enabled['hidden'] = array_unique( $enabled['hidden'] );
326 } else {
327 $enabled['hidden'] = array();
328 }
329
330 // Form the enabled services
331 $blog = array(
332 'visible' => array(),
333 'hidden' => array(),
334 );
335
336 foreach ( $blog as $area => $stuff ) {
337 foreach ( (array) $enabled[ $area ] as $service ) {
338 if ( isset( $services[ $service ] ) ) {
339 if ( ! isset( $options[ $service ] ) || ! is_array( $options[ $service ] ) ) {
340 $options[ $service ] = array();
341 }
342 $blog[ $area ][ $service ] = new $services[ $service ]( $service, array_merge( $global, $options[ $service ] ) );
343 }
344 }
345 }
346
347 /**
348 * Filters the list of enabled Sharing Services.
349 *
350 * @module sharedaddy
351 *
352 * @since 1.1.0
353 *
354 * @param array $blog Array of enabled Sharing Services.
355 */
356 $blog = apply_filters( 'sharing_services_enabled', $blog );
357
358 // Add CSS for NASCAR
359 if ( ( is_countable( $blog['visible'] ) && count( $blog['visible'] ) ) || ( is_countable( $blog['hidden'] ) && count( $blog['hidden'] ) ) ) {
360 add_filter( 'post_flair_block_css', 'post_flair_service_enabled_sharing' );
361 }
362
363 // Convenience for checking if a service is present
364 $blog['all'] = array_flip( array_merge( array_keys( $blog['visible'] ), array_keys( $blog['hidden'] ) ) );
365 return $blog;
366 }
367
368 /**
369 * Get information about a specific enabled sharing service.
370 *
371 * @param string $service_name Service name.
372 *
373 * @return bool|Sharing_Source
374 */
375 public function get_service( $service_name ) {
376 $services = $this->get_blog_services();
377
378 if ( isset( $services['visible'][ $service_name ] ) ) {
379 return $services['visible'][ $service_name ];
380 }
381
382 if ( isset( $services['hidden'][ $service_name ] ) ) {
383 return $services['hidden'][ $service_name ];
384 }
385
386 return false;
387 }
388
389 /**
390 * Update global sharing options.
391 *
392 * @param array $data Array of new sharing options to save.
393 */
394 public function set_global_options( $data ) {
395 $options = get_option( 'sharing-options' );
396
397 // No options yet.
398 if ( ! is_array( $options ) ) {
399 $options = array();
400 }
401
402 // Defaults.
403 $options['global'] = array(
404 'button_style' => 'icon-text',
405 'sharing_label' => $this->default_sharing_label,
406 'open_links' => 'same',
407 'show' => ! isset( $options['global'] ) ? array( 'post', 'page' ) : array(),
408 'custom' => isset( $options['global']['custom'] ) ? $options['global']['custom'] : array(),
409 );
410
411 /**
412 * Filters global sharing settings.
413 *
414 * @module sharedaddy
415 *
416 * @since 1.1.0
417 *
418 * @param array $options['global'] Array of global sharing settings.
419 */
420 $options['global'] = apply_filters( 'sharing_default_global', $options['global'] );
421
422 // Validate options and set from our data
423 if (
424 isset( $data['button_style'] )
425 && in_array( $data['button_style'], array( 'icon-text', 'icon', 'text', 'official' ), true )
426 ) {
427 $options['global']['button_style'] = $data['button_style'];
428 }
429
430 if ( isset( $data['sharing_label'] ) ) {
431 if ( $this->default_sharing_label === $data['sharing_label'] ) {
432 $options['global']['sharing_label'] = false;
433 } else {
434 $options['global']['sharing_label'] = trim( wp_kses( stripslashes( $data['sharing_label'] ), array() ) );
435 }
436 }
437
438 if (
439 isset( $data['open_links'] )
440 && in_array( $data['open_links'], array( 'new', 'same' ), true )
441 ) {
442 $options['global']['open_links'] = $data['open_links'];
443 }
444
445 $shows = array_values( get_post_types( array( 'public' => true ) ) );
446 $shows[] = 'index';
447 if ( isset( $data['show'] ) ) {
448 if ( is_scalar( $data['show'] ) ) {
449 switch ( $data['show'] ) {
450 case 'posts':
451 $data['show'] = array( 'post', 'page' );
452 break;
453 case 'index':
454 $data['show'] = array( 'index' );
455 break;
456 case 'posts-index':
457 $data['show'] = array( 'post', 'page', 'index' );
458 break;
459 }
460 }
461
462 $data['show'] = array_intersect( $data['show'], $shows );
463 if ( $data['show'] ) {
464 $options['global']['show'] = $data['show'];
465 }
466 }
467
468 update_option( 'sharing-options', $options );
469 return $options['global'];
470 }
471
472 /**
473 * Get global sharing options for the site.
474 *
475 * @return array
476 */
477 public function get_global_options() {
478 if ( $this->global === false ) {
479 $options = get_option( 'sharing-options' );
480
481 if ( is_array( $options ) && isset( $options['global'] ) && is_array( $options['global'] ) ) {
482 $this->global = $options['global'];
483 } else {
484 $this->global = $this->set_global_options( $options );
485 }
486 }
487
488 if ( ! isset( $this->global['show'] ) ) {
489 $this->global['show'] = array( 'post', 'page' );
490 } elseif ( is_scalar( $this->global['show'] ) ) {
491 switch ( $this->global['show'] ) {
492 case 'posts':
493 $this->global['show'] = array( 'post', 'page' );
494 break;
495 case 'index':
496 $this->global['show'] = array( 'index' );
497 break;
498 case 'posts-index':
499 $this->global['show'] = array( 'post', 'page', 'index' );
500 break;
501 }
502 }
503
504 if ( false === $this->global['sharing_label'] || $this->global['sharing_label'] === 'Share this:' ) {
505 $this->global['sharing_label'] = $this->default_sharing_label;
506 }
507
508 return $this->global;
509 }
510
511 /**
512 * Save a sharing service for use.
513 *
514 * @param int $id Sharing unique ID.
515 * @param Sharing_Source $service Sharing service.
516 *
517 * @return void
518 */
519 public function set_service( $id, Sharing_Source $service ) {
520 // Update the options for this service
521 $options = get_option( 'sharing-options' );
522
523 // No options yet
524 if ( ! is_array( $options ) ) {
525 $options = array();
526 }
527
528 /**
529 * Get the state of a sharing button.
530 *
531 * @module sharedaddy
532 *
533 * @since 1.1.0
534 *
535 * @param array $args {
536 * State of a sharing button.
537 *
538 * @type string $id Service ID.
539 * @type array $options Array of all sharing options.
540 * @type array $service Details about a service.
541 * }
542 */
543 do_action(
544 'sharing_get_button_state',
545 array(
546 'id' => $id,
547 'options' => $options,
548 'service' => $service,
549 )
550 );
551
552 $options[ $id ] = $service->get_options();
553
554 update_option( 'sharing-options', array_filter( $options ) );
555 }
556
557 /**
558 * Get stats for a site, a post, or a sharing service.
559 * Soon to come to a .org plugin near you!
560 *
561 * @param string|bool $service_name Service name.
562 * @param int|bool $post_id Post ID.
563 * @param int|bool $_blog_id Blog ID.
564 *
565 * @return int
566 */
567 public function get_total( $service_name = false, $post_id = false, $_blog_id = false ) {
568 global $wpdb, $blog_id;
569 if ( ! $_blog_id ) {
570 $_blog_id = $blog_id;
571 }
572 if ( $service_name === false ) {
573 if ( $post_id > 0 ) {
574 // total number of shares for this post
575 $sql = $wpdb->prepare( 'SELECT SUM( count ) FROM sharing_stats WHERE blog_id = %d AND post_id = %d', $_blog_id, $post_id );
576 $cache_key = "sharing_service_get_total_b{$_blog_id}_p{$post_id}";
577 } else {
578 // total number of shares for this blog
579 $sql = $wpdb->prepare( 'SELECT SUM( count ) FROM sharing_stats WHERE blog_id = %d', $_blog_id );
580 $cache_key = "sharing_service_get_total_b{$_blog_id}";
581 }
582 } elseif ( $post_id > 0 ) {
583 $sql = $wpdb->prepare( 'SELECT SUM( count ) FROM sharing_stats WHERE blog_id = %d AND post_id = %d AND share_service = %s', $_blog_id, $post_id, $service_name );
584 $cache_key = "sharing_service_get_total_b{$_blog_id}_p{$post_id}_s{$service_name}";
585 } else {
586 $sql = $wpdb->prepare( 'SELECT SUM( count ) FROM sharing_stats WHERE blog_id = %d AND share_service = %s', $_blog_id, $service_name );
587 $cache_key = "sharing_service_get_total_b{$_blog_id}_s{$service_name}";
588 }
589
590 $ret = wp_cache_get( $cache_key, 'sharing' );
591 if ( $ret === false ) {
592 // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared, WordPress.DB.DirectDatabaseQuery.DirectQuery -- Prepared above.
593 $ret = (int) $wpdb->get_var( $sql );
594 wp_cache_set( $cache_key, $ret, 'sharing', 5 * MINUTE_IN_SECONDS );
595 }
596 return $ret;
597 }
598
599 /**
600 * Get total stats for a site, for all sharing services.
601 *
602 * @param int|bool $post_id Post ID.
603 *
604 * @return array
605 */
606 public function get_services_total( $post_id = false ) {
607 $totals = array();
608 $services = $this->get_blog_services();
609
610 if ( ! empty( $services ) && isset( $services['all'] ) ) {
611 foreach ( $services['all'] as $key => $value ) {
612 $totals[ $key ] = new Sharing_Service_Total( $key, $this->get_total( $key, $post_id ) );
613 }
614 }
615 usort( $totals, array( 'Sharing_Service_Total', 'cmp' ) );
616
617 return $totals;
618 }
619
620 /**
621 * Get sharing stats for all posts on the site.
622 *
623 * @return array
624 */
625 public function get_posts_total() {
626 $totals = array();
627 global $wpdb, $blog_id;
628
629 $cache_key = "sharing_service_get_posts_total_{$blog_id}";
630 $my_data = wp_cache_get( $cache_key, 'sharing' );
631 if ( $my_data === false ) {
632 $my_data = $wpdb->get_results( $wpdb->prepare( 'SELECT post_id as id, SUM( count ) as total FROM sharing_stats WHERE blog_id = %d GROUP BY post_id ORDER BY count DESC ', $blog_id ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
633 wp_cache_set( $cache_key, $my_data, 'sharing', 5 * MINUTE_IN_SECONDS );
634 }
635
636 if ( ! empty( $my_data ) ) {
637 foreach ( $my_data as $row ) {
638 $totals[] = new Sharing_Post_Total( $row->id, $row->total );
639 }
640 }
641
642 usort( $totals, array( 'Sharing_Post_Total', 'cmp' ) );
643
644 return $totals;
645 }
646 }
647
648 /**
649 * Get stats for a specific sharing service.
650 */
651 class Sharing_Service_Total {
652 /**
653 * Sharing service ID.
654 *
655 * @var int
656 */
657 public $id = '';
658
659 /**
660 * Service name.
661 *
662 * @var string
663 */
664 public $name = '';
665
666 /**
667 * Sharing service name.
668 *
669 * @var string
670 */
671 public $service = '';
672
673 /**
674 * Total number of shares for this service.
675 *
676 * @var string
677 */
678 public $total = 0;
679
680 /**
681 * Constructor.
682 *
683 * @param int $id Service ID.
684 * @param int $total Total shares.
685 */
686 public function __construct( $id, $total ) {
687 $services = new Sharing_Service();
688 $this->id = esc_html( $id );
689 $this->service = $services->get_service( $id );
690 $this->total = (int) $total;
691
692 $this->name = $this->service->get_name();
693 }
694
695 /**
696 * Compare total shares between 2 posts.
697 *
698 * @param object $a Sharing_Service_Total object.
699 * @param object $b Sharing_Service_Total object.
700 *
701 * @return int -1, 0, or 1 if $a is <, =, or > $b
702 */
703 public static function cmp( $a, $b ) {
704 if ( $a->total === $b->total ) {
705 return $b->name <=> $a->name;
706 }
707 return $b->total <=> $a->total;
708 }
709 }
710
711 /**
712 * Get sharing stats for a specific post.
713 */
714 class Sharing_Post_Total {
715 /**
716 * Sharing service ID.
717 *
718 * @var int
719 */
720 public $id = 0;
721
722 /**
723 * Total shares.
724 *
725 * @var int
726 */
727 public $total = 0;
728
729 /**
730 * Post title.
731 *
732 * @var string
733 */
734 public $title = '';
735
736 /**
737 * Post permalink.
738 *
739 * @var string
740 */
741 public $url = '';
742
743 /**
744 * Constructor.
745 *
746 * @param int $id Service ID.
747 * @param int $total Total shares.
748 */
749 public function __construct( $id, $total ) {
750 $this->id = (int) $id;
751 $this->total = (int) $total;
752 $this->title = get_the_title( $this->id );
753 $this->url = get_permalink( $this->id );
754 }
755
756 /**
757 * Compare total shares between 2 posts.
758 *
759 * @param object $a Sharing_Post_Total object.
760 * @param object $b Sharing_Post_Total object.
761 *
762 * @return int -1, 0, or 1 if $a is <, =, or > $b
763 */
764 public static function cmp( $a, $b ) {
765 if ( $a->total === $b->total ) {
766 return $b->id <=> $a->id;
767 }
768 return $b->total <=> $a->total;
769 }
770 }
771
772 /**
773 * Populate sharing counts global with a post we want to count shares for.
774 *
775 * @param int $post_id Post ID.
776 *
777 * @return void
778 */
779 function sharing_register_post_for_share_counts( $post_id ) {
780 global $jetpack_sharing_counts;
781
782 if ( ! isset( $jetpack_sharing_counts ) || ! is_array( $jetpack_sharing_counts ) ) {
783 $jetpack_sharing_counts = array();
784 }
785
786 $jetpack_sharing_counts[ (int) $post_id ] = get_permalink( $post_id );
787 }
788
789 /**
790 * Determine whether we should load sharing scripts or not.
791 *
792 * @return bool
793 */
794 function sharing_maybe_enqueue_scripts() {
795 $sharer = new Sharing_Service();
796 $global_options = $sharer->get_global_options();
797
798 $enqueue = false;
799 if ( is_singular() && in_array( get_post_type(), $global_options['show'], true ) ) {
800 $enqueue = true;
801 } elseif (
802 in_array( 'index', $global_options['show'], true )
803 && (
804 is_home()
805 || is_front_page()
806 || is_archive()
807 || is_search()
808 || in_array( get_post_type(), $global_options['show'], true )
809 )
810 ) {
811 $enqueue = true;
812 }
813
814 /**
815 * Filter to decide when sharing scripts should be enqueued.
816 *
817 * @module sharedaddy
818 *
819 * @since 3.2.0
820 *
821 * @param bool $enqueue Decide if the sharing scripts should be enqueued.
822 */
823 return (bool) apply_filters( 'sharing_enqueue_scripts', $enqueue );
824 }
825
826 /**
827 * Add sharing JavaScript to the footer of a page.
828 *
829 * @return void
830 */
831 function sharing_add_footer() {
832 if (
833 class_exists( 'Jetpack_AMP_Support' )
834 && Jetpack_AMP_Support::is_amp_request()
835 ) {
836 return;
837 }
838
839 global $jetpack_sharing_counts;
840
841 if (
842 /**
843 * Filter all JavaScript output by the sharing module.
844 *
845 * @module sharedaddy
846 *
847 * @since 1.1.0
848 *
849 * @param bool true Control whether the sharing module should add any JavaScript to the site. Default to true.
850 */
851 apply_filters( 'sharing_js', true )
852 && sharing_maybe_enqueue_scripts()
853 ) {
854 if (
855 /**
856 * Filter the display of sharing counts next to the sharing buttons.
857 *
858 * @module sharedaddy
859 *
860 * @since 3.2.0
861 *
862 * @param bool true Control the display of counters next to the sharing buttons. Default to true.
863 */
864 apply_filters( 'jetpack_sharing_counts', true )
865 && is_array( $jetpack_sharing_counts )
866 && count( $jetpack_sharing_counts )
867 ) :
868 $sharing_post_urls = array_filter( $jetpack_sharing_counts );
869 if ( $sharing_post_urls ) :
870 ?>
871
872 <script type="text/javascript">
873 window.WPCOM_sharing_counts = <?php echo wp_json_encode( array_flip( $sharing_post_urls ) ); ?>;
874 </script>
875 <?php
876 endif;
877 endif;
878
879 wp_enqueue_script( 'sharing-js' );
880 $sharing_js_options = array(
881 'lang' => get_base_recaptcha_lang_code(),
882 /** This filter is documented in modules/sharedaddy/sharing-service.php */
883 'counts' => apply_filters( 'jetpack_sharing_counts', true ),
884 'is_stats_active' => Jetpack::is_module_active( 'stats' ),
885 );
886 wp_localize_script( 'sharing-js', 'sharing_js_options', $sharing_js_options );
887 }
888 $sharer = new Sharing_Service();
889 $enabled = $sharer->get_blog_services();
890 foreach ( array_merge( $enabled['visible'], $enabled['hidden'] ) as $service ) {
891 $service->display_footer();
892 }
893 }
894
895 /**
896 * Enqueue sharing CSS in head.
897 *
898 * @return void
899 */
900 function sharing_add_header() {
901 $sharer = new Sharing_Service();
902 $enabled = $sharer->get_blog_services();
903
904 foreach ( array_merge( $enabled['visible'], $enabled['hidden'] ) as $service ) {
905 $service->display_header();
906 }
907
908 if ( is_countable( $enabled['all'] ) && ( count( $enabled['all'] ) > 0 ) && sharing_maybe_enqueue_scripts() ) {
909 wp_enqueue_style( 'sharedaddy', plugin_dir_url( __FILE__ ) . 'sharing.css', array(), JETPACK__VERSION );
910 wp_enqueue_style( 'social-logos' );
911 }
912 }
913 add_action( 'wp_head', 'sharing_add_header', 1 );
914
915 /**
916 * Launch sharing requests on page load when a specific query string is used.
917 *
918 * @return void
919 */
920 function sharing_process_requests() {
921 global $post;
922
923 // Only process if: single post and share=X defined
924 if ( ( is_page() || is_single() ) && isset( $_GET['share'] ) && is_string( $_GET['share'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
925 $sharer = new Sharing_Service();
926
927 $service = $sharer->get_service( sanitize_text_field( wp_unslash( $_GET['share'] ) ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
928 if ( $service ) {
929 $service->process_request( $post, $_POST ); // phpcs:ignore WordPress.Security.NonceVerification.Missing
930 }
931 }
932 }
933 add_action( 'template_redirect', 'sharing_process_requests', 9 );
934
935 /**
936 * Gets the url to customise the sharing buttons in Calypso.
937 *
938 * @return string the customisation URL or null if it couldn't be determinde.
939 */
940 function get_sharing_buttons_customisation_url() {
941 return Redirect::get_url( 'calypso-marketing-sharing-buttons', array( 'site' => ( new Status() )->get_site_suffix() ) );
942 }
943
944 /**
945 * Append sharing links to text.
946 *
947 * @param string $text The original text to append sharing links onto.
948 * @param bool $echo Where to echo the text or return.
949 *
950 * @return string The original $text with, if conditions are met, the sharing links.
951 */
952 function sharing_display( $text = '', $echo = false ) {
953 global $post, $wp_current_filter;
954
955 if ( Settings::is_syncing() ) {
956 return $text;
957 }
958
959 if ( empty( $post ) ) {
960 return $text;
961 }
962
963 if ( ( is_preview() || is_admin() ) && ! ( defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
964 return $text;
965 }
966
967 // Prevent from rendering sharing buttons in block which is fetched from REST endpoint by editor
968 if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
969 return $text;
970 }
971
972 // Do not output sharing buttons for ActivityPub requests.
973 if (
974 function_exists( '\Activitypub\is_activitypub_request' )
975 && \Activitypub\is_activitypub_request()
976 ) {
977 return $text;
978 }
979
980 // Don't output flair on excerpts.
981 if ( in_array( 'get_the_excerpt', (array) $wp_current_filter, true ) ) {
982 return $text;
983 }
984
985 // Ensure we don't display sharing buttons on post excerpts that are hooked inside the post content
986 if ( in_array( 'the_excerpt', (array) $wp_current_filter, true ) &&
987 in_array( 'the_content', (array) $wp_current_filter, true ) ) {
988 return $text;
989 }
990
991 // Don't allow flair to be added to the_content more than once (prevent infinite loops).
992 $done = false;
993 foreach ( $wp_current_filter as $filter ) {
994 if ( 'the_content' === $filter ) {
995 if ( $done ) {
996 return $text;
997 } else {
998 $done = true;
999 }
1000 }
1001 }
1002
1003 // check whether we are viewing the front page and whether the front page option is checked.
1004 $options = get_option( 'sharing-options' );
1005 $display_options = null;
1006
1007 if ( is_array( $options ) ) {
1008 $display_options = $options['global']['show'];
1009 }
1010
1011 if ( is_front_page() && ( is_array( $display_options ) && ! in_array( 'index', $display_options, true ) ) ) {
1012 return $text;
1013 }
1014
1015 if ( is_attachment() && in_array( 'the_excerpt', (array) $wp_current_filter, true ) ) {
1016 // Many themes run the_excerpt() conditionally on an attachment page, then run the_content().
1017 // We only want to output the sharing buttons once. Let's stick with the_content().
1018 return $text;
1019 }
1020
1021 $sharer = new Sharing_Service();
1022 $global = $sharer->get_global_options();
1023
1024 $show = false;
1025 if ( ! is_feed() ) {
1026 if ( is_singular() && in_array( get_post_type(), $global['show'], true ) ) {
1027 $show = true;
1028 } elseif ( in_array( 'index', $global['show'], true ) && ( is_home() || is_front_page() || is_archive() || is_search() || in_array( get_post_type(), $global['show'], true ) ) ) {
1029 $show = true;
1030 }
1031 }
1032
1033 /**
1034 * Filter to decide if sharing buttons should be displayed.
1035 *
1036 * @module sharedaddy
1037 *
1038 * @since 1.1.0
1039 *
1040 * @param bool $show Should the sharing buttons be displayed.
1041 * @param WP_Post $post The post to share.
1042 */
1043 $show = apply_filters( 'sharing_show', $show, $post );
1044
1045 // Disabled for this post?
1046 $switched_status = get_post_meta( $post->ID, 'sharing_disabled', false );
1047
1048 if ( ! empty( $switched_status ) ) {
1049 $show = false;
1050 }
1051
1052 // Is the post private?
1053 $post_status = get_post_status( $post->ID );
1054
1055 if ( 'private' === $post_status ) {
1056 $show = false;
1057 }
1058
1059 // Hide on password protected posts unless password is provided.
1060 if ( post_password_required( $post->ID ) ) {
1061 $show = false;
1062 }
1063
1064 /**
1065 * Filter the Sharing buttons' Ajax action name Jetpack checks for.
1066 * This allows the use of the buttons with your own Ajax implementation.
1067 *
1068 * @module sharedaddy
1069 *
1070 * @since 7.3.0
1071 *
1072 * @param string $sharing_ajax_action_name Name of the Sharing buttons' Ajax action.
1073 */
1074 $ajax_action = apply_filters( 'sharing_ajax_action', 'get_latest_posts' );
1075
1076 // Allow to be used in ajax requests for latest posts.
1077 if (
1078 defined( 'DOING_AJAX' )
1079 && DOING_AJAX
1080 && isset( $_REQUEST['action'] ) // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Nonce handling happens within each custom implementation.
1081 && $ajax_action === $_REQUEST['action'] // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Nonce handling happens within each custom implementation.
1082 ) {
1083 $show = true;
1084 }
1085
1086 $sharing_content = '';
1087 $enabled = false;
1088
1089 if ( $show ) {
1090 /**
1091 * Filters the list of enabled Sharing Services.
1092 *
1093 * @module sharedaddy
1094 *
1095 * @since 2.2.3
1096 *
1097 * @param array $sharer->get_blog_services() Array of Sharing Services currently enabled.
1098 */
1099 $enabled = apply_filters( 'sharing_enabled', $sharer->get_blog_services() );
1100
1101 if ( is_countable( $enabled['all'] ) && ( count( $enabled['all'] ) > 0 ) ) {
1102 $dir = get_option( 'text_direction' );
1103
1104 // Wrapper.
1105 $sharing_content .= '<div class="sharedaddy sd-sharing-enabled"><div class="robots-nocontent sd-block sd-social sd-social-' . $global['button_style'] . ' sd-sharing">';
1106 if ( '' !== $global['sharing_label'] ) {
1107 $sharing_content .= sprintf(
1108 /**
1109 * Filter the sharing buttons' headline structure.
1110 *
1111 * @module sharedaddy
1112 *
1113 * @since 4.4.0
1114 *
1115 * @param string $sharing_headline Sharing headline structure.
1116 * @param string $global['sharing_label'] Sharing title.
1117 * @param string $sharing Module name.
1118 */
1119 apply_filters( 'jetpack_sharing_headline_html', '<h3 class="sd-title">%s</h3>', $global['sharing_label'], 'sharing' ),
1120 esc_html( $global['sharing_label'] )
1121 );
1122 }
1123 $sharing_content .= '<div class="sd-content"><ul>';
1124
1125 // Visible items.
1126 $visible = '';
1127 foreach ( $enabled['visible'] as $service ) {
1128 $klasses = array( 'share-' . $service->get_class() );
1129 if ( $service->is_deprecated() ) {
1130 if ( ! current_user_can( 'manage_options' ) ) {
1131 continue;
1132 }
1133 $klasses[] = 'share-deprecated';
1134 }
1135 // Individual HTML for sharing service.
1136 $visible .= '<li class="' . implode( ' ', $klasses ) . '">' . $service->get_display( $post ) . '</li>';
1137 }
1138
1139 $parts = array();
1140 $parts[] = $visible;
1141 $count_hidden = is_countable( $enabled['hidden'] ) ? count( $enabled['hidden'] ) : 0;
1142 $count_visible = is_countable( $enabled['visible'] ) ? count( $enabled['visible'] ) : 0;
1143 if ( $count_hidden > 0 ) {
1144 if ( $count_visible > 0 ) {
1145 $expand = __( 'More', 'jetpack' );
1146 } else {
1147 $expand = __( 'Share', 'jetpack' );
1148 }
1149 $parts[] = '<li><a href="#" class="sharing-anchor sd-button share-more"><span>' . $expand . '</span></a></li>';
1150 }
1151
1152 if ( 'rtl' === $dir ) {
1153 $parts = array_reverse( $parts );
1154 }
1155
1156 $sharing_content .= implode( '', $parts );
1157 $sharing_content .= '<li class="share-end"></li></ul>';
1158
1159 // Link to customization options if user can manage them.
1160 if ( current_user_can( 'manage_options' ) ) {
1161 $link_url = get_sharing_buttons_customisation_url();
1162 if ( ! empty( $link_url ) ) {
1163 $link_text = __( 'Customize buttons', 'jetpack' );
1164 $sharing_content .= '<p class="share-customize-link"><a href="' . esc_url( $link_url ) . '" target="_blank" rel="noopener noreferrer">' . esc_html( $link_text ) . '</a></p>';
1165 }
1166 }
1167
1168 if ( $count_hidden > 0 ) {
1169 $sharing_content .= '<div class="sharing-hidden"><div class="inner" style="display: none;';
1170
1171 if ( $count_hidden === 1 ) {
1172 $sharing_content .= 'width:150px;';
1173 }
1174
1175 $sharing_content .= '">';
1176
1177 if ( $count_hidden === 1 ) {
1178 $sharing_content .= '<ul style="background-image:none;">';
1179 } else {
1180 $sharing_content .= '<ul>';
1181 }
1182
1183 foreach ( $enabled['hidden'] as $service ) {
1184 // Individual HTML for sharing service.
1185 $klasses = array( 'share-' . $service->get_class() );
1186 if ( $service->is_deprecated() ) {
1187 if ( ! current_user_can( 'manage_options' ) ) {
1188 continue;
1189 }
1190 $klasses[] = 'share-deprecated';
1191 }
1192 $sharing_content .= '<li class="' . implode( ' ', $klasses ) . '">';
1193 $sharing_content .= $service->get_display( $post );
1194 $sharing_content .= '</li>';
1195 }
1196
1197 // End of wrapper.
1198 $sharing_content .= '<li class="share-end"></li></ul></div></div>';
1199 }
1200
1201 $sharing_content .= '</div></div></div>';
1202
1203 // Register our JS.
1204 if ( defined( 'JETPACK__VERSION' ) ) {
1205 $ver = JETPACK__VERSION;
1206 } else {
1207 $ver = '20211226';
1208 }
1209
1210 // @todo: Investigate if we can load this JS in the footer instead.
1211 wp_register_script(
1212 'sharing-js',
1213 Assets::get_file_url_for_environment(
1214 '_inc/build/sharedaddy/sharing.min.js',
1215 'modules/sharedaddy/sharing.js'
1216 ),
1217 array(),
1218 $ver,
1219 false
1220 );
1221
1222 // Enqueue scripts for the footer.
1223 add_action( 'wp_footer', 'sharing_add_footer' );
1224 }
1225 }
1226
1227 /**
1228 * Filters the content markup of the Jetpack sharing links
1229 *
1230 * @module sharedaddy
1231 *
1232 * @since 3.8.0
1233 * @since 6.2.0 Started sending $enabled as a second parameter.
1234 *
1235 * @param string $sharing_content Content markup of the Jetpack sharing links
1236 * @param array $enabled Array of Sharing Services currently enabled.
1237 */
1238 $sharing_markup = apply_filters( 'jetpack_sharing_display_markup', $sharing_content, $enabled );
1239
1240 if ( $echo ) {
1241 echo $text . $sharing_markup; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
1242 } else {
1243 return $text . $sharing_markup;
1244 }
1245 }
1246
1247 /**
1248 * Get reCAPTCHA language code based off the language code of the site.
1249 *
1250 * @return string
1251 */
1252 function get_base_recaptcha_lang_code() {
1253 $base_recaptcha_lang_code_mapping = array(
1254 'en' => 'en',
1255 'nl' => 'nl',
1256 'fr' => 'fr',
1257 'fr-be' => 'fr',
1258 'fr-ca' => 'fr',
1259 'fr-ch' => 'fr',
1260 'de' => 'de',
1261 'pt' => 'pt',
1262 'pt-br' => 'pt',
1263 'ru' => 'ru',
1264 'es' => 'es',
1265 'tr' => 'tr',
1266 );
1267
1268 $blog_lang_code = get_bloginfo( 'language' );
1269 if ( isset( $base_recaptcha_lang_code_mapping[ $blog_lang_code ] ) ) {
1270 return $base_recaptcha_lang_code_mapping[ $blog_lang_code ];
1271 }
1272
1273 // if no base mapping is found return default 'en'
1274 return 'en';
1275 }
1276
1277 Sharing_Service::init();
1278