X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FProtocol.php;h=bba7149a0462b848e4e3a6a101a2ec1f0256479a;hb=06284e60073f374c1bd411e0bba6474a13c14f10;hp=949e2350c3be85ceb72f93d0ad756cb8d2936b84;hpb=a19f8d642d6078b2a9f43770fcc863b5c006c026;p=friendica.git diff --git a/src/Core/Protocol.php b/src/Core/Protocol.php index 949e2350c3..bba7149a04 100644 --- a/src/Core/Protocol.php +++ b/src/Core/Protocol.php @@ -1,37 +1,67 @@ . + * */ + namespace Friendica\Core; -use Friendica\Util\Network; +use Friendica\Database\DBA; +use Friendica\DI; +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 - * - * @author Hypolite Petovan */ class Protocol { // Native support - const ACTIVITYPUB = 'apub'; // ActivityPub + const ACTIVITYPUB = 'apub'; // ActivityPub (Pleroma, Mastodon, Osada, ...) const DFRN = 'dfrn'; // Friendica, Mistpark, other DFRN implementations - const DIASPORA = 'dspr'; // Diaspora + const DIASPORA = 'dspr'; // Diaspora, Hubzilla, Socialhome, Ganggo const FEED = 'feed'; // RSS/Atom feeds with no known "post/notify" protocol const MAIL = 'mail'; // IMAP/POP - const OSTATUS = 'stat'; // GNU-social, Pleroma, Mastodon, other OStatus implementations + const OSTATUS = 'stat'; // GNU Social and other OStatus implementations const NATIVE_SUPPORT = [self::DFRN, self::DIASPORA, self::OSTATUS, self::FEED, self::MAIL, self::ACTIVITYPUB]; + const FEDERATED = [self::DFRN, self::DIASPORA, self::OSTATUS, self::ACTIVITYPUB]; + + const SUPPORT_PRIVATE = [self::DFRN, self::DIASPORA, self::MAIL, self::ACTIVITYPUB, self::PUMPIO]; + // Supported through a connector - const APPNET = 'apdn'; // app.net - Dead protocol const DIASPORA2 = 'dspc'; // Diaspora connector - const FACEBOOK = 'face'; // Facebook API - const GPLUS = 'goog'; // Google+ const LINKEDIN = 'lnkd'; // LinkedIn const PUMPIO = 'pump'; // pump.io const STATUSNET = 'stac'; // Statusnet connector const TWITTER = 'twit'; // Twitter + const DISCOURSE = 'dscs'; // Discourse + + // Dead protocols + const APPNET = 'apdn'; // app.net - Dead protocol + const FACEBOOK = 'face'; // Facebook API - Not working anymore, API is closed + const GPLUS = 'goog'; // Google+ - Dead in 2019 // Currently unsupported const ICALENDAR = 'ical'; // iCalendar @@ -43,12 +73,56 @@ class Protocol const PHANTOM = 'unkn'; // Place holder + /** + * Returns whether the provided protocol supports following + * + * @param $protocol + * @return bool + * @throws HTTPException\InternalServerErrorException + */ + public static function supportsFollow($protocol): bool + { + if (in_array($protocol, self::NATIVE_SUPPORT)) { + return true; + } + + $hook_data = [ + 'protocol' => $protocol, + 'result' => null + ]; + Hook::callAll('support_follow', $hook_data); + + return $hook_data['result'] === true; + } + + /** + * Returns whether the provided protocol supports revoking inbound follows + * + * @param $protocol + * @return bool + * @throws HTTPException\InternalServerErrorException + */ + public static function supportsRevokeFollow($protocol): bool + { + if (in_array($protocol, self::NATIVE_SUPPORT)) { + return true; + } + + $hook_data = [ + 'protocol' => $protocol, + 'result' => null + ]; + Hook::callAll('support_revoke_follow', $hook_data); + + return $hook_data['result'] === true; + } + /** * Returns the address string for the provided profile URL * * @param string $profile_url * @return string - * @throws Exception + * @throws \Exception */ public static function getAddrFromProfileUrl($profile_url) { @@ -67,8 +141,8 @@ class Protocol * Guesses the network from a profile URL * * @param string $profile_url - * @param array $matches preg_match return array: [0] => Full match [1] => hostname [2] => username - * @return type + * @param array $matches preg_match return array: [0] => Full match [1] => hostname [2] => username + * @return string */ public static function matchByProfileUrl($profile_url, &$matches = []) { @@ -100,7 +174,7 @@ class Protocol if (preg_match('=https?://(.*)/user/(.*)=ism', $profile_url, $matches)) { $statusnet_host = $matches[1]; $statusnet_user = $matches[2]; - $UserData = Network::fetchUrl('http://' . $statusnet_host . '/api/users/show.json?user_id=' . $statusnet_user); + $UserData = DI::httpClient()->fetch('http://' . $statusnet_host . '/api/users/show.json?user_id=' . $statusnet_user); $user = json_decode($UserData); if ($user) { $matches[2] = $user->screen_name; @@ -129,9 +203,191 @@ class Protocol * @param string $profile_url * @param string $display_name * @return string + * @throws \Exception */ public static function formatMention($profile_url, $display_name) { return $display_name . ' (' . self::getAddrFromProfileUrl($profile_url) . ')'; } + + /** + * 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; + } + + $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); + } + + return true; + } + + /** + * Sends an unfriend message. Does not remove the contact + * + * @param array $user User unfriending + * @param array $contact Contact unfriended + * @return bool|null true if successful, false if not, null if no remote action was performed + * @throws HTTPException\InternalServerErrorException + * @throws \ImagickException + */ + public static function terminateFriendship(array $user, array $contact): ?bool + { + if (empty($contact['network'])) { + throw new \InvalidArgumentException('Missing network key in contact array'); + } + + $protocol = $contact['network']; + if (($protocol == Protocol::DFRN) && !empty($contact['protocol'])) { + $protocol = $contact['protocol']; + } + + 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, + 'result' => null + ]; + Hook::callAll('unfollow', $hook_data); + + return $hook_data['result']; + } + + /** + * Revoke an incoming follow from the provided contact + * + * @param array $contact Private contact (uid != 0) array + * @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): ?bool + { + if (empty($contact['network'])) { + throw new \InvalidArgumentException('Missing network key in contact array'); + } + + $protocol = $contact['network']; + if ($protocol == Protocol::DFRN && !empty($contact['protocol'])) { + $protocol = $contact['protocol']; + } + + if ($protocol == Protocol::ACTIVITYPUB) { + return ActivityPub\Transmitter::sendContactReject($contact['url'], $contact['hub-verify'], $contact['uid']); + } + + // Catch-all hook for connector addons + $hook_data = [ + 'contact' => $contact, + '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']; + } + + /** + * Send an unblock message to a remote server. Only useful for connector addons. + * + * @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 unblock(array $contact, int $uid): ?bool + { + // Catch-all hook for connector addons + $hook_data = [ + 'contact' => $contact, + 'uid' => $uid, + 'result' => null, + ]; + Hook::callAll('unblock', $hook_data); + + return $hook_data['result']; + } }