Merge pull request #64 from SparkPost/FAD-3599

Add hooks

Author: rajumsys

admin.widget.class.php

@@ -9,11 +9,11 @@
  */
 class SparkPostAdmin
 {
-    private $options;
+    private $settings;
 
     public function __construct()
     {
-        $this->options = SparkPost::get_options();
+        $this->settings = SparkPost::get_settings(false);
         add_action('admin_menu', array($this, 'add_plugin_page'));
         add_action('admin_init', array($this, 'admin_page_init'));
 
@@ -80,7 +80,7 @@ public function test_email_sending($recipient, $debug = false)
         }
 
         if ($result) {
-            if (!$this->options['enable_sparkpost']) {
+            if (!$this->settings['enable_sparkpost']) {
                 $this->render_message('Test email sent successfully but not through SparkPost.<br/>Note: the SparkPost plugin is not enabled.  To enable it, check "Send email using SparkPost" on the SparkPost settings page.', 'updated');
             } else {
                 $this->render_message('Test email sent successfully', 'updated');
@@ -163,7 +163,7 @@ public function sanitize($input)
             add_settings_error('Password', esc_attr('password'), 'API Key is required', 'error');
         } else {
             if(SparkPost::is_key_obfuscated(esc_attr($input['password']))) { //do not change password
-                $new_input['password'] = $this->options['password'];
+                $new_input['password'] = $this->settings['password'];
             } else {
                 $new_input['password'] = sanitize_text_field($input['password']);
             }
@@ -207,7 +207,7 @@ public function sanitize($input)
     public function render_enable_sparkpost_field()
     {
         printf(
-            '<label><input type="checkbox" id="enable_sparkpost" name="sp_settings[enable_sparkpost]" value="1" %s />Send email using SparkPost</label>', $this->options['enable_sparkpost'] ? 'checked' : ''
+            '<label><input type="checkbox" id="enable_sparkpost" name="sp_settings[enable_sparkpost]" value="1" %s />Send email using SparkPost</label>', $this->settings['enable_sparkpost'] ? 'checked' : ''
         );
     }
 
@@ -218,7 +218,7 @@ public function render_username_field()
 
     public function render_password_field()
     {
-        $api_key = SparkPost::obfuscate_api_key($this->options['password']);
+        $api_key = SparkPost::obfuscate_api_key($this->settings['password']);
 
         printf(
             '<input type="text" id="password" name="sp_settings[password]" class="regular-text" value="%s" /><br/>
@@ -231,7 +231,7 @@ public function render_template_field()
     {
         ?>
         <input type="text" id="template" name="sp_settings[template]" class="regular-text"
-               value="<?php echo $this->options['template']; ?>"/><br/>
+               value="<?php echo $this->settings['template']; ?>"/><br/>
         <small>
             <ul>
                 <li>- Please see <a href="https://support.sparkpost.com/customer/portal/articles/2409547-using-templates-with-the-sparkpost-wordpress-plugin">this article</a> for detailed information about using templates with this plugin.</li>
@@ -245,30 +245,30 @@ public function render_template_field()
     public function render_from_email_field()
     {
         $hint = 'Important: Domain must match with one of your verified sending domains.';
-        if(empty($this->options['from_email'])){
+        if(empty($this->settings['from_email'])){
             $hostname = parse_url(get_bloginfo('url'), PHP_URL_HOST);
             $hint .= sprintf(' When left blank, <strong>%s</strong> will be used as email domain', $hostname);
         }
 
         $hint = sprintf('<small>%s</small>', $hint);
         printf(
             '<input type="email" id="from_email" name="sp_settings[from_email]" class="regular-text" value="%s" /><br/>%s',
-            isset($this->options['from_email']) ? esc_attr($this->options['from_email']) : '', $hint
+            isset($this->settings['from_email']) ? esc_attr($this->settings['from_email']) : '', $hint
         );
     }
 
     public function render_from_name_field()
     {
         printf(
             '<input type="text" id="from_name" name="sp_settings[from_name]" class="regular-text" value="%s" />',
-            isset($this->options['from_name']) ? esc_attr($this->options['from_name']) : ''
+            isset($this->settings['from_name']) ? esc_attr($this->settings['from_name']) : ''
         );
     }
 
     public function render_sending_method_field()
     {
-        $method = esc_attr($this->options['sending_method']);
-        $port = esc_attr($this->options['port']);
+        $method = esc_attr($this->settings['sending_method']);
+        $port = esc_attr($this->settings['port']);
 
         $selected_method = !empty($method) ? $method : 'api';
         $selected_port = !empty($port) ? $port : 587;
@@ -283,7 +283,7 @@ public function render_sending_method_field()
     public function render_enable_tracking_field()
     {
         printf(
-            '<label><input type="checkbox" id="enable_tracking" name="sp_settings[enable_tracking]" value="1" %s />Track clicks/opens in SparkPost</label>', $this->options['enable_tracking'] ? 'checked' : ''
+            '<label><input type="checkbox" id="enable_tracking" name="sp_settings[enable_tracking]" value="1" %s />Track clicks/opens in SparkPost</label>', $this->settings['enable_tracking'] ? 'checked' : ''
         );
     }
 

mailer.http.class.php

@@ -9,17 +9,18 @@
 class SparkPostHTTPMailer extends PHPMailer
 {
     protected $endpoint = 'https://api.sparkpost.com/api/v1/transmissions';
-    private $options;
+    private $settings;
 
     /**
      * Constructor.
      * @param boolean $exceptions Should we throw external exceptions?
      */
     function __construct($exceptions = false)
     {
-        $this->options = SparkPost::get_options();
+        $this->settings = SparkPost::get_settings();
 
         parent::__construct($exceptions);
+        do_action('wpsp_init_mailer', $this);
     }
 
     /**
@@ -46,43 +47,52 @@ function sparkpostSend()
             'body' => json_encode($this->get_request_body())
         );
 
-        $http = _wp_http_get_object();
+        $http = apply_filters('wpsp_get_http_lib', _wp_http_get_object());
 
         $this->edebug(sprintf('Request headers: %s', print_r($this->get_request_headers(true), true)));
         $this->edebug(sprintf('Request body: %s', $data['body']));
         $this->edebug(sprintf('Making HTTP POST request to %s', $this->endpoint));
+        do_action('wpsp_before_send', $this->endpoint, $data);
         $result = $http->request($this->endpoint, $data);
+        do_action('wpsp_after_send', $result);
         $this->edebug('Response received');
 
-        return $this->handle_response($result);
+        $result = apply_filters('wpsp_handle_response', $result);
+        if(is_bool($result)) { // it means, response been already processed by the hooked filter. so just return the value.
+          $this->edebug('Skipping response processing');
+          return $result;
+        } else {
+          return $this->handle_response($result);
+        }
     }
 
     /**
      * Build the request body to be sent to the SparkPost API.
      */
     protected function get_request_body()
     {
-        $tracking_enabled = !!$this->options['enable_tracking'];
+        $tracking_enabled = !!$this->settings['enable_tracking'];
         $sender = $this->get_sender();
         $replyTo = $this->get_reply_to();
         $body = array();
 
         // add recipients
-        $body['recipients'] = $this->get_recipients();
+        $body['recipients'] = apply_filters('wpsp_recipients', $this->get_recipients());
 
         // enable engagement tracking
         $body['options'] = array(
-            'open_tracking' => $tracking_enabled,
-            'click_tracking' => $tracking_enabled
+            'open_tracking' => (bool) apply_filters('wpsp_open_tracking', $tracking_enabled),
+            'click_tracking' => (bool) apply_filters('wpsp_click_tracking', $tracking_enabled)
         );
 
         // pass through either stored template or inline content
-        if (!empty($this->options['template'])) {
+        if (!empty($this->settings['template'])) {
             // stored template
-            $body['content']['template_id'] = $this->options['template'];
+            $body['content']['template_id'] = apply_filters('wpsp_template_id', $this->settings['template']);
 
             // supply substitution data so users can add variables to templates
-            $body['substitution_data']['content'] = $this->Body;
+            $content_substitution_tag_name = apply_filters('wpsp_substitution_content_tag_name', 'content');
+            $body['substitution_data'][$content_substitution_tag_name] = $this->Body;
             $body['substitution_data']['subject'] = $this->Subject;
             $body['substitution_data']['from_name'] = $sender['name'];
             $body['substitution_data']['from'] = $sender['name'] . ' <' . $sender['email'] . '>';
@@ -124,6 +134,8 @@ protected function get_request_body()
             $body['content']['attachments'] = $attachments;
         }
 
+        $body = apply_filters( 'wpsp_request_body', $body);
+
         return $body;
     }
 
@@ -173,7 +185,6 @@ public function isMail()
 
     protected function handle_response($response)
     {
-
         if (is_wp_error($response)) {
             $this->edebug('Request completed with error');
             $this->setError($response->get_error_messages()); //WP_Error implements this method
@@ -185,6 +196,8 @@ protected function handle_response($response)
         $this->edebug('Response body: ' . print_r($response['body'], true));
 
         $body = json_decode($response['body']);
+        do_action('wpsp_response_body', $body);
+
         if (property_exists($body, 'errors')) {
             $this->edebug('Error in transmission');
             $this->setError($body->errors);
@@ -238,20 +251,21 @@ protected function get_recipients()
         // include cc to recipients, they need to included in recipients and in headers (refer to get_headers method)
         $recipients = array_merge($recipients, $this->get_cc($recipients_header_to));
 
-        return $recipients;
+        return apply_filters('wpsp_recipients', $recipients);
     }
 
     protected function get_request_headers($hide_api_key = false)
     {
-        $api_key = $this->options['password'];
+        $api_key = apply_filters('wpsp_api_key', $this->settings['password']);
         if ($hide_api_key) {
             $api_key = SparkPost::obfuscate_api_key($api_key);
         }
-        return array(
+
+        return apply_filters('wpsp_request_headers', array(
             'User-Agent' => 'wordpress-sparkpost',
             'Content-Type' => 'application/json',
             'Authorization' => $api_key
-        );
+        ));
     }
 
     /**
@@ -291,7 +305,7 @@ protected function parse_reply_to()
             }
         }
 
-        return implode(',', $replyTos);
+        return apply_filters('wpsp_reply_to', implode(',', $replyTos));
     }
 
     protected function get_reply_to()
@@ -396,6 +410,6 @@ protected function get_headers()
           $formatted_headers['CC'] = $this->stringify_recipients($cc);
         }
 
-        return $formatted_headers;
+        return apply_filters('spwp_body_headers', $formatted_headers);
     }
 }

mailer.smtp.class.php

@@ -16,28 +16,29 @@ public function __construct()
     }
 
     public function configure_phpmailer($phpmailer) {
-        $options = SparkPost::get_options();
+        $settings = SparkPost::get_settings();
 
-        if (!$options['enable_sparkpost'] || empty($options['password'])) {
+        if (!$settings['enable_sparkpost'] || empty($settings['password'])) {
             return;
         }
-        $tracking_enabled = !!$options['enable_tracking'];
+
+        $tracking_enabled = (bool) $settings['enable_tracking'];
         $x_msys_api = array(
             'options' => array (
-                'open_tracking' => $tracking_enabled,
-                'click_tracking' => $tracking_enabled
+                'open_tracking' => (bool) apply_filters('wpsp_open_tracking', $tracking_enabled),
+                'click_tracking' => (bool) apply_filters('wpsp_click_tracking', $tracking_enabled)
             )
         );
 
         $phpmailer->isSMTP();
         $phpmailer->SMTPSecure = 'tls';
-        $phpmailer->Port = !empty($options['port']) ? intval($options['port']) : 587;
+        $phpmailer->Port = !empty($settings['port']) ? intval($settings['port']) : 587;
         $phpmailer->Host = 'smtp.sparkpostmail.com';
-        
         $phpmailer->SMTPAuth = true;
         $phpmailer->Username = 'SMTP_Injection';
-        $phpmailer->Password = $options['password'];
+        $phpmailer->Password = apply_filters('wpsp_api_key', $settings['password']);
 
-        $phpmailer->addCustomHeader('X-MSYS-API', json_encode($x_msys_api));
+        $json_x_msys_api = apply_filters('wpsp_smtp_msys_api', json_encode($x_msys_api));
+        $phpmailer->addCustomHeader('X-MSYS-API', $json_x_msys_api);
     }
 }

sparkpost.class.php

@@ -9,7 +9,7 @@
 class SparkPost
 {
 
-    protected static $options_default = array(
+    protected static $settings_default = array(
         'port' => 587,
         'sending_method' => 'api',
         'password' => '',
@@ -20,7 +20,7 @@ class SparkPost
         'template' => ''
     );
 
-    var $options;
+    var $settings;
 
     public function __construct()
     {
@@ -29,33 +29,41 @@ public function __construct()
 
         add_filter('plugin_action_links_' . plugin_basename(WPSP_PLUGIN_PATH), array($this, 'add_settings_link'));
 
-        $this->options = self::get_options();
+        $this->settings = self::get_settings();
 
-        if (self::get_option('enable_sparkpost')) { //no need to register this hooks if plugin is disabled
+        if (self::get_setting('enable_sparkpost')) { //no need to register this hooks if plugin is disabled
             add_filter('wp_mail_from', array($this, 'set_from_email'));
             add_filter('wp_mail_from_name', array($this, 'set_from_name'));
         }
     }
 
     public function sp_activate()
     {
-        update_option('sp_settings', self::$options_default);
+        update_option('sp_settings', self::$settings_default);
     }
 
     public function sp_deactivate()
     {
         delete_option('sp_settings');
     }
 
-    static function get_options()
+    static function get_settings($apply_filter = true)
     {
-        return array_merge(self::$options_default, get_option('sp_settings', array()));
+        $settings = array_merge(self::$settings_default, get_option('sp_settings', array()));
+
+        if ($apply_filter) {
+            return apply_filters('wpsp_get_settings', $settings);
+        }
+        else {
+            return $settings;
+        }
+
     }
 
-    static function get_option($option)
+    static function get_setting($setting)
     {
-        $options = self::get_options();
-        return $options[$option];
+        $settings = self::get_settings();
+        return $settings[$setting];
     }
 
     public function add_settings_link($links)
@@ -69,20 +77,20 @@ public function add_settings_link($links)
 
     public function set_from_name($name)
     {
-        if (!empty($this->options['from_name'])) {
-            return $this->options['from_name'];
-        } else {
-            return $name;
+        if (!empty($this->settings['from_name'])) {
+            $name = $this->settings['from_name'];
         }
+
+        return apply_filters('wpsp_sender_name', $name);
     }
 
     public function set_from_email($email)
     {
-        if (!empty($this->options['from_email'])) {
-            return $this->options['from_email'];
-        } else {
-            return $email;
+        if (!empty($this->settings['from_email'])) {
+            $email = $this->settings['from_email'];
         }
+
+        return apply_filters('wpsp_sender_email', $email);
     }
 
     static function obfuscate_api_key($api_key)