WC_Stripe_Apple_Pay_Registration::__construct() - Code Metrics - Inspection of "Serve Apple Pay domain association file via rewrit..." - woocommerce/woocommerce-gateway-stripe - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 462380...626044 )

unknown

created 2020-11-11 00:31 UTC

WC_Stripe_Apple_Pay_Registration::__construct() A

↳ Parent: WC_Stripe_Apple_Pay_Registration

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0

<?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;

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

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

	public function __construct() {
		add_action( 'init', array( $this, 'add_domain_association_rewrite_rule' ) );
		add_filter( 'query_vars', array( $this, 'whitelist_domain_association_query_param' ), 10, 1 );
		add_action( 'parse_request', array( $this, 'parse_domain_association_request' ), 10, 1 );

		add_action( 'woocommerce_stripe_updated', array( $this, 'verify_domain_if_configured' ) );
		add_action( 'add_option_woocommerce_stripe_settings', array( $this, 'verify_domain_on_new_settings' ), 10, 2 );
		add_action( 'update_option_woocommerce_stripe_settings', array( $this, 'verify_domain_on_updated_settings' ), 10, 2 );
		add_action( 'admin_notices', array( $this, 'admin_notices' ) );

		$this->stripe_settings         = get_option( 'woocommerce_stripe_settings', array() );
		$this->apple_pay_domain_set    = 'yes' === $this->get_option( 'apple_pay_domain_set', 'no' );
		$this->apple_pay_verify_notice = '';
	}

	/**
	 * 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;
	}

	/**
	 * Whether the gateway and Payment Request Button (prerequisites for Apple Pay) are enabled.
	 *
	 * @since 4.5.4
	 * @return string Whether Apple Pay required settings are enabled.
	 */
	private function is_enabled() {
		$stripe_enabled                 = 'yes' === $this->get_option( 'enabled', 'no' );
		$payment_request_button_enabled = 'yes' === $this->get_option( 'payment_request', 'yes' );

		return $stripe_enabled && $payment_request_button_enabled;
	}

	/**
	 * 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' );
	}

	/**
	 * Adds a rewrite rule for serving the domain association file from the proper location.
	 */
	public function add_domain_association_rewrite_rule() {
		$regex    = '^\.well-known\/apple-developer-merchantid-domain-association$';
		$redirect = 'index.php?apple-developer-merchantid-domain-association=1';

		add_rewrite_rule( $regex, $redirect, 'top' );
	}

	/**
	 * Add to the list of publicly allowed query variables.
	 *
	 * @param  array $query_vars - provided public query vars.
	 * @return array Updated public query vars.
	 */
	public function whitelist_domain_association_query_param( $query_vars ) {
		$query_vars[] = 'apple-developer-merchantid-domain-association';
		return $query_vars;
	}

	/**
	 * Serve domain association file when proper query param is provided.
	 *
	 * @param WP WordPress environment object.
	 */
	public function parse_domain_association_request( $wp ) {
		if (
			! isset( $wp->query_vars['apple-developer-merchantid-domain-association'] ) ||
			'1' !== $wp->query_vars['apple-developer-merchantid-domain-association']
		) {
			return;
		}

		$path = WC_STRIPE_PLUGIN_PATH . '/apple-developer-merchantid-domain-association';
		header( 'Content-Type: application/octet-stream' );
		echo esc_html( file_get_contents( $path ) );
		exit;
	}

	/**
	 * Makes request to register the domain with Stripe/Apple Pay.
	 *
	 * @since 3.1.0
	 * @version 4.5.4
	 * @param string $secret_key
	 */
	private function make_domain_registration_request( $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 ) );
		}
	}

	/**
	 * Processes the Apple Pay domain verification.
	 *
	 * @since 3.1.0
	 * @version 4.5.4
	 *
	 * @param string $secret_key
	 */
	public function register_domain_with_apple( $secret_key ) {
		try {
			$this->make_domain_registration_request( $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';
			$this->apple_pay_domain_set                    = false;

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

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


	/**
	 * Process the Apple Pay domain verification if proper settings are configured.
	 *
	 * @since 4.5.4
	 * @version 4.5.4
	 */
	public function verify_domain_if_configured() {
		$secret_key = $this->get_secret_key();

		if ( ! $this->is_enabled() || empty( $secret_key ) ) {
			return;
		}

		// Ensure that domain association file will be served.
		flush_rewrite_rules();

		// Register the domain with Apple Pay.
		$this->register_domain_with_apple( $secret_key );

		// Show/hide failure note if necessary.
		WC_Stripe_Inbox_Notes::notify_of_apple_pay_domain_verification_if_needed();
	}

	/**
	 * Conditionally process the Apple Pay domain verification after settings are initially set.
	 *
	 * @since 4.5.4
	 * @version 4.5.4
	 */
	public function verify_domain_on_new_settings( $option, $settings ) {
		$this->verify_domain_on_updated_settings( array(), $settings );
	}

	/**
	 * Conditionally process the Apple Pay domain verification after settings are updated.
	 *
	 * @since 4.5.3
	 * @version 4.5.4
	 */
	public function verify_domain_on_updated_settings( $prev_settings, $settings ) {
		// Grab previous state and then update cached settings.
		$this->stripe_settings = $prev_settings;
		$prev_secret_key       = $this->get_secret_key();
		$prev_is_enabled       = $this->is_enabled();
		$this->stripe_settings = $settings;

		// If Stripe or Payment Request Button wasn't enabled (or secret key was different) then might need to verify now.
		if ( ! $prev_is_enabled || ( $this->get_secret_key() !== $prev_secret_key ) ) {
			$this->verify_domain_if_configured();
		}
	}

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

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

		$empty_notice = empty( $this->apple_pay_verify_notice );
		if ( $empty_notice && ( $this->apple_pay_domain_set || empty( $this->secret_key ) ) ) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
			return;
		}

		/**
		 * 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.
		 */
		$allowed_html                      = array(
			'a' => array(
				'href'  => array(),
				'title' => array(),
			),
		);
		$verification_failed_without_error = __( 'Apple Pay domain verification failed.', 'woocommerce-gateway-stripe' );
		$verification_failed_with_error    = __( 'Apple Pay domain verification failed with the following error:', 'woocommerce-gateway-stripe' );
		$check_log_text                    = sprintf(
			/* translators: 1) HTML anchor open tag 2) HTML anchor closing tag */
			esc_html__( 'Please check the %1$slogs%2$s for more details on this issue. Logging must be enabled to see recorded logs.', 'woocommerce-gateway-stripe' ),
			'<a href="' . admin_url( 'admin.php?page=wc-status&tab=logs' ) . '">',
			'</a>'
		);

		?>
		<div class="error stripe-apple-pay-message">
			<?php if ( $empty_notice ) : ?>
				<p><?php echo esc_html( $verification_failed_without_error ); ?></p>
			<?php else : ?>
				<p><?php echo esc_html( $verification_failed_with_error ); ?></p>
				<p><i><?php echo wp_kses( make_clickable( esc_html( $this->apple_pay_verify_notice ) ), $allowed_html ); ?></i></p>
			<?php endif; ?>
			<p><?php echo $check_log_text; ?></p>
		</div>
		<?php
	}
}

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			* Apple Pay Domain Set.
22			*
23			* @var bool
24			*/
25			public $apple_pay_domain_set;
26
27			/**
28			* Stores Apple Pay domain verification issues.
29			*
30			* @var string
31			*/
32			public $apple_pay_verify_notice;
33
34			public function __construct() {
35			add_action( 'init', array( $this, 'add_domain_association_rewrite_rule' ) );
36			add_filter( 'query_vars', array( $this, 'whitelist_domain_association_query_param' ), 10, 1 );
37			add_action( 'parse_request', array( $this, 'parse_domain_association_request' ), 10, 1 );
38
39			add_action( 'woocommerce_stripe_updated', array( $this, 'verify_domain_if_configured' ) );
40			add_action( 'add_option_woocommerce_stripe_settings', array( $this, 'verify_domain_on_new_settings' ), 10, 2 );
41			add_action( 'update_option_woocommerce_stripe_settings', array( $this, 'verify_domain_on_updated_settings' ), 10, 2 );
42			add_action( 'admin_notices', array( $this, 'admin_notices' ) );
43
44			$this->stripe_settings = get_option( 'woocommerce_stripe_settings', array() );
45			$this->apple_pay_domain_set = 'yes' === $this->get_option( 'apple_pay_domain_set', 'no' );
46			$this->apple_pay_verify_notice = '';
47			}
48
49			/**
50			* Gets the Stripe settings.
51			*
52			* @since 4.0.6
53			* @param string $setting
54			* @param string default
55			* @return string $setting_value
56			*/
57			public function get_option( $setting = '', $default = '' ) {
58			if ( empty( $this->stripe_settings ) ) {
59			return $default;
60			}
61
62			if ( ! empty( $this->stripe_settings[ $setting ] ) ) {
63			return $this->stripe_settings[ $setting ];
64			}
65
66			return $default;
67			}
68
69			/**
70			* Whether the gateway and Payment Request Button (prerequisites for Apple Pay) are enabled.
71			*
72			* @since 4.5.4
73			* @return string Whether Apple Pay required settings are enabled.
74			*/
75			private function is_enabled() {
76			$stripe_enabled = 'yes' === $this->get_option( 'enabled', 'no' );
77			$payment_request_button_enabled = 'yes' === $this->get_option( 'payment_request', 'yes' );
78
79			return $stripe_enabled && $payment_request_button_enabled;
80			}
81
82			/**
83			* Gets the Stripe secret key for the current mode.
84			*
85			* @since 4.5.3
86			* @return string Secret key.
87			*/
88			private function get_secret_key() {
89			$testmode = 'yes' === $this->get_option( 'testmode', 'no' );
90			return $testmode ? $this->get_option( 'test_secret_key' ) : $this->get_option( 'secret_key' );
91			}
92
93			/**
94			* Adds a rewrite rule for serving the domain association file from the proper location.
95			*/
96			public function add_domain_association_rewrite_rule() {
97			$regex = '^\.well-known\/apple-developer-merchantid-domain-association$';
98			$redirect = 'index.php?apple-developer-merchantid-domain-association=1';
99
100			add_rewrite_rule( $regex, $redirect, 'top' );
101			}
102
103			/**
104			* Add to the list of publicly allowed query variables.
105			*
106			* @param array $query_vars - provided public query vars.
107			* @return array Updated public query vars.
108			*/
109			public function whitelist_domain_association_query_param( $query_vars ) {
110			$query_vars[] = 'apple-developer-merchantid-domain-association';
111			return $query_vars;
112			}
113
114			/**
115			* Serve domain association file when proper query param is provided.
116			*
117			* @param WP WordPress environment object.
118			*/
119			public function parse_domain_association_request( $wp ) {
120			if (
121			! isset( $wp->query_vars['apple-developer-merchantid-domain-association'] ) \|\|
122			'1' !== $wp->query_vars['apple-developer-merchantid-domain-association']
123			) {
124			return;
125			}
126
127			$path = WC_STRIPE_PLUGIN_PATH . '/apple-developer-merchantid-domain-association';
128			header( 'Content-Type: application/octet-stream' );
129			echo esc_html( file_get_contents( $path ) );
130			exit;
131			}
132
133			/**
134			* Makes request to register the domain with Stripe/Apple Pay.
135			*
136			* @since 3.1.0
137			* @version 4.5.4
138			* @param string $secret_key
139			*/
140			private function make_domain_registration_request( $secret_key ) {
141			if ( empty( $secret_key ) ) {
142			throw new Exception( __( 'Unable to verify domain - missing secret key.', 'woocommerce-gateway-stripe' ) );
143			}
144
145			$endpoint = 'https://api.stripe.com/v1/apple_pay/domains';
146
147			$data = array(
148			'domain_name' => $_SERVER['HTTP_HOST'],
149			);
150
151			$headers = array(
152			'User-Agent' => 'WooCommerce Stripe Apple Pay',
153			'Authorization' => 'Bearer ' . $secret_key,
154			);
155
156			$response = wp_remote_post(
157			$endpoint,
158			array(
159			'headers' => $headers,
160			'body' => http_build_query( $data ),
161			)
162			);
163
164			if ( is_wp_error( $response ) ) {
165			/* translators: error message */
166			throw new Exception( sprintf( __( 'Unable to verify domain - %s', 'woocommerce-gateway-stripe' ), $response->get_error_message() ) );
167			}
168
169			if ( 200 !== $response['response']['code'] ) {
170			$parsed_response = json_decode( $response['body'] );
171
172			$this->apple_pay_verify_notice = $parsed_response->error->message;
173
174			/* translators: error message */
175			throw new Exception( sprintf( __( 'Unable to verify domain - %s', 'woocommerce-gateway-stripe' ), $parsed_response->error->message ) );
176			}
177			}
178
179			/**
180			* Processes the Apple Pay domain verification.
181			*
182			* @since 3.1.0
183			* @version 4.5.4
184			*
185			* @param string $secret_key
186			*/
187			public function register_domain_with_apple( $secret_key ) {
188			try {
189			$this->make_domain_registration_request( $secret_key );
190
191			// No errors to this point, verification success!
192			$this->stripe_settings['apple_pay_domain_set'] = 'yes';
193			$this->apple_pay_domain_set = true;
194
195			update_option( 'woocommerce_stripe_settings', $this->stripe_settings );
196
197			WC_Stripe_Logger::log( 'Your domain has been verified with Apple Pay!' );
198
199			} catch ( Exception $e ) {
200			$this->stripe_settings['apple_pay_domain_set'] = 'no';
201			$this->apple_pay_domain_set = false;
202
203			update_option( 'woocommerce_stripe_settings', $this->stripe_settings );
204
205			WC_Stripe_Logger::log( 'Error: ' . $e->getMessage() );
206			}
207			}
208
209
210			/**
211			* Process the Apple Pay domain verification if proper settings are configured.
212			*
213			* @since 4.5.4
214			* @version 4.5.4
215			*/
216			public function verify_domain_if_configured() {
217			$secret_key = $this->get_secret_key();
218
219			if ( ! $this->is_enabled() \|\| empty( $secret_key ) ) {
220			return;
221			}
222
223			// Ensure that domain association file will be served.
224			flush_rewrite_rules();
225
226			// Register the domain with Apple Pay.
227			$this->register_domain_with_apple( $secret_key );
228
229			// Show/hide failure note if necessary.
230			WC_Stripe_Inbox_Notes::notify_of_apple_pay_domain_verification_if_needed();
231			}
232
233			/**
234			* Conditionally process the Apple Pay domain verification after settings are initially set.
235			*
236			* @since 4.5.4
237			* @version 4.5.4
238			*/
239			public function verify_domain_on_new_settings( $option, $settings ) {
240			$this->verify_domain_on_updated_settings( array(), $settings );
241			}
242
243			/**
244			* Conditionally process the Apple Pay domain verification after settings are updated.
245			*
246			* @since 4.5.3
247			* @version 4.5.4
248			*/
249			public function verify_domain_on_updated_settings( $prev_settings, $settings ) {
250			// Grab previous state and then update cached settings.
251			$this->stripe_settings = $prev_settings;
252			$prev_secret_key = $this->get_secret_key();
253			$prev_is_enabled = $this->is_enabled();
254			$this->stripe_settings = $settings;
255
256			// If Stripe or Payment Request Button wasn't enabled (or secret key was different) then might need to verify now.
257			if ( ! $prev_is_enabled \|\| ( $this->get_secret_key() !== $prev_secret_key ) ) {
258			$this->verify_domain_if_configured();
259			}
260			}
261
262			/**
263			* Display any admin notices to the user.
264			*
265			* @since 4.0.6
266			*/
267			public function admin_notices() {
268			if ( ! $this->is_enabled() ) {
269			return;
270			}
271
272			if ( ! current_user_can( 'manage_woocommerce' ) ) {
273			return;
274			}
275
276			$empty_notice = empty( $this->apple_pay_verify_notice );
277			if ( $empty_notice && ( $this->apple_pay_domain_set \|\| empty( $this->secret_key ) ) ) {
			0 ignored issues – show Bug introduced 2020-11-04 22:41 UTC by Report Bug Copy Issue Report The property `secret_key` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
278			return;
279			}
280
281			/**
282			* Apple pay is enabled by default and domain verification initializes
283			* when setting screen is displayed. So if domain verification is not set,
284			* something went wrong so lets notify user.
285			*/
286			$allowed_html = array(
287			'a' => array(
288			'href' => array(),
289			'title' => array(),
290			),
291			);
292			$verification_failed_without_error = __( 'Apple Pay domain verification failed.', 'woocommerce-gateway-stripe' );
293			$verification_failed_with_error = __( 'Apple Pay domain verification failed with the following error:', 'woocommerce-gateway-stripe' );
294			$check_log_text = sprintf(
295			/* translators: 1) HTML anchor open tag 2) HTML anchor closing tag */
296			esc_html__( 'Please check the %1$slogs%2$s for more details on this issue. Logging must be enabled to see recorded logs.', 'woocommerce-gateway-stripe' ),
297			'<a href="' . admin_url( 'admin.php?page=wc-status&tab=logs' ) . '">',
298			'</a>'
299			);
300
301			?>
302			<div class="error stripe-apple-pay-message">
303			<?php if ( $empty_notice ) : ?>
304			<p><?php echo esc_html( $verification_failed_without_error ); ?></p>
305			<?php else : ?>
306			<p><?php echo esc_html( $verification_failed_with_error ); ?></p>
307			<p><i><?php echo wp_kses( make_clickable( esc_html( $this->apple_pay_verify_notice ) ), $allowed_html ); ?></i></p>
308			<?php endif; ?>
309			<p><?php echo $check_log_text; ?></p>
310			</div>
311			<?php
312			}
313			}
314
315			new WC_Stripe_Apple_Pay_Registration();
316

woocommerce / woocommerce-gateway-stripe

Push — master ( 462380...626044 )

WC_Stripe_Apple_Pay_Registration::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like