| 1 |
<?php |
| 2 |
|
| 3 |
if (!defined('ABSPATH')) die('No direct access allowed'); |
| 4 |
|
| 5 |
/** |
| 6 |
* If we ever change the API of the Updraft_Notices class, then the version neeeds to be bumped, because otherwise a plugin may find that it's loaded an older instance than it wanted from another plugin. |
| 7 |
*/ |
| 8 |
abstract class Updraft_Notices_1_1 { |
| 9 |
|
| 10 |
protected $notices_content; |
| 11 |
|
| 12 |
/** |
| 13 |
* These variables are just short-hands to be used in advert content. |
| 14 |
* |
| 15 |
* @var array |
| 16 |
*/ |
| 17 |
protected $dashboard_top = array('top'); |
| 18 |
|
| 19 |
protected $dashboard_top_or_report = array('top', 'report', 'report-plain'); |
| 20 |
|
| 21 |
protected $dashboard_bottom_or_report = array('bottom', 'report', 'report-plain'); |
| 22 |
|
| 23 |
protected $anywhere = array('top', 'bottom', 'report', 'report-plain'); |
| 24 |
|
| 25 |
protected $autobackup = array('autobackup'); |
| 26 |
|
| 27 |
protected $autobackup_bottom_or_report = array('autobackup', 'bottom', 'report', 'report-plain'); |
| 28 |
|
| 29 |
protected function populate_notices_content() { |
| 30 |
// Global adverts that appear in all products will be returned to the child to display. |
| 31 |
return array(); |
| 32 |
} |
| 33 |
|
| 34 |
/** |
| 35 |
* Call this method to setup the notices. |
| 36 |
*/ |
| 37 |
abstract protected function notices_init(); |
| 38 |
|
| 39 |
public function is_plugin_installed($product = null, $also_require_active = false) { |
| 40 |
if ($also_require_active) return class_exists($product); |
| 41 |
if (!function_exists('get_plugins')) include_once(ABSPATH.'wp-admin/includes/plugin.php'); |
| 42 |
$plugins = get_plugins(); |
| 43 |
foreach ($plugins as $value) { |
| 44 |
if ($value['TextDomain'] == $product) { |
| 45 |
// We have found the plugin so return false so that we do not display this advert. |
| 46 |
return false; |
| 47 |
} |
| 48 |
} |
| 49 |
return true; |
| 50 |
} |
| 51 |
|
| 52 |
protected function translation_needed($plugin_base_dir, $product_name) { |
| 53 |
$wplang = get_locale(); |
| 54 |
if (strlen($wplang) < 1 || 'en_US' == $wplang || 'en_GB' == $wplang) return false; |
| 55 |
if (defined('WP_LANG_DIR') && is_file(WP_LANG_DIR.'/plugins/'.$product_name.'-'.$wplang.'.mo')) return false; |
| 56 |
if (is_file($plugin_base_dir.'/languages/'.$product_name.'-'.$wplang.'.mo')) return false; |
| 57 |
return true; |
| 58 |
} |
| 59 |
|
| 60 |
protected function url_start($html_allowed, $url, $https = false, $website_home = null) { |
| 61 |
$proto = ($https) ? 'https' : 'http'; |
| 62 |
if (strpos($url, $website_home) !== false) { |
| 63 |
return $html_allowed ? "<a href=".apply_filters(str_replace('.', '_', $website_home).'_link', $proto.'://'.$url).'>' : ''; |
| 64 |
} else { |
| 65 |
return $html_allowed ? '<a href="'.$proto.'://'.$url.'">' : ''; |
| 66 |
} |
| 67 |
} |
| 68 |
|
| 69 |
protected function url_end($html_allowed, $url, $https = false) { |
| 70 |
$proto = $https ? 'https' : 'http'; |
| 71 |
return $html_allowed ? '</a>' : ' ('.$proto.'://'.$url.')'; |
| 72 |
} |
| 73 |
|
| 74 |
public function do_notice($notice = false, $position = 'top', $return_instead_of_echo = false) { |
| 75 |
|
| 76 |
$this->notices_init(); |
| 77 |
|
| 78 |
if (false === $notice) $notice = apply_filters('updraft_notices_force_id', false, $this); |
| 79 |
|
| 80 |
$notice_content = $this->get_notice_data($notice, $position); |
| 81 |
|
| 82 |
if (false != $notice_content) { |
| 83 |
return $this->render_specified_notice($notice_content, $return_instead_of_echo, $position); |
| 84 |
} |
| 85 |
} |
| 86 |
|
| 87 |
/** |
| 88 |
* This method will return a notice ready for display. |
| 89 |
* |
| 90 |
* @param boolean $notice Sends True or False if there are notices to show. |
| 91 |
* @param string $position Which screen position the notice is. |
| 92 |
* @return array Returns Notice data. |
| 93 |
*/ |
| 94 |
protected function get_notice_data($notice = false, $position = 'top') { |
| 95 |
|
| 96 |
// If a specific notice has been passed to this method then return that notice. |
| 97 |
if ($notice) { |
| 98 |
if (!isset($this->notices_content[$notice])) return false; |
| 99 |
|
| 100 |
// Does the notice support the position specified? |
| 101 |
if (isset($this->notices_content[$notice]['supported_positions']) && !in_array($position, $this->notices_content[$notice]['supported_positions'])) return false; |
| 102 |
|
| 103 |
// First check if the advert passed can be displayed and hasn't been dismissed, we do this by checking what dismissed value we should be checking. |
| 104 |
$dismiss_time = $this->notices_content[$notice]['dismiss_time']; |
| 105 |
|
| 106 |
$dismiss = $this->check_notice_dismissed($dismiss_time); |
| 107 |
|
| 108 |
if ($dismiss) return false; |
| 109 |
|
| 110 |
return $this->notices_content[$notice]; |
| 111 |
} |
| 112 |
|
| 113 |
// Create an array to add non-seasonal adverts to so that if a seasonal advert can't be returned we can choose a random advert from this array. |
| 114 |
$available_notices = array(); |
| 115 |
|
| 116 |
// If Advert wasn't passed then next we should check to see if a seasonal advert can be returned. |
| 117 |
foreach ($this->notices_content as $notice_id => $notice_data) { |
| 118 |
// Does the notice support the position specified? |
| 119 |
if (isset($this->notices_content[$notice_id]['supported_positions']) && !in_array($position, $this->notices_content[$notice_id]['supported_positions'])) continue; |
| 120 |
|
| 121 |
// If the advert has a validity function, then require the advert to be valid. |
| 122 |
if (!empty($notice_data['validity_function']) && !call_user_func(array($this, $notice_data['validity_function']))) continue; |
| 123 |
|
| 124 |
|
| 125 |
if (isset($notice_data['valid_from']) && isset($notice_data['valid_to'])) { |
| 126 |
if ($this->skip_seasonal_notices($notice_data)) return $notice_data; |
| 127 |
} else { |
| 128 |
$dismiss_time = $this->notices_content[$notice_id]['dismiss_time']; |
| 129 |
$dismiss = $this->check_notice_dismissed($dismiss_time); |
| 130 |
|
| 131 |
if (!$dismiss) $available_notices[$notice_id] = $notice_data; |
| 132 |
} |
| 133 |
} |
| 134 |
|
| 135 |
if (empty($available_notices)) return false; |
| 136 |
|
| 137 |
// If a seasonal advert can't be returned then we will return a random advert. |
| 138 |
// Using shuffle here as something like rand which produces a random number and uses that as the array index fails, this is because in future an advert may not be numbered and could have a string as its key which will then cause errors. |
| 139 |
shuffle($available_notices); |
| 140 |
return $available_notices[0]; |
| 141 |
} |
| 142 |
|
| 143 |
protected function skip_seasonal_notices($notice_data) {// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable |
| 144 |
return false; |
| 145 |
} |
| 146 |
|
| 147 |
public function get_affiliate_id() { |
| 148 |
return $this->self_affiliate_id; |
| 149 |
} |
| 150 |
|
| 151 |
abstract protected function check_notice_dismissed($dismiss_time); |
| 152 |
} |
| 153 |
|
