From 3412e50b54e3daac8745234e21ab6e72be0ed165 Mon Sep 17 00:00:00 2001
From: Thomas Bruederli <thomas@roundcube.net>
Date: Wed, 04 Jun 2014 11:20:33 -0400
Subject: [PATCH] Fix attachment menu structure and aria-attributes
---
program/lib/Mail/mime.php | 288 +++++++++++++++++++++++++++++++++++++++-----------------
1 files changed, 199 insertions(+), 89 deletions(-)
diff --git a/program/lib/Mail/mime.php b/program/lib/Mail/mime.php
index c08c7cf..e079af7 100644
--- a/program/lib/Mail/mime.php
+++ b/program/lib/Mail/mime.php
@@ -245,7 +245,7 @@
}
} else {
$cont = $this->_file2str($data);
- if (PEAR::isError($cont)) {
+ if ($this->_isError($cont)) {
return $cont;
}
if (!$append) {
@@ -254,6 +254,7 @@
$this->_txtbody .= $cont;
}
}
+
return true;
}
@@ -286,7 +287,7 @@
$this->_htmlbody = $data;
} else {
$cont = $this->_file2str($data);
- if (PEAR::isError($cont)) {
+ if ($this->_isError($cont)) {
return $cont;
}
$this->_htmlbody = $cont;
@@ -336,7 +337,7 @@
$filedata = null;
$bodyfile = $file;
} else {
- if (PEAR::isError($filedata = $this->_file2str($file))) {
+ if ($this->_isError($filedata = $this->_file2str($file))) {
return $filedata;
}
}
@@ -347,7 +348,7 @@
}
if (!$content_id) {
- $content_id = md5(uniqid(time()));
+ $content_id = preg_replace('/[^0-9a-zA-Z]/', '', uniqid(time(), true));
}
$this->_html_images[] = array(
@@ -365,30 +366,30 @@
* Adds a file to the list of attachments.
*
* @param string $file The file name of the file to attach
- * OR the file contents itself
+ * or the file contents itself
* @param string $c_type The content type
* @param string $name The filename of the attachment
* Only use if $file is the contents
- * @param bool $isfile Whether $file is a filename or not
- * Defaults to true
- * @param string $encoding The type of encoding to use.
- * Defaults to base64.
- * Possible values: 7bit, 8bit, base64,
- * or quoted-printable.
+ * @param bool $isfile Whether $file is a filename or not. Defaults to true
+ * @param string $encoding The type of encoding to use. Defaults to base64.
+ * Possible values: 7bit, 8bit, base64 or quoted-printable.
* @param string $disposition The content-disposition of this file
* Defaults to attachment.
* Possible values: attachment, inline.
- * @param string $charset The character set used in the filename
- * of this attachment.
+ * @param string $charset The character set of attachment's content.
* @param string $language The language of the attachment
* @param string $location The RFC 2557.4 location of the attachment
- * @param string $n_encoding Encoding for attachment name (Content-Type)
+ * @param string $n_encoding Encoding of the attachment's name in Content-Type
* By default filenames are encoded using RFC2231 method
* Here you can set RFC2047 encoding (quoted-printable
* or base64) instead
- * @param string $f_encoding Encoding for attachment filename (Content-Disposition)
- * See $n_encoding description
+ * @param string $f_encoding Encoding of the attachment's filename
+ * in Content-Disposition header.
* @param string $description Content-Description header
+ * @param string $h_charset The character set of the headers e.g. filename
+ * If not specified, $charset will be used
+ * @param array $add_headers Additional part headers. Array keys can be in form
+ * of <header_name>:<parameter_name>
*
* @return mixed True on success or PEAR_Error object
* @access public
@@ -404,7 +405,9 @@
$location = '',
$n_encoding = null,
$f_encoding = null,
- $description = ''
+ $description = '',
+ $h_charset = null,
+ $add_headers = array()
) {
$bodyfile = null;
@@ -414,12 +417,12 @@
$filedata = null;
$bodyfile = $file;
} else {
- if (PEAR::isError($filedata = $this->_file2str($file))) {
+ if ($this->_isError($filedata = $this->_file2str($file))) {
return $filedata;
}
}
// Force the name the user supplied, otherwise use $file
- $filename = ($name ? $name : $file);
+ $filename = ($name ? $name : $this->_basename($file));
} else {
$filedata = $file;
$filename = $name;
@@ -427,24 +430,24 @@
if (!strlen($filename)) {
$msg = "The supplied filename for the attachment can't be empty";
- $err = PEAR::raiseError($msg);
- return $err;
+ return $this->_raiseError($msg);
}
- $filename = $this->_basename($filename);
$this->_parts[] = array(
'body' => $filedata,
'body_file' => $bodyfile,
'name' => $filename,
'c_type' => $c_type,
- 'encoding' => $encoding,
'charset' => $charset,
+ 'encoding' => $encoding,
'language' => $language,
'location' => $location,
'disposition' => $disposition,
'description' => $description,
+ 'add_headers' => $add_headers,
'name_encoding' => $n_encoding,
- 'filename_encoding' => $f_encoding
+ 'filename_encoding' => $f_encoding,
+ 'headers_charset' => $h_charset,
);
return true;
@@ -458,20 +461,17 @@
* @return string Contents of $file_name
* @access private
*/
- function &_file2str($file_name)
+ function _file2str($file_name)
{
// Check state of file and raise an error properly
if (!file_exists($file_name)) {
- $err = PEAR::raiseError('File not found: ' . $file_name);
- return $err;
+ return $this->_raiseError('File not found: ' . $file_name);
}
if (!is_file($file_name)) {
- $err = PEAR::raiseError('Not a regular file: ' . $file_name);
- return $err;
+ return $this->_raiseError('Not a regular file: ' . $file_name);
}
if (!is_readable($file_name)) {
- $err = PEAR::raiseError('File is not readable: ' . $file_name);
- return $err;
+ return $this->_raiseError('File is not readable: ' . $file_name);
}
// Temporarily reset magic_quotes_runtime and read file contents
@@ -497,7 +497,7 @@
* @return object The text mimePart object
* @access private
*/
- function &_addTextPart(&$obj, $text)
+ function &_addTextPart(&$obj = null, $text = '')
{
$params['content_type'] = 'text/plain';
$params['encoding'] = $this->_build_params['text_encoding'];
@@ -506,11 +506,11 @@
if (is_object($obj)) {
$ret = $obj->addSubpart($text, $params);
- return $ret;
} else {
$ret = new Mail_mimePart($text, $params);
- return $ret;
}
+
+ return $ret;
}
/**
@@ -523,7 +523,7 @@
* @return object The html mimePart object
* @access private
*/
- function &_addHtmlPart(&$obj)
+ function &_addHtmlPart(&$obj = null)
{
$params['content_type'] = 'text/html';
$params['encoding'] = $this->_build_params['html_encoding'];
@@ -532,11 +532,11 @@
if (is_object($obj)) {
$ret = $obj->addSubpart($this->_htmlbody, $params);
- return $ret;
} else {
$ret = new Mail_mimePart($this->_htmlbody, $params);
- return $ret;
}
+
+ return $ret;
}
/**
@@ -549,7 +549,6 @@
*/
function &_addMixedPart()
{
- $params = array();
$params['content_type'] = 'multipart/mixed';
$params['eol'] = $this->_build_params['eol'];
@@ -569,17 +568,18 @@
* @return object The multipart/mixed mimePart object
* @access private
*/
- function &_addAlternativePart(&$obj)
+ function &_addAlternativePart(&$obj = null)
{
$params['content_type'] = 'multipart/alternative';
$params['eol'] = $this->_build_params['eol'];
if (is_object($obj)) {
- return $obj->addSubpart('', $params);
+ $ret = $obj->addSubpart('', $params);
} else {
$ret = new Mail_mimePart('', $params);
- return $ret;
}
+
+ return $ret;
}
/**
@@ -593,17 +593,18 @@
* @return object The multipart/mixed mimePart object
* @access private
*/
- function &_addRelatedPart(&$obj)
+ function &_addRelatedPart(&$obj = null)
{
$params['content_type'] = 'multipart/related';
$params['eol'] = $this->_build_params['eol'];
if (is_object($obj)) {
- return $obj->addSubpart('', $params);
+ $ret = $obj->addSubpart('', $params);
} else {
$ret = new Mail_mimePart('', $params);
- return $ret;
}
+
+ return $ret;
}
/**
@@ -621,7 +622,7 @@
$params['content_type'] = $value['c_type'];
$params['encoding'] = 'base64';
$params['disposition'] = 'inline';
- $params['dfilename'] = $value['name'];
+ $params['filename'] = $value['name'];
$params['cid'] = $value['cid'];
$params['body_file'] = $value['body_file'];
$params['eol'] = $this->_build_params['eol'];
@@ -650,19 +651,25 @@
function &_addAttachmentPart(&$obj, $value)
{
$params['eol'] = $this->_build_params['eol'];
- $params['dfilename'] = $value['name'];
+ $params['filename'] = $value['name'];
$params['encoding'] = $value['encoding'];
$params['content_type'] = $value['c_type'];
$params['body_file'] = $value['body_file'];
$params['disposition'] = isset($value['disposition']) ?
$value['disposition'] : 'attachment';
- if ($value['charset']) {
+
+ // content charset
+ if (!empty($value['charset'])) {
$params['charset'] = $value['charset'];
}
- if ($value['language']) {
+ // headers charset (filename, description)
+ if (!empty($value['headers_charset'])) {
+ $params['headers_charset'] = $value['headers_charset'];
+ }
+ if (!empty($value['language'])) {
$params['language'] = $value['language'];
}
- if ($value['location']) {
+ if (!empty($value['location'])) {
$params['location'] = $value['location'];
}
if (!empty($value['name_encoding'])) {
@@ -673,6 +680,9 @@
}
if (!empty($value['description'])) {
$params['description'] = $value['description'];
+ }
+ if (is_array($value['add_headers'])) {
+ $params['headers'] = $value['add_headers'];
}
$ret = $obj->addSubpart($value['body'], $params);
@@ -688,9 +698,9 @@
*
* @param string $separation The separation between these two parts.
* @param array $params The Build parameters passed to the
- * &get() function. See &get for more info.
+ * get() function. See get() for more info.
* @param array $headers The extra headers that should be passed
- * to the &headers() function.
+ * to the headers() method.
* See that function for more info.
* @param bool $overwrite Overwrite the existing headers with new.
*
@@ -706,13 +716,11 @@
$body = $this->get($params);
- if (PEAR::isError($body)) {
+ if ($this->_isError($body)) {
return $body;
}
- $head = $this->txtHeaders($headers, $overwrite);
- $mail = $head . $separation . $body;
- return $mail;
+ return $this->txtHeaders($headers, $overwrite) . $separation . $body;
}
/**
@@ -720,7 +728,7 @@
* mail delivery method.
*
* @param array $params The Build parameters passed to the
- * &get() function. See &get for more info.
+ * get() method. See get() for more info.
*
* @return mixed The e-mail body or PEAR error object
* @access public
@@ -736,9 +744,9 @@
*
* @param string $filename Output file location
* @param array $params The Build parameters passed to the
- * &get() function. See &get for more info.
+ * get() method. See get() for more info.
* @param array $headers The extra headers that should be passed
- * to the &headers() function.
+ * to the headers() function.
* See that function for more info.
* @param bool $overwrite Overwrite the existing headers with new.
*
@@ -750,8 +758,7 @@
{
// Check state of file and raise an error properly
if (file_exists($filename) && !is_writable($filename)) {
- $err = PEAR::raiseError('File is not writable: ' . $filename);
- return $err;
+ return $this->_raiseError('File is not writable: ' . $filename);
}
// Temporarily reset magic_quotes_runtime and read file contents
@@ -760,15 +767,13 @@
}
if (!($fh = fopen($filename, 'ab'))) {
- $err = PEAR::raiseError('Unable to open file: ' . $filename);
- return $err;
+ return $this->_raiseError('Unable to open file: ' . $filename);
}
// Write message headers into file (skipping Content-* headers)
$head = $this->txtHeaders($headers, $overwrite, true);
if (fwrite($fh, $head) === false) {
- $err = PEAR::raiseError('Error writing to file: ' . $filename);
- return $err;
+ return $this->_raiseError('Error writing to file: ' . $filename);
}
fclose($fh);
@@ -785,10 +790,10 @@
/**
* Writes (appends) the complete e-mail body into file.
- *
+ *
* @param string $filename Output file location
* @param array $params The Build parameters passed to the
- * &get() function. See &get for more info.
+ * get() method. See get() for more info.
*
* @return mixed True or PEAR error object
* @access public
@@ -798,8 +803,7 @@
{
// Check state of file and raise an error properly
if (file_exists($filename) && !is_writable($filename)) {
- $err = PEAR::raiseError('File is not writable: ' . $filename);
- return $err;
+ return $this->_raiseError('File is not writable: ' . $filename);
}
// Temporarily reset magic_quotes_runtime and read file contents
@@ -808,8 +812,7 @@
}
if (!($fh = fopen($filename, 'ab'))) {
- $err = PEAR::raiseError('Unable to open file: ' . $filename);
- return $err;
+ return $this->_raiseError('Unable to open file: ' . $filename);
}
// Write the rest of the message into file
@@ -832,7 +835,7 @@
* @return mixed The MIME message content string, null or PEAR error object
* @access public
*/
- function &get($params = null, $filename = null, $skip_head = false)
+ function get($params = null, $filename = null, $skip_head = false)
{
if (isset($params)) {
while (list($key, $value) = each($params)) {
@@ -842,14 +845,16 @@
if (isset($this->_headers['From'])) {
// Bug #11381: Illegal characters in domain ID
- if (preg_match("|(@[0-9a-zA-Z\-\.]+)|", $this->_headers['From'], $matches)) {
+ if (preg_match('#(@[0-9a-zA-Z\-\.]+)#', $this->_headers['From'], $matches)) {
$domainID = $matches[1];
} else {
- $domainID = "@localhost";
+ $domainID = '@localhost';
}
foreach ($this->_html_images as $i => $img) {
- $this->_html_images[$i]['cid']
- = $this->_html_images[$i]['cid'] . $domainID;
+ $cid = $this->_html_images[$i]['cid'];
+ if (!preg_match('#'.preg_quote($domainID).'$#', $cid)) {
+ $this->_html_images[$i]['cid'] = $cid . $domainID;
+ }
}
}
@@ -990,10 +995,9 @@
}
if (!isset($message)) {
- $ret = null;
- return $ret;
+ return null;
}
-
+
// Use saved boundary
if (!empty($this->_build_params['boundary'])) {
$boundary = $this->_build_params['boundary'];
@@ -1005,20 +1009,18 @@
if ($filename) {
// Append mimePart message headers and body into file
$headers = $message->encodeToFile($filename, $boundary, $skip_head);
- if (PEAR::isError($headers)) {
+ if ($this->_isError($headers)) {
return $headers;
}
$this->_headers = array_merge($this->_headers, $headers);
- $ret = null;
- return $ret;
+ return null;
} else {
$output = $message->encode($boundary, $skip_head);
- if (PEAR::isError($output)) {
+ if ($this->_isError($output)) {
return $output;
}
$this->_headers = array_merge($this->_headers, $output['headers']);
- $body = $output['body'];
- return $body;
+ return $output['body'];
}
}
@@ -1028,6 +1030,7 @@
* $array['header-name'] = 'header-value';
*
* @param array $xtra_headers Assoc array with any extra headers (optional)
+ * (Don't set Content-Type for multipart messages here!)
* @param bool $overwrite Overwrite already existing headers.
* @param bool $skip_content Don't return content headers: Content-Type,
* Content-Disposition and Content-Transfer-Encoding
@@ -1035,7 +1038,7 @@
* @return array Assoc array with the mime headers
* @access public
*/
- function &headers($xtra_headers = null, $overwrite = false, $skip_content = false)
+ function headers($xtra_headers = null, $overwrite = false, $skip_content = false)
{
// Add mime version header
$headers['MIME-Version'] = '1.0';
@@ -1064,6 +1067,8 @@
unset($headers['Content-Type']);
unset($headers['Content-Transfer-Encoding']);
unset($headers['Content-Disposition']);
+ } else if (!empty($this->_build_params['ctype'])) {
+ $headers['Content-Type'] = $this->_build_params['ctype'];
}
$encodedHeaders = $this->_encodeHeaders($headers);
@@ -1075,6 +1080,7 @@
* (usefull if you want to use the PHP mail() function)
*
* @param array $xtra_headers Assoc array with any extra headers (optional)
+ * (Don't set Content-Type for multipart messages here!)
* @param bool $overwrite Overwrite the existing headers with new.
* @param bool $skip_content Don't return content headers: Content-Type,
* Content-Disposition and Content-Transfer-Encoding
@@ -1111,6 +1117,54 @@
}
/**
+ * Sets message Content-Type header.
+ * Use it to build messages with various content-types e.g. miltipart/raport
+ * not supported by _contentHeaders() function.
+ *
+ * @param string $type Type name
+ * @param array $params Hash array of header parameters
+ *
+ * @return void
+ * @access public
+ * @since 1.7.0
+ */
+ function setContentType($type, $params = array())
+ {
+ $header = $type;
+
+ $eol = !empty($this->_build_params['eol'])
+ ? $this->_build_params['eol'] : "\r\n";
+
+ // add parameters
+ $token_regexp = '#([^\x21\x23-\x27\x2A\x2B\x2D'
+ . '\x2E\x30-\x39\x41-\x5A\x5E-\x7E])#';
+ if (is_array($params)) {
+ foreach ($params as $name => $value) {
+ if ($name == 'boundary') {
+ $this->_build_params['boundary'] = $value;
+ }
+ if (!preg_match($token_regexp, $value)) {
+ $header .= ";$eol $name=$value";
+ } else {
+ $value = addcslashes($value, '\\"');
+ $header .= ";$eol $name=\"$value\"";
+ }
+ }
+ }
+
+ // add required boundary parameter if not defined
+ if (preg_match('/^multipart\//i', $type)) {
+ if (empty($this->_build_params['boundary'])) {
+ $this->_build_params['boundary'] = '=_' . md5(rand() . microtime());
+ }
+
+ $header .= ";$eol boundary=\"".$this->_build_params['boundary']."\"";
+ }
+
+ $this->_build_params['ctype'] = $header;
+ }
+
+ /**
* Sets the Subject header
*
* @param string $subject String to set the subject to.
@@ -1134,6 +1188,24 @@
function setFrom($email)
{
$this->_headers['From'] = $email;
+ }
+
+ /**
+ * Add an email to the To header
+ * (multiple calls to this method are allowed)
+ *
+ * @param string $email The email direction to add
+ *
+ * @return void
+ * @access public
+ */
+ function addTo($email)
+ {
+ if (isset($this->_headers['To'])) {
+ $this->_headers['To'] .= ", $email";
+ } else {
+ $this->_headers['To'] = $email;
+ }
}
/**
@@ -1241,7 +1313,8 @@
*/
function encodeHeader($name, $value, $charset, $encoding)
{
- return Mail_mimePart::encodeHeader(
+ $mime_part = new Mail_mimePart;
+ return $mime_part->encodeHeader(
$name, $value, $charset, $encoding, $this->_build_params['eol']
);
}
@@ -1315,18 +1388,23 @@
if ($headers['Content-Type'] == 'text/plain') {
// single-part message: add charset and encoding
+ $charset = 'charset=' . $this->_build_params['text_charset'];
+ // place charset parameter in the same line, if possible
+ // 26 = strlen("Content-Type: text/plain; ")
$headers['Content-Type']
- .= ";$eol charset=" . $this->_build_params['text_charset'];
+ .= (strlen($charset) + 26 <= 76) ? "; $charset" : ";$eol $charset";
$headers['Content-Transfer-Encoding']
= $this->_build_params['text_encoding'];
} else if ($headers['Content-Type'] == 'text/html') {
// single-part message: add charset and encoding
+ $charset = 'charset=' . $this->_build_params['html_charset'];
+ // place charset parameter in the same line, if possible
$headers['Content-Type']
- .= ";$eol charset=" . $this->_build_params['html_charset'];
+ .= (strlen($charset) + 25 <= 76) ? "; $charset" : ";$eol $charset";
$headers['Content-Transfer-Encoding']
= $this->_build_params['html_encoding'];
} else {
- // multipart message: add charset and boundary
+ // multipart message: and boundary
if (!empty($this->_build_params['boundary'])) {
$boundary = $this->_build_params['boundary'];
} else if (!empty($this->_headers['Content-Type'])
@@ -1382,4 +1460,36 @@
}
}
+ /**
+ * PEAR::isError implementation
+ *
+ * @param mixed $data Object
+ *
+ * @return bool True if object is an instance of PEAR_Error
+ * @access private
+ */
+ function _isError($data)
+ {
+ // PEAR::isError() is not PHP 5.4 compatible (see Bug #19473)
+ if (is_object($data) && is_a($data, 'PEAR_Error')) {
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * PEAR::raiseError implementation
+ *
+ * @param $message A text error message
+ *
+ * @return PEAR_Error Instance of PEAR_Error
+ * @access private
+ */
+ function _raiseError($message)
+ {
+ // PEAR::raiseError() is not PHP 5.4 compatible
+ return new PEAR_Error($message);
+ }
+
} // End of class
--
Gitblit v1.9.1