';
+ }
+ /**
+ * Prints the notice.
+ */
+ public function the_notice()
+ {
+ // Early exit if we don't want to show this notice.
+ if (!$this->show()) {
+ return;
+ }
+ echo \wp_kses_post($this->get_notice());
+ }
+ /**
+ * Determine if the notice should be shown or not.
+ *
+ * @return bool
+ */
+ public function show()
+ {
+ // Don't show if the user doesn't have the required capability.
+ if (!\current_user_can($this->options['capability'])) {
+ return \false;
+ }
+ // Don't show if we're not on the right screen.
+ if (!$this->is_screen()) {
+ return \false;
+ }
+ // Don't show if notice has been dismissed.
+ if ($this->options['dismissible'] === \true && $this->is_dismissed()) {
+ return \false;
+ }
+ return \true;
+ }
+ /**
+ * Evaluate if we're on the right place depending on the "screens" argument.
+ *
+ * @return bool
+ */
+ private function is_screen()
+ {
+ // If screen is empty we want this shown on all screens.
+ if (!$this->options['screens'] || empty($this->options['screens'])) {
+ return \true;
+ }
+ // Make sure the get_current_screen function exists.
+ if (!\function_exists('get_current_screen')) {
+ require_once \ABSPATH . 'wp-admin/includes/screen.php';
+ }
+ /** @var \WP_Screen $current_screen */
+ $current_screen = \get_current_screen();
+ // Check if we're on one of the defined screens.
+ return \in_array($current_screen->id, $this->options['screens'], \true);
+ }
+ /**
+ * Run check to see if we need to dismiss the notice.
+ * If all tests are successful then call the dismiss_notice() method.
+ *
+ * @return void
+ */
+ public function ajax_maybe_dismiss_notice()
+ {
+ // If dissmiss_callback is set.
+ if (\is_callable($this->options['dissmiss_callback'])) {
+ \call_user_func($this->options['dissmiss_callback'], $this->id, $this->title, $this->message, $this->options, $this);
+ }
+ // Early exit if we're not on a barn2_dismiss_admin_notice action.
+ if (!isset($_POST['action']) || 'barn2_dismiss_admin_notice' !== $_POST['action']) {
+ return;
+ }
+ // Early exit if the ID of the notice is not the one from this object.
+ if (!isset($_POST['id']) || $this->id !== $_POST['id']) {
+ return;
+ }
+ // Make sure nonce is OK.
+ \check_ajax_referer('barn2_dismiss_admin_notice_' . $this->id, 'nonce', \true);
+ // Dismisses the notice.
+ $this->dismiss_notice();
+ }
+ /**
+ * Dismisses the notice.
+ *
+ * @return void
+ */
+ public function dismiss_notice()
+ {
+ if ($this->options['scope'] === 'user') {
+ \update_user_meta(\get_current_user_id(), $this->options['option_prefix'] . '_' . $this->id, \true);
+ return;
+ }
+ \update_option($this->options['option_prefix'] . '_' . $this->id, \true, \false);
+ }
+ /**
+ * Checks if the notice has been dismissed or not.
+ *
+ * @return bool
+ */
+ public function is_dismissed()
+ {
+ // Check if the notice has been dismissed when using user-meta.
+ if ($this->options['scope'] === 'user') {
+ return \get_user_meta(\get_current_user_id(), $this->options['option_prefix'] . '_' . $this->id, \true);
+ }
+ return \get_option($this->options['option_prefix'] . '_' . $this->id);
+ }
+}
diff --git a/dependencies/barn2/barn2-lib/src/Admin/Notices.php b/dependencies/barn2/barn2-lib/src/Admin/Notices.php
index 04bccc2..005a34d 100644
--- a/dependencies/barn2/barn2-lib/src/Admin/Notices.php
+++ b/dependencies/barn2/barn2-lib/src/Admin/Notices.php
@@ -2,34 +2,98 @@
namespace Barn2\Plugin\WC_Product_Tabs_Free\Dependencies\Lib\Admin;
-use Barn2\Plugin\WC_Product_Tabs_Free\Dependencies\WPTRT\AdminNotices\Notices as AdminNoticesNotices;
/**
- * Extends the WPTRT Notices class to allow additional HTML in the admin notice.
+ * Manages admin notices.
*
* @package Barn2\barn2-lib
* @author Barn2 Plugins
* @license GPL-3.0
* @copyright Barn2 Media Ltd
+ * @version 1.0
* @internal
*/
-class Notices extends AdminNoticesNotices
+class Notices
{
/**
- * Constructor.
+ * An array of notices.
+ *
+ * @var array
+ */
+ private $notices = [];
+ /**
+ * Boot all added admin notices.
+ */
+ public function boot()
+ {
+ \add_action('admin_notices', [$this, 'the_notices']);
+ }
+ /**
+ * Adds a notice.
+ *
+ * @param string $id A unique notice ID. Should contain lowercase characters and underscores.
+ * @param string $title The title of the notice.
+ * @param string $message The notice message.
+ * @param array $options {
+ * Optional. An array of additional options to change the defaults for this notice.
+ *
+ * @type string $type The type of admin notice. Default 'info'. Accepts 'info', 'success', 'warning', 'error'.
+ * @type bool $alt_style Whether we want to use alt styles or not. Default false.
+ * @type array $additional_classes A string array of class names.
+ * @type array $attributes Additional attributes for the notice div.
+ * @type bool $paragraph_wrap Whether to wrap the message in paragraph tags. Default true.
+ * @type array $buttons Associative array with buttons attributes and values. Default [].
+ * @type string $capability The user capability required to see the notice. Default 'edit_theme_options'.
+ * @type array $screens An array of screens where the notice will be displayed. Default is empty to always show.
+ * @type bool $dismissible Whether the admin notice is dismissible. Default true.
+ * @type string $scope Saves the dismissed status as an option or user-meta. Accepts 'global', 'user'. Default 'global'.
+ * @type string $option_prefix The prefix that will be used to build the option (or post-meta) name. Should contain lowercase characters and underscores.
+ * @type callable $dissmiss_callback Function called before dismissing a notice. The arguments are $id, $title, $message, $options, $notice_obj.
+ * }
+ */
+ public function add($id, $title, $message, $options = [])
+ {
+ $this->notices[$id] = new Notice($id, $title, $message, $options);
+ }
+ /**
+ * Removes a notice.
+ *
+ * @param string $id The unique ID of the notice we want to remove.
*/
- public function __construct()
+ public function remove($id)
{
- \add_filter('wptrt_admin_notices_allowed_html', [__CLASS__, 'filter_allowed_html']);
+ unset($this->notices[$id]);
}
/**
- * Filter allowed html in notices.
+ * Gets a single notice.
+ *
+ * @param string $id The unique ID of the notice we want to retrieve.
+ *
+ * @return Notice|null
+ */
+ public function get($id)
+ {
+ if (isset($this->notices[$id])) {
+ return $this->notices[$id];
+ }
+ return null;
+ }
+ /**
+ * Gets all notices.
*
- * @param array $allowed_html
* @return array
*/
- public static function filter_allowed_html($allowed_html)
+ public function get_all()
+ {
+ return $this->notices;
+ }
+ /**
+ * Prints all visible notices.
+ */
+ public function the_notices()
{
- $allowed_html['a']['target'] = [];
- return $allowed_html;
+ $notices = $this->get_all();
+ foreach ($notices as $notice) {
+ $notice->the_notice();
+ }
}
}
diff --git a/dependencies/barn2/barn2-lib/src/Admin/Settings_API_Helper.php b/dependencies/barn2/barn2-lib/src/Admin/Settings_API_Helper.php
index 63eb1c1..40b2fe8 100644
--- a/dependencies/barn2/barn2-lib/src/Admin/Settings_API_Helper.php
+++ b/dependencies/barn2/barn2-lib/src/Admin/Settings_API_Helper.php
@@ -221,6 +221,49 @@ class="
+
+
+ />
+
+
+
-
+
+
/>
diff --git a/dependencies/barn2/barn2-lib/src/Plugin/I18n.php b/dependencies/barn2/barn2-lib/src/Plugin/I18n.php
index bf78757..e721edd 100644
--- a/dependencies/barn2/barn2-lib/src/Plugin/I18n.php
+++ b/dependencies/barn2/barn2-lib/src/Plugin/I18n.php
@@ -37,7 +37,7 @@ public function __construct(Plugin $plugin)
*/
public function register()
{
- \add_action('after_setup_scheme', array($this, 'load_textdomain'));
+ \add_action('after_setup_theme', array($this, 'load_textdomain'));
}
/**
* Load the plugin's textdomain.
@@ -46,6 +46,6 @@ public function register()
*/
public function load_textdomain()
{
- \load_plugin_textdomain($this->plugin->plugin_data()->get_textdomain(), \false, $this->plugin->get_dir_path() . '/languages');
+ \load_plugin_textdomain($this->plugin->plugin_data()->get_textdomain(), \false, \dirname(\plugin_basename($this->plugin->get_file())) . '/languages');
}
}
diff --git a/dependencies/barn2/barn2-lib/src/Plugin/License/Admin/License_Notices.php b/dependencies/barn2/barn2-lib/src/Plugin/License/Admin/License_Notices.php
index d048dd9..9ec2a8c 100644
--- a/dependencies/barn2/barn2-lib/src/Plugin/License/Admin/License_Notices.php
+++ b/dependencies/barn2/barn2-lib/src/Plugin/License/Admin/License_Notices.php
@@ -33,6 +33,7 @@ public function __construct(Licensed_Plugin $plugin)
public function register()
{
\add_action('admin_init', [$this, 'add_notices'], 50);
+ \add_action('admin_enqueue_scripts', [$this, 'register_scripts']);
\add_action('barn2_license_activated_' . $this->plugin->get_id(), [$this, 'cleanup_transients']);
\add_action('wp_ajax_barn2_dismiss_notice', [$this, 'ajax_dismiss_notice']);
}
@@ -177,11 +178,14 @@ public function cleanup_transients()
\delete_transient($this->get_notice_dismissed_transient_name(self::DISABLED));
\delete_transient($this->get_notice_dismissed_transient_name(self::SITE_MOVED));
}
- public function load_scripts()
+ public function register_scripts()
{
if (!\wp_script_is('barn2-notices', 'registered')) {
\wp_register_script('barn2-notices', \plugins_url('dependencies/barn2/barn2-lib/build/js/admin/barn2-notices.js', $this->plugin->get_file()), ['jquery'], $this->plugin->get_version(), \true);
}
+ }
+ public function load_scripts()
+ {
\wp_enqueue_script('barn2-notices');
}
public function ajax_dismiss_notice()
diff --git a/dependencies/barn2/barn2-lib/src/Plugin/License/Plugin_License.php b/dependencies/barn2/barn2-lib/src/Plugin/License/Plugin_License.php
index 61c1397..5d8f972 100644
--- a/dependencies/barn2/barn2-lib/src/Plugin/License/Plugin_License.php
+++ b/dependencies/barn2/barn2-lib/src/Plugin/License/Plugin_License.php
@@ -144,7 +144,7 @@ public function activate($license_key)
if (isset($response->bonus_downloads)) {
$license_data['bonus_downloads'] = $response->bonus_downloads;
}
- \do_action('barn2_license_activated_' . $this->item_id, $license_key, $url_to_activate);
+ \do_action("barn2_license_activated_{$this->item_id}", $license_key, $url_to_activate);
} else {
// Invalid license.
$license_data['error_code'] = isset($response->error) ? $response->error : 'error';
@@ -159,6 +159,15 @@ public function activate($license_key)
$license_data['error_message'] = $api_result->response;
}
$this->set_license_data($license_data);
+ /**
+ * Fires after the activation process has completed.
+ *
+ * @param string $license_key The license key that was activated.
+ * @param string $url_to_activate The URL that was used to activate the license.
+ * @param array $license_data The license data after activation.
+ * @param boolean $result Whether the activation was successful.
+ */
+ \do_action("barn2_license_after_activate_{$this->item_id}", $license_key, $url_to_activate, $license_data, $result);
return $result;
}
/**
@@ -183,8 +192,9 @@ public function deactivate()
}
$result = \false;
$license_data = [];
+ $license_key = $this->get_license_key();
$url_to_deactivate = $this->get_active_url();
- $api_result = $this->license_api->deactivate_license($this->get_license_key(), $this->item_id, $url_to_deactivate);
+ $api_result = $this->license_api->deactivate_license($license_key, $this->item_id, $url_to_deactivate);
if ($api_result->success) {
// Successful response - now check whether license is valid.
$response = $api_result->response;
@@ -201,13 +211,22 @@ public function deactivate()
// In this case we refresh license data to ensure we have correct state stored in database.
$this->refresh();
}
- \do_action('barn2_license_deactivated_' . $this->item_id, $this->get_license_key(), $url_to_deactivate);
+ \do_action("barn2_license_deactivated_{$this->item_id}", $license_key, $url_to_deactivate);
} else {
// API error
$license_data['error_code'] = 'error';
$license_data['error_message'] = $api_result->response;
$this->update_license_data($license_data);
}
+ /**
+ * Fires after the deactivation process has completed.
+ *
+ * @param string $license_key The license key that was deactivated.
+ * @param string $url_to_deactivate The URL that was used to deactivate the license.
+ * @param array $license_data The license data after deactivation.
+ * @param boolean $result Whether the deactivation was successful.
+ */
+ \do_action("barn2_license_after_deactivate_{$this->item_id}", $license_key, $url_to_deactivate, $license_data, $result);
return $result;
}
/**
@@ -218,18 +237,22 @@ public function deactivate()
*/
public function refresh()
{
+ $license_key = $this->get_license_key();
// No point refreshing if license doesn't exist.
- if (!$this->get_license_key()) {
+ if (!$license_key) {
return;
}
// If license is overridden, we shouldn't refresh as it will lose override state.
if ($this->is_license_overridden()) {
return;
}
- $license_data = ['license' => $this->get_license_key()];
+ $result = \false;
+ $url_to_refresh = $this->get_home_url();
+ $license_data = ['license' => $license_key];
// We use the home url when checking the license, as the license result should reflect the current site, not any previous site.
- $api_result = $this->license_api->check_license($this->get_license_key(), $this->item_id, $this->get_home_url());
+ $api_result = $this->license_api->check_license($license_key, $this->item_id, $url_to_refresh);
if ($api_result->success) {
+ $result = \true;
// Successful response returned.
$response = $api_result->response;
if ('valid' === $response->license) {
@@ -245,21 +268,50 @@ public function refresh()
}
// Store returned license info.
$license_data['license_info'] = $this->format_license_info($response);
- \do_action('barn2_license_refreshed_' . $this->item_id, $this->get_license_key(), $this->get_home_url());
+ \do_action("barn2_license_refreshed_{$this->item_id}", $license_key, $url_to_refresh);
} else {
// API error - store the error but don't change license status (e.g. temporary communication error).
$license_data['error_code'] = 'error';
$license_data['error_message'] = $api_result->response;
}
$this->update_license_data($license_data);
+ /**
+ * Fires after the refresh process has completed.
+ *
+ * When refreshing a license, the result only indicates
+ * whether the refresh was successful, not whether the license is valid.
+ * Use the license status in the `$license_data` parameter to determine the license validity.
+ *
+ * @param string $license_key The license key that was refreshed.
+ * @param string $url_to_refresh The URL that was used to refresh the license.
+ * @param array $license_data The license data after refresh.
+ * @param boolean $result Whether the refresh was successful.
+ */
+ \do_action("barn2_license_after_refresh_{$this->item_id}", $license_key, $url_to_refresh, $license_data, $result);
}
public function override($license_key, $status)
{
if (!$license_key || !$this->is_valid_status($status)) {
return;
}
- $this->set_license_data(['license' => $license_key, 'url' => $this->get_home_url(), 'status' => $status, 'override' => \true]);
- \do_action('barn2_license_activated_' . $this->item_id, $license_key, $this->get_home_url());
+ $url_to_activate = $this->get_home_url();
+ $license_data = ['license' => $license_key, 'url' => $url_to_activate, 'status' => $status, 'override' => \true];
+ $this->set_license_data($license_data);
+ \do_action("barn2_license_activated_{$this->item_id}", $license_key, $url_to_activate);
+ /**
+ * Fires after the license has been overridden.
+ *
+ * The fourth parameter is always true as the override is always successful.
+ * It is provided here for consistency with the other license actions.
+ * Also, although override is effectively activating a license, we use the 'after_override' action
+ * right after the 'activated' action to differentiate between the two actions.
+ *
+ * @param string $license_key The license key that was overridden.
+ * @param string $url_to_activate The URL that was used to activate the license.
+ * @param array $license_data The license data after override.
+ * @param bool $result Whether the override was successful. Always true
+ */
+ \do_action("barn2_license_after_override_{$this->item_id}", $license_key, $url_to_activate, $license_data, \true);
}
public function get_setting_name()
{
diff --git a/dependencies/barn2/barn2-lib/src/Plugin/Plugin_Data.php b/dependencies/barn2/barn2-lib/src/Plugin/Plugin_Data.php
index 1918eb1..08b16a9 100644
--- a/dependencies/barn2/barn2-lib/src/Plugin/Plugin_Data.php
+++ b/dependencies/barn2/barn2-lib/src/Plugin/Plugin_Data.php
@@ -51,7 +51,7 @@ public function get_plugin_data(string $property = null)
if (!\function_exists('get_plugin_data')) {
require_once \ABSPATH . 'wp-admin/includes/plugin.php';
}
- $this->plugin_data = \get_plugin_data($this->plugin->get_file());
+ $this->plugin_data = \get_plugin_data($this->plugin->get_file(), \false, \false);
}
if (!\is_null($property)) {
return $this->plugin_data[$property] ?? '';
diff --git a/dependencies/barn2/barn2-lib/src/Plugin/Simple_Plugin.php b/dependencies/barn2/barn2-lib/src/Plugin/Simple_Plugin.php
index 154518b..ed9ad82 100644
--- a/dependencies/barn2/barn2-lib/src/Plugin/Simple_Plugin.php
+++ b/dependencies/barn2/barn2-lib/src/Plugin/Simple_Plugin.php
@@ -297,6 +297,15 @@ public function get_settings_page_url()
{
return !empty($this->data['settings_path']) ? \admin_url($this->data['settings_path']) : '';
}
+ /**
+ * Get the design page URL in the WordPress admin.
+ *
+ * @return string (URL)
+ */
+ public function get_design_page_url()
+ {
+ return !empty($this->data['design_path']) ? \admin_url($this->data['design_path']) : '';
+ }
/**
* Get the plugin data service.
*
diff --git a/dependencies/barn2/barn2-lib/src/Service/Updater.php b/dependencies/barn2/barn2-lib/src/Service/Updater.php
new file mode 100644
index 0000000..7d137bc
--- /dev/null
+++ b/dependencies/barn2/barn2-lib/src/Service/Updater.php
@@ -0,0 +1,323 @@
+
+ * @license GPL-3.0
+ * @copyright Barn2 Media Ltd
+ * @version 1.0
+ * @internal
+ */
+abstract class Updater implements Standard_Service, Conditional, Registerable
+{
+ /**
+ * Callbacks functions that are called on a plugin update.
+ *
+ * Please note that these functions are invoked when a plugin is updated from a previous version,
+ * but NOT when the plugin is newly installed.
+ *
+ * The array keys should contain the version number, and it MUST be sorted from low to high.
+ *
+ * Example:
+ *
+ * '1.11.0' => [
+ * 'update_1_11_0_do_something',
+ * 'update_1_11_0_do_something_else',
+ * ],
+ * '1.23.0' => [
+ * 'update_1_23_0_do_something',
+ * ],
+ *
+ * @var array
+ */
+ public static $updates = [];
+ /**
+ * Plugin instance.
+ *
+ * @var Plugin
+ */
+ protected $plugin;
+ /**
+ * The class options.
+ *
+ * See the get_default_options method to verify the array structure.
+ *
+ * @var string
+ */
+ public $options = [];
+ /**
+ * Constructor.
+ *
+ * @param Plugin $plugin
+ * @param array $options {
+ * Optional. An array of additional options to change the default values.
+ *
+ * @type string $version_option_name Option name to store the version value on the options DB table. Default '_version'.
+ * @type array $needs_update_db_notice Needs update database admin notice array options. Accepts 'title', 'message', 'buttons' array keys.
+ * @type array $updating_db_notice Updating database admin notice options. Accepts 'title', 'message', 'buttons' array keys.
+ * @type array $update_db_complete_notice Update database complete admin notice options. Accepts 'title', 'message', 'buttons' array keys.
+ * }
+ */
+ public function __construct(Plugin $plugin, $options = null)
+ {
+ $this->plugin = $plugin;
+ $this->set_options($options);
+ return $this;
+ }
+ /**
+ * {@inheritdoc}
+ */
+ public function is_required()
+ {
+ return \is_admin() && $this->needs_update();
+ }
+ /**
+ * {@inheritdoc}
+ */
+ public function register()
+ {
+ // Check the plugin's version and show the update admin notice message.
+ \add_action('admin_init', [$this, 'check_version']);
+ // Print the script after common.js.
+ \add_action('admin_enqueue_scripts', [$this, 'add_script']);
+ // Handle AJAX requests to dismiss the notice.
+ \add_action('wp_ajax_' . $this->plugin->get_slug() . '_update_db', [$this, 'ajax_start_update']);
+ \add_action('wp_ajax_' . $this->plugin->get_slug() . '_check_update_db', [$this, 'ajax_check_update_db']);
+ }
+ /**
+ * Gets the default options.
+ *
+ * @return array
+ */
+ public function get_default_options()
+ {
+ return ['version_option_name' => $this->plugin->get_slug() . '_version', 'needs_update_db_notice' => ['title' => \sprintf(__('%1$s database update required'), $this->plugin->get_name()), 'message' => \sprintf(__('
%1$s has been updated! To keep things running smoothly, we have to update your database to the newest version. The database update process runs in the background and may take a little while, so please be patient.