Move emogrifier to separate module.

Installation

------------

If available, the libraries module will be used to locate the emogrifier.php

file.  See http://drupal.org/project/libraries for further information.

If available, the pathologic filter will be used to convert relative urls to

absolute urls  This is especially important if you format your emails with a

drupal theme (see below.)

Install as usual; see http://drupal.org/node/895232 for further information.

Theming

-----------

Chris Herberte - http://drupal.org/user/1171

Bob Vincent - http://drupal.org/user/36148

<?php

/**

 * @file

 * Wrapper for the Emogrifier library.

 * @see http://www.pelagodesign.com/sidecar/emogrifier/

 * Emogrifier converts CSS stylesheets to inline style attributes applied

 * to other HTML tags within the same $message, based on CSS selectors.

 *

 * @param string $message

 *   The message text.  Usually set to $message['body'].

 *

 * @return string $message

 *   The modified message text with inlined CSS applied.

 */

function _htmlmail_emogrify(&$message) {

  if ($emogrifier = &_htmlmail_emogrifier()) {

    $style = array();

    // Pull Drupal-generated linked stylesheets with media="all".

    $link_re = "@<link type=\"text/css\" rel=\"stylesheet\" href=\"(.*)\" media=\"all\" />@Usi";

    if (preg_match_all($link_re, $message, $matches)) {

      foreach ($matches[1] as $url) {

        $response = drupal_http_request($url);

        if (empty($response->error)) {

          $style[] = $response->data;

        }

      }

      $message = str_replace($matches[0], '', $message);

    }

    // Pull out the contents of any style tags.

    $style_re = '@<style[^>]*>\s*?(<!--)??\s*?(.*)\s*?(-->)??\s*?</style>@Usi';

    if (preg_match_all($style_re, $message, $matches)) {

      $style = array_merge($style, $matches[2]);

      // Remove the (now redundant) rules to reduce overall filesize.

      $message = str_replace($matches[0], '', $message);

    }

    // Get rid of comments and whitespace.

    $style = preg_replace(array("/[[:space:]]+/", '#/\*.*?\*/#', '/ +/'), ' ', $style);

    // Emogrify can't handle several CSS rules on one line. As a precaution,

    // we therefore insert LF after each closing bracket.

    $style = preg_replace('/}\s*/', "}\n", implode("\n", $style));

    // Get and reset error levels so we dont get DOMDocument::loadHTML() errors.

    $errorlevel = error_reporting(0);

    // Inline the CSS rules.

    $emogrifier->setHTML($message);

    $emogrifier->setCSS($style);

    $message = $emogrifier->emogrify();

    error_reporting($errorlevel);

  }

  return $message;

}

/**

 * Returns an instance of the Emogrifier class, if available.

 * If needed, loads the appropriate class file.

 *

 * @param &$paths = array()

 *   Additional paths relative to DRUPAL_ROOT to search for the emogrifier.php

 *   library. A default set of search paths will be added.

 *

 * @return

 *   An instance of the Emogrifier class if available, else FALSE.

 */

function &_htmlmail_emogrifier(&$paths = array()) {

  $emogrifier = FALSE;

  if (!is_array($paths)) {

    if (!empty($paths)) {

      $paths = array($paths);

    }

    else {

      $paths = array();

    }

  }

  if (class_exists('Emogrifier')) {

    $emogrifier = new Emogrifier();

  }

  elseif (extension_loaded('dom')) {

    $search = array_flip($paths);

    $search['sites/all/libraries/emogrifier'] = -1;

    $search[drupal_get_path('module', 'htmlmail') . '/emogrifier'] = -2;

    if (function_exists('libraries_get_path')) {

      $search[libraries_get_path('emogrifier')] = -3;

    }

    $paths = array_flip($search);

    ksort($paths);

    foreach ($paths as $dir) {

      if (is_file("$dir/emogrifier.php")) {

        include_once "$dir/emogrifier.php";

        if (class_exists('Emogrifier')) {

          $emogrifier = new Emogrifier();

          break;

        }

      }

    }

  }

  return $emogrifier;

}

<?php

/**

 * @file

 * CSS to Inline Converter Class

 */

/*

Emogrifier is provided under the terms of the MIT license:

1: http://www.opensource.org/licenses/mit-license.php

2: http://en.wikipedia.org/wiki/MIT_License

=============================================================================

THE EMOGRIFIER LICENSE

Copyright (c) 2008-2009 Pelago (http://www.pelagodesign.com/)

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.

UPDATES

    2008-08-10  Fixed CSS comment stripping regex to add PCRE_DOTALL (changed from '/\/\*.*\*\//U' to '/\/\*.*\*\//sU')

    2008-08-18  Added lines instructing DOMDocument to attempt to normalize HTML before processing

    2008-10-20  Fixed bug with bad variable name... Thanks Thomas!

    2008-03-02  Added licensing terms under the MIT License; Only remove unprocessable HTML tags if they exist in the array

*/

class Emogrifier {

    private $html = '';

    private $css = '';

    private $unprocessableHTMLTags = array('wbr');

    public function __construct($html = '', $css = '') {

        $this->html = $html;

        $this->css  = $css;

    }

    public function setHTML($html = '') { $this->html = $html; }

    public function setCSS($css = '') { $this->css = $css; }

	// there are some HTML tags that DOMDocument cannot process, and will throw an error if it encounters them.

	// these functions allow you to add/remove them if necessary.

	// it only strips them from the code (does not remove actual nodes).

    public function addUnprocessableHTMLTag($tag) { $this->unprocessableHTMLTags[] = $tag; }

    public function removeUnprocessableHTMLTag($tag) {

        if (($key = array_search($tag,$this->unprocessableHTMLTags)) !== false)

            unset($this->unprocessableHTMLTags[$key]);

    }

    // applies the CSS you submit to the html you submit. places the css inline

	public function emogrify() {

	    $body = $this->html;

	    // process the CSS here, turning the CSS style blocks into inline css

	    if (count($this->unprocessableHTMLTags)) {

            $unprocessableHTMLTags = implode('|',$this->unprocessableHTMLTags);

            $body = preg_replace("/<($unprocessableHTMLTags)[^>]*>/i",'',$body);

	    }

		$xmldoc = new DOMDocument();

		$xmldoc->strictErrorChecking = false;

		$xmldoc->formatOutput = true;

		$xmldoc->loadHTML($body);

		$xmldoc->normalizeDocument();

		$xpath = new DOMXPath($xmldoc);

		// get rid of css comment code

		$re_commentCSS = '/\/\*.*\*\//sU';

		$css = preg_replace($re_commentCSS,'',$this->css);

		// process the CSS file for selectors and definitions

		$re_CSS = '/^\s*([^{]+){([^}]+)}/mis';

		preg_match_all($re_CSS,$css,$matches);

		foreach ($matches[1] as $key => $selectorString) {

		    // if there is a blank definition, skip

		    if (!strlen(trim($matches[2][$key]))) continue;

		    // split up the selector

		    $selectors = explode(',',$selectorString);

		    foreach ($selectors as $selector) {

		        // don't process pseudo-classes

		        if (strpos($selector,':') !== false) continue;

		        // query the body for the xpath selector

		        $nodes = $xpath->query($this->translateCSStoXpath(trim($selector)));

		        foreach($nodes as $node) {

		            // if it has a style attribute, get it, process it, and append (overwrite) new stuff

		            if ($node->hasAttribute('style')) {

		                $style = $node->getAttribute('style');

		                // break it up into an associative array

		                $oldStyleArr = $this->cssStyleDefinitionToArray($node->getAttribute('style'));

		                $newStyleArr = $this->cssStyleDefinitionToArray($matches[2][$key]);

		                // new styles overwrite the old styles (not technically accurate, but close enough)

		                $combinedArr = array_merge($oldStyleArr,$newStyleArr);

		                $style = '';

		                foreach ($combinedArr as $k => $v) $style .= ($k . ':' . $v . ';');

		            } else {

		                // otherwise create a new style

		                $style = trim($matches[2][$key]);

		            }

		            $node->setAttribute('style',$style);

		        }

		    }

		}

		// This removes styles from your email that contain display:none;. You could comment these out if you want.

        $nodes = $xpath->query('//*[contains(translate(@style," ",""),"display:none;")]');

        foreach ($nodes as $node) $node->parentNode->removeChild($node);

		return $xmldoc->saveHTML();

	}

	// right now we only support CSS 1 selectors, but include CSS2/3 selectors are fully possible.

	// http://plasmasturm.org/log/444/

	private function translateCSStoXpath($css_selector) {

	    // returns an Xpath selector

	    $search = array(

	                       '/\s+>\s+/', // Matches any F element that is a child of an element E.

	                       '/(\w+)\s+\+\s+(\w+)/', // Matches any F element that is a child of an element E.

	                       '/\s+/', // Matches any F element that is a descendant of an E element.

	                       '/(\w+)?\#([\w\-]+)/e', // Matches id attributes

	                       '/(\w+)?\.([\w\-]+)/e', // Matches class attributes

	    );

	    $replace = array(

	                       '/',

	                       '\\1/following-sibling::*[1]/self::\\2',

	                       '//',

	                       "(strlen('\\1') ? '\\1' : '*').'[@id=\"\\2\"]'",

	                       "(strlen('\\1') ? '\\1' : '*').'[contains(concat(\" \",@class,\" \"),concat(\" \",\"\\2\",\" \"))]'",

	    );

	    return '//'.preg_replace($search,$replace,trim($css_selector));

	}

	private function cssStyleDefinitionToArray($style) {

	    $definitions = explode(';',$style);

	    $retArr = array();

	    foreach ($definitions as $def) {

    	    list($key,$value) = explode(':',$def);

    	    if (empty($key) || empty($value)) continue;

    	    $retArr[trim($key)] = trim($value);

	    }

	    return $retArr;

	}

}

?>

 No newline at end of file

    '#options' => $formats,

    '#description' => t('Choose a <a href="/admin/config/content/formats">text format</a> to be used for filtering email messages <em>after</em> the selected theme or template is applied.'),

  );

  // @todo Move to a separate filter module.

  $disabled = module_load_include('inc', 'htmlmail', 'emogrifier/emogrifier')

    && (_htmlmail_emogrifier() === FALSE);

  $form['htmlmail_emogrifier'] = array(

    '#type' => 'checkbox',

    '#title' => t('Emogrifier'),

    '#default_value' => $disabled ? 0 : variable_get('htmlmail_emogrifier', '0'),

    '#description' => t('Insert your CSS definitions as inline styles into HTML tags for Outlook 2007 and Google Gmail.<br /><em>Checkbox will be disabled if the !e library is not available.</em>', array('!e' => 'emogrifier.php')),

    '#disabled' => $disabled,

  );

  $form['htmlmail_debug'] = array(

    '#type' => 'checkbox',

    '#title' => t('Debug'),

  return system_settings_form($form);

}

// @todo Move to a separate UI module.

function htmlmail_admin_settings_submit($form, &$form_state) {

  $mail_system = array(

    'default-system' => (

      empty($form_state['values']['default-system'])

      ? 'DefaultMailSystem'

      : $form_state['values']['default-system']

    )

  );

  foreach (system_rebuild_module_data() as $key => $module) {

    if ($module->status && isset($form_state['values'][$key])) {

      if (!empty($form_state['values'][$key])) {

        $mail_system[$key] = $form_state['values'][$key];

      }

      unset($form_state['values'][$key]);

    }

  }

  variable_set('mail_system', $mail_system);

}

/**

 * Builds a form for setting Header, Footer, and CSS content to be included in

 * sent emails.

  db_query("DELETE FROM {variable} WHERE name LIKE 'htmlmail_%'");

  cache_clear_all('variables', 'cache');

}

/**

 * Implements hook_requirements().

 */

function htmlmail_requirements($phase) {

  $requirements = array();

  if ($phase == 'runtime') {

    $libraries = module_exists('libraries');

    $requirements['libraries'] = array(

      'title' => 'Libraries module',

      'value' => $libraries ? 'Enabled' : 'Disabled',

      'severity' => $libraries ? REQUIREMENT_OK : REQUIREMENT_WARNING,

    );

    $dom = extension_loaded('dom');

    $requirements['dom'] = array(

      'title' => 'DOM extension',

      'value' => $dom ? 'Enabled' : 'Disabled',

      'description' => t(

        'The %d extension must be loaded before %e can be used with the %m module.',

        array(

          '%d' => 'dom',

          '%e' => 'emogrifier',

          '%m' => 'htmlmail'

        )

      ),

      'severity' => $dom ? REQUIREMENT_OK : REQUIREMENT_WARNING,

    );

    $transliteration = function_exists('transliteration_get');

    $requirements['transliteration'] = array(

      'title' => 'Transliteration module',

      'value' => $transliteration ? 'Enabled' : 'Disabled',

      'description' => t(

        'The %m module optionally uses the %t module to ensure consistent display on mobile devices.',

        array(

          '%m' => 'htmlmail',

          '%t' => 'transliteration'

        )

      ),

      'severity' => $transliteration ? REQUIREMENT_OK : REQUIREMENT_WARNING,

    );

    $pathologic = (module_exists('pathologic') && function_exists('_pathologic'));

    $requirements['pathologic'] = array(

      'title' => 'Pathologic module',

      'value' => $pathologic ? 'Enabled' : 'Disabled',

      'description' => t(

        'The %m module optionally uses the %p module to urls from relative to absolute form so that linked content is available to email recipients.',

        array(

          '%m' => 'htmlmail',

          '%p' => 'pathologic'

        )

      ),

      'severity' => $pathologic ? REQUIREMENT_OK : REQUIREMENT_WARNING,

    );

    if (module_load_include('inc', 'htmlmail', 'emogrifier/emogrifier')) {

      $paths = array();

      $emogrifier = _htmlmail_emogrifier($paths) !== FALSE;

      $requirements['emogrifier'] = array(

        'title' => 'Emogrifier class',

        'value' =>  $emogrifier ? 'Available' : 'Unavailable',

        'description' => t(

          "The %m module optionally uses the %l library to convert CSS to inline styles for more consistent display on webmail and mobile devices.  The following directories were searched: !p",

          array(

            '%m' => 'htmlmail',

            '%l' => 'emogrifier.php',

            '!p' => '<ul><li>' . implode('</li><li>', $paths) . '</li></ul>',

          )

        ),

        'severity' => $emogrifier ? REQUIREMENT_OK : REQUIREMENT_WARNING,

      );

    }

  }

  return $requirements;

}