3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 if (!defined('GNUSOCIAL')) { exit(1); }
23 * Table Definition for subscription
25 class Subscription extends Managed_DataObject
27 const CACHE_WINDOW = 201;
30 public $__table = 'subscription'; // table name
31 public $subscriber; // int(4) primary_key not_null
32 public $subscribed; // int(4) primary_key not_null
33 public $jabber; // tinyint(1) default_1
34 public $sms; // tinyint(1) default_1
35 public $token; // varchar(191) not 255 because utf8mb4 takes more space
36 public $secret; // varchar(191) not 255 because utf8mb4 takes more space
37 public $uri; // varchar(191) not 255 because utf8mb4 takes more space
38 public $created; // datetime() not_null
39 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
41 public static function schemaDef()
45 'subscriber' => array('type' => 'int', 'not null' => true, 'description' => 'profile listening'),
46 'subscribed' => array('type' => 'int', 'not null' => true, 'description' => 'profile being listened to'),
47 'jabber' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'deliver jabber messages'),
48 'sms' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'deliver sms messages'),
49 'token' => array('type' => 'varchar', 'length' => 191, 'description' => 'authorization token'),
50 'secret' => array('type' => 'varchar', 'length' => 191, 'description' => 'token secret'),
51 'uri' => array('type' => 'varchar', 'length' => 191, 'description' => 'universally unique identifier'),
52 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
53 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
55 'primary key' => array('subscriber', 'subscribed'),
56 'unique keys' => array(
57 'subscription_uri_key' => array('uri'),
60 'subscription_subscriber_idx' => array('subscriber', 'created'),
61 'subscription_subscribed_idx' => array('subscribed', 'created'),
62 'subscription_token_idx' => array('token'),
68 * Make a new subscription
70 * @param Profile $subscriber party to receive new notices
71 * @param Profile $other party sending notices; publisher
72 * @param bool $force pass Subscription::FORCE to override local subscription approval
74 * @return mixed Subscription or Subscription_queue: new subscription info
77 static function start(Profile $subscriber, Profile $other, $force=false)
79 if (!$subscriber->hasRight(Right::SUBSCRIBE)) {
80 // TRANS: Exception thrown when trying to subscribe while being banned from subscribing.
81 throw new Exception(_('You have been banned from subscribing.'));
84 if (self::exists($subscriber, $other)) {
85 // TRANS: Exception thrown when trying to subscribe while already subscribed.
86 throw new AlreadyFulfilledException(_('Already subscribed!'));
89 if ($other->hasBlocked($subscriber)) {
90 // TRANS: Exception thrown when trying to subscribe to a user who has blocked the subscribing user.
91 throw new Exception(_('User has blocked you.'));
94 if (Event::handle('StartSubscribe', array($subscriber, $other))) {
95 $otherUser = User::getKV('id', $other->id);
96 if ($otherUser instanceof User && $otherUser->subscribe_policy == User::SUBSCRIBE_POLICY_MODERATE && !$force) {
98 $sub = Subscription_queue::saveNew($subscriber, $other);
100 } catch (AlreadyFulfilledException $e) {
101 $sub = Subscription_queue::getSubQueue($subscriber, $other);
104 $sub = self::saveNew($subscriber, $other);
107 self::blow('user:notices_with_friends:%d', $subscriber->id);
109 self::blow('subscription:by-subscriber:'.$subscriber->id);
110 self::blow('subscription:by-subscribed:'.$other->id);
112 $subscriber->blowSubscriptionCount();
113 $other->blowSubscriberCount();
115 if ($otherUser instanceof User &&
116 $otherUser->autosubscribe &&
117 !self::exists($other, $subscriber) &&
118 !$subscriber->hasBlocked($other)) {
121 self::start($other, $subscriber);
122 } catch (AlreadyFulfilledException $e) {
123 // This shouldn't happen due to !self::exists above
124 common_debug('Tried to autosubscribe a user to its new subscriber.');
125 } catch (Exception $e) {
126 common_log(LOG_ERR, "Exception during autosubscribe of {$other->nickname} to profile {$subscriber->id}: {$e->getMessage()}");
131 if ($sub instanceof Subscription) { // i.e. not Subscription_queue
132 Event::handle('EndSubscribe', array($subscriber, $other));
139 static function ensureStart(Profile $subscriber, Profile $other, $force=false)
142 $sub = self::start($subscriber, $other, $force);
143 } catch (AlreadyFulfilledException $e) {
144 return self::getSubscription($subscriber, $other);
150 * Low-level subscription save.
151 * Outside callers should use Subscription::start()
153 protected static function saveNew(Profile $subscriber, Profile $other)
155 $sub = new Subscription();
157 $sub->subscriber = $subscriber->getID();
158 $sub->subscribed = $other->getID();
161 $sub->created = common_sql_now();
162 $sub->uri = self::newUri($subscriber,
166 $result = $sub->insert();
168 if ($result===false) {
169 common_log_db_error($sub, 'INSERT', __FILE__);
170 // TRANS: Exception thrown when a subscription could not be stored on the server.
171 throw new Exception(_('Could not save subscription.'));
179 // XXX: add other notifications (Jabber, SMS) here
180 // XXX: queue this and handle it offline
181 // XXX: Whatever happens, do it in Twitter-like API, too
183 $this->notifyEmail();
186 function notifyEmail()
188 $subscribedUser = User::getKV('id', $this->subscribed);
190 if ($subscribedUser instanceof User) {
192 $subscriber = Profile::getKV('id', $this->subscriber);
194 mail_subscribe_notify_profile($subscribedUser, $subscriber);
199 * Cancel a subscription
202 static function cancel(Profile $subscriber, Profile $other)
204 if (!self::exists($subscriber, $other)) {
205 // TRANS: Exception thrown when trying to unsibscribe without a subscription.
206 throw new AlreadyFulfilledException(_('Not subscribed!'));
209 // Don't allow deleting self subs
211 if ($subscriber->id == $other->id) {
212 // TRANS: Exception thrown when trying to unsubscribe a user from themselves.
213 throw new Exception(_('Could not delete self-subscription.'));
216 if (Event::handle('StartUnsubscribe', array($subscriber, $other))) {
218 $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
219 'subscribed' => $other->id));
221 // note we checked for existence above
223 assert(!empty($sub));
225 $result = $sub->delete();
228 common_log_db_error($sub, 'DELETE', __FILE__);
229 // TRANS: Exception thrown when a subscription could not be deleted on the server.
230 throw new Exception(_('Could not delete subscription.'));
233 self::blow('user:notices_with_friends:%d', $subscriber->id);
235 self::blow('subscription:by-subscriber:'.$subscriber->id);
236 self::blow('subscription:by-subscribed:'.$other->id);
238 $subscriber->blowSubscriptionCount();
239 $other->blowSubscriberCount();
241 Event::handle('EndUnsubscribe', array($subscriber, $other));
247 static function exists(Profile $subscriber, Profile $other)
250 $sub = self::getSubscription($subscriber, $other);
251 } catch (NoResultException $e) {
258 static function getSubscription(Profile $subscriber, Profile $other)
260 // This is essentially a pkeyGet but we have an object to return in NoResultException
261 $sub = new Subscription();
262 $sub->subscriber = $subscriber->id;
263 $sub->subscribed = $other->id;
264 if (!$sub->find(true)) {
265 throw new NoResultException($sub);
270 public function getSubscriber()
272 return Profile::getByID($this->subscriber);
275 public function getSubscribed()
277 return Profile::getByID($this->subscribed);
280 function asActivity()
282 $subscriber = $this->getSubscriber();
283 $subscribed = $this->getSubscribed();
285 $act = new Activity();
287 $act->verb = ActivityVerb::FOLLOW;
289 // XXX: rationalize this with the URL
291 $act->id = $this->getUri();
293 $act->time = strtotime($this->created);
294 // TRANS: Activity title when subscribing to another person.
295 $act->title = _m('TITLE','Follow');
296 // TRANS: Notification given when one person starts following another.
297 // TRANS: %1$s is the subscriber, %2$s is the subscribed.
298 $act->content = sprintf(_('%1$s is now following %2$s.'),
299 $subscriber->getBestName(),
300 $subscribed->getBestName());
302 $act->actor = $subscriber->asActivityObject();
303 $act->objects[] = $subscribed->asActivityObject();
305 $url = common_local_url('AtomPubShowSubscription',
306 array('subscriber' => $subscriber->id,
307 'subscribed' => $subscribed->id));
309 $act->selfLink = $url;
310 $act->editLink = $url;
316 * Stream of subscriptions with the same subscriber
318 * Useful for showing pages that list subscriptions in reverse
319 * chronological order. Has offset & limit to make paging
322 * @param integer $profile_id ID of the subscriber profile
323 * @param integer $offset Offset from latest
324 * @param integer $limit Maximum number to fetch
326 * @return Subscription stream of subscriptions; use fetch() to iterate
328 public static function bySubscriber($profile_id, $offset = 0, $limit = PROFILES_PER_PAGE)
330 // "by subscriber" means it is the list of subscribed users we want
331 $ids = self::getSubscribedIDs($profile_id, $offset, $limit);
332 return Subscription::listFind('subscribed', $ids);
336 * Stream of subscriptions with the same subscriber
338 * Useful for showing pages that list subscriptions in reverse
339 * chronological order. Has offset & limit to make paging
342 * @param integer $profile_id ID of the subscribed profile
343 * @param integer $offset Offset from latest
344 * @param integer $limit Maximum number to fetch
346 * @return Subscription stream of subscriptions; use fetch() to iterate
348 public static function bySubscribed($profile_id, $offset = 0, $limit = PROFILES_PER_PAGE)
350 // "by subscribed" means it is the list of subscribers we want
351 $ids = self::getSubscriberIDs($profile_id, $offset, $limit);
352 return Subscription::listFind('subscriber', $ids);
356 // The following are helper functions to the subscription lists,
357 // notably the public ones get used in places such as Profile
358 public static function getSubscribedIDs($profile_id, $offset, $limit) {
359 return self::getSubscriptionIDs('subscribed', $profile_id, $offset, $limit);
362 public static function getSubscriberIDs($profile_id, $offset, $limit) {
363 return self::getSubscriptionIDs('subscriber', $profile_id, $offset, $limit);
366 private static function getSubscriptionIDs($get_type, $profile_id, $offset, $limit)
370 $by_type = 'subscriber';
373 $by_type = 'subscribed';
376 throw new Exception('Bad type argument to getSubscriptionIDs');
379 $cacheKey = 'subscription:by-'.$by_type.':'.$profile_id;
381 $queryoffset = $offset;
382 $querylimit = $limit;
384 if ($offset + $limit <= self::CACHE_WINDOW) {
385 // Oh, it seems it should be cached
386 $ids = self::cacheGet($cacheKey);
387 if (is_array($ids)) {
388 return array_slice($ids, $offset, $limit);
390 // Being here indicates we didn't find anything cached
391 // so we'll have to fill it up simultaneously
393 $querylimit = self::CACHE_WINDOW;
396 $sub = new Subscription();
397 $sub->$by_type = $profile_id;
398 $sub->selectAdd($get_type);
399 $sub->whereAdd("{$get_type} != {$profile_id}");
400 $sub->orderBy('created DESC');
401 $sub->limit($queryoffset, $querylimit);
407 $ids = $sub->fetchAll($get_type);
409 // If we're simultaneously filling up cache, remember to slice
410 if ($queryoffset === 0 && $querylimit === self::CACHE_WINDOW) {
411 self::cacheSet($cacheKey, $ids);
412 return array_slice($ids, $offset, $limit);
419 * Flush cached subscriptions when subscription is updated
421 * Because we cache subscriptions, it's useful to flush them
424 * @param mixed $dataObject Original version of object
426 * @return boolean success flag.
428 function update($dataObject=false)
430 self::blow('subscription:by-subscriber:'.$this->subscriber);
431 self::blow('subscription:by-subscribed:'.$this->subscribed);
433 return parent::update($dataObject);
436 public function getUri()
438 return $this->uri ?: self::newUri($this->getSubscriber(), $this->getSubscribed(), $this->created);