lib/phpmailer MDL-20701 - Convert to moodle_phpmailer class

Stage 2 - We now extend phpmailer and do our customisations in our subclass
rather than directly in the original file.

Previously we modified SetLanguage(), but I have not carried that change over
because I could not see code paths where this gets executed.(See bug)

I tested the header/content of the old class vs this one and think the changes
are all carried over. (If anyone has clever thoughts for how to unit test this
mailing out it would be useful, especially for upgrading phpmailer).

lib/moodlelib.php

@@ -4416,8 +4416,8 @@ function &get_mailer($action='get') {
             get_mailer('flush');
         }
 
-        include_once($CFG->libdir.'/phpmailer/class.phpmailer.php');
-        $mailer = new phpmailer();
+        include_once($CFG->libdir.'/phpmailer/moodle_phpmailer.php');
+        $mailer = new moodle_phpmailer();
 
         $counter = 1;
 

lib/phpmailer/README_MOODLE.txt

@@ -1,12 +1,11 @@
-Description of PHPMailer 1.73 library import into Moodle
+Description of PHPMailer 5.1 library import into Moodle
 
-Changes:
+We now use a vanilla version of phpmailer and do our customisations in a
+subclass.
 
-class.phpmailer.php
- * Duplicate Message-IDs in Forum mail (MDL-3681)
- * Support for gb18030 (MDL-5229)
- * Correct timezone in date (MDL-12596)
- * Backported fixes for CVE-2007-3215 (MDL-18348)
- * Custom EncodeHeader() to allow multibyte subjects (textlib). Seems that current phpmailer version (2.3) has it properly implemented (though dependent of mbstring).
- * Custom constructor PHPMailer()
- * Custom SetLanguage() function
+When doing the import we remove directories/files:
+aboutus.html
+class.pop3.php
+docs/
+examples/
+test/

lib/phpmailer/moodle_phpmailer.php

@@ -0,0 +1,107 @@
+<?php
+
+/**
+ * Moodle - Modular Object-Oriented Dynamic Learning Environment
+ *          http://moodle.org
+ * Copyright (C) 1999 onwards Martin Dougiamas  http://dougiamas.com
+ *
+ * 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, see <http://www.gnu.org/licenses/>.
+ *
+ * @package    moodle
+ * @subpackage lib
+ * @author     Dan Poltawski <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ *
+ * Customised version of phpmailer for Moodle
+ */
+
+// PLEASE NOTE: we use the phpmailer class _unmodified_
+// through the joys of OO. Distros are free to use their stock
+// version of this file.
+require_once($CFG->libdir.'/phpmailer/class.phpmailer.php');
+
+/**
+ * Moodle Customised version of the PHPMailer class
+ *
+ * This class extends the stock PHPMailer class
+ * in order to make sensible configuration choices,
+ * and behave in a way which is friendly to moodle.
+ *
+ * @copyright 2009 Dan Poltawski <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @since     Moodle 2.0
+ */
+class moodle_phpmailer extends PHPMailer {
+
+    /**
+     * Constructor - creates an instance of the PHPMailer class
+     * with Moodle defaults.
+     */
+    public function __construct(){
+        global $CFG;
+        $this->Version   = 'Moodle '.$CFG->version;         // mailer version
+        $this->PluginDir = $CFG->libdir.'/phpmailer/';      // plugin directory (eg smtp plugin)
+        $this->CharSet   = 'UTF-8';
+    }
+
+    /**
+     * Extended AddCustomHeader function in order to stop duplicate 
+     * message-ids
+     * http://tracker.moodle.org/browse/MDL-3681
+     */
+    public function AddCustomHeader($custom_header) {
+        if(preg_match('/message-id:(.*)/i', $custom_header, $matches)){
+            $this->MessageID = $matches[1];
+            return true;
+        }else{
+            return parent::AddCustomHeader($custom_header);
+        }
+    }
+
+    /**
+     * Use internal moodles own textlib to encode mimeheaders.
+     * Fall back to phpmailers inbuilt functions if not 
+     */
+    public function EncodeHeader ($str, $position = 'text') {
+        $textlib = textlib_get_instance();
+        $encoded = $textlib->encode_mimeheader($str, $this->CharSet);
+        if ($encoded !== false) {
+            $encoded = str_replace("\n", $this->LE, $encoded);
+            if ($position == 'phrase') {
+                return ("\"$encoded\"");
+            }
+            return $encoded;
+        }
+
+        return parent::EncodeHeader($str, $position);
+    }
+
+    /**
+     * Replaced function to fix tz bug:
+     * http://tracker.moodle.org/browse/MDL-12596
+     *
+     * PLEASE NOTE: intentionally not declared this function public in 
+     * order that we keep compatibiltiy with previous versions of phpmailer 
+     * where it was declared private.
+     */
+    static function RFCDate() {
+        $tz = date('Z');
+        $tzs = ($tz < 0) ? '-' : '+';
+        $tz = abs($tz);
+        $tz = (($tz - ($tz%3600) )/3600)*100 + ($tz%3600)/60; // fixed tz bug
+        $result = sprintf("%s %s%04d", date('D, j M Y H:i:s'), $tzs, $tz);
+
+        return $result;
+    }
+}