Completed
Push — update/improve-api-docs-again ( 94dfd5 )
by
unknown
18s
created

Jetpack_Carousel::post_attachment_comment()   D

Complexity

Conditions 18
Paths 76

Size

Total Lines 91
Code Lines 57

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 18
eloc 57
nc 76
nop 0
dl 0
loc 91
rs 4.7996
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
		$this->in_jetpack = ( class_exists( 'Jetpack' ) && method_exists( 'Jetpack', 'enable_module_configurable' ) ) ? true : false;
40
41
		$this->single_image_gallery_enabled = !$this->maybe_disable_jp_carousel_single_images();
42
		$this->single_image_gallery_enabled_media_file = $this->maybe_enable_jp_carousel_single_images_media_file();
43
44
		if ( is_admin() ) {
45
			// Register the Carousel-related related settings
46
			add_action( 'admin_init', array( $this, 'register_settings' ), 5 );
47
			if ( ! $this->in_jetpack ) {
48
				if ( 0 == $this->test_1or0_option( get_option( 'carousel_enable_it' ), true ) )
49
					return; // Carousel disabled, abort early, but still register setting so user can switch it back on
50
			}
51
			// If in admin, register the ajax endpoints.
52
			add_action( 'wp_ajax_get_attachment_comments', array( $this, 'get_attachment_comments' ) );
53
			add_action( 'wp_ajax_nopriv_get_attachment_comments', array( $this, 'get_attachment_comments' ) );
54
			add_action( 'wp_ajax_post_attachment_comment', array( $this, 'post_attachment_comment' ) );
55
			add_action( 'wp_ajax_nopriv_post_attachment_comment', array( $this, 'post_attachment_comment' ) );
56
		} else {
57
			if ( ! $this->in_jetpack ) {
58
				if ( 0 == $this->test_1or0_option( get_option( 'carousel_enable_it' ), true ) )
59
					return; // Carousel disabled, abort early
60
			}
61
			// If on front-end, do the Carousel thang.
62
			/**
63
			 * Filter the array of default prebuilt widths used in Carousel.
64
			 *
65
			 * @module carousel
66
			 *
67
			 * @since 1.6.0
68
			 *
69
			 * @param array $this->prebuilt_widths Array of default widths.
70
			 */
71
			$this->prebuilt_widths = apply_filters( 'jp_carousel_widths', $this->prebuilt_widths );
72
			// below: load later than other callbacks hooked it (e.g. 3rd party plugins handling gallery shortcode)
73
			add_filter( 'post_gallery', array( $this, 'check_if_shortcode_processed_and_enqueue_assets' ), 1000, 2 );
74
			add_filter( 'post_gallery', array( $this, 'set_in_gallery' ), -1000 );
75
			add_filter( 'gallery_style', array( $this, 'add_data_to_container' ) );
76
			add_filter( 'wp_get_attachment_image_attributes', array( $this, 'add_data_to_images' ), 10, 2 );
77
			if ( $this->single_image_gallery_enabled ) {
78
				add_filter( 'the_content', array( $this, 'add_data_img_tags_and_enqueue_assets' ) );
79
			}
80
		}
81
82
		if ( $this->in_jetpack && method_exists( 'Jetpack', 'module_configuration_load' ) ) {
83
			Jetpack::enable_module_configurable( dirname( dirname( __FILE__ ) ) . '/carousel.php' );
84
			Jetpack::module_configuration_load( dirname( dirname( __FILE__ ) ) . '/carousel.php', array( $this, 'jetpack_configuration_load' ) );
85
		}
86
	}
87
88
	function maybe_disable_jp_carousel() {
89
		/**
90
		 * Allow third-party plugins or themes to disable Carousel.
91
		 *
92
		 * @module carousel
93
		 *
94
		 * @since 1.6.0
95
		 *
96
		 * @param bool false Should Carousel be disabled? Default to false.
97
		 */
98
		return apply_filters( 'jp_carousel_maybe_disable', false );
99
	}
100
101
	function maybe_disable_jp_carousel_single_images() {
102
		/**
103
		 * Allow third-party plugins or themes to disable Carousel for single images.
104
		 *
105
		 * @module carousel
106
		 *
107
		 * @since 4.5.0
108
		 *
109
		 * @param bool false Should Carousel be disabled for single images? Default to false.
110
		 */
111
		return apply_filters( 'jp_carousel_maybe_disable_single_images', false );
112
	}
113
114
	function maybe_enable_jp_carousel_single_images_media_file() {
115
		/**
116
		 * Allow third-party plugins or themes to enable Carousel
117
		 * for single images linking to 'Media File' (full size image).
118
		 *
119
		 * @module carousel
120
		 *
121
		 * @since 4.5.0
122
		 *
123
		 * @param bool false Should Carousel be enabled for single images linking to 'Media File'? Default to false.
124
		 */
125
		return apply_filters( 'jp_carousel_load_for_images_linked_to_file', false );
126
	}
127
128
	function jetpack_configuration_load() {
129
		wp_safe_redirect( admin_url( 'options-media.php#carousel_background_color' ) );
130
		exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method jetpack_configuration_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
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
			! empty( $output ) &&
159
			/**
160
			 * Allow third-party plugins or themes to force-enable Carousel.
161
			 *
162
			 * @module carousel
163
			 *
164
			 * @since 1.9.0
165
			 *
166
			 * @param bool false Should we force enable Carousel? Default to false.
167
			 */
168
			! apply_filters( 'jp_carousel_force_enable', false )
169
		) {
170
			// Bail because someone is overriding the [gallery] shortcode.
171
			remove_filter( 'gallery_style', array( $this, 'add_data_to_container' ) );
172
			remove_filter( 'wp_get_attachment_image_attributes', array( $this, 'add_data_to_images' ) );
173
			remove_filter( 'the_content', array( $this, 'add_data_img_tags_and_enqueue_assets' ) );
174
			// Display message that carousel has bailed, if user is super_admin, and if we're not on WordPress.com.
175
			if (
176
				is_super_admin() &&
177
				! ( defined( 'IS_WPCOM' ) && IS_WPCOM )
178
			) {
179
				add_filter( 'post_gallery', array( $this, 'display_bail_message' ) );
180
			}
181
			return $output;
182
		}
183
184
		/**
185
		 * Fires when thumbnails are shown in Carousel.
186
		 *
187
		 * @module carousel
188
		 *
189
		 * @since 1.6.0
190
		 **/
191
		do_action( 'jp_carousel_thumbnails_shown' );
192
193
		$this->enqueue_assets();
194
195
		return $output;
196
	}
197
198
	function enqueue_assets() {
199
		if ( $this->first_run ) {
200
			wp_enqueue_script( 'jetpack-carousel', plugins_url( 'jetpack-carousel.js', __FILE__ ), array( 'jquery.spin' ), $this->asset_version( '20170209' ), true );
201
202
			// 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)
203
			// Also: not hardcoding path since there is no guarantee site is running on site root in self-hosted context.
204
			$is_logged_in = is_user_logged_in();
205
			$current_user = wp_get_current_user();
206
			$comment_registration = intval( get_option( 'comment_registration' ) );
207
			$require_name_email   = intval( get_option( 'require_name_email' ) );
208
			$localize_strings = array(
209
				'widths'               => $this->prebuilt_widths,
210
				'is_logged_in'         => $is_logged_in,
211
				'lang'                 => strtolower( substr( get_locale(), 0, 2 ) ),
212
				'ajaxurl'              => set_url_scheme( admin_url( 'admin-ajax.php' ) ),
213
				'nonce'                => wp_create_nonce( 'carousel_nonce' ),
214
				'display_exif'         => $this->test_1or0_option( Jetpack_Options::get_option_and_ensure_autoload( 'carousel_display_exif', true ) ),
215
				'display_geo'          => $this->test_1or0_option( Jetpack_Options::get_option_and_ensure_autoload( 'carousel_display_geo', true ) ),
216
				'single_image_gallery' => $this->single_image_gallery_enabled,
217
				'single_image_gallery_media_file' => $this->single_image_gallery_enabled_media_file,
218
				'background_color'     => $this->carousel_background_color_sanitize( Jetpack_Options::get_option_and_ensure_autoload( 'carousel_background_color', '' ) ),
219
				'comment'              => __( 'Comment', 'jetpack' ),
220
				'post_comment'         => __( 'Post Comment', 'jetpack' ),
221
				'write_comment'        => __( 'Write a Comment...', 'jetpack' ),
222
				'loading_comments'     => __( 'Loading Comments...', 'jetpack' ),
223
				'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}' ),
224
				'no_comment_text'      => __( 'Please be sure to submit some text with your comment.', 'jetpack' ),
225
				'no_comment_email'     => __( 'Please provide an email address to comment.', 'jetpack' ),
226
				'no_comment_author'    => __( 'Please provide your name to comment.', 'jetpack' ),
227
				'comment_post_error'   => __( 'Sorry, but there was an error posting your comment. Please try again later.', 'jetpack' ),
228
				'comment_approved'     => __( 'Your comment was approved.', 'jetpack' ),
229
				'comment_unapproved'   => __( 'Your comment is in moderation.', 'jetpack' ),
230
				'camera'               => __( 'Camera', 'jetpack' ),
231
				'aperture'             => __( 'Aperture', 'jetpack' ),
232
				'shutter_speed'        => __( 'Shutter Speed', 'jetpack' ),
233
				'focal_length'         => __( 'Focal Length', 'jetpack' ),
234
				'copyright'            => __( 'Copyright', 'jetpack' ),
235
				'comment_registration' => $comment_registration,
236
				'require_name_email'   => $require_name_email,
237
				/** This action is documented in core/src/wp-includes/link-template.php */
238
				'login_url'            => wp_login_url( apply_filters( 'the_permalink', get_permalink() ) ),
239
				'blog_id'              => (int) get_current_blog_id(),
240
				'meta_data'            => array( 'camera', 'aperture', 'shutter_speed', 'focal_length', 'copyright' )
241
			);
242
243
			if ( ! isset( $localize_strings['jetpack_comments_iframe_src'] ) || empty( $localize_strings['jetpack_comments_iframe_src'] ) ) {
244
				// We're not using Comments after all, so fallback to standard local comments.
245
246
				if ( $is_logged_in ) {
247
					$localize_strings['local_comments_commenting_as'] = '<p id="jp-carousel-commenting-as">' . sprintf( __( 'Commenting as %s', 'jetpack' ), $current_user->data->display_name ) . '</p>';
248
				} else {
249
					if ( $comment_registration ) {
250
						$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>';
251
					} else {
252
						$required = ( $require_name_email ) ? __( '%s (Required)', 'jetpack' ) : '%s';
253
						$localize_strings['local_comments_commenting_as'] = ''
254
							. '<fieldset><label for="email">' . sprintf( $required, __( 'Email', 'jetpack' ) ) . '</label> '
255
							. '<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>'
256
							. '<fieldset><label for="author">' . sprintf( $required, __( 'Name', 'jetpack' ) ) . '</label> '
257
							. '<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>'
258
							. '<fieldset><label for="url">' . __( 'Website', 'jetpack' ) . '</label> '
259
							. '<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>';
260
						}
261
				}
262
			}
263
264
			/**
265
			 * Handle WP stats for images in full-screen.
266
			 * Build string with tracking info.
267
			 */
268
269
			/**
270
			 * Filter if Jetpack should enable stats collection on carousel views
271
			 *
272
			 * @module carousel
273
			 *
274
			 * @since 4.3.2
275
			 *
276
			 * @param bool Enable Jetpack Carousel stat collection. Default false.
277
			 */
278
			if ( apply_filters( 'jetpack_enable_carousel_stats', false ) && in_array( 'stats', Jetpack::get_active_modules() ) && ! Jetpack::is_development_mode() ) {
279
				$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;
280
281
				// Set the stats as empty if user is logged in but logged-in users shouldn't be tracked.
282 View Code Duplication
				if ( is_user_logged_in() && function_exists( 'stats_get_options' ) ) {
283
					$stats_options = stats_get_options();
284
					$track_loggedin_users = isset( $stats_options['reg_users'] ) ? (bool) $stats_options['reg_users'] : false;
285
286
					if ( ! $track_loggedin_users ) {
287
						$localize_strings['stats'] = '';
288
					}
289
				}
290
			}
291
292
			/**
293
			 * Filter the strings passed to the Carousel's js file.
294
			 *
295
			 * @module carousel
296
			 *
297
			 * @since 1.6.0
298
			 *
299
			 * @param array $localize_strings Array of strings passed to the Jetpack js file.
300
			 */
301
			$localize_strings = apply_filters( 'jp_carousel_localize_strings', $localize_strings );
302
			wp_localize_script( 'jetpack-carousel', 'jetpackCarouselStrings', $localize_strings );
303
			wp_enqueue_style( 'jetpack-carousel', plugins_url( 'jetpack-carousel.css', __FILE__ ), array(), $this->asset_version( '20120629' ) );
304
			wp_style_add_data( 'jetpack-carousel', 'rtl', 'replace' );
305
306
			wp_register_style( 'jetpack-carousel-ie8fix', plugins_url( 'jetpack-carousel-ie8fix.css', __FILE__ ), array(), $this->asset_version( '20121024' ) );
307
			$GLOBALS['wp_styles']->add_data( 'jetpack-carousel-ie8fix', 'conditional', 'lte IE 8' );
308
			wp_enqueue_style( 'jetpack-carousel-ie8fix' );
309
310
			/**
311
			 * Fires after carousel assets are enqueued for the first time.
312
			 * Allows for adding additional assets to the carousel page.
313
			 *
314
			 * @module carousel
315
			 *
316
			 * @since 1.6.0
317
			 *
318
			 * @param bool $first_run First load if Carousel on the page.
319
			 * @param array $localized_strings Array of strings passed to the Jetpack js file.
320
			 */
321
			do_action( 'jp_carousel_enqueue_assets', $this->first_run, $localize_strings );
322
323
			$this->first_run = false;
324
		}
325
	}
326
327
	function set_in_gallery( $output ) {
328
		$this->in_gallery = true;
329
		return $output;
330
	}
331
332
	/**
333
	 * Adds data-* attributes required by carousel to img tags in post HTML
334
	 * content. To be used by 'the_content' filter.
335
	 *
336
	 * @see add_data_to_images()
337
	 * @see wp_make_content_images_responsive() in wp-includes/media.php
338
	 *
339
	 * @param string $content HTML content of the post
340
	 * @return string Modified HTML content of the post
341
	 */
342
	function add_data_img_tags_and_enqueue_assets( $content ) {
343
		if ( ! preg_match_all( '/<img [^>]+>/', $content, $matches ) ) {
344
			return $content;
345
		}
346
		$selected_images = array();
347
348
		foreach( $matches[0] as $image_html ) {
349
			if ( preg_match( '/wp-image-([0-9]+)/i', $image_html, $class_id ) &&
350
				( $attachment_id = absint( $class_id[1] ) ) ) {
351
352
				/*
353
				 * If exactly the same image tag is used more than once, overwrite it.
354
				 * All identical tags will be replaced later with 'str_replace()'.
355
				 */
356
				$selected_images[ $attachment_id  ] = $image_html;
357
			}
358
		}
359
360
		foreach ( $selected_images as $attachment_id => $image_html ) {
361
			$attachment = get_post( $attachment_id );
362
363
			if ( ! $attachment ) {
364
				continue;
365
			}
366
367
			$attributes = $this->add_data_to_images( array(), $attachment );
368
			$attributes_html = '';
369
			foreach( $attributes as $k => $v ) {
370
				$attributes_html .= esc_attr( $k ) . '="' . esc_attr( $v ) . '" ';
371
			}
372
			$image_html_with_data = str_replace( '<img ', "<img $attributes_html", $image_html );
373
			$content = str_replace( $image_html, $image_html_with_data, $content );
374
		}
375
		$this->enqueue_assets();
376
		return $content;
377
	}
378
379
	function add_data_to_images( $attr, $attachment = null ) {
380
		$attachment_id   = intval( $attachment->ID );
381
		$orig_file       = wp_get_attachment_image_src( $attachment_id, 'full' );
382
		$orig_file       = isset( $orig_file[0] ) ? $orig_file[0] : wp_get_attachment_url( $attachment_id );
383
		$meta            = wp_get_attachment_metadata( $attachment_id );
384
		$size            = isset( $meta['width'] ) ? intval( $meta['width'] ) . ',' . intval( $meta['height'] ) : '';
385
		$img_meta        = ( ! empty( $meta['image_meta'] ) ) ? (array) $meta['image_meta'] : array();
386
		$comments_opened = intval( comments_open( $attachment_id ) );
387
388
		 /*
389
		 * Note: Cannot generate a filename from the width and height wp_get_attachment_image_src() returns because
390
		 * it takes the $content_width global variable themes can set in consideration, therefore returning sizes
391
		 * which when used to generate a filename will likely result in a 404 on the image.
392
		 * $content_width has no filter we could temporarily de-register, run wp_get_attachment_image_src(), then
393
		 * re-register. So using returned file URL instead, which we can define the sizes from through filename
394
		 * parsing in the JS, as this is a failsafe file reference.
395
		 *
396
		 * EG with Twenty Eleven activated:
397
		 * 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) }
398
		 *
399
		 * EG with Twenty Ten activated:
400
		 * 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) }
401
		 */
402
403
		$medium_file_info = wp_get_attachment_image_src( $attachment_id, 'medium' );
404
		$medium_file      = isset( $medium_file_info[0] ) ? $medium_file_info[0] : '';
405
406
		$large_file_info  = wp_get_attachment_image_src( $attachment_id, 'large' );
407
		$large_file       = isset( $large_file_info[0] ) ? $large_file_info[0] : '';
408
409
		$attachment       = get_post( $attachment_id );
410
		$attachment_title = wptexturize( $attachment->post_title );
411
		$attachment_desc  = wpautop( wptexturize( $attachment->post_content ) );
412
		// Not yet providing geo-data, need to "fuzzify" for privacy
413 View Code Duplication
		if ( ! empty( $img_meta ) ) {
414
			foreach ( $img_meta as $k => $v ) {
415
				if ( 'latitude' == $k || 'longitude' == $k )
416
					unset( $img_meta[$k] );
417
			}
418
		}
419
420
		// See https://github.com/Automattic/jetpack/issues/2765
421
		if ( isset( $img_meta['keywords'] ) ) {
422
			unset( $img_meta['keywords'] );
423
		}
424
425
		$img_meta = json_encode( array_map( 'strval', $img_meta ) );
426
427
		$attr['data-attachment-id']     = $attachment_id;
428
		$attr['data-permalink']         = esc_attr( get_permalink( $attachment->ID ) );
429
		$attr['data-orig-file']         = esc_attr( $orig_file );
430
		$attr['data-orig-size']         = $size;
431
		$attr['data-comments-opened']   = $comments_opened;
432
		$attr['data-image-meta']        = esc_attr( $img_meta );
433
		$attr['data-image-title']       = esc_attr( htmlspecialchars( $attachment_title ) );
434
		$attr['data-image-description'] = esc_attr( htmlspecialchars( $attachment_desc ) );
435
		$attr['data-medium-file']       = esc_attr( $medium_file );
436
		$attr['data-large-file']        = esc_attr( $large_file );
437
438
		return $attr;
439
	}
440
441
	function add_data_to_container( $html ) {
442
		global $post;
443
444
		if ( isset( $post ) ) {
445
			$blog_id = (int) get_current_blog_id();
446
447
			$extra_data = array(
448
				'data-carousel-extra' => array(
449
					'blog_id' => $blog_id,
450
					'permalink' => get_permalink( $post->ID ),
451
					)
452
				);
453
454
			/**
455
			 * Filter the data added to the Gallery container.
456
			 *
457
			 * @module carousel
458
			 *
459
			 * @since 1.6.0
460
			 *
461
			 * @param array $extra_data Array of data about the site and the post.
462
			 */
463
			$extra_data = apply_filters( 'jp_carousel_add_data_to_container', $extra_data );
464
			foreach ( (array) $extra_data as $data_key => $data_values ) {
465
				$html = str_replace( '<div ', '<div ' . esc_attr( $data_key ) . "='" . json_encode( $data_values ) . "' ", $html );
466
			}
467
		}
468
469
		return $html;
470
	}
471
472
	function get_attachment_comments() {
473
		if ( ! headers_sent() )
474
			header('Content-type: text/javascript');
475
476
		/**
477
		 * Allows for the checking of privileges of the blog user before comments
478
		 * are packaged as JSON and sent back from the get_attachment_comments
479
		 * AJAX endpoint
480
		 *
481
		 * @module carousel
482
		 *
483
		 * @since 1.6.0
484
		 */
485
		do_action('jp_carousel_check_blog_user_privileges');
486
487
		$attachment_id = ( isset( $_REQUEST['id'] ) ) ? (int) $_REQUEST['id'] : 0;
488
		$offset        = ( isset( $_REQUEST['offset'] ) ) ? (int) $_REQUEST['offset'] : 0;
489
490
		if ( ! $attachment_id ) {
491
			echo json_encode( __( 'Missing attachment ID.', 'jetpack' ) );
492
			die();
0 ignored issues
show
Coding Style Compatibility introduced by
The method get_attachment_comments() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
493
		}
494
495
		if ( $offset < 1 )
496
			$offset = 0;
497
498
		$comments = get_comments( array(
499
			'status'  => 'approve',
500
			'order'   => ( 'asc' == get_option('comment_order') ) ? 'ASC' : 'DESC',
501
			'number'  => 10,
502
			'offset'  => $offset,
503
			'post_id' => $attachment_id,
504
		) );
505
506
		$out      = array();
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 6 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
507
508
		// Can't just send the results, they contain the commenter's email address.
509
		foreach ( $comments as $comment ) {
510
			$avatar = get_avatar( $comment->comment_author_email, 64 );
511
			if( ! $avatar )
512
				$avatar = '';
513
			$out[] = array(
514
				'id'              => $comment->comment_ID,
515
				'parent_id'       => $comment->comment_parent,
516
				'author_markup'   => get_comment_author_link( $comment->comment_ID ),
517
				'gravatar_markup' => $avatar,
518
				'date_gmt'        => $comment->comment_date_gmt,
519
				'content'         => wpautop($comment->comment_content),
520
			);
521
		}
522
523
		die( json_encode( $out ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method get_attachment_comments() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
524
	}
525
526
	function post_attachment_comment() {
527
		if ( ! headers_sent() )
528
			header('Content-type: text/javascript');
529
530
		if ( empty( $_POST['nonce'] ) || ! wp_verify_nonce($_POST['nonce'], 'carousel_nonce') )
531
			die( json_encode( array( 'error' => __( 'Nonce verification failed.', 'jetpack' ) ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method post_attachment_comment() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
532
533
		$_blog_id = (int) $_POST['blog_id'];
534
		$_post_id = (int) $_POST['id'];
535
		$comment = $_POST['comment'];
536
537
		if ( empty( $_blog_id ) )
538
			die( json_encode( array( 'error' => __( 'Missing target blog ID.', 'jetpack' ) ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method post_attachment_comment() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
539
540
		if ( empty( $_post_id ) )
541
			die( json_encode( array( 'error' => __( 'Missing target post ID.', 'jetpack' ) ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method post_attachment_comment() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
542
543
		if ( empty( $comment ) )
544
			die( json_encode( array( 'error' => __( 'No comment text was submitted.', 'jetpack' ) ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method post_attachment_comment() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
545
546
		// Used in context like NewDash
547
		$switched = false;
548
		if ( is_multisite() && $_blog_id != get_current_blog_id() ) {
549
			switch_to_blog( $_blog_id );
550
			$switched = true;
551
		}
552
553
		/** This action is documented in modules/carousel/jetpack-carousel.php */
554
		do_action('jp_carousel_check_blog_user_privileges');
555
556
		if ( ! comments_open( $_post_id ) )
557
			die( json_encode( array( 'error' => __( 'Comments on this post are closed.', 'jetpack' ) ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method post_attachment_comment() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
558
559
		if ( is_user_logged_in() ) {
560
			$user         = wp_get_current_user();
561
			$user_id      = $user->ID;
562
			$display_name = $user->display_name;
563
			$email        = $user->user_email;
564
			$url          = $user->user_url;
565
566
			if ( empty( $user_id ) )
567
				die( json_encode( array( 'error' => __( 'Sorry, but we could not authenticate your request.', 'jetpack' ) ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method post_attachment_comment() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
568
		} else {
569
			$user_id      = 0;
570
			$display_name = $_POST['author'];
571
			$email        = $_POST['email'];
572
			$url          = $_POST['url'];
573
574
			if ( get_option( 'require_name_email' ) ) {
575
				if ( empty( $display_name ) )
576
					die( json_encode( array( 'error' => __( 'Please provide your name.', 'jetpack' ) ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method post_attachment_comment() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
577
578
				if ( empty( $email ) )
579
					die( json_encode( array( 'error' => __( 'Please provide an email address.', 'jetpack' ) ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method post_attachment_comment() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
580
581
				if ( ! is_email( $email ) )
582
					die( json_encode( array( 'error' => __( 'Please provide a valid email address.', 'jetpack' ) ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method post_attachment_comment() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
583
			}
584
		}
585
586
		$comment_data =  array(
587
			'comment_content'      => $comment,
588
			'comment_post_ID'      => $_post_id,
589
			'comment_author'       => $display_name,
590
			'comment_author_email' => $email,
591
			'comment_author_url'   => $url,
592
			'comment_approved'     => 0,
593
			'comment_type'         => '',
594
		);
595
596
		if ( ! empty( $user_id ) )
597
			$comment_data['user_id'] = $user_id;
598
599
		// Note: wp_new_comment() sanitizes and validates the values (too).
600
		$comment_id = wp_new_comment( $comment_data );
601
602
		/**
603
		 * Fires before adding a new comment to the database via the get_attachment_comments ajax endpoint.
604
		 *
605
		 * @module carousel
606
		 *
607
		 * @since 1.6.0
608
		 */
609
		do_action( 'jp_carousel_post_attachment_comment' );
610
		$comment_status = wp_get_comment_status( $comment_id );
611
612
		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...
613
			restore_current_blog();
614
615
		die( json_encode( array( 'comment_id' => $comment_id, 'comment_status' => $comment_status ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method post_attachment_comment() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
616
	}
617
618
	function register_settings() {
619
		add_settings_section('carousel_section', __( 'Image Gallery Carousel', 'jetpack' ), array( $this, 'carousel_section_callback' ), 'media');
620
621
		if ( ! $this->in_jetpack ) {
622
			add_settings_field('carousel_enable_it', __( 'Enable carousel', 'jetpack' ), array( $this, 'carousel_enable_it_callback' ), 'media', 'carousel_section' );
623
			register_setting( 'media', 'carousel_enable_it', array( $this, 'carousel_enable_it_sanitize' ) );
624
		}
625
626
		add_settings_field('carousel_background_color', __( 'Background color', 'jetpack' ), array( $this, 'carousel_background_color_callback' ), 'media', 'carousel_section' );
627
		register_setting( 'media', 'carousel_background_color', array( $this, 'carousel_background_color_sanitize' ) );
628
629
		add_settings_field('carousel_display_exif', __( 'Metadata', 'jetpack'), array( $this, 'carousel_display_exif_callback' ), 'media', 'carousel_section' );
630
		register_setting( 'media', 'carousel_display_exif', array( $this, 'carousel_display_exif_sanitize' ) );
631
632
		// No geo setting yet, need to "fuzzify" data first, for privacy
633
		// add_settings_field('carousel_display_geo', __( 'Geolocation', 'jetpack' ), array( $this, 'carousel_display_geo_callback' ), 'media', 'carousel_section' );
634
		// register_setting( 'media', 'carousel_display_geo', array( $this, 'carousel_display_geo_sanitize' ) );
635
	}
636
637
	// Fulfill the settings section callback requirement by returning nothing
638
	function carousel_section_callback() {
639
		return;
640
	}
641
642
	function test_1or0_option( $value, $default_to_1 = true ) {
643
		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...
644
			// Binary false (===) of $value means it has not yet been set, in which case we do want to default sites to 1
645
			if ( false === $value )
646
				$value = 1;
647
		}
648
		return ( 1 == $value ) ? 1 : 0;
649
	}
650
651
	function sanitize_1or0_option( $value ) {
652
		return ( 1 == $value ) ? 1 : 0;
653
	}
654
655
	function settings_checkbox($name, $label_text, $extra_text = '', $default_to_checked = true) {
656
		if ( empty( $name ) )
657
			return;
658
		$option = $this->test_1or0_option( get_option( $name ), $default_to_checked );
659
		echo '<fieldset>';
660
		echo '<input type="checkbox" name="'.esc_attr($name).'" id="'.esc_attr($name).'" value="1" ';
661
		checked( '1', $option );
662
		echo '/> <label for="'.esc_attr($name).'">'.$label_text.'</label>';
663
		if ( ! empty( $extra_text ) )
664
			echo '<p class="description">'.$extra_text.'</p>';
665
		echo '</fieldset>';
666
	}
667
668
	function settings_select($name, $values, $extra_text = '') {
669
		if ( empty( $name ) || ! is_array( $values ) || empty( $values ) )
670
			return;
671
		$option = get_option( $name );
672
		echo '<fieldset>';
673
		echo '<select name="'.esc_attr($name).'" id="'.esc_attr($name).'">';
674
		foreach( $values as $key => $value ) {
675
			echo '<option value="'.esc_attr($key).'" ';
676
			selected( $key, $option );
677
			echo '>'.esc_html($value).'</option>';
678
		}
679
		echo '</select>';
680
		if ( ! empty( $extra_text ) )
681
			echo '<p class="description">'.$extra_text.'</p>';
682
		echo '</fieldset>';
683
	}
684
685
	function carousel_display_exif_callback() {
686
		$this->settings_checkbox( 'carousel_display_exif', __( 'Show photo metadata (<a href="http://en.wikipedia.org/wiki/Exchangeable_image_file_format" target="_blank">Exif</a>) in carousel, when available.', 'jetpack' ) );
687
	}
688
689
	function carousel_display_exif_sanitize( $value ) {
690
		return $this->sanitize_1or0_option( $value );
691
	}
692
693
	function carousel_display_geo_callback() {
694
		$this->settings_checkbox( 'carousel_display_geo', __( 'Show map of photo location in carousel, when available.', 'jetpack' ) );
695
	}
696
697
	function carousel_display_geo_sanitize( $value ) {
698
		return $this->sanitize_1or0_option( $value );
699
	}
700
701
	function carousel_background_color_callback() {
702
		$this->settings_select( 'carousel_background_color', array( 'black' => __( 'Black', 'jetpack' ), 'white' => __( 'White', 'jetpack', 'jetpack' ) ) );
703
	}
704
705
	function carousel_background_color_sanitize( $value ) {
706
		return ( 'white' == $value ) ? 'white' : 'black';
707
	}
708
709
	function carousel_enable_it_callback() {
710
		$this->settings_checkbox( 'carousel_enable_it', __( 'Display images in full-size carousel slideshow.', 'jetpack' ) );
711
	}
712
713
	function carousel_enable_it_sanitize( $value ) {
714
		return $this->sanitize_1or0_option( $value );
715
	}
716
}
717
718
new Jetpack_Carousel;
719