convertkit / includes / class-convertkit-subscriber.php

class-convertkit-subscriber.php in Kit (formerly ConvertKit) – Email Newsletter, Email Marketing, Membership, Subscribers and Landing Pages 3.0.6, at includes/class-convertkit-subscriber.php

198 lines 5.2 KB

Raw Download Zip

1	<?php
2	/**
3	* ConvertKit Subscriber class.
4	*
5	* @package ConvertKit
6	* @author ConvertKit
7	*/
8
9	/**
10	* Class to confirm a ConvertKit Subscriber ID exists, writing/reading
11	* it from cookie storage.
12	*
13	* @since 2.0.0
14	*/
15	class ConvertKit_Subscriber {
16
17	/**
18	* Holds the key to check on requests and store as a cookie.
19	*
20	* @since 2.0.0
21	*
22	* @var string
23	*/
24	private $key = 'ck_subscriber_id';
25
26	/**
27	* Gets the subscriber ID from either the request's `ck_subscriber_id` parameter,
28	* or the existing `ck_subscriber_id` cookie.
29	*
30	* @since 2.0.0
31	*
32	* @return WP_Error\|bool\|int\|string Error \| false \| Subscriber ID \| Signed Subscriber ID
33	*/
34	public function get_subscriber_id() {
35
36	// If the subscriber ID is in the request URI, use it.
37	if ( filter_has_var( INPUT_GET, $this->key ) ) {
38	return $this->validate_and_store_subscriber_id( filter_input( INPUT_GET, $this->key, FILTER_SANITIZE_FULL_SPECIAL_CHARS ) );
39	}
40
41	// If the subscriber ID is in a cookie, return it.
42	// For performance, we don't check that the subscriber ID exists every time, otherwise this would
43	// call the API on every page load.
44	if ( isset( $_COOKIE[ $this->key ] ) && ! empty( $_COOKIE[ $this->key ] ) ) {
45	return $this->get_subscriber_id_from_cookie();
46	}
47
48	// If here, no subscriber ID exists.
49	return false;
50
51	}
52
53	/**
54	* Validates the given subscriber ID by querying the API to confirm
55	* the subscriber exists before storing their ID in a cookie.
56	*
57	* @since 2.0.0
58	*
59	* @param int\|string $subscriber_id Possible Subscriber ID or Signed Subscriber ID.
60	* @return WP_Error\|int\|string Error \| Confirmed Subscriber ID or Signed Subscriber ID
61	*/
62	public function validate_and_store_subscriber_id( $subscriber_id ) {
63
64	// Bail if the API hasn't been configured.
65	$settings = new ConvertKit_Settings();
66	if ( ! $settings->has_access_and_refresh_token() ) {
67	return new WP_Error(
68	'convertkit_subscriber_get_subscriber_id_from_request_error',
69	__( 'Access Token not configured in Plugin Settings.', 'convertkit' )
70	);
71	}
72
73	// Initialize the API.
74	$api = new ConvertKit_API_V4(
75	CONVERTKIT_OAUTH_CLIENT_ID,
76	CONVERTKIT_OAUTH_CLIENT_REDIRECT_URI,
77	$settings->get_access_token(),
78	$settings->get_refresh_token(),
79	$settings->debug_enabled(),
80	'subscriber'
81	);
82
83	// Get subscriber by ID, to ensure they exist.
84	$subscriber = $api->get_subscriber( absint( $subscriber_id ) );
85
86	// Bail if no subscriber exists with the given subscriber ID, or an error occured.
87	if ( is_wp_error( $subscriber ) ) {
88	// Delete the cookie.
89	$this->forget();
90
91	// Return error.
92	return $subscriber;
93	}
94
95	// Store the subscriber ID as a cookie.
96	$this->set( $subscriber['subscriber']['id'] );
97
98	// Return subscriber ID.
99	return $subscriber['subscriber']['id'];
100
101	}
102
103	/**
104	* Validates the given subscriber email by querying the API to confirm
105	* the subscriber exists before storing their ID in a cookie.
106	*
107	* @since 2.0.0
108	*
109	* @param string $subscriber_email Possible Subscriber Email.
110	* @return WP_Error\|int\|string Error \| Confirmed Subscriber ID or Signed Subscriber ID
111	*/
112	public function validate_and_store_subscriber_email( $subscriber_email ) {
113
114	// Bail if the API hasn't been configured.
115	$settings = new ConvertKit_Settings();
116	if ( ! $settings->has_access_and_refresh_token() ) {
117	return new WP_Error(
118	'convertkit_subscriber_get_subscriber_id_from_request_error',
119	__( 'Access Token not configured in Plugin Settings.', 'convertkit' )
120	);
121	}
122
123	// Initialize the API.
124	$api = new ConvertKit_API_V4(
125	CONVERTKIT_OAUTH_CLIENT_ID,
126	CONVERTKIT_OAUTH_CLIENT_REDIRECT_URI,
127	$settings->get_access_token(),
128	$settings->get_refresh_token(),
129	$settings->debug_enabled(),
130	'subscriber'
131	);
132
133	// Get subscriber by email, to ensure they exist.
134	$subscriber_id = $api->get_subscriber_id( $subscriber_email );
135
136	// Bail if no subscriber exists with the given subscriber ID, or an error occured.
137	if ( is_wp_error( $subscriber_id ) ) {
138	// Delete the cookie.
139	$this->forget();
140
141	// Return error.
142	return $subscriber_id;
143	}
144
145	// Store the subscriber ID as a cookie.
146	$this->set( $subscriber_id );
147
148	// Return subscriber ID.
149	return $subscriber_id;
150
151	}
152
153	/**
154	* Gets the subscriber ID from the `ck_subscriber_id` cookie.
155	*
156	* @since 2.0.0
157	*
158	* @return string
159	*/
160	private function get_subscriber_id_from_cookie() {
161
162	if ( ! isset( $_COOKIE[ $this->key ] ) ) {
163	return '';
164	}
165
166	return sanitize_text_field( wp_unslash( $_COOKIE[ $this->key ] ) );
167
168	}
169
170	/**
171	* Stores the given subscriber ID in the `ck_subscriber_id` cookie
172	* and a prefixed `wordpress_ck_subscriber_id` cookie.
173	*
174	* @since 2.0.0
175	*
176	* @param int\|string $subscriber_id Subscriber ID.
177	*/
178	public function set( $subscriber_id ) {
179
180	setcookie( $this->key, (string) $subscriber_id, time() + ( 365 * DAY_IN_SECONDS ), '/' );
181	setcookie( 'wordpress_' . $this->key, (string) $subscriber_id, time() + ( 365 * DAY_IN_SECONDS ), '/' );
182
183	}
184
185	/**
186	* Deletes the `ck_subscriber_id` cookie.
187	*
188	* @since 2.0.0
189	*/
190	public function forget() {
191
192	setcookie( $this->key, '', time() - ( 365 * DAY_IN_SECONDS ), '/' );
193	setcookie( 'wordpress_' . $this->key, '', time() - ( 365 * DAY_IN_SECONDS ), '/' );
194
195	}
196
197	}
198