GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

[ActivityPub][AProfile] Complete strict typing

Browse Source
This commit is contained in:
Diogo Cordeiro 2020-07-21 23:21:27 +01:00 committed by Diogo Peralta Cordeiro
parent e902a9bdfc
commit 7022d85b93
1 changed files with 41 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
plugins/ActivityPub/classes/Activitypub_profile.php
View File

@ -84,7 +84,7 @@ class Activitypub_profile extends Managed_DataObject
* @throws Exception * @throws Exception
* @author Diogo Cordeiro <diogo@fc.up.pt> * @author Diogo Cordeiro <diogo@fc.up.pt>
*/ */
public static function profile_to_array($profile) public static function profile_to_array(Profile $profile): array
{ {
$uri = $profile->getUri(); $uri = $profile->getUri();
$id = $profile->getID(); $id = $profile->getID();
@ -145,7 +145,7 @@ class Activitypub_profile extends Managed_DataObject
* @author Diogo Cordeiro <diogo@fc.up.pt> * @author Diogo Cordeiro <diogo@fc.up.pt>
* @access public * @access public
*/ */
public function do_insert() public function do_insert(): void
{ {
// Does any other protocol have this remote entity we're about to add ? // Does any other protocol have this remote entity we're about to add ?
Event::handle('StartTFNLookup', [$this->uri, get_class($this), &$profile_id]); Event::handle('StartTFNLookup', [$this->uri, get_class($this), &$profile_id]);
@ -241,6 +241,12 @@ class Activitypub_profile extends Managed_DataObject
return $aprofile; return $aprofile;
} }
/**
* Travels an array of Profile and returns an array of Activitypub_profile
*
* @param array of Profile $profiles
* @return array of Activitypub_profile
*/
public static function from_profile_collection(array $profiles): array public static function from_profile_collection(array $profiles): array
{ {
$ap_profiles = []; $ap_profiles = [];
@ -268,7 +274,7 @@ class Activitypub_profile extends Managed_DataObject
* @throws Exception * @throws Exception
* @author Diogo Cordeiro <diogo@fc.up.pt> * @author Diogo Cordeiro <diogo@fc.up.pt>
*/ */
private static function create_from_local_profile(Profile $profile) private static function create_from_local_profile(Profile $profile): Activitypub_profile
{ {
$aprofile = new Activitypub_profile(); $aprofile = new Activitypub_profile();
@ -301,7 +307,7 @@ class Activitypub_profile extends Managed_DataObject
* @return string Inbox URL * @return string Inbox URL
* @author Diogo Cordeiro <diogo@fc.up.pt> * @author Diogo Cordeiro <diogo@fc.up.pt>
*/ */
public function get_inbox() public function get_inbox(): string
{ {
if (is_null($this->sharedInboxuri)) { if (is_null($this->sharedInboxuri)) {
return $this->inboxuri; return $this->inboxuri;
@ -316,7 +322,7 @@ class Activitypub_profile extends Managed_DataObject
* @return string URI * @return string URI
* @author Diogo Cordeiro <diogo@fc.up.pt> * @author Diogo Cordeiro <diogo@fc.up.pt>
*/ */
public function getUri() public function getUri(): string
{ {
return $this->uri; return $this->uri;
} }
@ -327,7 +333,7 @@ class Activitypub_profile extends Managed_DataObject
* @return string URL * @return string URL
* @author Diogo Cordeiro <diogo@fc.up.pt> * @author Diogo Cordeiro <diogo@fc.up.pt>
*/ */
public function getUrl() public function getUrl(): string
{ {
return $this->getUri(); return $this->getUri();
} }
@ -338,7 +344,7 @@ class Activitypub_profile extends Managed_DataObject
* @return int * @return int
* @author Diogo Cordeiro <diogo@fc.up.pt> * @author Diogo Cordeiro <diogo@fc.up.pt>
*/ */
public function getID() public function getID(): int
{ {
return $this->profile_id; return $this->profile_id;
} }
@ -352,7 +358,7 @@ class Activitypub_profile extends Managed_DataObject
* @throws Exception if it isn't possible to return an Activitypub_profile * @throws Exception if it isn't possible to return an Activitypub_profile
* @author Diogo Cordeiro <diogo@fc.up.pt> * @author Diogo Cordeiro <diogo@fc.up.pt>
*/ */
public static function fromUri($url, $grab_online = true) public static function fromUri(string $url, bool $grab_online = true): Activitypub_profile
{ {
try { try {
return self::from_profile(Activitypub_explorer::get_profile_from_url($url, $grab_online)); return self::from_profile(Activitypub_explorer::get_profile_from_url($url, $grab_online));
@ -373,7 +379,7 @@ class Activitypub_profile extends Managed_DataObject
* @author Diogo Cordeiro <diogo@fc.up.pt> * @author Diogo Cordeiro <diogo@fc.up.pt>
* @author GNU social * @author GNU social
*/ */
public static function ensure_webfinger($addr) public static function ensure_webfinger(string $addr): Activitypub_profile
{ {
// Normalize $addr, i.e. add 'acct:' if missing // Normalize $addr, i.e. add 'acct:' if missing
$addr = Discovery::normalize($addr); $addr = Discovery::normalize($addr);
@ -542,7 +548,7 @@ class Activitypub_profile extends Managed_DataObject
* @throws Exception (if the update fails) * @throws Exception (if the update fails)
* @author Bruno Casteleiro <brunoccast@fc.up.pt> * @author Bruno Casteleiro <brunoccast@fc.up.pt>
*/ */
public function updateUri(string $uri) public function updateUri(string $uri): void
{ {
$orig = clone($this); $orig = clone($this);
$this->uri = $uri; $this->uri = $uri;
@ -617,7 +623,14 @@ class Activitypub_profile extends Managed_DataObject
return $cnt; return $cnt;
} }
public static function updateSubscriberCount(Profile $profile, $adder) /**
* Increment or decrement subscriber count
*
* @param Profile $profile
* @param $adder
* @author Bruno Casteleiro <brunoccast@fc.up.pt>
*/
public static function updateSubscriberCount(Profile $profile, $adder): void
{ {
$cnt = self::cacheGet(sprintf('activitypub_profile:subscriberCount:%d', $profile->id)); $cnt = self::cacheGet(sprintf('activitypub_profile:subscriberCount:%d', $profile->id));
@ -626,7 +639,14 @@ class Activitypub_profile extends Managed_DataObject
} }
} }
public static function updateSubscriptionCount(Profile $profile, $adder) /**
* Increment or decrement subscription count
*
* @param Profile $profile
* @param $adder
* @author Bruno Casteleiro <brunoccast@fc.up.pt>
*/
public static function updateSubscriptionCount(Profile $profile, $adder): void
{ {
$cnt = self::cacheGet(sprintf('activitypub_profile:subscriptionCount:%d', $profile->id)); $cnt = self::cacheGet(sprintf('activitypub_profile:subscriptionCount:%d', $profile->id));
@ -640,12 +660,14 @@ class Activitypub_profile extends Managed_DataObject
* given local profile * given local profile
* *
* @param Profile $profile profile object * @param Profile $profile profile object
* @param int $offset index of the starting row to fetch from * @param int $offset [optional] index of the starting row to fetch from
* @param int $limit maximum number of rows allowed for fetching * @param int|null $limit [optional] maximum number of rows allowed for fetching. If it is omitted,
* then the sequence will have everything
* from offset up until the end.
* @return array subscriber profile objects * @return array subscriber profile objects
* @author Bruno Casteleiro <brunoccast@fc.up.pt> * @author Bruno Casteleiro <brunoccast@fc.up.pt>
*/ */
public static function getSubscribers(Profile $profile, $offset = 0, $limit = null): array public static function getSubscribers(Profile $profile, int $offset = 0, ?int $limit = null): array
{ {
$cache = false; $cache = false;
if ($offset + $limit <= Subscription::CACHE_WINDOW) { if ($offset + $limit <= Subscription::CACHE_WINDOW) {
@ -683,11 +705,11 @@ class Activitypub_profile extends Managed_DataObject
* *
* @param Profile $profile profile object * @param Profile $profile profile object
* @param int $offset index of the starting row to fetch from * @param int $offset index of the starting row to fetch from
* @param int $limit maximum number of rows allowed for fetching * @param int|null $limit maximum number of rows allowed for fetching
* @return array subscribed profile objects * @return array subscribed profile objects
* @author Bruno Casteleiro <brunoccast@fc.up.pt> * @author Bruno Casteleiro <brunoccast@fc.up.pt>
*/ */
public static function getSubscribed(Profile $profile, $offset = 0, $limit = null): array public static function getSubscribed(Profile $profile, int $offset = 0, ?int $limit = null): array
{ {
$cache = false; $cache = false;
if ($offset + $limit <= Subscription::CACHE_WINDOW) { if ($offset + $limit <= Subscription::CACHE_WINDOW) {
@ -733,7 +755,7 @@ class Activitypub_profile extends Managed_DataObject
* @throws Exception * @throws Exception
* @author Bruno Casteleiro <brunoccast@fc.up.pt> * @author Bruno Casteleiro <brunoccast@fc.up.pt>
*/ */
public static function subscribeCacheUpdate(Profile $actor, Profile $other) public static function subscribeCacheUpdate(Profile $actor, Profile $other): void
{ {
self::blow('activitypub_profile:subscribedCollection:%d', $actor->getID()); self::blow('activitypub_profile:subscribedCollection:%d', $actor->getID());
self::blow('activitypub_profile:subscriberCollection:%d', $other->id); self::blow('activitypub_profile:subscriberCollection:%d', $other->id);
@ -751,7 +773,7 @@ class Activitypub_profile extends Managed_DataObject
* @throws Exception * @throws Exception
* @author Bruno Casteleiro <brunoccast@fc.up.pt> * @author Bruno Casteleiro <brunoccast@fc.up.pt>
*/ */
public static function unsubscribeCacheUpdate(Profile $actor, Profile $other) public static function unsubscribeCacheUpdate(Profile $actor, Profile $other): void
{ {
self::blow('activitypub_profile:subscribedCollection:%d', $actor->getID()); self::blow('activitypub_profile:subscribedCollection:%d', $actor->getID());
self::blow('activitypub_profile:subscriberCollection:%d', $other->id); self::blow('activitypub_profile:subscriberCollection:%d', $other->id);