Issues in CMB2_Ajax.php - New Issues - Inspection of "Merge pull request #938 from bradp/phpcs-wp-vip-fi..." - WebDevStudios/CMB2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — trunk ( 177664...aedc6e )

unknown

created 2017-04-03 19:52 UTC

includes/CMB2_Ajax.php (1 issue)

Labels

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

/**
 * CMB2 ajax methods
 * (i.e. a lot of work to get oEmbeds to work with non-post objects)
 *
 * @since  0.9.5
 *
 * @category  WordPress_Plugin
 * @package   CMB2
 * @author    WebDevStudios
 * @license   GPL-2.0+
 */
class CMB2_Ajax {

	// Whether to hijack the oembed cache system
	protected $hijack      = false;
	protected $object_id   = 0;
	protected $embed_args  = array();
	protected $object_type = 'post';
	protected $ajax_update = false;

	/**
	 * Instance of this class
	 *
	 * @since 2.2.2
	 * @var object
	 */
	protected static $instance;

	/**
	 * Get the singleton instance of this class
	 *
	 * @since 2.2.2
	 * @return CMB2_Ajax
	 */
	public static function get_instance() {
		if ( ! ( self::$instance instanceof self ) ) {
			self::$instance = new self();
		}

		return self::$instance;
	}

	/**
	 * Constructor
	 *
	 * @since 2.2.0
	 */
	protected function __construct() {
		add_action( 'wp_ajax_cmb2_oembed_handler', array( $this, 'oembed_handler' ) );
		add_action( 'wp_ajax_nopriv_cmb2_oembed_handler', array( $this, 'oembed_handler' ) );
		// Need to occasionally clean stale oembed cache data from the option value.
		add_action( 'cmb2_save_options-page_fields', array( __CLASS__, 'clean_stale_options_page_oembeds' ) );
	}

	/**
	 * Handles our oEmbed ajax request
	 *
	 * @since  0.9.5
	 * @return object oEmbed embed code | fallback | error message
	 */
	public function oembed_handler() {

		// Verify our nonce
		if ( ! ( isset( $_REQUEST['cmb2_ajax_nonce'], $_REQUEST['oembed_url'] ) && wp_verify_nonce( $_REQUEST['cmb2_ajax_nonce'], 'ajax_nonce' ) ) ) {
			die();
		}

		// Sanitize our search string
		$oembed_string = sanitize_text_field( $_REQUEST['oembed_url'] );

		// Send back error if empty
		if ( empty( $oembed_string ) ) {
			wp_send_json_error( '<p class="ui-state-error-text">' . esc_html__( 'Please Try Again', 'cmb2' ) . '</p>' );
		}

		// Set width of embed
		$embed_width = isset( $_REQUEST['oembed_width'] ) && intval( $_REQUEST['oembed_width'] ) < 640 ? intval( $_REQUEST['oembed_width'] ) : '640';

		// Set url
		$oembed_url = esc_url( $oembed_string );

		// Set args
		$embed_args = array(
			'width' => $embed_width,
		);

		$this->ajax_update = true;

		// Get embed code (or fallback link)
		$html = $this->get_oembed( array(
			'url'         => $oembed_url,
			'object_id'   => $_REQUEST['object_id'],
			'object_type' => isset( $_REQUEST['object_type'] ) ? $_REQUEST['object_type'] : 'post',
			'oembed_args' => $embed_args,
			'field_id'    => $_REQUEST['field_id'],
		) );

		wp_send_json_success( $html );
	}

	/**
	 * Retrieves oEmbed from url/object ID
	 *
	 * @since  0.9.5
	 * @param  array $args      Arguments for method
	 * @return string            html markup with embed or fallback
	 */
	public function get_oembed_no_edit( $args ) {
		global $wp_embed;

		$oembed_url = esc_url( $args['url'] );

		// Sanitize object_id
		$this->object_id = is_numeric( $args['object_id'] ) ? absint( $args['object_id'] ) : sanitize_text_field( $args['object_id'] );

		$args = wp_parse_args( $args, array(
			'object_type' => 'post',
			'oembed_args' => $this->embed_args,
			'field_id'    => false,
			'wp_error'    => false,
		) );

		$this->embed_args =& $args;

		/**
		 * Set the post_ID so oEmbed won't fail
		 * wp-includes/class-wp-embed.php, WP_Embed::shortcode()
		 */
		$wp_embed->post_ID = $this->object_id;

		// Special scenario if NOT a post object
		if ( isset( $args['object_type'] ) && 'post' != $args['object_type'] ) {

			if ( 'options-page' == $args['object_type'] ) {

				// Bogus id to pass some numeric checks. Issue with a VERY large WP install?
				$wp_embed->post_ID = 1987645321;
			}

			// Ok, we need to hijack the oembed cache system
			$this->hijack = true;
			$this->object_type = $args['object_type'];

			// Gets ombed cache from our object's meta (vs postmeta)
			add_filter( 'get_post_metadata', array( $this, 'hijack_oembed_cache_get' ), 10, 3 );

			// Sets ombed cache in our object's meta (vs postmeta)
			add_filter( 'update_post_metadata', array( $this, 'hijack_oembed_cache_set' ), 10, 4 );

		}

		$embed_args = '';

		foreach ( $args['oembed_args'] as $key => $val ) {
			$embed_args .= " $key=\"$val\"";
		}

		// Ping WordPress for an embed
		$embed = $wp_embed->run_shortcode( '[embed' . $embed_args . ']' . $oembed_url . '[/embed]' );

		// Fallback that WordPress creates when no oEmbed was found
		$fallback = $wp_embed->maybe_make_link( $oembed_url );

		return compact( 'embed', 'fallback', 'args' );
	}

	/**
	 * Retrieves oEmbed from url/object ID
	 *
	 * @since  0.9.5
	 * @param  array $args      Arguments for method
	 * @return string            html markup with embed or fallback
	 */
	public function get_oembed( $args ) {
		$oembed = $this->get_oembed_no_edit( $args );

		// Send back our embed
		if ( $oembed['embed'] && $oembed['embed'] != $oembed['fallback'] ) {
			return '<div class="cmb2-oembed embed-status">' . $oembed['embed'] . '<p class="cmb2-remove-wrapper"><a href="#" class="cmb2-remove-file-button" rel="' . $oembed['args']['field_id'] . '">' . esc_html__( 'Remove Embed', 'cmb2' ) . '</a></p></div>';
		}

		// Otherwise, send back error info that no oEmbeds were found
		return sprintf(
			'<p class="ui-state-error-text">%s</p>',
			sprintf(
				/* translators: 1: results for. 2: link to codex.wordpress.org/Embeds */
				esc_html__( 'No oEmbed Results Found for %1$s. View more info at %2$s.', 'cmb2' ),
				$oembed['fallback'],
				'<a href="https://codex.wordpress.org/Embeds" target="_blank">codex.wordpress.org/Embeds</a>'
			)
		);
	}

	/**
	 * Hijacks retrieving of cached oEmbed.
	 * Returns cached data from relevant object metadata (vs postmeta)
	 *
	 * @since  0.9.5
	 * @param  boolean $check     Whether to retrieve postmeta or override
	 * @param  int     $object_id Object ID
	 * @param  string  $meta_key  Object metakey
	 * @return mixed              Object's oEmbed cached data
	 */
	public function hijack_oembed_cache_get( $check, $object_id, $meta_key ) {
		if ( ! $this->hijack || ( $this->object_id != $object_id && 1987645321 !== $object_id ) ) {
			return $check;
		}

		if ( $this->ajax_update ) {
			return false;
		}

		return $this->cache_action( $meta_key );
	}

	/**
	 * Hijacks saving of cached oEmbed.
	 * Saves cached data to relevant object metadata (vs postmeta)
	 *
	 * @since  0.9.5
	 * @param  boolean $check      Whether to continue setting postmeta
	 * @param  int     $object_id  Object ID to get postmeta from
	 * @param  string  $meta_key   Postmeta's key
	 * @param  mixed   $meta_value Value of the postmeta to be saved
	 * @return boolean             Whether to continue setting
	 */
	public function hijack_oembed_cache_set( $check, $object_id, $meta_key, $meta_value ) {

		if (
			! $this->hijack
			|| ( $this->object_id != $object_id && 1987645321 !== $object_id )
			// only want to hijack oembed meta values
			|| 0 !== strpos( $meta_key, '_oembed_' )
		) {
			return $check;
		}

		$this->cache_action( $meta_key, $meta_value );

		// Anything other than `null` to cancel saving to postmeta
		return true;
	}

	/**
	 * Gets/updates the cached oEmbed value from/to relevant object metadata (vs postmeta)
	 *
	 * @since 1.3.0
	 * @param string $meta_key Postmeta's key
	 */
	protected function cache_action( $meta_key ) {
		$func_args = func_get_args();
		$action    = isset( $func_args[1] ) ? 'update' : 'get';

		if ( 'options-page' === $this->object_type ) {

			$args = array( $meta_key );

			if ( 'update' === $action ) {
				$args[] = $func_args[1];
				$args[] = true;
			}

			// Cache the result to our options
			$status = call_user_func_array( array( cmb2_options( $this->object_id ), $action ), $args );
		} else {

			$args = array( $this->object_type, $this->object_id, $meta_key );
			$args[] = 'update' === $action ? $func_args : true;

			// Cache the result to our metadata
			$status = call_user_func_array( $action . '_metadata', $args );
		}

		return $status;
	}

	/**
	 * Hooks in when options-page data is saved to clean stale
	 * oembed cache data from the option value.
	 *
	 * @since  2.2.0
	 * @param  string $option_key The options-page option key
	 * @return void
	 */
	public static function clean_stale_options_page_oembeds( $option_key ) {
		$options = cmb2_options( $option_key )->get_options();
		$modified = false;
		if ( is_array( $options ) ) {

			$ttl = apply_filters( 'oembed_ttl', DAY_IN_SECONDS, '', array(), 0 );
			$now = time();

			foreach ( $options as $key => $value ) {
				// Check for cached oembed data
				if ( 0 === strpos( $key, '_oembed_time_' ) ) {
					$cached_recently = ( $now - $value ) < $ttl;

					if ( ! $cached_recently ) {
						$modified = true;
						// Remove the the cached ttl expiration, and the cached oembed value.
						unset( $options[ $key ] );
						unset( $options[ str_replace( '_oembed_time_', '_oembed_', $key ) ] );
					}
				} // End if().

				// Remove the cached unknown values.
				elseif ( '{{unknown}}' === $value ) {
					$modified = true;
					unset( $options[ $key ] );
				}
			}
		}

		// Update the option and remove stale cache data
		if ( $modified ) {
			$updated = cmb2_options( $option_key )->set( $options );
		}
	}

}


1		<?php
2
3		/**
4		* CMB2 ajax methods
5		* (i.e. a lot of work to get oEmbeds to work with non-post objects)
6		*
7		* @since 0.9.5
8		*
9		* @category WordPress_Plugin
10		* @package CMB2
11		* @author WebDevStudios
12		* @license GPL-2.0+
13		*/
14		class CMB2_Ajax {
15
16		// Whether to hijack the oembed cache system
17		protected $hijack = false;
18		protected $object_id = 0;
19		protected $embed_args = array();
20		protected $object_type = 'post';
21		protected $ajax_update = false;
22
23		/**
24		* Instance of this class
25		*
26		* @since 2.2.2
27		* @var object
28		*/
29		protected static $instance;
30
31		/**
32		* Get the singleton instance of this class
33		*
34		* @since 2.2.2
35		* @return CMB2_Ajax
36		*/
37		public static function get_instance() {
38		if ( ! ( self::$instance instanceof self ) ) {
39		self::$instance = new self();
40		}
41
42		return self::$instance;
43		}
44
45		/**
46		* Constructor
47		*
48		* @since 2.2.0
49		*/
50		protected function __construct() {
51		add_action( 'wp_ajax_cmb2_oembed_handler', array( $this, 'oembed_handler' ) );
52		add_action( 'wp_ajax_nopriv_cmb2_oembed_handler', array( $this, 'oembed_handler' ) );
53		// Need to occasionally clean stale oembed cache data from the option value.
54		add_action( 'cmb2_save_options-page_fields', array( __CLASS__, 'clean_stale_options_page_oembeds' ) );
55		}
56
57		/**
58		* Handles our oEmbed ajax request
59		*
60		* @since 0.9.5
61		* @return object oEmbed embed code \| fallback \| error message
62		*/
63		public function oembed_handler() {
64
65		// Verify our nonce
66		if ( ! ( isset( $_REQUEST['cmb2_ajax_nonce'], $_REQUEST['oembed_url'] ) && wp_verify_nonce( $_REQUEST['cmb2_ajax_nonce'], 'ajax_nonce' ) ) ) {
67		die();
68		}
69
70	1	// Sanitize our search string
71		$oembed_string = sanitize_text_field( $_REQUEST['oembed_url'] );
72	1
73		// Send back error if empty
74	1	if ( empty( $oembed_string ) ) {
75		wp_send_json_error( '<p class="ui-state-error-text">' . esc_html__( 'Please Try Again', 'cmb2' ) . '</p>' );
76		}
77	1
78		// Set width of embed
79	1	$embed_width = isset( $_REQUEST['oembed_width'] ) && intval( $_REQUEST['oembed_width'] ) < 640 ? intval( $_REQUEST['oembed_width'] ) : '640';
80	1
81	1	// Set url
82	1	$oembed_url = esc_url( $oembed_string );
83	1
84	1	// Set args
85		$embed_args = array(
86	1	'width' => $embed_width,
87		);
88
89		$this->ajax_update = true;
90
91		// Get embed code (or fallback link)
92		$html = $this->get_oembed( array(
93	1	'url' => $oembed_url,
94		'object_id' => $_REQUEST['object_id'],
95		'object_type' => isset( $_REQUEST['object_type'] ) ? $_REQUEST['object_type'] : 'post',
96	1	'oembed_args' => $embed_args,
97		'field_id' => $_REQUEST['field_id'],
98		) );
99
100		wp_send_json_success( $html );
101		}
102
103		/**
104		* Retrieves oEmbed from url/object ID
105		*
106		* @since 0.9.5
107		* @param array $args Arguments for method
108		* @return string html markup with embed or fallback
109		*/
110		public function get_oembed_no_edit( $args ) {
111		global $wp_embed;
112
113		$oembed_url = esc_url( $args['url'] );
114
115		// Sanitize object_id
116		$this->object_id = is_numeric( $args['object_id'] ) ? absint( $args['object_id'] ) : sanitize_text_field( $args['object_id'] );
117
118		$args = wp_parse_args( $args, array(
119	1	'object_type' => 'post',
120		'oembed_args' => $this->embed_args,
121	1	'field_id' => false,
122	1	'wp_error' => false,
123	1	) );
124
125		$this->embed_args =& $args;
126	1
127		/**
128		* Set the post_ID so oEmbed won't fail
129	1	* wp-includes/class-wp-embed.php, WP_Embed::shortcode()
130		*/
131		$wp_embed->post_ID = $this->object_id;
132	1
133	1	// Special scenario if NOT a post object
134		if ( isset( $args['object_type'] ) && 'post' != $args['object_type'] ) {
135
136		if ( 'options-page' == $args['object_type'] ) {
137
138		// Bogus id to pass some numeric checks. Issue with a VERY large WP install?
139		$wp_embed->post_ID = 1987645321;
140		}
141
142		// Ok, we need to hijack the oembed cache system
143		$this->hijack = true;
144		$this->object_type = $args['object_type'];
145
146		// Gets ombed cache from our object's meta (vs postmeta)
147		add_filter( 'get_post_metadata', array( $this, 'hijack_oembed_cache_get' ), 10, 3 );
148
149		// Sets ombed cache in our object's meta (vs postmeta)
150		add_filter( 'update_post_metadata', array( $this, 'hijack_oembed_cache_set' ), 10, 4 );
151
152		}
153
154		$embed_args = '';
155
156		foreach ( $args['oembed_args'] as $key => $val ) {
157		$embed_args .= " $key=\"$val\"";
158		}
159
160		// Ping WordPress for an embed
161		$embed = $wp_embed->run_shortcode( '[embed' . $embed_args . ']' . $oembed_url . '[/embed]' );
162
163		// Fallback that WordPress creates when no oEmbed was found
164		$fallback = $wp_embed->maybe_make_link( $oembed_url );
165
166		return compact( 'embed', 'fallback', 'args' );
167		}
168
169		/**
170		* Retrieves oEmbed from url/object ID
171		*
172		* @since 0.9.5
173		* @param array $args Arguments for method
174		* @return string html markup with embed or fallback
175		*/
176		public function get_oembed( $args ) {
177		$oembed = $this->get_oembed_no_edit( $args );
178
179		// Send back our embed
180		if ( $oembed['embed'] && $oembed['embed'] != $oembed['fallback'] ) {
181		return '<div class="cmb2-oembed embed-status">' . $oembed['embed'] . '<p class="cmb2-remove-wrapper"><a href="#" class="cmb2-remove-file-button" rel="' . $oembed['args']['field_id'] . '">' . esc_html__( 'Remove Embed', 'cmb2' ) . '</a></p></div>';
182		}
183
184		// Otherwise, send back error info that no oEmbeds were found
185		return sprintf(
186		'<p class="ui-state-error-text">%s</p>',
187		sprintf(
188		/* translators: 1: results for. 2: link to codex.wordpress.org/Embeds */
189		esc_html__( 'No oEmbed Results Found for %1$s. View more info at %2$s.', 'cmb2' ),
190		$oembed['fallback'],
191		'<a href="https://codex.wordpress.org/Embeds" target="_blank">codex.wordpress.org/Embeds</a>'
192		)
193		);
194		}
195
196		/**
197		* Hijacks retrieving of cached oEmbed.
198		* Returns cached data from relevant object metadata (vs postmeta)
199		*
200		* @since 0.9.5
201		* @param boolean $check Whether to retrieve postmeta or override
202		* @param int $object_id Object ID
203		* @param string $meta_key Object metakey
204		* @return mixed Object's oEmbed cached data
205		*/
206		public function hijack_oembed_cache_get( $check, $object_id, $meta_key ) {
207		if ( ! $this->hijack \|\| ( $this->object_id != $object_id && 1987645321 !== $object_id ) ) {
208		return $check;
209		}
210	1
211		if ( $this->ajax_update ) {
212		return false;
213		}
214
215		return $this->cache_action( $meta_key );
216		}
217
218		/**
219		* Hijacks saving of cached oEmbed.
220		* Saves cached data to relevant object metadata (vs postmeta)
221		*
222		* @since 0.9.5
223		* @param boolean $check Whether to continue setting postmeta
224		* @param int $object_id Object ID to get postmeta from
225		* @param string $meta_key Postmeta's key
226		* @param mixed $meta_value Value of the postmeta to be saved
227		* @return boolean Whether to continue setting
228		*/
229		public function hijack_oembed_cache_set( $check, $object_id, $meta_key, $meta_value ) {
230
231		if (
232		! $this->hijack
233		\|\| ( $this->object_id != $object_id && 1987645321 !== $object_id )
234		// only want to hijack oembed meta values
235		\|\| 0 !== strpos( $meta_key, '_oembed_' )
236		) {
237		return $check;
238		}
239
240		$this->cache_action( $meta_key, $meta_value );
241
242		// Anything other than `null` to cancel saving to postmeta
243		return true;
244		}
245
246		/**
247		* Gets/updates the cached oEmbed value from/to relevant object metadata (vs postmeta)
248		*
249		* @since 1.3.0
250		* @param string $meta_key Postmeta's key
251		*/
252		protected function cache_action( $meta_key ) {
253		$func_args = func_get_args();
254		$action = isset( $func_args[1] ) ? 'update' : 'get';
255
256		if ( 'options-page' === $this->object_type ) {
257
258		$args = array( $meta_key );
259
260		if ( 'update' === $action ) {
261		$args[] = $func_args[1];
262		$args[] = true;
263		}
264
265		// Cache the result to our options
266		$status = call_user_func_array( array( cmb2_options( $this->object_id ), $action ), $args );
267		} else {
268
269		$args = array( $this->object_type, $this->object_id, $meta_key );
270		$args[] = 'update' === $action ? $func_args : true;
271
272		// Cache the result to our metadata
273		$status = call_user_func_array( $action . '_metadata', $args );
274		}
275
276		return $status;
277		}
278
279		/**
280		* Hooks in when options-page data is saved to clean stale
281		* oembed cache data from the option value.
282		*
283		* @since 2.2.0
284		* @param string $option_key The options-page option key
285		* @return void
286		*/
287		public static function clean_stale_options_page_oembeds( $option_key ) {
288		$options = cmb2_options( $option_key )->get_options();
289		$modified = false;
290		if ( is_array( $options ) ) {
291
292		$ttl = apply_filters( 'oembed_ttl', DAY_IN_SECONDS, '', array(), 0 );
293		$now = time();
294
295		foreach ( $options as $key => $value ) {
296		// Check for cached oembed data
297		if ( 0 === strpos( $key, '_oembed_time_' ) ) {
298		$cached_recently = ( $now - $value ) < $ttl;
299
300		if ( ! $cached_recently ) {
301		$modified = true;
302		// Remove the the cached ttl expiration, and the cached oembed value.
303		unset( $options[ $key ] );
304		unset( $options[ str_replace( '_oembed_time_', '_oembed_', $key ) ] );
305		}
306		} // End if().
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-04-04 03:29 UTC by Report Bug Copy Issue Report Show Similar Issues like this `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
307		// Remove the cached unknown values.
308		elseif ( '{{unknown}}' === $value ) {
309		$modified = true;
310		unset( $options[ $key ] );
311		}
312		}
313		}
314
315		// Update the option and remove stale cache data
316		if ( $modified ) {
317		$updated = cmb2_options( $option_key )->set( $options );
318		}
319		}
320
321		}
322

WebDevStudios / CMB2

Push — trunk ( 177664...aedc6e )

includes/CMB2_Ajax.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like