PUM_Extension_License
License handler for Popup Maker
Description Description
This class should simplify the process of adding license information to new Popup Maker extensions.
Note for wordpress.org admins. This is not called in the free hosted version and is simply used for hooking in addons to one update system rather than including it in each plugin.
Source Source
File: classes/Extension/License.php
class PUM_Extension_License {
private $file;
private $license;
private $item_name;
private $item_id;
private $item_shortname;
private $version;
private $author;
private $api_url = 'https://wppopupmaker.com/edd-sl-api/';
/**
* Class constructor
*
* @param string $_file
* @param string $_item_name
* @param string $_version
* @param string $_author
* @param string $_optname
* @param string $_api_url
* @param int $_item_id
*/
function __construct( $_file, $_item_name, $_version, $_author, $_optname = null, $_api_url = null, $_item_id = null ) {
$this->file = $_file;
$this->item_name = $_item_name;
if ( is_numeric( $_item_id ) ) {
$this->item_id = absint( $_item_id );
}
$this->item_shortname = 'popmake_' . preg_replace( '/[^a-zA-Z0-9_\s]/', '', str_replace( ' ', '_', strtolower( $this->item_name ) ) );
$this->version = $_version;
$this->license = trim( PUM_Utils_Options::get( $this->item_shortname . '_license_key', '' ) );
$this->author = $_author;
$this->api_url = is_null( $_api_url ) ? $this->api_url : $_api_url;
/**
* Allows for backwards compatibility with old license options,
* i.e. if the plugins had license key fields previously, the license
* handler will automatically pick these up and use those in lieu of the
* user having to reactive their license.
*/
if ( ! empty( $_optname ) ) {
$opt = PUM_Utils_Options::get( $_optname );
if ( isset( $opt ) && empty( $this->license ) ) {
$this->license = trim( $opt );
}
}
// Setup hooks
$this->includes();
$this->hooks();
}
/**
* Include the updater class
*
* @access private
* @return void
*/
private function includes() {
}
/**
* Setup hooks
*
* @access private
* @return void
*/
private function hooks() {
// Register settings
add_filter( 'pum_settings_fields', array( $this, 'settings' ), 1 );
// Activate license key on settings save
add_action( 'admin_init', array( $this, 'activate_license' ) );
// Deactivate license key
add_action( 'admin_init', array( $this, 'deactivate_license' ) );
// Check that license is valid once per week
add_action( 'popmake_weekly_scheduled_events', array( $this, 'weekly_license_check' ) );
// For testing license notices, uncomment this line to force checks on every page load
//add_action( 'admin_init', array( $this, 'weekly_license_check' ) );
// Updater
add_action( 'admin_init', array( $this, 'auto_updater' ), 0 );
// Display notices to admins
// add_action( 'admin_notices', array( $this, 'notices' ) );
// Display notices to admins
add_filter( 'pum_alert_list', array( $this, 'alerts' ) );
add_action( 'in_plugin_update_message-' . plugin_basename( $this->file ), array( $this, 'plugin_row_license_missing' ), 10, 2 );
// Register plugins for beta support
add_filter( 'pum_beta_enabled_extensions', array( $this, 'register_beta_support' ) );
}
/**
* Auto updater
*
* @access private
* @return void
*/
public function auto_updater() {
$args = array(
'version' => $this->version,
'license' => $this->license,
'author' => $this->author,
'beta' => PUM_Admin_Tools::extension_has_beta_support( $this->item_shortname ),
);
if ( ! empty( $this->item_id ) ) {
$args['item_id'] = $this->item_id;
} else {
$args['item_name'] = $this->item_name;
}
// Setup the updater
$popmake_updater = new PUM_Extension_Updater( $this->api_url, $this->file, $args );
}
/**
* Add license field to settings
*
* @access public
*
* @param array $tabs
*
* @return array
*/
public function settings( $tabs = array() ) {
static $license_help_text = false;
if ( ! $license_help_text && ! isset( $tabs['licenses']['main']['license_help_text'] ) ) {
$license_help_text = true;
$tabs['licenses']['main']['license_help_text'] = array(
'type' => 'html',
'content' => '<p><strong>' . sprintf( __( 'Enter your extension license keys here to receive updates for purchased extensions. If your license key has expired, please %srenew your license%s.', 'popup-maker' ), '<a href="https://docs.wppopupmaker.com/article/177-license-renewal?utm_medium=license-help-text&utm_campaign=Licensing&utm_source=plugin-settings-page-licenses-tab" target="_blank">', '</a>' ) . '</strong></p>',
'priority' => 0,
);
}
$tabs['licenses']['main'][ $this->item_shortname . '_license_key' ] = array(
'type' => 'license_key',
'label' => sprintf( __( '%1$s', 'popup-maker' ), $this->item_name ),
'options' => array(
'is_valid_license_option' => $this->item_shortname . '_license_active',
'activation_callback' => array( $this, 'activate_license' ),
),
);
return $tabs;
}
/**
* Activate the license key
*
* @access public
* @return void
*/
public function activate_license() {
if ( ! isset( $_POST['pum_settings'] ) ) {
return;
}
if ( ! isset( $_POST['pum_settings'][ $this->item_shortname . '_license_key' ] ) ) {
return;
}
// Don't activate a key when deactivating a different key
if ( ! empty( $_POST['pum_license_deactivate'] ) ) {
return;
}
if ( ! current_user_can( 'manage_options' ) ) {
return;
}
$details = get_option( $this->item_shortname . '_license_active' );
if ( is_object( $details ) && 'valid' === $details->license ) {
return;
}
$license = sanitize_text_field( $_POST['pum_settings'][ $this->item_shortname . '_license_key' ] );
if ( empty( $license ) && empty( $_POST['pum_license_activate'][ $this->item_shortname . '_license_key' ] ) ) {
return;
}
// Data to send to the API
$api_params = array(
'edd_action' => 'activate_license',
'license' => $license,
'item_name' => urlencode( $this->item_name ),
'item_id' => $this->item_id,
'url' => home_url(),
);
// Call the API
$response = wp_remote_post( $this->api_url, array(
'timeout' => 15,
'sslverify' => false,
'body' => $api_params,
) );
// Make sure there are no errors
if ( is_wp_error( $response ) ) {
return;
}
// Tell WordPress to look for updates
set_site_transient( 'update_plugins', null );
// Decode license data
$license_data = json_decode( wp_remote_retrieve_body( $response ) );
update_option( $this->item_shortname . '_license_active', $license_data );
}
/**
* Deactivate the license key
*
* @access public
* @return void
*/
public function deactivate_license() {
if ( ! isset( $_POST['pum_settings'] ) ) {
return;
}
if ( ! isset( $_POST['pum_settings'][ $this->item_shortname . '_license_key' ] ) ) {
return;
}
if ( ! current_user_can( 'manage_options' ) ) {
return;
}
// Run on deactivate button press
if ( isset( $_POST['pum_license_deactivate'][ $this->item_shortname . '_license_key' ] ) ) {
// Data to send to the API
$api_params = array(
'edd_action' => 'deactivate_license',
'license' => $this->license,
'item_name' => urlencode( $this->item_name ),
'url' => home_url(),
);
// Call the API
$response = wp_remote_post( $this->api_url, array(
'timeout' => 15,
'sslverify' => false,
'body' => $api_params,
) );
// Make sure there are no errors
if ( is_wp_error( $response ) ) {
return;
}
// Decode the license data
$license_data = json_decode( wp_remote_retrieve_body( $response ) );
delete_option( $this->item_shortname . '_license_active' );
}
}
/**
* Check if license key is valid once per week
*
* @access public
* @since 2.5
* @return void
*/
public function weekly_license_check() {
if ( ! empty( $_POST['popmake_settings'] ) ) {
return; // Don't fire when saving settings
}
if ( empty( $this->license ) ) {
return;
}
// data to send in our API request
$api_params = array(
'edd_action' => 'check_license',
'license' => $this->license,
'item_name' => urlencode( $this->item_name ),
'url' => home_url(),
);
// Call the API
$response = wp_remote_post( $this->api_url, array(
'timeout' => 15,
'sslverify' => false,
'body' => $api_params,
) );
// make sure the response came back okay
if ( is_wp_error( $response ) ) {
return;
}
$license_data = json_decode( wp_remote_retrieve_body( $response ) );
update_option( $this->item_shortname . '_license_active', $license_data );
}
/**
* Adds an alert to the Popup Maker notification area when the license is invalid, expired, or empty
*
* @param array $alerts The existing alerts from the pum_alert_list filter
* @return array Our modified array of alerts
*/
public function alerts( $alerts = array() ) {
static $showed_invalid_message;
// If user can't manage it, or we already showed this alert abort.
if ( ! current_user_can( 'manage_options' ) || $showed_invalid_message ) {
return $alerts;
}
// If this alert is already in the list of alerts, abort.
foreach ( $alerts as $alert ) {
if ( 'license_not_valid' === $alert['code'] ) {
return $alerts;
}
}
// If this license key is not empty, check if it's valid.
if ( ! empty( $this->license ) ) {
$license = get_option( $this->item_shortname . '_license_active' );
if ( ! is_object( $license ) || 'valid' === $license->license ) {
return $alerts;
}
}
$showed_invalid_message = true;
if ( empty( $this->license ) ) {
$alerts[] = array(
'code' => 'license_not_valid',
'message' => sprintf( __( 'One or more of your extensions are missing license keys. You will not be able to receive updates until the extension has a valid license key entered. Please go to the %sLicenses page%s to add your license keys.', 'popup-maker' ), '<a href="' . admin_url( 'edit.php?post_type=popup&page=pum-settings&tab=licenses' ) . '">', '</a>' ),
'type' => 'error',
'dismissible' => '4 weeks',
'priority' => 0,
);
} else {
$alerts[] = array(
'code' => 'license_not_valid',
'message' => sprintf( __( 'You have invalid or expired license keys for Popup Maker. Please go to the %sLicenses page%s to correct this issue.', 'popup-maker' ), '<a href="' . admin_url( 'edit.php?post_type=popup&page=pum-settings&tab=licenses' ) . '">', '</a>' ),
'type' => 'error',
'dismissible' => '4 weeks',
'priority' => 0,
);
}
return $alerts;
}
/**
* Admin notices for errors
*
* @access public
* @return void
*/
public function notices() {
static $showed_invalid_message;
if ( empty( $this->license ) ) {
return;
}
if ( ! current_user_can( 'manage_options' ) || $showed_invalid_message ) {
return;
}
$messages = array();
$license = get_option( $this->item_shortname . '_license_active' );
if ( is_object( $license ) && 'valid' !== $license->license ) {
if ( empty( $_GET['tab'] ) || 'licenses' !== $_GET['tab'] ) {
$messages[] = sprintf( __( 'You have invalid or expired license keys for Popup Maker. Please go to the %sLicenses page%s to correct this issue.', 'popup-maker' ), '<a href="' . admin_url( 'edit.php?post_type=popup&page=pum-settings&tab=licenses' ) . '">', '</a>' );
$showed_invalid_message = true;
}
}
if ( ! empty( $messages ) ) {
foreach ( $messages as $message ) {
echo '<div class="error">';
echo '<p>' . $message . '</p>';
echo '</div>';
}
}
}
/**
* Displays message inline on plugin row that the license key is missing
*/
public function plugin_row_license_missing( $plugin_data, $version_info ) {
static $showed_imissing_key_message;
$license = get_option( $this->item_shortname . '_license_active' );
if ( ( ! is_object( $license ) || 'valid' !== $license->license ) && empty( $showed_imissing_key_message[ $this->item_shortname ] ) ) {
echo ' <strong><a href="' . esc_url( admin_url( 'edit.php?post_type=popup&page=pum-settings&tab=licenses' ) ) . '">' . __( 'Enter valid license key for automatic updates.', 'popup-maker' ) . '</a></strong>';
$showed_imissing_key_message[ $this->item_shortname ] = true;
}
}
/**
* Adds this plugin to the beta page
*
* @access public
*
* @param array $products
*
* @return array
*/
public function register_beta_support( $products ) {
$products[ $this->item_shortname ] = $this->item_name;
return $products;
}
}
Expand full source code Collapse full source code View on Trac
Methods Methods
- __construct — Class constructor
- activate_license — Activate the license key
- alerts — Adds an alert to the Popup Maker notification area when the license is invalid, expired, or empty
- auto_updater — Auto updater
- deactivate_license — Deactivate the license key
- hooks — Setup hooks
- includes — Include the updater class
- notices — Admin notices for errors
- plugin_row_license_missing — Displays message inline on plugin row that the license key is missing
- register_beta_support — Adds this plugin to the beta page
- settings — Add license field to settings
- weekly_license_check — Check if license key is valid once per week