/usr/share/php/Horde/Imap/Client/Data/BaseSubject.php is in php-horde-imap-client 2.29.12-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | <?php
/**
* Copyright 2008-2016 Horde LLC (http://www.horde.org/)
*
* getBaseSubject() code adapted from imap-base-subject.c (Dovecot 1.2)
* Original code released under the LGPL-2.1
* Copyright (c) 2002-2008 Timo Sirainen <tss@iki.fi>
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Horde
* @copyright 2002-2008 Timo Sirainen
* @copyright 2008-2016 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Imap_Client
*/
/**
* Determines the "base subject" of a string (RFC 5256 [2.1]).
*
* @author Timo Sirainen <tss@iki.fi>
* @author Michael Slusarz <slusarz@horde.org>
* @category Horde
* @copyright 2002-2008 Timo Sirainen
* @copyright 2011-2016 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Imap_Client
*/
class Horde_Imap_Client_Data_BaseSubject
{
/**
* The base subject.
*
* @var string
*/
protected $_subject;
/**
* Constructor.
*
* @param string $str The subject string.
* @param array $opts Additional options:
* - keepblob: (boolean) Don't remove any "blob" information (i.e. text
* leading text between square brackets) from string.
*
* @return string The cleaned up subject string.
*/
public function __construct($str, array $opts = array())
{
// Rule 1a: MIME decode.
$str = Horde_Mime::decode($str);
// Rule 1b: Remove superfluous whitespace.
$str = preg_replace("/[\t\r\n ]+/", ' ', $str);
do {
/* (2) Remove all trailing text of the subject that matches the
* the subj-trailer ABNF, repeat until no more matches are
* possible. */
$str = preg_replace("/(?:\s*\(fwd\)\s*)+$/i", '', $str);
do {
/* (3) Remove all prefix text of the subject that matches the
* subj-leader ABNF. */
$found = $this->_removeSubjLeader($str, !empty($opts['keepblob']));
/* (4) If there is prefix text of the subject that matches
* the subj-blob ABNF, and removing that prefix leaves a
* non-empty subj-base, then remove the prefix text. */
$found = (empty($opts['keepblob']) && $this->_removeBlobWhenNonempty($str)) || $found;
/* (5) Repeat (3) and (4) until no matches remain. */
} while ($found);
/* (6) If the resulting text begins with the subj-fwd-hdr ABNF and
* ends with the subj-fwd-trl ABNF, remove the subj-fwd-hdr and
* subj-fwd-trl and repeat from step (2). */
} while ($this->_removeSubjFwdHdr($str));
$this->_subject = strval($str);
}
/**
* Return the "base subject" defined in RFC 5256 [2.1].
*
* @return string The base subject.
*/
public function __toString()
{
return $this->_subject;
}
/**
* Remove all prefix text of the subject that matches the subj-leader
* ABNF.
*
* @param string &$str The subject string.
* @param boolean $keepblob Remove blob information?
*
* @return boolean True if string was altered.
*/
protected function _removeSubjLeader(&$str, $keepblob = false)
{
$ret = false;
if (!strlen($str)) {
return $ret;
}
if ($len = strspn($str, " \t")) {
$str = substr($str, $len);
$ret = true;
}
$i = 0;
if (!$keepblob) {
while (isset($str[$i]) && ($str[$i] === '[')) {
if (($i = $this->_removeBlob($str, $i)) === false) {
return $ret;
}
}
}
if (stripos($str, 're', $i) === 0) {
$i += 2;
} elseif (stripos($str, 'fw', $i) === 0) {
$i += (stripos($str, 'fwd', $i) === 0) ? 3 : 2;
} else {
return $ret;
}
$i += strspn($str, " \t", $i);
if (!$keepblob) {
while (isset($str[$i]) && ($str[$i] === '[')) {
if (($i = $this->_removeBlob($str, $i)) === false) {
return $ret;
}
}
}
if (!isset($str[$i]) || ($str[$i] !== ':')) {
return $ret;
}
$str = substr($str, ++$i);
return true;
}
/**
* Remove "[...]" text.
*
* @param string $str The subject string.
* @param integer $i Current position.
*
* @return boolean|integer False if blob was not found, otherwise the
* string position of the first non-blob char.
*/
protected function _removeBlob($str, $i)
{
if ($str[$i] !== '[') {
return false;
}
++$i;
for ($cnt = strlen($str); $i < $cnt; ++$i) {
if ($str[$i] === ']') {
break;
}
if ($str[$i] === '[') {
return false;
}
}
if ($i === ($cnt - 1)) {
return false;
}
++$i;
if ($str[$i] === ' ') {
++$i;
}
return $i;
}
/**
* Remove "[...]" text if it doesn't result in the subject becoming
* empty.
*
* @param string &$str The subject string.
*
* @return boolean True if string was altered.
*/
protected function _removeBlobWhenNonempty(&$str)
{
if ($str &&
($str[0] === '[') &&
(($i = $this->_removeBlob($str, 0)) !== false) &&
($i !== strlen($str))) {
$str = substr($str, $i);
return true;
}
return false;
}
/**
* Remove a "[fwd: ... ]" string.
*
* @param string &$str The subject string.
*
* @return boolean True if string was altered.
*/
protected function _removeSubjFwdHdr(&$str)
{
if ((stripos($str, '[fwd:') !== 0) || (substr($str, -1) !== ']')) {
return false;
}
$str = substr($str, 5, -1);
return true;
}
}
|