PushNotifications.php — WooCommerce 10.9.1

woocommerce / src / Internal / PushNotifications / PushNotifications.php

woocommerce / src / Internal / PushNotifications Last commit date

Controllers 4 weeks ago DataStores 4 weeks ago Dispatchers 2 months ago Entities 3 months ago Exceptions 4 months ago Notifications 4 weeks ago Services 4 weeks ago Traits 4 weeks ago Triggers 4 weeks ago Validators 3 months ago PushNotifications.php 4 weeks ago

PushNotifications.php

167 lines

1	<?php
2
3	declare(strict_types=1);
4
5	namespace Automattic\WooCommerce\Internal\PushNotifications;
6
7	defined( 'ABSPATH' ) \|\| exit;
8
9	use Automattic\Jetpack\Connection\Manager as JetpackConnectionManager;
10	use Automattic\WooCommerce\Internal\PushNotifications\Controllers\NotificationPreferencesRestController;
11	use Automattic\WooCommerce\Internal\PushNotifications\Controllers\PushNotificationRestController;
12	use Automattic\WooCommerce\Internal\PushNotifications\Controllers\PushTokenRestController;
13	use Automattic\WooCommerce\Internal\PushNotifications\Entities\PushToken;
14	use Automattic\WooCommerce\Internal\PushNotifications\Services\NotificationProcessor;
15	use Automattic\WooCommerce\Internal\PushNotifications\Services\NotificationRetryHandler;
16	use Automattic\WooCommerce\Internal\PushNotifications\Services\PendingNotificationStore;
17	use Automattic\WooCommerce\Internal\PushNotifications\Triggers\NewOrderNotificationTrigger;
18	use Automattic\WooCommerce\Internal\PushNotifications\Triggers\NewReviewNotificationTrigger;
19	use Automattic\WooCommerce\Internal\PushNotifications\Triggers\StockNotificationRecoveryHandler;
20	use Automattic\WooCommerce\Internal\PushNotifications\Triggers\StockNotificationTrigger;
21	use Automattic\WooCommerce\Proxies\LegacyProxy;
22	use Automattic\WooCommerce\Utilities\FeaturesUtil;
23	use WC_Logger;
24	use Exception;
25
26	/**
27	* WC Push Notifications
28	*
29	* Class for setting up the WooCommerce-driven push notifications.
30	*
31	* @since 10.4.0
32	*/
33	class PushNotifications {
34	/**
35	* Feature name for the push notifications feature.
36	*/
37	const FEATURE_NAME = 'push_notifications';
38
39	/**
40	* Roles that can receive push notifications.
41	*
42	* This will be used to gate functionality access to just these roles.
43	*/
44	const ROLES_WITH_PUSH_NOTIFICATIONS_ENABLED = array(
45	'administrator',
46	'shop_manager',
47	);
48
49	/**
50	* 'Memoized' enablement flag.
51	*
52	* @var bool\|null
53	*/
54	private ?bool $enabled = null;
55
56	/**
57	* Registers initialisation tasks to the `init` hook.
58	*
59	* @return void
60	*
61	* @since 10.4.0
62	*/
63	public function register(): void {
64	add_action( 'init', array( $this, 'on_init' ) );
65	}
66
67	/**
68	* Loads the push notifications class.
69	*
70	* @return void
71	*
72	* @since 10.6.0
73	*/
74	public function on_init(): void {
75	if ( ! $this->should_be_enabled() ) {
76	return;
77	}
78
79	$this->register_post_types();
80
81	wc_get_container()->get( PendingNotificationStore::class )->register();
82
83	( new PushTokenRestController() )->register();
84	( new PushNotificationRestController() )->register();
85	( new NotificationPreferencesRestController() )->register();
86	( new NewOrderNotificationTrigger() )->register();
87	( new NewReviewNotificationTrigger() )->register();
88	( new StockNotificationTrigger() )->register();
89	( new StockNotificationRecoveryHandler() )->register();
90
91	wc_get_container()->get( NotificationProcessor::class )->register();
92	wc_get_container()->get( NotificationRetryHandler::class )->register();
93	}
94
95	/**
96	* Registers the push token custom post type.
97	*
98	* @since 10.5.0
99	* @return void
100	*/
101	public function register_post_types(): void {
102	register_post_type(
103	PushToken::POST_TYPE,
104	array(
105	'labels' => array(
106	'name' => __( 'Push Tokens', 'woocommerce' ),
107	'singular_name' => __( 'Push Token', 'woocommerce' ),
108	),
109	'public' => false,
110	'publicly_queryable' => false,
111	'show_ui' => false,
112	'show_in_menu' => false,
113	'query_var' => false,
114	'rewrite' => false,
115	'capability_type' => 'post',
116	'has_archive' => false,
117	'hierarchical' => false,
118	'supports' => array( 'author' ),
119	'can_export' => false,
120	'delete_with_user' => true,
121	)
122	);
123	}
124
125	/**
126	* Determines if local push notification functionality should be enabled.
127	* Push notifications require both the feature flag to be enabled and
128	* Jetpack to be connected. Memoize the value so we only check once per
129	* request.
130	*
131	* @return bool
132	*
133	* @since 10.4.0
134	*/
135	public function should_be_enabled(): bool {
136	if ( null !== $this->enabled ) {
137	return $this->enabled;
138	}
139
140	if ( ! FeaturesUtil::feature_is_enabled( self::FEATURE_NAME ) ) {
141	$this->enabled = false;
142	return $this->enabled;
143	}
144
145	try {
146	$proxy = wc_get_container()->get( LegacyProxy::class );
147
148	$this->enabled = (
149	class_exists( JetpackConnectionManager::class )
150	&& $proxy->get_instance_of( JetpackConnectionManager::class )->is_connected()
151	);
152	} catch ( Exception $e ) {
153	$logger = wc_get_container()->get( LegacyProxy::class )->call_function( 'wc_get_logger' );
154
155	if ( $logger instanceof WC_Logger ) {
156	$logger->error(
157	'Error determining if PushNotifications feature should be enabled: ' . $e->getMessage()
158	);
159	}
160
161	$this->enabled = false;
162	}
163
164	return $this->enabled;
165	}
166	}
167