From 63306081bc164fcf57abd7f0996767626fd1e501 Mon Sep 17 00:00:00 2001 From: Mikael Nordfeldth Date: Sat, 21 Sep 2013 18:26:58 +0200 Subject: [PATCH] Subscription "get by" functions now don't use ArrayWrappers They were getting in the way of some strict-typing stuff. --- actions/apiuserfriends.php | 2 +- actions/subscriptions.php | 2 +- classes/Profile.php | 36 +---- classes/Subscription.php | 157 ++++++++++------------ classes/User.php | 4 +- lib/command.php | 2 +- lib/profileaction.php | 2 +- plugins/OStatus/scripts/updateostatus.php | 2 +- scripts/createsim.php | 2 +- 9 files changed, 85 insertions(+), 124 deletions(-) diff --git a/actions/apiuserfriends.php b/actions/apiuserfriends.php index be6ccba273..2508f49c98 100644 --- a/actions/apiuserfriends.php +++ b/actions/apiuserfriends.php @@ -65,7 +65,7 @@ class ApiUserFriendsAction extends ApiSubscriptionsAction $this->tag, $offset, $limit ); } else { - $subs = $this->user->getSubscriptions( + $subs = $this->user->getSubscribed( $offset, $limit ); diff --git a/actions/subscriptions.php b/actions/subscriptions.php index e4cb123912..56892243b6 100644 --- a/actions/subscriptions.php +++ b/actions/subscriptions.php @@ -95,7 +95,7 @@ class SubscriptionsAction extends GalleryAction if ($this->tag) { $subscriptions = $this->user->getTaggedSubscriptions($this->tag, $offset, $limit); } else { - $subscriptions = $this->user->getSubscriptions($offset, $limit); + $subscriptions = $this->user->getSubscribed($offset, $limit); } if ($subscriptions) { diff --git a/classes/Profile.php b/classes/Profile.php index f4ac30cb03..8a7f7c1ff8 100644 --- a/classes/Profile.php +++ b/classes/Profile.php @@ -646,40 +646,18 @@ class Profile extends Managed_DataObject } } - function getSubscriptions($offset=0, $limit=null) + function getSubscribed($offset=0, $limit=null) { - $subs = Subscription::bySubscriber($this->id, - $offset, - $limit); - - $profiles = array(); - - while ($subs->fetch()) { - $profile = Profile::getKV($subs->subscribed); - if ($profile) { - $profiles[] = $profile; - } - } - - return new ArrayWrapper($profiles); + $subs = Subscription::getSubscribedIDs($this->id, $offset, $limit); + $profiles = Profile::listFind('id', $subs); + return $profiles; } function getSubscribers($offset=0, $limit=null) { - $subs = Subscription::bySubscribed($this->id, - $offset, - $limit); - - $profiles = array(); - - while ($subs->fetch()) { - $profile = Profile::getKV($subs->subscriber); - if ($profile) { - $profiles[] = $profile; - } - } - - return new ArrayWrapper($profiles); + $subs = Subscription::getSubscriberIDs($this->id, $offset, $limit); + $profiles = Profile::listFind('id', $subs); + return $profiles; } function getTaggedSubscribers($tag) diff --git a/classes/Subscription.php b/classes/Subscription.php index 3f1819a841..a9ffe8913e 100644 --- a/classes/Subscription.php +++ b/classes/Subscription.php @@ -287,117 +287,100 @@ class Subscription extends Managed_DataObject * chronological order. Has offset & limit to make paging * easy. * - * @param integer $subscriberId Profile ID of the subscriber + * @param integer $profile_id ID of the subscriber profile * @param integer $offset Offset from latest * @param integer $limit Maximum number to fetch * * @return Subscription stream of subscriptions; use fetch() to iterate */ - static function bySubscriber($subscriberId, - $offset = 0, - $limit = PROFILES_PER_PAGE) + public static function bySubscriber($profile_id, $offset = 0, $limit = PROFILES_PER_PAGE) { - if ($offset + $limit > self::CACHE_WINDOW) { - return new ArrayWrapper(self::realBySubscriber($subscriberId, - $offset, - $limit)); - } else { - $key = 'subscription:by-subscriber:'.$subscriberId; - $window = self::cacheGet($key); - if ($window === false) { - $window = self::realBySubscriber($subscriberId, - 0, - self::CACHE_WINDOW); - self::cacheSet($key, $window); - } - return new ArrayWrapper(array_slice($window, - $offset, - $limit)); - } - } - - private static function realBySubscriber($subscriberId, - $offset, - $limit) - { - $sub = new Subscription(); - - $sub->subscriber = $subscriberId; - - $sub->whereAdd('subscribed != ' . $subscriberId); - - $sub->orderBy('created DESC'); - $sub->limit($offset, $limit); - - $sub->find(); - - $subs = array(); - - while ($sub->fetch()) { - $subs[] = clone($sub); - } - - return $subs; + // "by subscriber" means it is the list of subscribed users we want + $ids = self::getSubscribedIDs($profile_id, $offset, $limit); + return Subscription::listFind('subscribed', $ids); } /** - * Stream of subscriptions with the same subscribed profile + * Stream of subscriptions with the same subscriber * - * Useful for showing pages that list subscribers in reverse + * Useful for showing pages that list subscriptions in reverse * chronological order. Has offset & limit to make paging * easy. * - * @param integer $subscribedId Profile ID of the subscribed + * @param integer $profile_id ID of the subscribed profile * @param integer $offset Offset from latest * @param integer $limit Maximum number to fetch * * @return Subscription stream of subscriptions; use fetch() to iterate */ - static function bySubscribed($subscribedId, - $offset = 0, - $limit = PROFILES_PER_PAGE) + public static function bySubscribed($profile_id, $offset = 0, $limit = PROFILES_PER_PAGE) { - if ($offset + $limit > self::CACHE_WINDOW) { - return new ArrayWrapper(self::realBySubscribed($subscribedId, - $offset, - $limit)); - } else { - $key = 'subscription:by-subscribed:'.$subscribedId; - $window = self::cacheGet($key); - if ($window === false) { - $window = self::realBySubscribed($subscribedId, - 0, - self::CACHE_WINDOW); - self::cacheSet($key, $window); - } - return new ArrayWrapper(array_slice($window, - $offset, - $limit)); - } + // "by subscribed" means it is the list of subscribers we want + $ids = self::getSubscriberIDs($profile_id, $offset, $limit); + return Subscription::listFind('subscriber', $ids); } - private static function realBySubscribed($subscribedId, - $offset, - $limit) + + // The following are helper functions to the subscription lists, + // notably the public ones get used in places such as Profile + public static function getSubscribedIDs($profile_id, $offset, $limit) { + return self::getSubscriptionIDs('subscribed', $profile_id, $offset, $limit); + } + + public static function getSubscriberIDs($profile_id, $offset, $limit) { + return self::getSubscriptionIDs('subscriber', $profile_id, $offset, $limit); + } + + private static function getSubscriptionIDs($get_type, $profile_id, $offset, $limit) { - $sub = new Subscription(); - - $sub->subscribed = $subscribedId; - - $sub->whereAdd('subscriber != ' . $subscribedId); - - $sub->orderBy('created DESC'); - $sub->limit($offset, $limit); - - $sub->find(); - - $subs = array(); - - while ($sub->fetch()) { - $subs[] = clone($sub); + switch ($get_type) { + case 'subscribed': + $by_type = 'subscriber'; + break; + case 'subscriber': + $by_type = 'subscribed'; + break; + default: + throw new Exception('Bad type argument to getSubscriptionIDs'); } - return $subs; + $cacheKey = 'subscription:by-'.$by_type.':'.$profile_id; + + $queryoffset = $offset; + $querylimit = $limit; + + if ($offset + $limit <= self::CACHE_WINDOW) { + // Oh, it seems it should be cached + $ids = self::cacheGet($cacheKey); + if (is_array($ids)) { + return array_slice($ids, $offset, $limit); + } + // Being here indicates we didn't find anything cached + // so we'll have to fill it up simultaneously + $queryoffset = 0; + $querylimit = self::CACHE_WINDOW; + } + + $sub = new Subscription(); + $sub->$by_type = $profile_id; + $sub->selectAdd($get_type); + $sub->whereAdd("{$get_type} != {$profile_id}"); + $sub->orderBy('created DESC'); + $sub->limit($queryoffset, $querylimit); + + if (!$sub->find()) { + return array(); + } + + $ids = $sub->fetchAll($get_type); + + // If we're simultaneously filling up cache, remember to slice + if ($offset === 0 && $querylimit === self::CACHE_WINDOW) { + self::cacheSet($cacheKey, $ids); + return array_slice($ids, $offset, $limit); + } + + return $ids; } /** diff --git a/classes/User.php b/classes/User.php index c3e1d29827..14ff66825a 100644 --- a/classes/User.php +++ b/classes/User.php @@ -701,10 +701,10 @@ class User extends Managed_DataObject return $profile->leaveGroup($group); } - function getSubscriptions($offset=0, $limit=null) + function getSubscribed($offset=0, $limit=null) { $profile = $this->getProfile(); - return $profile->getSubscriptions($offset, $limit); + return $profile->getSubscribed($offset, $limit); } function getSubscribers($offset=0, $limit=null) diff --git a/lib/command.php b/lib/command.php index 57708deaf8..6d0d7194f3 100644 --- a/lib/command.php +++ b/lib/command.php @@ -931,7 +931,7 @@ class SubscriptionsCommand extends Command { function handle($channel) { - $profile = $this->user->getSubscriptions(0); + $profile = $this->user->getSubscribed(0); $nicknames=array(); while ($profile->fetch()) { $nicknames[]=$profile->nickname; diff --git a/lib/profileaction.php b/lib/profileaction.php index 7197121815..1efa906067 100644 --- a/lib/profileaction.php +++ b/lib/profileaction.php @@ -125,7 +125,7 @@ class ProfileAction extends Action function showSubscriptions() { - $profile = $this->profile->getSubscriptions(0, PROFILES_PER_MINILIST + 1); + $profile = $this->profile->getSubscribed(0, PROFILES_PER_MINILIST + 1); $this->elementStart('div', array('id' => 'entity_subscriptions', 'class' => 'section')); diff --git a/plugins/OStatus/scripts/updateostatus.php b/plugins/OStatus/scripts/updateostatus.php index 5461eebe7d..e19b853aac 100644 --- a/plugins/OStatus/scripts/updateostatus.php +++ b/plugins/OStatus/scripts/updateostatus.php @@ -81,7 +81,7 @@ function updateOStatus($user) $up = $user->getProfile(); - $sp = $user->getSubscriptions(); + $sp = $up->getSubscribed(); $rps = array(); diff --git a/scripts/createsim.php b/scripts/createsim.php index 78bc5a1f89..e0ad74c49e 100644 --- a/scripts/createsim.php +++ b/scripts/createsim.php @@ -118,7 +118,7 @@ function newNotice($i, $tagmax) $is_directed = rand(0, 4); if ($is_directed == 0) { - $subs = $user->getSubscriptions(0, 100)->fetchAll(); + $subs = $user->getSubscribed(0, 100)->fetchAll(); if (count($subs) > 0) { $seen = array(); $f = rand(0, 9);