389 lines
14 KiB
PHP
389 lines
14 KiB
PHP
<?php
|
|
|
|
/**
|
|
* The file that defines the core plugin class
|
|
*
|
|
* A class definition that includes attributes and functions used across both the
|
|
* public-facing side of the site and the admin area.
|
|
*
|
|
* @link https://mailchimp.com
|
|
* @since 1.0.1
|
|
*
|
|
* @package MailChimp_WooCommerce
|
|
* @subpackage MailChimp_WooCommerce/includes
|
|
*/
|
|
|
|
/**
|
|
* The core plugin class.
|
|
*
|
|
* This is used to define internationalization, admin-specific hooks, and
|
|
* public-facing site hooks.
|
|
*
|
|
* Also maintains the unique identifier of this plugin as well as the current
|
|
* version of the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @package MailChimp_WooCommerce
|
|
* @subpackage MailChimp_WooCommerce/includes
|
|
* @author Ryan Hungate <ryan@vextras.com>
|
|
*/
|
|
class MailChimp_WooCommerce
|
|
{
|
|
|
|
/**
|
|
* The loader that's responsible for maintaining and registering all hooks that power
|
|
* the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @access protected
|
|
* @var MailChimp_WooCommerce_Loader $loader Maintains and registers all hooks for the plugin.
|
|
*/
|
|
protected $loader;
|
|
|
|
/**
|
|
* The unique identifier of this plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @access protected
|
|
* @var string $plugin_name The string used to uniquely identify this plugin.
|
|
*/
|
|
protected $plugin_name;
|
|
|
|
/**
|
|
* The current version of the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @access protected
|
|
* @var string $version The current version of the plugin.
|
|
*/
|
|
protected $version;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $environment = 'production';
|
|
|
|
protected $is_configured;
|
|
|
|
protected static $logging_config = null;
|
|
|
|
/**
|
|
* @return object
|
|
*/
|
|
public static function getLoggingConfig()
|
|
{
|
|
if (is_object(static::$logging_config)) {
|
|
return static::$logging_config;
|
|
}
|
|
|
|
$plugin_options = get_option('mailchimp-woocommerce');
|
|
$is_options = is_array($plugin_options);
|
|
|
|
$api_key = $is_options && array_key_exists('mailchimp_api_key', $plugin_options) ?
|
|
$plugin_options['mailchimp_api_key'] : false;
|
|
|
|
$enable_logging = $is_options &&
|
|
array_key_exists('mailchimp_debugging', $plugin_options) &&
|
|
$plugin_options['mailchimp_debugging'];
|
|
|
|
$account_id = $is_options && array_key_exists('mailchimp_account_info_id', $plugin_options) ?
|
|
$plugin_options['mailchimp_account_info_id'] : false;
|
|
|
|
$username = $is_options && array_key_exists('mailchimp_account_info_username', $plugin_options) ?
|
|
$plugin_options['mailchimp_account_info_username'] : false;
|
|
|
|
$api_key_parts = str_getcsv($api_key, '-');
|
|
$data_center = isset($api_key_parts[1]) ? $api_key_parts[1] : 'us1';
|
|
|
|
return static::$logging_config = (object)array(
|
|
'enable_logging' => (bool)$enable_logging,
|
|
'account_id' => $account_id,
|
|
'username' => $username,
|
|
'endpoint' => 'https://ecommerce.' . $data_center . '.list-manage.com/ecommerce/log',
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
* Define the core functionality of the plugin.
|
|
*
|
|
* Set the plugin name and the plugin version that can be used throughout the plugin.
|
|
* Load the dependencies, define the locale, and set the hooks for the admin area and
|
|
* the public-facing side of the site.
|
|
*
|
|
* @param string $environment
|
|
* @param string $version
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function __construct($environment = 'production', $version = '1.0.0')
|
|
{
|
|
|
|
$this->plugin_name = 'mailchimp-woocommerce';
|
|
$this->version = $version;
|
|
$this->environment = $environment;
|
|
$this->is_configured = mailchimp_is_configured();
|
|
|
|
$this->load_dependencies();
|
|
$this->set_locale();
|
|
$this->define_admin_hooks();
|
|
$this->define_public_hooks();
|
|
$this->define_gdpr_hooks();
|
|
|
|
$this->activateMailChimpNewsletter();
|
|
$this->activateMailChimpService();
|
|
}
|
|
|
|
/**
|
|
* Load the required dependencies for this plugin.
|
|
*
|
|
* Include the following files that make up the plugin:
|
|
*
|
|
* - MailChimp_WooCommerce_Loader. Orchestrates the hooks of the plugin.
|
|
* - MailChimp_WooCommerce_i18n. Defines internationalization functionality.
|
|
* - MailChimp_WooCommerce_Admin. Defines all hooks for the admin area.
|
|
* - MailChimp_WooCommerce_Public. Defines all hooks for the public side of the site.
|
|
*
|
|
* Create an instance of the loader which will be used to register the hooks
|
|
* with WordPress.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
*/
|
|
private function load_dependencies()
|
|
{
|
|
global $wp_queue;
|
|
if (empty($wp_queue)) {
|
|
$wp_queue = new WP_Queue();
|
|
}
|
|
|
|
// fire up the loader
|
|
$this->loader = new MailChimp_WooCommerce_Loader();
|
|
|
|
if (!mailchimp_running_in_console() && mailchimp_is_configured()) {
|
|
// fire up the http worker container
|
|
new WP_Http_Worker($wp_queue);
|
|
}
|
|
|
|
// if we're not running in the console, and the http_worker is not running
|
|
if (mailchimp_should_init_queue()) {
|
|
try {
|
|
// if we do not have a site transient for the queue listener
|
|
if (!get_site_transient('http_worker_queue_listen')) {
|
|
// set the site transient to expire in 50 seconds so this will not happen too many times
|
|
// but still work for cron scripts on the minute mark.
|
|
set_site_transient('http_worker_queue_listen', microtime(), 50);
|
|
// if we have available jobs, call the http worker manually
|
|
if ($wp_queue->available_jobs()) {
|
|
mailchimp_call_http_worker_manually();
|
|
}
|
|
}
|
|
} catch (\Exception $e) {}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Define the locale for this plugin for internationalization.
|
|
*
|
|
* Uses the MailChimp_WooCommerce_i18n class in order to set the domain and to register the hook
|
|
* with WordPress.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
*/
|
|
private function set_locale()
|
|
{
|
|
$plugin_i18n = new MailChimp_WooCommerce_i18n();
|
|
$this->loader->add_action('plugins_loaded', $plugin_i18n, 'load_plugin_textdomain');
|
|
}
|
|
|
|
/**
|
|
* Define the GDPR additions from Automattic.
|
|
*/
|
|
private function define_gdpr_hooks()
|
|
{
|
|
$gdpr = new MailChimp_WooCommerce_Privacy();
|
|
|
|
$this->loader->add_action('admin_init', $gdpr, 'privacy_policy');
|
|
$this->loader->add_filter('wp_privacy_personal_data_exporters', $gdpr, 'register_exporter', 10);
|
|
$this->loader->add_filter('wp_privacy_personal_data_erasers', $gdpr, 'register_eraser', 10);
|
|
}
|
|
|
|
/**
|
|
* Register all of the hooks related to the admin area functionality
|
|
* of the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
*/
|
|
private function define_admin_hooks() {
|
|
|
|
$plugin_admin = new MailChimp_WooCommerce_Admin( $this->get_plugin_name(), $this->get_version() );
|
|
|
|
$this->loader->add_action('admin_enqueue_scripts', $plugin_admin, 'enqueue_styles');
|
|
$this->loader->add_action('admin_enqueue_scripts', $plugin_admin, 'enqueue_scripts');
|
|
|
|
// Add menu item
|
|
$this->loader->add_action('admin_menu', $plugin_admin, 'add_plugin_admin_menu');
|
|
|
|
// Add Settings link to the plugin
|
|
$plugin_basename = plugin_basename( plugin_dir_path( __DIR__ ) . $this->plugin_name . '.php');
|
|
$this->loader->add_filter('plugin_action_links_' . $plugin_basename, $plugin_admin, 'add_action_links');
|
|
|
|
// make sure we're listening for the admin init
|
|
$this->loader->add_action('admin_init', $plugin_admin, 'options_update');
|
|
|
|
// put the menu on the admin top bar.
|
|
//$this->loader->add_action('admin_bar_menu', $plugin_admin, 'admin_bar', 100);
|
|
|
|
$this->loader->add_action('plugins_loaded', $plugin_admin, 'update_db_check');
|
|
}
|
|
|
|
/**
|
|
* Register all of the hooks related to the public-facing functionality
|
|
* of the plugin.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
*/
|
|
private function define_public_hooks() {
|
|
|
|
$plugin_public = new MailChimp_WooCommerce_Public( $this->get_plugin_name(), $this->get_version() );
|
|
|
|
$this->loader->add_action('wp_enqueue_scripts', $plugin_public, 'enqueue_styles');
|
|
$this->loader->add_action('wp_enqueue_scripts', $plugin_public, 'enqueue_scripts');
|
|
}
|
|
|
|
/**
|
|
* Handle the newsletter actions here.
|
|
*/
|
|
private function activateMailChimpNewsletter()
|
|
{
|
|
$service = new MailChimp_Newsletter();
|
|
|
|
if ($this->is_configured && $service->isConfigured()) {
|
|
|
|
$service->setEnvironment($this->environment);
|
|
$service->setVersion($this->version);
|
|
|
|
// adding the ability to render the checkbox on another screen of the checkout page.
|
|
$render_on = $service->getOption('mailchimp_checkbox_action', 'woocommerce_after_checkout_billing_form');
|
|
|
|
$this->loader->add_action($render_on, $service, 'applyNewsletterField', 10);
|
|
|
|
$this->loader->add_action('woocommerce_ppe_checkout_order_review', $service, 'applyNewsletterField', 10);
|
|
$this->loader->add_action('woocommerce_register_form', $service, 'applyNewsletterField', 10);
|
|
|
|
$this->loader->add_action('woocommerce_checkout_order_processed', $service, 'processNewsletterField', 10, 2);
|
|
$this->loader->add_action('woocommerce_ppe_do_payaction', $service, 'processPayPalNewsletterField', 10, 1);
|
|
$this->loader->add_action('woocommerce_register_post', $service, 'processRegistrationForm', 10, 3);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handle all the service hooks here.
|
|
*/
|
|
private function activateMailChimpService()
|
|
{
|
|
$service = new MailChimp_Service();
|
|
|
|
if ($service->isConfigured()) {
|
|
|
|
$service->setEnvironment($this->environment);
|
|
$service->setVersion($this->version);
|
|
|
|
// core hook setup
|
|
$this->loader->add_action('admin_init', $service, 'adminReady');
|
|
$this->loader->add_action('woocommerce_init', $service, 'wooIsRunning');
|
|
|
|
// for the data sync we need to configure basic auth.
|
|
$this->loader->add_filter('http_request_args', $service, 'addHttpRequestArgs', 10, 2);
|
|
|
|
// campaign tracking
|
|
$this->loader->add_action( 'init', $service, 'handleCampaignTracking' );
|
|
|
|
// order hooks
|
|
$this->loader->add_action('woocommerce_thankyou', $service, 'onNewOrder', 10);
|
|
$this->loader->add_action('woocommerce_api_create_order', $service, 'onNewOrder', 10);
|
|
$this->loader->add_action('woocommerce_ppe_do_payaction', $service, 'onNewPayPalOrder', 10, 1);
|
|
$this->loader->add_action('woocommerce_order_status_changed', $service, 'handleOrderStatusChanged', 10);
|
|
|
|
// partially refunded
|
|
$this->loader->add_action('woocommerce_order_partially_refunded', $service, 'onPartiallyRefunded', 10);
|
|
|
|
// cart hooks
|
|
//$this->loader->add_action('woocommerce_cart_updated', $service, 'handleCartUpdated');
|
|
$this->loader->add_filter('woocommerce_update_cart_action_cart_updated', $service, 'handleCartUpdated');
|
|
$this->loader->add_action('woocommerce_add_to_cart', $service, 'handleCartUpdated');
|
|
$this->loader->add_action('woocommerce_cart_item_removed', $service, 'handleCartUpdated');
|
|
|
|
// save post hooks
|
|
$this->loader->add_action('save_post', $service, 'handlePostSaved', 10, 3);
|
|
$this->loader->add_action('wp_trash_post', $service, 'handlePostTrashed', 10);
|
|
$this->loader->add_action('untrashed_post', $service, 'handlePostRestored', 10);
|
|
|
|
//coupons
|
|
$this->loader->add_action('woocommerce_new_coupon', $service, 'handleNewCoupon', 10);
|
|
$this->loader->add_action('woocommerce_coupon_options_save', $service, 'handleCouponSaved', 10, 2);
|
|
$this->loader->add_action('woocommerce_api_create_coupon', $service, 'handleCouponSaved', 9, 2);
|
|
|
|
$this->loader->add_action('woocommerce_delete_coupon', $service, 'handleCouponTrashed', 10);
|
|
$this->loader->add_action('woocommerce_trash_coupon', $service, 'handleCouponTrashed', 10);
|
|
$this->loader->add_action('woocommerce_api_delete_coupon', $service, 'handleCouponTrashed', 9);
|
|
|
|
// handle the user registration hook
|
|
$this->loader->add_action('user_register', $service, 'handleUserRegistration');
|
|
// handle the user updated profile hook
|
|
$this->loader->add_action('profile_update', $service, 'handleUserUpdated', 10, 2);
|
|
|
|
// get user by hash ( public and private )
|
|
$this->loader->add_action('wp_ajax_mailchimp_get_user_by_hash', $service, 'get_user_by_hash');
|
|
$this->loader->add_action('wp_ajax_nopriv_mailchimp_get_user_by_hash', $service, 'get_user_by_hash');
|
|
|
|
// set user by email hash ( public and private )
|
|
$this->loader->add_action('wp_ajax_mailchimp_set_user_by_email', $service, 'set_user_by_email');
|
|
$this->loader->add_action('wp_ajax_nopriv_mailchimp_set_user_by_email', $service, 'set_user_by_email');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Run the loader to execute all of the hooks with WordPress.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function run() {
|
|
$this->loader->run();
|
|
}
|
|
|
|
/**
|
|
* The name of the plugin used to uniquely identify it within the context of
|
|
* WordPress and to define internationalization functionality.
|
|
*
|
|
* @since 1.0.1
|
|
* @return string The name of the plugin.
|
|
*/
|
|
public function get_plugin_name() {
|
|
return $this->plugin_name;
|
|
}
|
|
|
|
/**
|
|
* The reference to the class that orchestrates the hooks with the plugin.
|
|
*
|
|
* @since 1.0.1
|
|
* @return MailChimp_WooCommerce_Loader Orchestrates the hooks of the plugin.
|
|
*/
|
|
public function get_loader() {
|
|
return $this->loader;
|
|
}
|
|
|
|
/**
|
|
* Retrieve the version number of the plugin.
|
|
*
|
|
* @since 1.0.1
|
|
* @return string The version number of the plugin.
|
|
*/
|
|
public function get_version() {
|
|
return $this->version;
|
|
}
|
|
}
|