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                 $systemTags = [];
  90                 $userTags = [];
  91                 $denyTags = [];
  92
  93                 if ($scope == self::SCOPE_TAGS) {
  94                         $server_tags = $config->get('system', 'relay_server_tags');
  95                         $tagitems = explode(',', mb_strtolower($server_tags));
  96                         foreach ($tagitems as $tag) {
  97                                 $systemTags[] = trim($tag, '# ');
  98                         }
  99
 100                         if ($config->get('system', 'relay_user_tags')) {
 101                                 $userTags = Search::getUserTags();
 102                         }
 103                 }
 104
 105                 $tagList = array_unique(array_merge($systemTags, $userTags));
 106
 107                 $deny_tags = $config->get('system', 'relay_deny_tags');
 108                 $tagitems = explode(',', mb_strtolower($deny_tags));
 109                 foreach ($tagitems as $tag) {
 110                         $tag = trim($tag, '# ');
 111                         $denyTags[] = $tag;
 112                 }
 113
 114                 if (!empty($tagList) || !empty($denyTags)) {
 115                         $content = mb_strtolower(BBCode::toPlaintext($body, false));
 116
 117                         foreach ($tags as $tag) {
 118                                 $tag = mb_strtolower($tag);
 119                                 if (in_array($tag, $denyTags)) {
 120                                         Logger::info('Unwanted hashtag found - rejected', ['hashtag' => $tag, 'network' => $network, 'url' => $url, 'causer' => $causer]);
 121                                         return false;
 122                                 }
 123
 124                                 if (in_array($tag, $tagList)) {
 125                                         Logger::info('Subscribed hashtag found - accepted', ['hashtag' => $tag, 'network' => $network, 'url' => $url, 'causer' => $causer]);
 126                                         return true;
 127                                 }
 128
 129                                 // We check with "strpos" for performance issues. Only when this is true, the regular expression check is used
 130                                 // RegExp is taken from here: https://medium.com/@shiba1014/regex-word-boundaries-with-unicode-207794f6e7ed
 131                                 if ((strpos($content, $tag) !== false) && preg_match('/(?<=[\s,.:;"\']|^)' . preg_quote($tag, '/') . '(?=[\s,.:;"\']|$)/', $content)) {
 132                                         Logger::info('Subscribed hashtag found in content - accepted', ['hashtag' => $tag, 'network' => $network, 'url' => $url, 'causer' => $causer]);
 133                                         return true;
 134                                 }
 135                         }
 136                 }
 137
 138                 $languages = [];
 139                 foreach (Item::getLanguageArray($body, 10) as $language => $reliability) {
 140                         if ($reliability > 0) {
 141                                 $languages[] = $language;
 142                         }
 143                 }
 144
 145                 Logger::debug('Got languages', ['languages' => $languages, 'body' => $body, 'causer' => $causer]);
 146
 147                 if (!empty($languages)) {
 148                         if (in_array($languages[0], $config->get('system', 'relay_deny_languages'))) {
 149                                 Logger::info('Unwanted language found - rejected', ['language' => $languages[0], 'network' => $network, 'url' => $url, 'causer' => $causer]);
 150                                 return false;
 151                         }
 152                 } elseif ($config->get('system', 'relay_deny_undetected_language')) {
 153                         Logger::info('Undetected language found - rejected', ['body' => $body, 'network' => $network, 'url' => $url, 'causer' => $causer]);
 154                         return false;
 155                 }
 156
 157                 if ($scope == self::SCOPE_ALL) {
 158                         Logger::info('Server accept all posts - accepted', ['network' => $network, 'url' => $url, 'causer' => $causer]);
 159                         return true;
 160                 }
 161
 162                 Logger::info('No matching hashtags found - rejected', ['network' => $network, 'url' => $url, 'causer' => $causer]);
 163                 return false;
 164         }
 165
 166         /**
 167          * Update or insert a relay contact
 168          *
 169          * @param array $gserver Global server record
 170          * @param array $fields  Optional network specific fields
 171          * @return void
 172          * @throws \Exception
 173          */
 174         public static function updateContact(array $gserver, array $fields = [])
 175         {
 176                 if (in_array($gserver['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN])) {
 177                         $system = APContact::getByURL($gserver['url'] . '/friendica');
 178                         if (!empty($system['sharedinbox'])) {
 179                                 Logger::info('Sucessfully probed for relay contact', ['server' => $gserver['url']]);
 180                                 $id = Contact::updateFromProbeByURL($system['url']);
 181                                 Logger::info('Updated relay contact', ['server' => $gserver['url'], 'id' => $id]);
 182                                 return;
 183                         }
 184                 }
 185
 186                 $condition = ['uid' => 0, 'gsid' => $gserver['id'], 'contact-type' => Contact::TYPE_RELAY];
 187                 $old = DBA::selectFirst('contact', [], $condition);
 188                 if (!DBA::isResult($old)) {
 189                         $condition = ['uid' => 0, 'nurl' => Strings::normaliseLink($gserver['url'])];
 190                         $old = DBA::selectFirst('contact', [], $condition);
 191                         if (DBA::isResult($old)) {
 192                                 $fields['gsid'] = $gserver['id'];
 193                                 $fields['contact-type'] = Contact::TYPE_RELAY;
 194                                 Logger::info('Assigning missing data for relay contact', ['server' => $gserver['url'], 'id' => $old['id']]);
 195                         }
 196                 } elseif (empty($fields)) {
 197                         Logger::info('No content to update, quitting', ['server' => $gserver['url']]);
 198                         return;
 199                 }
 200
 201                 if (DBA::isResult($old)) {
 202                         $fields['updated'] = DateTimeFormat::utcNow();
 203
 204                         Logger::info('Update relay contact', ['server' => $gserver['url'], 'id' => $old['id'], 'fields' => $fields]);
 205                         Contact::update($fields, ['id' => $old['id']], $old);
 206                 } else {
 207                         $default = ['created' => DateTimeFormat::utcNow(),
 208                                 'name' => 'relay', 'nick' => 'relay', 'url' => $gserver['url'],
 209                                 'nurl' => Strings::normaliseLink($gserver['url']),
 210                                 'network' => Protocol::DIASPORA, 'uid' => 0,
 211                                 'batch' => $gserver['url'] . '/receive/public',
 212                                 'rel' => Contact::FOLLOWER, 'blocked' => false,
 213                                 'pending' => false, 'writable' => true,
 214                                 'gsid' => $gserver['id'],
 215                                 'baseurl' => $gserver['url'], 'contact-type' => Contact::TYPE_RELAY];
 216
 217                         $fields = array_merge($default, $fields);
 218
 219                         Logger::info('Create relay contact', ['server' => $gserver['url'], 'fields' => $fields]);
 220                         Contact::insert($fields);
 221                 }
 222         }
 223
 224         /**
 225          * Mark the relay contact of the given contact for archival
 226          * This is called whenever there is a communication issue with the server.
 227          * It avoids sending stuff to servers who don't exist anymore.
 228          * The relay contact is a technical contact entry that exists once per server.
 229          *
 230          * @param array $contact of the relay contact
 231          * @return void
 232          */
 233         public static function markForArchival(array $contact)
 234         {
 235                 if (!empty($contact['contact-type']) && ($contact['contact-type'] == Contact::TYPE_RELAY)) {
 236                         // This is already the relay contact, we don't need to fetch it
 237                         $relay_contact = $contact;
 238                 } elseif (empty($contact['baseurl'])) {
 239                         if (!empty($contact['batch'])) {
 240                                 $condition = ['uid' => 0, 'network' => Protocol::FEDERATED, 'batch' => $contact['batch'], 'contact-type' => Contact::TYPE_RELAY];
 241                                 $relay_contact = DBA::selectFirst('contact', [], $condition);
 242                         } else {
 243                                 return;
 244                         }
 245                 } else {
 246                         $gserver = ['id' => $contact['gsid'] ?: GServer::getID($contact['baseurl'], true),
 247                                 'url' => $contact['baseurl'], 'network' => $contact['network']];
 248                         $relay_contact = self::getContact($gserver, []);
 249                 }
 250
 251                 if (!empty($relay_contact)) {
 252                         Logger::info('Relay contact will be marked for archival', ['id' => $relay_contact['id'], 'url' => $relay_contact['url']]);
 253                         Contact::markForArchival($relay_contact);
 254                 }
 255         }
 256
 257         /**
 258          * Return a list of servers that we serve via the direct relay
 259          *
 260          * @param integer $item_id  id of the item that is sent
 261          * @param array   $contacts Previously fetched contacts
 262          * @param array   $networks Networks of the relay servers
 263          * @return array of relay servers
 264          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 265          */
 266         public static function getDirectRelayList(int $item_id): array
 267         {
 268                 $serverlist = [];
 269
 270                 if (!DI::config()->get('system', 'relay_directly', false)) {
 271                         return [];
 272                 }
 273
 274                 // We distribute our stuff based on the parent to ensure that the thread will be complete
 275                 $parent = Post::selectFirst(['uri-id'], ['id' => $item_id]);
 276                 if (!DBA::isResult($parent)) {
 277                         return [];
 278                 }
 279
 280                 // Servers that want to get all content
 281                 $servers = DBA::select('gserver', ['id', 'url', 'network'], ['relay-subscribe' => true, 'relay-scope' => 'all']);
 282                 while ($server = DBA::fetch($servers)) {
 283                         $serverlist[$server['id']] = $server;
 284                 }
 285                 DBA::close($servers);
 286
 287                 // All tags of the current post
 288                 $tags = DBA::select('tag-view', ['name'], ['uri-id' => $parent['uri-id'], 'type' => Tag::HASHTAG]);
 289                 $taglist = [];
 290                 while ($tag = DBA::fetch($tags)) {
 291                         $taglist[] = $tag['name'];
 292                 }
 293                 DBA::close($tags);
 294
 295                 // All servers who wants content with this tag
 296                 $tagserverlist = [];
 297                 if (!empty($taglist)) {
 298                         $tagserver = DBA::select('gserver-tag', ['gserver-id'], ['tag' => $taglist]);
 299                         while ($server = DBA::fetch($tagserver)) {
 300                                 $tagserverlist[] = $server['gserver-id'];
 301                         }
 302                         DBA::close($tagserver);
 303                 }
 304
 305                 // All adresses with the given id
 306                 if (!empty($tagserverlist)) {
 307                         $servers = DBA::select('gserver', ['id', 'url', 'network'], ['relay-subscribe' => true, 'relay-scope' => 'tags', 'id' => $tagserverlist]);
 308                         while ($server = DBA::fetch($servers)) {
 309                                 $serverlist[$server['id']] = $server;
 310                         }
 311                         DBA::close($servers);
 312                 }
 313
 314                 $contacts = [];
 315
 316                 // Now we are collecting all relay contacts
 317                 foreach ($serverlist as $gserver) {
 318                         // We don't send messages to ourselves
 319                         if (Strings::compareLink($gserver['url'], DI::baseUrl())) {
 320                                 continue;
 321                         }
 322                         $contact = self::getContact($gserver);
 323                         if (empty($contact)) {
 324                                 continue;
 325                         }
 326                 }
 327
 328                 return $contacts;
 329         }
 330
 331         /**
 332          * Return a list of relay servers
 333          *
 334          * @param array $fields Field list
 335          * @return array List of relay servers
 336          * @throws Exception
 337          */
 338         public static function getList(array $fields = []): array
 339         {
 340                 return DBA::selectToArray('apcontact', $fields,
 341                         ["`type` = ? AND `url` IN (SELECT `url` FROM `contact` WHERE `uid` = ? AND `rel` = ?)", 'Application', 0, Contact::FRIEND]);
 342         }
 343
 344         /**
 345          * Return a contact for a given server address or creates a dummy entry
 346          *
 347          * @param array $gserver Global server record
 348          * @param array $fields  Fieldlist
 349          * @return array|bool Array with the contact or false on error
 350          * @throws \Exception
 351          */
 352         private static function getContact(array $gserver, array $fields = ['batch', 'id', 'url', 'name', 'network', 'protocol', 'archive', 'blocked'])
 353         {
 354                 // Fetch the relay contact
 355                 $condition = ['uid' => 0, 'gsid' => $gserver['id'], 'contact-type' => Contact::TYPE_RELAY];
 356                 $contact = DBA::selectFirst('contact', $fields, $condition);
 357                 if (DBA::isResult($contact)) {
 358                         if ($contact['archive'] || $contact['blocked']) {
 359                                 return false;
 360                         }
 361                         return $contact;
 362                 } else {
 363                         self::updateContact($gserver);
 364
 365                         $contact = DBA::selectFirst('contact', $fields, $condition);
 366                         if (DBA::isResult($contact)) {
 367                                 return $contact;
 368                         }
 369                 }
 370
 371                 // It should never happen that we arrive here
 372                 return [];
 373         }
 374
 375         /**
 376          * Resubscribe to all relay servers
 377          *
 378          * @return void
 379          */
 380         public static function reSubscribe()
 381         {
 382                 foreach (self::getList() as $server) {
 383                         $success = ActivityPub\Transmitter::sendRelayFollow($server['url']);
 384                         Logger::debug('Resubscribed', ['profile' => $server['url'], 'success' => $success]);
 385                 }
 386         }
 387 }