wp-optimize / includes / class-wp-optimize-notices.php

class-wp-optimize-notices.php in WP-Optimize – Cache, Compress images, Minify & Clean database to boost page speed & performance 3.2.9, at includes/class-wp-optimize-notices.php

393 lines 17.1 KB

Raw Download Zip

1	<?php
2
3	if (!defined('WPO_PLUGIN_MAIN_PATH')) die('No direct access allowed');
4
5	if (!class_exists('Updraft_Notices_1_2')) require_once(WPO_PLUGIN_MAIN_PATH.'/vendor/team-updraft/common-libs/src/updraft-notices/updraft-notices.php');
6
7	class WP_Optimize_Notices extends Updraft_Notices_1_2 {
8
9	private $initialized = false;
10
11	protected $self_affiliate_id = 216;
12
13	protected $notices_content = array();
14
15	/**
16	* Returns singleton instance object
17	*
18	* @return WP_Optimize_Notices Returns `WP_Optimize_Notices` object
19	*/
20	public static function instance() {
21	static $_instance = null;
22	if (null === $_instance) {
23	$_instance = new self();
24	}
25	return $_instance;
26	}
27
28	/**
29	* This method gets any parent notices and adds its own notices to the notice array
30	*
31	* @return Array returns an array of notices
32	*/
33	protected function populate_notices_content() {
34
35	$parent_notice_content = parent::populate_notices_content();
36
37	$child_notice_content = array(
38	'updraftplus' => array(
39	'prefix' => '',
40	'title' => __('Make sure you backup before you optimize your database', 'wp-optimize'),
41	'text' => __("UpdraftPlus is the world's most trusted backup plugin from the owners of WP-Optimize", 'wp-optimize'),
42	'image' => 'notices/updraft_logo.png',
43	'button_link' => 'https://wordpress.org/plugins/updraftplus/',
44	'button_meta' => 'updraftplus',
45	'dismiss_time' => 'dismiss_page_notice_until',
46	'supported_positions' => $this->dashboard_top_or_report,
47	'validity_function' => 'is_updraftplus_installed',
48	),
49	'updraftcentral' => array(
50	'prefix' => '',
51	'title' => __('Save Time and Money. Manage multiple WordPress sites from one location.', 'wp-optimize'),
52	'text' => __('UpdraftCentral is a highly efficient way to take backup, update and manage multiple WP sites from one location.', 'wp-optimize'),
53	'image' => 'notices/updraft_logo.png',
54	'button_link' => 'https://updraftcentral.com',
55	'button_meta' => 'updraftcentral',
56	'dismiss_time' => 'dismiss_page_notice_until',
57	'supported_positions' => $this->dashboard_top_or_report,
58	'validity_function' => 'is_updraftcentral_installed',
59	),
60	'rate_plugin' => array(
61	'text' => __("Hey - We noticed WP-Optimize has kept your site running fast for a while. If you like us, please consider leaving a positive review to spread the word. Or if you have any issues or questions please leave us a support message", 'wp-optimize') . ' <a href="https://wordpress.org/support/plugin/wp-optimize/" target="_blank">' . __('here', 'wp-optimize') . '.</a><br>' . __('Thank you so much!', 'wp-optimize') . ' - <b>WP-Optimize</b><br>',
62	'image' => 'notices/ud_smile.png',
63	'button_link' => 'https://wordpress.org/support/plugin/wp-optimize/reviews/?rate=5#new-post',
64	'button_meta' => 'review',
65	'dismiss_time' => 'dismiss_review_notice',
66	'supported_positions' => $this->dashboard_top,
67	'validity_function' => 'show_rate_notice'
68	),
69	'translation_needed' => array(
70	'prefix' => '',
71	'title' => 'Can you translate? Want to improve WP-Optimize for speakers of your language?',
72	'text' => $this->url_start(true, 'translate.wordpress.org/projects/wp-plugins/wp-optimize')."Please go here for instructions - it is easy.".$this->url_end(true, 'translate.wordpress.org/projects/wp-plugins/wp-optimize'),
73	'text_plain' => $this->url_start(false, 'translate.wordpress.org/projects/wp-plugins/wp-optimize')."Please go here for instructions - it is easy.".$this->url_end(false, 'translate.wordpress.org/projects/wp-plugins/wp-optimize'),
74	'image' => 'notices/wp_optimize_logo.png',
75	'button_link' => false,
76	'dismiss_time' => false,
77	'supported_positions' => $this->anywhere,
78	'validity_function' => 'translation_needed',
79	),
80	'wpo-premium' => array(
81	'prefix' => '',
82	'title' => __("Perform optimizations while your visitors sleep", "wp-optimize"),
83	'text' => __("WP-Optimize Premium features an advanced scheduling system that allows you to run optimizations at the quietest time of day (or night).", "wp-optimize"),
84	'image' => 'notices/wp_optimize_logo.png',
85	'button_link' => 'https://getwpo.com',
86	'button_meta' => 'wpo-premium',
87	'dismiss_time' => 'dismiss_notice',
88	'supported_positions' => $this->anywhere,
89	'validity_function' => 'is_wpo_premium_installed',
90	),
91	'wpo-premium-multisite' => array(
92	'prefix' => '',
93	'title' => __("Manage a multisite installation? Need extra control?", "wp-optimize"),
94	'text' => __("WP-Optimize Premium's multisite feature includes a locking system that restricts optimization commands to users with the right permissions.", "wp-optimize"),
95	'image' => 'notices/wp_optimize_logo.png',
96	'button_link' => 'https://getwpo.com',
97	'button_meta' => 'wpo-premium',
98	'dismiss_time' => 'dismiss_notice',
99	'supported_positions' => $this->anywhere,
100	'validity_function' => 'is_wpo_premium_installed',
101	),
102	'wpo-premium2' => array(
103	'prefix' => '',
104	'title' => __("WP-Optimize Premium offers unparalleled choice and flexibility", "wp-optimize"),
105	'text' => __("Upgrade today to combine over a dozen optimization options.", "wp-optimize"),
106	'image' => 'notices/wp_optimize_logo.png',
107	'button_link' => 'https://getwpo.com',
108	'button_meta' => 'wpo-premium',
109	'dismiss_time' => 'dismiss_notice',
110	'supported_positions' => $this->anywhere,
111	'validity_function' => 'is_wpo_premium_installed',
112	),
113	'wpo-premium3' => array(
114	'prefix' => '',
115	'title' => __("Remove unwanted images for better site performance.", "wp-optimize"),
116	'text' => __("WP-Optimize Premium comes with a feature to easily remove orphaned images, or images that exceed a certain size from your website.", "wp-optimize"),
117	'image' => 'notices/wp_optimize_logo.png',
118	'button_link' => 'https://getwpo.com',
119	'button_meta' => 'wpo-premium',
120	'dismiss_time' => 'dismiss_notice',
121	'supported_positions' => $this->anywhere,
122	'validity_function' => 'is_wpo_premium_installed',
123	),
124	'wpo-power-tweaks' => array(
125	'prefix' => '',
126	'title' => __("Power tweaks for advanced users and better site performance.", "wp-optimize"),
127	'text' => __("WP-Optimize Premium comes with the power tweaks that will enable you to improve performance by targeting specific weak points, either in WordPress Core, or in popular plugins.", "wp-optimize"),
128	'image' => 'notices/wp_optimize_logo.png',
129	'button_link' => 'https://getwpo.com/faqs/#Power-tweaks-2-',
130	'button_meta' => 'wpo-premium',
131	'dismiss_time' => 'dismiss_notice',
132	'supported_positions' => $this->anywhere,
133	'validity_function' => 'is_wpo_premium_installed',
134	),
135	'subscriben' => array(
136	'prefix' => '',
137	'title' => 'Subscriben ' .__('by', 'wp-optimize'). ' UpdraftPlus',
138	'text' => __("The WordPress subscription extension for WooCommerce store owners.", "wp-optimize"),
139	'image' => 'notices/subscriben.png',
140	'button_link' => 'https://subscribenplugin.com',
141	'button_meta' => 'read_more',
142	'dismiss_time' => 'dismiss_notice',
143	'supported_positions' => $this->anywhere,
144	),
145
146	// The sale adverts content starts here
147	'blackfriday' => array(
148	'prefix' => '',
149	'title' => __('Black Friday - 20% off WP-Optimize Premium until November 30th', 'wp-optimize'),
150	'text' => __('To benefit, use this discount code:', 'wp-optimize').' ',
151	'image' => 'notices/black_friday.png',
152	'button_link' => 'https://getwpo.com',
153	'button_meta' => 'wp-optimize',
154	'dismiss_time' => 'dismiss_season',
155	'discount_code' => 'blackfridaysale2022',
156	'valid_from' => '2022-11-20 00:00:00',
157	'valid_to' => '2022-11-30 23:59:59',
158	'supported_positions' => $this->dashboard_top_or_report,
159	'validity_function' => 'is_wpo_premium_installed',
160	),
161	'newyear' => array(
162	'prefix' => '',
163	'title' => __('Happy New Year - 20% off WP-Optimize Premium until January 14th', 'wp-optimize'),
164	'text' => __('To benefit, use this discount code:', 'wp-optimize').' ',
165	'image' => 'notices/new_year.png',
166	'button_link' => 'https://getwpo.com',
167	'button_meta' => 'wp-optimize',
168	'dismiss_time' => 'dismiss_season',
169	'discount_code' => 'newyearsale2023',
170	'valid_from' => '2022-12-26 00:00:00',
171	'valid_to' => '2023-01-14 23:59:59',
172	'supported_positions' => $this->dashboard_top_or_report,
173	'validity_function' => 'is_wpo_premium_installed',
174	),
175	'spring' => array(
176	'prefix' => '',
177	'title' => __('Spring sale - 20% off WP-Optimize Premium until May 31st', 'wp-optimize'),
178	'text' => __('To benefit, use this discount code:', 'wp-optimize').' ',
179	'image' => 'notices/spring.png',
180	'button_link' => 'https://getwpo.com',
181	'button_meta' => 'wp-optimize',
182	'dismiss_time' => 'dismiss_season',
183	'discount_code' => 'springsale2022',
184	'valid_from' => '2022-05-01 00:00:00',
185	'valid_to' => '2022-05-31 23:59:59',
186	'supported_positions' => $this->dashboard_top_or_report,
187	'validity_function' => 'is_wpo_premium_installed',
188	),
189	'summer' => array(
190	'prefix' => '',
191	'title' => __('Summer sale - 20% off WP-Optimize Premium until July 31st', 'wp-optimize'),
192	'text' => __('To benefit, use this discount code:', 'wp-optimize').' ',
193	'image' => 'notices/summer.png',
194	'button_link' => 'https://getwpo.com',
195	'button_meta' => 'wp-optimize',
196	'dismiss_time' => 'dismiss_season',
197	'discount_code' => 'summersale2022',
198	'valid_from' => '2022-07-01 00:00:00',
199	'valid_to' => '2022-07-31 23:59:59',
200	'supported_positions' => $this->dashboard_top_or_report,
201	'validity_function' => 'is_wpo_premium_installed',
202	),
203	'collection' => array(
204	'prefix' => '',
205	'title' => __('The Updraft Plugin Collection Sale', 'wp-optimize'),
206	'text' => __('Get 20% off any of our plugins. But hurry - offer ends 30th September, use this discount code:', 'wp-optimize').' ',
207	'image' => 'notices/wp_optimize_logo.png',
208	'button_link' => 'https://teamupdraft.com',
209	'campaign' => 'collection',
210	'button_meta' => 'collection',
211	'dismiss_time' => 'dismiss_season',
212	'discount_code' => 'WPO2022',
213	'valid_from' => '2022-09-01 00:00:00',
214	'valid_to' => '2022-09-30 23:59:59',
215	'supported_positions' => $this->dashboard_top_or_report,
216	)
217	);
218
219	return array_merge($parent_notice_content, $child_notice_content);
220	}
221
222	/**
223	* Call this method to setup the notices
224	*/
225	public function notices_init() {
226	if ($this->initialized) return;
227	$this->initialized = true;
228	$this->notices_content = (defined('WP_OPTIMIZE_NOADS_B') && WP_OPTIMIZE_NOADS_B) ? array() : $this->populate_notices_content();
229	}
230
231	/**
232	* This method will call the parent is_plugin_installed and pass in the product updraftplus to check if that plugin is installed if it is then we shouldn't display the notice
233	*
234	* @param string $product the plugin slug
235	* @param boolean $also_require_active a bool to indicate if the plugin should also be active
236	* @return boolean a bool to indicate if the notice should be displayed or not
237	*/
238	protected function is_updraftplus_installed($product = 'updraftplus', $also_require_active = false) {
239	return parent::is_plugin_installed($product, $also_require_active);
240	}
241
242	/**
243	* This method will call the parent is_plugin_installed and pass in the product updraftcentral to check if that plugin is installed if it is then we shouldn't display the notice
244	*
245	* @param string $product the plugin slug
246	* @param boolean $also_require_active a bool to indicate if the plugin should also be active
247	* @return boolean a bool to indicate if the notice should be displayed or not
248	*/
249	protected function is_updraftcentral_installed($product = 'updraftcentral', $also_require_active = false) {
250	return parent::is_plugin_installed($product, $also_require_active);
251	}
252
253	/**
254	* This method will call the is premium function in the WPO object to check if this install is premium and if it is we won't display the notice
255	*
256	* @return boolean a bool to indicate if we should display the notice or not
257	*/
258	protected function is_wpo_premium_installed() {
259	if (WP_Optimize::is_premium()) {
260	return false;
261	}
262
263	return true;
264	}
265
266	/**
267	* This method will check to see if a number of different backup plugins are installed and if they are we won't display the notice
268	*
269	* @param String $product the plugin slug
270	* @param boolean $also_require_active a bool to indicate if the plugin should be active or not
271	* @return boolean a bool to indicate if the notice should be displayed or not
272	*/
273	public function is_backup_plugin_installed($product = null, $also_require_active = false) {
274	$backup_plugins = array('updraftplus' => 'UpdraftPlus', 'backwpup' => 'BackWPup', 'backupwordpress' => 'BackupWordPress', 'vaultpress' => 'VaultPress', 'wp-db-backup' => 'WP-DB-Backup', 'backupbuddy' => 'BackupBuddy');
275
276	foreach ($backup_plugins as $slug => $title) {
277	if (!parent::is_plugin_installed($slug, $also_require_active)) {
278	return $title;
279	}
280	}
281
282	return apply_filters('wp_optimize_is_backup_plugin_installed', false);
283	}
284
285	/**
286	* This function will check if we should display the rate notice or not
287	*
288	* @return boolean - to indicate if we should show the notice or not
289	*/
290	protected function show_rate_notice() {
291
292	$options = WP_Optimize()->get_options();
293	$installed = $options->get_option('installed-for', 0);
294	$installed_for = time() - $installed;
295
296	if ($installed && $installed_for > 28*86400) {
297	return true;
298	}
299
300	return false;
301	}
302
303	/**
304	* This method calls the parent verson and will work out if the user is using a non english language and if so returns true so that they can see the translation advert.
305	*
306	* @param String $plugin_base_dir the plugin base directory
307	* @param String $product_name the name of the plugin
308	* @return Boolean returns true if the user is using a non english language and could translate otherwise false
309	*/
310	protected function translation_needed($plugin_base_dir = null, $product_name = null) {// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
311	return parent::translation_needed(WPO_PLUGIN_MAIN_PATH, 'wp-optimize');
312	}
313
314	/**
315	* This method is used to generate the correct URL output for the start of the URL
316	*
317	* @param Boolean $html_allowed a boolean value to indicate if HTML can be used or not
318	* @param String $url the url to use
319	* @param Boolean $https a boolean value to indicate if https should be used or not
320	* @param String $website_home a string to be displayed
321	* @return String returns a string of the completed url
322	*/
323	protected function url_start($html_allowed, $url, $https = false, $website_home = 'getwpo.com') {
324	return parent::url_start($html_allowed, $url, $https, $website_home);
325	}
326
327	/**
328	* This method checks to see if the notices dismiss_time parameter has been dismissed
329	*
330	* @param String $dismiss_time a string containing the dimiss time ID
331	* @return Boolean returns true if the notice has been dismissed and shouldn't be shown otherwise display it
332	*/
333	protected function check_notice_dismissed($dismiss_time) {
334
335	$time_now = (defined('WP_OPTIMIZE_NOTICES_FORCE_TIME') ? WP_OPTIMIZE_NOTICES_FORCE_TIME : time());
336
337	$options = WP_Optimize()->get_options();
338
339	$notice_dismiss = ($time_now < $options->get_option($dismiss_time, 0));
340
341	return $notice_dismiss;
342	}
343
344	/**
345	* Check notice data for seasonal info and return true if we should display this notice.
346	*
347	* @param array $notice_data
348	* @return bool
349	*/
350	protected function skip_seasonal_notices($notice_data) {
351	$time_now = defined('WPO_NOTICES_FORCE_TIME') ? WPO_NOTICES_FORCE_TIME : time();
352	// Do not show seasonal notices in Premium version.
353	if (false === WP_Optimize::is_premium()) {
354	$valid_from = strtotime($notice_data['valid_from']);
355	$valid_to = strtotime($notice_data['valid_to']);
356	$dismiss = $this->check_notice_dismissed($notice_data['dismiss_time']);
357	if (($time_now >= $valid_from && $time_now <= $valid_to) && !$dismiss) {
358	// return true so that we return this notice to be displayed
359	return true;
360	}
361	}
362
363	return false;
364	}
365
366	/**
367	* This method will create the chosen notice and the template to use and depending on the parameters either echo it to the page or return it
368	*
369	* @param Array $advert_information an array with the notice information in
370	* @param Boolean $return_instead_of_echo a bool value to indicate if the notice should be printed to page or returned
371	* @param String $position a string to indicate what template should be used
372	* @return String a notice to display
373	*/
374	protected function render_specified_notice($advert_information, $return_instead_of_echo = false, $position = 'top') {
375
376	if ('bottom' == $position) {
377	$template_file = 'bottom-notice.php';
378	} elseif ('report' == $position) {
379	$template_file = 'report.php';
380	} elseif ('report-plain' == $position) {
381	$template_file = 'report-plain.php';
382	} else {
383	$template_file = 'horizontal-notice.php';
384	}
385
386	$extract_variables = array_merge($advert_information, array('wp_optimize_notices' => $this));
387
388	return WP_Optimize()->include_template('notices/'.$template_file, $return_instead_of_echo, $extract_variables);
389	}
390	}
391
392	$GLOBALS['wp_optimize_notices'] = WP_Optimize_Notices::instance();
393