classes/plmailer.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2010 Polytechnique.org                              *
   4  *  http://opensource.polytechnique.org/                                   *
   5  *                                                                         *
   6  *  This program is free software; you can redistribute it and/or modify   *
   7  *  it under the terms of the GNU General Public License as published by   *
   8  *  the Free Software Foundation; either version 2 of the License, or      *
   9  *  (at your option) any later version.                                    *
  10  *                                                                         *
  11  *  This program is distributed in the hope that it will be useful,        *
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
  14  *  GNU General Public License for more details.                           *
  15  *                                                                         *
  16  *  You should have received a copy of the GNU General Public License      *
  17  *  along with this program; if not, write to the Free Software            *
  18  *  Foundation, Inc.,                                                      *
  19  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  20  ***************************************************************************/
  21
  22 require_once('smarty/libs/Smarty.class.php');
  23
  24 /** Classe de mail avec corps en templates.
  25  */
  26 class PlMail extends Smarty
  27 {
  28     private $tpl;
  29     private $mailer = null;
  30
  31     function __construct($tpl)
  32     {
  33         global $globals;
  34         $this->tpl           = $tpl;
  35         $this->caching       = false;
  36         $this->compile_check = true;
  37
  38         $this->template_dir  = $globals->spoolroot . "/templates/";
  39         $this->compile_dir   = $globals->spoolroot . "/spool/mails_c/";
  40         $this->config_dir    = $globals->spoolroot . "/configs/";
  41         array_unshift($this->plugins_dir, $globals->spoolroot."/plugins/");
  42
  43         $this->register_outputfilter(Array($this, 'mail_format'));
  44         $this->register_function('from',    Array($this, 'setFrom'));
  45         $this->register_function('to',      Array($this, 'addTo'));
  46         $this->register_function('cc',      Array($this, 'addCc'));
  47         $this->register_function('bcc',     Array($this, 'addBcc'));
  48         $this->register_function('subject', Array($this, 'setSubject'));
  49         $this->register_function('add_header', Array($this, 'addHeader'));
  50         $this->assign_by_ref('globals', $globals);
  51     }
  52
  53     public static function &get(&$mailer, $tpl)
  54     {
  55         static $plmail;
  56         if (!isset($plmail) || $plmail->tpl != $tpl) {
  57             $plmail = new PlMail($tpl);
  58         }
  59         $plmail->mailer =& $mailer;
  60         return $plmail;
  61     }
  62
  63     public function run($version)
  64     {
  65         $this->assign('mail_part', $version);
  66         $text = $this->fetch($this->tpl);
  67         if ($version == 'text') {
  68             return wordwrap($text, 78);
  69         }
  70         return $text;
  71     }
  72
  73     /** used to remove the empty lines due to {from ...}, {to ...} ... functions */
  74     static public function mail_format($output, &$smarty)
  75     {
  76         return "\n".trim($output)."\n";
  77     }
  78
  79     static protected function format_addr(&$params)
  80     {
  81         if (isset($params['full'])) {
  82             return $params['full'];
  83         } elseif (empty($params['text'])) {
  84             return $params['addr'];
  85         } else {
  86             return $params['text'].' <'.$params['addr'].'>';
  87         }
  88     }
  89
  90     /** template function : from.
  91      * {from full=...} for an already formatted address
  92      * {from addr=... [text=...]} else
  93      */
  94     public function setFrom($params, &$smarty)
  95     {
  96         $smarty->mailer->setFrom(PlMail::format_addr($params));
  97     }
  98
  99     /** template function : to.
 100      * {to full=...} for an already formatted address
 101      * {to addr=... [text=...]} else
 102      */
 103     public function addTo($params, &$smarty)
 104     {
 105         $smarty->mailer->addTo(PlMail::format_addr($params));
 106     }
 107
 108     /** template function : cc.
 109      * {cc full=...} for an already formatted address
 110      * {cc addr=... [text=...]} else
 111      */
 112     public function addCc($params, &$smarty)
 113     {
 114         $smarty->mailer->addCc(PlMail::format_addr($params));
 115     }
 116
 117     /** template function : bcc.
 118      * {bcc full=...} for an already formatted address
 119      * {bcc addr=... [text=...]} else
 120      */
 121     public function addBcc($params, &$smarty)
 122     {
 123         $smarty->mailer->addBcc(PlMail::format_addr($params));
 124     }
 125
 126     /** template function : subject.
 127      * {subject text=...}
 128      */
 129     public function setSubject($params, &$smarty)
 130     {
 131         $smarty->mailer->setSubject($params['text']);
 132     }
 133
 134     /** template function : add_header.
 135      * {add_header name=... value=...}
 136      */
 137     public function addHeader($params, &$smarty)
 138     {
 139         $smarty->mailer->addHeader($params['name'], $params['value']);
 140     }
 141 }
 142
 143 require_once('Mail.php');
 144 require_once('Mail/mime.php');
 145
 146 /** Class for sending inline or multipart-emails.
 147  * Based on Diogenes' HermesMailer
 148  */
 149 class PlMailer extends Mail_Mime {
 150
 151     private $mail;
 152     private $page    = null;
 153     private $charset;
 154     private $wiki    = null;
 155
 156     function __construct($tpl = null, $charset = "UTF-8")
 157     {
 158         $this->charset = $charset;
 159         $this->Mail_Mime("\n");
 160         $this->mail = Mail::factory('sendmail', Array('sendmail_args' => '-oi'));
 161         if (!is_null($tpl)) {
 162             $this->page =& PlMail::get($this, $tpl);
 163         }
 164     }
 165
 166     static private function formatUser(PlUser $user)
 167     {
 168         return '"' . $user->fullName() . '" <' . $user->bestEmail() . '>';
 169     }
 170
 171     /**
 172      * converts all : Foo Bar Baz <quux@foobar.org> into "Foo Bar Baz" <quux@foobar.org> which is RFC compliant
 173      */
 174     private function correct_emails($email)
 175     {
 176         if ($email instanceof PlUser) {
 177             $email = self::formatUser($email);
 178         }
 179         $email = preg_replace('!(^|, *)([^<"]+?) *(<[^>]*>)!u',
 180                               '\1 "\2" \3', $email);
 181         return preg_replace('/"([^<]+)"/e',
 182                             '"\\"" . PlMailer::encodeStringQP("\1") . "\\""',
 183                             $email);
 184     }
 185
 186     public function addTo($email)
 187     {
 188         $email = $this->correct_emails($email);
 189         if (isset($this->_headers['To'])) {
 190             $this->_headers['To'] .= ", $email";
 191         } else {
 192             $this->_headers['To'] = $email;
 193         }
 194     }
 195
 196     public function setTo($email)
 197     {
 198         $email = $this->correct_emails($email);
 199         $this->_headers['To'] = $email;
 200     }
 201
 202     public function addCc($email)
 203     {
 204         return parent::addCc($this->correct_emails($email));
 205     }
 206
 207     public function addBcc($email)
 208     {
 209         return parent::addBcc($this->correct_emails($email));
 210     }
 211
 212     public function setFrom($email)
 213     {
 214         return parent::setFrom($this->correct_emails($email));
 215     }
 216
 217     static function encodeStringQP($string)
 218     {
 219         if (!preg_match('/^[\x20-\x7e]*$/', $string)) {
 220             $string = '=?UTF-8?Q?' . preg_replace('/[^\x21-\x3C\x3e\x40-\x7e]/e', 'PlMailer::encodeQP("\0")', $string)
 221                      . '?=';
 222         }
 223         return $string;
 224     }
 225
 226
 227     static function encodeQP($char)
 228     {
 229         return sprintf('=%02X', ord($char));
 230     }
 231
 232     public function setSubject($subject)
 233     {
 234         return parent::setSubject(self::encodeStringQP($subject));
 235     }
 236
 237     public function addHeader($hdr,$val)
 238     {
 239         switch($hdr) {
 240             case 'From':
 241                 $this->setFrom($val);
 242                 break;
 243
 244             case 'To':
 245                 unset($this->_headers[$hdr]);
 246                 $this->addTo($val);
 247                 break;
 248
 249             case 'Cc':
 250                 unset($this->_headers[$hdr]);
 251                 $this->addCc($val);
 252                 break;
 253
 254             case 'Bcc':
 255                 unset($this->_headers[$hdr]);
 256                 $this->addBcc($val);
 257                 break;
 258
 259             default:
 260                 $this->headers(Array($hdr=>$val));
 261         }
 262     }
 263
 264     public function addUploadAttachment(PlUpload &$upload, $name)
 265     {
 266         $encoding = $upload->isType('text') ? 'quoted-printable' : 'base64';
 267         $this->addAttachment($upload->getContents(), $upload->contentType(), $name, false, $encoding);
 268     }
 269
 270     public function assign($var, $value)
 271     {
 272         if (!is_null($this->page)) {
 273             $this->page->assign($var, $value);
 274         }
 275     }
 276
 277     public function assign_by_ref($var, &$value)
 278     {
 279         if (!is_null($this->page)) {
 280             $this->page->assign_by_ref($var, $value);
 281         }
 282     }
 283
 284     public function register_modifier($var, $callback)
 285     {
 286         if (!is_null($this->page)) {
 287             $this->page->register_modifier($var, $callback);
 288         }
 289     }
 290
 291     public function register_function($var, $callback)
 292     {
 293         if (!is_null($this->page)) {
 294             $this->page->register_function($var, $callback);
 295         }
 296     }
 297
 298     public function setWikiBody($wiki)
 299     {
 300         $this->wiki = $wiki;
 301     }
 302
 303     private function processPage($with_html = true)
 304     {
 305         if (!is_null($this->page)) {
 306             global $globals;
 307             if (!($globals->debug & DEBUG_SMARTY)) {
 308                 $level = error_reporting(0);
 309             }
 310             $this->page->assign_by_ref('globals', $globals);
 311             $this->page->run('head'); // process page headers
 312             $this->wiki = trim($this->page->run('wiki')); // get wiki
 313             if (!$this->wiki) {
 314                 $this->setTxtBody($this->page->run('text'));
 315                 if ($with_html) {
 316                     $html = trim($this->page->run('html'));
 317                     if (!empty($html)) {
 318                         $this->setHtmlBody($html);
 319                     }
 320                 }
 321             }
 322             if (!($globals->debug & DEBUG_SMARTY)) {
 323                 error_reporting($level);
 324             }
 325         }
 326         if ($this->wiki) {
 327             $this->setTxtBody(MiniWiki::WikiToText($this->wiki, false, 0, 78));
 328             if ($with_html) {
 329                 $this->setHtmlBody('<html><body>' . MiniWiki::WikiToHtml($this->wiki, true) . '</body></html>');
 330             }
 331         }
 332     }
 333
 334     public function sendTo(PlUser &$user)
 335     {
 336         $this->setTo($user);
 337         $this->assign_by_ref('user', $user);
 338         return $this->send($user->isEmailFormatHtml());
 339     }
 340
 341     public function send($with_html = true)
 342     {
 343         $this->processPage($with_html);
 344         if (S::user()) {
 345             $this->addHeader('X-Org-Mail', S::user()->forlifeEmail());
 346         }
 347         $addrs = Array();
 348         foreach (Array('To', 'Cc', 'Bcc') as $hdr) {
 349             if (isset($this->_headers[$hdr])) {
 350                 require_once 'Mail/RFC822.php';
 351                 $parsed = @Mail_RFC822::parseAddressList($this->_headers[$hdr]);
 352                 if (is_array($parsed)) {
 353                     $addrs = array_merge($addrs, $parsed);
 354                 }
 355             }
 356         }
 357         if (empty($addrs)) {
 358             return false;
 359         }
 360
 361         $dests = Array();
 362         foreach ($addrs as $a) {
 363             $dests[] = "{$a->mailbox}@{$a->host}";
 364         }
 365
 366         // Support for a "catch-all" email address, to be used by developers.
 367         // This mode can only be activated when the working copy is in restricted
 368         // mode, to ensure that production plat/al copies are never affected.
 369         global $globals;
 370         if ($globals->email_catchall && $globals->core->restricted_platal) {
 371             require_once 'Mail/RFC822.php';
 372             if (@Mail_RFC822::isValidInetAddress($globals->email_catchall)) {
 373                 $dests = array($globals->email_catchall);
 374             }
 375         }
 376
 377         // very important to do it in THIS order very precisely.
 378         $body = $this->get(array('text_charset' => $this->charset,
 379                                  'text_encoding' => '8bit',
 380                                  'html_charset' => $this->charset,
 381                                  'head_charset' => $this->charset));
 382         $hdrs = $this->headers();
 383         if (empty($hdrs['From'])) {
 384             trigger_error('Empty "From", mail not sent', E_USER_WARNING);
 385             return false;
 386         }
 387         return $this->mail->send($dests, $hdrs, $body);
 388     }
 389 }
 390
 391 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 392 ?>