]> git.mxchange.org Git - friendica.git/blobdiff - src/Protocol/Email.php
Merge pull request #11519 from MrPetovan/task/11511-console-domain-move
[friendica.git] / src / Protocol / Email.php
index b1eeb94d62f8903023c97ae3bec2074b9e828300..db22b76973b736ef86f9ecb6a591aca081771c07 100644 (file)
@@ -1,13 +1,36 @@
 <?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;
 
-require_once 'include/html2plain.php';
+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
 {
@@ -15,7 +38,8 @@ class Email
         * @param string $mailbox  The mailbox name
         * @param string $username The username
         * @param string $password The password
-        * @return object
+        * @return Connection|resource
+        * @throws \Exception
         */
        public static function connect($mailbox, $username, $password)
        {
@@ -25,39 +49,50 @@ class Email
 
                $mbox = @imap_open($mailbox, $username, $password);
 
+               $errors = imap_errors();
+               if (!empty($errors)) {
+                       Logger::notice('IMAP Errors occured', ['errors' => $errors]);
+               }
+
+               $alerts = imap_alerts();
+               if (!empty($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, $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));
@@ -78,8 +113,8 @@ class Email
        }
 
        /**
-        * @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)
@@ -89,29 +124,42 @@ class Email
        }
 
        /**
-        * @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
         * @return array
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function getMessage($mbox, $uid, $reply)
+       public static function getMessage($mbox, $uid, $reply, $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'] = html2bbcode($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 = '';
@@ -127,10 +175,17 @@ class Email
                                        $html .= $x;
                                }
                        }
-                       if (trim($html) != '') {
-                               $ret['body'] = html2bbcode($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'];
                        }
                }
 
@@ -145,17 +200,22 @@ class Email
 
                $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)
@@ -163,8 +223,6 @@ class Email
                // $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)
@@ -232,9 +290,6 @@ class Email
                        $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;
                }
@@ -298,7 +353,7 @@ class Email
        }
 
        /**
-        * 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
@@ -308,6 +363,8 @@ class Email
         *
         * @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)
@@ -319,7 +376,7 @@ class Email
 
                $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";
@@ -328,7 +385,7 @@ class Email
                $body .= "Content-Transfer-Encoding: 8bit\n";
                $body .= "Content-Type: text/plain; charset=utf-8; format=flowed\n\n";
 
-               $body .= html2plain($html)."\n";
+               $body .= HTML::toPlaintext($html)."\n";
 
                $body .= "--=_".$part."\n";
                $body .= "Content-Transfer-Encoding: 8bit\n";
@@ -340,7 +397,7 @@ class Email
 
                //$message = '<html><body>' . $html . '</body></html>';
                //$message = html2plain($html);
-               logger('notifier: email delivery to ' . $addr);
+               Logger::notice('notifier: email delivery to ' . $addr);
                mail($addr, $subject, $body, $headers);
        }
 
@@ -469,13 +526,11 @@ class Email
                        '[\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]);
+               if (preg_match($pattern, $message, $result)) {
+                       $cleaned = trim($result[1].$result[2].$result[3]);
 
-               $cleaned = str_replace(["\n- --\n", "\n- -"], ["\n-- \n", "\n-"], $cleaned);
-
-               if ($cleaned == '') {
+                       $cleaned = str_replace(["\n- --\n", "\n- -"], ["\n-- \n", "\n-"], $cleaned);
+               } else {
                        $cleaned = $message;
                }
 
@@ -503,7 +558,7 @@ class Email
 
                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 {
@@ -534,7 +589,7 @@ class Email
                        }
 
                        $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) == '>') {
@@ -544,27 +599,7 @@ class Email
                                $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] .= ' ';
                                }
@@ -574,13 +609,15 @@ class Email
 
                                        $line = ltrim(substr($line, 1));
                                }
+                       } else {
+                               $lines[$lineno] = '';
                        }
 
                        $lines[$lineno] .= $line;
                        if (((substr($line, -1, 1) != ' '))
                                || ($quotelevel != $currquotelevel)) {
                                $lineno++;
-                               }
+                       }
                }
                return implode("\n", $lines);
        }
@@ -608,13 +645,11 @@ class Email
                }
 
                $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]";