]> git.mxchange.org Git - friendica-addons.git/blobdiff - discourse/discourse.php
[blockem] Fix syntax error (#1357)
[friendica-addons.git] / discourse / discourse.php
index 1df248a586cd9e64d7d3a4f69f842d249b4c19cb..3d27c5b0b09afc4a45fdf5787622d232c6748fb6 100644 (file)
  * Author: Michael Vogel <http://pirati.ca/profile/heluecht>
  *
  */
-//use DOMDocument;
-//use DOMXPath;
+
 use Friendica\App;
+use Friendica\Content\Text\Markdown;
 use Friendica\Core\Hook;
-use Friendica\Core\L10n;
 use Friendica\Core\Logger;
-use Friendica\Core\PConfig;
-use Friendica\Util\XML;
-use Friendica\Content\Text\Markdown;
-use Friendica\Util\Network;
-Use Friendica\Util\DateTimeFormat;
+use Friendica\Core\Protocol;
+use Friendica\Core\Renderer;
+use Friendica\Database\DBA;
+use Friendica\DI;
+use Friendica\Model\Contact;
+use Friendica\Util\DateTimeFormat;
+use Friendica\Util\Strings;
+
+/* Todo:
+ * - Obtaining API tokens to be able to read non public posts as well
+ * - Handling duplicates (possibly using some non visible marker)
+ * - Fetching missing posts
+ * - Fetch topic information
+ * - Support mail free mode when write tokens are available
+ * - Fix incomplete (relative) links (hosts are missing)
+*/
 
 function discourse_install()
 {
-       Hook::register('email_getmessage',     __FILE__, 'discourse_email_getmessage');
-       Hook::register('email_getmessage_end', __FILE__, 'discourse_email_getmessage_end');
-       Hook::register('addon_settings',       __FILE__, 'discourse_addon_settings');
-       Hook::register('addon_settings_post',  __FILE__, 'discourse_addon_settings_post');
+       Hook::register('email_getmessage',        __FILE__, 'discourse_email_getmessage');
+       Hook::register('connector_settings',      __FILE__, 'discourse_settings');
+       Hook::register('connector_settings_post', __FILE__, 'discourse_settings_post');
 }
 
-function discourse_uninstall()
+function discourse_settings(array &$data)
 {
-       Hook::unregister('email_getmessage',     __FILE__, 'discourse_email_getmessage');
-       Hook::unregister('email_getmessage_end', __FILE__, 'discourse_email_getmessage_end');
-       Hook::unregister('addon_settings',       __FILE__, 'discourse_addon_settings');
-       Hook::unregister('addon_settings_post',  __FILE__, 'discourse_addon_settings_post');
-}
+       if (!DI::userSession()->getLocalUserId()) {
+               return;
+       }
 
-function discourse_addon_settings(App $a, &$s)
-{
+       $enabled = intval(DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'discourse', 'enabled'));
+
+       $t    = Renderer::getMarkupTemplate('connector_settings.tpl', 'addon/discourse/');
+       $html = Renderer::replaceMacros($t, [
+               '$enabled' => ['enabled', DI::l10n()->t('Enable processing of Discourse mailing list mails'), $enabled, DI::l10n()->t('If enabled, incoming mails from Discourse will be improved so they look much better. To make it work, you have to configure the e-mail settings in Friendica. You also have to enable the mailing list mode in Discourse. Then you have to add the Discourse mail account as contact.')],
+       ]);
+
+       $data = [
+               'connector' => 'discourse',
+               'title'     => DI::l10n()->t('Discourse'),
+               'image'     => 'images/discourse.png',
+               'enabled'   => $enabled,
+               'html'      => $html,
+       ];
 }
 
-function discourse_addon_settings_post(App $a)
+function discourse_settings_post()
 {
+       if (!DI::userSession()->getLocalUserId() || empty($_POST['discourse-submit'])) {
+                return;
+        }
+
+       DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'discourse', 'enabled', intval($_POST['enabled']));
 }
 
-function discourse_email_getmessage(App $a, &$message)
+function discourse_email_getmessage(&$message)
 {
-//     Logger::info('Got raw message', $message);
-       // Remove the title on comments, they don't serve any purpose there
-       if ($message['item']['parent-uri'] != $message['item']['uri']) {
-               unset($message['item']['title']);
+       if (empty($message['item']['uid'])) {
+               return;
        }
 
-       if (preg_match('=topic/(.*)/(.*)@(.*)=', $message['item']['uri'], $matches)) {
-               Logger::info('Got post data', ['topic' => $matches[1], 'post' => $matches[2], 'host' => $matches[3]]);
-               if (discourse_fetch_post_from_api($message, $matches[2], $matches[3])) {
-                       return;
-               }
+       if (!DI::pConfig()->get($message['item']['uid'], 'discourse', 'enabled')) {
+               return;
+       }
+
+       // We do assume that all Discourse servers are running with SSL
+       if (preg_match('=topic/(.*\d)/(.*\d)@(.*)=', $message['item']['uri'], $matches) &&
+               discourse_fetch_post_from_api($message, $matches[2], $matches[3])) {
+               Logger::info('Fetched comment via API (message-id mode)', ['host' => $matches[3], 'topic' => $matches[1], 'post' => $matches[2]]);
+               return;
+       }
+
+       if (preg_match('=topic/(.*\d)@(.*)=', $message['item']['uri'], $matches) &&
+               discourse_fetch_topic_from_api($message, 'https://' . $matches[2], $matches[1], 1)) {
+               Logger::info('Fetched starting post via API (message-id mode)', ['host' => $matches[2], 'topic' => $matches[1]]);
+               return;
        }
 
        // Search in the text part for the link to the discourse entry and the text body
-       // The text body is used as alternative, if the fetched HTML isn't working
        if (!empty($message['text'])) {
-               discourse_get_text($message);
+               $message = discourse_get_text($message);
        }
 
-       if (!empty($message['item']['plink'])) {
-               if (preg_match('=(http.*)/t/.*/(.*\d)/(.*\d)=', $message['item']['plink'], $matches)) {
-                       if (discourse_fetch_topic_from_api($message, $matches[1], $matches[1], $matches[1])) {
-                               return;
-                       }
-               }
+       if (empty($message['item']['plink']) || !preg_match('=(http.*)/t/.*/(.*\d)/(.*\d)=', $message['item']['plink'], $matches)) {
+               Logger::info('This is no Discourse post');
+               return;
        }
 
+       if (discourse_fetch_topic_from_api($message, $matches[1], $matches[2], $matches[3])) {
+               Logger::info('Fetched post via API (plink mode)', ['host' => $matches[1], 'topic' => $matches[2], 'id' => $matches[3]]);
+               return;
+       }
+
+       Logger::info('Fallback mode', ['plink' => $message['item']['plink']]);
        // Search in the HTML part for the discourse entry and the author profile
        if (!empty($message['html'])) {
-               discourse_get_html($message);
+               $message = discourse_get_html($message);
+       }
+
+       // Remove the title on comments, they don't serve any purpose there
+       if ($message['item']['thr-parent'] != $message['item']['uri']) {
+               unset($message['item']['title']);
        }
 }
 
-function discourse_fetch_topic_from_api(&$message, $host, $topic, $pid)
+function discourse_fetch_post($host, $topic, $pid)
 {
-       $url = $host . '/t/' . $topic . '/posts.json?posts_ids[]=' . $pid;
-       $curlResult = Network::curl($url);
+       $url = $host . '/t/' . $topic . '/' . $pid . '.json';
+       $curlResult = DI::httpClient()->get($url);
        if (!$curlResult->isSuccess()) {
+               Logger::info('No success', ['url' => $url]);
                return false;
        }
+
        $raw = $curlResult->getBody();
        $data = json_decode($raw, true);
        $posts = $data['post_stream']['posts'];
        foreach($posts as $post) {
                if ($post['post_number'] != $pid) {
+                       /// @todo Possibly fetch missing posts here
                        continue;
                }
                Logger::info('Got post data from topic', $post);
-               discourse_process_post($message, $post);
-               return true;
+               return $post;
        }
+
+       Logger::info('Post not found', ['host' => $host, 'topic' => $topic, 'pid' => $pid]);
        return false;
 }
 
+function discourse_fetch_topic_from_api(&$message, $host, $topic, $pid)
+{
+       $post = discourse_fetch_post($host, $topic, $pid);
+       if (empty($post)) {
+               return false;
+       }
+
+       $message = discourse_process_post($message, $post, $host);
+       return true;
+}
+
 function discourse_fetch_post_from_api(&$message, $post, $host)
 {
-       $url = "https://" . $host . '/posts/' . $post . '.json';
-       $curlResult = Network::curl($url);
+       $hostaddr = 'https://' . $host;
+       $url = $hostaddr . '/posts/' . $post . '.json';
+       $curlResult = DI::httpClient()->get($url);
        if (!$curlResult->isSuccess()) {
                return false;
        }
@@ -113,28 +168,92 @@ function discourse_fetch_post_from_api(&$message, $post, $host)
                return false;
        }
 
-       discourse_process_post($message, $data);
+       $message = discourse_process_post($message, $data, $hostaddr);
 
        Logger::info('Got API data', $message);
        return true;
 }
 
-function discourse_process_post(&$message, $post)
+function discourse_get_user($post, $hostaddr)
 {
-       if ($post['post_number'] == 1) {
-               // Thread information
+       $host = parse_url($hostaddr, PHP_URL_HOST);
+
+       // Currently unused contact fields:
+       // - display_username
+       // - user_id
+
+       $contact = [];
+       $contact['uid'] = 0;
+       $contact['network'] = Protocol::DISCOURSE;
+       $contact['name'] = $contact['nick'] = $post['username'];
+       if (!empty($post['name'])) {
+               $contact['name'] = $post['name'];
+       }
+
+       $contact['about'] = $post['user_title'];
+
+       if (parse_url($post['avatar_template'], PHP_URL_SCHEME)) {
+               $contact['photo'] = str_replace('{size}', '300', $post['avatar_template']);
+       } else {
+               $contact['photo'] = $hostaddr . str_replace('{size}', '300', $post['avatar_template']);
+       }
+
+       $contact['addr'] = $contact['nick'] . '@' . $host;
+       $contact['contact-type'] = Contact::TYPE_PERSON;
+       $contact['url'] = $hostaddr . '/u/' . $contact['nick'];
+       $contact['nurl'] = Strings::normaliseLink($contact['url']);
+       $contact['baseurl'] = $hostaddr;
+       Logger::info('Contact', $contact);
+       $contact['id'] = Contact::getIdForURL($contact['url'], 0, false, $contact);
+        if (!empty($contact['id'])) {
+               $avatar = $contact['photo'];
+               unset($contact['photo']);
+               DBA::update('contact', $contact, ['id' => $contact['id']]);
+               Contact::updateAvatar($contact['id'], $avatar);
+               $contact['photo'] = $avatar;
        }
 
-       $nick = $post['username'];
-       $name = $post['name'];
-       // User information
+       return $contact;
+}
+
+function discourse_process_post($message, $post, $hostaddr)
+{
+       $host = parse_url($hostaddr, PHP_URL_HOST);
 
        $message['html'] = $post['cooked'];
-       $message['text'] = $post['raw'];
+
+       $contact = discourse_get_user($post, $hostaddr);
+       $message['item']['author-id'] = $contact['id'];
+       $message['item']['author-link'] = $contact['url'];
+       $message['item']['author-name'] = $contact['name'];
+       $message['item']['author-avatar'] = $contact['photo'];
        $message['item']['created'] = DateTimeFormat::utc($post['created_at']);
+       $message['item']['plink'] = $hostaddr . '/t/' . $post['topic_slug'] . '/' . $post['topic_id'] . '/' . $post['post_number'];
+
+       if ($post['post_number'] == 1) {
+               $message['item']['parent-uri'] = $message['item']['uri'] = 'topic/' . $post['topic_id'] . '@' . $host;
+
+               // Remove the Discourse forum name from the subject
+               $pattern = '=\[.*\].*\s(\[.*\].*)=';
+               if (preg_match($pattern, $message['item']['title'])) {
+                       $message['item']['title'] = preg_replace($pattern, '$1', $message['item']['title']);
+               }
+               /// @ToDo Fetch thread information
+       } else {
+               $message['item']['uri'] = 'topic/' . $post['topic_id'] . '/' . $post['id'] . '@' . $host;
+               unset($message['item']['title']);
+               if (empty($post['reply_to_post_number']) || $post['reply_to_post_number'] == 1) {
+                       $message['item']['parent-uri'] = 'topic/' . $post['topic_id'] . '@' . $host;
+               } else {
+                       $reply = discourse_fetch_post($hostaddr, $post['topic_id'], $post['reply_to_post_number']);
+                       $message['item']['parent-uri'] = 'topic/' . $post['topic_id'] . '/' . $reply['id'] . '@' . $host;
+               }
+       }
+
+       return $message;
 }
 
-function discourse_get_html(&$message)
+function discourse_get_html($message)
 {
        $doc = new DOMDocument();
        $doc2 = new DOMDocument();
@@ -145,7 +264,7 @@ function discourse_get_html(&$message)
 
        $xpath = new DomXPath($doc);
 
-       // Fetch the first 'div' before the 'hr' -hopefully this fits for all systems
+       // Fetch the first 'div' before the 'hr' - hopefully this fits for all systems
        $result = $xpath->query("//hr//preceding::div[1]");
        $div = $doc2->importNode($result->item(0), true);
        $doc2->appendChild($div);
@@ -153,35 +272,40 @@ function discourse_get_html(&$message)
        Logger::info('Found html body', ['html' => $message['html']]);
 
        $profile = discourse_get_profile($xpath);
-       if (!empty($profile)) {
+       if (!empty($profile['url'])) {
                Logger::info('Found profile', $profile);
-/*
-               $message['item']['author-avatar'] = $contact['avatar'];
-               $message['item']['author-link'] = $profile['link'];
+               $message['item']['author-id'] = Contact::getIdForURL($profile['url'], 0, false, $profile);
+               $message['item']['author-link'] = $profile['url'];
                $message['item']['author-name'] = $profile['name'];
-*/
+               $message['item']['author-avatar'] = $profile['photo'];
        }
+
+       return $message;
 }
 
-function discourse_get_text(&$message)
+function discourse_get_text($message)
 {
        $text = $message['text'];
        $text = str_replace("\r", '', $text);
        $pos = strpos($text, "\n---\n");
-       if ($pos > 0) {
-               $message['text'] = trim(substr($text, 0, $pos));
-               Logger::info('Found text body', ['text' => $message['text']]);
+       if ($pos == 0) {
+               Logger::info('No separator found', ['text' => $text]);
+               return $message;
+       }
 
-               $message['text'] = Markdown::toBBCode($message['text']);
+       $message['text'] = trim(substr($text, 0, $pos));
 
-               $text = substr($text, $pos);
-               if (preg_match('=\((http.*?)\)=', $text, $link)) {
-                       $message['item']['plink'] = $link[1];
-                       Logger::info('Found plink', ['plink' => $message['item']['plink']]);
-               }
-       } else {
-               Logger::info('No separator found', ['text' => $text]);
+       Logger::info('Found text body', ['text' => $message['text']]);
+
+       $message['text'] = Markdown::toBBCode($message['text']);
+
+       $text = substr($text, $pos);
+       Logger::info('Found footer', ['text' => $text]);
+       if (preg_match('=\((http.*/t/.*/.*\d/.*\d)\)=', $text, $link)) {
+               $message['item']['plink'] = $link[1];
+               Logger::info('Found plink', ['plink' => $message['item']['plink']]);
        }
+       return $message;
 }
 
 function discourse_get_profile($xpath)
@@ -197,7 +321,7 @@ function discourse_get_profile($xpath)
                if (!empty($attr['src']) && !empty($attr['title'])
                        && !empty($attr['width']) && !empty($attr['height'])
                        && ($attr['width'] == $attr['height'])) {
-                       $profile = ['avatar' => $attr['src'], 'name' => $attr['title']];
+                       $profile = ['photo' => $attr['src'], 'name' => $attr['title']];
                        break;
                }
        }
@@ -210,15 +334,10 @@ function discourse_get_profile($xpath)
                                $attr[$attribute->name] = $attribute->value;
                        }
                        if (!empty($attr['href']) && (strpos($attr['href'], '/' . $profile['name']))) {
-                               $profile['link'] = $attr['href'];
+                               $profile['url'] = $attr['href'];
                                break;
                        }
                }
        }
        return $profile;
 }
-
-function discourse_email_getmessage_end(App $a, &$message)
-{
-//     Logger::info('Got converted message', $message);
-}