Completed
Push — fix/gutencarousel ( 163655 )
by George
34:59 queued 26:48
created

Jetpack_Carousel::check_content_for_blocks()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

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