]> git.mxchange.org Git - friendica-addons.git/blobdiff - mailstream/mailstream.php
recovered [mailstream] various modernisations
[friendica-addons.git] / mailstream / mailstream.php
index 60d6412b465451494040d089326205077d161313..542a1a4220367c9c60ee14fe1d3d0991822fc20f 100644 (file)
@@ -32,7 +32,6 @@ function mailstream_install()
        Hook::register('addon_settings_post', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings_post');
        Hook::register('post_local_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook');
        Hook::register('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook');
-       Hook::register('cron', 'addon/mailstream/mailstream.php', 'mailstream_cron');
        Hook::register('mailstream_send_hook', 'addon/mailstream/mailstream.php', 'mailstream_send_hook');
 
        Logger::info("mailstream: installed");
@@ -53,34 +52,35 @@ function mailstream_check_version()
                        'addon/mailstream/mailstream.php',
                        'mailstream_convert_table_entries'
                );
-               Hook::fork(PRIORITY_LOW, 'mailstream_convert_table_entries');
+               Hook::fork(Worker::PRIORITY_LOW, 'mailstream_convert_table_entries');
        }
 }
 
 /**
- * This function indicates a module that can be wrapped in the LegacyModule class
+ * This is a statement rather than an actual function definition. The simple
+ * existence of this method is checked to figure out if the addon offers a
+ * module.
  */
-function mailstream_module()
-{
-}
+function mailstream_module() {}
 
 /**
  * Adds an item in "addon features" in the admin menu of the site
  *
- * @param Friendica\App $a App object (unused)
+ * @param App $a App object (unused)
  * @param string        $o HTML form data
  */
-function mailstream_addon_admin(&$a, &$o)
+function mailstream_addon_admin(App $a, string &$o)
 {
        $frommail = DI::config()->get('mailstream', 'frommail');
        $template = Renderer::getMarkupTemplate('admin.tpl', 'addon/mailstream/');
        $config = ['frommail',
-                       DI::l10n()->t('From Address'),
-                       $frommail,
-                       DI::l10n()->t('Email address that stream items will appear to be from.')];
+               DI::l10n()->t('From Address'),
+               $frommail,
+               DI::l10n()->t('Email address that stream items will appear to be from.')];
        $o .= Renderer::replaceMacros($template, [
-                                '$frommail' => $config,
-                                '$submit' => DI::l10n()->t('Save Settings')]);
+               '$frommail' => $config,
+               '$submit' => DI::l10n()->t('Save Settings')
+       ]);
 }
 
 /**
@@ -101,7 +101,7 @@ function mailstream_addon_admin_post()
  *
  * @return string the created message ID
  */
-function mailstream_generate_id($uri)
+function mailstream_generate_id(string $uri): string
 {
        $host = DI::baseUrl()->getHostname();
        $resource = hash('md5', $uri);
@@ -110,7 +110,7 @@ function mailstream_generate_id($uri)
        return $message_id;
 }
 
-function mailstream_send_hook(&$a, $data)
+function mailstream_send_hook(App $a, array $data)
 {
        $criteria = array('uid' => $data['uid'], 'contact-id' => $data['contact-id'], 'uri' => $data['uri']);
        $item = Post::selectFirst([], $criteria);
@@ -138,15 +138,16 @@ function mailstream_send_hook(&$a, $data)
  * mailstream is enabled and the necessary data is available, forks a
  * workerqueue item to send the email.
  *
- * @param Friendica\App $a    App object (unused)
- * @param array         $item content of the item (may or may not already be stored in the item table)
+ * @param App $a    App object (unused)
+ * @param array     $item content of the item (may or may not already be stored in the item table)
+ * @return void
  */
-function mailstream_post_hook(&$a, &$item)
+function mailstream_post_hook(App $a, array &$item)
 {
        mailstream_check_version();
 
        if (!DI::pConfig()->get($item['uid'], 'mailstream', 'enabled')) {
-               Logger::debug('mailstream: not enabled for item ' . $item['id']);
+               Logger::debug('mailstream: not enabled.', ['item' => $item['id'], ' uid ' => $item['uid']]);
                return;
        }
        if (!$item['uid']) {
@@ -161,8 +162,8 @@ function mailstream_post_hook(&$a, &$item)
                Logger::debug('mailstream: no uri for item ' . $item['id']);
                return;
        }
-       if (!$item['plink']) {
-               Logger::debug('mailstream: no plink for item ' . $item['id']);
+       if ($item['verb'] == Activity::ANNOUNCE) {
+               Logger::debug('mailstream: announce item ', ['item' => $item['id']]);
                return;
        }
        if (DI::pConfig()->get($item['uid'], 'mailstream', 'nolikes')) {
@@ -174,12 +175,14 @@ function mailstream_post_hook(&$a, &$item)
 
        $message_id = mailstream_generate_id($item['uri']);
 
-       $send_hook_data = array('uid' => $item['uid'],
-                                                               'contact-id' => $item['contact-id'],
-                                                               'uri' => $item['uri'],
-                                                               'message_id' => $message_id,
-                                                               'tries' => 0);
-       Hook::fork(PRIORITY_LOW, 'mailstream_send_hook', $send_hook_data);
+       $send_hook_data = [
+               'uid' => $item['uid'],
+               'contact-id' => $item['contact-id'],
+               'uri' => $item['uri'],
+               'message_id' => $message_id,
+               'tries' => 0,
+       ];
+       Hook::fork(Worker::PRIORITY_LOW, 'mailstream_send_hook', $send_hook_data);
 }
 
 /**
@@ -193,25 +196,30 @@ function mailstream_post_hook(&$a, &$item)
  *
  * @return array new value of the attachments table (results are also stored in the reference parameter)
  */
-function mailstream_do_images(&$item, &$attachments)
+function mailstream_do_images(array &$item, array &$attachments)
 {
        if (!DI::pConfig()->get($item['uid'], 'mailstream', 'attachimg')) {
                return;
        }
+
        $attachments = [];
+
        preg_match_all("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", $item["body"], $matches1);
        preg_match_all("/\[img\](.*?)\[\/img\]/ism", $item["body"], $matches2);
        preg_match_all("/\[img\=([^\]]*)\]([^[]*)\[\/img\]/ism", $item["body"], $matches3);
+
        foreach (array_merge($matches1[3], $matches2[1], $matches3[1]) as $url) {
                $components = parse_url($url);
+
                if (!$components) {
                        continue;
                }
+
                $cookiejar = tempnam(System::getTempPath(), 'cookiejar-mailstream-');
                $curlResult = DI::httpClient()->fetchFull($url, HttpClientAccept::DEFAULT, 0, $cookiejar);
                $attachments[$url] = [
                        'data' => $curlResult->getBody(),
-                       'guid' => hash("crc32", $url),
+                       'guid' => hash('crc32', $url),
                        'filename' => basename($components['path']),
                        'type' => $curlResult->getContentType()
                ];
@@ -221,6 +229,7 @@ function mailstream_do_images(&$item, &$attachments)
                        continue;
                }
        }
+
        return $attachments;
 }
 
@@ -231,7 +240,7 @@ function mailstream_do_images(&$item, &$attachments)
  *
  * @return string sender suitable for use in the email
  */
-function mailstream_sender($item)
+function mailstream_sender(array $item): string
 {
        $contact = Contact::getById($item['contact-id']);
        if (DBA::isResult($contact)) {
@@ -249,7 +258,7 @@ function mailstream_sender($item)
  *
  * @return string plaintext subject line
  */
-function mailstream_decode_subject($subject)
+function mailstream_decode_subject(string $subject): string
 {
        $html = BBCode::convert($subject);
        if (!$html) {
@@ -264,7 +273,7 @@ function mailstream_decode_subject($subject)
                return $notags;
        }
        $nocodes = preg_replace_callback("/(&#[0-9]+;)/", function ($m) {
-               return mb_convert_encoding($m[1], "UTF-8", "HTML-ENTITIES");
+               return mb_convert_encoding($m[1], 'UTF-8', 'HTML-ENTITIES');
        }, $noentity);
        if (!$nocodes) {
                return $noentity;
@@ -283,7 +292,7 @@ function mailstream_decode_subject($subject)
  *
  * @return string subject line suitable for use in the email
  */
-function mailstream_subject($item)
+function mailstream_subject(array $item): string
 {
        if ($item['title']) {
                return mailstream_decode_subject($item['title']);
@@ -345,11 +354,11 @@ function mailstream_subject($item)
  *
  * @return bool True if this message has been completed.  False if it should be retried.
  */
-function mailstream_send($message_id, $item, $user)
+function mailstream_send(string $message_id, array $item, array $user): bool
 {
        if (!is_array($item)) {
                Logger::error('mailstream_send item is empty', ['message_id' => $message_id]);
-               return;
+               return false;
        }
 
        if (!$item['visible']) {
@@ -361,19 +370,22 @@ function mailstream_send($message_id, $item, $user)
                                'user email' => $user['email']]);
                return true;
        }
-       require_once(dirname(__file__).'/phpmailer/class.phpmailer.php');
+
+       require_once (dirname(__file__) . '/phpmailer/class.phpmailer.php');
+
+       $item['body'] = Post\Media::addAttachmentsToBody($item['uri-id'], $item['body']);
 
        $attachments = [];
        mailstream_do_images($item, $attachments);
        $frommail = DI::config()->get('mailstream', 'frommail');
-       if ($frommail == "") {
+       if ($frommail == '') {
                $frommail = 'friendica@localhost.local';
        }
        $address = DI::pConfig()->get($item['uid'], 'mailstream', 'address');
        if (!$address) {
                $address = $user['email'];
        }
-       $mail = new PHPmailer;
+       $mail = new PHPmailer();
        try {
                $mail->XMailer = 'Friendica Mailstream Addon';
                $mail->SetFrom($frommail, mailstream_sender($item));
@@ -384,7 +396,9 @@ function mailstream_send($message_id, $item, $user)
                        $mail->addCustomHeader('In-Reply-To: ' . mailstream_generate_id($item['thr-parent']));
                }
                $mail->addCustomHeader('X-Friendica-Mailstream-URI: ' . $item['uri']);
-               $mail->addCustomHeader('X-Friendica-Mailstream-Plink: ' . $item['plink']);
+               if ($item['plink']) {
+                       $mail->addCustomHeader('X-Friendica-Mailstream-Plink: ' . $item['plink']);
+               }
                $encoding = 'base64';
                foreach ($attachments as $url => $image) {
                        $mail->AddStringEmbeddedImage(
@@ -403,9 +417,10 @@ function mailstream_send($message_id, $item, $user)
                $item['url'] = DI::baseUrl()->get() . '/display/' . $item['guid'];
                $mail->Body = Renderer::replaceMacros($template, [
                                                 '$upstream' => DI::l10n()->t('Upstream'),
+                                                '$uri' => DI::l10n()->t('URI'),
                                                 '$local' => DI::l10n()->t('Local'),
                                                 '$item' => $item]);
-               mailstream_html_wrap($mail->Body);
+               $mail->Body = mailstream_html_wrap($mail->Body);
                if (!$mail->Send()) {
                        throw new Exception($mail->ErrorInfo);
                }
@@ -426,15 +441,17 @@ function mailstream_send($message_id, $item, $user)
  * bbcode's output suitable for transmission, we try to break things
  * up so that lines are about 200 characters.
  *
- * @param string $text text to word wrap - modified in-place
+ * @param string $text text to word wrap
+ * @return string wrapped text
  */
-function mailstream_html_wrap(&$text)
+function mailstream_html_wrap(string &$text)
 {
        $lines = str_split($text, 200);
        for ($i = 0; $i < count($lines); $i++) {
                $lines[$i] = preg_replace('/ /', "\n", $lines[$i], 1);
        }
        $text = implode($lines);
+       return $text;
 }
 
 /**
@@ -451,12 +468,11 @@ function mailstream_convert_table_entries()
                                        'message_id' => $ms_item_id['message-id'],
                                        'tries' => 0);
                if (!$ms_item_id['message-id'] || !strlen($ms_item_id['message-id'])) {
-                       Logger::info('mailstream_cron: Item ' .
-                                                       $ms_item_id['id'] . ' URI ' . $ms_item_id['uri'] . ' has no message-id');
+                       Logger::info('mailstream_convert_table_entries: item has no message-id.', 'item' => $ms_item_id['id'], 'uri' => $ms_item_id['uri']]);
                                                        continue;
                }
                Logger::info('mailstream_convert_table_entries: convert item to workerqueue', $send_hook_data);
-               Hook::fork(PRIORITY_LOW, 'mailstream_send_hook', $send_hook_data);
+               Hook::fork(Worker::PRIORITY_LOW, 'mailstream_send_hook', $send_hook_data);
        }
        DBA::e('DROP TABLE `mailstream_item`');
 }
@@ -470,10 +486,10 @@ function mailstream_convert_table_entries()
  */
 function mailstream_addon_settings(App &$a, array &$data)
 {
-       $enabled   = DI::pConfig()->get(local_user(), 'mailstream', 'enabled');
-       $address   = DI::pConfig()->get(local_user(), 'mailstream', 'address');
-       $nolikes   = DI::pConfig()->get(local_user(), 'mailstream', 'nolikes');
-       $attachimg = DI::pConfig()->get(local_user(), 'mailstream', 'attachimg');
+       $enabled   = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'mailstream', 'enabled');
+       $address   = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'mailstream', 'address');
+       $nolikes   = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'mailstream', 'nolikes');
+       $attachimg = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'mailstream', 'attachimg');
 
        $template  = Renderer::getMarkupTemplate('settings.tpl', 'addon/mailstream/');
        $html      = Renderer::replaceMacros($template, [
@@ -514,31 +530,32 @@ function mailstream_addon_settings(App &$a, array &$data)
  * Process data submitted to user's mailstream features form
  * @param App $a
  * @param array          $post POST data
+ * @return void
  */
 function mailstream_addon_settings_post(App $a, array $post)
 {
-       if (!local_user() || empty($post['mailstream-submit'])) {
+       if (!DI::userSession()->getLocalUserId() || empty($post['mailstream-submit'])) {
                return;
        }
 
        if ($post['mailstream_address'] != "") {
-               DI::pConfig()->set(local_user(), 'mailstream', 'address', $post['mailstream_address']);
+               DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'mailstream', 'address', $post['mailstream_address']);
        } else {
-               DI::pConfig()->delete(local_user(), 'mailstream', 'address');
+               DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'mailstream', 'address');
        }
        if ($post['mailstream_nolikes']) {
-               DI::pConfig()->set(local_user(), 'mailstream', 'nolikes', $post['mailstream_enabled']);
+               DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'mailstream', 'nolikes', $post['mailstream_enabled']);
        } else {
-               DI::pConfig()->delete(local_user(), 'mailstream', 'nolikes');
+               DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'mailstream', 'nolikes');
        }
        if ($post['mailstream_enabled']) {
-               DI::pConfig()->set(local_user(), 'mailstream', 'enabled', $post['mailstream_enabled']);
+               DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'mailstream', 'enabled', $post['mailstream_enabled']);
        } else {
-               DI::pConfig()->delete(local_user(), 'mailstream', 'enabled');
+               DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'mailstream', 'enabled');
        }
        if ($post['mailstream_attachimg']) {
-               DI::pConfig()->set(local_user(), 'mailstream', 'attachimg', $post['mailstream_attachimg']);
+               DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'mailstream', 'attachimg', $post['mailstream_attachimg']);
        } else {
-               DI::pConfig()->delete(local_user(), 'mailstream', 'attachimg');
+               DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'mailstream', 'attachimg');
        }
 }