From e5c4fc8eb9dd3b0761db7fe1ba4d098c686ba0fa Mon Sep 17 00:00:00 2001
From: =?utf8?q?Tim=20D=C3=BCsterhus?= <duesterhus@woltlab.com>
Date: Tue, 12 Feb 2019 19:41:49 +0100
Subject: [PATCH] Add DebugFolderEmailTransport

---
 com.woltlab.wcf/option.xml                    |  6 +-
 .../DebugFolderEmailTransport.class.php       | 62 +++++++++++++++++++
 .../PackageInstallationDispatcher.class.php   |  2 +-
 wcfsetup/install/lang/de.xml                  |  3 +-
 wcfsetup/install/lang/en.xml                  |  3 +-
 5 files changed, 71 insertions(+), 5 deletions(-)
 create mode 100644 wcfsetup/install/files/lib/system/email/transport/DebugFolderEmailTransport.class.php

diff --git a/com.woltlab.wcf/option.xml b/com.woltlab.wcf/option.xml
index 2b507ac1ac..00a14c6cbe 100644
--- a/com.woltlab.wcf/option.xml
+++ b/com.woltlab.wcf/option.xml
@@ -880,10 +880,12 @@ physical:wcf.acp.option.google_maps_type.physical</selectoptions>
 				<defaultvalue>php</defaultvalue>
 				<enableoptions>php:mail_use_f_param,!mail_smtp_host,!mail_smtp_port,!mail_smtp_starttls,!mail_smtp_user,!mail_smtp_password
 smtp:!mail_use_f_param,mail_smtp_host,mail_smtp_port,mail_smtp_starttls,mail_smtp_user,mail_smtp_password
-debug:!mail_use_f_param,!mail_smtp_host,!mail_smtp_port,!mail_smtp_starttls,!mail_smtp_user,!mail_smtp_password</enableoptions>
+debug:!mail_use_f_param,!mail_smtp_host,!mail_smtp_port,!mail_smtp_starttls,!mail_smtp_user,!mail_smtp_password
+debugFolder:!mail_use_f_param,!mail_smtp_host,!mail_smtp_port,!mail_smtp_starttls,!mail_smtp_user,!mail_smtp_password</enableoptions>
 				<selectoptions>php:wcf.acp.option.mail_send_method.php
 smtp:wcf.acp.option.mail_send_method.smtp
-debug:wcf.acp.option.mail_send_method.debug</selectoptions>
+debug:wcf.acp.option.mail_send_method.debug
+debugFolder:wcf.acp.option.mail_send_method.debugFolder</selectoptions>
 			</option>
 			<option name="mail_smtp_host">
 				<categoryname>general.mail.send</categoryname>
diff --git a/wcfsetup/install/files/lib/system/email/transport/DebugFolderEmailTransport.class.php b/wcfsetup/install/files/lib/system/email/transport/DebugFolderEmailTransport.class.php
new file mode 100644
index 0000000000..ead83a9a2c
--- /dev/null
+++ b/wcfsetup/install/files/lib/system/email/transport/DebugFolderEmailTransport.class.php
@@ -0,0 +1,62 @@
+<?php
+namespace wcf\system\email\transport;
+use wcf\system\email\Email;
+use wcf\system\email\Mailbox;
+use wcf\util\FileUtil;
+
+/**
+ * DebugFolderEmailTransport is a debug implementation of an email transport which writes emails into
+ * a folder.
+ * On unix-like operating systems the folder will be a valid Maildir.
+ * 
+ * @author	Tim Duesterhus
+ * @copyright	2001-2019 WoltLab GmbH
+ * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package	WoltLabSuite\Core\System\Email\Transport
+ * @since	5.2
+ */
+class DebugFolderEmailTransport implements IEmailTransport {
+	/**
+	 * folder
+	 * @var	string
+	 */
+	protected $folder = null;
+	
+	/**
+	 * Creates a new DebugFolderTransport using the given folder as target.
+	 * 
+	 * @param	string	$folder	folder or null for default folder
+	 */
+	public function __construct($folder = null) {
+		if ($folder === null) $folder = WCF_DIR.'log/Maildir';
+		
+		$this->folder = FileUtil::addTrailingSlash($folder);
+		FileUtil::makePath($this->folder);
+		if (PHP_EOL != "\r\n") {
+			FileUtil::makePath($this->folder.'new');
+			FileUtil::makePath($this->folder.'cur');
+			FileUtil::makePath($this->folder.'tmp');
+		}
+	}
+	
+	/**
+	 * Writes the given $email into the folder.
+	 * 
+	 * @param	Email		$email
+	 * @param	Mailbox		$envelopeFrom
+	 * @param	Mailbox		$envelopeTo
+	 */
+	public function deliver(Email $email, Mailbox $envelopeFrom, Mailbox $envelopeTo) {
+		$eml = "Return-Path: <".$envelopeFrom->getAddress().">\r\n";
+		$eml .= "Delivered-To: <".$envelopeTo->getAddress().">\r\n";
+		$eml .= $email->getEmail();
+		$eml .= "\r\n";
+		$timestamp = explode(' ', microtime());
+		$filename = $timestamp[1].'.M'.substr($timestamp[0], 2).'.eml';
+		file_put_contents($this->folder.$filename, $eml);
+		
+		if (PHP_EOL != "\r\n") {
+			symlink('../'.$filename, $this->folder.'new/'.$filename);
+		}
+	}
+}
diff --git a/wcfsetup/install/files/lib/system/package/PackageInstallationDispatcher.class.php b/wcfsetup/install/files/lib/system/package/PackageInstallationDispatcher.class.php
index 19018f1a19..a21ebf15d6 100644
--- a/wcfsetup/install/files/lib/system/package/PackageInstallationDispatcher.class.php
+++ b/wcfsetup/install/files/lib/system/package/PackageInstallationDispatcher.class.php
@@ -242,7 +242,7 @@ class PackageInstallationDispatcher {
 							'exception_privacy'
 						]);
 						$statement->execute([
-							'debug',
+							'debugFolder',
 							'mail_send_method'
 						]);
 						$statement->execute([
diff --git a/wcfsetup/install/lang/de.xml b/wcfsetup/install/lang/de.xml
index 22c7dd9480..fc4e01de8f 100644
--- a/wcfsetup/install/lang/de.xml
+++ b/wcfsetup/install/lang/de.xml
@@ -1278,7 +1278,8 @@
 		<item name="wcf.acp.option.mail_from_name"><![CDATA[Absender-Name]]></item>
 		<item name="wcf.acp.option.mail_from_name.description"><![CDATA[Absender-Name für automatisch generierte E-Mails]]></item>
 		<item name="wcf.acp.option.mail_send_method"><![CDATA[Versandmethode]]></item>
-		<item name="wcf.acp.option.mail_send_method.debug"><![CDATA[Debug]]></item>
+		<item name="wcf.acp.option.mail_send_method.debug"><![CDATA[Debug (mbox)]]></item>
+		<item name="wcf.acp.option.mail_send_method.debugFolder"><![CDATA[Debug (Ordner mit .eml-Dateien)]]></item>
 		<item name="wcf.acp.option.mail_send_method.php"><![CDATA[PHP]]></item>
 		<item name="wcf.acp.option.mail_send_method.smtp"><![CDATA[SMTP]]></item>
 		<item name="wcf.acp.option.mail_signature"><![CDATA[Signatur]]></item>
diff --git a/wcfsetup/install/lang/en.xml b/wcfsetup/install/lang/en.xml
index f68a58e968..ffe3bfc0f5 100644
--- a/wcfsetup/install/lang/en.xml
+++ b/wcfsetup/install/lang/en.xml
@@ -1255,7 +1255,8 @@
 		<item name="wcf.acp.option.mail_from_name"><![CDATA[Sender’s Name]]></item>
 		<item name="wcf.acp.option.mail_from_name.description"><![CDATA[The sender’s name for all generated emails.]]></item>
 		<item name="wcf.acp.option.mail_send_method"><![CDATA[Send Method]]></item>
-		<item name="wcf.acp.option.mail_send_method.debug"><![CDATA[Use Debug]]></item>
+		<item name="wcf.acp.option.mail_send_method.debug"><![CDATA[Use Debug (mbox)]]></item>
+		<item name="wcf.acp.option.mail_send_method.debugFolder"><![CDATA[Use Debug (Folder with .eml files)]]></item>
 		<item name="wcf.acp.option.mail_send_method.php"><![CDATA[Use PHP]]></item>
 		<item name="wcf.acp.option.mail_send_method.smtp"><![CDATA[Use SMTP]]></item>
 		<item name="wcf.acp.option.mail_signature"><![CDATA[Sender’s Signature]]></item>
-- 
2.20.1