<?php
/**
- * @file src/Protocol/Email.php
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
+
namespace Friendica\Protocol;
+use Friendica\Core\Hook;
+use Friendica\Core\Logger;
+use Friendica\Content\Text\BBCode;
use Friendica\Content\Text\HTML;
+use Friendica\Model\Item;
+use Friendica\Util\Strings;
+use \IMAP\Connection;
/**
- * @brief Email class
+ * Email class
*/
class Email
{
* @param string $mailbox The mailbox name
* @param string $username The username
* @param string $password The password
- * @return object
+ * @return Connection|resource|bool
+ * @throws \Exception
*/
- public static function connect($mailbox, $username, $password)
+ public static function connect(string $mailbox, string $username, string $password)
{
if (!function_exists('imap_open')) {
return false;
$errors = imap_errors();
if (!empty($errors)) {
- logger('IMAP Errors occured: ' . json_encode($errors));
+ Logger::notice('IMAP Errors occured', ['errors' => $errors]);
}
$alerts = imap_alerts();
if (!empty($alerts)) {
- logger('IMAP Alerts occured: ' . json_encode($alerts));
+ Logger::notice('IMAP Alerts occured: ', ['alerts' => $alerts]);
}
return $mbox;
}
/**
- * @param object $mbox mailbox
- * @param string $email_addr email
+ * @param Connection|resource $mbox mailbox
+ * @param string $email_addr email
* @return array
+ * @throws \Exception
*/
- public static function poll($mbox, $email_addr)
+ public static function poll($mbox, string $email_addr): array
{
if (!$mbox || !$email_addr) {
return [];
}
- $search1 = @imap_search($mbox, 'FROM "' . $email_addr . '"', SE_UID);
+ $search1 = @imap_search($mbox, 'UNDELETED FROM "' . $email_addr . '"', SE_UID);
if (!$search1) {
$search1 = [];
} else {
- logger("Found mails from ".$email_addr, LOGGER_DEBUG);
+ Logger::notice("Found mails from ".$email_addr);
}
- $search2 = @imap_search($mbox, 'TO "' . $email_addr . '"', SE_UID);
+ $search2 = @imap_search($mbox, 'UNDELETED TO "' . $email_addr . '"', SE_UID);
if (!$search2) {
$search2 = [];
} else {
- logger("Found mails to ".$email_addr, LOGGER_DEBUG);
+ Logger::notice("Found mails to ".$email_addr);
}
- $search3 = @imap_search($mbox, 'CC "' . $email_addr . '"', SE_UID);
+ $search3 = @imap_search($mbox, 'UNDELETED CC "' . $email_addr . '"', SE_UID);
if (!$search3) {
$search3 = [];
} else {
- logger("Found mails cc ".$email_addr, LOGGER_DEBUG);
+ Logger::notice("Found mails cc ".$email_addr);
}
$res = array_unique(array_merge($search1, $search2, $search3));
}
/**
+ * Returns mailbox name
+ *
* @param array $mailacct mail account
* @return string
*/
- public static function constructMailboxName($mailacct)
+ public static function constructMailboxName(array $mailacct): string
{
$ret = '{' . $mailacct['server'] . ((intval($mailacct['port'])) ? ':' . $mailacct['port'] : '');
$ret .= (($mailacct['ssltype']) ? '/' . $mailacct['ssltype'] . '/novalidate-cert' : '');
}
/**
- * @param object $mbox mailbox
- * @param integer $uid user id
+ * @param Connection|resource $mbox mailbox
+ * @param integer $uid user id
* @return mixed
*/
- public static function messageMeta($mbox, $uid)
+ public static function messageMeta($mbox, int $uid)
{
$ret = (($mbox && $uid) ? @imap_fetch_overview($mbox, $uid, FT_UID) : [[]]); // POSSIBLE CLEANUP --> array(array()) is probably redundant now
return (count($ret)) ? $ret : [];
}
/**
- * @param object $mbox mailbox
- * @param integer $uid user id
- * @param string $reply reply
+ * @param Connection|resource $mbox mailbox
+ * @param integer $uid user id
+ * @param string $reply reply
+ * @param array $item Item
* @return array
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function getMessage($mbox, $uid, $reply)
+ public static function getMessage($mbox, int $uid, string $reply, array $item): array
{
- $ret = [];
+ $ret = $item;
$struc = (($mbox && $uid) ? @imap_fetchstructure($mbox, $uid, FT_UID) : null);
if (!$struc) {
+ Logger::notice("IMAP structure couldn't be fetched", ['uid' => $uid]);
return $ret;
}
- if (!$struc->parts) {
- $ret['body'] = self::messageGetPart($mbox, $uid, $struc, 0, 'html');
- $html = $ret['body'];
+ if (empty($struc->parts)) {
+ $html = trim(self::messageGetPart($mbox, $uid, $struc, 0, 'html'));
- if (trim($ret['body']) == '') {
- $ret['body'] = self::messageGetPart($mbox, $uid, $struc, 0, 'plain');
- } else {
- $ret['body'] = HTML::toBBCode($ret['body']);
+ if (!empty($html)) {
+ $message = ['text' => '', 'html' => $html, 'item' => $ret];
+ Hook::callAll('email_getmessage', $message);
+ $ret = $message['item'];
+ if (empty($ret['body'])) {
+ $ret['body'] = HTML::toBBCode($message['html']);
+ }
+ }
+
+ if (empty($ret['body'])) {
+ $text = self::messageGetPart($mbox, $uid, $struc, 0, 'plain');
+
+ $message = ['text' => $text, 'html' => '', 'item' => $ret];
+ Hook::callAll('email_getmessage', $message);
+ $ret = $message['item'];
+ $ret['body'] = $message['text'];
}
} else {
$text = '';
$html .= $x;
}
}
- if (trim($html) != '') {
- $ret['body'] = HTML::toBBCode($html);
- } else {
- $ret['body'] = $text;
+
+ $message = ['text' => trim($text), 'html' => trim($html), 'item' => $ret];
+ Hook::callAll('email_getmessage', $message);
+ $ret = $message['item'];
+
+ if (empty($ret['body']) && !empty($message['html'])) {
+ $ret['body'] = HTML::toBBCode($message['html']);
+ }
+
+ if (empty($ret['body'])) {
+ $ret['body'] = $message['text'];
}
}
$ret['body'] = self::unifyAttributionLine($ret['body']);
+ $ret['body'] = Strings::escapeHtml($ret['body']);
+ $ret['body'] = BBCode::limitBodySize($ret['body']);
+
+ Hook::callAll('email_getmessage_end', $ret);
+
return $ret;
}
- // At the moment - only return plain/text.
- // Later we'll repackage inline images as data url's and make the HTML safe
/**
- * @param object $mbox mailbox
- * @param integer $uid user id
- * @param object $p parts
- * @param integer $partno part number
- * @param string $subtype sub type
+ * fetch the specified message part number with the specified subtype
+ *
+ * @param Connection|resource $mbox mailbox
+ * @param integer $uid user id
+ * @param object $p parts
+ * @param integer $partno part number
+ * @param string $subtype sub type
* @return string
*/
- private static function messageGetPart($mbox, $uid, $p, $partno, $subtype)
+ private static function messageGetPart($mbox, int $uid, $p, in $partno, string $subtype): string
{
// $partno = '1', '2', '2.1', '2.1.3', etc for multipart, 0 if simple
global $htmlmsg,$plainmsg,$charset,$attachments;
- //echo $partno."\n";
-
// DECODE DATA
$data = ($partno)
? @imap_fetchbody($mbox, $uid, $partno, FT_UID|FT_PEEK)
$x = "";
foreach ($p->parts as $partno0 => $p2) {
$x .= self::messageGetPart($mbox, $uid, $p2, $partno . '.' . ($partno0+1), $subtype); // 1.2, 1.2.1, etc.
- //if ($x) {
- // return $x;
- //}
}
return $x;
}
}
/**
+ * Returns encoded header
+ *
* @param string $in_str in string
* @param string $charset character set
* @return string
*/
- public static function encodeHeader($in_str, $charset)
+ public static function encodeHeader(string $in_str, string $charset): string
{
$out_str = $in_str;
$need_to_convert = false;
}
/**
- * Function send is used by NETWORK_EMAIL and NETWORK_EMAIL2 code
+ * Function send is used by Protocol::EMAIL code
* (not to notify the user, but to send items to email contacts)
*
* @param string $addr address
* @param string $subject subject
* @param string $headers headers
* @param array $item item
+ * @return bool Status from mail()
*
- * @return void
- *
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ * @throws \ImagickException
* @todo This could be changed to use the Emailer class
*/
- public static function send($addr, $subject, $headers, $item)
+ public static function send(string $addr, string $subject, string $headers, array$item)
{
//$headers .= 'MIME-Version: 1.0' . "\n";
//$headers .= 'Content-Type: text/html; charset=UTF-8' . "\n";
//$headers .= 'Content-Type: text/plain; charset=UTF-8' . "\n";
//$headers .= 'Content-Transfer-Encoding: 8bit' . "\n\n";
- $part = uniqid("", true);
+ $part = uniqid('', true);
- $html = prepare_body($item);
+ $html = Item::prepareBody($item);
$headers .= "Mime-Version: 1.0\n";
$headers .= 'Content-Type: multipart/alternative; boundary="=_'.$part.'"'."\n\n";
//$message = '<html><body>' . $html . '</body></html>';
//$message = html2plain($html);
- logger('notifier: email delivery to ' . $addr);
- mail($addr, $subject, $body, $headers);
+ Logger::notice('notifier: email delivery to ' . $addr);
+ return mail($addr, $subject, $body, $headers);
}
/**
- * @param string $iri string
- * @return string
+ * Convert item URI to message id
+ *
+ * @param string $itemUri Item URI
+ * @return string Message id
*/
- public static function iri2msgid($iri)
+ public static function iri2msgid(string $itemUri): string
{
- if (!strpos($iri, "@")) {
- $msgid = preg_replace("/urn:(\S+):(\S+)\.(\S+):(\d+):(\S+)/i", "urn!$1!$4!$5@$2.$3", $iri);
- } else {
- $msgid = $iri;
+ $msgid = $itemUri;
+
+ if (!strpos($itemUri, '@')) {
+ $msgid = preg_replace("/urn:(\S+):(\S+)\.(\S+):(\d+):(\S+)/i", "urn!$1!$4!$5@$2.$3", $itemUri);
}
return $msgid;
}
/**
- * @param string $msgid msgid
- * @return string
+ * Converts message id to item URI
+ *
+ * @param string $msgid Message id
+ * @return string Item URI
*/
- public static function msgid2iri($msgid)
+ public static function msgid2iri(string $msgid): string
{
- if (strpos($msgid, "@")) {
- $iri = preg_replace("/urn!(\S+)!(\d+)!(\S+)@(\S+)\.(\S+)/i", "urn:$1:$4.$5:$2:$3", $msgid);
- } else {
- $iri = $msgid;
+ $itemUri = $msgid;
+
+ if (strpos($msgid, '@')) {
+ $itemUri = preg_replace("/urn!(\S+)!(\d+)!(\S+)@(\S+)\.(\S+)/i", "urn:$1:$4.$5:$2:$3", $msgid);
}
- return $iri;
+ return $itemUri;
}
- private static function saveReplace($pattern, $replace, $text)
+ /**
+ * Invokes preg_replace() but does return full text from parameter if it
+ * returned an empty message.
+ *
+ * @param string $pattern Pattern to match
+ * @param string $replace String to replace with
+ * @param string $text String to check
+ * @return string Replaced string
+ */
+ private static function saveReplace(string $pattern, string $replace, string $text): string
{
- $save = $text;
+ $return = preg_replace($pattern, $replace, $text);
- $text = preg_replace($pattern, $replace, $text);
-
- if ($text == '') {
- $text = $save;
+ if ($return == '') {
+ $return = $text;
}
- return $text;
+
+ return $return;
}
- private static function unifyAttributionLine($message)
+ /**
+ * Unifies attribution line(s)
+ *
+ * @param string $message Unfiltered message
+ * @return string Message with unified attribution line(s)
+ */
+ private static function unifyAttributionLine(string $message): string
{
$quotestr = ['quote', 'spoiler'];
foreach ($quotestr as $quote) {
return $message;
}
- private static function removeGPG($message)
+ /**
+ * Removes GPG part from message
+ *
+ * @param string $message Unfiltered message
+ * @return string Message with GPG part
+ */
+ private static function removeGPG(string $message): string
{
$pattern = '/(.*)\s*-----BEGIN PGP SIGNED MESSAGE-----\s*[\r\n].*Hash:.*?[\r\n](.*)'.
'[\r\n]\s*-----BEGIN PGP SIGNATURE-----\s*[\r\n].*'.
'[\r\n]\s*-----END PGP SIGNATURE-----(.*)/is';
- preg_match($pattern, $message, $result);
-
- $cleaned = trim($result[1].$result[2].$result[3]);
-
- $cleaned = str_replace(["\n- --\n", "\n- -"], ["\n-- \n", "\n-"], $cleaned);
+ if (preg_match($pattern, $message, $result)) {
+ $cleaned = trim($result[1].$result[2].$result[3]);
- if ($cleaned == '') {
+ $cleaned = str_replace(["\n- --\n", "\n- -"], ["\n-- \n", "\n-"], $cleaned);
+ } else {
$cleaned = $message;
}
return $cleaned;
}
- private static function removeSig($message)
+ /**
+ * Removes signature from message
+ *
+ * @param string $message Unfiltered message
+ * @return string Message with no signature
+ */
+ private static function removeSig(string $message): string
{
$sigpos = strrpos($message, "\n-- \n");
$quotepos = strrpos($message, "[/quote]");
preg_match($pattern, $message, $result);
- if (($result[1] != '') && ($result[2] != '')) {
+ if (!empty($result[1]) && !empty($result[2])) {
$cleaned = trim($result[1])."\n";
$sig = trim($result[2]);
} else {
return ['body' => $cleaned, 'sig' => $sig];
}
- private static function removeLinebreak($message)
+ /**
+ * Removes lines breaks from message
+ *
+ * @param string $message Unfiltered message
+ * @return string Message with no line breaks
+ */
+ private static function removeLinebreak(string $message): string
{
$arrbody = explode("\n", trim($message));
}
$quotelevel = 0;
- $nextline = trim($arrbody[$i+1]);
+ $nextline = trim($arrbody[$i + 1] ?? '');
while ((strlen($nextline)>0) && ((substr($nextline, 0, 1) == '>')
|| (substr($nextline, 0, 1) == ' '))) {
if (substr($nextline, 0, 1) == '>') {
$nextline = ltrim(substr($nextline, 1));
}
- $firstword = strpos($nextline.' ', ' ');
-
- $specialchars = ((substr(trim($nextline), 0, 1) == '-') ||
- (substr(trim($nextline), 0, 1) == '=') ||
- (substr(trim($nextline), 0, 1) == '*') ||
- (substr(trim($nextline), 0, 1) == '·') ||
- (substr(trim($nextline), 0, 4) == '[url') ||
- (substr(trim($nextline), 0, 5) == '[size') ||
- (substr(trim($nextline), 0, 7) == 'http://') ||
- (substr(trim($nextline), 0, 8) == 'https://'));
-
- if (!$specialchars) {
- $specialchars = ((substr(rtrim($line), -1) == '-') ||
- (substr(rtrim($line), -1) == '=') ||
- (substr(rtrim($line), -1) == '*') ||
- (substr(rtrim($line), -1) == '·') ||
- (substr(rtrim($line), -6) == '[/url]') ||
- (substr(rtrim($line), -7) == '[/size]'));
- }
-
- if ($lines[$lineno] != '') {
+ if (!empty($lines[$lineno])) {
if (substr($lines[$lineno], -1) != ' ') {
$lines[$lineno] .= ' ';
}
$line = ltrim(substr($line, 1));
}
+ } else {
+ $lines[$lineno] = '';
}
$lines[$lineno] .= $line;
if (((substr($line, -1, 1) != ' '))
|| ($quotelevel != $currquotelevel)) {
$lineno++;
- }
+ }
}
return implode("\n", $lines);
}
- private static function convertQuote($body, $reply)
+ private static function convertQuote(strng $body, string $reply): string
{
// Convert Quotes
$arrbody = explode("\n", trim($body));
}
$quotelevel = 0;
- $previousquote = 0;
$arrbodyquoted = [];
for ($i = 0; $i < count($arrbody); $i++) {
$previousquote = $quotelevel;
$quotelevel = $arrlevel[$i];
- $currline = $arrbody[$i];
while ($previousquote < $quotelevel) {
$quote = "[quote]";
return $body;
}
- private static function removeToFu($message)
+ private static function removeToFu(string $message): string
{
$message = trim($message);
do {
$oldmessage = $message;
$message = preg_replace('=\[/quote\][\s](.*?)\[quote\]=i', '$1', $message);
- $message = str_replace("[/quote][quote]", "", $message);
+ $message = str_replace('[/quote][quote]', '', $message);
} while ($message != $oldmessage);
$quotes = [];
$start = $pos + 7;
}
- if (strtolower(substr($message, -8)) != '[/quote]')
+ if (strtolower(substr($message, -8)) != '[/quote]') {
return($message);
+ }
krsort($quotes);
}
if ($quotestart != 0) {
- $message = trim(substr($message, 0, $quotestart))."\n[spoiler]".substr($message, $quotestart+7, -8).'[/spoiler]';
+ $message = trim(substr($message, 0, $quotestart))."\n[spoiler]".substr($message, $quotestart+7, -8) . '[/spoiler]';
}
return $message;
projects / friendica.git / blobdiff