src/Model/APContact.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\Model;
  23
  24 use Friendica\Content\Text\HTML;
  25 use Friendica\Core\Cache\Enum\Duration;
  26 use Friendica\Core\Logger;
  27 use Friendica\Core\System;
  28 use Friendica\Database\DBA;
  29 use Friendica\Database\DBStructure;
  30 use Friendica\DI;
  31 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
  32 use Friendica\Network\HTTPException;
  33 use Friendica\Network\Probe;
  34 use Friendica\Protocol\ActivityNamespace;
  35 use Friendica\Protocol\ActivityPub;
  36 use Friendica\Protocol\ActivityPub\Transmitter;
  37 use Friendica\Util\Crypto;
  38 use Friendica\Util\DateTimeFormat;
  39 use Friendica\Util\HTTPSignature;
  40 use Friendica\Util\JsonLD;
  41 use Friendica\Util\Network;
  42
  43 class APContact
  44 {
  45         /**
  46          * Fetch webfinger data
  47          *
  48          * @param string $addr Address
  49          * @return array webfinger data
  50          */
  51         private static function fetchWebfingerData(string $addr): array
  52         {
  53                 $addr_parts = explode('@', $addr);
  54                 if (count($addr_parts) != 2) {
  55                         return [];
  56                 }
  57
  58                 if (Contact::isLocal($addr) && ($local_uid = User::getIdForURL($addr)) && ($local_owner = User::getOwnerDataById($local_uid))) {
  59                         $data = [
  60                                 'addr'      => $local_owner['addr'],
  61                                 'baseurl'   => $local_owner['baseurl'],
  62                                 'url'       => $local_owner['url'],
  63                                 'subscribe' => $local_owner['baseurl'] . '/follow?url={uri}'];
  64
  65                         if (!empty($local_owner['alias']) && ($local_owner['url'] != $local_owner['alias'])) {
  66                                 $data['alias'] = $local_owner['alias'];
  67                         }
  68
  69                         return $data;
  70                 }
  71
  72                 $data = ['addr' => $addr];
  73                 $template = 'https://' . $addr_parts[1] . '/.well-known/webfinger?resource=acct:' . urlencode($addr);
  74                 $webfinger = Probe::webfinger(str_replace('{uri}', urlencode($addr), $template), HttpClientAccept::JRD_JSON);
  75                 if (empty($webfinger['links'])) {
  76                         $template = 'http://' . $addr_parts[1] . '/.well-known/webfinger?resource=acct:' . urlencode($addr);
  77                         $webfinger = Probe::webfinger(str_replace('{uri}', urlencode($addr), $template), HttpClientAccept::JRD_JSON);
  78                         if (empty($webfinger['links'])) {
  79                                 return [];
  80                         }
  81                         $data['baseurl'] = 'http://' . $addr_parts[1];
  82                 } else {
  83                         $data['baseurl'] = 'https://' . $addr_parts[1];
  84                 }
  85
  86                 foreach ($webfinger['links'] as $link) {
  87                         if (empty($link['rel'])) {
  88                                 continue;
  89                         }
  90
  91                         if (!empty($link['template']) && ($link['rel'] == ActivityNamespace::OSTATUSSUB)) {
  92                                 $data['subscribe'] = $link['template'];
  93                         }
  94
  95                         if (!empty($link['href']) && !empty($link['type']) && ($link['rel'] == 'self') && ($link['type'] == 'application/activity+json')) {
  96                                 $data['url'] = $link['href'];
  97                         }
  98
  99                         if (!empty($link['href']) && !empty($link['type']) && ($link['rel'] == 'http://webfinger.net/rel/profile-page') && ($link['type'] == 'text/html')) {
 100                                 $data['alias'] = $link['href'];
 101                         }
 102                 }
 103
 104                 if (!empty($data['url']) && !empty($data['alias']) && ($data['url'] == $data['alias'])) {
 105                         unset($data['alias']);
 106                 }
 107
 108                 return $data;
 109         }
 110
 111         /**
 112          * Fetches a profile from a given url
 113          *
 114          * @param string  $url    profile url
 115          * @param boolean $update true = always update, false = never update, null = update when not found or outdated
 116          * @return array profile array
 117          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 118          * @throws \ImagickException
 119          * @todo Rewrite parameter $update to avoid true|false|null (boolean is binary, null adds a third case)
 120          */
 121         public static function getByURL(string $url, $update = null): array
 122         {
 123                 if (empty($url) || Network::isUrlBlocked($url)) {
 124                         Logger::info('Domain is blocked', ['url' => $url]);
 125                         return [];
 126                 }
 127
 128                 $fetched_contact = [];
 129
 130                 if (empty($update)) {
 131                         if (is_null($update)) {
 132                                 $ref_update = DateTimeFormat::utc('now - 1 month');
 133                         } else {
 134                                 $ref_update = DBA::NULL_DATETIME;
 135                         }
 136
 137                         $apcontact = DBA::selectFirst('apcontact', [], ['url' => $url]);
 138                         if (!DBA::isResult($apcontact)) {
 139                                 $apcontact = DBA::selectFirst('apcontact', [], ['alias' => $url]);
 140                         }
 141
 142                         if (!DBA::isResult($apcontact)) {
 143                                 $apcontact = DBA::selectFirst('apcontact', [], ['addr' => $url]);
 144                         }
 145
 146                         if (DBA::isResult($apcontact) && ($apcontact['updated'] > $ref_update) && !empty($apcontact['pubkey']) && !empty($apcontact['uri-id'])) {
 147                                 return $apcontact;
 148                         }
 149
 150                         if (!is_null($update)) {
 151                                 return DBA::isResult($apcontact) ? $apcontact : [];
 152                         }
 153
 154                         if (DBA::isResult($apcontact)) {
 155                                 $fetched_contact = $apcontact;
 156                         }
 157                 }
 158
 159                 $apcontact = [];
 160
 161                 $webfinger = empty(parse_url($url, PHP_URL_SCHEME));
 162                 if ($webfinger) {
 163                         $apcontact = self::fetchWebfingerData($url);
 164                         if (empty($apcontact['url'])) {
 165                                 return $fetched_contact;
 166                         }
 167                         $url = $apcontact['url'];
 168                 } elseif (empty(parse_url($url, PHP_URL_PATH))) {
 169                         $apcontact['baseurl'] = $url;
 170                 }
 171
 172                 // Detect multiple fast repeating request to the same address
 173                 // See https://github.com/friendica/friendica/issues/9303
 174                 $cachekey = 'apcontact:' . ItemURI::getIdByURI($url);
 175                 $result = DI::cache()->get($cachekey);
 176                 if (!is_null($result)) {
 177                         Logger::notice('Multiple requests for the address', ['url' => $url, 'update' => $update, 'callstack' => System::callstack(20), 'result' => $result]);
 178                         if (!empty($fetched_contact)) {
 179                                 return $fetched_contact;
 180                         }
 181                 } else {
 182                         DI::cache()->set($cachekey, System::callstack(20), Duration::FIVE_MINUTES);
 183                 }
 184
 185                 if (Network::isLocalLink($url) && ($local_uid = User::getIdForURL($url))) {
 186                         try {
 187                                 $data = Transmitter::getProfile($local_uid);
 188                                 $local_owner = User::getOwnerDataById($local_uid);
 189                         } catch(HTTPException\NotFoundException $e) {
 190                                 $data = null;
 191                         }
 192                 }
 193
 194                 if (empty($data)) {
 195                         $local_owner = [];
 196
 197                         $curlResult = HTTPSignature::fetchRaw($url);
 198                         $failed = empty($curlResult) || empty($curlResult->getBody()) ||
 199                                 (!$curlResult->isSuccess() && ($curlResult->getReturnCode() != 410));
 200
 201                         if (!$failed) {
 202                                 $data = json_decode($curlResult->getBody(), true);
 203                                 $failed = empty($data) || !is_array($data);
 204                         }
 205
 206                         if (!$failed && ($curlResult->getReturnCode() == 410)) {
 207                                 $data = ['@context' => ActivityPub::CONTEXT, 'id' => $url, 'type' => 'Tombstone'];
 208                         }
 209
 210                         if ($failed) {
 211                                 self::markForArchival($fetched_contact ?: []);
 212                                 return $fetched_contact;
 213                         }
 214                 }
 215
 216                 $compacted = JsonLD::compact($data);
 217                 if (empty($compacted['@id'])) {
 218                         return $fetched_contact;
 219                 }
 220
 221                 $apcontact['url'] = $compacted['@id'];
 222                 $apcontact['uuid'] = JsonLD::fetchElement($compacted, 'diaspora:guid', '@value');
 223                 $apcontact['type'] = str_replace('as:', '', JsonLD::fetchElement($compacted, '@type'));
 224                 $apcontact['following'] = JsonLD::fetchElement($compacted, 'as:following', '@id');
 225                 $apcontact['followers'] = JsonLD::fetchElement($compacted, 'as:followers', '@id');
 226                 $apcontact['inbox'] = (JsonLD::fetchElement($compacted, 'ldp:inbox', '@id') ?? '');
 227                 self::unarchiveInbox($apcontact['inbox'], false);
 228
 229                 $apcontact['outbox'] = JsonLD::fetchElement($compacted, 'as:outbox', '@id');
 230
 231                 $apcontact['sharedinbox'] = '';
 232                 if (!empty($compacted['as:endpoints'])) {
 233                         $apcontact['sharedinbox'] = (JsonLD::fetchElement($compacted['as:endpoints'], 'as:sharedInbox', '@id') ?? '');
 234                         self::unarchiveInbox($apcontact['sharedinbox'], true);
 235                 }
 236
 237                 $apcontact['featured']      = JsonLD::fetchElement($compacted, 'toot:featured', '@id');
 238                 $apcontact['featured-tags'] = JsonLD::fetchElement($compacted, 'toot:featuredTags', '@id');
 239
 240                 $apcontact['nick'] = JsonLD::fetchElement($compacted, 'as:preferredUsername', '@value') ?? '';
 241                 $apcontact['name'] = JsonLD::fetchElement($compacted, 'as:name', '@value');
 242
 243                 if (empty($apcontact['name'])) {
 244                         $apcontact['name'] = $apcontact['nick'];
 245                 }
 246
 247                 $apcontact['about'] = HTML::toBBCode(JsonLD::fetchElement($compacted, 'as:summary', '@value') ?? '');
 248
 249                 $ims = JsonLD::fetchElementArray($compacted, 'vcard:hasInstantMessage');
 250
 251                 if (!empty($ims)) {
 252                         foreach ($ims as $link) {
 253                                 if (substr($link, 0, 5) == 'xmpp:') {
 254                                         $apcontact['xmpp'] = substr($link, 5);
 255                                 }
 256                                 if (substr($link, 0, 7) == 'matrix:') {
 257                                         $apcontact['matrix'] = substr($link, 7);
 258                                 }
 259                         }
 260                 }
 261
 262                 $apcontact['photo'] = JsonLD::fetchElement($compacted, 'as:icon', '@id');
 263                 if (is_array($apcontact['photo']) || !empty($compacted['as:icon']['as:url']['@id'])) {
 264                         $apcontact['photo'] = JsonLD::fetchElement($compacted['as:icon'], 'as:url', '@id');
 265                 }
 266
 267                 $apcontact['header'] = JsonLD::fetchElement($compacted, 'as:image', '@id');
 268                 if (is_array($apcontact['header']) || !empty($compacted['as:image']['as:url']['@id'])) {
 269                         $apcontact['header'] = JsonLD::fetchElement($compacted['as:image'], 'as:url', '@id');
 270                 }
 271
 272                 if (empty($apcontact['alias'])) {
 273                         $apcontact['alias'] = JsonLD::fetchElement($compacted, 'as:url', '@id');
 274                         if (is_array($apcontact['alias'])) {
 275                                 $apcontact['alias'] = JsonLD::fetchElement($compacted['as:url'], 'as:href', '@id');
 276                         }
 277                 }
 278
 279                 // Quit if none of the basic values are set
 280                 if (empty($apcontact['url']) || empty($apcontact['type']) || (($apcontact['type'] != 'Tombstone') && empty($apcontact['inbox']))) {
 281                         return $fetched_contact;
 282                 } elseif ($apcontact['type'] == 'Tombstone') {
 283                         // The "inbox" field must have a content
 284                         $apcontact['inbox'] = '';
 285                 }
 286
 287                 // Quit if this doesn't seem to be an account at all
 288                 if (!in_array($apcontact['type'], ActivityPub::ACCOUNT_TYPES)) {
 289                         return $fetched_contact;
 290                 }
 291
 292                 $parts = parse_url($apcontact['url']);
 293                 unset($parts['scheme']);
 294                 unset($parts['path']);
 295
 296                 if (empty($apcontact['addr'])) {
 297                         if (!empty($apcontact['nick']) && is_array($parts)) {
 298                                 $apcontact['addr'] = $apcontact['nick'] . '@' . str_replace('//', '', Network::unparseURL($parts));
 299                         } else {
 300                                 $apcontact['addr'] = '';
 301                         }
 302                 }
 303
 304                 $apcontact['pubkey'] = null;
 305                 if (!empty($compacted['w3id:publicKey'])) {
 306                         $apcontact['pubkey'] = trim(JsonLD::fetchElement($compacted['w3id:publicKey'], 'w3id:publicKeyPem', '@value'));
 307                         if (strstr($apcontact['pubkey'], 'RSA ')) {
 308                                 $apcontact['pubkey'] = Crypto::rsaToPem($apcontact['pubkey']);
 309                         }
 310                 }
 311
 312                 $apcontact['manually-approve'] = (int)JsonLD::fetchElement($compacted, 'as:manuallyApprovesFollowers');
 313
 314                 if (!empty($compacted['as:generator'])) {
 315                         $apcontact['baseurl'] = JsonLD::fetchElement($compacted['as:generator'], 'as:url', '@id');
 316                         $apcontact['generator'] = JsonLD::fetchElement($compacted['as:generator'], 'as:name', '@value');
 317                 }
 318
 319                 if (!empty($apcontact['following'])) {
 320                         if (!empty($local_owner)) {
 321                                 $following = ActivityPub\Transmitter::getContacts($local_owner, [Contact::SHARING, Contact::FRIEND], 'following');
 322                         } else {
 323                                 $following = ActivityPub::fetchContent($apcontact['following']);
 324                         }
 325                         if (!empty($following['totalItems'])) {
 326                                 // Mastodon seriously allows for this condition?
 327                                 // Jul 14 2021 - See https://mastodon.social/@BLUW for a negative following count
 328                                 if ($following['totalItems'] < 0) {
 329                                         $following['totalItems'] = 0;
 330                                 }
 331                                 $apcontact['following_count'] = $following['totalItems'];
 332                         }
 333                 }
 334
 335                 if (!empty($apcontact['followers'])) {
 336                         if (!empty($local_owner)) {
 337                                 $followers = ActivityPub\Transmitter::getContacts($local_owner, [Contact::FOLLOWER, Contact::FRIEND], 'followers');
 338                         } else {
 339                                 $followers = ActivityPub::fetchContent($apcontact['followers']);
 340                         }
 341                         if (!empty($followers['totalItems'])) {
 342                                 // Mastodon seriously allows for this condition?
 343                                 // Jul 14 2021 - See https://mastodon.online/@goes11 for a negative followers count
 344                                 if ($followers['totalItems'] < 0) {
 345                                         $followers['totalItems'] = 0;
 346                                 }
 347                                 $apcontact['followers_count'] = $followers['totalItems'];
 348                         }
 349                 }
 350
 351                 if (!empty($apcontact['outbox'])) {
 352                         if (!empty($local_owner)) {
 353                                 $outbox = ActivityPub\Transmitter::getOutbox($local_owner);
 354                         } else {
 355                                 $outbox = ActivityPub::fetchContent($apcontact['outbox']);
 356                         }
 357                         if (!empty($outbox['totalItems'])) {
 358                                 // Mastodon seriously allows for this condition?
 359                                 // Jul 20 2021 - See https://chaos.social/@m11 for a negative posts count
 360                                 if ($outbox['totalItems'] < 0) {
 361                                         $outbox['totalItems'] = 0;
 362                                 }
 363                                 $apcontact['statuses_count'] = $outbox['totalItems'];
 364                         }
 365                 }
 366
 367                 $apcontact['discoverable'] = JsonLD::fetchElement($compacted, 'toot:discoverable', '@value');
 368
 369                 // To-Do
 370
 371                 // Unhandled
 372                 // tag, attachment, image, nomadicLocations, signature, movedTo, liked
 373
 374                 // Unhandled from Misskey
 375                 // sharedInbox, isCat
 376
 377                 // Unhandled from Kroeg
 378                 // kroeg:blocks, updated
 379
 380                 // When the photo is too large, try to shorten it by removing parts
 381                 if (strlen($apcontact['photo']) > 255) {
 382                         $parts = parse_url($apcontact['photo']);
 383                         unset($parts['fragment']);
 384                         $apcontact['photo'] = Network::unparseURL($parts);
 385
 386                         if (strlen($apcontact['photo']) > 255) {
 387                                 unset($parts['query']);
 388                                 $apcontact['photo'] = Network::unparseURL($parts);
 389                         }
 390
 391                         if (strlen($apcontact['photo']) > 255) {
 392                                 $apcontact['photo'] = substr($apcontact['photo'], 0, 255);
 393                         }
 394                 }
 395
 396                 if (!$webfinger && !empty($apcontact['addr'])) {
 397                         $data = self::fetchWebfingerData($apcontact['addr']);
 398                         if (!empty($data)) {
 399                                 $apcontact['baseurl'] = $data['baseurl'];
 400
 401                                 if (empty($apcontact['alias']) && !empty($data['alias'])) {
 402                                         $apcontact['alias'] = $data['alias'];
 403                                 }
 404                                 if (!empty($data['subscribe'])) {
 405                                         $apcontact['subscribe'] = $data['subscribe'];
 406                                 }
 407                         } else {
 408                                 $apcontact['addr'] = null;
 409                         }
 410                 }
 411
 412                 if (empty($apcontact['baseurl'])) {
 413                         $apcontact['baseurl'] = null;
 414                 }
 415
 416                 if (empty($apcontact['subscribe'])) {
 417                         $apcontact['subscribe'] = null;
 418                 }
 419
 420                 if (!empty($apcontact['baseurl']) && empty($fetched_contact['gsid'])) {
 421                         $apcontact['gsid'] = GServer::getID($apcontact['baseurl']);
 422                 } elseif (!empty($fetched_contact['gsid'])) {
 423                         $apcontact['gsid'] = $fetched_contact['gsid'];
 424                 } else {
 425                         $apcontact['gsid'] = null;
 426                 }
 427
 428                 if ($apcontact['url'] == $apcontact['alias']) {
 429                         $apcontact['alias'] = null;
 430                 }
 431
 432                 if (empty($apcontact['uuid'])) {
 433                         $apcontact['uri-id'] = ItemURI::getIdByURI($apcontact['url']);
 434                 } else {
 435                         $apcontact['uri-id'] = ItemURI::insert(['uri' => $apcontact['url'], 'guid' => $apcontact['uuid']]);
 436                 }
 437
 438                 foreach (APContact\Endpoint::ENDPOINT_NAMES as $type => $name) {
 439                         $value = JsonLD::fetchElement($compacted, $name, '@id');
 440                         if (empty($value)) {
 441                                 continue;
 442                         }
 443                         APContact\Endpoint::update($apcontact['uri-id'], $type, $value);
 444                 }
 445
 446                 if (!empty($compacted['as:endpoints'])) {
 447                         foreach ($compacted['as:endpoints'] as $name => $endpoint) {
 448                                 if (empty($endpoint['@id']) || !is_string($endpoint['@id'])) {
 449                                         continue;
 450                                 }
 451
 452                                 if (in_array($name, APContact\Endpoint::ENDPOINT_NAMES)) {
 453                                         $key = array_search($name, APContact\Endpoint::ENDPOINT_NAMES);
 454                                         APContact\Endpoint::update($apcontact['uri-id'], $key, $endpoint['@id']);
 455                                         Logger::debug('Store endpoint', ['key' => $key, 'name' => $name, 'endpoint' => $endpoint['@id']]);
 456                                 } elseif (!in_array($name, ['as:sharedInbox', 'as:uploadMedia', 'as:oauthTokenEndpoint', 'as:oauthAuthorizationEndpoint', 'litepub:oauthRegistrationEndpoint'])) {
 457                                         Logger::debug('Unknown endpoint', ['name' => $name, 'endpoint' => $endpoint['@id']]);
 458                                 }
 459                         }
 460                 }
 461
 462                 $apcontact['updated'] = DateTimeFormat::utcNow();
 463
 464                 // We delete the old entry when the URL is changed
 465                 if ($url != $apcontact['url']) {
 466                         Logger::info('Delete changed profile url', ['old' => $url, 'new' => $apcontact['url']]);
 467                         DBA::delete('apcontact', ['url' => $url]);
 468                 }
 469
 470                 // Limit the length on incoming fields
 471                 $apcontact = DI::dbaDefinition()->truncateFieldsForTable('apcontact', $apcontact);
 472
 473                 if (DBA::exists('apcontact', ['url' => $apcontact['url']])) {
 474                         DBA::update('apcontact', $apcontact, ['url' => $apcontact['url']]);
 475                 } else {
 476                         DBA::replace('apcontact', $apcontact);
 477                 }
 478
 479                 Logger::info('Updated profile', ['url' => $url]);
 480
 481                 return DBA::selectFirst('apcontact', [], ['url' => $apcontact['url']]) ?: [];
 482         }
 483
 484         /**
 485          * Mark the given AP Contact as "to archive"
 486          *
 487          * @param array $apcontact
 488          * @return void
 489          */
 490         public static function markForArchival(array $apcontact)
 491         {
 492                 if (!empty($apcontact['inbox'])) {
 493                         Logger::info('Set inbox status to failure', ['inbox' => $apcontact['inbox']]);
 494                         HTTPSignature::setInboxStatus($apcontact['inbox'], false);
 495                 }
 496
 497                 if (!empty($apcontact['sharedinbox'])) {
 498                         // Check if there are any available inboxes
 499                         $available = DBA::exists('apcontact', ["`sharedinbox` = ? AnD `inbox` IN (SELECT `url` FROM `inbox-status` WHERE `success` > `failure`)",
 500                                 $apcontact['sharedinbox']]);
 501                         if (!$available) {
 502                                 // If all known personal inboxes are failing then set their shared inbox to failure as well
 503                                 Logger::info('Set shared inbox status to failure', ['sharedinbox' => $apcontact['sharedinbox']]);
 504                                 HTTPSignature::setInboxStatus($apcontact['sharedinbox'], false, true);
 505                         }
 506                 }
 507         }
 508
 509         /**
 510          * Unmark the given AP Contact as "to archive"
 511          *
 512          * @param array $apcontact
 513          * @return void
 514          */
 515         public static function unmarkForArchival(array $apcontact)
 516         {
 517                 if (!empty($apcontact['inbox'])) {
 518                         Logger::info('Set inbox status to success', ['inbox' => $apcontact['inbox']]);
 519                         HTTPSignature::setInboxStatus($apcontact['inbox'], true);
 520                 }
 521                 if (!empty($apcontact['sharedinbox'])) {
 522                         Logger::info('Set shared inbox status to success', ['sharedinbox' => $apcontact['sharedinbox']]);
 523                         HTTPSignature::setInboxStatus($apcontact['sharedinbox'], true, true);
 524                 }
 525         }
 526
 527         /**
 528          * Unarchive inboxes
 529          *
 530          * @param string  $url    inbox url
 531          * @param boolean $shared Shared Inbox
 532          * @return void
 533          */
 534         private static function unarchiveInbox(string $url, bool $shared)
 535         {
 536                 if (empty($url)) {
 537                         return;
 538                 }
 539
 540                 HTTPSignature::setInboxStatus($url, true, $shared);
 541         }
 542 }