← All changes | classes/models/FrmFormApi.php +39 -248 6.27 → 5.0.09 View file →

		@@ -4,36 +4,14 @@
4	4	}
5	5
6	6	class FrmFormApi {
7	7
8		- /**
9		- * @var string
10		- */
11	8	protected $license = '';
12		-
13		- /**
14		- * @var string
15		- */
16	9	protected $cache_key = '';
17		-
18		- /**
19		- * @var string
20		- */
21	10	protected $cache_timeout = '+6 hours';
22	11
23	12	/**
24		- * The number of days an add-on is new.
25		- *
26		- * @var int
27		- */
28		- protected $new_days = 90;
29		-
30		- /**
31	13	* @since 3.06
32		- *
33		- * @param string|null $license The license key.
34		- *
35		- * @return void
36	14	*/
37	15	public function __construct( $license = null ) {
38	16	$this->set_license( $license );
39	17	$this->set_cache_key();
		@@ -40,18 +18,13 @@
40	18	}
41	19
42	20	/**
43	21	* @since 3.06
44		- *
45		- * @param string|null $license The license key.
46		- *
47		- * @return void
48	22	*/
49	23	private function set_license( $license ) {
50	24	if ( $license === null ) {
51	25	$edd_update = $this->get_pro_updater();
52		-
53		- if ( $edd_update ) {
	26	+ if ( ! empty( $edd_update ) ) {
54	27	$license = $edd_update->license;
55	28	}
56	29	}
57	30	$this->license = $license;
		@@ -58,9 +31,8 @@
58	31	}
59	32
60	33	/**
61	34	* @since 3.06
62		- *
63	35	* @return string
64	36	*/
65	37	public function get_license() {
66	38	return $this->license;
		@@ -67,10 +39,8 @@
67	39	}
68	40
69	41	/**
70	42	* @since 3.06
71		- *
72		- * @return void
73	43	*/
74	44	protected function set_cache_key() {
75	45	$this->cache_key = 'frm_addons_l' . ( empty( $this->license ) ? '' : md5( $this->license ) );
76	46	}
		@@ -76,9 +46,8 @@
76	46	}
77	47
78	48	/**
79	49	* @since 3.06
80		- *
81	50	* @return string
82	51	*/
83	52	public function get_cache_key() {
84	53	return $this->cache_key;
		@@ -85,34 +54,23 @@
85	54	}
86	55
87	56	/**
88	57	* @since 3.06
89		- *
90	58	* @return array
91	59	*/
92	60	public function get_api_info() {
93	61	$url = $this->api_url();
94		-
95	62	if ( ! empty( $this->license ) ) {
96	63	$url .= '?l=' . urlencode( base64_encode( $this->license ) );
97	64	}
98	65
99	66	$addons = $this->get_cached();
100		-
101		- if ( is_array( $addons ) ) {
	67	+ if ( ! empty( $addons ) ) {
102	68	return $addons;
103	69	}
104	70
105		- if ( $this->is_running() ) {
106		- // If there's no saved cache, we'll need to wait for the current request to finish.
107		- return array();
108		- }
109		-
110		- $this->set_running();
111		-
112	71	// We need to know the version number to allow different downloads.
113	72	$agent = 'formidable/' . FrmAppHelper::plugin_version();
114		-
115	73	if ( class_exists( 'FrmProDb' ) ) {
116	74	$agent = 'formidable-pro/' . FrmProDb::$plug_version;
117	75	}
118	76
		@@ -122,124 +80,43 @@
122	80	'timeout' => 25,
123	81	'user-agent' => $agent . '; ' . get_bloginfo( 'url' ),
124	82	)
125	83	);
126		-
127	84	if ( is_array( $response ) && ! is_wp_error( $response ) ) {
128		- $addons = $response['body'] ? json_decode( $response['body'], true ) : array();
129		- }
	85	+ $addons = $response['body'];
	86	+ if ( ! empty( $addons ) ) {
	87	+ $addons = json_decode( $addons, true );
130	88
131		- if ( ! is_array( $addons ) ) {
132		- $addons = array();
133		- }
134		-
135		- $addons['response_code'] = wp_remote_retrieve_response_code( $response );
136		-
137		- foreach ( $addons as $k => $addon ) {
138		- if ( ! is_array( $addon ) ) {
139		- continue;
140		- }
141		-
142		- if ( isset( $addon['categories'] ) ) {
143		- $cats = array_intersect( $this->skip_categories(), $addon['categories'] );
144		-
145		- if ( $cats ) {
146		- unset( $addons[ $k ] );
147		- continue;
	89	+ foreach ( $addons as $k => $addon ) {
	90	+ if ( ! isset( $addon['categories'] ) ) {
	91	+ continue;
	92	+ }
	93	+ $cats = array_intersect( $this->skip_categories(), $addon['categories'] );
	94	+ if ( ! empty( $cats ) ) {
	95	+ unset( $addons[ $k ] );
	96	+ }
148	97	}
149		- }
150	98
151		- if ( ! array_key_exists( 'is_new', $addon ) && array_key_exists( 'released', $addon ) ) {
152		- $addons[ $k ]['is_new'] = $this->is_new( $addon );
	99	+ $this->set_cached( $addons );
153	100	}
154	101	}
155	102
156		- $this->set_cached( $addons );
157		- $this->done_running();
	103	+ if ( empty( $addons ) ) {
	104	+ return array();
	105	+ }
158	106
159	107	return $addons;
160	108	}
161	109
162	110	/**
163		- * Prevent multiple requests from running at the same time.
164		- *
165		- * @since 6.8.3
166		- *
167		- * @return bool
168		- */
169		- protected function is_running() {
170		- if ( $this->run_as_multisite() ) {
171		- return get_site_transient( $this->transient_key() );
172		- }
173		- return get_transient( $this->transient_key() );
174		- }
175		-
176		- /**
177		- * @since 6.8.3
178		- *
179		- * @return void
180		- */
181		- protected function set_running() {
182		- $expires = 2 * MINUTE_IN_SECONDS;
183		-
184		- if ( $this->run_as_multisite() ) {
185		- set_site_transient( $this->transient_key(), true, $expires );
186		- return;
187		- }
188		-
189		- set_transient( $this->transient_key(), true, $expires );
190		- }
191		-
192		- /**
193		- * @since 6.8.3
194		- *
195		- * @return void
196		- */
197		- protected function done_running() {
198		- if ( $this->run_as_multisite() ) {
199		- delete_site_transient( $this->transient_key() );
200		- }
201		- delete_transient( $this->transient_key() );
202		- }
203		-
204		- /**
205		- * Only allow one site in the network to make the api request at a time.
206		- * If there is a license for the request, run individually.
207		- *
208		- * @since 6.8.3
209		- *
210		- * @return bool
211		- */
212		- protected function run_as_multisite() {
213		- return is_multisite() && empty( $this->license );
214		- }
215		-
216		- /**
217		- * @since 6.8.3
218		- *
219		- * @return string
220		- */
221		- protected function transient_key() {
222		- return strtolower( self::class ) . '_request_lock';
223		- }
224		-
225		- /**
226	111	* @since 3.06
227		- *
228		- * @return string
229	112	*/
230	113	protected function api_url() {
231		- if ( empty( $this->license ) ) {
232		- // Direct traffic to Cloudflare worker when there is no license.
233		- return 'https://plapi.formidableforms.com/list/';
234		- }
235	114	return 'https://formidableforms.com/wp-json/s11edd/v1/updates/';
236	115	}
237	116
238	117	/**
239	118	* @since 3.06
240		- *
241		- * @return string[]
242	119	*/
243	120	protected function skip_categories() {
244	121	return array( 'WordPress Form Templates', 'WordPress Form Style Templates' );
245	122	}
		@@ -246,24 +123,21 @@
246	123
247	124	/**
248	125	* @since 3.06
249	126	*
250		- * @param object $license_plugin The FrmAddon object.
251		- * @param array $addons
	127	+ * @param object $license_plugin The FrmAddon object
252	128	*
253	129	* @return array
254	130	*/
255	131	public function get_addon_for_license( $license_plugin, $addons = array() ) {
256		- if ( ! $addons ) {
	132	+ if ( empty( $addons ) ) {
257	133	$addons = $this->get_api_info();
258	134	}
259		-
260	135	$download_id = $license_plugin->download_id;
261	136	$plugin = array();
262		-
263		- if ( ! $download_id && ! empty( $addons ) ) {
	137	+ if ( empty( $download_id ) && ! empty( $addons ) ) {
264	138	foreach ( $addons as $addon ) {
265		- if ( is_array( $addon ) && ! empty( $addon['title'] ) && strtolower( $license_plugin->plugin_name ) === strtolower( $addon['title'] ) ) {
	139	+ if ( strtolower( $license_plugin->plugin_name ) == strtolower( $addon['title'] ) ) {
266	140	return $addon;
267	141	}
268	142	}
269	143	} elseif ( isset( $addons[ $download_id ] ) ) {
		@@ -274,10 +148,8 @@
274	148	}
275	149
276	150	/**
277	151	* @since 3.06
278		- *
279		- * @return false|object
280	152	*/
281	153	public function get_pro_updater() {
282	154	if ( FrmAppHelper::pro_is_installed() && is_callable( 'FrmProAppHelper::get_updater' ) ) {
283	155	$updater = FrmProAppHelper::get_updater();
		@@ -290,28 +162,21 @@
290	162	}
291	163
292	164	/**
293	165	* @since 3.06
294		- *
295		- * @return array|bool
	166	+ * @return array
296	167	*/
297	168	protected function get_cached() {
298		- $cache = $this->get_cached_option();
	169	+ $cache = get_option( $this->cache_key );
299	170
300		- if ( ! $cache ) {
301		- return false;
	171	+ if ( empty( $cache ) || empty( $cache['timeout'] ) || current_time( 'timestamp' ) > $cache['timeout'] ) {
	172	+ return false; // Cache is expired
302	173	}
303	174
304		- $is_expired = empty( $cache['timeout'] ) || time() > $cache['timeout'];
305		-
306		- if ( ! $is_expired && isset( $cache['version'] ) && $cache['version'] !== FrmAppHelper::plugin_version() ) {
307		- $is_expired = true;
308		- }
309		-
310		- // Avoid old cached data, unless we're currently trying to query for new data.
311		- // The call to $this->is_running likely triggers a database query, so only call if if we're expired.
312		- // (Rather than the other way around, which is less efficient).
313		- if ( $is_expired && ! $this->is_running() ) {
	175	+ $version = FrmAppHelper::plugin_version();
	176	+ $for_current = isset( $cache['version'] ) && $cache['version'] == $version;
	177	+ if ( ! $for_current ) {
	178	+ // Force a new check.
314	179	return false;
315	180	}
316	181
317	182	return json_decode( $cache['value'], true );
		@@ -317,127 +182,53 @@
317	182	return json_decode( $cache['value'], true );
318	183	}
319	184
320	185	/**
321		- * Get the cache for the network if multisite.
322		- *
323		- * @since 6.8.3
324		- *
325		- * @return mixed
326		- */
327		- protected function get_cached_option() {
328		- if ( is_multisite() ) {
329		- $cached = get_site_option( $this->cache_key );
330		-
331		- if ( $cached ) {
332		- return $cached;
333		- }
334		- }
335		-
336		- return get_option( $this->cache_key );
337		- }
338		-
339		- /**
340	186	* @since 3.06
341		- *
342		- * @param array $addons
343		- *
344		- * @return void
345	187	*/
346	188	protected function set_cached( $addons ) {
347	189	$data = array(
348		- 'timeout' => strtotime( $this->get_cache_timeout( $addons ), time() ),
349		- 'value' => wp_json_encode( $addons ),
	190	+ 'timeout' => strtotime( $this->cache_timeout, current_time( 'timestamp' ) ),
	191	+ 'value' => json_encode( $addons ),
350	192	'version' => FrmAppHelper::plugin_version(),
351	193	);
352	194
353		- if ( is_multisite() ) {
354		- update_site_option( $this->cache_key, $data );
355		- } else {
356		- // Autoload the license cache because it gets called everywhere.
357		- $autoload = str_starts_with( $this->cache_key, 'frm_addons_l' );
358		- update_option( $this->cache_key, $data, $autoload );
359		- }
	195	+ update_option( $this->cache_key, $data, 'no' );
360	196	}
361	197
362	198	/**
363		- * If the last check was a a rate limit, we'll need to check again sooner.
364		- *
365		- * @since 6.8.3
366		- *
367		- * @param array $addons
368		- *
369		- * @return string
370		- */
371		- protected function get_cache_timeout( $addons ) {
372		- if ( isset( $addons['response_code'] ) && 429 === $addons['response_code'] ) {
373		- return '+5 minutes';
374		- }
375		- return $this->cache_timeout;
376		- }
377		-
378		- /**
379	199	* @since 3.06
380		- *
381		- * @return void
382	200	*/
383	201	public function reset_cached() {
384		- if ( is_multisite() ) {
385		- delete_site_option( $this->cache_key );
386		- } else {
387		- delete_option( $this->cache_key );
388		- }
389		- $this->done_running();
	202	+ delete_option( $this->cache_key );
390	203	}
391	204
392	205	/**
393	206	* @since 3.06
394		- *
395	207	* @return array
396	208	*/
397	209	public function error_for_license() {
	210	+ $errors = array();
398	211	if ( ! empty( $this->license ) ) {
399		- return $this->get_error_from_response();
	212	+ $errors = $this->get_error_from_response();
400	213	}
401		- return array();
	214	+
	215	+ return $errors;
402	216	}
403	217
404	218	/**
405	219	* @since 3.06
406		- *
407		- * @param array $addons
408		- *
409	220	* @return array
410	221	*/
411	222	public function get_error_from_response( $addons = array() ) {
412		- if ( ! $addons ) {
	223	+ if ( empty( $addons ) ) {
413	224	$addons = $this->get_api_info();
414	225	}
415		-
416	226	$errors = array();
417		-
418	227	if ( isset( $addons['error'] ) ) {
419		- if ( is_string( $addons['error'] ) ) {
420		- $errors[] = $addons['error'];
421		- } elseif ( ! empty( $addons['error']['message'] ) ) {
422		- $errors[] = $addons['error']['message'];
423		- }
424		-
	228	+ $errors[] = $addons['error']['message'];
425	229	do_action( 'frm_license_error', $addons['error'] );
426	230	}
427	231
428	232	return $errors;
429		- }
430		-
431		- /**
432		- * Check if a template is new.
433		- *
434		- * @since 6.0
435		- *
436		- * @param array $addon
437		- *
438		- * @return bool
439		- */
440		- protected function is_new( $addon ) {
441		- return strtotime( $addon['released'] ) > strtotime( '-' . $this->new_days . ' days' );
442	233	}
443	234	}