Projekt

Obecné

Profil

Stáhnout (25.7 KB) Statistiky
| Větev: | Tag: | Revize:

freenetis-github/system/vendor/swift/Swift/Message.php @ b79f77ca

8baed187 Michal Kliment
<?php

/**
* Swift Mailer Message Component
* Composes MIME 1.0 messages meeting various RFC standards
* Deals with attachments, embedded images, multipart bodies, forwarded messages...
* Please read the LICENSE file
* @copyright Chris Corbyn <chris@w3style.co.uk>
* @author Chris Corbyn <chris@w3style.co.uk>
* @package Swift_Message
* @license GNU Lesser General Public License
*/

require_once dirname(__FILE__) . "/ClassLoader.php";
Swift_ClassLoader::load("Swift_Address");
Swift_ClassLoader::load("Swift_Message_Mime");
Swift_ClassLoader::load("Swift_Message_Image");
Swift_ClassLoader::load("Swift_Message_Part");


/**
* Swift Message class
* @package Swift_Message
* @author Chris Corbyn <chris@w3style.co.uk>
*/
class Swift_Message extends Swift_Message_Mime
{
/**
* Constant from a high priority message (pretty meaningless)
*/
const PRIORITY_HIGH = 1;
/**
* Constant for a low priority message
*/
const PRIORITY_LOW = 5;
/**
* Constant for a normal priority message
*/
const PRIORITY_NORMAL = 3;
/**
* The MIME warning for client not supporting multipart content
* @var string
*/
protected $mimeWarning = null;
/**
* The version of the library (Swift) if known.
* @var string
*/
protected $libVersion = "";
/**
* A container for references to other objects.
* This is used in some very complex logic when sub-parts get shifted around.
* @var array
*/
protected $references = array(
"parent" => array("alternative" => null, "mixed" => null, "related" => null),
"alternative" => array(),
"mixed" => array(),
"related" => array()
);
/**
* Ctor.
* @param string Message subject
* @param string Body
* @param string Content-type
* @param string Encoding
* @param string Charset
*/
public function __construct($subject="", $body=null, $type="text/plain", $encoding=null, $charset=null)
{
parent::__construct();
if (function_exists("date_default_timezone_set") && function_exists("date_default_timezone_get"))
{
date_default_timezone_set(@date_default_timezone_get());
}
$this->setReturnPath(null);
$this->setTo("");
$this->setFrom("");
$this->setCc(null);
$this->setBcc(null);
$this->setReplyTo(null);
$this->setSubject($subject);
$this->setDate(time());
if (defined("Swift::VERSION"))
{
$this->libVersion = Swift::VERSION;
$this->headers->set("X-LibVersion", $this->libVersion);
}
$this->headers->set("MIME-Version", "1.0");
$this->setContentType($type);
$this->setCharset($charset);
$this->setFlowed(true);
$this->setEncoding($encoding);
foreach (array_keys($this->references["parent"]) as $key)
{
$this->setReference("parent", $key, $this);
}
$this->setMimeWarning(
"This is a message in multipart MIME format. Your mail client should not be displaying this. " .
"Consider upgrading your mail client to view this message correctly."
);
if ($body !== null)
{
$this->setData($body);
if ($charset === null)
{
Swift_ClassLoader::load("Swift_Message_Encoder");
if (Swift_Message_Encoder::instance()->isUTF8($body)) $this->setCharset("utf-8");
else $this->setCharset("iso-8859-1");
}
}
}
/**
* Sets a reference so when nodes are nested, operations can be redirected.
* This really should be refactored to use just one array rather than dynamic variables.
* @param string Key 1
* @param string Key 2
* @param Object Reference
*/
protected function setReference($where, $key, $ref)
{
if ($ref === $this) $this->references[$where][$key] = false;
else $this->references[$where][$key] = $ref;
}
/**
* Get a reference to an object (for complex reasons).
* @param string Key 1
* @param string Key 2
* @return Object
*/
protected function getReference($where, $key)
{
if (!$this->references[$where][$key]) return $this;
else return $this->references[$where][$key];
}
/**
* Get the level in the MIME hierarchy at which this section should appear.
* @return string
*/
public function getLevel()
{
return Swift_Message_Mime::LEVEL_TOP;
}
/**
* Set the message id literally.
* Unless you know what you are doing you should be using generateId() rather than this method,
* otherwise you may break compliancy with RFC 2822.
* @param string The message ID string.
*/
public function setId($id)
{
$this->headers->set("Message-ID", $id);
}
/**
* Create a RFC 2822 compliant message id, optionally based upon $idstring.
* The message ID includes information about the current time, the server and some random characters.
* @param string An optional string the base the ID on
* @return string The generated message ID, including the <> quotes.
* @author Cristian Rodriguez <judas.iscariote@flyspray.org>
*/
public function generateId($idstring=null)
{
$midparams = array(
"utctime" => gmstrftime("%Y%m%d%H%M%S"),
"pid" => getmypid(),
"randint" => mt_rand(),
"customstr" => (preg_match("/^(?<!\\.)[a-z0-9\\.]+(?!\\.)\$/iD", $idstring) ? $idstring : "swift") ,
"hostname" => (isset($_SERVER["SERVER_NAME"]) ? $_SERVER["SERVER_NAME"] : php_uname("n")),
);
$this->setId(vsprintf("<%s.%d.%d.%s@%s>", $midparams));
return $this->getId();
}
/**
* Get the generated message ID for this message, including the <> quotes.
* If generated automatically, or using generateId() this method returns a RFC2822 compliant Message-ID.
* @return string
* @author Cristian Rodriguez <judas.iscariote@flyspray.org>
*/
public function getId()
{
return $this->headers->has("Message-ID") ? $this->headers->get("Message-ID") : null;
}
/**
* Set the address in the Return-Path: header
* @param string The bounce-detect address
*/
public function setReturnPath($address)
{
if ($address instanceof Swift_Address) $address = $address->build(true);
$this->headers->set("Return-Path", $address);
}
/**
* Return the address used in the Return-Path: header
* @return string
* @param boolean Return the address for SMTP command
*/
public function getReturnPath($smtp=false)
{
if ($this->headers->has("Return-Path"))
{
if (!$smtp) return $this->headers->get("Return-Path");
else
{
$path = $this->headers->get("Return-Path");
if (strpos($path, ">") > strpos($path, "<")) return substr($path, ($start = strpos($path, "<")), ($start + strrpos($path, ">") + 1));
else return "<" . $path . ">";
}
}
}
/**
* Set the address in the From: header
* @param string The address to set as From
*/
public function setFrom($from)
{
if ($from instanceof Swift_Address) $from = $from->build();
$this->headers->set("From", $from);
}
/**
* Get the address used in the From: header
* @return string
*/
public function getFrom()
{
if ($this->headers->has("From")) return $this->headers->get("From");
}
/**
* Set the list of recipients in the To: header
* @param mixed An array or a string
*/
public function setTo($to)
{
if ($to)
{
if (!is_array($to)) $to = array($to);
foreach ($to as $key => $value)
{
if ($value instanceof Swift_Address) $to[$key] = $value->build();
}
}
$this->headers->set("To", $to);
}
/**
* Return the list of recipients in the To: header
* @return array
*/
public function getTo()
{
if ($this->headers->has("To"))
{
$to = $this->headers->get("To");
if ($to == "") return array();
else return (array) $to;
}
}
/**
* Set the list of recipients in the Reply-To: header
* @param mixed An array or a string
*/
public function setReplyTo($replyto)
{
if ($replyto)
{
if (!is_array($replyto)) $replyto = array($replyto);
foreach ($replyto as $key => $value)
{
if ($value instanceof Swift_Address) $replyto[$key] = $value->build();
}
}
$this->headers->set("Reply-To", $replyto);
}
/**
* Return the list of recipients in the Reply-To: header
* @return array
*/
public function getReplyTo()
{
if ($this->headers->has("Reply-To"))
{
$reply_to = $this->headers->get("Reply-To");
if ($reply_to == "") return array();
else return (array) $reply_to;
}
}
/**
* Set the list of recipients in the Cc: header
* @param mixed An array or a string
*/
public function setCc($cc)
{
if ($cc)
{
if (!is_array($cc)) $cc = array($cc);
foreach ($cc as $key => $value)
{
if ($value instanceof Swift_Address) $cc[$key] = $value->build();
}
}
$this->headers->set("Cc", $cc);
}
/**
* Return the list of recipients in the Cc: header
* @return array
*/
public function getCc()
{
if ($this->headers->has("Cc"))
{
$cc = $this->headers->get("Cc");
if ($cc == "") return array();
else return (array) $cc;
}
}
/**
* Set the list of recipients in the Bcc: header
* @param mixed An array or a string
*/
public function setBcc($bcc)
{
if ($bcc)
{
if (!is_array($bcc)) $bcc = array($bcc);
foreach ($bcc as $key => $value)
{
if ($value instanceof Swift_Address) $bcc[$key] = $value->build();
}
}
$this->headers->set("Bcc", $bcc);
}
/**
* Return the list of recipients in the Bcc: header
* @return array
*/
public function getBcc()
{
if ($this->headers->has("Bcc"))
{
$bcc = $this->headers->get("Bcc");
if ($bcc == "") return array();
else return (array) $bcc;
}
}
/**
* Set the subject in the headers
* @param string The subject of the email
*/
public function setSubject($subject)
{
$this->headers->set("Subject", $subject);
}
/**
* Get the current subject used in the headers
* @return string
*/
public function getSubject()
{
return $this->headers->get("Subject");
}
/**
* Set the date in the headers in RFC 2822 format
* @param int The time as a UNIX timestamp
*/
public function setDate($date)
{
$this->headers->set("Date", date("r", $date));
}
/**
* Get the date as it looks in the headers
* @return string
*/
public function getDate()
{
return strtotime($this->headers->get("Date"));
}
/**
* Set the charset of the document
* @param string The charset used
*/
public function setCharset($charset)
{
$this->headers->setAttribute("Content-Type", "charset", $charset);
if (($this->getEncoding() == "7bit") && (strtolower($charset) == "utf-8" || strtolower($charset) == "utf8")) $this->setEncoding("8bit");
}
/**
* Get the charset used in the document
* Returns null if none is set
* @return string
*/
public function getCharset()
{
if ($this->headers->hasAttribute("Content-Type", "charset"))
{
return $this->headers->getAttribute("Content-Type", "charset");
}
else
{
return null;
}
}
/**
* Set the "format" attribute to flowed
* @param boolean On or Off
*/
public function setFlowed($flowed=true)
{
$value = null;
if ($flowed) $value = "flowed";
$this->headers->setAttribute("Content-Type", "format", $value);
}
/**
* Check if the message format is set as flowed
* @return boolean
*/
public function isFlowed()
{
if ($this->headers->hasAttribute("Content-Type", "format")
&& $this->headers->getAttribute("Content-Type", "format") == "flowed")
{
return true;
}
else return false;
}
/**
* Set the message prioirty in the mail client (don't rely on this)
* @param int The priority as a value between 1 (high) and 5 (low)
*/
public function setPriority($priority)
{
$priority = (int) $priority;
if ($priority > self::PRIORITY_LOW) $priority = self::PRIORITY_LOW;
if ($priority < self::PRIORITY_HIGH) $priority = self::PRIORITY_HIGH;
$label = array(1 => "High", 2 => "High", 3 => "Normal", 4 => "Low", 5 => "Low");
$this->headers->set("X-Priority", $priority);
$this->headers->set("X-MSMail-Priority", $label[$priority]);
$this->headers->set("X-MimeOLE", "Produced by SwiftMailer " . $this->libVersion);
}
/**
* Request that the client send back a read-receipt (don't rely on this!)
* @param string Request address
*/
public function requestReadReceipt($request)
{
if ($request instanceof Swift_Address) $request = $request->build();
if (!$request)
{
$this->headers->set("Disposition-Notification-To", null);
$this->headers->set("X-Confirm-Reading-To", null);
$this->headers->set("Return-Receipt-To", null);
}
else
{
$this->headers->set("Disposition-Notification-To", $request);
$this->headers->set("X-Confirm-Reading-To", $request);
$this->headers->set("Return-Receipt-To", $request);
}
}
/**
* Check if a read receipt has been requested for this message
* @return boolean
*/
public function wantsReadReceipt()
{
return $this->headers->has("Disposition-Notification-To");
}
/**
* Get the current message priority
* Returns NULL if none set
* @return int
*/
public function getPriority()
{
if ($this->headers->has("X-Priority")) return $this->headers->get("X-Priority");
else return null;
}
/**
* Alias for setData()
* @param mixed Body
*/
public function setBody($body)
{
$this->setData($body);
}
/**
* Alias for getData()
* @return mixed The document body
*/
public function getBody()
{
return $this->getData();
}
/**
* Set the MIME warning message which is displayed to old clients
* @var string The full warning message (in 7bit ascii)
*/
public function setMimeWarning($text)
{
$this->mimeWarning = (string) $text;
}
/**
* Get the MIME warning which is displayed to old clients
* @return string
*/
public function getMimeWarning()
{
return $this->mimeWarning;
}
/**
* Attach a mime part or an attachment of some sort
* Any descendant of Swift_Message_Mime can be added safely (including other Swift_Message objects for mail forwarding!!)
* @param Swift_Message_Mime The document to attach
* @param string An identifier to use (one is returned otherwise)
* @return string The identifier for the part
*/
public function attach(Swift_Message_Mime $child, $id=null)
{
try {
switch ($child->getLevel())
{
case Swift_Message_Mime::LEVEL_ALTERNATIVE:
$sign = (strtolower($child->getContentType()) == "text/plain") ? -1 : 1;
$id = $this->getReference("parent", "alternative")->addChild($child, $id, $sign);
$this->setReference("alternative", $id, $child);
break;
case Swift_Message_Mime::LEVEL_RELATED:
$id = "cid:" . $child->getContentId();
$id = $this->getReference("parent", "related")->addChild($child, $id, 1);
$this->setReference("related", $id, $child);
break;
case Swift_Message_Mime::LEVEL_MIXED: default:
$id = $this->getReference("parent", "mixed")->addChild($child, $id, 1);
$this->setReference("mixed", $id, $child);
break;
}
$this->postAttachFixStructure();
$this->fixContentType();
return $id;
} catch (Swift_Message_MimeException $e) {
throw new Swift_Message_MimeException("Something went wrong whilst trying to move some MIME parts during an attach(). " .
"The MIME component threw an exception:<br />" . $e->getMessage());
}
}
/**
* Remove a nested MIME part
* @param string The ID of the attached part
* @throws Swift_Message_MimeException If no such part exists
*/
public function detach($id)
{
try {
switch (true)
{
case array_key_exists($id, $this->references["alternative"]):
$this->getReference("parent", "alternative")->removeChild($id);
unset($this->references["alternative"][$id]);
break;
case array_key_exists($id, $this->references["related"]):
$this->getReference("parent", "related")->removeChild($id);
unset($this->references["related"][$id]);
break;
case array_key_exists($id, $this->references["mixed"]):
$this->getReference("parent", "mixed")->removeChild($id);
unset($this->references["mixed"][$id]);
break;
default:
throw new Swift_Message_MimeException("Unable to detach part identified by ID '" . $id . "' since it's not registered.");
break;
}
$this->postDetachFixStructure();
$this->fixContentType();
} catch (Swift_Message_MimeException $e) {
throw new Swift_Message_MimeException("Something went wrong whilst trying to move some MIME parts during a detach(). " .
"The MIME component threw an exception:<br />" . $e->getMessage());
}
}
/**
* Sets the correct content type header by looking at what types of data we have set
*/
protected function fixContentType()
{
if (!empty($this->references["mixed"])) $this->setContentType("multipart/mixed");
elseif (!empty($this->references["related"])) $this->setContentType("multipart/related");
elseif (!empty($this->references["alternative"])) $this->setContentType("multipart/alternative");
}
/**
* Move a branch of the tree, containing all it's MIME parts onto another branch
* @param string The content type on the branch itself
* @param string The content type which may exist in the branch's parent
* @param array The array containing all the nodes presently
* @param string The location of the branch now
* @param string The location of the branch after moving
* @param string The key to identify the branch by in it's new location
*/
protected function moveBranchIn($type, $nested_type, $from, $old_branch, $new_branch, $tag)
{
$new = new Swift_Message_Part();
$new->setContentType($type);
$this->getReference("parent", $new_branch)->addChild($new, $tag, -1);
switch ($new_branch)
{
case "related": $this->setReference("related", $tag, $new);//relatedRefs[$tag] = $new;
break;
case "mixed": $this->setReference("mixed", $tag, $new);//mixedRefs[$tag] = $new;
break;
}
foreach ($from as $id => $ref)
{
if (!$ref) $ref = $this;
$sign = (strtolower($ref->getContentType()) == "text/plain"
|| strtolower($ref->getContentType()) == $nested_type) ? -1 : 1;
switch ($new_branch)
{
case "related": $this->getReference("related", $tag)->addChild($ref, $id, $sign);
break;
case "mixed": $this->getReference("mixed", $tag)->addChild($ref, $id, $sign);
break;
}
$this->getReference("parent", $old_branch)->removeChild($id);
}
$this->setReference("parent", $old_branch, $new); //parentRefs[$old_branch] = $new;
}
/**
* Analyzes the mixing of MIME types in a mulitpart message an re-arranges if needed
* It looks complicated and long winded but the concept is pretty simple, even if putting it
* in code does me make want to cry!
*/
protected function postAttachFixStructure()
{
switch (true)
{
case (!empty($this->references["mixed"]) && !empty($this->references["related"]) && !empty($this->references["alternative"])):
if (!isset($this->references["related"]["_alternative"]))
{
$this->moveBranchIn(
"multipart/alternative", "multipart/alternative", $this->references["alternative"], "alternative", "related", "_alternative");
}
if (!isset($this->references["mixed"]["_related"]))
{
$this->moveBranchIn(
"multipart/related", "multipart/alternative", $this->references["related"], "related", "mixed", "_related");
}
break;
case (!empty($this->references["mixed"]) && !empty($this->references["related"])):
if (!isset($this->references["mixed"]["_related"]))
{
$this->moveBranchIn(
"multipart/related", "multipart/related", $this->references["related"], "related", "mixed", "_related");
}
break;
case (!empty($this->references["mixed"]) && !empty($this->references["alternative"])):
if (!isset($this->references["mixed"]["_alternative"]))
{
$this->moveBranchIn(
"multipart/alternative", null, $this->references["alternative"], "alternative", "mixed", "_alternative");
}
break;
case (!empty($this->references["related"]) && !empty($this->references["alternative"])):
if (!isset($this->references["related"]["_alternative"]))
{
$this->moveBranchIn(
"multipart/alternative", "multipart/alternative", $this->references["alternative"], "alternative", "related", "_alternative");
}
break;
}
}
/**
* Move a branch further toward the top of the tree
* @param array The array containing MIME parts from the old branch
* @param string The name of the old branch
* @param string The name of the new branch
* @param string The key of the branch being moved
*/
protected function moveBranchOut($from, $old_branch, $new_branch, $tag)
{
foreach ($from as $id => $ref)
{
if (!$ref) $ref = $this;
$sign = (strtolower($ref->getContentType()) == "text/html"
|| strtolower($ref->getContentType()) == "multipart/alternative") ? -1 : 1;
$this->getReference("parent", $new_branch)->addChild($ref, $id, $sign);
switch ($new_branch)
{
case "related": $this->getReference("related", $tag)->removeChild($id);
break;
case "mixed": $this->getReference("parent", $old_branch)->removeChild($id);
break;
}
}
$this->getReference("parent", $new_branch)->removeChild($tag);
$mixed = $this->getReference("parent", $new_branch);//parentRefs[$new_branch];
$this->setReference("parent", $old_branch, $mixed);//parentRefs[$old_branch] = $mixed;
switch ($new_branch)
{
case "related": unset($this->references["related"][$tag]);
break;
case "mixed": unset($this->references["mixed"][$tag]);
break;
}
}
/**
* Analyzes the mixing of MIME types in a mulitpart message an re-arranges if needed
* It looks complicated and long winded but the concept is pretty simple, even if putting it
* in code does me make want to cry!
*/
protected function postDetachFixStructure()
{
switch (true)
{
case (!empty($this->references["mixed"]) && !empty($this->references["related"]) && !empty($this->references["alternative"])):
if (array_keys($this->references["related"]) == array("_alternative"))
{
$alt = $this->getReference("parent", "related")->getChild("_alternative");
$this->getReference("parent", "mixed")->addChild($alt, "_alternative", -1);
$this->setReference("mixed", "_alternative", $alt);//mixedRefs["_alternative"] = $alt;
$this->getReference("parent", "related")->removeChild("_alternative");
unset($this->references["related"]["_alternative"]);
$this->getReference("parent", "mixed")->removeChild("_related");
unset($this->references["mixed"]["_related"]);
}
if (array_keys($this->references["mixed"]) == array("_related"))
{
$this->moveBranchOut($this->references["related"], "related", "mixed", "_related");
}
break;
case (!empty($this->references["mixed"]) && !empty($this->references["related"])):
if (array_keys($this->references["mixed"]) == array("_related"))
{
$this->moveBranchOut($this->references["related"], "related", "mixed", "_related");
}
if (isset($this->references["related"]["_alternative"]))
{
$this->detach("_alternative");
}
break;
case (!empty($this->references["mixed"]) && !empty($this->references["alternative"])):
if (array_keys($this->references["mixed"]) == array("_alternative"))
{
$this->moveBranchOut($this->references["alternative"], "alternative", "mixed", "_alternative");
}
break;
case (!empty($this->references["related"]) && !empty($this->references["alternative"])):
if (array_keys($this->references["related"]) == array("_alternative"))
{
$this->moveBranchOut($this->references["alternative"], "alternative", "related", "_alternative");
}
break;
case (!empty($this->references["mixed"])):
if (isset($this->references["mixed"]["_related"])) $this->detach("_related");
case (!empty($this->references["related"])):
if (isset($this->references["related"]["_alternative"]) || isset($this->references["mixed"]["_alternative"]))
$this->detach("_alternative");
break;
}
}
/**
* Execute needed logic prior to compilation
*/
public function preBuild()
{
$data = $this->getData();
if (!($enc = $this->getEncoding()))
{
$this->setEncoding("8bit");
}
if ($this->getCharset() === null && !$this->numChildren())
{
Swift_ClassLoader::load("Swift_Message_Encoder");
if (is_string($data) && Swift_Message_Encoder::instance()->isUTF8($data))
{
$this->setCharset("utf-8");
}
elseif(is_string($data) && Swift_Message_Encoder::instance()->is7BitAscii($data))
{
$this->setCharset("us-ascii");
if (!$enc) $this->setEncoding("7bit");
}
else $this->setCharset("iso-8859-1");
}
elseif ($this->numChildren())
{
if (!$this->getData())
{
$this->setData($this->getMimeWarning());
$this->setLineWrap(76);
}
if ($this->getCharset() !== null) $this->setCharset(null);
if ($this->isFlowed()) $this->setFlowed(false);
$this->setEncoding("7bit");
}
}
}