Completed
Pull Request — trunk (#602)
by Juliette
71:35 queued 56:37
created

CMB2_Ajax   B

Complexity

Total Complexity 40

Size/Duplication

Total Lines 280
Duplicated Lines 0 %

Coupling/Cohesion

Components 2
Dependencies 1

Test Coverage

Coverage 73.04%

Importance

Changes 4
Bugs 1 Features 3
Metric Value
wmc 40
c 4
b 1
f 3
lcom 2
cbo 1
dl 0
loc 280
ccs 84
cts 115
cp 0.7304
rs 8.2608

8 Methods

Rating   Name   Duplication   Size   Complexity  
A get_instance() 0 7 2
A __construct() 0 6 1
C oembed_handler() 0 37 7
C get_oembed() 0 65 8
B hijack_oembed_cache_get() 0 11 5
B hijack_oembed_cache_set() 0 16 5
B cache_action() 0 26 5
C clean_stale_options_page_oembeds() 0 32 7

How to fix   Complexity   

Complex Class

Complex classes like CMB2_Ajax often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use CMB2_Ajax, and based on these observations, apply Extract Interface, too.

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 {
0 ignored issues
show
Coding Style Compatibility introduced by
PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

You can fix this by adding a namespace to your class:

namespace YourVendor;

class YourClass { }

When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.

Loading history...
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
	 * @since 2.2.2
26
	 * @var object
27 1
	 */
28 1
	protected static $instance;
29 1
30
	/**
31
	 * Get the singleton instance of this class
32
	 * @since 2.2.2
33
	 * @return object
34
	 */
35
	public static function get_instance() {
36 1
		if ( ! ( self::$instance instanceof self ) ) {
37 1
			self::$instance = new self();
38
		}
39 1
40 1
		return self::$instance;
41 1
	}
42
43 1
	/**
44 1
	 * Constructor
45 1
	 * @since 2.2.0
46 1
	 */
47
	protected function __construct() {
48
		add_action( 'wp_ajax_cmb2_oembed_handler', array( $this, 'oembed_handler' ) );
49
		add_action( 'wp_ajax_nopriv_cmb2_oembed_handler', array( $this, 'oembed_handler' ) );
50
		// Need to occasionally clean stale oembed cache data from the option value.
51
		add_action( 'cmb2_save_options-page_fields', array( __CLASS__, 'clean_stale_options_page_oembeds' ) );
52
	}
53
54
	/**
55
	 * Handles our oEmbed ajax request
56
	 * @since  0.9.5
57
	 * @return object oEmbed embed code | fallback | error message
58
	 */
59
	public function oembed_handler() {
0 ignored issues
show
Coding Style introduced by
oembed_handler uses the super-global variable $_REQUEST which is generally not recommended.

Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable:

// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
Loading history...
60
61
		// Verify our nonce
62
		if ( ! ( isset( $_REQUEST['cmb2_ajax_nonce'], $_REQUEST['oembed_url'] ) && wp_verify_nonce( $_REQUEST['cmb2_ajax_nonce'], 'ajax_nonce' ) ) ) {
63
			die();
0 ignored issues
show
Coding Style Compatibility introduced by
The method oembed_handler() 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...
64
		}
65
66
		// Sanitize our search string
67
		$oembed_string = sanitize_text_field( $_REQUEST['oembed_url'] );
68
69
		// Send back error if empty
70
		if ( empty( $oembed_string ) ) {
71
			wp_send_json_error( '<p class="ui-state-error-text">' . __( 'Please Try Again', 'cmb2' ) . '</p>' );
72
		}
73
74
		// Set width of embed
75
		$embed_width = isset( $_REQUEST['oembed_width'] ) && intval( $_REQUEST['oembed_width'] ) < 640 ? intval( $_REQUEST['oembed_width'] ) : '640';
76
77
		// Set url
78
		$oembed_url = esc_url( $oembed_string );
79
80
		// Set args
81
		$embed_args = array( 'width' => $embed_width );
82
83
		$this->ajax_update = true;
84
85
		// Get embed code (or fallback link)
86
		$html = $this->get_oembed( array(
87
			'url'         => $oembed_url,
88
			'object_id'   => $_REQUEST['object_id'],
89
			'object_type' => isset( $_REQUEST['object_type'] ) ? $_REQUEST['object_type'] : 'post',
90
			'oembed_args' => $embed_args,
91
			'field_id'    => $_REQUEST['field_id'],
92
		) );
93
94
		wp_send_json_success( $html );
95
	}
96
97 2
	/**
98
	 * Retrieves oEmbed from url/object ID
99 2
	 * @since  0.9.5
100
	 * @param  array  $args      Arguments for method
101 2
	 * @return string            html markup with embed or fallback
102
	 */
103
	public function get_oembed( $args ) {
104 2
105
		global $wp_embed;
0 ignored issues
show
Compatibility Best Practice introduced by
Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

Instead of relying on global state, we recommend one of these alternatives:

1. Pass all data via parameters

function myFunction($a, $b) {
    // Do something
}

2. Create a class that maintains your state

class MyClass {
    private $a;
    private $b;

    public function __construct($a, $b) {
        $this->a = $a;
        $this->b = $b;
    }

    public function myFunction() {
        // Do something
    }
}
Loading history...
106 2
107 2
		$oembed_url = esc_url( $args['url'] );
108 2
109 2
		// Sanitize object_id
110 2
		$this->object_id = is_numeric( $args['object_id'] ) ? absint( $args['object_id'] ) : sanitize_text_field( $args['object_id'] );
111
112 2
		$args = wp_parse_args( $args, array(
113
			'object_type' => 'post',
114
			'oembed_args' => $this->embed_args,
115
			'field_id'    => false,
116
		) );
117
118 2
		$this->embed_args =& $args;
119
120
		/**
121 2
		 * Set the post_ID so oEmbed won't fail
122
		 * wp-includes/class-wp-embed.php, WP_Embed::shortcode()
123 1
		 */
124
		$wp_embed->post_ID = $this->object_id;
125
126 1
		// Special scenario if NOT a post object
127 1
		if ( isset( $args['object_type'] ) && 'post' != $args['object_type'] ) {
128
129
			if ( 'options-page' == $args['object_type'] ) {
130 1
131 1
				// Bogus id to pass some numeric checks. Issue with a VERY large WP install?
132
				$wp_embed->post_ID = 1987645321;
133
			}
134 1
135
			// Ok, we need to hijack the oembed cache system
136
			$this->hijack = true;
137 1
			$this->object_type = $args['object_type'];
138
139 1
			// Gets ombed cache from our object's meta (vs postmeta)
140
			add_filter( 'get_post_metadata', array( $this, 'hijack_oembed_cache_get' ), 10, 3 );
141 2
142
			// Sets ombed cache in our object's meta (vs postmeta)
143 2
			add_filter( 'update_post_metadata', array( $this, 'hijack_oembed_cache_set' ), 10, 4 );
144 2
145 2
		}
146
147
		$embed_args = '';
148 2
149
		foreach ( $args['oembed_args'] as $key => $val ) {
150
			$embed_args .= " $key=\"$val\"";
151 2
		}
152
153
		// Ping WordPress for an embed
154 2
		$check_embed = $wp_embed->run_shortcode( '[embed' . $embed_args . ']' . $oembed_url . '[/embed]' );
155 2
156
		// Fallback that WordPress creates when no oEmbed was found
157
		$fallback = $wp_embed->maybe_make_link( $oembed_url );
158
159 1
		// Send back our embed
160
		if ( $check_embed && $check_embed != $fallback ) {
161
			return '<div class="embed-status">' . $check_embed . '<p class="cmb2-remove-wrapper"><a href="#" class="cmb2-remove-file-button" rel="' . $args['field_id'] . '">' . __( 'Remove Embed', 'cmb2' ) . '</a></p></div>';
162
		}
163
164
		// Otherwise, send back error info that no oEmbeds were found
165
		return '<p class="ui-state-error-text">' . sprintf( __( 'No oEmbed Results Found for %s. View more info at', 'cmb2' ), $fallback ) . ' <a href="http://codex.wordpress.org/Embeds" target="_blank">codex.wordpress.org/Embeds</a>.</p>';
166
167
	}
168
169
	/**
170
	 * Hijacks retrieving of cached oEmbed.
171
	 * Returns cached data from relevant object metadata (vs postmeta)
172
	 *
173 68
	 * @since  0.9.5
174 68
	 * @param  boolean $check     Whether to retrieve postmeta or override
175 67
	 * @param  int     $object_id Object ID
176
	 * @param  string  $meta_key  Object metakey
177
	 * @return mixed              Object's oEmbed cached data
178 2
	 */
179
	public function hijack_oembed_cache_get( $check, $object_id, $meta_key ) {
180
		if ( ! $this->hijack || ( $this->object_id != $object_id && 1987645321 !== $object_id ) ) {
181
			return $check;
182 2
		}
183
184
		if ( $this->ajax_update ) {
185
			return false;
186
		}
187
188
		return $this->cache_action( $meta_key );
189
	}
190
191
	/**
192
	 * Hijacks saving of cached oEmbed.
193
	 * Saves cached data to relevant object metadata (vs postmeta)
194
	 *
195
	 * @since  0.9.5
196 52
	 * @param  boolean $check      Whether to continue setting postmeta
197
	 * @param  int     $object_id  Object ID to get postmeta from
198
	 * @param  string  $meta_key   Postmeta's key
199 52
	 * @param  mixed   $meta_value Value of the postmeta to be saved
200 52
	 * @return boolean             Whether to continue setting
201
	 */
202 52
	public function hijack_oembed_cache_set( $check, $object_id, $meta_key, $meta_value ) {
203 52
204 51
		if (
205
			! $this->hijack
206
			|| ( $this->object_id != $object_id && 1987645321 !== $object_id )
207 2
			// only want to hijack oembed meta values
208
			|| 0 !== strpos( $meta_key, '_oembed_' )
209
		) {
210 2
			return $check;
211
		}
212
213
		$this->cache_action( $meta_key, $meta_value );
214
215
		// Anything other than `null` to cancel saving to postmeta
216
		return true;
217
	}
218
219
	/**
220 2
	 * Gets/updates the cached oEmbed value from/to relevant object metadata (vs postmeta)
221 2
	 *
222 2
	 * @since  1.3.0
223
	 * @param  string  $meta_key   Postmeta's key
224 2
	 * @param  mixed   $meta_value (Optional) value of the postmeta to be saved
0 ignored issues
show
Bug introduced by
There is no parameter named $meta_value. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
225
	 */
226 2
	protected function cache_action( $meta_key ) {
227
		$func_args = func_get_args();
228 2
		$action    = isset( $func_args[1] ) ? 'update' : 'get';
229 2
230 2
		if ( 'options-page' === $this->object_type ) {
231 2
232
			$args = array( $meta_key );
233
234 2
			if ( 'update' === $action ) {
235 2
				$args[] = $func_args[1];
236
				$args[] = true;
237
			}
238
239
			// Cache the result to our options
240
			$status = call_user_func_array( array( cmb2_options( $this->object_id ), $action ), $args );
241
		} else {
242
243
			$args = array( $this->object_type, $this->object_id, $meta_key );
244 2
			$args[] = 'update' === $action ? $func_args : true;
245
246
			// Cache the result to our metadata
247
			$status = call_user_func_array( $action . '_metadata', $args );
248
		}
249
250
		return $status;
251
	}
252
253
	/**
254 1
	 * Hooks in when options-page data is saved to clean stale
255 1
	 * oembed cache data from the option value.
256 1
	 * @since  2.2.0
257
	 * @param  string  $option_key The options-page option key
258 1
	 * @return void
259 1
	 */
260 1
	public static function clean_stale_options_page_oembeds( $option_key ) {
261
		$options = cmb2_options( $option_key )->get_options();
262 1
		if ( is_array( $options ) ) {
263
264 1
			$ttl = apply_filters( 'oembed_ttl', DAY_IN_SECONDS, '', array(), 0 );
265
			$now = time();
266
			$modified = false;
267
268
			foreach ( $options as $key => $value ) {
269
				// Check for cached oembed data
270
				if ( 0 === strpos( $key, '_oembed_time_' ) ) {
271
					$cached_recently = ( $now - $value ) < $ttl;
272
273
					if ( ! $cached_recently ) {
274
						$modified = true;
275 1
						// Remove the the cached ttl expiration, and the cached oembed value.
276 1
						unset( $options[ $key ] );
277 1
						unset( $options[ str_replace( '_oembed_time_', '_oembed_', $key ) ] );
278 1
					}
279 1
				}
280 1
				// Remove the cached unknown values
281
				elseif ( '{{unknown}}' === $value ) {
282 1
					$modified = true;
283 1
					unset( $options[ $key ] );
284 1
				}
285 1
			}
286
		}
287
		// Update the option and remove stale cache data
288
		if ( $modified ) {
0 ignored issues
show
Bug introduced by
The variable $modified does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
289
			$updated = cmb2_options( $option_key )->set( $options );
0 ignored issues
show
Unused Code introduced by
$updated is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
290
		}
291
	}
292
293
}
294