]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/Protocol.php
Merge pull request #11520 from annando/display-polls
[friendica.git] / src / Core / Protocol.php
index 860ac26be68beff9ecfe1d9b01d9b2b5105574e0..c141bbc54e6240f2c79372050468e458ab34964c 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @copyright Copyright (C) 2010-2022, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
 
 namespace Friendica\Core;
 
-use Friendica\DI;
+use Friendica\Database\DBA;
+use Friendica\Model\User;
+use Friendica\Network\HTTPException;
+use Friendica\Protocol\Activity;
+use Friendica\Protocol\ActivityPub;
+use Friendica\Protocol\Diaspora;
+use Friendica\Protocol\OStatus;
+use Friendica\Protocol\Salmon;
 
 /**
  * Manage compatibility with federated networks
@@ -66,95 +73,230 @@ class Protocol
        const PHANTOM   = 'unkn';    // Place holder
 
        /**
-        * Returns the address string for the provided profile URL
+        * Returns whether the provided protocol supports following
         *
-        * @param string $profile_url
-        * @return string
-        * @throws \Exception
+        * @param $protocol
+        * @return bool
+        * @throws HTTPException\InternalServerErrorException
         */
-       public static function getAddrFromProfileUrl($profile_url)
+       public static function supportsFollow($protocol): bool
        {
-               $network = self::matchByProfileUrl($profile_url, $matches);
-
-               if ($network === self::PHANTOM) {
-                       return "";
+               if (in_array($protocol, self::NATIVE_SUPPORT)) {
+                       return true;
                }
 
-               $addr = $matches[2] . '@' . $matches[1];
+               $hook_data = [
+                       'protocol' => $protocol,
+                       'result' => null
+               ];
+               Hook::callAll('support_follow', $hook_data);
 
-               return $addr;
+               return $hook_data['result'] === true;
        }
 
        /**
-        * Guesses the network from a profile URL
+        * Returns whether the provided protocol supports revoking inbound follows
         *
-        * @param string $profile_url
-        * @param array  $matches preg_match return array: [0] => Full match [1] => hostname [2] => username
-        * @return string
+        * @param $protocol
+        * @return bool
+        * @throws HTTPException\InternalServerErrorException
         */
-       public static function matchByProfileUrl($profile_url, &$matches = [])
+       public static function supportsRevokeFollow($protocol): bool
        {
-               if (preg_match('=https?://(twitter\.com)/(.*)=ism', $profile_url, $matches)) {
-                       return self::TWITTER;
+               if (in_array($protocol, self::NATIVE_SUPPORT)) {
+                       return true;
                }
 
-               if (preg_match('=https?://(alpha\.app\.net)/(.*)=ism', $profile_url, $matches)) {
-                       return self::APPNET;
-               }
+               $hook_data = [
+                       'protocol' => $protocol,
+                       'result' => null
+               ];
+               Hook::callAll('support_revoke_follow', $hook_data);
 
-               if (preg_match('=https?://(plus\.google\.com)/(.*)=ism', $profile_url, $matches)) {
-                       return self::GPLUS;
+               return $hook_data['result'] === true;
+       }
+
+       /**
+        * Send a follow message to a remote server.
+        *
+        * @param int     $uid      User Id
+        * @param array   $contact  Contact being followed
+        * @param ?string $protocol Expected protocol
+        * @return bool Only returns false in the unlikely case an ActivityPub contact ID doesn't exist (???)
+        * @throws HTTPException\InternalServerErrorException
+        * @throws \ImagickException
+        */
+       public static function follow(int $uid, array $contact, ?string $protocol = null): bool
+       {
+               $owner = User::getOwnerDataById($uid);
+               if (!DBA::isResult($owner)) {
+                       return true;
                }
 
-               if (preg_match('=https?://(.*)/profile/(.*)=ism', $profile_url, $matches)) {
-                       return self::DFRN;
+               $protocol = $protocol ?? $contact['protocol'];
+
+               if (in_array($protocol, [Protocol::OSTATUS, Protocol::DFRN])) {
+                       // create a follow slap
+                       $item = [
+                               'verb'    => Activity::FOLLOW,
+                               'gravity' => GRAVITY_ACTIVITY,
+                               'follow'  => $contact['url'],
+                               'body'    => '',
+                               'title'   => '',
+                               'guid'    => '',
+                               'uri-id'  => 0,
+                       ];
+
+                       $slap = OStatus::salmon($item, $owner);
+
+                       if (!empty($contact['notify'])) {
+                               Salmon::slapper($owner, $contact['notify'], $slap);
+                       }
+               } elseif ($protocol == Protocol::DIASPORA) {
+                       $contact = Diaspora::sendShare($owner, $contact);
+                       Logger::notice('share returns: ' . $contact);
+               } elseif ($protocol == Protocol::ACTIVITYPUB) {
+                       $activity_id = ActivityPub\Transmitter::activityIDFromContact($contact['id']);
+                       if (empty($activity_id)) {
+                               // This really should never happen
+                               return false;
+                       }
+
+                       $success = ActivityPub\Transmitter::sendActivity('Follow', $contact['url'], $owner['uid'], $activity_id);
+                       Logger::notice('Follow returns: ' . $success);
                }
 
-               if (preg_match('=https?://(.*)/u/(.*)=ism', $profile_url, $matches)) {
-                       return self::DIASPORA;
+               return true;
+       }
+
+       /**
+        * Sends an unfollow message. Does not remove the contact
+        *
+        * @param array $contact Target public contact (uid = 0) array
+        * @param array $user    Source local user array
+        * @return bool|null true if successful, false if not, null if no remote action was performed
+        * @throws HTTPException\InternalServerErrorException
+        * @throws \ImagickException
+        */
+       public static function unfollow(array $contact, array $user): ?bool
+       {
+               if (empty($contact['network'])) {
+                       throw new \InvalidArgumentException('Missing network key in contact array');
                }
 
-               if (preg_match('=https?://(.*)/channel/(.*)=ism', $profile_url, $matches)) {
-                       // RedMatrix/Hubzilla is identified as Diaspora - friendica can't connect directly to it
-                       return self::DIASPORA;
+               $protocol = $contact['network'];
+               if (($protocol == Protocol::DFRN) && !empty($contact['protocol'])) {
+                       $protocol = $contact['protocol'];
                }
 
-               if (preg_match('=https?://(.*)/user/(.*)=ism', $profile_url, $matches)) {
-                       $statusnet_host = $matches[1];
-                       $statusnet_user = $matches[2];
-                       $UserData = DI::httpRequest()->fetch('http://' . $statusnet_host . '/api/users/show.json?user_id=' . $statusnet_user);
-                       $user = json_decode($UserData);
-                       if ($user) {
-                               $matches[2] = $user->screen_name;
-                               return self::STATUSNET;
+               if (in_array($protocol, [Protocol::OSTATUS, Protocol::DFRN])) {
+                       // create an unfollow slap
+                       $item = [];
+                       $item['verb'] = Activity::O_UNFOLLOW;
+                       $item['gravity'] = GRAVITY_ACTIVITY;
+                       $item['follow'] = $contact['url'];
+                       $item['body'] = '';
+                       $item['title'] = '';
+                       $item['guid'] = '';
+                       $item['uri-id'] = 0;
+                       $slap = OStatus::salmon($item, $user);
+
+                       if (empty($contact['notify'])) {
+                               throw new \InvalidArgumentException('Missing expected "notify" key in OStatus/DFRN contact');
                        }
+
+                       return Salmon::slapper($user, $contact['notify'], $slap) === 0;
+               } elseif ($protocol == Protocol::DIASPORA) {
+                       return Diaspora::sendUnshare($user, $contact) > 0;
+               } elseif ($protocol == Protocol::ACTIVITYPUB) {
+                       return ActivityPub\Transmitter::sendContactUndo($contact['url'], $contact['id'], $user['uid']);
+               }
+
+               // Catch-all hook for connector addons
+               $hook_data = [
+                       'contact' => $contact,
+                       'uid'     => $user['uid'],
+                       'result'  => null,
+               ];
+               Hook::callAll('unfollow', $hook_data);
+
+               return $hook_data['result'];
+       }
+
+       /**
+        * Revoke an incoming follow from the provided contact
+        *
+        * @param array $contact Target public contact (uid == 0) array
+        * @param int   $uid     Source local user id
+        * @return bool|null true if successful, false if not, null if no action was performed
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
+        */
+       public static function revokeFollow(array $contact, int $uid): ?bool
+       {
+               if (empty($contact['network'])) {
+                       throw new \InvalidArgumentException('Missing network key in contact array');
                }
 
-               // Mastodon, Pleroma
-               if (preg_match('=https?://(.+?)/users/(.+)=ism', $profile_url, $matches)
-                       || preg_match('=https?://(.+?)/@(.+)=ism', $profile_url, $matches)
-               ) {
-                       return self::ACTIVITYPUB;
+               $protocol = $contact['network'];
+               if ($protocol == Protocol::DFRN && !empty($contact['protocol'])) {
+                       $protocol = $contact['protocol'];
                }
 
-               // pumpio (http://host.name/user)
-               if (preg_match('=https?://([\.\w]+)/([\.\w]+)$=ism', $profile_url, $matches)) {
-                       return self::PUMPIO;
+               if ($protocol == Protocol::ACTIVITYPUB) {
+                       return ActivityPub\Transmitter::sendContactReject($contact['url'], $contact['hub-verify'], $uid);
                }
 
-               return self::PHANTOM;
+               // Catch-all hook for connector addons
+               $hook_data = [
+                       'contact' => $contact,
+                       'uid'     => $uid,
+                       'result'  => null,
+               ];
+               Hook::callAll('revoke_follow', $hook_data);
+
+               return $hook_data['result'];
+       }
+
+       /**
+        * Send a block message to a remote server. Only useful for connector addons.
+        *
+        * @param array $contact Public contact record to block
+        * @param int   $uid     User issuing the block
+        * @return bool|null true if successful, false if not, null if no action was performed
+        * @throws HTTPException\InternalServerErrorException
+        */
+       public static function block(array $contact, int $uid): ?bool
+       {
+               // Catch-all hook for connector addons
+               $hook_data = [
+                       'contact' => $contact,
+                       'uid' => $uid,
+                       'result' => null,
+               ];
+               Hook::callAll('block', $hook_data);
+
+               return $hook_data['result'];
        }
 
        /**
-        * Returns a formatted mention from a profile URL and a display name
+        * Send an unblock message to a remote server. Only useful for connector addons.
         *
-        * @param string $profile_url
-        * @param string $display_name
-        * @return string
-        * @throws \Exception
+        * @param array $contact Public contact record to unblock
+        * @param int   $uid     User revoking the block
+        * @return bool|null true if successful, false if not, null if no action was performed
+        * @throws HTTPException\InternalServerErrorException
         */
-       public static function formatMention($profile_url, $display_name)
+       public static function unblock(array $contact, int $uid): ?bool
        {
-               return $display_name . ' (' . self::getAddrFromProfileUrl($profile_url) . ')';
+               // Catch-all hook for connector addons
+               $hook_data = [
+                       'contact' => $contact,
+                       'uid' => $uid,
+                       'result' => null,
+               ];
+               Hook::callAll('unblock', $hook_data);
+
+               return $hook_data['result'];
        }
 }