src/Protocol/Relay.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Protocol;
  23
  24 use Friendica\Content\Text\BBCode;
  25 use Friendica\Core\Logger;
  26 use Friendica\Core\Protocol;
  27 use Friendica\Database\DBA;
  28 use Friendica\DI;
  29 use Friendica\Model\APContact;
  30 use Friendica\Model\Contact;
  31 use Friendica\Model\GServer;
  32 use Friendica\Model\Post;
  33 use Friendica\Model\Search;
  34 use Friendica\Model\Tag;
  35 use Friendica\Util\DateTimeFormat;
  36 use Friendica\Util\Strings;
  37
  38 /**
  39  * Base class for relay handling
  40  * @see https://github.com/jaywink/social-relay
  41  * @see https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
  42  */
  43 class Relay
  44 {
  45         const SCOPE_NONE = '';
  46         const SCOPE_ALL = 'all';
  47         const SCOPE_TAGS = 'tags';
  48
  49         /**
  50          * Check if a post is wanted
  51          *
  52          * @param array $tags
  53          * @param string $body
  54          * @param int $authorid
  55          * @param string $url
  56          * @return boolean "true" is the post is wanted by the system
  57          */
  58         public static function isSolicitedPost(array $tags, string $body, int $authorid, string $url, string $network = '')
  59         {
  60                 $config = DI::config();
  61
  62                 $scope = $config->get('system', 'relay_scope');
  63
  64                 if ($scope == self::SCOPE_NONE) {
  65                         Logger::info('Server does not accept relay posts - rejected', ['network' => $network, 'url' => $url]);
  66                         return false;
  67                 }
  68
  69                 if (Contact::isBlocked($authorid)) {
  70                         Logger::info('Author is blocked - rejected', ['author' => $authorid, 'network' => $network, 'url' => $url]);
  71                         return false;
  72                 }
  73
  74                 if (Contact::isHidden($authorid)) {
  75                         Logger::info('Author is hidden - rejected', ['author' => $authorid, 'network' => $network, 'url' => $url]);
  76                         return false;
  77                 }
  78
  79                 $systemTags = [];
  80                 $userTags = [];
  81                 $denyTags = [];
  82
  83                 if ($scope == self::SCOPE_TAGS) {
  84                         $server_tags = $config->get('system', 'relay_server_tags');
  85                         $tagitems = explode(',', mb_strtolower($server_tags));
  86                         foreach ($tagitems as $tag) {
  87                                 $systemTags[] = trim($tag, '# ');
  88                         }
  89
  90                         if ($config->get('system', 'relay_user_tags')) {
  91                                 $userTags = Search::getUserTags();
  92                         }
  93                 }
  94
  95                 $tagList = array_unique(array_merge($systemTags, $userTags));
  96
  97                 $deny_tags = $config->get('system', 'relay_deny_tags');
  98                 $tagitems = explode(',', mb_strtolower($deny_tags));
  99                 foreach ($tagitems as $tag) {
 100                         $tag = trim($tag, '# ');
 101                         $denyTags[] = $tag;
 102                 }
 103
 104                 if (!empty($tagList) || !empty($denyTags)) {
 105                         $content = mb_strtolower(BBCode::toPlaintext($body, false));
 106
 107                         foreach ($tags as $tag) {
 108                                 $tag = mb_strtolower($tag);
 109                                 if (in_array($tag, $denyTags)) {
 110                                         Logger::info('Unwanted hashtag found - rejected', ['hashtag' => $tag, 'network' => $network, 'url' => $url]);
 111                                         return false;
 112                                 }
 113
 114                                 if (in_array($tag, $tagList)) {
 115                                         Logger::info('Subscribed hashtag found - accepted', ['hashtag' => $tag, 'network' => $network, 'url' => $url]);
 116                                         return true;
 117                                 }
 118
 119                                 // We check with "strpos" for performance issues. Only when this is true, the regular expression check is used
 120                                 // RegExp is taken from here: https://medium.com/@shiba1014/regex-word-boundaries-with-unicode-207794f6e7ed
 121                                 if ((strpos($content, $tag) !== false) && preg_match('/(?<=[\s,.:;"\']|^)' . preg_quote($tag, '/') . '(?=[\s,.:;"\']|$)/', $content)) {
 122                                         Logger::info('Subscribed hashtag found in content - accepted', ['hashtag' => $tag, 'network' => $network, 'url' => $url]);
 123                                         return true;
 124                                 }
 125                         }
 126                 }
 127
 128                 if ($scope == self::SCOPE_ALL) {
 129                         Logger::info('Server accept all posts - accepted', ['network' => $network, 'url' => $url]);
 130                         return true;
 131                 }
 132
 133                 Logger::info('No matching hashtags found - rejected', ['network' => $network, 'url' => $url]);
 134                 return false;
 135         }
 136
 137         /**
 138          * Update or insert a relay contact
 139          *
 140          * @param array $gserver Global server record
 141          * @param array $fields  Optional network specific fields
 142          * @throws \Exception
 143          */
 144         public static function updateContact(array $gserver, array $fields = [])
 145         {
 146                 if (in_array($gserver['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN])) {
 147                         $system = APContact::getByURL($gserver['url'] . '/friendica');
 148                         if (!empty($system['sharedinbox'])) {
 149                                 Logger::info('Sucessfully probed for relay contact', ['server' => $gserver['url']]);
 150                                 $id = Contact::updateFromProbeByURL($system['url']);
 151                                 Logger::info('Updated relay contact', ['server' => $gserver['url'], 'id' => $id]);
 152                                 return;
 153                         }
 154                 }
 155
 156                 $condition = ['uid' => 0, 'gsid' => $gserver['id'], 'contact-type' => Contact::TYPE_RELAY];
 157                 $old = DBA::selectFirst('contact', [], $condition);
 158                 if (!DBA::isResult($old)) {
 159                         $condition = ['uid' => 0, 'nurl' => Strings::normaliseLink($gserver['url'])];
 160                         $old = DBA::selectFirst('contact', [], $condition);
 161                         if (DBA::isResult($old)) {
 162                                 $fields['gsid'] = $gserver['id'];
 163                                 $fields['contact-type'] = Contact::TYPE_RELAY;
 164                                 Logger::info('Assigning missing data for relay contact', ['server' => $gserver['url'], 'id' => $old['id']]);
 165                         }
 166                 } elseif (empty($fields)) {
 167                         Logger::info('No content to update, quitting', ['server' => $gserver['url']]);
 168                         return;
 169                 }
 170
 171                 if (DBA::isResult($old)) {
 172                         $fields['updated'] = DateTimeFormat::utcNow();
 173
 174                         Logger::info('Update relay contact', ['server' => $gserver['url'], 'id' => $old['id'], 'fields' => $fields]);
 175                         Contact::update($fields, ['id' => $old['id']], $old);
 176                 } else {
 177                         $default = ['created' => DateTimeFormat::utcNow(),
 178                                 'name' => 'relay', 'nick' => 'relay', 'url' => $gserver['url'],
 179                                 'nurl' => Strings::normaliseLink($gserver['url']),
 180                                 'network' => Protocol::DIASPORA, 'uid' => 0,
 181                                 'batch' => $gserver['url'] . '/receive/public',
 182                                 'rel' => Contact::FOLLOWER, 'blocked' => false,
 183                                 'pending' => false, 'writable' => true,
 184                                 'gsid' => $gserver['id'],
 185                                 'baseurl' => $gserver['url'], 'contact-type' => Contact::TYPE_RELAY];
 186
 187                         $fields = array_merge($default, $fields);
 188
 189                         Logger::info('Create relay contact', ['server' => $gserver['url'], 'fields' => $fields]);
 190                         Contact::insert($fields);
 191                 }
 192         }
 193
 194         /**
 195          * Mark the relay contact of the given contact for archival
 196          * This is called whenever there is a communication issue with the server.
 197          * It avoids sending stuff to servers who don't exist anymore.
 198          * The relay contact is a technical contact entry that exists once per server.
 199          *
 200          * @param array $contact of the relay contact
 201          */
 202         public static function markForArchival(array $contact)
 203         {
 204                 if (!empty($contact['contact-type']) && ($contact['contact-type'] == Contact::TYPE_RELAY)) {
 205                         // This is already the relay contact, we don't need to fetch it
 206                         $relay_contact = $contact;
 207                 } elseif (empty($contact['baseurl'])) {
 208                         if (!empty($contact['batch'])) {
 209                                 $condition = ['uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => Contact::TYPE_RELAY];
 210                                 $relay_contact = DBA::selectFirst('contact', [], $condition);
 211                         } else {
 212                                 return;
 213                         }
 214                 } else {
 215                         $gserver = ['id' => $contact['gsid'] ?: GServer::getID($contact['baseurl'], true),
 216                                 'url' => $contact['baseurl'], 'network' => $contact['network']];
 217                         $relay_contact = self::getContact($gserver, []);
 218                 }
 219
 220                 if (!empty($relay_contact)) {
 221                         Logger::info('Relay contact will be marked for archival', ['id' => $relay_contact['id'], 'url' => $relay_contact['url']]);
 222                         Contact::markForArchival($relay_contact);
 223                 }
 224         }
 225
 226         /**
 227          * Return a list of servers that we serve via the direct relay
 228          *
 229          * @param integer $item_id  id of the item that is sent
 230          * @param array   $contacts Previously fetched contacts
 231          * @param array   $networks Networks of the relay servers
 232          *
 233          * @return array of relay servers
 234          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 235          */
 236         public static function getDirectRelayList(int $item_id)
 237         {
 238                 $serverlist = [];
 239
 240                 if (!DI::config()->get("system", "relay_directly", false)) {
 241                         return [];
 242                 }
 243
 244                 // We distribute our stuff based on the parent to ensure that the thread will be complete
 245                 $parent = Post::selectFirst(['uri-id'], ['id' => $item_id]);
 246                 if (!DBA::isResult($parent)) {
 247                         return [];
 248                 }
 249
 250                 // Servers that want to get all content
 251                 $servers = DBA::select('gserver', ['id', 'url', 'network'], ['relay-subscribe' => true, 'relay-scope' => 'all']);
 252                 while ($server = DBA::fetch($servers)) {
 253                         $serverlist[$server['id']] = $server;
 254                 }
 255                 DBA::close($servers);
 256
 257                 // All tags of the current post
 258                 $tags = DBA::select('tag-view', ['name'], ['uri-id' => $parent['uri-id'], 'type' => Tag::HASHTAG]);
 259                 $taglist = [];
 260                 while ($tag = DBA::fetch($tags)) {
 261                         $taglist[] = $tag['name'];
 262                 }
 263                 DBA::close($tags);
 264
 265                 // All servers who wants content with this tag
 266                 $tagserverlist = [];
 267                 if (!empty($taglist)) {
 268                         $tagserver = DBA::select('gserver-tag', ['gserver-id'], ['tag' => $taglist]);
 269                         while ($server = DBA::fetch($tagserver)) {
 270                                 $tagserverlist[] = $server['gserver-id'];
 271                         }
 272                         DBA::close($tagserver);
 273                 }
 274
 275                 // All adresses with the given id
 276                 if (!empty($tagserverlist)) {
 277                         $servers = DBA::select('gserver', ['id', 'url', 'network'], ['relay-subscribe' => true, 'relay-scope' => 'tags', 'id' => $tagserverlist]);
 278                         while ($server = DBA::fetch($servers)) {
 279                                 $serverlist[$server['id']] = $server;
 280                         }
 281                         DBA::close($servers);
 282                 }
 283
 284                 $contacts = [];
 285
 286                 // Now we are collecting all relay contacts
 287                 foreach ($serverlist as $gserver) {
 288                         // We don't send messages to ourselves
 289                         if (Strings::compareLink($gserver['url'], DI::baseUrl())) {
 290                                 continue;
 291                         }
 292                         $contact = self::getContact($gserver);
 293                         if (empty($contact)) {
 294                                 continue;
 295                         }
 296                 }
 297
 298                 return $contacts;
 299         }
 300
 301         /**
 302          * Return a list of relay servers
 303          *
 304          * @param array $fields Field list
 305          * @return array
 306          * @throws Exception
 307          */
 308         public static function getList($fields = []):array
 309         {
 310                 return DBA::selectToArray('apcontact', $fields,
 311                         ["`type` = ? AND `url` IN (SELECT `url` FROM `contact` WHERE `uid` = ? AND `rel` = ?)", 'Application', 0, Contact::FRIEND]);
 312         }
 313
 314         /**
 315          * Return a contact for a given server address or creates a dummy entry
 316          *
 317          * @param array $gserver Global server record
 318          * @param array $fields  Fieldlist
 319          * @return array with the contact
 320          * @throws \Exception
 321          */
 322         private static function getContact(array $gserver, array $fields = ['batch', 'id', 'url', 'name', 'network', 'protocol', 'archive', 'blocked'])
 323         {
 324                 // Fetch the relay contact
 325                 $condition = ['uid' => 0, 'gsid' => $gserver['id'], 'contact-type' => Contact::TYPE_RELAY];
 326                 $contact = DBA::selectFirst('contact', $fields, $condition);
 327                 if (DBA::isResult($contact)) {
 328                         if ($contact['archive'] || $contact['blocked']) {
 329                                 return false;
 330                         }
 331                         return $contact;
 332                 } else {
 333                         self::updateContact($gserver);
 334
 335                         $contact = DBA::selectFirst('contact', $fields, $condition);
 336                         if (DBA::isResult($contact)) {
 337                                 return $contact;
 338                         }
 339                 }
 340
 341                 // It should never happen that we arrive here
 342                 return [];
 343         }
 344 }