src/Protocol/Relay.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, 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\Item;
  33 use Friendica\Model\Post;
  34 use Friendica\Model\Search;
  35 use Friendica\Model\Tag;
  36 use Friendica\Util\DateTimeFormat;
  37 use Friendica\Util\Strings;
  38
  39 /**
  40  * Base class for relay handling
  41  * @see https://github.com/jaywink/social-relay
  42  * @see https://wiki.diasporafoundation.org/Relay_servers_for_public_posts
  43  */
  44 class Relay
  45 {
  46         const SCOPE_NONE = '';
  47         const SCOPE_ALL = 'all';
  48         const SCOPE_TAGS = 'tags';
  49
  50         /**
  51          * Check if a post is wanted
  52          *
  53          * @param array $tags
  54          * @param string $body
  55          * @param int $authorid
  56          * @param string $url
  57          * @return boolean "true" is the post is wanted by the system
  58          */
  59         public static function isSolicitedPost(array $tags, string $body, int $authorid, string $url, string $network = '', int $causerid = 0): bool
  60         {
  61                 $config = DI::config();
  62
  63                 $scope = $config->get('system', 'relay_scope');
  64
  65                 if ($scope == self::SCOPE_NONE) {
  66                         Logger::info('Server does not accept relay posts - rejected', ['network' => $network, 'url' => $url]);
  67                         return false;
  68                 }
  69
  70                 if (Contact::isBlocked($authorid)) {
  71                         Logger::info('Author is blocked - rejected', ['author' => $authorid, 'network' => $network, 'url' => $url]);
  72                         return false;
  73                 }
  74
  75                 if (Contact::isHidden($authorid)) {
  76                         Logger::info('Author is hidden - rejected', ['author' => $authorid, 'network' => $network, 'url' => $url]);
  77                         return false;
  78                 }
  79
  80                 if (!empty($causerid)) {
  81                         $contact = Contact::getById($causerid, ['url']);
  82                         $causer = $contact['url'] ?? '';
  83                 } else {
  84                         $causer = '';
  85                 }
  86
  87                 $body = ActivityPub\Processor::normalizeMentionLinks($body);
  88
  89                 $denyTags = [];
  90
  91                 if ($scope == self::SCOPE_TAGS) {
  92                         $tagList = self::getSubscribedTags();
  93                 } else {
  94                         $tagList  = [];
  95                 }
  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, 'causer' => $causer]);
 111                                         return false;
 112                                 }
 113
 114                                 if (in_array($tag, $tagList)) {
 115                                         Logger::info('Subscribed hashtag found - accepted', ['hashtag' => $tag, 'network' => $network, 'url' => $url, 'causer' => $causer]);
 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, 'causer' => $causer]);
 123                                         return true;
 124                                 }
 125                         }
 126                 }
 127
 128                 if (!self::isWantedLanguage($body)) {
 129                         Logger::info('Unwanted or Undetected language found - rejected', ['network' => $network, 'url' => $url, 'causer' => $causer, 'tags' => $tags]);
 130                         return false;
 131                 }
 132
 133                 if ($scope == self::SCOPE_ALL) {
 134                         Logger::info('Server accept all posts - accepted', ['network' => $network, 'url' => $url, 'causer' => $causer, 'tags' => $tags]);
 135                         return true;
 136                 }
 137
 138                 Logger::info('No matching hashtags found - rejected', ['network' => $network, 'url' => $url, 'causer' => $causer, 'tags' => $tags]);
 139                 return false;
 140         }
 141
 142         /**
 143          * Get a list of subscribed tags by both the users and the tags that are defined by the admin
 144          *
 145          * @return array
 146          */
 147         public static function getSubscribedTags(): array
 148         {
 149                 $systemTags  = [];
 150                 $server_tags = DI::config()->get('system', 'relay_server_tags');
 151
 152                 foreach (explode(',', mb_strtolower($server_tags)) as $tag) {
 153                         $systemTags[] = trim($tag, '# ');
 154                 }
 155
 156                 if (DI::config()->get('system', 'relay_user_tags')) {
 157                         $userTags = Search::getUserTags();
 158                 } else {
 159                         $userTags = [];
 160                 }
 161
 162                 return array_unique(array_merge($systemTags, $userTags));
 163         }
 164
 165         /**
 166          * Detect the language of a post and decide if the post should be accepted
 167          *
 168          * @param string $body
 169          * @return boolean
 170          */
 171         public static function isWantedLanguage(string $body)
 172         {
 173                 $languages = [];
 174                 foreach (Item::getLanguageArray($body, 10) as $language => $reliability) {
 175                         if ($reliability > 0) {
 176                                 $languages[] = $language;
 177                         }
 178                 }
 179
 180                 Logger::debug('Got languages', ['languages' => $languages, 'body' => $body]);
 181
 182                 if (!empty($languages)) {
 183                         if (in_array($languages[0], DI::config()->get('system', 'relay_deny_languages'))) {
 184                                 Logger::info('Unwanted language found', ['language' => $languages[0]]);
 185                                 return false;
 186                         }
 187                 } elseif (DI::config()->get('system', 'relay_deny_undetected_language')) {
 188                         Logger::info('Undetected language found', ['body' => $body]);
 189                         return false;
 190                 }
 191
 192                 return true;
 193         }
 194
 195         /**
 196          * Update or insert a relay contact
 197          *
 198          * @param array $gserver Global server record
 199          * @param array $fields  Optional network specific fields
 200          * @return void
 201          * @throws \Exception
 202          */
 203         public static function updateContact(array $gserver, array $fields = [])
 204         {
 205                 if (in_array($gserver['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN])) {
 206                         $system = APContact::getByURL($gserver['url'] . '/friendica');
 207                         if (!empty($system['sharedinbox'])) {
 208                                 Logger::info('Successfully probed for relay contact', ['server' => $gserver['url']]);
 209                                 $id = Contact::updateFromProbeByURL($system['url']);
 210                                 Logger::info('Updated relay contact', ['server' => $gserver['url'], 'id' => $id]);
 211                                 return;
 212                         }
 213                 }
 214
 215                 $condition = ['uid' => 0, 'gsid' => $gserver['id'], 'contact-type' => Contact::TYPE_RELAY];
 216                 $old = DBA::selectFirst('contact', [], $condition);
 217                 if (!DBA::isResult($old)) {
 218                         $condition = ['uid' => 0, 'nurl' => Strings::normaliseLink($gserver['url'])];
 219                         $old = DBA::selectFirst('contact', [], $condition);
 220                         if (DBA::isResult($old)) {
 221                                 $fields['gsid'] = $gserver['id'];
 222                                 $fields['contact-type'] = Contact::TYPE_RELAY;
 223                                 Logger::info('Assigning missing data for relay contact', ['server' => $gserver['url'], 'id' => $old['id']]);
 224                         }
 225                 } elseif (empty($fields)) {
 226                         Logger::info('No content to update, quitting', ['server' => $gserver['url']]);
 227                         return;
 228                 }
 229
 230                 if (DBA::isResult($old)) {
 231                         $fields['updated'] = DateTimeFormat::utcNow();
 232
 233                         Logger::info('Update relay contact', ['server' => $gserver['url'], 'id' => $old['id'], 'fields' => $fields]);
 234                         Contact::update($fields, ['id' => $old['id']], $old);
 235                 } else {
 236                         $default = ['created' => DateTimeFormat::utcNow(),
 237                                 'name' => 'relay', 'nick' => 'relay', 'url' => $gserver['url'],
 238                                 'nurl' => Strings::normaliseLink($gserver['url']),
 239                                 'network' => Protocol::DIASPORA, 'uid' => 0,
 240                                 'batch' => $gserver['url'] . '/receive/public',
 241                                 'rel' => Contact::FOLLOWER, 'blocked' => false,
 242                                 'pending' => false, 'writable' => true,
 243                                 'gsid' => $gserver['id'],
 244                                 'baseurl' => $gserver['url'], 'contact-type' => Contact::TYPE_RELAY];
 245
 246                         $fields = array_merge($default, $fields);
 247
 248                         Logger::info('Create relay contact', ['server' => $gserver['url'], 'fields' => $fields]);
 249                         Contact::insert($fields);
 250                 }
 251         }
 252
 253         /**
 254          * Mark the relay contact of the given contact for archival
 255          * This is called whenever there is a communication issue with the server.
 256          * It avoids sending stuff to servers who don't exist anymore.
 257          * The relay contact is a technical contact entry that exists once per server.
 258          *
 259          * @param array $contact of the relay contact
 260          * @return void
 261          */
 262         public static function markForArchival(array $contact)
 263         {
 264                 if (!empty($contact['contact-type']) && ($contact['contact-type'] == Contact::TYPE_RELAY)) {
 265                         // This is already the relay contact, we don't need to fetch it
 266                         $relay_contact = $contact;
 267                 } elseif (empty($contact['baseurl'])) {
 268                         if (!empty($contact['batch'])) {
 269                                 $condition = ['uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => Contact::TYPE_RELAY];
 270                                 $relay_contact = DBA::selectFirst('contact', [], $condition);
 271                         } else {
 272                                 return;
 273                         }
 274                 } else {
 275                         $gserver = ['id' => $contact['gsid'] ?: GServer::getID($contact['baseurl'], true),
 276                                 'url' => $contact['baseurl'], 'network' => $contact['network']];
 277                         $relay_contact = self::getContact($gserver, []);
 278                 }
 279
 280                 if (!empty($relay_contact)) {
 281                         Logger::info('Relay contact will be marked for archival', ['id' => $relay_contact['id'], 'url' => $relay_contact['url']]);
 282                         Contact::markForArchival($relay_contact);
 283                 }
 284         }
 285
 286         /**
 287          * Return a list of servers that we serve via the direct relay
 288          *
 289          * @param integer $item_id  id of the item that is sent
 290          * @param array   $contacts Previously fetched contacts
 291          * @param array   $networks Networks of the relay servers
 292          * @return array of relay servers
 293          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 294          */
 295         public static function getDirectRelayList(int $item_id): array
 296         {
 297                 $serverlist = [];
 298
 299                 if (!DI::config()->get('system', 'relay_directly', false)) {
 300                         return [];
 301                 }
 302
 303                 // We distribute our stuff based on the parent to ensure that the thread will be complete
 304                 $parent = Post::selectFirst(['uri-id'], ['id' => $item_id]);
 305                 if (!DBA::isResult($parent)) {
 306                         return [];
 307                 }
 308
 309                 // Servers that want to get all content
 310                 $servers = DBA::select('gserver', ['id', 'url', 'network'], ['relay-subscribe' => true, 'relay-scope' => 'all']);
 311                 while ($server = DBA::fetch($servers)) {
 312                         $serverlist[$server['id']] = $server;
 313                 }
 314                 DBA::close($servers);
 315
 316                 // All tags of the current post
 317                 $tags = DBA::select('tag-view', ['name'], ['uri-id' => $parent['uri-id'], 'type' => Tag::HASHTAG]);
 318                 $taglist = [];
 319                 while ($tag = DBA::fetch($tags)) {
 320                         $taglist[] = $tag['name'];
 321                 }
 322                 DBA::close($tags);
 323
 324                 // All servers who wants content with this tag
 325                 $tagserverlist = [];
 326                 if (!empty($taglist)) {
 327                         $tagserver = DBA::select('gserver-tag', ['gserver-id'], ['tag' => $taglist]);
 328                         while ($server = DBA::fetch($tagserver)) {
 329                                 $tagserverlist[] = $server['gserver-id'];
 330                         }
 331                         DBA::close($tagserver);
 332                 }
 333
 334                 // All addresses with the given id
 335                 if (!empty($tagserverlist)) {
 336                         $servers = DBA::select('gserver', ['id', 'url', 'network'], ['relay-subscribe' => true, 'relay-scope' => 'tags', 'id' => $tagserverlist]);
 337                         while ($server = DBA::fetch($servers)) {
 338                                 $serverlist[$server['id']] = $server;
 339                         }
 340                         DBA::close($servers);
 341                 }
 342
 343                 $contacts = [];
 344
 345                 // Now we are collecting all relay contacts
 346                 foreach ($serverlist as $gserver) {
 347                         // We don't send messages to ourselves
 348                         if (Strings::compareLink($gserver['url'], DI::baseUrl())) {
 349                                 continue;
 350                         }
 351                         $contact = self::getContact($gserver);
 352                         if (empty($contact)) {
 353                                 continue;
 354                         }
 355                 }
 356
 357                 return $contacts;
 358         }
 359
 360         /**
 361          * Return a list of relay servers
 362          *
 363          * @param array $fields Field list
 364          * @return array List of relay servers
 365          * @throws Exception
 366          */
 367         public static function getList(array $fields = []): array
 368         {
 369                 return DBA::selectToArray('apcontact', $fields,
 370                         ["`type` IN (?, ?) AND `url` IN (SELECT `url` FROM `contact` WHERE `uid` = ? AND `rel` = ?)", 'Application', 'Service', 0, Contact::FRIEND]);
 371         }
 372
 373         /**
 374          * Return a contact for a given server address or creates a dummy entry
 375          *
 376          * @param array $gserver Global server record
 377          * @param array $fields  Fieldlist
 378          * @return array|bool Array with the contact or false on error
 379          * @throws \Exception
 380          */
 381         private static function getContact(array $gserver, array $fields = ['batch', 'id', 'url', 'name', 'network', 'protocol', 'archive', 'blocked'])
 382         {
 383                 // Fetch the relay contact
 384                 $condition = ['uid' => 0, 'gsid' => $gserver['id'], 'contact-type' => Contact::TYPE_RELAY];
 385                 $contact = DBA::selectFirst('contact', $fields, $condition);
 386                 if (DBA::isResult($contact)) {
 387                         if ($contact['archive'] || $contact['blocked']) {
 388                                 return false;
 389                         }
 390                         return $contact;
 391                 } else {
 392                         self::updateContact($gserver);
 393
 394                         $contact = DBA::selectFirst('contact', $fields, $condition);
 395                         if (DBA::isResult($contact)) {
 396                                 return $contact;
 397                         }
 398                 }
 399
 400                 // It should never happen that we arrive here
 401                 return [];
 402         }
 403
 404         /**
 405          * Resubscribe to all relay servers
 406          *
 407          * @return void
 408          */
 409         public static function reSubscribe()
 410         {
 411                 foreach (self::getList() as $server) {
 412                         $success = ActivityPub\Transmitter::sendRelayFollow($server['url']);
 413                         Logger::debug('Resubscribed', ['profile' => $server['url'], 'success' => $success]);
 414                 }
 415         }
 416 }