Completed
Push — add/carousel-module-amp ( 6ae6c8 )
by
unknown
06:36
created

Jetpack_Carousel::settings_checkbox()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 14

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
nc 3
nop 4
dl 0
loc 14
rs 9.7998
c 0
b 0
f 0
1
<?php
2
use Automattic\Jetpack\Assets;
3
use Automattic\Jetpack\Status;
4
/*
5
Plugin Name: Jetpack Carousel
6
Plugin URL: https://wordpress.com/
7
Description: Transform your standard image galleries into an immersive full-screen experience.
8
Version: 0.1
9
Author: Automattic
10
11
Released under the GPL v.2 license.
12
13
This program is distributed in the hope that it will be useful,
14
but WITHOUT ANY WARRANTY; without even the implied warranty of
15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
GNU General Public License for more details.
17
*/
18
class Jetpack_Carousel {
19
20
	public $prebuilt_widths = array( 370, 700, 1000, 1200, 1400, 2000 );
21
22
	public $first_run = true;
23
24
	public $in_gallery = false;
25
26
	public $in_jetpack = true;
27
28
	public $single_image_gallery_enabled = false;
29
30
	public $single_image_gallery_enabled_media_file = false;
31
32
	function __construct() {
33
		add_action( 'init', array( $this, 'init' ) );
34
	}
35
36
	function init() {
37
		if ( $this->maybe_disable_jp_carousel() ) {
38
			return;
39
		}
40
41
		$this->in_jetpack = ( class_exists( 'Jetpack' ) && method_exists( 'Jetpack', 'enable_module_configurable' ) ) ? true : false;
42
43
		$this->single_image_gallery_enabled            = ! $this->maybe_disable_jp_carousel_single_images();
44
		$this->single_image_gallery_enabled_media_file = $this->maybe_enable_jp_carousel_single_images_media_file();
45
46
		if ( is_admin() ) {
47
			// Register the Carousel-related related settings
48
			add_action( 'admin_init', array( $this, 'register_settings' ), 5 );
49
			if ( ! $this->in_jetpack ) {
50
				if ( 0 == $this->test_1or0_option( get_option( 'carousel_enable_it' ), true ) ) {
51
					return; // Carousel disabled, abort early, but still register setting so user can switch it back on
52
				}
53
			}
54
			// If in admin, register the ajax endpoints.
55
			add_action( 'wp_ajax_get_attachment_comments', array( $this, 'get_attachment_comments' ) );
56
			add_action( 'wp_ajax_nopriv_get_attachment_comments', array( $this, 'get_attachment_comments' ) );
57
			add_action( 'wp_ajax_post_attachment_comment', array( $this, 'post_attachment_comment' ) );
58
			add_action( 'wp_ajax_nopriv_post_attachment_comment', array( $this, 'post_attachment_comment' ) );
59
		} else {
60
			if ( ! $this->in_jetpack ) {
61
				if ( 0 == $this->test_1or0_option( get_option( 'carousel_enable_it' ), true ) ) {
62
					return; // Carousel disabled, abort early
63
				}
64
			}
65
			// If on front-end, do the Carousel thang.
66
			/**
67
			 * Filter the array of default prebuilt widths used in Carousel.
68
			 *
69
			 * @module carousel
70
			 *
71
			 * @since 1.6.0
72
			 *
73
			 * @param array $this->prebuilt_widths Array of default widths.
74
			 */
75
			$this->prebuilt_widths = apply_filters( 'jp_carousel_widths', $this->prebuilt_widths );
76
			// below: load later than other callbacks hooked it (e.g. 3rd party plugins handling gallery shortcode)
77
			add_filter( 'post_gallery', array( $this, 'check_if_shortcode_processed_and_enqueue_assets' ), 1000, 2 );
78
			add_filter( 'post_gallery', array( $this, 'set_in_gallery' ), -1000 );
79
			add_filter( 'gallery_style', array( $this, 'add_data_to_container' ) );
80
			add_filter( 'wp_get_attachment_image_attributes', array( $this, 'add_data_to_images' ), 10, 2 );
81
			add_filter( 'the_content', array( $this, 'check_content_for_blocks' ), 1 );
82
			add_filter( 'jetpack_tiled_galleries_block_content', array( $this, 'add_data_img_tags_and_enqueue_assets' ) );
83
			if ( $this->single_image_gallery_enabled ) {
84
				add_filter( 'the_content', array( $this, 'add_data_img_tags_and_enqueue_assets' ) );
85
			}
86
		}
87
88
		if ( $this->in_jetpack ) {
89
			Jetpack::enable_module_configurable( dirname( dirname( __FILE__ ) ) . '/carousel.php' );
90
		}
91
	}
92
93
	function maybe_disable_jp_carousel() {
94
		/**
95
		 * Allow third-party plugins or themes to disable Carousel.
96
		 *
97
		 * @module carousel
98
		 *
99
		 * @since 1.6.0
100
		 *
101
		 * @param bool false Should Carousel be disabled? Default to false.
102
		 */
103
		return apply_filters( 'jp_carousel_maybe_disable', false );
104
	}
105
106
	function maybe_disable_jp_carousel_single_images() {
107
		/**
108
		 * Allow third-party plugins or themes to disable Carousel for single images.
109
		 *
110
		 * @module carousel
111
		 *
112
		 * @since 4.5.0
113
		 *
114
		 * @param bool false Should Carousel be disabled for single images? Default to false.
115
		 */
116
		return apply_filters( 'jp_carousel_maybe_disable_single_images', false );
117
	}
118
119
	function maybe_enable_jp_carousel_single_images_media_file() {
120
		/**
121
		 * Allow third-party plugins or themes to enable Carousel
122
		 * for single images linking to 'Media File' (full size image).
123
		 *
124
		 * @module carousel
125
		 *
126
		 * @since 4.5.0
127
		 *
128
		 * @param bool false Should Carousel be enabled for single images linking to 'Media File'? Default to false.
129
		 */
130
		return apply_filters( 'jp_carousel_load_for_images_linked_to_file', false );
131
	}
132
133
	function asset_version( $version ) {
134
		/**
135
		 * Filter the version string used when enqueuing Carousel assets.
136
		 *
137
		 * @module carousel
138
		 *
139
		 * @since 1.6.0
140
		 *
141
		 * @param string $version Asset version.
142
		 */
143
		return apply_filters( 'jp_carousel_asset_version', $version );
144
	}
145
146
	function display_bail_message( $output = '' ) {
147
		// Displays a message on top of gallery if carousel has bailed
148
		$message  = '<div class="jp-carousel-msg"><p>';
149
		$message .= __( 'Jetpack\'s Carousel has been disabled, because another plugin or your theme is overriding the [gallery] shortcode.', 'jetpack' );
150
		$message .= '</p></div>';
151
		// put before gallery output
152
		$output = $message . $output;
153
		return $output;
154
	}
155
156
	function check_if_shortcode_processed_and_enqueue_assets( $output ) {
157
		if (
158
			class_exists( 'Jetpack_AMP_Support' )
159
			&& Jetpack_AMP_Support::is_amp_request()
160
		) {
161
			return $output;
162
		}
163
164
		if (
165
			! empty( $output ) &&
166
			/**
167
			 * Allow third-party plugins or themes to force-enable Carousel.
168
			 *
169
			 * @module carousel
170
			 *
171
			 * @since 1.9.0
172
			 *
173
			 * @param bool false Should we force enable Carousel? Default to false.
174
			 */
175
			! apply_filters( 'jp_carousel_force_enable', false )
176
		) {
177
			// Bail because someone is overriding the [gallery] shortcode.
178
			remove_filter( 'gallery_style', array( $this, 'add_data_to_container' ) );
179
			remove_filter( 'wp_get_attachment_image_attributes', array( $this, 'add_data_to_images' ) );
180
			remove_filter( 'the_content', array( $this, 'add_data_img_tags_and_enqueue_assets' ) );
181
			// Display message that carousel has bailed, if user is super_admin, and if we're not on WordPress.com.
182
			if (
183
				is_super_admin() &&
184
				! ( defined( 'IS_WPCOM' ) && IS_WPCOM )
185
			) {
186
				add_filter( 'post_gallery', array( $this, 'display_bail_message' ) );
187
			}
188
			return $output;
189
		}
190
191
		/**
192
		 * Fires when thumbnails are shown in Carousel.
193
		 *
194
		 * @module carousel
195
		 *
196
		 * @since 1.6.0
197
		 **/
198
		do_action( 'jp_carousel_thumbnails_shown' );
199
200
		$this->enqueue_assets();
201
202
		return $output;
203
	}
204
205
	/**
206
	 * Check if the content of a post uses gallery blocks. To be used by 'the_content' filter.
207
	 *
208
	 * @since 6.8.0
209
	 *
210
	 * @param string $content Post content.
211
	 *
212
	 * @return string $content Post content.
213
	 */
214
	function check_content_for_blocks( $content ) {
215
		if (
216
			class_exists( 'Jetpack_AMP_Support' )
217
			&& Jetpack_AMP_Support::is_amp_request()
218
		) {
219
			return $content;
220
		}
221
222
		if ( has_block( 'gallery', $content ) || has_block( 'jetpack/tiled-gallery', $content ) ) {
223
			$this->enqueue_assets();
224
			$content = $this->add_data_to_container( $content );
225
		}
226
		return $content;
227
	}
228
229
	function enqueue_assets() {
230
		if ( $this->first_run ) {
231
			wp_enqueue_script(
232
				'jetpack-carousel',
233
				Assets::get_file_url_for_environment(
234
					'_inc/build/carousel/jetpack-carousel.min.js',
235
					'modules/carousel/jetpack-carousel.js'
236
				),
237
				array( 'jquery.spin' ),
238
				$this->asset_version( '20190102' ),
239
				true
240
			);
241
242
			// Note: using  home_url() instead of admin_url() for ajaxurl to be sure  to get same domain on wpcom when using mapped domains (also works on self-hosted)
243
			// Also: not hardcoding path since there is no guarantee site is running on site root in self-hosted context.
244
			$is_logged_in         = is_user_logged_in();
245
			$current_user         = wp_get_current_user();
246
			$comment_registration = intval( get_option( 'comment_registration' ) );
247
			$require_name_email   = intval( get_option( 'require_name_email' ) );
248
			$localize_strings     = array(
249
				'widths'                          => $this->prebuilt_widths,
250
				'is_logged_in'                    => $is_logged_in,
251
				'lang'                            => strtolower( substr( get_locale(), 0, 2 ) ),
252
				'ajaxurl'                         => set_url_scheme( admin_url( 'admin-ajax.php' ) ),
253
				'nonce'                           => wp_create_nonce( 'carousel_nonce' ),
254
				'display_exif'                    => $this->test_1or0_option( Jetpack_Options::get_option_and_ensure_autoload( 'carousel_display_exif', true ) ),
255
				'display_geo'                     => $this->test_1or0_option( Jetpack_Options::get_option_and_ensure_autoload( 'carousel_display_geo', true ) ),
256
				'single_image_gallery'            => $this->single_image_gallery_enabled,
257
				'single_image_gallery_media_file' => $this->single_image_gallery_enabled_media_file,
258
				'background_color'                => $this->carousel_background_color_sanitize( Jetpack_Options::get_option_and_ensure_autoload( 'carousel_background_color', '' ) ),
259
				'comment'                         => __( 'Comment', 'jetpack' ),
260
				'post_comment'                    => __( 'Post Comment', 'jetpack' ),
261
				'write_comment'                   => __( 'Write a Comment...', 'jetpack' ),
262
				'loading_comments'                => __( 'Loading Comments...', 'jetpack' ),
263
				'download_original'               => sprintf( __( 'View full size <span class="photo-size">%1$s<span class="photo-size-times">&times;</span>%2$s</span>', 'jetpack' ), '{0}', '{1}' ),
264
				'no_comment_text'                 => __( 'Please be sure to submit some text with your comment.', 'jetpack' ),
265
				'no_comment_email'                => __( 'Please provide an email address to comment.', 'jetpack' ),
266
				'no_comment_author'               => __( 'Please provide your name to comment.', 'jetpack' ),
267
				'comment_post_error'              => __( 'Sorry, but there was an error posting your comment. Please try again later.', 'jetpack' ),
268
				'comment_approved'                => __( 'Your comment was approved.', 'jetpack' ),
269
				'comment_unapproved'              => __( 'Your comment is in moderation.', 'jetpack' ),
270
				'camera'                          => __( 'Camera', 'jetpack' ),
271
				'aperture'                        => __( 'Aperture', 'jetpack' ),
272
				'shutter_speed'                   => __( 'Shutter Speed', 'jetpack' ),
273
				'focal_length'                    => __( 'Focal Length', 'jetpack' ),
274
				'copyright'                       => __( 'Copyright', 'jetpack' ),
275
				'comment_registration'            => $comment_registration,
276
				'require_name_email'              => $require_name_email,
277
				/** This action is documented in core/src/wp-includes/link-template.php */
278
				'login_url'                       => wp_login_url( apply_filters( 'the_permalink', get_permalink() ) ),
279
				'blog_id'                         => (int) get_current_blog_id(),
280
				'meta_data'                       => array( 'camera', 'aperture', 'shutter_speed', 'focal_length', 'copyright' ),
281
			);
282
283
			if ( ! isset( $localize_strings['jetpack_comments_iframe_src'] ) || empty( $localize_strings['jetpack_comments_iframe_src'] ) ) {
284
				// We're not using Comments after all, so fallback to standard local comments.
285
286
				if ( $is_logged_in ) {
287
					$localize_strings['local_comments_commenting_as'] = '<p id="jp-carousel-commenting-as">' . sprintf( __( 'Commenting as %s', 'jetpack' ), $current_user->data->display_name ) . '</p>';
288
				} else {
289
					if ( $comment_registration ) {
290
						$localize_strings['local_comments_commenting_as'] = '<p id="jp-carousel-commenting-as">' . __( 'You must be <a href="#" class="jp-carousel-comment-login">logged in</a> to post a comment.', 'jetpack' ) . '</p>';
291
					} else {
292
						$required = ( $require_name_email ) ? __( '%s (Required)', 'jetpack' ) : '%s';
293
						$localize_strings['local_comments_commenting_as'] = ''
294
							. '<fieldset><label for="email">' . sprintf( $required, __( 'Email', 'jetpack' ) ) . '</label> '
295
							. '<input type="text" name="email" class="jp-carousel-comment-form-field jp-carousel-comment-form-text-field" id="jp-carousel-comment-form-email-field" /></fieldset>'
296
							. '<fieldset><label for="author">' . sprintf( $required, __( 'Name', 'jetpack' ) ) . '</label> '
297
							. '<input type="text" name="author" class="jp-carousel-comment-form-field jp-carousel-comment-form-text-field" id="jp-carousel-comment-form-author-field" /></fieldset>'
298
							. '<fieldset><label for="url">' . __( 'Website', 'jetpack' ) . '</label> '
299
							. '<input type="text" name="url" class="jp-carousel-comment-form-field jp-carousel-comment-form-text-field" id="jp-carousel-comment-form-url-field" /></fieldset>';
300
					}
301
				}
302
			}
303
304
			/**
305
			 * Handle WP stats for images in full-screen.
306
			 * Build string with tracking info.
307
			 */
308
309
			/**
310
			 * Filter if Jetpack should enable stats collection on carousel views
311
			 *
312
			 * @module carousel
313
			 *
314
			 * @since 4.3.2
315
			 *
316
			 * @param bool Enable Jetpack Carousel stat collection. Default false.
317
			 */
318
			if ( apply_filters( 'jetpack_enable_carousel_stats', false ) && in_array( 'stats', Jetpack::get_active_modules() ) && ! ( new Status() )->is_development_mode() ) {
319
				$localize_strings['stats'] = 'blog=' . Jetpack_Options::get_option( 'id' ) . '&host=' . wp_parse_url( get_option( 'home' ), PHP_URL_HOST ) . '&v=ext&j=' . JETPACK__API_VERSION . ':' . JETPACK__VERSION;
320
321
				// Set the stats as empty if user is logged in but logged-in users shouldn't be tracked.
322 View Code Duplication
				if ( is_user_logged_in() && function_exists( 'stats_get_options' ) ) {
323
					$stats_options        = stats_get_options();
324
					$track_loggedin_users = isset( $stats_options['reg_users'] ) ? (bool) $stats_options['reg_users'] : false;
325
326
					if ( ! $track_loggedin_users ) {
327
						$localize_strings['stats'] = '';
328
					}
329
				}
330
			}
331
332
			/**
333
			 * Filter the strings passed to the Carousel's js file.
334
			 *
335
			 * @module carousel
336
			 *
337
			 * @since 1.6.0
338
			 *
339
			 * @param array $localize_strings Array of strings passed to the Jetpack js file.
340
			 */
341
			$localize_strings = apply_filters( 'jp_carousel_localize_strings', $localize_strings );
342
			wp_localize_script( 'jetpack-carousel', 'jetpackCarouselStrings', $localize_strings );
343
			wp_enqueue_style( 'jetpack-carousel', plugins_url( 'jetpack-carousel.css', __FILE__ ), array(), $this->asset_version( '20120629' ) );
344
			wp_style_add_data( 'jetpack-carousel', 'rtl', 'replace' );
345
346
			/**
347
			 * Fires after carousel assets are enqueued for the first time.
348
			 * Allows for adding additional assets to the carousel page.
349
			 *
350
			 * @module carousel
351
			 *
352
			 * @since 1.6.0
353
			 *
354
			 * @param bool $first_run First load if Carousel on the page.
355
			 * @param array $localized_strings Array of strings passed to the Jetpack js file.
356
			 */
357
			do_action( 'jp_carousel_enqueue_assets', $this->first_run, $localize_strings );
358
359
			$this->first_run = false;
360
		}
361
	}
362
363
	function set_in_gallery( $output ) {
364
		if (
365
			class_exists( 'Jetpack_AMP_Support' )
366
			&& Jetpack_AMP_Support::is_amp_request()
367
		) {
368
			return $output;
369
		}
370
		$this->in_gallery = true;
371
		return $output;
372
	}
373
374
	/**
375
	 * Adds data-* attributes required by carousel to img tags in post HTML
376
	 * content. To be used by 'the_content' filter.
377
	 *
378
	 * @see add_data_to_images()
379
	 * @see wp_make_content_images_responsive() in wp-includes/media.php
380
	 *
381
	 * @param string $content HTML content of the post
382
	 * @return string Modified HTML content of the post
383
	 */
384
	function add_data_img_tags_and_enqueue_assets( $content ) {
385
		if (
386
			class_exists( 'Jetpack_AMP_Support' )
387
			&& Jetpack_AMP_Support::is_amp_request()
388
		) {
389
			return $this->maybe_add_amp_lightbox( $content );
390
		}
391
392
		if ( ! preg_match_all( '/<img [^>]+>/', $content, $matches ) ) {
393
			return $content;
394
		}
395
		$selected_images = array();
396
		foreach ( $matches[0] as $image_html ) {
397
			if ( preg_match( '/(wp-image-|data-id=)\"?([0-9]+)\"?/i', $image_html, $class_id ) &&
398
				! preg_match( '/wp-block-jetpack-slideshow_image/', $image_html ) ) {
399
				$attachment_id = absint( $class_id[2] );
400
				/**
401
				 * If exactly the same image tag is used more than once, overwrite it.
402
				 * All identical tags will be replaced later with 'str_replace()'.
403
				 */
404
				$selected_images[ $attachment_id  ] = $image_html;
405
			}
406
		}
407
408
		$find    = array();
409
		$replace = array();
410
		if ( empty( $selected_images ) ) {
411
			return $content;
412
		}
413
414
		$attachments = get_posts(
415
			array(
416
				'include'          => array_keys( $selected_images ),
417
				'post_type'        => 'any',
418
				'post_status'      => 'any',
419
				'suppress_filters' => false,
420
			)
421
		);
422
423
		foreach ( $attachments as $attachment ) {
424
			$image_html = $selected_images[ $attachment->ID ];
425
426
			$attributes      = $this->add_data_to_images( array(), $attachment );
427
			$attributes_html = '';
428
			foreach ( $attributes as $k => $v ) {
429
				$attributes_html .= esc_attr( $k ) . '="' . esc_attr( $v ) . '" ';
430
			}
431
432
			$find[]    = $image_html;
433
			$replace[] = str_replace( '<img ', "<img $attributes_html", $image_html );
434
		}
435
436
		$content = str_replace( $find, $replace, $content );
437
		$this->enqueue_assets();
438
		return $content;
439
	}
440
441
	function add_data_to_images( $attr, $attachment = null ) {
442
		if (
443
			class_exists( 'Jetpack_AMP_Support' )
444
			&& Jetpack_AMP_Support::is_amp_request()
445
		) {
446
			return $attr;
447
		}
448
449
		$attachment_id = intval( $attachment->ID );
450
		if ( ! wp_attachment_is_image( $attachment_id ) ) {
451
			return $attr;
452
		}
453
454
		$orig_file       = wp_get_attachment_image_src( $attachment_id, 'full' );
455
		$orig_file       = isset( $orig_file[0] ) ? $orig_file[0] : wp_get_attachment_url( $attachment_id );
456
		$meta            = wp_get_attachment_metadata( $attachment_id );
457
		$size            = isset( $meta['width'] ) ? intval( $meta['width'] ) . ',' . intval( $meta['height'] ) : '';
458
		$img_meta        = ( ! empty( $meta['image_meta'] ) ) ? (array) $meta['image_meta'] : array();
459
		$comments_opened = intval( comments_open( $attachment_id ) );
460
461
		/**
462
		 * Note: Cannot generate a filename from the width and height wp_get_attachment_image_src() returns because
463
		 * it takes the $content_width global variable themes can set in consideration, therefore returning sizes
464
		 * which when used to generate a filename will likely result in a 404 on the image.
465
		 * $content_width has no filter we could temporarily de-register, run wp_get_attachment_image_src(), then
466
		 * re-register. So using returned file URL instead, which we can define the sizes from through filename
467
		 * parsing in the JS, as this is a failsafe file reference.
468
		 *
469
		 * EG with Twenty Eleven activated:
470
		 * array(4) { [0]=> string(82) "http://vanillawpinstall.blah/wp-content/uploads/2012/06/IMG_3534-1024x764.jpg" [1]=> int(584) [2]=> int(435) [3]=> bool(true) }
471
		 *
472
		 * EG with Twenty Ten activated:
473
		 * array(4) { [0]=> string(82) "http://vanillawpinstall.blah/wp-content/uploads/2012/06/IMG_3534-1024x764.jpg" [1]=> int(640) [2]=> int(477) [3]=> bool(true) }
474
		 */
475
476
		$medium_file_info = wp_get_attachment_image_src( $attachment_id, 'medium' );
477
		$medium_file      = isset( $medium_file_info[0] ) ? $medium_file_info[0] : '';
478
479
		$large_file_info = wp_get_attachment_image_src( $attachment_id, 'large' );
480
		$large_file      = isset( $large_file_info[0] ) ? $large_file_info[0] : '';
481
482
		$attachment       = get_post( $attachment_id );
483
		$attachment_title = wptexturize( $attachment->post_title );
484
		$attachment_desc  = wpautop( wptexturize( $attachment->post_content ) );
485
		// Not yet providing geo-data, need to "fuzzify" for privacy
486 View Code Duplication
		if ( ! empty( $img_meta ) ) {
487
			foreach ( $img_meta as $k => $v ) {
488
				if ( 'latitude' == $k || 'longitude' == $k ) {
489
					unset( $img_meta[ $k ] );
490
				}
491
			}
492
		}
493
494
		// See https://github.com/Automattic/jetpack/issues/2765
495
		if ( isset( $img_meta['keywords'] ) ) {
496
			unset( $img_meta['keywords'] );
497
		}
498
499
		$img_meta = json_encode( array_map( 'strval', array_filter( $img_meta, 'is_scalar' ) ) );
500
501
		$attr['data-attachment-id']     = $attachment_id;
502
		$attr['data-permalink']         = esc_attr( get_permalink( $attachment->ID ) );
503
		$attr['data-orig-file']         = esc_attr( $orig_file );
504
		$attr['data-orig-size']         = $size;
505
		$attr['data-comments-opened']   = $comments_opened;
506
		$attr['data-image-meta']        = esc_attr( $img_meta );
507
		$attr['data-image-title']       = esc_attr( htmlspecialchars( $attachment_title ) );
508
		$attr['data-image-description'] = esc_attr( htmlspecialchars( $attachment_desc ) );
509
		$attr['data-medium-file']       = esc_attr( $medium_file );
510
		$attr['data-large-file']        = esc_attr( $large_file );
511
512
		return $attr;
513
	}
514
515
	function add_data_to_container( $html ) {
516
		global $post;
517
		if (
518
			class_exists( 'Jetpack_AMP_Support' )
519
			&& Jetpack_AMP_Support::is_amp_request()
520
		) {
521
			return $html;
522
		}
523
524
		if ( isset( $post ) ) {
525
			$blog_id = (int) get_current_blog_id();
526
527
			$extra_data = array(
528
				'data-carousel-extra' => array(
529
					'blog_id'   => $blog_id,
530
					'permalink' => get_permalink( $post->ID ),
531
				),
532
			);
533
534
			/**
535
			 * Filter the data added to the Gallery container.
536
			 *
537
			 * @module carousel
538
			 *
539
			 * @since 1.6.0
540
			 *
541
			 * @param array $extra_data Array of data about the site and the post.
542
			 */
543
			$extra_data = apply_filters( 'jp_carousel_add_data_to_container', $extra_data );
544
			foreach ( (array) $extra_data as $data_key => $data_values ) {
545
				$html = str_replace( '<div ', '<div ' . esc_attr( $data_key ) . "='" . json_encode( $data_values ) . "' ", $html );
546
				$html = str_replace( '<ul class="wp-block-gallery', '<ul ' . esc_attr( $data_key ) . "='" . json_encode( $data_values ) . "' class=\"wp-block-gallery", $html );
547
				$html = str_replace( '<ul class="blocks-gallery-grid', '<ul ' . esc_attr( $data_key ) . "='" . json_encode( $data_values ) . "' class=\"blocks-gallery-grid", $html );
548
			}
549
		}
550
551
		return $html;
552
	}
553
554
	/**
555
	 * Conditionally adds amp-lightbox to galleries and images.
556
	 *
557
	 * This applies to gallery blocks and shortcodes,
558
	 * in addition to images that are wrapped in a link to the page.
559
	 * Images wrapped in a link to the media file shouldn't get an amp-lightbox.
560
	 *
561
	 * @param string $content The content to possibly add amp-lightbox to.
562
	 * @return string The content, with amp-lightbox possibly added.
563
	 */
564
	public function maybe_add_amp_lightbox( $content ) {
565
		$content = preg_replace(
566
			array(
567
				'#(<figure)[^>]*(?=class=(["\']?)[^>]*wp-block-gallery[^>]*\2)#is', // Gallery block.
568
				'#(\[gallery)(?=\s+)#', // Gallery shortcode.
569
			),
570
			array(
571
				'\1 data-amp-lightbox="true" ', // https://github.com/ampproject/amp-wp/blob/1094ea03bd5dc92889405a47a8c41de1a88908de/includes/sanitizers/class-amp-gallery-block-sanitizer.php#L84.
572
				'\1 amp-lightbox="true"', // https://github.com/ampproject/amp-wp/blob/1094ea03bd5dc92889405a47a8c41de1a88908de/includes/embeds/class-amp-gallery-embed.php#L64.
573
			),
574
			$content
575
		);
576
577
		return preg_replace_callback(
578
			'#(<a[^>]* href=(["\']?)(\S+)\2>)\s*(<img[^>]*)(class=(["\']?)[^>]*wp-image-[0-9]+[^>]*\6.*>)\s*</a>#is',
579
			static function( $matches ) {
580 View Code Duplication
				if ( ! preg_match( '#\.\w+$#', $matches[3] ) ) {
581
					// The a[href] doesn't end in a file extension like .jpeg, so this is not a link to the media file, and should get a lightbox.
582
					return $matches[4] . ' data-amp-lightbox="true" lightbox="true" ' . $matches[5]; // https://github.com/ampproject/amp-wp/blob/1094ea03bd5dc92889405a47a8c41de1a88908de/includes/sanitizers/class-amp-img-sanitizer.php#L419.
583
				}
584
585
				return $matches[0];
586
			},
587
			$content
588
		);
589
	}
590
591
	function get_attachment_comments() {
592
		if ( ! headers_sent() ) {
593
			header( 'Content-type: text/javascript' );
594
		}
595
596
		/**
597
		 * Allows for the checking of privileges of the blog user before comments
598
		 * are packaged as JSON and sent back from the get_attachment_comments
599
		 * AJAX endpoint
600
		 *
601
		 * @module carousel
602
		 *
603
		 * @since 1.6.0
604
		 */
605
		do_action( 'jp_carousel_check_blog_user_privileges' );
606
607
		$attachment_id = ( isset( $_REQUEST['id'] ) ) ? (int) $_REQUEST['id'] : 0;
608
		$offset        = ( isset( $_REQUEST['offset'] ) ) ? (int) $_REQUEST['offset'] : 0;
609
610
		if ( ! $attachment_id ) {
611
			echo json_encode( __( 'Missing attachment ID.', 'jetpack' ) );
612
			die();
613
		}
614
615
		if ( $offset < 1 ) {
616
			$offset = 0;
617
		}
618
619
		$comments = get_comments(
620
			array(
621
				'status'  => 'approve',
622
				'order'   => ( 'asc' == get_option( 'comment_order' ) ) ? 'ASC' : 'DESC',
623
				'number'  => 10,
624
				'offset'  => $offset,
625
				'post_id' => $attachment_id,
626
			)
627
		);
628
629
		$out = array();
630
631
		// Can't just send the results, they contain the commenter's email address.
632
		foreach ( $comments as $comment ) {
633
			$avatar = get_avatar( $comment->comment_author_email, 64 );
634
			if ( ! $avatar ) {
635
				$avatar = '';
636
			}
637
			$out[] = array(
638
				'id'              => $comment->comment_ID,
639
				'parent_id'       => $comment->comment_parent,
640
				'author_markup'   => get_comment_author_link( $comment->comment_ID ),
641
				'gravatar_markup' => $avatar,
642
				'date_gmt'        => $comment->comment_date_gmt,
643
				'content'         => wpautop( $comment->comment_content ),
644
			);
645
		}
646
647
		die( json_encode( $out ) );
648
	}
649
650
	function post_attachment_comment() {
651
		if ( ! headers_sent() ) {
652
			header( 'Content-type: text/javascript' );
653
		}
654
655
		if ( empty( $_POST['nonce'] ) || ! wp_verify_nonce( $_POST['nonce'], 'carousel_nonce' ) ) {
656
			die( json_encode( array( 'error' => __( 'Nonce verification failed.', 'jetpack' ) ) ) );
657
		}
658
659
		$_blog_id = (int) $_POST['blog_id'];
660
		$_post_id = (int) $_POST['id'];
661
		$comment  = $_POST['comment'];
662
663
		if ( empty( $_blog_id ) ) {
664
			die( json_encode( array( 'error' => __( 'Missing target blog ID.', 'jetpack' ) ) ) );
665
		}
666
667
		if ( empty( $_post_id ) ) {
668
			die( json_encode( array( 'error' => __( 'Missing target post ID.', 'jetpack' ) ) ) );
669
		}
670
671
		if ( empty( $comment ) ) {
672
			die( json_encode( array( 'error' => __( 'No comment text was submitted.', 'jetpack' ) ) ) );
673
		}
674
675
		// Used in context like NewDash
676
		$switched = false;
677
		if ( is_multisite() && $_blog_id != get_current_blog_id() ) {
678
			switch_to_blog( $_blog_id );
679
			$switched = true;
680
		}
681
682
		/** This action is documented in modules/carousel/jetpack-carousel.php */
683
		do_action( 'jp_carousel_check_blog_user_privileges' );
684
685
		if ( ! comments_open( $_post_id ) ) {
686
			die( json_encode( array( 'error' => __( 'Comments on this post are closed.', 'jetpack' ) ) ) );
687
		}
688
689
		if ( is_user_logged_in() ) {
690
			$user         = wp_get_current_user();
691
			$user_id      = $user->ID;
692
			$display_name = $user->display_name;
693
			$email        = $user->user_email;
694
			$url          = $user->user_url;
695
696
			if ( empty( $user_id ) ) {
697
				die( json_encode( array( 'error' => __( 'Sorry, but we could not authenticate your request.', 'jetpack' ) ) ) );
698
			}
699
		} else {
700
			$user_id      = 0;
701
			$display_name = $_POST['author'];
702
			$email        = $_POST['email'];
703
			$url          = $_POST['url'];
704
705
			if ( get_option( 'require_name_email' ) ) {
706
				if ( empty( $display_name ) ) {
707
					die( json_encode( array( 'error' => __( 'Please provide your name.', 'jetpack' ) ) ) );
708
				}
709
710
				if ( empty( $email ) ) {
711
					die( json_encode( array( 'error' => __( 'Please provide an email address.', 'jetpack' ) ) ) );
712
				}
713
714
				if ( ! is_email( $email ) ) {
715
					die( json_encode( array( 'error' => __( 'Please provide a valid email address.', 'jetpack' ) ) ) );
716
				}
717
			}
718
		}
719
720
		$comment_data = array(
721
			'comment_content'      => $comment,
722
			'comment_post_ID'      => $_post_id,
723
			'comment_author'       => $display_name,
724
			'comment_author_email' => $email,
725
			'comment_author_url'   => $url,
726
			'comment_approved'     => 0,
727
			'comment_type'         => '',
728
		);
729
730
		if ( ! empty( $user_id ) ) {
731
			$comment_data['user_id'] = $user_id;
732
		}
733
734
		// Note: wp_new_comment() sanitizes and validates the values (too).
735
		$comment_id = wp_new_comment( $comment_data );
736
737
		/**
738
		 * Fires before adding a new comment to the database via the get_attachment_comments ajax endpoint.
739
		 *
740
		 * @module carousel
741
		 *
742
		 * @since 1.6.0
743
		 */
744
		do_action( 'jp_carousel_post_attachment_comment' );
745
		$comment_status = wp_get_comment_status( $comment_id );
746
747
		if ( true == $switched ) {
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
748
			restore_current_blog();
749
		}
750
751
		die(
752
			json_encode(
753
				array(
754
					'comment_id'     => $comment_id,
755
					'comment_status' => $comment_status,
756
				)
757
			)
758
		);
759
	}
760
761
	function register_settings() {
762
		add_settings_section( 'carousel_section', __( 'Image Gallery Carousel', 'jetpack' ), array( $this, 'carousel_section_callback' ), 'media' );
763
764
		if ( ! $this->in_jetpack ) {
765
			add_settings_field( 'carousel_enable_it', __( 'Enable carousel', 'jetpack' ), array( $this, 'carousel_enable_it_callback' ), 'media', 'carousel_section' );
766
			register_setting( 'media', 'carousel_enable_it', array( $this, 'carousel_enable_it_sanitize' ) );
767
		}
768
769
		add_settings_field( 'carousel_background_color', __( 'Background color', 'jetpack' ), array( $this, 'carousel_background_color_callback' ), 'media', 'carousel_section' );
770
		register_setting( 'media', 'carousel_background_color', array( $this, 'carousel_background_color_sanitize' ) );
771
772
		add_settings_field( 'carousel_display_exif', __( 'Metadata', 'jetpack' ), array( $this, 'carousel_display_exif_callback' ), 'media', 'carousel_section' );
773
		register_setting( 'media', 'carousel_display_exif', array( $this, 'carousel_display_exif_sanitize' ) );
774
775
		// No geo setting yet, need to "fuzzify" data first, for privacy
776
		// add_settings_field('carousel_display_geo', __( 'Geolocation', 'jetpack' ), array( $this, 'carousel_display_geo_callback' ), 'media', 'carousel_section' );
777
		// register_setting( 'media', 'carousel_display_geo', array( $this, 'carousel_display_geo_sanitize' ) );
778
	}
779
780
	// Fulfill the settings section callback requirement by returning nothing
781
	function carousel_section_callback() {
782
		return;
783
	}
784
785
	function test_1or0_option( $value, $default_to_1 = true ) {
786
		if ( true == $default_to_1 ) {
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
787
			// Binary false (===) of $value means it has not yet been set, in which case we do want to default sites to 1
788
			if ( false === $value ) {
789
				$value = 1;
790
			}
791
		}
792
		return ( 1 == $value ) ? 1 : 0;
793
	}
794
795
	function sanitize_1or0_option( $value ) {
796
		return ( 1 == $value ) ? 1 : 0;
797
	}
798
799
	function settings_checkbox( $name, $label_text, $extra_text = '', $default_to_checked = true ) {
800
		if ( empty( $name ) ) {
801
			return;
802
		}
803
		$option = $this->test_1or0_option( get_option( $name ), $default_to_checked );
804
		echo '<fieldset>';
805
		echo '<input type="checkbox" name="' . esc_attr( $name ) . '" id="' . esc_attr( $name ) . '" value="1" ';
806
		checked( '1', $option );
807
		echo '/> <label for="' . esc_attr( $name ) . '">' . $label_text . '</label>';
808
		if ( ! empty( $extra_text ) ) {
809
			echo '<p class="description">' . $extra_text . '</p>';
810
		}
811
		echo '</fieldset>';
812
	}
813
814
	function settings_select( $name, $values, $extra_text = '' ) {
815
		if ( empty( $name ) || ! is_array( $values ) || empty( $values ) ) {
816
			return;
817
		}
818
		$option = get_option( $name );
819
		echo '<fieldset>';
820
		echo '<select name="' . esc_attr( $name ) . '" id="' . esc_attr( $name ) . '">';
821
		foreach ( $values as $key => $value ) {
822
			echo '<option value="' . esc_attr( $key ) . '" ';
823
			selected( $key, $option );
824
			echo '>' . esc_html( $value ) . '</option>';
825
		}
826
		echo '</select>';
827
		if ( ! empty( $extra_text ) ) {
828
			echo '<p class="description">' . $extra_text . '</p>';
829
		}
830
		echo '</fieldset>';
831
	}
832
833
	function carousel_display_exif_callback() {
834
		$this->settings_checkbox( 'carousel_display_exif', __( 'Show photo metadata (<a href="https://en.wikipedia.org/wiki/Exchangeable_image_file_format" rel="noopener noreferrer" target="_blank">Exif</a>) in carousel, when available.', 'jetpack' ) );
835
	}
836
837
	function carousel_display_exif_sanitize( $value ) {
838
		return $this->sanitize_1or0_option( $value );
839
	}
840
841
	function carousel_display_geo_callback() {
842
		$this->settings_checkbox( 'carousel_display_geo', __( 'Show map of photo location in carousel, when available.', 'jetpack' ) );
843
	}
844
845
	function carousel_display_geo_sanitize( $value ) {
846
		return $this->sanitize_1or0_option( $value );
847
	}
848
849
	function carousel_background_color_callback() {
850
		$this->settings_select(
851
			'carousel_background_color', array(
852
				'black' => __( 'Black', 'jetpack' ),
853
				'white' => __( 'White', 'jetpack' ),
854
			)
855
		);
856
	}
857
858
	function carousel_background_color_sanitize( $value ) {
859
		return ( 'white' == $value ) ? 'white' : 'black';
860
	}
861
862
	function carousel_enable_it_callback() {
863
		$this->settings_checkbox( 'carousel_enable_it', __( 'Display images in full-size carousel slideshow.', 'jetpack' ) );
864
	}
865
866
	function carousel_enable_it_sanitize( $value ) {
867
		return $this->sanitize_1or0_option( $value );
868
	}
869
}
870
871
new Jetpack_Carousel;
872