wpbe.php

<?php
/*
Plugin Name: WP Better Emails
Plugin URI: http://wordpress.org/extend/plugins/wp-better-emails/
Description: Beautify the default text/plain WP mails into fully customizable HTML emails.
Version: 0.4
Author: Nicolas Lemoine
Author URI: http://wordpress.org/extend/plugins/wp-better-emails/
License: GPLv2
 */

/*
  Copyright (c) 2011 Nicolas Lemoine.

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

if ( ! class_exists( 'WP_Better_Emails' ) ) {

	if ( ! defined( 'WPBE_JS_URL' ) ) {
		define( 'WPBE_JS_URL', plugin_dir_url( __FILE__ ) . 'dist/js' );
	}

	if ( ! defined( 'WPBE_CSS_URL' ) ) {
		define( 'WPBE_CSS_URL', plugin_dir_url( __FILE__ ) . 'dist/css' );
	}

	class WP_Better_Emails {

		var $options = [];
		var $page = '';
		var $send_as_html;

		/**
		 * Construct function
		 *
		 * @since 0.2
		 */
		function __construct() {
			global $wp_version;

			$this->get_options();

			// Front end filter
			add_filter( 'wp_mail_from',         array( $this, 'set_from' ) );
			add_filter( 'wp_mail_content_type', array( $this, 'set_content_type' ), 100 );
			add_action( 'phpmailer_init',   array( $this, 'send_html' ) );
			add_filter( 'mandrill_payload', array( $this, 'wpmandrill_compatibility' ) );

			if ( ! is_admin() ) {
				return;
			}

			// Load translations
			load_plugin_textdomain( 'wp-better-emails', null, basename( dirname( __FILE__ ) ) . '/langs/' );

			// Actions
			add_action( 'admin_init',           array( $this, 'init' ) );
			add_action( 'admin_menu',           array( $this, 'admin_menu' ) );
			add_action( 'wp_ajax_send_preview', array( $this, 'ajax_send_preview' ) );

			// Filters
			add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), array( $this, 'settings_link' ) );

		}

		/**
		 * Get recorded options
		 *
		 * @since 0.2
		 */
		function get_options() {
			$this->options = get_option( 'wpbe_options' );
		}

		/**
		 * Set the default options
		 *
		 * @since 0.2
		 */
		function set_options() {

			// HTML default template
			$template = '';
			@require 'templates/template.php';

			// Plain-text default template
			ob_start();
?>
%content%

---

Email sent %date% @ %time%
For any requests, please contact %admin_email%'
<?php
			$plaintext = ob_get_clean();

			// Setup options array
			$this->options = array(
				'from_email'         => '',
				'from_name'          => '',
				'template'           => $template,
				'plaintext_template' => $plaintext
			);

			// If option doesn't exist, save default option
			if ( get_option( 'wpbe_options' ) === false ) {
				add_option( 'wpbe_options', $this->options );
			}
		}

		/**
		 * Init plugin options to white list our options & register our script
		 *
		 * @since 0.1
		 */
		function init() {
			register_setting( 'wpbe_full_options', 'wpbe_options', array( $this, 'validate_options' ) );
			wp_register_script( 'wpbe-admin-script', WPBE_JS_URL . '/admin.js',['jquery', 'thickbox'], null, true );
			wp_register_style( 'wpbe-admin-style', WPBE_CSS_URL . '/wpbe.css' );
		}

		/**
		 * Settings link in the plugins page
		 *
		 * @since 0.1
		 *
		 * @param array   $links Plugin links
		 * @return array Plugins links with settings added
		 */
		function settings_link( $links ) {
			$links[] = '<a href="options-general.php?page=wpbe_options">' . __( 'Settings', 'wp-better-emails' ) . '</a>';

			return $links;
		}

		/**
		 * Record options on plugin activation
		 *
		 * @since 0.1
		 * @global $wp_version
		 */
		function activate() {
			if ( ! is_multisite() ) {
				$this->set_options();
			} else {
				global $wpdb;
				$all_blogs = $wpdb->get_col( "SELECT blog_id FROM $wpdb->blogs" );
				if ( is_array( $all_blogs ) && $all_blogs !== array() ) {
					foreach ( $all_blogs as $blog_id ) {
						switch_to_blog( $blog_id );
						$this->set_options();
						restore_current_blog();
					}
				}
			}
		}

		/**
		 * Option page to the built-in settings menu
		 *
		 * @since 0.1
		 */
		function admin_menu() {
			$this->page = add_options_page(
				__( 'Email settings', 'wp-better-emails' ),
				__( 'WP Better Emails', 'wp-better-emails' ),
				'administrator',
				'wpbe_options',
				array( $this, 'admin_page' )
			);

			add_action( 'load-' . $this->page, [$this, 'load_hooks']);
		}

		/**
		 * Fire WP Better Emails admin page hooks
		 *
		 * @since 0.5
		 */
		function load_hooks() {
			// Add help tab
			$this->add_help_tab();

			// Tiny MCE
			add_filter( 'mce_external_plugins', array( $this, 'tinymce_plugins' ) );
			add_filter( 'mce_buttons',          array( $this, 'tinymce_buttons' ) );
			add_filter( 'tiny_mce_before_init', array( $this, 'tinymce_config' ) );

			// Scripts & styles
			add_action( 'admin_print_scripts', array( $this, 'admin_print_script' ) );
			add_action( 'admin_print_styles', array( $this, 'admin_print_style' ) );
		}

		/**
		 * Enqueue the script to display it on the options page
		 * Add Javascript to handle AJAX email preview
		 *
		 * @since 0.1
		 */
		function admin_print_script() {
			wp_enqueue_script( 'wpbe-admin-script' );

			$protocol = isset( $_SERVER["HTTPS"] ) ? 'https://' : 'http://';

			$ajax_vars = array(
				'nonce'  => wp_create_nonce( 'email_preview' ),
				'action' => 'send_preview'
			);

			wp_localize_script( 'wpbe-admin-script', 'wpbe_ajax_vars', $ajax_vars );
		}

		/**
		 * Enqueue the style to display it on the options page
		 *
		 * @since 0.1
		 */
		function admin_print_style() {
			wp_enqueue_style( 'wpbe-admin-style' );
			wp_enqueue_style( 'thickbox' );
		}

		/**
		 * Include admin options page
		 *
		 * @since 0.1
		 * @global $wp_version
		 */
		function admin_page() {
			global $wp_version;

			require 'wpbe-options.php';
		}

		/**
		 * Sanitize each option value
		 *
		 * @since 0.1
		 * @param array   $input The options returned by the options page
		 * @return array $input Sanitized values
		 */
		function validate_options( $input ) {

			return $input;

			$from_email = strtolower( $input['from_email'] );

			// Checking emails
			if ( ! empty( $from_email ) && ! is_email( $from_email ) ) {
				add_settings_error( 'wpbe_options', 'settings_updated', __( 'Please enter a valid sender email address.', 'wp-better-emails' ), 'error' );
				$input['from_email'] = '';
			} else {
				$input['from_email'] = sanitize_email( $from_email );
			}

			// Check name
			$input['from_name'] = esc_html( $input['from_name'] );

			/** Check HTML template *****************************************/

			// Template is empty
			if ( empty( $input['template'] ) ) {
				add_settings_error( 'wpbe_options', 'settings_updated', __( 'Template is empty', 'wp-better-emails' ) );

				// Check if %content% tag is the template body
			} elseif ( strpos( $input['template'], '%content%' ) === false ) {
				add_settings_error( 'wpbe_options', 'settings_updated', __( 'No content tag found. The %content% tag is required in your template', 'wp-better-emails' ) );
			}

			$input['template'] = $input['template'];

			/** Check plain-text template ***********************************/

			// Template is empty
			if ( empty( $input['plaintext_template'] ) ) {
				add_settings_error( 'wpbe_options', 'settings_updated', __( 'Plain-text template is empty', 'wp-better-emails' ) );

				// Check if %content% tag is the template body
			} elseif ( strpos( $input['plaintext_template'], '%content%' ) === false ) {
				add_settings_error( 'wpbe_options', 'settings_updated', __( 'No content tag found. The %content% tag is required in your plain-text template', 'wp-better-emails' ) );
			}

			$input['plaintext_template'] = $input['plaintext_template'];

			return $input;
		}

		/**
		 * Send a email preview to test the template
		 *
		 * @since 0.1
		 * @param string $email
		 */
		function ajax_send_preview( $email ) {
			if ( ! current_user_can( 'manage_options' ) ) {
				die();
			}

			check_ajax_referer( 'email_preview' );

			$preview_email = sanitize_email( $_POST['preview_email'] );

			if ( empty( $preview_email ) ) {
				die( '<div class="error"><p>' . __( 'Please enter an email', 'wp-better-emails' ) . '</p></div>' );
			}

			if ( ! is_email( $preview_email ) ) {
				die( '<div class="error"><p>' . __( 'Please enter a valid email', 'wp-better-emails' ) . '</p></div>' );
			}

			// Setup preview message content
			$message = __( 'Hey !', 'wp-better-emails' );
			$message .= "\r\n\r\n";
			$message .= __( 'This is a sample email to test your HTML template.', 'wp-better-emails' );
			$message .= "\r\n\r\n";
			$message .= __( 'If you\'re not skilled in HTML/CSS email coding, I strongly recommend to leave the default template as it is. It has been tested on various and popular email clients like Gmail, Yahoo Mail, Hotmail/Live, Thunderbird, Apple Mail, Outlook, and many more.', 'wp-better-emails' );
			$message .= "\r\n\r\n";
			$message .= __( 'If you have any problems or any suggestions to improve this plugin, please let me know.', 'wp-better-emails' );
			$message .= "\r\n\r\n";

			// Send the preview email
			if ( wp_mail( $preview_email, '[' . wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ) . '] - ' . __( 'Email template preview', 'wp-better-emails' ), $message ) ) {
				die( '<div class="updated"><p>' . sprintf( __( 'An email preview has been successfully sent to %s' , 'wp-better-emails' ), esc_attr( $preview_email ) ) . '</p></div>' );
			} else {
				die( '<div class="error"><p>' . __( 'An error occured while sending email. Please check your server configuration.', 'wp-better-emails' ) . '</p></div>' );
			}
		}

		/**
		 * Replace variables in the template
		 *
		 * @since 0.1
		 * @param string $template Template with variables
		 * @return string Template with variables replaced
		 */
		function template_vars_replacement( $template ) {

			$to_replace = array(
				'blog_url'         => get_option( 'siteurl' ),
				'home_url'         => get_option( 'home' ),
				'blog_name'        => get_option( 'blogname' ),
				'blog_description' => get_option( 'blogdescription' ),
				'admin_email'      => get_option( 'admin_email' ),
				'date'             => date_i18n( get_option( 'date_format' ) ),
				'time'             => date_i18n( get_option( 'time_format' ) )
			);
			$to_replace = apply_filters( 'wpbe_tags', $to_replace );

			foreach ( $to_replace as $tag => $var ) {
				$template = str_replace( '%' . $tag . '%', $var, $template );
			}

			return $template;
		}

		/**
		 * Checks the WP Better Emails options
		 *
		 * @since 0.1
		 * @return bool
		 */
		function check_template() {
			if ( strpos( $this->options['template'], '%content%' ) === false || empty( $this->options['template'] ) )
				return false;

			return true;
		}

		/**
		 * Add the template to the message body.
		 *
		 * Looks for %message% into the template and replaces it with the message.
		 *
		 * @since 0.1
		 * @param string $body The message to templatize
		 * @param string $type The type of template to use. Defaults to 'template', which is HTML.
		 *  Use 'plaintext_template' to use the plain-text template.
		 * @return string $email The email surrounded by template
		 */
		function set_email_template( $body, $type = 'template' ) {
			$template = '';

			if ( isset( $this->options[$type] ) && ! empty( $this->options[$type] ) ) {
				$template .= $this->options[$type];
			}

			return str_replace( '%content%', $body, $template );
		}

		/**
		 * Get default from email
		 * Copy pasted from wp_mail
		 *
		 * @see wp_mail
		 * @return string Default from email
		 */
		function get_default_from_email() {
			$sitename = strtolower( $_SERVER['SERVER_NAME'] );
			if ( substr( $sitename, 0, 4 ) == 'www.' ) {
				$sitename = substr( $sitename, 4 );
			}
			return 'wordpress@' . $sitename;
		}

		/**
		 * Set from email and from name only in case default email and name is used
		 *
		 * @param string $from_email From email
		 */
		function set_from( $from_email ) {
			// Only apply custom from name and email if default email is used
			if( $this->get_default_from_email() === $from_email ) {
				add_filter( 'wp_mail_from_name',    array( $this, 'set_from_name' ) );
				if ( ! empty( $this->options['from_email'] ) && is_email( $this->options['from_email'] ) ) {
					return $this->options['from_email'];
				}
			}
			return $from_email;
		}

		/**
		 * Replaces sender name if set
		 *
		 * @since 0.1
		 * @param string $from_name
		 * @return string
		 */
		function set_from_name( $from_name ) {
			if ( ! empty( $this->options['from_name'] ) ) {
				return wp_specialchars_decode( $this->options['from_name'], ENT_QUOTES );
			}

			return $from_name;
		}

		/**
		 * Always set content type to HTML
		 *
		 * @since 0.1
		 * @param string $content_type
		 * @return string $content_type
		 */
		function set_content_type( $content_type ) {
			// Only convert if the message is text/plain and the template is ok
			if ( $content_type == 'text/plain' && $this->check_template() === true ) {
				$this->send_as_html = true;
				return $content_type = 'text/html';
			} else {
				$this->send_as_html = false;
			}
			return $content_type;
		}

		/**
		 * Make templating compatible with WpMandrill
		 * @since 0.2.7
		 * @param  array $message
		 * @return array
		 */
		function wpmandrill_compatibility( $message ) {

			if ( $this->check_template() ) {
				$message['html'] = $this->process_email_html( $message['html'] );
			}

			return $message;
		}

		/**
		 * Add the email template and set it as multipart.
		 *
		 * @since 0.1
		 * @param object $phpmailer
		 */
		function send_html( $phpmailer ) {

			$phpmailer->AltBody = $this->process_email_text( $phpmailer->Body );

			if ( $this->send_as_html ) {
				$phpmailer->Body = $this->process_email_html( $phpmailer->Body );
			}

		}

		/**
		 * Process the text version of the message
		 *
		 * @since 0.2.7
		 * @param string $message
		 * @return string
		 */
		function process_email_text( $message ) {

			//$message = strip_tags( $message );

			// Decode body
			$message = wp_specialchars_decode( $message, ENT_QUOTES );

			// Add plain-text template to message
			$message = $this->set_email_template( $message, 'plaintext_template' );

			// Replace variables in email
			$message = apply_filters( 'wpbe_plaintext_body', $this->template_vars_replacement( $message ) );

			return $message;
		}

		/**
		 * Process the HTML version of the message
		 *
		 * @since 0.2.7
		 * @param string $message
		 * @return string
		 */
		function process_email_html( $message ) {

			// Clean < and > around text links in WP 3.1
			$message = $this->esc_textlinks( $message );

			// Convert line breaks
			if( apply_filters( 'wpbe_convert_line_breaks', true ) ) {
				$message = nl2br( $message );
			}

			// Convert URLs to links
			if( apply_filters( 'wpbe_convert_urls', true ) ) {
				$message = make_clickable( $message );
			}

			// Add template to message
			$message = $this->set_email_template( $message );

			// Replace variables in email
			$message = apply_filters( 'wpbe_html_body', $this->template_vars_replacement( $message ) );

			return $message;

		}

		/**
		 * Replaces the < & > of the 3.1 email text links
		 *
		 * @since 0.1.2
		 * @param string $body
		 * @return string
		 */
		function esc_textlinks( $body ) {
			return preg_replace( '#<(https?://[^*]+)>#', '$1', $body );
		}

		/**
		 * Help on template variables in contextual help
		 *
		 * @since 0.2
		 */
		function add_help_tab() {
			$screen = get_current_screen();

			ob_start();
			require 'views/help.php';
			$content = ob_get_clean();

			$screen->add_help_tab([
				'id' => 'wpbe_help',
				'title' => 'Template help',
				'content' => $content,
			]);
		}

		/**
		 * TinyMCE plugins
		 *
		 * Editing HTML emails requires some more plugins from TinyMCE:
		 *  - fullpage to handle html, meta, body tags
		 *  - codemirror for editing source
		 *
		 * @since 0.2
		 * @param array $external_plugins
		 * @return array
		 */
		function tinymce_plugins( $external_plugins ) {
			$external_plugins['codemirror'] = plugins_url('dist/js/plugins/codemirror/plugin.js', __FILE__);
			$external_plugins['fullpage'] = plugins_url('dist/js/plugins/fullpage.js', __FILE__);
			return $external_plugins;
		}

		/**
		 * Button to the TinyMCE toolbar
		 *
		 * @since 0.2
		 * @global string $page
		 * @global type $page_hook
		 * @param type $buttons
		 * @return type
		 */
		function tinymce_buttons( $buttons ) {
			array_push( $buttons, 'code' );
			return $buttons;
		}

		/**
		 * Prevent TinyMCE from removing line breaks
		 *
		 * @param array $init
		 * @return boolean
		 */
		function tinymce_config( $init ) {
			// $init['remove_linebreaks'] = false;

			if ( isset( $init['extended_valid_elements'] ) ) {
				$init['extended_valid_elements'] = $init['extended_valid_elements'] . ',td[*]';
			}

			return $init;
		}

		/**
		 * Print WP TinyMCE editor to edit template
		 *
		 * @since 0.2
		 * @global string $wp_version
		 */
		function template_editor() {
			wp_editor( $this->options['template'], 'wpbe_template', [
				'wpautop'       => false,
				'editor_class'  => 'wpbe_template',
				'quicktags'     => false,
				'textarea_name' => 'wpbe_options[template]'
			] );
		}

		/**
		 * Print plain-text textarea field to edit template.
		 *
		 * @since 0.2.x
		 */
		function plaintext_template_editor() {
?>
			<textarea id="wpbe_plaintext_template" class="wpbe_template" name="wpbe_options[plaintext_template]" cols="120" rows="10"><?php echo $this->options['plaintext_template']; ?></textarea>
		<?php
		}

	}

}

if ( class_exists( 'WP_Better_Emails' ) ) {
	$wp_better_emails = new WP_Better_Emails();
	register_activation_hook( __FILE__, array( $wp_better_emails, 'activate' ) );
}