Completed
Push — try/package-button-block ( e0a758...b39073 )
by
unknown
116:40 queued 108:18
created

Jetpack_Memberships::get_instance()   A

Complexity

Conditions 4
Paths 5

Size

Total Lines 10

Duplication

Lines 9
Ratio 90 %

Importance

Changes 0
Metric Value
cc 4
nc 5
nop 0
dl 9
loc 10
rs 9.9332
c 0
b 0
f 0
1
<?php
2
/**
3
 * Jetpack_Memberships: wrapper for memberships functions.
4
 *
5
 * @package    Jetpack
6
 * @since      7.3.0
7
 */
8
9
/**
10
 * Class Jetpack_Memberships
11
 * This class represents the Memberships functionality.
12
 */
13
class Jetpack_Memberships {
14
	/**
15
	 * CSS class prefix to use in the styling.
16
	 *
17
	 * @var string
18
	 */
19
	public static $css_classname_prefix = 'jetpack-memberships';
20
	/**
21
	 * Our CPT type for the product (plan).
22
	 *
23
	 * @var string
24
	 */
25
	public static $post_type_plan = 'jp_mem_plan';
26
	/**
27
	 * Option that will store currently set up account (Stripe etc) id for memberships.
28
	 *
29
	 * @var string
30
	 */
31
	public static $connected_account_id_option_name = 'jetpack-memberships-connected-account-id';
32
	/**
33
	 * Button block type to use.
34
	 *
35
	 * @var string
36
	 */
37
	private static $button_block_name = 'recurring-payments';
38
39
	/**
40
	 * These are defaults for wp_kses ran on the membership button.
41
	 *
42
	 * @var array
43
	 */
44
	private static $tags_allowed_in_the_button = array( 'br' => array() );
45
46
	/**
47
	 * The minimum required plan for this Gutenberg block.
48
	 *
49
	 * @var string Plan slug
50
	 */
51
	private static $required_plan;
52
53
	/**
54
	 * Track recurring payments block registration.
55
	 *
56
	 * @var boolean True if block registration has been executed.
57
	 */
58
	private static $has_registered_block = false;
59
60
	/**
61
	 * Classic singleton pattern
62
	 *
63
	 * @var Jetpack_Memberships
64
	 */
65
	private static $instance;
66
67
	/**
68
	 * Jetpack_Memberships constructor.
69
	 */
70
	private function __construct() {}
71
72
	/**
73
	 * The actual constructor initializing the object.
74
	 *
75
	 * @return Jetpack_Memberships
76
	 */
77 View Code Duplication
	public static function get_instance() {
78
		if ( ! self::$instance ) {
79
			self::$instance = new self();
80
			self::$instance->register_init_hook();
81
			// Yes, `personal-bundle` with a dash, `jetpack_personal` with an underscore. Check the v1.5 endpoint to verify.
82
			self::$required_plan = ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ? 'personal-bundle' : 'jetpack_personal';
83
		}
84
85
		return self::$instance;
86
	}
87
	/**
88
	 * Get the map that defines the shape of CPT post. keys are names of fields and
89
	 * 'meta' is the name of actual WP post meta field that corresponds.
90
	 *
91
	 * @return array
92
	 */
93
	private static function get_plan_property_mapping() {
94
		$meta_prefix = 'jetpack_memberships_';
95
		$properties  = array(
96
			'price'    => array(
97
				'meta' => $meta_prefix . 'price',
98
			),
99
			'currency' => array(
100
				'meta' => $meta_prefix . 'currency',
101
			),
102
		);
103
		return $properties;
104
	}
105
106
	/**
107
	 * Inits further hooks on init hook.
108
	 */
109
	private function register_init_hook() {
110
		add_action( 'init', array( $this, 'init_hook_action' ) );
111
		add_action( 'jetpack_register_gutenberg_extensions', array( $this, 'register_gutenberg_block' ) );
112
	}
113
114
	/**
115
	 * Actual hooks initializing on init.
116
	 */
117
	public function init_hook_action() {
118
		add_filter( 'rest_api_allowed_post_types', array( $this, 'allow_rest_api_types' ) );
119
		add_filter( 'jetpack_sync_post_meta_whitelist', array( $this, 'allow_sync_post_meta' ) );
120
		$this->setup_cpts();
121
	}
122
123
	/**
124
	 * Sets up the custom post types for the module.
125
	 */
126
	private function setup_cpts() {
127
		/*
128
		 * PLAN data structure.
129
		 */
130
		$capabilities = array(
131
			'edit_post'          => 'edit_posts',
132
			'read_post'          => 'read_private_posts',
133
			'delete_post'        => 'delete_posts',
134
			'edit_posts'         => 'edit_posts',
135
			'edit_others_posts'  => 'edit_others_posts',
136
			'publish_posts'      => 'publish_posts',
137
			'read_private_posts' => 'read_private_posts',
138
		);
139
		$order_args   = array(
140
			'label'               => esc_html__( 'Plan', 'jetpack' ),
141
			'description'         => esc_html__( 'Recurring Payments plans', 'jetpack' ),
142
			'supports'            => array( 'title', 'custom-fields', 'content' ),
143
			'hierarchical'        => false,
144
			'public'              => false,
145
			'show_ui'             => false,
146
			'show_in_menu'        => false,
147
			'show_in_admin_bar'   => false,
148
			'show_in_nav_menus'   => false,
149
			'can_export'          => true,
150
			'has_archive'         => false,
151
			'exclude_from_search' => true,
152
			'publicly_queryable'  => false,
153
			'rewrite'             => false,
154
			'capabilities'        => $capabilities,
155
			'show_in_rest'        => false,
156
		);
157
		register_post_type( self::$post_type_plan, $order_args );
158
	}
159
160
	/**
161
	 * Allows custom post types to be used by REST API.
162
	 *
163
	 * @param array $post_types - other post types.
164
	 *
165
	 * @see hook 'rest_api_allowed_post_types'
166
	 * @return array
167
	 */
168
	public function allow_rest_api_types( $post_types ) {
169
		$post_types[] = self::$post_type_plan;
170
171
		return $post_types;
172
	}
173
174
	/**
175
	 * Allows custom meta fields to sync.
176
	 *
177
	 * @param array $post_meta - previously changet post meta.
178
	 *
179
	 * @return array
180
	 */
181
	public function allow_sync_post_meta( $post_meta ) {
182
		$meta_keys = array_map(
183
			array( $this, 'return_meta' ),
184
			$this->get_plan_property_mapping()
185
		);
186
		return array_merge( $post_meta, array_values( $meta_keys ) );
187
	}
188
189
	/**
190
	 * This returns meta attribute of passet array.
191
	 * Used for array functions.
192
	 *
193
	 * @param array $map - stuff.
194
	 *
195
	 * @return mixed
196
	 */
197
	public function return_meta( $map ) {
198
		return $map['meta'];
199
	}
200
	/**
201
	 * Callback that parses the membership purchase shortcode.
202
	 *
203
	 * @param array  $attrs - attributes in the shortcode. `id` here is the CPT id of the plan.
204
	 * @param string $content - Recurring Payment block content.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $content not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
205
	 *
206
	 * @return string|void
207
	 */
208
	public function render_button( $attrs, $content = null ) {
209
		Jetpack_Gutenberg::load_assets_as_required( self::$button_block_name, array( 'thickbox', 'wp-polyfill' ) );
210
211
		if ( empty( $attrs['planId'] ) ) {
212
			return;
213
		}
214
		$plan_id = intval( $attrs['planId'] );
215
		$product = get_post( $plan_id );
216
		if ( ! $product || is_wp_error( $product ) ) {
217
			return;
218
		}
219
		if ( $product->post_type !== self::$post_type_plan || 'publish' !== $product->post_status ) {
220
			return;
221
		}
222
223
		add_thickbox();
224
225
		if ( ! empty( $content ) ) {
226
			$block_id      = esc_attr( wp_unique_id( 'recurring-payments-block-' ) );
227
			$content       = str_replace( 'recurring-payments-id', $block_id, $content );
228
			$subscribe_url = $this->get_subscription_url( $plan_id );
229
			return str_replace( 'href="#"', 'href="' . $subscribe_url . '"', $content );
230
		}
231
232
		return $this->deprecated_render_button_v1( $attrs, $plan_id );
233
	}
234
235
	/**
236
	 * Builds subscription URL for this membership using the current blog and
237
	 * supplied plan IDs.
238
	 *
239
	 * @param integer $plan_id - Unique ID for the plan being subscribed to.
240
	 * @return string
241
	 */
242
	public function get_subscription_url( $plan_id ) {
243
		global $wp;
244
245
		return add_query_arg(
246
			array(
247
				'blog'     => esc_attr( self::get_blog_id() ),
248
				'plan'     => esc_attr( $plan_id ),
249
				'lang'     => esc_attr( get_locale() ),
250
				'pid'      => esc_attr( get_the_ID() ), // Needed for analytics purposes.
251
				'redirect' => esc_attr( rawurlencode( home_url( $wp->request ) ) ), // Needed for redirect back in case of redirect-based flow.
252
			),
253
			'https://subscribe.wordpress.com/memberships/'
254
		);
255
	}
256
257
	/**
258
	 * Renders a deprecated legacy version of the button HTML.
259
	 *
260
	 * @param array   $attrs - Array containing the Recurring Payment block attributes.
261
	 * @param integer $plan_id - Unique plan ID the membership is for.
262
	 *
263
	 * @return string
264
	 */
265
	public function deprecated_render_button_v1( $attrs, $plan_id ) {
266
		$button_label = isset( $attrs['submitButtonText'] )
267
			? $attrs['submitButtonText']
268
			: __( 'Your contribution', 'jetpack' );
269
270
		$button_styles = array();
271 View Code Duplication
		if ( ! empty( $attrs['customBackgroundButtonColor'] ) ) {
272
			array_push(
273
				$button_styles,
274
				sprintf(
275
					'background-color: %s',
276
					sanitize_hex_color( $attrs['customBackgroundButtonColor'] )
277
				)
278
			);
279
		}
280 View Code Duplication
		if ( ! empty( $attrs['customTextButtonColor'] ) ) {
281
			array_push(
282
				$button_styles,
283
				sprintf(
284
					'color: %s',
285
					sanitize_hex_color( $attrs['customTextButtonColor'] )
286
				)
287
			);
288
		}
289
		$button_styles = implode( ';', $button_styles );
290
291
		return sprintf(
292
			'<div class="%1$s"><a role="button" %6$s href="%2$s" class="%3$s" style="%4$s">%5$s</a></div>',
293
			esc_attr(
294
				Jetpack_Gutenberg::block_classes(
295
					self::$button_block_name,
296
					$attrs,
297
					array( 'wp-block-button' )
298
				)
299
			),
300
			esc_url( $this->get_subscription_url( $plan_id ) ),
301
			isset( $attrs['submitButtonClasses'] ) ? esc_attr( $attrs['submitButtonClasses'] ) : 'wp-block-button__link',
302
			esc_attr( $button_styles ),
303
			wp_kses( $button_label, self::$tags_allowed_in_the_button ),
304
			isset( $attrs['submitButtonAttributes'] ) ? sanitize_text_field( $attrs['submitButtonAttributes'] ) : '' // Needed for arbitrary target=_blank on WPCOM VIP.
305
		);
306
	}
307
308
	/**
309
	 * Get current blog id.
310
	 *
311
	 * @return int
312
	 */
313
	public static function get_blog_id() {
314
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
315
			return get_current_blog_id();
316
		}
317
318
		return Jetpack_Options::get_option( 'id' );
319
	}
320
321
	/**
322
	 * Get the id of the connected payment acount (Stripe etc).
323
	 *
324
	 * @return int|void
325
	 */
326
	public static function get_connected_account_id() {
327
		return get_option( self::$connected_account_id_option_name );
328
	}
329
330
	/**
331
	 * Whether Recurring Payments are enabled.
332
	 *
333
	 * @return bool
334
	 */
335
	public static function is_enabled_jetpack_recurring_payments() {
336
		// For WPCOM sites.
337 View Code Duplication
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM && function_exists( 'has_any_blog_stickers' ) ) {
338
			$site_id = get_current_blog_id();
339
			return has_any_blog_stickers( array( 'personal-plan', 'premium-plan', 'business-plan', 'ecommerce-plan' ), $site_id );
340
		}
341
342
		// For Jetpack sites.
343
		return Jetpack::is_active() && (
344
			/** This filter is documented in class.jetpack-gutenberg.php */
345
			! apply_filters( 'jetpack_block_editor_enable_upgrade_nudge', false ) || // Remove when the default becomes `true`.
346
			Jetpack_Plan::supports( 'recurring-payments' )
347
		);
348
	}
349
350
	/**
351
	 * Register the Recurring Payments Gutenberg block
352
	 */
353
	public function register_gutenberg_block() {
354
		// This gate was introduced to prevent duplicate registration. A race condition exists where
355
		// the registration that happens via extensions/blocks/recurring-payments/recurring-payments.php
356
		// was adding the registration action after the action had been run in some contexts.
357
		if ( self::$has_registered_block ) {
358
			return;
359
		}
360
361
		if ( self::is_enabled_jetpack_recurring_payments() ) {
362
			jetpack_register_block(
363
				'jetpack/recurring-payments',
364
				array(
365
					'render_callback' => array( $this, 'render_button' ),
366
				)
367
			);
368
		} else {
369
			Jetpack_Gutenberg::set_extension_unavailable(
370
				'jetpack/recurring-payments',
371
				'missing_plan',
372
				array(
373
					'required_feature' => 'memberships',
374
					'required_plan'    => self::$required_plan,
375
				)
376
			);
377
		}
378
379
		self::$has_registered_block = true;
380
	}
381
}
382
Jetpack_Memberships::get_instance();
383