Completed
Push — kraftbj-patch-1 ( 599bd6...9b0476 )
by
unknown
145:59 queued 137:31
created

Jetpack_Carousel::post_attachment_comment()   F

Complexity

Conditions 18
Paths 76

Size

Total Lines 110

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 18
nc 76
nop 0
dl 0
loc 110
rs 3.8933
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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