Completed
Push — fix/external-link-component-re... ( 552a03...a12c86 )
by
unknown
52:02 queued 41:45
created

Jetpack_Carousel::add_carousel_skeleton()   C

Complexity

Conditions 13
Paths 80

Size

Total Lines 129

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 13
nc 80
nop 0
dl 0
loc 129
rs 5.2933
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
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' ),
238
				$this->asset_version( JETPACK__VERSION ),
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
			$comment_registration = (int) get_option( 'comment_registration' );
246
			$require_name_email   = (int) 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_comments'                => $this->test_1or0_option( Jetpack_Options::get_option_and_ensure_autoload( 'carousel_display_comments', 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
			/**
284
			 * Handle WP stats for images in full-screen.
285
			 * Build string with tracking info.
286
			 */
287
288
			/**
289
			 * Filter if Jetpack should enable stats collection on carousel views
290
			 *
291
			 * @module carousel
292
			 *
293
			 * @since 4.3.2
294
			 *
295
			 * @param bool Enable Jetpack Carousel stat collection. Default false.
296
			 */
297
			if ( apply_filters( 'jetpack_enable_carousel_stats', false ) && in_array( 'stats', Jetpack::get_active_modules(), true ) && ! ( new Status() )->is_offline_mode() ) {
298
				$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;
299
300
				// Set the stats as empty if user is logged in but logged-in users shouldn't be tracked.
301 View Code Duplication
				if ( is_user_logged_in() && function_exists( 'stats_get_options' ) ) {
302
					$stats_options        = stats_get_options();
303
					$track_loggedin_users = isset( $stats_options['reg_users'] ) ? (bool) $stats_options['reg_users'] : false;
304
305
					if ( ! $track_loggedin_users ) {
306
						$localize_strings['stats'] = '';
307
					}
308
				}
309
			}
310
311
			/**
312
			 * Filter the strings passed to the Carousel's js file.
313
			 *
314
			 * @module carousel
315
			 *
316
			 * @since 1.6.0
317
			 *
318
			 * @param array $localize_strings Array of strings passed to the Jetpack js file.
319
			 */
320
			$localize_strings = apply_filters( 'jp_carousel_localize_strings', $localize_strings );
321
			wp_localize_script( 'jetpack-carousel', 'jetpackCarouselStrings', $localize_strings );
322
			wp_enqueue_style( 'jetpack-carousel', plugins_url( 'jetpack-carousel.css', __FILE__ ), array(), $this->asset_version( JETPACK__VERSION ) );
323
			wp_style_add_data( 'jetpack-carousel', 'rtl', 'replace' );
324
325
			/**
326
			 * Fires after carousel assets are enqueued for the first time.
327
			 * Allows for adding additional assets to the carousel page.
328
			 *
329
			 * @module carousel
330
			 *
331
			 * @since 1.6.0
332
			 *
333
			 * @param bool $first_run First load if Carousel on the page.
334
			 * @param array $localized_strings Array of strings passed to the Jetpack js file.
335
			 */
336
			do_action( 'jp_carousel_enqueue_assets', $this->first_run, $localize_strings );
337
338
			// Add the carousel skeleton to the page.
339
			$this->localize_strings = $localize_strings;
0 ignored issues
show
Bug introduced by
The property localize_strings does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
340
			add_action( 'wp_footer', array( $this, 'add_carousel_skeleton' ) );
341
342
			$this->first_run = false;
343
		}
344
	}
345
346
	/**
347
	 * Generate the HTML skeleton that will be picked up by the Carousel JS and used for showing the carousel.
348
	 */
349
	public function add_carousel_skeleton() {
350
		$localize_strings = $this->localize_strings;
351
		$is_light         = ( 'white' === $localize_strings['background_color'] );
352
		// Determine whether to fall back to standard local comments.
353
		$use_local_comments = ! isset( $localize_strings['jetpack_comments_iframe_src'] ) || empty( $localize_strings['jetpack_comments_iframe_src'] );
354
		$current_user       = wp_get_current_user();
355
		$require_name_email = (int) get_option( 'require_name_email' );
356
		/* translators: %s is replaced with a field name in the form, e.g. "Email" */
357
		$required = ( $require_name_email ) ? __( '%s (Required)', 'jetpack' ) : '%s';
358
		?>
359
360
		<div
361
			class="jp-carousel-wrap jp-carousel-transitions<?php echo( $is_light ? ' jp-carousel-light' : '' ); ?>"
362
			itemscope
363
			itemtype="https://schema.org/ImageGallery"
364
			style="display: none;">
365
			<div class="jp-carousel-overlay"></div>
366
			<div class="jp-carousel"></div>
367
			<div class="jp-carousel-fadeaway"></div>
368
			<div class="jp-carousel-info">
369
				<div class="jp-carousel-photo-info">
370
					<h2 class="jp-carousel-caption" itemprop="caption description"></h2>
371
				</div>
372
				<div class="jp-carousel-info-columns">
373
					<div class="jp-carousel-left-column-wrapper">
374
						<div class="jp-carousel-titleanddesc"></div>
375
						<!-- Intentional duplicate -->
376
						<div class="jp-carousel-photo-info">
377
							<h2 class="jp-carousel-caption" itemprop="caption description"></h2>
378
						</div>
379
						<?php if ( $localize_strings['display_comments'] ) : ?>
380
							<div id="jp-carousel-comment-form-container">
381
								<?php if ( $use_local_comments ) : ?>
382
									<?php if ( ! $localize_strings['is_logged_in'] && $localize_strings['comment_registration'] ) : ?>
383
										<div id="jp-carousel-comment-form-commenting-as">
384
											<p id="jp-carousel-commenting-as">
385
												<?php
386
													echo wp_kses(
387
														__( 'You must be <a href="#" class="jp-carousel-comment-login">logged in</a> to post a comment.', 'jetpack' ),
388
														array(
389
															'a' => array(
390
																'href'  => array(),
391
																'class' => array(),
392
															),
393
														)
394
													);
395
												?>
396
											</p>
397
										</div>
398
									<?php else : ?>
399
										<form id="jp-carousel-comment-form">
400
											<textarea
401
												name="comment"
402
												class="jp-carousel-comment-form-field jp-carousel-comment-form-textarea"
403
												id="jp-carousel-comment-form-comment-field"
404
												placeholder="<?php echo esc_attr( $localize_strings['write_comment'] ); ?>"
405
											></textarea>
406
											<div id="jp-carousel-comment-form-submit-and-info-wrapper">
407
												<div id="jp-carousel-comment-form-commenting-as">
408
													<?php if ( $localize_strings['is_logged_in'] ) : ?>
409
														<p id="jp-carousel-commenting-as">
410
															<?php
411
																printf(
412
																	/* translators: %s is replaced with the user's display name */
413
																	esc_html__( 'Commenting as %s', 'jetpack' ),
414
																	esc_html( $current_user->data->display_name )
415
																);
416
															?>
417
														</p>
418
													<?php else : ?>
419
														<fieldset>
420
															<label for="email"><?php echo esc_html( sprintf( $required, __( 'Email', 'jetpack' ) ) ); ?></label>
421
															<input type="text" name="email" class="jp-carousel-comment-form-field jp-carousel-comment-form-text-field" id="jp-carousel-comment-form-email-field" />
422
														</fieldset>
423
														<fieldset>
424
															<label for="author"><?php echo esc_html( sprintf( $required, __( 'Name', 'jetpack' ) ) ); ?></label>
425
															<input type="text" name="author" class="jp-carousel-comment-form-field jp-carousel-comment-form-text-field" id="jp-carousel-comment-form-author-field" />
426
														</fieldset>
427
														<fieldset>
428
															<label for="url"><?php esc_html_e( 'Website', 'jetpack' ); ?></label>
429
															<input type="text" name="url" class="jp-carousel-comment-form-field jp-carousel-comment-form-text-field" id="jp-carousel-comment-form-url-field" />
430
														</fieldset>
431
													<?php endif ?>
432
												</div>
433
												<input
434
													type="submit"
435
													name="submit"
436
													class="jp-carousel-comment-form-button"
437
													id="jp-carousel-comment-form-button-submit"
438
													value="<?php echo esc_attr( $localize_strings['post_comment'] ); ?>" />
439
												<span id="jp-carousel-comment-form-spinner">&nbsp;</span>
440
												<div id="jp-carousel-comment-post-results"></div>
441
											</div>
442
										</form>
443
									<?php endif ?>
444
								<?php endif ?>
445
							</div>
446
							<div class="jp-carousel-comments"></div>
447
							<div id="jp-carousel-comments-loading">
448
								<span><?php echo esc_html( $localize_strings['loading_comments'] ); ?></span>
449
							</div>
450
						<?php endif ?>
451
					</div>
452
					<div class="jp-carousel-image-meta">
453
						<div class="jp-carousel-buttons">
454
							<?php if ( $localize_strings['display_comments'] ) : ?>
455
							<a class="jp-carousel-commentlink" href="#"><?php echo esc_html( $localize_strings['comment'] ); ?></a>
456
							<?php endif ?>
457
							<?php if ( is_user_logged_in() && in_array( 'reblog_enabled', $localize_strings, true ) && $localize_strings['reblog_enabled'] ) : ?>
458
								<a class="jp-carousel-reblog" href="#"><?php echo esc_html( $localize_strings['reblog'] ); ?></a>
459
							<?php endif ?>
460
						</div>
461
						<ul class="jp-carousel-image-exif" style="display: none;"></ul>
462
						<a class="jp-carousel-image-download" style="display: none;"></a>
463
						<div class="jp-carousel-image-map" style="display: none;"></div>
464
					</div>
465
				</div>
466
			</div>
467
			<div class="jp-carousel-next-button" style="display: none;">
468
				<span></span>
469
			</div>
470
			<div class="jp-carousel-previous-button" style="display: none;">
471
				<span></span>
472
			</div>
473
			<div class="jp-carousel-close-hint"><span>&times;</span></div>
474
		</div>
475
476
		<?php
477
	}
478
479
	function set_in_gallery( $output ) {
480
		if (
481
			class_exists( 'Jetpack_AMP_Support' )
482
			&& Jetpack_AMP_Support::is_amp_request()
483
		) {
484
			return $output;
485
		}
486
		$this->in_gallery = true;
487
		return $output;
488
	}
489
490
	/**
491
	 * Adds data-* attributes required by carousel to img tags in post HTML
492
	 * content. To be used by 'the_content' filter.
493
	 *
494
	 * @see add_data_to_images()
495
	 * @see wp_make_content_images_responsive() in wp-includes/media.php
496
	 *
497
	 * @param string $content HTML content of the post
498
	 * @return string Modified HTML content of the post
499
	 */
500
	function add_data_img_tags_and_enqueue_assets( $content ) {
501
		if (
502
			class_exists( 'Jetpack_AMP_Support' )
503
			&& Jetpack_AMP_Support::is_amp_request()
504
		) {
505
			return $this->maybe_add_amp_lightbox( $content );
506
		}
507
508
		if ( ! preg_match_all( '/<img [^>]+>/', $content, $matches ) ) {
509
			return $content;
510
		}
511
		$selected_images = array();
512
		foreach ( $matches[0] as $image_html ) {
513
			if ( preg_match( '/(wp-image-|data-id=)\"?([0-9]+)\"?/i', $image_html, $class_id ) &&
514
				! preg_match( '/wp-block-jetpack-slideshow_image/', $image_html ) ) {
515
				$attachment_id = absint( $class_id[2] );
516
				/**
517
				 * If exactly the same image tag is used more than once, overwrite it.
518
				 * All identical tags will be replaced later with 'str_replace()'.
519
				 */
520
				$selected_images[ $attachment_id  ] = $image_html;
521
			}
522
		}
523
524
		$find    = array();
525
		$replace = array();
526
		if ( empty( $selected_images ) ) {
527
			return $content;
528
		}
529
530
		$attachments = get_posts(
531
			array(
532
				'include'          => array_keys( $selected_images ),
533
				'post_type'        => 'any',
534
				'post_status'      => 'any',
535
				'suppress_filters' => false,
536
			)
537
		);
538
539
		foreach ( $attachments as $attachment ) {
540
			$image_html = $selected_images[ $attachment->ID ];
541
542
			$attributes      = $this->add_data_to_images( array(), $attachment );
543
			$attributes_html = '';
544
			foreach ( $attributes as $k => $v ) {
545
				$attributes_html .= esc_attr( $k ) . '="' . esc_attr( $v ) . '" ';
546
			}
547
548
			$find[]    = $image_html;
549
			$replace[] = str_replace( '<img ', "<img $attributes_html", $image_html );
550
		}
551
552
		$content = str_replace( $find, $replace, $content );
553
		$this->enqueue_assets();
554
		return $content;
555
	}
556
557
	function add_data_to_images( $attr, $attachment = null ) {
558
		if (
559
			class_exists( 'Jetpack_AMP_Support' )
560
			&& Jetpack_AMP_Support::is_amp_request()
561
		) {
562
			return $attr;
563
		}
564
565
		$attachment_id = (int) $attachment->ID;
566
		if ( ! wp_attachment_is_image( $attachment_id ) ) {
567
			return $attr;
568
		}
569
570
		$orig_file       = wp_get_attachment_image_src( $attachment_id, 'full' );
571
		$orig_file       = isset( $orig_file[0] ) ? $orig_file[0] : wp_get_attachment_url( $attachment_id );
572
		$meta            = wp_get_attachment_metadata( $attachment_id );
573
		$size            = isset( $meta['width'] ) ? (int) $meta['width'] . ',' . (int) $meta['height'] : '';
574
		$img_meta        = ( ! empty( $meta['image_meta'] ) ) ? (array) $meta['image_meta'] : array();
575
		$comments_opened = (int) comments_open( $attachment_id );
576
577
		/**
578
		 * Note: Cannot generate a filename from the width and height wp_get_attachment_image_src() returns because
579
		 * it takes the $content_width global variable themes can set in consideration, therefore returning sizes
580
		 * which when used to generate a filename will likely result in a 404 on the image.
581
		 * $content_width has no filter we could temporarily de-register, run wp_get_attachment_image_src(), then
582
		 * re-register. So using returned file URL instead, which we can define the sizes from through filename
583
		 * parsing in the JS, as this is a failsafe file reference.
584
		 *
585
		 * EG with Twenty Eleven activated:
586
		 * 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) }
587
		 *
588
		 * EG with Twenty Ten activated:
589
		 * 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) }
590
		 */
591
592
		$medium_file_info = wp_get_attachment_image_src( $attachment_id, 'medium' );
593
		$medium_file      = isset( $medium_file_info[0] ) ? $medium_file_info[0] : '';
594
595
		$large_file_info = wp_get_attachment_image_src( $attachment_id, 'large' );
596
		$large_file      = isset( $large_file_info[0] ) ? $large_file_info[0] : '';
597
598
		$attachment       = get_post( $attachment_id );
599
		$attachment_title = wptexturize( $attachment->post_title );
600
		$attachment_desc  = wpautop( wptexturize( $attachment->post_content ) );
601
		// Not yet providing geo-data, need to "fuzzify" for privacy
602 View Code Duplication
		if ( ! empty( $img_meta ) ) {
603
			foreach ( $img_meta as $k => $v ) {
604
				if ( 'latitude' == $k || 'longitude' == $k ) {
605
					unset( $img_meta[ $k ] );
606
				}
607
			}
608
		}
609
610
		// See https://github.com/Automattic/jetpack/issues/2765
611
		if ( isset( $img_meta['keywords'] ) ) {
612
			unset( $img_meta['keywords'] );
613
		}
614
615
		$img_meta = json_encode( array_map( 'strval', array_filter( $img_meta, 'is_scalar' ) ) );
616
617
		$attr['data-attachment-id']     = $attachment_id;
618
		$attr['data-permalink']         = esc_attr( get_permalink( $attachment->ID ) );
619
		$attr['data-orig-file']         = esc_attr( $orig_file );
620
		$attr['data-orig-size']         = $size;
621
		$attr['data-comments-opened']   = $comments_opened;
622
		$attr['data-image-meta']        = esc_attr( $img_meta );
623
		$attr['data-image-title']       = esc_attr( htmlspecialchars( $attachment_title ) );
624
		$attr['data-image-description'] = esc_attr( htmlspecialchars( $attachment_desc ) );
625
		$attr['data-medium-file']       = esc_attr( $medium_file );
626
		$attr['data-large-file']        = esc_attr( $large_file );
627
628
		return $attr;
629
	}
630
631
	function add_data_to_container( $html ) {
632
		global $post;
633
		if (
634
			class_exists( 'Jetpack_AMP_Support' )
635
			&& Jetpack_AMP_Support::is_amp_request()
636
		) {
637
			return $html;
638
		}
639
640
		if ( isset( $post ) ) {
641
			$blog_id = (int) get_current_blog_id();
642
643
			$extra_data = array(
644
				'data-carousel-extra' => array(
645
					'blog_id'   => $blog_id,
646
					'permalink' => get_permalink( $post->ID ),
647
				),
648
			);
649
650
			/**
651
			 * Filter the data added to the Gallery container.
652
			 *
653
			 * @module carousel
654
			 *
655
			 * @since 1.6.0
656
			 *
657
			 * @param array $extra_data Array of data about the site and the post.
658
			 */
659
			$extra_data = apply_filters( 'jp_carousel_add_data_to_container', $extra_data );
660
			foreach ( (array) $extra_data as $data_key => $data_values ) {
661
				$html = str_replace( '<div ', '<div ' . esc_attr( $data_key ) . "='" . wp_json_encode( $data_values ) . "' ", $html );
662
				$html = str_replace( '<ul class="wp-block-gallery', '<ul ' . esc_attr( $data_key ) . "='" . wp_json_encode( $data_values ) . "' class=\"wp-block-gallery", $html );
663
				$html = str_replace( '<ul class="blocks-gallery-grid', '<ul ' . esc_attr( $data_key ) . "='" . wp_json_encode( $data_values ) . "' class=\"blocks-gallery-grid", $html );
664
				$html = str_replace( '<figure class="wp-block-gallery blocks-gallery-grid', '<figure ' . esc_attr( $data_key ) . "='" . wp_json_encode( $data_values ) . "' class=\"wp-block-gallery  blocks-gallery-grid", $html );
665
			}
666
		}
667
668
		return $html;
669
	}
670
671
	/**
672
	 * Conditionally adds amp-lightbox to galleries and images.
673
	 *
674
	 * This applies to gallery blocks and shortcodes,
675
	 * in addition to images that are wrapped in a link to the page.
676
	 * Images wrapped in a link to the media file shouldn't get an amp-lightbox.
677
	 *
678
	 * @param string $content The content to possibly add amp-lightbox to.
679
	 * @return string The content, with amp-lightbox possibly added.
680
	 */
681
	public function maybe_add_amp_lightbox( $content ) {
682
		$content = preg_replace(
683
			array(
684
				'#(<figure)[^>]*(?=class=(["\']?)[^>]*wp-block-gallery[^>]*\2)#is', // Gallery block.
685
				'#(\[gallery)(?=\s+)#', // Gallery shortcode.
686
			),
687
			array(
688
				'\1 data-amp-lightbox="true" ', // https://github.com/ampproject/amp-wp/blob/1094ea03bd5dc92889405a47a8c41de1a88908de/includes/sanitizers/class-amp-gallery-block-sanitizer.php#L84.
689
				'\1 amp-lightbox="true"', // https://github.com/ampproject/amp-wp/blob/1094ea03bd5dc92889405a47a8c41de1a88908de/includes/embeds/class-amp-gallery-embed.php#L64.
690
			),
691
			$content
692
		);
693
694
		return preg_replace_callback(
695
			'#(<a[^>]* href=(["\']?)(\S+)\2>)\s*(<img[^>]*)(class=(["\']?)[^>]*wp-image-[0-9]+[^>]*\6.*>)\s*</a>#is',
696
			static function( $matches ) {
697 View Code Duplication
				if ( ! preg_match( '#\.\w+$#', $matches[3] ) ) {
698
					// 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.
699
					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.
700
				}
701
702
				return $matches[0];
703
			},
704
			$content
705
		);
706
	}
707
708
	function get_attachment_comments() {
709
		if ( ! headers_sent() ) {
710
			header( 'Content-type: text/javascript' );
711
		}
712
713
		/**
714
		 * Allows for the checking of privileges of the blog user before comments
715
		 * are packaged as JSON and sent back from the get_attachment_comments
716
		 * AJAX endpoint
717
		 *
718
		 * @module carousel
719
		 *
720
		 * @since 1.6.0
721
		 */
722
		do_action( 'jp_carousel_check_blog_user_privileges' );
723
724
		$attachment_id = ( isset( $_REQUEST['id'] ) ) ? (int) $_REQUEST['id'] : 0;
725
		$offset        = ( isset( $_REQUEST['offset'] ) ) ? (int) $_REQUEST['offset'] : 0;
726
727
		if ( ! $attachment_id ) {
728
			echo json_encode( __( 'Missing attachment ID.', 'jetpack' ) );
729
			die();
730
		}
731
732
		if ( $offset < 1 ) {
733
			$offset = 0;
734
		}
735
736
		$comments = get_comments(
737
			array(
738
				'status'  => 'approve',
739
				'order'   => ( 'asc' == get_option( 'comment_order' ) ) ? 'ASC' : 'DESC',
740
				'number'  => 10,
741
				'offset'  => $offset,
742
				'post_id' => $attachment_id,
743
			)
744
		);
745
746
		$out = array();
747
748
		// Can't just send the results, they contain the commenter's email address.
749
		foreach ( $comments as $comment ) {
750
			$avatar = get_avatar( $comment->comment_author_email, 64 );
751
			if ( ! $avatar ) {
752
				$avatar = '';
753
			}
754
			$out[] = array(
755
				'id'              => $comment->comment_ID,
756
				'parent_id'       => $comment->comment_parent,
757
				'author_markup'   => get_comment_author_link( $comment->comment_ID ),
758
				'gravatar_markup' => $avatar,
759
				'date_gmt'        => $comment->comment_date_gmt,
760
				'content'         => wpautop( $comment->comment_content ),
761
			);
762
		}
763
764
		die( json_encode( $out ) );
765
	}
766
767
	function post_attachment_comment() {
768
		if ( ! headers_sent() ) {
769
			header( 'Content-type: text/javascript' );
770
		}
771
772
		if ( empty( $_POST['nonce'] ) || ! wp_verify_nonce( $_POST['nonce'], 'carousel_nonce' ) ) {
773
			die( json_encode( array( 'error' => __( 'Nonce verification failed.', 'jetpack' ) ) ) );
774
		}
775
776
		$_blog_id = (int) $_POST['blog_id'];
777
		$_post_id = (int) $_POST['id'];
778
		$comment  = $_POST['comment'];
779
780
		if ( empty( $_blog_id ) ) {
781
			die( json_encode( array( 'error' => __( 'Missing target blog ID.', 'jetpack' ) ) ) );
782
		}
783
784
		if ( empty( $_post_id ) ) {
785
			die( json_encode( array( 'error' => __( 'Missing target post ID.', 'jetpack' ) ) ) );
786
		}
787
788
		if ( empty( $comment ) ) {
789
			die( json_encode( array( 'error' => __( 'No comment text was submitted.', 'jetpack' ) ) ) );
790
		}
791
792
		// Used in context like NewDash
793
		$switched = false;
794
		if ( is_multisite() && $_blog_id != get_current_blog_id() ) {
795
			switch_to_blog( $_blog_id );
796
			$switched = true;
797
		}
798
799
		/** This action is documented in modules/carousel/jetpack-carousel.php */
800
		do_action( 'jp_carousel_check_blog_user_privileges' );
801
802 View Code Duplication
		if ( ! comments_open( $_post_id ) ) {
803
			if ( $switched ) {
804
				restore_current_blog();
805
			}
806
			die( json_encode( array( 'error' => __( 'Comments on this post are closed.', 'jetpack' ) ) ) );
807
		}
808
809
		if ( is_user_logged_in() ) {
810
			$user         = wp_get_current_user();
811
			$user_id      = $user->ID;
812
			$display_name = $user->display_name;
813
			$email        = $user->user_email;
814
			$url          = $user->user_url;
815
816 View Code Duplication
			if ( empty( $user_id ) ) {
817
				if ( $switched ) {
818
					restore_current_blog();
819
				}
820
				die( json_encode( array( 'error' => __( 'Sorry, but we could not authenticate your request.', 'jetpack' ) ) ) );
821
			}
822
		} else {
823
			$user_id      = 0;
824
			$display_name = $_POST['author'];
825
			$email        = $_POST['email'];
826
			$url          = $_POST['url'];
827
828
			if ( get_option( 'require_name_email' ) ) {
829 View Code Duplication
				if ( empty( $display_name ) ) {
830
					if ( $switched ) {
831
						restore_current_blog();
832
					}
833
					die( json_encode( array( 'error' => __( 'Please provide your name.', 'jetpack' ) ) ) );
834
				}
835
836 View Code Duplication
				if ( empty( $email ) ) {
837
					if ( $switched ) {
838
						restore_current_blog();
839
					}
840
					die( json_encode( array( 'error' => __( 'Please provide an email address.', 'jetpack' ) ) ) );
841
				}
842
843 View Code Duplication
				if ( ! is_email( $email ) ) {
844
					if ( $switched ) {
845
						restore_current_blog();
846
					}
847
					die( json_encode( array( 'error' => __( 'Please provide a valid email address.', 'jetpack' ) ) ) );
848
				}
849
			}
850
		}
851
852
		$comment_data = array(
853
			'comment_content'      => $comment,
854
			'comment_post_ID'      => $_post_id,
855
			'comment_author'       => $display_name,
856
			'comment_author_email' => $email,
857
			'comment_author_url'   => $url,
858
			'comment_approved'     => 0,
859
			'comment_type'         => 'comment',
860
		);
861
862
		if ( ! empty( $user_id ) ) {
863
			$comment_data['user_id'] = $user_id;
864
		}
865
866
		// Note: wp_new_comment() sanitizes and validates the values (too).
867
		$comment_id = wp_new_comment( $comment_data );
868
869
		/**
870
		 * Fires before adding a new comment to the database via the get_attachment_comments ajax endpoint.
871
		 *
872
		 * @module carousel
873
		 *
874
		 * @since 1.6.0
875
		 */
876
		do_action( 'jp_carousel_post_attachment_comment' );
877
		$comment_status = wp_get_comment_status( $comment_id );
878
879
		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...
880
			restore_current_blog();
881
		}
882
883
		die(
884
			json_encode(
885
				array(
886
					'comment_id'     => $comment_id,
887
					'comment_status' => $comment_status,
888
				)
889
			)
890
		);
891
	}
892
893
	function register_settings() {
894
		add_settings_section( 'carousel_section', __( 'Image Gallery Carousel', 'jetpack' ), array( $this, 'carousel_section_callback' ), 'media' );
895
896
		if ( ! $this->in_jetpack ) {
897
			add_settings_field( 'carousel_enable_it', __( 'Enable carousel', 'jetpack' ), array( $this, 'carousel_enable_it_callback' ), 'media', 'carousel_section' );
898
			register_setting( 'media', 'carousel_enable_it', array( $this, 'carousel_enable_it_sanitize' ) );
899
		}
900
901
		add_settings_field( 'carousel_background_color', __( 'Background color', 'jetpack' ), array( $this, 'carousel_background_color_callback' ), 'media', 'carousel_section' );
902
		register_setting( 'media', 'carousel_background_color', array( $this, 'carousel_background_color_sanitize' ) );
903
904
		add_settings_field( 'carousel_display_exif', __( 'Metadata', 'jetpack' ), array( $this, 'carousel_display_exif_callback' ), 'media', 'carousel_section' );
905
		register_setting( 'media', 'carousel_display_exif', array( $this, 'carousel_display_exif_sanitize' ) );
906
907
		add_settings_field( 'carousel_display_comments', __( 'Comments', 'jetpack' ), array( $this, 'carousel_display_comments_callback' ), 'media', 'carousel_section' );
908
		register_setting( 'media', 'carousel_display_comments', array( $this, 'carousel_display_comments_sanitize' ) );
909
910
		// No geo setting yet, need to "fuzzify" data first, for privacy
911
		// add_settings_field('carousel_display_geo', __( 'Geolocation', 'jetpack' ), array( $this, 'carousel_display_geo_callback' ), 'media', 'carousel_section' );
912
		// register_setting( 'media', 'carousel_display_geo', array( $this, 'carousel_display_geo_sanitize' ) );
913
	}
914
915
	// Fulfill the settings section callback requirement by returning nothing
916
	function carousel_section_callback() {
917
		return;
918
	}
919
920
	function test_1or0_option( $value, $default_to_1 = true ) {
921
		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...
922
			// Binary false (===) of $value means it has not yet been set, in which case we do want to default sites to 1
923
			if ( false === $value ) {
924
				$value = 1;
925
			}
926
		}
927
		return ( 1 == $value ) ? 1 : 0;
928
	}
929
930
	function sanitize_1or0_option( $value ) {
931
		return ( 1 == $value ) ? 1 : 0;
932
	}
933
934
	function settings_checkbox( $name, $label_text, $extra_text = '', $default_to_checked = true ) {
935
		if ( empty( $name ) ) {
936
			return;
937
		}
938
		$option = $this->test_1or0_option( get_option( $name ), $default_to_checked );
939
		echo '<fieldset>';
940
		echo '<input type="checkbox" name="' . esc_attr( $name ) . '" id="' . esc_attr( $name ) . '" value="1" ';
941
		checked( '1', $option );
942
		echo '/> <label for="' . esc_attr( $name ) . '">' . $label_text . '</label>';
943
		if ( ! empty( $extra_text ) ) {
944
			echo '<p class="description">' . $extra_text . '</p>';
945
		}
946
		echo '</fieldset>';
947
	}
948
949
	function settings_select( $name, $values, $extra_text = '' ) {
950
		if ( empty( $name ) || ! is_array( $values ) || empty( $values ) ) {
951
			return;
952
		}
953
		$option = get_option( $name );
954
		echo '<fieldset>';
955
		echo '<select name="' . esc_attr( $name ) . '" id="' . esc_attr( $name ) . '">';
956
		foreach ( $values as $key => $value ) {
957
			echo '<option value="' . esc_attr( $key ) . '" ';
958
			selected( $key, $option );
959
			echo '>' . esc_html( $value ) . '</option>';
960
		}
961
		echo '</select>';
962
		if ( ! empty( $extra_text ) ) {
963
			echo '<p class="description">' . $extra_text . '</p>';
964
		}
965
		echo '</fieldset>';
966
	}
967
968
	function carousel_display_exif_callback() {
969
		$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' ) );
970
	}
971
972
	/**
973
	 * Callback for checkbox and label of field that allows to toggle comments.
974
	 */
975
	public function carousel_display_comments_callback() {
976
		$this->settings_checkbox( 'carousel_display_comments', esc_html__( 'Show comments area in carousel', 'jetpack' ) );
977
	}
978
979
	function carousel_display_exif_sanitize( $value ) {
980
		return $this->sanitize_1or0_option( $value );
981
	}
982
983
	/**
984
	 * Return sanitized option for value that controls whether comments will be hidden or not.
985
	 *
986
	 * @param number $value Value to sanitize.
987
	 *
988
	 * @return number Sanitized value, only 1 or 0.
989
	 */
990
	public function carousel_display_comments_sanitize( $value ) {
991
		return $this->sanitize_1or0_option( $value );
992
	}
993
994
	function carousel_display_geo_callback() {
995
		$this->settings_checkbox( 'carousel_display_geo', __( 'Show map of photo location in carousel, when available.', 'jetpack' ) );
996
	}
997
998
	function carousel_display_geo_sanitize( $value ) {
999
		return $this->sanitize_1or0_option( $value );
1000
	}
1001
1002
	function carousel_background_color_callback() {
1003
		$this->settings_select(
1004
			'carousel_background_color', array(
1005
				'black' => __( 'Black', 'jetpack' ),
1006
				'white' => __( 'White', 'jetpack' ),
1007
			)
1008
		);
1009
	}
1010
1011
	function carousel_background_color_sanitize( $value ) {
1012
		return ( 'white' == $value ) ? 'white' : 'black';
1013
	}
1014
1015
	function carousel_enable_it_callback() {
1016
		$this->settings_checkbox( 'carousel_enable_it', __( 'Display images in full-size carousel slideshow.', 'jetpack' ) );
1017
	}
1018
1019
	function carousel_enable_it_sanitize( $value ) {
1020
		return $this->sanitize_1or0_option( $value );
1021
	}
1022
}
1023
1024
new Jetpack_Carousel;
1025