WC_Stripe_Apple_Pay_Registration - Code Metrics - Inspection of "Use more targeted option update hook" - woocommerce/woocommerce-gateway-stripe - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4cc53b...9f385c )

unknown

created 2020-10-06 19:10 UTC

WC_Stripe_Apple_Pay_Registration B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	298
Duplicated Lines	2.68 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
dl	8
loc	298
rs	8.96
c	0
b	0
f	0
wmc	43
lcom	1
cbo	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	2
A	get_option()	0	11	3
A	get_secret_key()	0	4	2
B	init_apple_pay()	0	11	9
A	register_domain_with_apple()	0	38	4
B	update_domain_association_file()	8	27	7
A	verify_domain()	0	28	3
A	verify_domain_on_new_secret_key()	0	11	3
A	verify_domain_if_needed()	0	7	2
B	admin_notices()	0	30	8

How to fix Duplicated Code Complexity

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:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like WC_Stripe_Apple_Pay_Registration 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 WC_Stripe_Apple_Pay_Registration, and based on these observations, apply Extract Interface, too.

<?php
/**
 * Stripe Apple Pay Registration Class.
 *
 * @since 4.0.6
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

class WC_Stripe_Apple_Pay_Registration {
	/**
	 * Enabled.
	 *
	 * @var
	 */
	public $stripe_settings;

	/**
	 * Main Stripe Enabled.
	 *
	 * @var bool
	 */
	public $stripe_enabled;

	/**
	 * Do we accept Payment Request?
	 *
	 * @var bool
	 */
	public $payment_request;

	/**
	 * Apple Pay Domain Set.
	 *
	 * @var bool
	 */
	public $apple_pay_domain_set;

	/**
	 * Secret Key.
	 *
	 * @var string
	 */
	public $secret_key;

	/**
	 * Stores Apple Pay domain verification issues.
	 *
	 * @var string
	 */
	public $apple_pay_verify_notice;

	public function __construct() {
		add_action( 'woocommerce_stripe_updated', array( $this, 'verify_domain_if_needed' ) );
		add_action( 'update_option_woocommerce_stripe_settings', array( $this, 'verify_domain_on_new_secret_key' ), 10, 2 );

		$this->stripe_settings         = get_option( 'woocommerce_stripe_settings', array() );
		$this->stripe_enabled          = $this->get_option( 'enabled' );
$answer = 42;

$correct = false;

$correct = (bool) $answer;
		$this->payment_request         = 'yes' === $this->get_option( 'payment_request', 'yes' );
		$this->apple_pay_domain_set    = 'yes' === $this->get_option( 'apple_pay_domain_set', 'no' );
		$this->apple_pay_verify_notice = '';
		$this->secret_key              = $this->get_secret_key();

		if ( empty( $this->stripe_settings ) ) {
			return;
		}

		$this->init_apple_pay();

		add_action( 'admin_notices', array( $this, 'admin_notices' ) );
	}

	/**
	 * Gets the Stripe settings.
	 *
	 * @since 4.0.6
	 * @param string $setting
	 * @param string default
	 * @return string $setting_value
	 */
	public function get_option( $setting = '', $default = '' ) {
		if ( empty( $this->stripe_settings ) ) {
			return $default;
		}

		if ( ! empty( $this->stripe_settings[ $setting ] ) ) {
			return $this->stripe_settings[ $setting ];
		}

		return $default;
	}

	/**
	 * Gets the Stripe secret key for the current mode.
	 *
	 * @since 4.5.3
	 * @return string Secret key.
	 */
	private function get_secret_key() {
		$testmode = 'yes' === $this->get_option( 'testmode', 'no' );
		return $testmode ? $this->get_option( 'test_secret_key' ) : $this->get_option( 'secret_key' );
	}

	/**
	 * Initializes Apple Pay process on settings page.
	 *
	 * @since 3.1.0
	 * @version 3.1.0
	 */
	public function init_apple_pay() {
		if (
			is_admin() &&
			isset( $_GET['page'] ) && 'wc-settings' === $_GET['page'] &&
			isset( $_GET['tab'] ) && 'checkout' === $_GET['tab'] &&
			isset( $_GET['section'] ) && 'stripe' === $_GET['section'] &&
			$this->payment_request
		) {
			$this->verify_domain();
		}
	}

	/**
	 * Registers the domain with Stripe/Apple Pay
	 *
	 * @since 3.1.0
	 * @version 3.1.0
	 * @param string $secret_key
	 */
	private function register_domain_with_apple( $secret_key = '' ) {
		if ( empty( $secret_key ) ) {
			throw new Exception( __( 'Unable to verify domain - missing secret key.', 'woocommerce-gateway-stripe' ) );
		}

		$endpoint = 'https://api.stripe.com/v1/apple_pay/domains';

		$data = array(
			'domain_name' => $_SERVER['HTTP_HOST'],
		);

		$headers = array(
			'User-Agent'    => 'WooCommerce Stripe Apple Pay',
			'Authorization' => 'Bearer ' . $secret_key,
		);

		$response = wp_remote_post(
			$endpoint,
			array(
				'headers' => $headers,
				'body'    => http_build_query( $data ),
			)
		);

		if ( is_wp_error( $response ) ) {
			/* translators: error message */
			throw new Exception( sprintf( __( 'Unable to verify domain - %s', 'woocommerce-gateway-stripe' ), $response->get_error_message() ) );
		}

		if ( 200 !== $response['response']['code'] ) {
			$parsed_response = json_decode( $response['body'] );

			$this->apple_pay_verify_notice = $parsed_response->error->message;

			/* translators: error message */
			throw new Exception( sprintf( __( 'Unable to verify domain - %s', 'woocommerce-gateway-stripe' ), $parsed_response->error->message ) );
		}
	}

	/**
	 * Updates the Apple Pay domain association file.
	 *
	 * @param bool $force True to create the file if it didn't exist, false for just updating the file if needed.
	 *
	 * @version 4.3.0
	 * @since 4.3.0
	 * @return bool True on success, false on failure.
	 */
	public function update_domain_association_file( $force = false ) {
			$path     = untrailingslashit( $_SERVER['DOCUMENT_ROOT'] );
			$dir      = '.well-known';
			$file     = 'apple-developer-merchantid-domain-association';
			$fullpath = $path . '/' . $dir . '/' . $file;

			$existing_contents = @file_get_contents( $fullpath );
			$new_contents = @file_get_contents( WC_STRIPE_PLUGIN_PATH . '/' . $file );
			if ( ( ! $existing_contents && ! $force ) || $existing_contents === $new_contents ) {
				return true;
			}

			if ( ! file_exists( $path . '/' . $dir ) ) {
				if ( ! @mkdir( $path . '/' . $dir, 0755 ) ) { // @codingStandardsIgnoreLine

					WC_Stripe_Logger::log( 'Error: ' . __( 'Unable to create domain association folder to domain root.', 'woocommerce-gateway-stripe' ) );
					return false;
				}
			}

			if ( ! @copy( WC_STRIPE_PLUGIN_PATH . '/' . $file, $fullpath ) ) { // @codingStandardsIgnoreLine

				WC_Stripe_Logger::log( 'Error: ' . __( 'Unable to copy domain association file to domain root.', 'woocommerce-gateway-stripe' ) );
				return false;
			}

			WC_Stripe_Logger::log( 'Domain association file updated.' );
			return true;
	}

	/**
	 * Processes the Apple Pay domain verification.
	 *
	 * @since 3.1.0
	 * @version 3.1.0
	 */
	public function verify_domain() {
		if ( ! $this->update_domain_association_file( true ) ) {
			$this->stripe_settings['apple_pay_domain_set'] = 'no';
			update_option( 'woocommerce_stripe_settings', $this->stripe_settings );
			return;
		}

		try {
			// At this point then the domain association folder and file should be available.
			// Proceed to verify/and or verify again.
			$this->register_domain_with_apple( $this->secret_key );

			// No errors to this point, verification success!
			$this->stripe_settings['apple_pay_domain_set'] = 'yes';
			$this->apple_pay_domain_set                    = true;

			update_option( 'woocommerce_stripe_settings', $this->stripe_settings );

			WC_Stripe_Logger::log( 'Your domain has been verified with Apple Pay!' );

		} catch ( Exception $e ) {
			$this->stripe_settings['apple_pay_domain_set'] = 'no';

			update_option( 'woocommerce_stripe_settings', $this->stripe_settings );

			WC_Stripe_Logger::log( 'Error: ' . $e->getMessage() );
		}
	}

	/**
	 * Conditionally process the Apple Pay domain verification after a new secret key is set.
	 *
	 * @since 4.5.3
	 * @version 4.5.3
	 */
	public function verify_domain_on_new_secret_key( $prev_settings, $settings ) {
		$this->stripe_settings = $prev_settings;
		$prev_secret_key = $this->get_secret_key();

		$this->stripe_settings = $settings;
		$this->secret_key = $this->get_secret_key();

		if ( ! empty( $this->secret_key ) && $this->secret_key !== $prev_secret_key ) {
			$this->verify_domain();
		}
	}

	/**
	 * Process the Apple Pay domain verification if not already done - otherwise just update the file.
	 *
	 * @since 4.5.3
	 * @version 4.5.3
	 */
	public function verify_domain_if_needed() {
		if ( $this->apple_pay_domain_set ) {
			$this->update_domain_association_file();
		} else {
			$this->verify_domain();
		}
	}

	/**
	 * Display any admin notices to the user.
	 *
	 * @since 4.0.6
	 */
	public function admin_notices() {
		if ( ! $this->stripe_enabled ) {
			return;
		}

		if ( ! current_user_can( 'manage_woocommerce' ) ) {
			return;
		}

		if ( $this->payment_request && ! empty( $this->apple_pay_verify_notice ) ) {
			$allowed_html = array(
				'a' => array(
					'href'  => array(),
					'title' => array(),
				),
			);

			echo '<div class="error stripe-apple-pay-message"><p>' . wp_kses( make_clickable( $this->apple_pay_verify_notice ), $allowed_html ) . '</p></div>';
		}

		/**
		 * Apple pay is enabled by default and domain verification initializes
		 * when setting screen is displayed. So if domain verification is not set,
		 * something went wrong so lets notify user.
		 */
		if ( ! empty( $this->secret_key ) && $this->payment_request && ! $this->apple_pay_domain_set ) {
			/* translators: 1) HTML anchor open tag 2) HTML anchor closing tag */
			echo '<div class="error stripe-apple-pay-message"><p>' . sprintf( __( 'Apple Pay domain verification failed. Please check the %1$slog%2$s to see the issue. (Logging must be enabled to see recorded logs)', 'woocommerce-gateway-stripe' ), '<a href="' . admin_url( 'admin.php?page=wc-status&tab=logs' ) . '">', '</a>' ) . '</p></div>';
		}
	}
}

new WC_Stripe_Apple_Pay_Registration();


1		<?php
2		/**
3		* Stripe Apple Pay Registration Class.
4		*
5		* @since 4.0.6
6		*/
7
8		if ( ! defined( 'ABSPATH' ) ) {
9		exit;
10		}
11
12		class WC_Stripe_Apple_Pay_Registration {
13		/**
14		* Enabled.
15		*
16		* @var
17		*/
18		public $stripe_settings;
19
20		/**
21		* Main Stripe Enabled.
22		*
23		* @var bool
24		*/
25		public $stripe_enabled;
26
27		/**
28		* Do we accept Payment Request?
29		*
30		* @var bool
31		*/
32		public $payment_request;
33
34		/**
35		* Apple Pay Domain Set.
36		*
37		* @var bool
38		*/
39		public $apple_pay_domain_set;
40
41		/**
42		* Secret Key.
43		*
44		* @var string
45		*/
46		public $secret_key;
47
48		/**
49		* Stores Apple Pay domain verification issues.
50		*
51		* @var string
52		*/
53		public $apple_pay_verify_notice;
54
55		public function __construct() {
56		add_action( 'woocommerce_stripe_updated', array( $this, 'verify_domain_if_needed' ) );
57		add_action( 'update_option_woocommerce_stripe_settings', array( $this, 'verify_domain_on_new_secret_key' ), 10, 2 );
58
59		$this->stripe_settings = get_option( 'woocommerce_stripe_settings', array() );
60		$this->stripe_enabled = $this->get_option( 'enabled' );
		0 ignored issues – show Documentation Bug introduced 2018-02-09 22:54 UTC by Report Bug Copy Issue Report The property `$stripe_enabled` was declared of type `boolean`, but `$this->get_option('enabled')` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
61		$this->payment_request = 'yes' === $this->get_option( 'payment_request', 'yes' );
62		$this->apple_pay_domain_set = 'yes' === $this->get_option( 'apple_pay_domain_set', 'no' );
63		$this->apple_pay_verify_notice = '';
64		$this->secret_key = $this->get_secret_key();
65
66		if ( empty( $this->stripe_settings ) ) {
67		return;
68		}
69
70		$this->init_apple_pay();
71
72		add_action( 'admin_notices', array( $this, 'admin_notices' ) );
73		}
74
75		/**
76		* Gets the Stripe settings.
77		*
78		* @since 4.0.6
79		* @param string $setting
80		* @param string default
81		* @return string $setting_value
82		*/
83		public function get_option( $setting = '', $default = '' ) {
84		if ( empty( $this->stripe_settings ) ) {
85		return $default;
86		}
87
88		if ( ! empty( $this->stripe_settings[ $setting ] ) ) {
89		return $this->stripe_settings[ $setting ];
90		}
91
92		return $default;
93		}
94
95		/**
96		* Gets the Stripe secret key for the current mode.
97		*
98		* @since 4.5.3
99		* @return string Secret key.
100		*/
101		private function get_secret_key() {
102		$testmode = 'yes' === $this->get_option( 'testmode', 'no' );
103		return $testmode ? $this->get_option( 'test_secret_key' ) : $this->get_option( 'secret_key' );
104		}
105
106		/**
107		* Initializes Apple Pay process on settings page.
108		*
109		* @since 3.1.0
110		* @version 3.1.0
111		*/
112		public function init_apple_pay() {
113		if (
114		is_admin() &&
115		isset( $_GET['page'] ) && 'wc-settings' === $_GET['page'] &&
116		isset( $_GET['tab'] ) && 'checkout' === $_GET['tab'] &&
117		isset( $_GET['section'] ) && 'stripe' === $_GET['section'] &&
118		$this->payment_request
119		) {
120		$this->verify_domain();
121		}
122		}
123
124		/**
125		* Registers the domain with Stripe/Apple Pay
126		*
127		* @since 3.1.0
128		* @version 3.1.0
129		* @param string $secret_key
130		*/
131		private function register_domain_with_apple( $secret_key = '' ) {
132		if ( empty( $secret_key ) ) {
133		throw new Exception( __( 'Unable to verify domain - missing secret key.', 'woocommerce-gateway-stripe' ) );
134		}
135
136		$endpoint = 'https://api.stripe.com/v1/apple_pay/domains';
137
138		$data = array(
139		'domain_name' => $_SERVER['HTTP_HOST'],
140		);
141
142		$headers = array(
143		'User-Agent' => 'WooCommerce Stripe Apple Pay',
144		'Authorization' => 'Bearer ' . $secret_key,
145		);
146
147		$response = wp_remote_post(
148		$endpoint,
149		array(
150		'headers' => $headers,
151		'body' => http_build_query( $data ),
152		)
153		);
154
155		if ( is_wp_error( $response ) ) {
156		/* translators: error message */
157		throw new Exception( sprintf( __( 'Unable to verify domain - %s', 'woocommerce-gateway-stripe' ), $response->get_error_message() ) );
158		}
159
160		if ( 200 !== $response['response']['code'] ) {
161		$parsed_response = json_decode( $response['body'] );
162
163		$this->apple_pay_verify_notice = $parsed_response->error->message;
164
165		/* translators: error message */
166		throw new Exception( sprintf( __( 'Unable to verify domain - %s', 'woocommerce-gateway-stripe' ), $parsed_response->error->message ) );
167		}
168		}
169
170		/**
171		* Updates the Apple Pay domain association file.
172		*
173		* @param bool $force True to create the file if it didn't exist, false for just updating the file if needed.
174		*
175		* @version 4.3.0
176		* @since 4.3.0
177		* @return bool True on success, false on failure.
178		*/
179		public function update_domain_association_file( $force = false ) {
180		$path = untrailingslashit( $_SERVER['DOCUMENT_ROOT'] );
181		$dir = '.well-known';
182		$file = 'apple-developer-merchantid-domain-association';
183		$fullpath = $path . '/' . $dir . '/' . $file;
184
185		$existing_contents = @file_get_contents( $fullpath );
186		$new_contents = @file_get_contents( WC_STRIPE_PLUGIN_PATH . '/' . $file );
187		if ( ( ! $existing_contents && ! $force ) \|\| $existing_contents === $new_contents ) {
188		return true;
189		}
190
191		if ( ! file_exists( $path . '/' . $dir ) ) {
192	View Code Duplication	if ( ! @mkdir( $path . '/' . $dir, 0755 ) ) { // @codingStandardsIgnoreLine
		0 ignored issues – show Duplication introduced 2019-10-21 14:26 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
193		WC_Stripe_Logger::log( 'Error: ' . __( 'Unable to create domain association folder to domain root.', 'woocommerce-gateway-stripe' ) );
194		return false;
195		}
196		}
197
198	View Code Duplication	if ( ! @copy( WC_STRIPE_PLUGIN_PATH . '/' . $file, $fullpath ) ) { // @codingStandardsIgnoreLine
		0 ignored issues – show Duplication introduced 2019-10-21 14:26 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
199		WC_Stripe_Logger::log( 'Error: ' . __( 'Unable to copy domain association file to domain root.', 'woocommerce-gateway-stripe' ) );
200		return false;
201		}
202
203		WC_Stripe_Logger::log( 'Domain association file updated.' );
204		return true;
205		}
206
207		/**
208		* Processes the Apple Pay domain verification.
209		*
210		* @since 3.1.0
211		* @version 3.1.0
212		*/
213		public function verify_domain() {
214		if ( ! $this->update_domain_association_file( true ) ) {
215		$this->stripe_settings['apple_pay_domain_set'] = 'no';
216		update_option( 'woocommerce_stripe_settings', $this->stripe_settings );
217		return;
218		}
219
220		try {
221		// At this point then the domain association folder and file should be available.
222		// Proceed to verify/and or verify again.
223		$this->register_domain_with_apple( $this->secret_key );
224
225		// No errors to this point, verification success!
226		$this->stripe_settings['apple_pay_domain_set'] = 'yes';
227		$this->apple_pay_domain_set = true;
228
229		update_option( 'woocommerce_stripe_settings', $this->stripe_settings );
230
231		WC_Stripe_Logger::log( 'Your domain has been verified with Apple Pay!' );
232
233		} catch ( Exception $e ) {
234		$this->stripe_settings['apple_pay_domain_set'] = 'no';
235
236		update_option( 'woocommerce_stripe_settings', $this->stripe_settings );
237
238		WC_Stripe_Logger::log( 'Error: ' . $e->getMessage() );
239		}
240		}
241
242		/**
243		* Conditionally process the Apple Pay domain verification after a new secret key is set.
244		*
245		* @since 4.5.3
246		* @version 4.5.3
247		*/
248		public function verify_domain_on_new_secret_key( $prev_settings, $settings ) {
249		$this->stripe_settings = $prev_settings;
250		$prev_secret_key = $this->get_secret_key();
251
252		$this->stripe_settings = $settings;
253		$this->secret_key = $this->get_secret_key();
254
255		if ( ! empty( $this->secret_key ) && $this->secret_key !== $prev_secret_key ) {
256		$this->verify_domain();
257		}
258		}
259
260		/**
261		* Process the Apple Pay domain verification if not already done - otherwise just update the file.
262		*
263		* @since 4.5.3
264		* @version 4.5.3
265		*/
266		public function verify_domain_if_needed() {
267		if ( $this->apple_pay_domain_set ) {
268		$this->update_domain_association_file();
269		} else {
270		$this->verify_domain();
271		}
272		}
273
274		/**
275		* Display any admin notices to the user.
276		*
277		* @since 4.0.6
278		*/
279		public function admin_notices() {
280		if ( ! $this->stripe_enabled ) {
281		return;
282		}
283
284		if ( ! current_user_can( 'manage_woocommerce' ) ) {
285		return;
286		}
287
288		if ( $this->payment_request && ! empty( $this->apple_pay_verify_notice ) ) {
289		$allowed_html = array(
290		'a' => array(
291		'href' => array(),
292		'title' => array(),
293		),
294		);
295
296		echo '<div class="error stripe-apple-pay-message"><p>' . wp_kses( make_clickable( $this->apple_pay_verify_notice ), $allowed_html ) . '</p></div>';
297		}
298
299		/**
300		* Apple pay is enabled by default and domain verification initializes
301		* when setting screen is displayed. So if domain verification is not set,
302		* something went wrong so lets notify user.
303		*/
304		if ( ! empty( $this->secret_key ) && $this->payment_request && ! $this->apple_pay_domain_set ) {
305		/* translators: 1) HTML anchor open tag 2) HTML anchor closing tag */
306		echo '<div class="error stripe-apple-pay-message"><p>' . sprintf( __( 'Apple Pay domain verification failed. Please check the %1$slog%2$s to see the issue. (Logging must be enabled to see recorded logs)', 'woocommerce-gateway-stripe' ), '<a href="' . admin_url( 'admin.php?page=wc-status&tab=logs' ) . '">', '</a>' ) . '</p></div>';
307		}
308		}
309		}
310
311		new WC_Stripe_Apple_Pay_Registration();
312

woocommerce / woocommerce-gateway-stripe