* @param array $params A hash containing any additional configuration or
* connection parameters a subclass might need.
*
- * @return mixed The newly created concrete Horde_Imap_Client instance.
+ * @return Horde_Imap_Client_Base The newly created Horde_Imap_Client instance.
*/
- static final public function getInstance($driver, $params = array())
+ static public function getInstance($driver, $params = array())
{
$class = 'Horde_Imap_Client_' . strtr(basename($driver), '-', '_');
if (!class_exists($class)) {
return new $class($params);
}
- /**
- * Create an IMAP message sequence string from a list of indices.
- * Format: range_start:range_end,uid,uid2,range2_start:range2_end,...
- *
- * @param array $in An array of indices.
- * @param array $options Additional options:
- * <pre>
- * 'nosort' - (boolean) Do not numerically sort the IDs before creating
- * the range?
- * DEFAULT: IDs are sorted
- * </pre>
- *
- * @return string The IMAP message sequence string.
- */
- static final public function toSequenceString($ids, $options = array())
- {
- if (empty($ids)) {
- return '';
- }
-
- // Make sure IDs are unique
- $ids = array_keys(array_flip($ids));
-
- if (empty($options['nosort'])) {
- sort($ids, SORT_NUMERIC);
- }
-
- $first = $last = array_shift($ids);
- $out = array();
-
- foreach ($ids as $val) {
- if ($last + 1 == $val) {
- $last = $val;
- } else {
- $out[] = $first . ($last == $first ? '' : (':' . $last));
- $first = $last = $val;
- }
- }
- $out[] = $first . ($last == $first ? '' : (':' . $last));
-
- return implode(',', $out);
- }
-
- /**
- * Parse an IMAP message sequence string into a list of indices.
- * Format: range_start:range_end,uid,uid2,range2_start:range2_end,...
- *
- * @param string $str The IMAP message sequence string.
- *
- * @return array An array of indices.
- */
- static final public function fromSequenceString($str)
- {
- $ids = array();
- $str = trim($str);
-
- $idarray = explode(',', $str);
- if (empty($idarray)) {
- $idarray = array($str);
- }
-
- foreach ($idarray as $val) {
- $range = array_map('intval', explode(':', $val));
- if (count($range) == 1) {
- $ids[] = $val;
- } else {
- list($low, $high) = ($range[0] < $range[1]) ? $range : array_reverse($range);
- $ids = array_merge($ids, range($low, $high));
- }
- }
-
- return $ids;
- }
-
- /**
- * Remove "bare newlines" from a string.
- *
- * @param string $str The original string.
- *
- * @return string The string with all bare newlines removed.
- */
- static final public function removeBareNewlines($str)
- {
- return str_replace(array("\r\n", "\n"), array("\n", "\r\n"), $str);
- }
-
- /**
- * Escape IMAP output via a quoted string (see RFC 3501 [4.3]).
- *
- * @param string $str The unescaped string.
- *
- * @return string The escaped string.
- */
- static final public function escape($str)
- {
- return '"' . addcslashes($str, '"\\') . '"';
- }
-
- /**
- * Return the "base subject" defined in RFC 5256 [2.1].
- *
- * @param string $str The original subject string.
- * @param array $options Additional options:
- * <pre>
- * 'keepblob' - (boolean) Don't remove any "blob" information (i.e. text
- * leading text between square brackets) from string.
- * </pre>
- *
- * @return string The cleaned up subject string.
- */
- static final public function getBaseSubject($str, $options = array())
- {
- // Rule 1a: MIME decode to UTF-8 (if possible).
- $str = Horde_Mime::decode($str, 'UTF-8');
-
- // Rule 1b: Remove superfluous whitespace.
- $str = preg_replace("/\s{2,}/", '', $str);
-
- if (!$str) {
- return '';
- }
-
- 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 = self::_removeSubjLeader($str, !empty($options['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($options['keepblob']) && self::_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 (self::_removeSubjFwdHdr($str));
-
- return $str;
- }
-
- /**
- * 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.
- */
- static final protected function _removeSubjLeader(&$str, $keepblob = false)
- {
- $ret = false;
-
- if (!$str) {
- return $ret;
- }
-
- if ($str[0] == ' ') {
- $str = substr($str, 1);
- $ret = true;
- }
-
- $i = 0;
-
- if (!$keepblob) {
- while ($str[$i] == '[') {
- if (($i = self::_removeBlob($str, $i)) === false) {
- return $ret;
- }
- }
- }
-
- $cmp_str = substr($str, $i);
- if (stripos($cmp_str, 're') === 0) {
- $i += 2;
- } elseif (stripos($cmp_str, 'fwd') === 0) {
- $i += 3;
- } elseif (stripos($cmp_str, 'fw') === 0) {
- $i += 2;
- } else {
- return $ret;
- }
-
- if ($str[$i] == ' ') {
- ++$i;
- }
-
- if (!$keepblob) {
- while ($str[$i] == '[') {
- if (($i = self::_removeBlob($str, $i)) === false) {
- return $ret;
- }
- }
- }
-
- if ($str[$i] != ':') {
- return $ret;
- }
-
- $str = substr($str, ++$i);
-
- return true;
- }
-
- /**
- * Remove "[...]" text.
- *
- * @param string &$str The subject string.
- *
- * @return boolean True if string was altered.
- */
- static final 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.
- */
- static final protected function _removeBlobWhenNonempty(&$str)
- {
- if ($str &&
- ($str[0] == '[') &&
- (($i = self::_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.
- */
- static final protected function _removeSubjFwdHdr(&$str)
- {
- if ((stripos($str, '[fwd:') !== 0) || (substr($str, -1) != ']')) {
- return false;
- }
-
- $str = substr($str, 5, -1);
- return true;
- }
-
- /**
- * Parse an IMAP URL (RFC 5092).
- *
- * @param string $url A IMAP URL string.
- *
- * @return mixed False if the URL is invalid. If valid, a URL with the
- * following fields:
- * <pre>
- * 'auth' - (string) The authentication method to use.
- * 'port' - (integer) The remote port
- * 'hostspec' - (string) The remote server
- * 'username' - (string) The username to use on the remote server.
- * </pre>
- */
- static final public function parseImapURL($url)
- {
- $url = trim($url);
- if (stripos($url, 'imap://') !== 0) {
- return false;
- }
- $url = substr($url, 7);
-
- /* At present, only support imap://<iserver>[/] style URLs. */
- if (($pos = strpos($url, '/')) !== false) {
- $url = substr($url, 0, $pos);
- }
-
- $ret_array = array();
-
- /* Check for username/auth information. */
- if (($pos = strpos($url, '@')) !== false) {
- if ((($apos = stripos($url, ';AUTH=')) !== false) &&
- ($apos < $pos)) {
- $auth = substr($url, $apos + 6, $pos - $apos - 6);
- if ($auth != '*') {
- $ret_array['auth'] = $auth;
- }
- if ($apos) {
- $ret_array['username'] = substr($url, 0, $apos);
- }
- }
- $url = substr($url, $pos + 1);
- }
-
- /* Check for port information. */
- if (($pos = strpos($url, ':')) !== false) {
- $ret_array['port'] = substr($url, $pos + 1);
- $url = substr($url, 0, $pos);
- }
-
- $ret_array['hostspec'] = $url;
-
- return $ret_array;
- }
-
}
* @category Horde
* @package Horde_Imap_Client
*/
-abstract class Horde_Imap_Client_Base extends Horde_Imap_Client
+abstract class Horde_Imap_Client_Base
{
/**
* Hash containing connection parameters.
protected $_debug = null;
/**
+ * Create an IMAP message sequence string from a list of indices.
+ * Format: range_start:range_end,uid,uid2,range2_start:range2_end,...
+ *
+ * @param array $in An array of indices.
+ * @param array $options Additional options:
+ * <pre>
+ * 'nosort' - (boolean) Do not numerically sort the IDs before creating
+ * the range?
+ * DEFAULT: IDs are sorted
+ * </pre>
+ *
+ * @return string The IMAP message sequence string.
+ */
+ static public function toSequenceString($ids, $options = array())
+ {
+ if (empty($ids)) {
+ return '';
+ }
+
+ // Make sure IDs are unique
+ $ids = array_keys(array_flip($ids));
+
+ if (empty($options['nosort'])) {
+ sort($ids, SORT_NUMERIC);
+ }
+
+ $first = $last = array_shift($ids);
+ $out = array();
+
+ foreach ($ids as $val) {
+ if ($last + 1 == $val) {
+ $last = $val;
+ } else {
+ $out[] = $first . ($last == $first ? '' : (':' . $last));
+ $first = $last = $val;
+ }
+ }
+ $out[] = $first . ($last == $first ? '' : (':' . $last));
+
+ return implode(',', $out);
+ }
+
+ /**
+ * Parse an IMAP message sequence string into a list of indices.
+ * Format: range_start:range_end,uid,uid2,range2_start:range2_end,...
+ *
+ * @param string $str The IMAP message sequence string.
+ *
+ * @return array An array of indices.
+ */
+ static public function fromSequenceString($str)
+ {
+ $ids = array();
+ $str = trim($str);
+
+ $idarray = explode(',', $str);
+ if (empty($idarray)) {
+ $idarray = array($str);
+ }
+
+ foreach ($idarray as $val) {
+ $range = array_map('intval', explode(':', $val));
+ if (count($range) == 1) {
+ $ids[] = $val;
+ } else {
+ list($low, $high) = ($range[0] < $range[1]) ? $range : array_reverse($range);
+ $ids = array_merge($ids, range($low, $high));
+ }
+ }
+
+ return $ids;
+ }
+
+ /**
+ * Remove "bare newlines" from a string.
+ *
+ * @param string $str The original string.
+ *
+ * @return string The string with all bare newlines removed.
+ */
+ static public function removeBareNewlines($str)
+ {
+ return str_replace(array("\r\n", "\n"), array("\n", "\r\n"), $str);
+ }
+
+ /**
+ * Escape IMAP output via a quoted string (see RFC 3501 [4.3]).
+ *
+ * @param string $str The unescaped string.
+ *
+ * @return string The escaped string.
+ */
+ static public function escape($str)
+ {
+ return '"' . addcslashes($str, '"\\') . '"';
+ }
+
+ /**
+ * Return the "base subject" defined in RFC 5256 [2.1].
+ *
+ * @param string $str The original subject string.
+ * @param array $options Additional options:
+ * <pre>
+ * 'keepblob' - (boolean) Don't remove any "blob" information (i.e. text
+ * leading text between square brackets) from string.
+ * </pre>
+ *
+ * @return string The cleaned up subject string.
+ */
+ static public function getBaseSubject($str, $options = array())
+ {
+ // Rule 1a: MIME decode to UTF-8 (if possible).
+ $str = Horde_Mime::decode($str, 'UTF-8');
+
+ // Rule 1b: Remove superfluous whitespace.
+ $str = preg_replace("/\s{2,}/", '', $str);
+
+ if (!$str) {
+ return '';
+ }
+
+ 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 = self::_removeSubjLeader($str, !empty($options['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($options['keepblob']) && self::_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 (self::_removeSubjFwdHdr($str));
+
+ return $str;
+ }
+
+ /**
+ * Parse an IMAP URL (RFC 5092).
+ *
+ * @param string $url A IMAP URL string.
+ *
+ * @return mixed False if the URL is invalid. If valid, a URL with the
+ * following fields:
+ * <pre>
+ * 'auth' - (string) The authentication method to use.
+ * 'port' - (integer) The remote port
+ * 'hostspec' - (string) The remote server
+ * 'username' - (string) The username to use on the remote server.
+ * </pre>
+ */
+ static public function parseImapUrl($url)
+ {
+ $url = trim($url);
+ if (stripos($url, 'imap://') !== 0) {
+ return false;
+ }
+ $url = substr($url, 7);
+
+ /* At present, only support imap://<iserver>[/] style URLs. */
+ if (($pos = strpos($url, '/')) !== false) {
+ $url = substr($url, 0, $pos);
+ }
+
+ $ret_array = array();
+
+ /* Check for username/auth information. */
+ if (($pos = strpos($url, '@')) !== false) {
+ if ((($apos = stripos($url, ';AUTH=')) !== false) &&
+ ($apos < $pos)) {
+ $auth = substr($url, $apos + 6, $pos - $apos - 6);
+ if ($auth != '*') {
+ $ret_array['auth'] = $auth;
+ }
+ if ($apos) {
+ $ret_array['username'] = substr($url, 0, $apos);
+ }
+ }
+ $url = substr($url, $pos + 1);
+ }
+
+ /* Check for port information. */
+ if (($pos = strpos($url, ':')) !== false) {
+ $ret_array['port'] = substr($url, $pos + 1);
+ $url = substr($url, 0, $pos);
+ }
+
+ $ret_array['hostspec'] = $url;
+
+ return $ret_array;
+ }
+
+ /**
+ * 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.
+ */
+ static protected function _removeSubjLeader(&$str, $keepblob = false)
+ {
+ $ret = false;
+
+ if (!$str) {
+ return $ret;
+ }
+
+ if ($str[0] == ' ') {
+ $str = substr($str, 1);
+ $ret = true;
+ }
+
+ $i = 0;
+
+ if (!$keepblob) {
+ while ($str[$i] == '[') {
+ if (($i = self::_removeBlob($str, $i)) === false) {
+ return $ret;
+ }
+ }
+ }
+
+ $cmp_str = substr($str, $i);
+ if (stripos($cmp_str, 're') === 0) {
+ $i += 2;
+ } elseif (stripos($cmp_str, 'fwd') === 0) {
+ $i += 3;
+ } elseif (stripos($cmp_str, 'fw') === 0) {
+ $i += 2;
+ } else {
+ return $ret;
+ }
+
+ if ($str[$i] == ' ') {
+ ++$i;
+ }
+
+ if (!$keepblob) {
+ while ($str[$i] == '[') {
+ if (($i = self::_removeBlob($str, $i)) === false) {
+ return $ret;
+ }
+ }
+ }
+
+ if ($str[$i] != ':') {
+ return $ret;
+ }
+
+ $str = substr($str, ++$i);
+
+ return true;
+ }
+
+ /**
+ * Remove "[...]" text.
+ *
+ * @param string &$str The subject string.
+ *
+ * @return boolean True if string was altered.
+ */
+ static 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.
+ */
+ static protected function _removeBlobWhenNonempty(&$str)
+ {
+ if ($str &&
+ ($str[0] == '[') &&
+ (($i = self::_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.
+ */
+ static protected function _removeSubjFwdHdr(&$str)
+ {
+ if ((stripos($str, '[fwd:') !== 0) || (substr($str, -1) != ']')) {
+ return false;
+ }
+
+ $str = substr($str, 5, -1);
+ return true;
+ }
+
+ /**
* Constructs a new Horde_Imap_Client object.
* Throws a Horde_Imap_Client_Exception on error.
*
case 'REFERRAL':
// Defined by RFC 2221
- $this->_temp['referral'] = $this->parseImapURL($data);
+ $this->_temp['referral'] = $this->parseImapUrl($data);
break;
case 'UNKNOWN-CTE':
}
if (!empty($argv[3])) {
- $params = array_merge($params, Horde_Imap_Client::parseImapURL($argv[3]));
+ $params = array_merge($params, Horde_Imap_Client::parseImapUrl($argv[3]));
}
function exception_handler($exception) {
foreach ($imap_urls as $val) {
print "URL: " . $val . "\n";
print "PARSED:\n";
- print_r(Horde_Imap_Client::parseImapURL($val));
+ print_r(Horde_Imap_Client::parseImapUrl($val));
print "\n";
}
projects / horde.git / commitdiff