Completed
Push — add/implement_pre_connection_j... ( def69c...959dbf )
by
unknown
06:40
created

Pre_Connection_JITM   A

Complexity

Total Complexity 20

Size/Duplication

Total Lines 134
Duplicated Lines 11.94 %

Coupling/Cohesion

Components 0
Dependencies 6

Importance

Changes 0
Metric Value
dl 16
loc 134
rs 10
c 0
b 0
f 0
wmc 20
lcom 0
cbo 6

2 Methods

Rating   Name   Duplication   Size   Complexity  
A register() 0 4 1
F get_messages() 16 109 19

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
/**
3
 * Jetpack's Pre-Connection JITM class.
4
 *
5
 * @package automattic/jetpack-jitm
6
 */
7
8
namespace Automattic\Jetpack\JITMS;
9
10
use Automattic\Jetpack\Assets;
11
use Automattic\Jetpack\Connection\Client;
12
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
13
use Automattic\Jetpack\Partner;
14
use Automattic\Jetpack\JITMS\JITM;
15
use Automattic\Jetpack\JITMS\Engine;
16
17
/**
18
 * Jetpack just in time messaging through out the admin
19
 *
20
 * @since 5.6.0
21
 */
22
class Pre_Connection_JITM extends JITM {
23
24
	const PACKAGE_VERSION = '1.0'; // TODO: Keep in sync with version specified in composer.json.
25
26
	/**
27
	 * Determines if JITMs are enabled.
28
	 *
29
	 * @return bool Enable JITMs.
30
	 */
31
	public function register() {
32
		add_action( 'current_screen', array( $this, 'prepare_jitms' ) );
33
		return true;
34
	}
35
36
	/**
37
	 * Retrieve the current message to display keyed on query string and message path
38
	 *
39
	 * @param string $message_path The message path to ask for.
40
	 * @param string $query The query string originally from the front end.
41
	 * @param bool   $full_jp_logo_exists If there is a full Jetpack logo already on the page.
42
	 *
43
	 * @return array The JITM's to show, or an empty array if there is nothing to show
44
	 */
45
	public function get_messages( $message_path, $query, $full_jp_logo_exists ) {
46
		$jitm_engine = new Engine();
47
48
		$query_string = array();
49
		if ( isset( $query ) ) {
50
			foreach ( explode( ',', $query ) as $query_item ) {
51
				$query_item                     = explode( '=', $query_item );
52
				$query_string[ $query_item[0] ] = isset( $query_item[1] ) ? $query_item[1] : null;
53
			}
54
			unset( $query_item );
55
		}
56
57
		$mobile_browser = jetpack_is_mobile( 'smart' );
58
		$user           = wp_get_current_user();
59
60
		// Unauthenticated or invalid requests just bail.
61
		if ( ! $user ) {
62
			return array();
63
		}
64
65
		$user_roles = implode( ',', $user->roles );
66
67
		$envelopes = $jitm_engine->get_top_messages( $message_path, $user->ID, $user_roles, $query_string, $mobile_browser );
0 ignored issues
show
Documentation introduced by
$query_string is of type array, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
Bug introduced by
It seems like $mobile_browser defined by jetpack_is_mobile('smart') on line 57 can also be of type string; however, Automattic\Jetpack\JITMS...ine::get_top_messages() does only seem to accept boolean, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
68
69
		if ( ! is_array( $envelopes ) ) {
70
			return array();
71
		}
72
73
		$hidden_jitms = \Jetpack_Options::get_option( 'hide_jitm' );
74
75
		unset( $envelopes['last_response_time'] );
76
77
		/**
78
		 * Allow adding your own custom JITMs after a set of JITMs has been received.
79
		 *
80
		 * @since 6.9.0
81
		 * @since 8.3.0 - Added Message path.
82
		 *
83
		 * @param array  $envelopes    array of existing JITMs.
84
		 * @param string $message_path The message path to ask for.
85
		 */
86
		$envelopes = apply_filters( 'jetpack_jitm_received_envelopes', $envelopes, $message_path );
87
88
		foreach ( $envelopes as $idx => &$envelope ) {
89
90
			$dismissed_feature = isset( $hidden_jitms[ $envelope->feature_class ] ) && is_array( $hidden_jitms[ $envelope->feature_class ] ) ? $hidden_jitms[ $envelope->feature_class ] : null;
91
92
			// If the this feature class has been dismissed and the request has not passed the ttl, skip it as it's been dismissed.
93 View Code Duplication
			if ( is_array( $dismissed_feature ) && ( time() - $dismissed_feature['last_dismissal'] < $envelope->expires || $dismissed_feature['number'] >= $envelope->max_dismissal ) ) {
94
				unset( $envelopes[ $idx ] );
95
				continue;
96
			}
97
98
			$normalized_site_url = \Jetpack::build_raw_urls( get_home_url() );
99
100
			$url_params = array(
101
				'source' => "jitm-$envelope->id",
102
				'site'   => $normalized_site_url,
103
				'u'      => $user->ID,
104
			);
105
106
			// Get affiliate code and add it to the array of URL parameters.
107
			$aff = Partner::init()->get_partner_code( Partner::AFFILIATE_CODE );
108
			if ( '' !== $aff ) {
109
				$url_params['aff'] = $aff;
110
			}
111
112
			$envelope->url = add_query_arg( $url_params, 'https://jetpack.com/redirect/' );
113
114 View Code Duplication
			if ( $envelope->cta['hook'] ) {
115
				$envelope->url = apply_filters( 'jitm_' . $envelope->cta['hook'], $envelope->url );
116
				unset( $envelope->cta['hook'] );
117
			}
118
119 View Code Duplication
			if ( isset( $envelope->content['hook'] ) ) {
120
				$envelope->content = apply_filters( 'jitm_' . $envelope->content['hook'], $envelope->content );
121
				unset( $envelope->content['hook'] );
122
			}
123
124
			// No point in showing an empty message.
125
			if ( empty( $envelope->content['message'] ) ) {
126
				unset( $envelopes[ $idx ] );
127
				continue;
128
			}
129
130
			switch ( $envelope->content['icon'] ) {
131 View Code Duplication
				case 'jetpack':
132
					$jetpack_logo              = new Jetpack_Logo();
133
					$envelope->content['icon'] = '<div class="jp-emblem">' . ( ( $full_jp_logo_exists ) ? $jetpack_logo->get_jp_emblem() : $jetpack_logo->get_jp_emblem_larger() ) . '</div>';
134
					break;
135
				case 'woocommerce':
136
					$envelope->content['icon'] = '<div class="jp-emblem"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0px" y="0px" viewBox="0 0 168 100" xml:space="preserve" enable-background="new 0 0 168 100" width="50" height="30"><style type="text/css">
137
					.st0{clip-path:url(#SVGID_2_);enable-background:new    ;}
138
					.st1{clip-path:url(#SVGID_4_);}
139
					.st2{clip-path:url(#SVGID_6_);}
140
					.st3{clip-path:url(#SVGID_8_);fill:#8F567F;}
141
					.st4{clip-path:url(#SVGID_10_);fill:#FFFFFE;}
142
					.st5{clip-path:url(#SVGID_12_);fill:#FFFFFE;}
143
					.st6{clip-path:url(#SVGID_14_);fill:#FFFFFE;}
144
				</style><g><defs><polygon id="SVGID_1_" points="83.8 100 0 100 0 0.3 83.8 0.3 167.6 0.3 167.6 100 "/></defs><clipPath id="SVGID_2_"><use xlink:href="#SVGID_1_" overflow="visible"/></clipPath><g class="st0"><g><defs><rect id="SVGID_3_" width="168" height="100"/></defs><clipPath id="SVGID_4_"><use xlink:href="#SVGID_3_" overflow="visible"/></clipPath><g class="st1"><defs><path id="SVGID_5_" d="M15.6 0.3H152c8.6 0 15.6 7 15.6 15.6v52c0 8.6-7 15.6-15.6 15.6h-48.9l6.7 16.4L80.2 83.6H15.6C7 83.6 0 76.6 0 67.9v-52C0 7.3 7 0.3 15.6 0.3"/></defs><clipPath id="SVGID_6_"><use xlink:href="#SVGID_5_" overflow="visible"/></clipPath><g class="st2"><defs><rect id="SVGID_7_" width="168" height="100"/></defs><clipPath id="SVGID_8_"><use xlink:href="#SVGID_7_" overflow="visible"/></clipPath><rect x="-10" y="-9.7" class="st3" width="187.6" height="119.7"/></g></g></g></g></g><g><defs><path id="SVGID_9_" d="M8.4 14.5c1-1.3 2.4-2 4.3-2.1 3.5-0.2 5.5 1.4 6 4.9 2.1 14.3 4.4 26.4 6.9 36.4l15-28.6c1.4-2.6 3.1-3.9 5.2-4.1 3-0.2 4.9 1.7 5.6 5.7 1.7 9.1 3.9 16.9 6.5 23.4 1.8-17.4 4.8-30 9-37.7 1-1.9 2.5-2.9 4.5-3 1.6-0.1 3 0.3 4.3 1.4 1.3 1 2 2.3 2.1 3.9 0.1 1.2-0.1 2.3-0.7 3.3 -2.7 5-4.9 13.2-6.6 24.7 -1.7 11.1-2.3 19.8-1.9 26.1 0.1 1.7-0.1 3.2-0.8 4.5 -0.8 1.5-2 2.4-3.7 2.5 -1.8 0.1-3.6-0.7-5.4-2.5C52.4 66.7 47.4 57 43.7 44.1c-4.4 8.8-7.7 15.3-9.9 19.7 -4 7.7-7.5 11.7-10.3 11.9 -1.9 0.1-3.5-1.4-4.8-4.7 -3.5-9-7.3-26.3-11.3-52C7.1 17.3 7.5 15.8 8.4 14.5"/></defs><clipPath id="SVGID_10_"><use xlink:href="#SVGID_9_" overflow="visible"/></clipPath><rect x="-2.7" y="-0.6" class="st4" width="90.6" height="86.4"/></g><g><defs><path id="SVGID_11_" d="M155.6 25.2c-2.5-4.3-6.1-6.9-11-7.9 -1.3-0.3-2.5-0.4-3.7-0.4 -6.6 0-11.9 3.4-16.1 10.2 -3.6 5.8-5.3 12.3-5.3 19.3 0 5.3 1.1 9.8 3.3 13.6 2.5 4.3 6.1 6.9 11 7.9 1.3 0.3 2.5 0.4 3.7 0.4 6.6 0 12-3.4 16.1-10.2 3.6-5.9 5.3-12.4 5.3-19.4C159 33.4 157.9 28.9 155.6 25.2zM147 44.2c-0.9 4.5-2.7 7.9-5.2 10.1 -2 1.8-3.9 2.5-5.5 2.2 -1.7-0.3-3-1.8-4-4.4 -0.8-2.1-1.2-4.2-1.2-6.2 0-1.7 0.2-3.4 0.5-5 0.6-2.8 1.8-5.5 3.6-8.1 2.3-3.3 4.7-4.8 7.1-4.2 1.7 0.3 3 1.8 4 4.4 0.8 2.1 1.2 4.2 1.2 6.2C147.5 40.9 147.3 42.6 147 44.2z"/></defs><clipPath id="SVGID_12_"><use xlink:href="#SVGID_11_" overflow="visible"/></clipPath><rect x="109.6" y="6.9" class="st5" width="59.4" height="71.4"/></g><g><defs><path id="SVGID_13_" d="M112.7 25.2c-2.5-4.3-6.1-6.9-11-7.9 -1.3-0.3-2.5-0.4-3.7-0.4 -6.6 0-11.9 3.4-16.1 10.2 -3.5 5.8-5.3 12.3-5.3 19.3 0 5.3 1.1 9.8 3.3 13.6 2.5 4.3 6.1 6.9 11 7.9 1.3 0.3 2.5 0.4 3.7 0.4 6.6 0 12-3.4 16.1-10.2 3.5-5.9 5.3-12.4 5.3-19.4C116 33.4 114.9 28.9 112.7 25.2zM104.1 44.2c-0.9 4.5-2.7 7.9-5.2 10.1 -2 1.8-3.9 2.5-5.5 2.2 -1.7-0.3-3-1.8-4-4.4 -0.8-2.1-1.2-4.2-1.2-6.2 0-1.7 0.2-3.4 0.5-5 0.6-2.8 1.8-5.5 3.6-8.1 2.3-3.3 4.7-4.8 7.1-4.2 1.7 0.3 3 1.8 4 4.4 0.8 2.1 1.2 4.2 1.2 6.2C104.6 40.9 104.4 42.6 104.1 44.2z"/></defs><clipPath id="SVGID_14_"><use xlink:href="#SVGID_13_" overflow="visible"/></clipPath><rect x="66.7" y="6.9" class="st6" width="59.4" height="71.4"/></g></svg></div>';
145
					break;
146
				default:
147
					$envelope->content['icon'] = '';
148
					break;
149
			}
150
		}
151
152
		return $envelopes;
153
	}
154
155
}
156