Create a sendmail library to wrap the call to the system sendmail

facility. Something quirky is happening in the first test, see comment
in code, but I couldn't figure it out.  Left a @todo for now.

3 files changed, 230 insertions, 0 deletions

diff --git a/core/config/sendmail.php b/core/config/sendmail.php
new file mode 100644
index 00000000..ac1bdb1a
--- /dev/null
+++ b/core/config/sendmail.php
@@ -0,0 +1,28 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2008 Bharat Mediratta
+ *
+ * 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.
+ */
+/**
+ * PHP Mail Configuration parameters
+ * from        => email address that appears as the from address
+ * line-length => word wrap length
+ * reply-to    => what goes into the reply to header
+ */
+$config["from"] = "admin@gallery3.com";
+$config["line_length"] = 75;
+$config["reply_to"] = "public@gallery3.com";
diff --git a/core/libraries/Sendmail.php b/core/libraries/Sendmail.php
new file mode 100644
index 00000000..27efb1fd
--- /dev/null
+++ b/core/libraries/Sendmail.php
@@ -0,0 +1,102 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2008 Bharat Mediratta
+ *
+ * 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.
+ */
+class Sendmail_Core {
+  protected $to;
+  protected $subject;
+  protected $message;
+  protected $headers;
+  protected $line_length = 70;
+
+  /**
+   * In test mode this gets the message that would have been set
+   */
+  private $_send_text;
+
+  /**
+   * Return an instance of a Menu_Element
+   * @chainable
+   */
+  static function factory() {
+    return new Sendmail();
+  }
+
+  public function __construct() {
+    $this->headers = array();
+    $config = Kohana::config('sendmail');
+    foreach ($config as $key => $value) {
+      $this->$key($value);
+    }
+  }
+
+  public function __get($key) {
+    if (TEST_MODE && $key == "send_text") {
+      return $this->_send_text;
+    }
+    return null;
+  }
+
+  public function __call($key, $value) {
+    switch ($key) {
+    case "to":
+      $this->to = is_array($value) ? $value : array($value);
+      break;
+    case  "header":
+      if (count($value) != 2) {
+        throw new Exception("@todo INVALID HEADER PARAMETERS");
+      }
+      $this->headers[$value[0]] = $value[1];
+      break;
+    case "from":
+      $this->headers["From"] = $value[0];
+      break;
+    case "reply_to":
+      $this->headers["Reply-To"] = $value[0];
+      break;
+    default:
+      $this->$key = $value[0];
+    }
+    return $this;
+  }
+
+  public function send() {
+    if (empty($this->to)) {
+      throw new Exception("@todo TO IS REQUIRED FOR MAIL");
+    }
+    $to = implode(", ", $this->to);
+    $headers = array();
+    foreach ($this->headers as $key => $value) {
+      $key = ucfirst($key);
+      $headers[] = "$key: $value";
+    }
+    $headers = implode("\r\n", $headers);
+    $message = wordwrap($this->message, $this->line_length, "\r\n");
+
+    if (!TEST_MODE) {
+      if (!mail($to, $this->subject, $this->message, $headers)) {
+        Kohana::log("error", wordwrap("Sending mail failed:\nTo: $to\n $this->subject\n" .
+                                      "Headers: $headers\n $this->message"));
+        throw new Exception("@todo SEND MAIL FAILED");
+      }
+    } else {
+      $this->_send_text = "To: $to\r\n{$headers}\r\nSubject: $this->subject\r\n\r\n$message";
+    }
+    return $this;
+  }
+}
diff --git a/core/tests/Sendmail_Test.php b/core/tests/Sendmail_Test.php
new file mode 100644
index 00000000..fa9995e5
--- /dev/null
+++ b/core/tests/Sendmail_Test.php
@@ -0,0 +1,100 @@
+<?php defined("SYSPATH") or die("No direct script access.");
+/**
+ * Gallery - a web based photo album viewer and editor
+ * Copyright (C) 2000-2008 Bharat Mediratta
+ *
+ * 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.
+ */
+class Sendmail_Test extends Unit_Test_Case {
+  public function setup() {
+    $config = Kohana::config("sendmail");
+    $config["from"] = "from@gallery3.com";
+    Kohana::config_set("sendmail", $config);
+  }
+
+  public function sendmail_test() {
+    $expected = "To: receiver@someemail.com\r\n" .
+                "From: from@gallery3.com\r\n" .
+                "Reply-To: public@gallery3.com\r\n" .
+                "Subject: Test Email Unit test\r\n\r\n" .
+                "The mail message body";
+    $result = Sendmail::factory()
+      ->to("receiver@someemail.com")
+      /*
+       * @todo figure out why this test fails so badly, when the following
+       * line is not supplied. It doesn't seem to be set by setup method
+       * as you would expect.
+       */
+      ->from("from@gallery3.com")
+      ->subject("Test Email Unit test")
+      ->message("The mail message body")
+      ->send()->send_text;
+
+    $this->assert_equal($expected, $result);
+  }
+
+  public function sendmail_reply_to_test() {
+    $expected = "To: receiver@someemail.com\r\n" .
+                "From: from@gallery3.com\r\n" .
+                "Reply-To: reply-to@gallery3.com\r\n" .
+                "Subject: Test Email Unit test\r\n\r\n" .
+                "The mail message body";
+    $result = Sendmail::factory()
+      ->to("receiver@someemail.com")
+      ->subject("Test Email Unit test")
+      ->reply_to("reply-to@gallery3.com")
+      ->message("The mail message body")
+      ->send()->send_text;
+    $this->assert_equal($expected, $result);
+  }
+
+  public function sendmail_html_message_test() {
+    $expected = "To: receiver@someemail.com\r\n" .
+                "From: from@gallery3.com\r\n" .
+                "Reply-To: public@gallery3.com\r\n" .
+                "MIME-Version: 1.0\r\n" .
+                "Content-type: text/html; charset=iso-8859-1\r\n" .
+                "Subject: Test Email Unit test\r\n\r\n" .
+                "<html><body><p>This is an html msg</p></body></html>";
+    $result = Sendmail::factory()
+      ->to("receiver@someemail.com")
+      ->subject("Test Email Unit test")
+      ->header("MIME-Version", "1.0")
+      ->header("Content-type", "text/html; charset=iso-8859-1")
+      ->message("<html><body><p>This is an html msg</p></body></html>")
+      ->send()->send_text;
+    $this->assert_equal($expected, $result);
+  }
+
+  public function sendmail_wrapped_message_test() {
+    $expected = "To: receiver@someemail.com\r\n" .
+                "From: from@gallery3.com\r\n" .
+                "Reply-To: public@gallery3.com\r\n" .
+                "Subject: Test Email Unit test\r\n\r\n" .
+                "This is a long message that needs to go\r\n" .
+                "over forty characters If we get lucky we\r\n" .
+                "might make it long enought to wrap a\r\n" .
+                "couple of times.";
+    $result = Sendmail::factory()
+      ->to("receiver@someemail.com")
+      ->subject("Test Email Unit test")
+      ->line_length(40)
+      ->message("This is a long message that needs to go over forty characters " .
+                "If we get lucky we might make it long enought to wrap a couple " .
+                "of times.")
+      ->send()->send_text;
+    $this->assert_equal($expected, $result);
+  }
+}
\ No newline at end of file