get_plugin_data();
}
return $this->$key;
}
protected function __construct() {
$this->setup_constants();
// Register our CSS/JS for the whole plugin
add_action( 'init', array( $this, 'register_scripts' ) );
add_action( 'init', array( $this, 'load_textdomain' ) );
// Handle licensing
add_action(
'edd_extension_license_init',
function ( \EDD\Extensions\ExtensionRegistry $registry ) {
$registry->addExtension( __FILE__, 'Slack', 980982, EDD_Slack_VER );
}
);
// Load this first so that we have the ability to use it during Upgrade Routines
require_once EDD_Slack_DIR . '/core/slack/class-edd-slack-api.php';
$this->slack_api = new EDD_Slack_API();
add_action( 'admin_footer', array( $this, 'upgrade_routine' ) );
$this->require_necessities();
}
/**
* Setup plugin constants
*
* @access private
* @since 1.0.0
* @return void
*/
private function setup_constants() {
if ( ! defined( 'EDD_Slack_VER' ) ) {
// Plugin version
define( 'EDD_Slack_VER', '1.2.0' );
}
if ( ! defined( 'EDD_Slack_DIR' ) ) {
// Plugin path
define( 'EDD_Slack_DIR', plugin_dir_path( __FILE__ ) );
}
if ( ! defined( 'EDD_Slack_URL' ) ) {
// Plugin URL
define( 'EDD_Slack_URL', plugin_dir_url( __FILE__ ) );
}
if ( ! defined( 'EDD_Slack_FILE' ) ) {
// Plugin File
define( 'EDD_Slack_FILE', __FILE__ );
}
}
/**
* Internationalization.
*
* @since 1.0.0
* @return void
*/
public function load_textdomain() {
// Set filter for language directory
$lang_dir = EDD_Slack_DIR . '/languages/';
$lang_dir = apply_filters( 'edd_slack_languages_directory', $lang_dir );
// Traditional WordPress plugin locale filter
$locale = apply_filters( 'plugin_locale', get_locale(), 'edd-slack' );
$mofile = sprintf( '%1$s-%2$s.mo', 'edd-slack', $locale );
// Setup paths to current locale file
$mofile_local = $lang_dir . $mofile;
$mofile_global = WP_LANG_DIR . '/' . 'edd-slack' . '/' . $mofile;
if ( file_exists( $mofile_global ) ) {
// Look in global /wp-content/languages/edd-slack/ folder
// This way translations can be overridden via the Theme/Child Theme
load_textdomain( 'edd-slack', $mofile_global );
} elseif ( file_exists( $mofile_local ) ) {
// Look in local /wp-content/plugins/edd-slack/languages/ folder
load_textdomain( 'edd-slack', $mofile_local );
} else {
// Load the default language files
load_plugin_textdomain( 'edd-slack', false, $lang_dir );
}
}
/**
* Run any appropriate Upgrade Routines
* If the upgrade requires User Interaction, it forwards the version to the pending_upgrade() method
*
* @access private
* @since 1.1.0
* @return bool|void Normally returns nothing, but will bail if appropriate
*/
public function upgrade_routine() {
$last_upgrade = edd_get_option( 'slack_last_upgrade', '1.0.0' );
if ( '1.1.0' === $last_upgrade ) {
return;
}
if ( false === strpos( $last_upgrade, 'pending' ) ) {
if ( version_compare( $last_upgrade, '1.1.0', '<' ) ) {
$oauth_token = edd_get_option( 'slack_app_oauth_token', false );
if ( $oauth_token && '-1' !== $oauth_token ) {
// Clear out values so Slack doesn't try to send Interactive Notifications (Or other related things) and fail
$this->slack_api->revoke_oauth_token();
edd_update_option( 'slack_app_oauth_token', '-1' );
edd_delete_option( 'slack_app_has_client_scope' );
// Set to pending since we need the User to re-link the Slack App
$last_upgrade = 'pending-1.1.0';
} else {
$last_upgrade = '1.1.0';
}
}
edd_update_option( 'slack_last_upgrade', $last_upgrade );
}
// Run any Pending routines
if ( false !== strpos( $last_upgrade, 'pending' ) ) {
$pending_version = str_replace( 'pending-', '', $last_upgrade );
$finished_pending = $this->pending_upgrade( $pending_version );
// We're pending, this needs user interaction before we can proceed
if ( ! $finished_pending ) {
return false;
}
}
}
/**
* Check to see if Pending Upgrades have been completed by the User
*
* @param string $pending_version Upgrade that is Pending
*
* @access private
* @since 1.1.0
* @return boolean Whether the Pending Upgrade has been completed or not
*/
private function pending_upgrade( $pending_version ) {
if ( '1.1.0' === $pending_version ) {
$oauth_token = edd_get_option( 'slack_app_oauth_token', false );
if ( ( $oauth_token && $oauth_token !== '-1' ) ||
( ! isset( $_GET['error'] ) && isset( $_GET['token_type'] ) && isset( $_GET['section'] ) && $_GET['section'] == 'edd-slack-settings' ) ) {
edd_update_option( 'slack_last_upgrade', $pending_version );
return true;
} else {
$this->admin_errors[] = sprintf(
_x( '%1$s v%2$s requires additional permissions for Interactive Notifications and Slash Commands. You will need to re-link your Slack App %3$s.', 'OAUTH Token Needs Updating v1.1.0', 'edd-slack' ),
'Easy Digital Downloads - Slack',
$pending_version,
'here'
);
add_action( 'admin_notices', array( $this, 'admin_errors' ) );
}
}
return false;
}
/**
* Include different aspects of the Plugin
*
* @access private
* @since 1.0.0
* @return void
*/
private function require_necessities() {
if ( is_admin() ) {
require_once EDD_Slack_DIR . '/core/admin/class-edd-slack-admin.php';
$this->admin = new EDD_Slack_Admin();
if ( is_ssl() ) {
require_once EDD_Slack_DIR . '/core/ssl-only/class-edd-slack-app-oauth-settings.php';
$this->oauth_settings = new EDD_Slack_OAUTH_Settings();
}
}
require_once EDD_Slack_DIR . '/core/notifications/class-edd-slack-notification-handler.php';
$this->notification_handler = new EDD_Slack_Notification_Handler();
require_once EDD_Slack_DIR . '/core/slack/class-edd-slack-notification-integration.php';
$this->notification_integration = new EDD_Slack_Notification_Integration();
require_once EDD_Slack_DIR . '/core/slack/class-edd-slack-notification-triggers.php';
$this->notification_triggers = new EDD_Slack_Notification_Triggers();
// Include Bundled Integrations with this Plugin
// These also serve as an example of how to tie-in to this Plugin and utilize its functionality
// If Comments are Enabled for Downloads
if ( post_type_supports( 'download', 'comments' ) ) {
require_once EDD_Slack_DIR . '/core/integrations/edd-comments/class-edd-slack-comments.php';
}
// If EDD Software Licensing is Active
if ( class_exists( 'EDD_Software_Licensing' ) ) {
if ( defined( 'EDD_SL_VERSION' ) && version_compare( EDD_SL_VERSION, '3.4.12', '>=' ) ) {
require_once EDD_Slack_DIR . '/core/integrations/edd-software-licensing/class-edd-slack-software-licensing.php';
} else {
$this->integration_errors[] = 'software-licensing';
}
}
// If EDD FES is Active
if ( class_exists( 'EDD_Front_End_Submissions' ) ) {
if ( defined( 'fes_plugin_version' ) && version_compare( fes_plugin_version, '2.4.2', '>=' ) ) {
require_once EDD_Slack_DIR . '/core/integrations/edd-frontend-submissions/class-edd-slack-frontend-submissions.php';
} else {
$this->integration_errors[] = 'fes';
}
}
// If EDD Commissions is Active
if ( defined( 'EDD_COMMISSIONS_VERSION' ) ) {
if ( version_compare( EDD_COMMISSIONS_VERSION, '3.2.10', '>=' ) ) {
require_once EDD_Slack_DIR . '/core/integrations/edd-commissions/class-edd-slack-commissions.php';
} else {
$this->integration_errors[] = 'commissions';
}
}
// If EDD Purchase Limit is Active
if ( class_exists( 'EDD_Purchase_Limit' ) ) {
if ( defined( 'EDD_PURCHASE_LIMIT_VERSION' ) &&
version_compare( EDD_PURCHASE_LIMIT_VERSION, '1.2.16', '>=' ) ) {
require_once EDD_Slack_DIR . '/core/integrations/edd-purchase-limit/class-edd-slack-purchase-limit.php';
} else {
$this->integration_errors[] = 'purchase-limit';
}
}
// If EDD Reviews is Active
if ( class_exists( 'EDD_Reviews' ) ) {
if ( version_compare( edd_reviews()->version, '2.0.5', '>=' ) ) {
require_once EDD_Slack_DIR . '/core/integrations/edd-reviews/class-edd-slack-reviews.php';
} else {
$this->integration_errors[] = 'reviews';
}
}
// If EDD Fraud Monitor is Active
if ( defined( 'EDD_FM_VERSION' ) ) {
if ( version_compare( EDD_FM_VERSION, '1.0.3', '>=' ) ) {
require_once EDD_Slack_DIR . '/core/integrations/edd-fraud-monitor/class-edd-slack-fraud-monitor.php';
} else {
$this->integration_errors[] = 'fraud-monitor';
}
}
// If EDD Recurring is Active
if ( defined( 'EDD_RECURRING_VERSION' ) ) {
if ( version_compare( EDD_RECURRING_VERSION, '2.6.9', '>=' ) ) {
require_once EDD_Slack_DIR . '/core/integrations/edd-recurring/class-edd-slack-recurring.php';
} else {
$this->integration_errors[] = 'recurring';
}
}
// Output all Integration-related Errors just above the Notification Repeater
if ( ! empty( $this->integration_errors ) ) {
add_action( 'edd_slack_before_repeater', array( $this, 'integration_errors' ) );
}
// SSL anywhere, not just Admin
if ( is_ssl() ) {
$oauth_token = edd_get_option( 'slack_app_oauth_token', false );
// If we've got a linked Slack App
if ( $oauth_token && $oauth_token !== '-1' ) {
require_once EDD_Slack_DIR . '/core/ssl-only/class-edd-slack-ssl-rest.php';
$this->slack_rest_api = new EDD_Slack_SSL_REST();
}
// If we've linked our Slack App previously or just now
// This file is loaded at `plugins_loaded` and the data is saved at `init`, so we can't reliably check on that first load
if ( ( $oauth_token && $oauth_token !== '-1' ) ||
( ! isset( $_GET['error'] ) && isset( $_GET['token_type'] ) ) ) {
require_once EDD_Slack_DIR . '/core/ssl-only/interactive-notifications/class-edd-slack-app-interactive-notification-settings.php';
require_once EDD_Slack_DIR . '/core/ssl-only/slash-commands/class-edd-slack-app-slash-command-settings.php';
// This file does mostly things on the Admin-side, but it runs Filters that need access to the Frontend based on results from the Admin-side
// Primarily, replacing `#general` as appropriate
// Since this is done within Interactive Notifications, we need the file to be loaded here
require_once EDD_Slack_DIR . '/core/ssl-only/slack-invites/class-edd-slack-app-invites-settings.php';
}
// If we've been granted Client Scope previously or just now
// This file is loaded at `plugins_loaded` and the data is saved at `init`, so we can't reliably check on that first load
if ( edd_get_option( 'slack_app_has_client_scope', false ) ||
( ! isset( $_GET['error'] ) && isset( $_GET['token_type'] ) && $_GET['token_type'] == 'team_invites' ) ) {
// Here we actually send out the Invites if appropriate
require_once EDD_Slack_DIR . '/core/ssl-only/slack-invites/class-edd-slack-app-invites.php';
}
// If Comments are Enabled for Downloads
if ( post_type_supports( 'download', 'comments' ) ) {
require_once EDD_Slack_DIR . '/core/ssl-only/integrations/edd-comments/class-edd-slack-app-comments.php';
}
// If EDD FES is Active
if ( class_exists( 'EDD_Front_End_Submissions' ) ) {
require_once EDD_Slack_DIR . '/core/ssl-only/integrations/edd-frontend-submissions/class-edd-slack-app-frontend-submissions.php';
}
// If EDD Fraud Monitor is Active
if ( defined( 'EDD_FM_VERSION' ) ) {
require_once EDD_Slack_DIR . '/core/ssl-only/integrations/edd-fraud-monitor/class-edd-slack-app-fraud-monitor.php';
}
}
}
/**
* Grab EDD Slack Notification Repeater Fields
*
* @param boolean $query Whether to run through Database Queries or not
*
* @access public
* @since 1.0.0
* @return array EDD Settings API Array
*/
public function get_notification_fields( $query = true ) {
$downloads_array = array();
$discount_codes_array = array();
// Only run through all these queries when we need them
if ( $query ) {
$base_args = array(
'posts_per_page' => -1,
'orderby' => 'title',
'order' => 'ASC',
);
$downloads = get_posts(
array(
'post_type' => 'download',
) + $base_args
);
$downloads_query = wp_list_pluck( $downloads, 'post_title', 'ID' );
// Sort before adding
asort( $downloads_query );
foreach ( $downloads_query as $download_id => $download_name ) {
// If there's no variable Prices, continue
if ( ! edd_has_variable_prices( $download_id ) ) {
$downloads_array[ $download_id ] = $download_name;
continue;
}
$variations = edd_get_variable_prices( $download_id );
$downloads_array[ $download_id ] = $download_name . ' - ' . _x( 'All Variations', 'All Variations Option Text', 'edd-slack' );
// Apparently edd_get_variable_prices() can't be trusted to get Price IDs
// After the first Price ID it just has an empty String
// Thankfully, EDD reliably starts its index for those at 1
$price_id = 1;
foreach ( $variations as $variation ) {
$downloads_array[ $download_id . '-' . $price_id ] = $download_name . ' - ' . edd_get_price_option_name( $download_id, $price_id );
++$price_id;
}
}
$discount_codes = edd_get_discounts(
array(
'status__in' => array( 'active', 'inactive', 'expired' ),
'orderby' => 'name',
'number' => 99999,
'order' => 'ASC',
)
);
if ( $discount_codes && is_array( $discount_codes ) ) {
foreach ( $discount_codes as $discount_code ) {
if ( $discount_code instanceof EDD_Discount ) {
$name = $discount_code->name;
$code = $discount_code->code;
} else {
$name = $discount_code->post_title;
$code = get_post_meta( $discount_code->ID, '_edd_discount_code', true );
}
$discount_codes_array[ $code ] = $name . ' - ' . $code;
}
}
}
return apply_filters(
'edd_slack_notification_fields',
array(
'slack_post_id' => array(
'type' => 'hook',
'std' => '',
'field_class' => array(
'edd-slack-field',
'edd-slack-post-id',
),
),
'admin_title' => array(
'desc' => '',
'label' => __( 'Identifier for this Notification', 'edd-slack' ),
'type' => 'text',
'readonly' => false,
'placeholder' => __( 'New Slack Notification', 'edd-slack' ),
'std' => '',
'field_class' => 'edd-slack-field',
'label_tooltip_title' => __( 'Identifier for this Notification', 'edd-slack' ),
'label_tooltip_desc' => __( 'Helps distinguish Notifications from one another on the Settings Screen. If left blank, your Notification will be labeled “New Slack Notification”.', 'edd-slack' ),
),
'trigger' => array(
'desc' => '',
'label' => __( 'Slack Trigger', 'edd-slack' ),
'type' => 'select',
'multiple' => false,
'field_class' => array(
'edd-slack-field',
'edd-slack-trigger',
'required',
),
'options' => array(
'' => _x( 'Select a Slack Trigger', 'Slack Trigger Default Label', 'edd-slack' ),
) + $this->get_slack_triggers(),
'placeholder' => _x( 'Select a Slack Trigger', 'Slack Trigger Default Label', 'edd-slack' ),
'std' => '',
),
'download' => array(
'desc' => '',
'label' => edd_get_label_plural(),
'type' => 'select',
'multiple' => true,
'field_class' => array(
'edd-slack-chosen',
'edd-slack-field',
'edd-slack-download',
'edd-slack-conditional',
'edd_complete_purchase',
'edd_discount_code_applied',
'edd_failed_purchase',
'required',
),
'options' => array(
'all' => sprintf( _x( 'All %s', 'All items in a Select Field', 'edd-slack' ), edd_get_label_plural() ),
) + $downloads_array,
'placeholder' => sprintf( _x( 'Select %s', 'Select Field Default', 'edd-slack' ), edd_get_label_plural() ),
'std' => '',
'hide_on_load' => true,
),
'exclude_download' => array(
'desc' => '',
'label' => sprintf( __( 'Exclude %s (Optional)', 'edd-slack' ), edd_get_label_plural() ),
'type' => 'select',
'multiple' => true,
'field_class' => array(
'edd-slack-chosen',
'edd-slack-field',
'edd-slack-exclude-download', // This is a conditional field, but not in the same way as others. It will be hidden/shown based on the value of .edd-slack-download
),
'options' => array_merge( array( '' => __( 'None', 'edd-slack' ) ), $downloads_array ),
'placeholder' => sprintf( _x( 'Select %s', 'Select Field Default', 'edd-slack' ), edd_get_label_plural() ),
'std' => '',
'hide_on_load' => true,
),
'discount_code' => array(
'desc' => '',
'label' => _x( 'Discount Code', 'Discount Code Field Label', 'edd-slack' ),
'type' => 'select',
'multiple' => false,
'field_class' => array(
'edd-slack-chosen',
'edd-slack-field',
'edd-slack-download',
'edd-slack-conditional',
'edd_discount_code_applied',
'required',
),
'options' => array(
'' => _x( 'Select Discount Code', 'Discount Code Field Default', 'edd-slack' ),
'all' => _x( 'All Discount Codes', 'All Discount Codes Text', 'edd-slack' ),
) + $discount_codes_array,
'placeholder' => _x( 'Select Discount Code', 'Discount Code Field Default', 'edd-slack' ),
'std' => '',
'hide_on_load' => true,
),
'replacement_hints' => array(
'type' => 'hook',
'std' => '',
),
'message_pretext' => array(
'desc' => '',
'type' => 'text',
'label' => __( 'Message Pre-text (Optional)', 'edd-slack' ),
'readonly' => false,
'placeholder' => '',
'std' => '',
'field_class' => 'edd-slack-field',
'label_tooltip_title' => __( 'Message Pre-text', 'edd-slack' ),
'label_tooltip_desc' => __( 'Shows directly below Username and above the Title/Message.', 'edd-slack' ),
),
'message_title' => array(
'desc' => '',
'type' => 'text',
'label' => __( 'Message Title (Optional)', 'edd-slack' ),
'readonly' => false,
'placeholder' => '',
'std' => '',
'field_class' => 'edd-slack-field',
'label_tooltip_title' => __( 'Message Title', 'edd-slack' ),
'label_tooltip_desc' => __( 'If left blank this will default to the Notification Identifier.', 'edd-slack' ),
),
'message_text' => array(
'desc' => '',
'type' => 'textarea',
'label' => __( 'Message (Optional)', 'edd-slack' ),
'std' => '',
'field_class' => 'edd-slack-field',
'readonly' => false,
),
'webhook' => array(
'desc' => '',
'type' => 'text',
'label' => __( 'Slack Webhook URL (Optional)', 'edd-slack' ),
'readonly' => false,
'placeholder' => edd_get_option( 'edd_slack_webhook' ),
'args' => array(
'label' => '' .
__( 'You can override the above Webhook URL here.', 'edd-slack' ) .
'
',
),
'std' => '',
'field_class' => array(
'edd-slack-field',
'edd-slack-webhook-url',
),
'label_tooltip_title' => __( 'Slack Webhook URL', 'edd-slack' ),
'label_tooltip_desc' => __( 'This overrides the Default Webhook URL. This can be useful if you want a specific Notification to send to another Slack Team entirely.', 'edd-slack' ),
),
'channel' => array(
'desc' => '',
'type' => 'text',
'label' => __( 'Slack Channel (Optional)', 'edd-slack' ),
'readonly' => false,
'placeholder' => __( 'Webhook default', 'edd-slack' ),
'std' => '',
'field_class' => 'edd-slack-field',
'label_tooltip_title' => __( 'Slack Channel', 'edd-slack' ),
'label_tooltip_desc' => __( 'This overrides the Default Channel defined by the Webhook URL. Notifications can be sent to individual Users instead by entering their Username like so: @«username».', 'edd-slack' ),
),
'username' => array(
'desc' => '',
'type' => 'text',
'label' => __( 'Username (Optional)', 'edd-slack' ),
'readonly' => false,
'placeholder' => get_bloginfo( 'name' ),
'std' => '',
'field_class' => 'edd-slack-field',
'label_tooltip_title' => __( 'Username', 'edd-slack' ),
'label_tooltip_desc' => sprintf( __( 'This controls who the Notification appears to be from. It does not have to be a valid User in your Slack Team. This will default to “%s”.', 'edd-slack' ), get_bloginfo( 'name' ) ),
),
'icon' => array(
'desc' => '',
'type' => 'text',
'label' => __( 'Icon Emoji or Image URL (Optional)', 'edd-slack' ),
'readonly' => false,
'placeholder' => __( 'Webhook default', 'edd-slack' ),
'std' => '',
'field_class' => 'edd-slack-field',
'label_tooltip_title' => __( 'Icon Emoji or Image URL', 'edd-slack' ),
'label_tooltip_desc' => __( 'This accepts an Emoji (Example: :rocket:) or an Image URL. You can even use Custom Emojis defined within your Slack Team. If left empty, it will default to the Emoji or Image defined by the Webhook URL.', 'edd-slack' ),
),
'color' => array(
'desc' => '',
'type' => 'color',
'label' => __( 'Color', 'edd-slack' ),
'std' => '#3299BB',
'field_class' => 'edd-slack-field',
'label_tooltip_title' => __( 'Color', 'edd-slack' ),
'label_tooltip_desc' => __( 'Shows next to Message Title and Message.', 'edd-slack' ),
),
)
);
}
/**
* Returns a List of EDD Slack Triggers and their EDD Actions
*
* @access public
* @since 1.0.0
* @return array EDD Slack Triggers
*/
public function get_slack_triggers() {
$triggers = apply_filters(
'edd_slack_triggers',
array(
'edd_complete_purchase' => _x( 'Purchase Complete', 'Purchase Complete Trigger Label', 'edd-slack' ),
'edd_failed_purchase' => _x( 'Purchase Failed', 'Purchase Failed Trigger Label', 'edd-slack' ),
'edd_discount_code_applied' => _x( 'Discount Code Applied', 'Discount Code Applied Trigger Label', 'edd-slack' ),
'edd_insert_user' => _x( 'New User Registration via EDD', 'New User Registration Trigger Label', 'edd-slack' ),
)
);
asort( $triggers );
return $triggers;
}
/**
* Register our CSS/JS to use later
*
* @access public
* @since 1.0.0
* @return void
*/
public function register_scripts() {
wp_register_style(
'edd-slack-admin',
EDD_Slack_URL . 'assets/build/css/admin-style.css',
null,
defined( 'WP_DEBUG' ) && WP_DEBUG ? time() : EDD_Slack_VER
);
wp_register_script(
'edd-slack-admin',
EDD_Slack_URL . 'assets/build/js/admin.js',
array( 'jquery', 'jquery-effects-core', 'jquery-effects-highlight' ),
defined( 'WP_DEBUG' ) && WP_DEBUG ? time() : EDD_Slack_VER,
true
);
wp_localize_script(
'edd-slack-admin',
'eddSlack',
apply_filters( 'edd_slack_localize_admin_script', array() )
);
}
/**
* Utility Function to insert one Array into another at a specified Index. Useful for the Notification Repeater Field's Filter
*
* @param array &$array Array being modified. This passes by reference.
* @param integer $index Insertion Index. Even if it is an associative array, give a numeric index. Determine it by doing a foreach() until you hit your desired placement and then break out of the loop.
* @param array $insert_array Array being Inserted at the Index
*
* @access public
* @since 1.0.0
* @return void
*/
public function array_insert( &$array, $index, $insert_array ) {
// First half before the cut-off for the splice
$first_array = array_splice( $array, 0, $index );
// Merge this with the inserted array and the last half of the splice
$array = array_merge( $first_array, $insert_array, $array );
}
/**
* Show admin errors.
*
* @access public
* @since 1.0.0
* @return HTML
*/
public function admin_errors() {
?>
admin_errors as $notice ) : ?>
integration_errors as $notice ) :
$details = $this->get_notice( $notice );
if ( ! $details ) {
continue;
}
?>
%s',
esc_html( $details['name'] )
),
esc_html( $details['version'] )
);
?>