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('STATUSNET') && !defined('LACONICA')) { exit(1); }
23 * Table Definition for subscription
25 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
27 class Subscription extends Managed_DataObject
29 const CACHE_WINDOW = 201;
33 /* the code below is auto generated do not remove the above tag */
35 public $__table = 'subscription'; // table name
36 public $subscriber; // int(4) primary_key not_null
37 public $subscribed; // int(4) primary_key not_null
38 public $jabber; // tinyint(1) default_1
39 public $sms; // tinyint(1) default_1
40 public $token; // varchar(255)
41 public $secret; // varchar(255)
42 public $uri; // varchar(255)
43 public $created; // datetime() not_null
44 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
46 public static function schemaDef()
50 'subscriber' => array('type' => 'int', 'not null' => true, 'description' => 'profile listening'),
51 'subscribed' => array('type' => 'int', 'not null' => true, 'description' => 'profile being listened to'),
52 'jabber' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'deliver jabber messages'),
53 'sms' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'deliver sms messages'),
54 'token' => array('type' => 'varchar', 'length' => 255, 'description' => 'authorization token'),
55 'secret' => array('type' => 'varchar', 'length' => 255, 'description' => 'token secret'),
56 'uri' => array('type' => 'varchar', 'length' => 255, 'description' => 'universally unique identifier'),
57 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
58 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
60 'primary key' => array('subscriber', 'subscribed'),
61 'unique keys' => array(
62 'subscription_uri_key' => array('uri'),
65 'subscription_subscriber_idx' => array('subscriber', 'created'),
66 'subscription_subscribed_idx' => array('subscribed', 'created'),
67 'subscription_token_idx' => array('token'),
73 * Make a new subscription
75 * @param Profile $subscriber party to receive new notices
76 * @param Profile $other party sending notices; publisher
77 * @param bool $force pass Subscription::FORCE to override local subscription approval
79 * @return mixed Subscription or Subscription_queue: new subscription info
82 static function start(Profile $subscriber, Profile $other, $force=false)
84 if (!$subscriber->hasRight(Right::SUBSCRIBE)) {
85 // TRANS: Exception thrown when trying to subscribe while being banned from subscribing.
86 throw new Exception(_('You have been banned from subscribing.'));
89 if (self::exists($subscriber, $other)) {
90 // TRANS: Exception thrown when trying to subscribe while already subscribed.
91 throw new Exception(_('Already subscribed!'));
94 if ($other->hasBlocked($subscriber)) {
95 // TRANS: Exception thrown when trying to subscribe to a user who has blocked the subscribing user.
96 throw new Exception(_('User has blocked you.'));
99 if (Event::handle('StartSubscribe', array($subscriber, $other))) {
100 $otherUser = User::getKV('id', $other->id);
101 if ($otherUser && $otherUser->subscribe_policy == User::SUBSCRIBE_POLICY_MODERATE && !$force) {
102 $sub = Subscription_queue::saveNew($subscriber, $other);
105 $sub = self::saveNew($subscriber->id, $other->id);
108 self::blow('user:notices_with_friends:%d', $subscriber->id);
110 self::blow('subscription:by-subscriber:'.$subscriber->id);
111 self::blow('subscription:by-subscribed:'.$other->id);
113 $subscriber->blowSubscriptionCount();
114 $other->blowSubscriberCount();
116 if (!empty($otherUser) &&
117 $otherUser->autosubscribe &&
118 !self::exists($other, $subscriber) &&
119 !$subscriber->hasBlocked($other)) {
122 self::start($other, $subscriber);
123 } catch (Exception $e) {
124 common_log(LOG_ERR, "Exception during autosubscribe of {$other->nickname} to profile {$subscriber->id}: {$e->getMessage()}");
129 Event::handle('EndSubscribe', array($subscriber, $other));
136 * Low-level subscription save.
137 * Outside callers should use Subscription::start()
139 protected function saveNew($subscriber_id, $other_id)
141 $sub = new Subscription();
143 $sub->subscriber = $subscriber_id;
144 $sub->subscribed = $other_id;
147 $sub->created = common_sql_now();
148 $sub->uri = self::newURI($sub->subscriber,
152 $result = $sub->insert();
155 common_log_db_error($sub, 'INSERT', __FILE__);
156 // TRANS: Exception thrown when a subscription could not be stored on the server.
157 throw new Exception(_('Could not save subscription.'));
165 // XXX: add other notifications (Jabber, SMS) here
166 // XXX: queue this and handle it offline
167 // XXX: Whatever happens, do it in Twitter-like API, too
169 $this->notifyEmail();
172 function notifyEmail()
174 $subscribedUser = User::getKV('id', $this->subscribed);
176 if (!empty($subscribedUser)) {
178 $subscriber = Profile::getKV('id', $this->subscriber);
180 mail_subscribe_notify_profile($subscribedUser, $subscriber);
185 * Cancel a subscription
188 static function cancel(Profile $subscriber, Profile $other)
190 if (!self::exists($subscriber, $other)) {
191 // TRANS: Exception thrown when trying to unsibscribe without a subscription.
192 throw new Exception(_('Not subscribed!'));
195 // Don't allow deleting self subs
197 if ($subscriber->id == $other->id) {
198 // TRANS: Exception thrown when trying to unsubscribe a user from themselves.
199 throw new Exception(_('Could not delete self-subscription.'));
202 if (Event::handle('StartUnsubscribe', array($subscriber, $other))) {
204 $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
205 'subscribed' => $other->id));
207 // note we checked for existence above
209 assert(!empty($sub));
211 $result = $sub->delete();
214 common_log_db_error($sub, 'DELETE', __FILE__);
215 // TRANS: Exception thrown when a subscription could not be deleted on the server.
216 throw new Exception(_('Could not delete subscription.'));
219 self::blow('user:notices_with_friends:%d', $subscriber->id);
221 self::blow('subscription:by-subscriber:'.$subscriber->id);
222 self::blow('subscription:by-subscribed:'.$other->id);
224 $subscriber->blowSubscriptionCount();
225 $other->blowSubscriberCount();
227 Event::handle('EndUnsubscribe', array($subscriber, $other));
233 static function exists(Profile $subscriber, Profile $other)
235 $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
236 'subscribed' => $other->id));
237 return (empty($sub)) ? false : true;
240 function asActivity()
242 $subscriber = Profile::getKV('id', $this->subscriber);
243 $subscribed = Profile::getKV('id', $this->subscribed);
245 if (empty($subscriber)) {
246 throw new Exception(sprintf(_('No profile for the subscriber: %d'), $this->subscriber));
249 if (empty($subscribed)) {
250 throw new Exception(sprintf(_('No profile for the subscribed: %d'), $this->subscribed));
253 $act = new Activity();
255 $act->verb = ActivityVerb::FOLLOW;
257 // XXX: rationalize this with the URL
259 $act->id = $this->getURI();
261 $act->time = strtotime($this->created);
262 // TRANS: Activity title when subscribing to another person.
263 $act->title = _m('TITLE','Follow');
264 // TRANS: Notification given when one person starts following another.
265 // TRANS: %1$s is the subscriber, %2$s is the subscribed.
266 $act->content = sprintf(_('%1$s is now following %2$s.'),
267 $subscriber->getBestName(),
268 $subscribed->getBestName());
270 $act->actor = ActivityObject::fromProfile($subscriber);
271 $act->objects[] = ActivityObject::fromProfile($subscribed);
273 $url = common_local_url('AtomPubShowSubscription',
274 array('subscriber' => $subscriber->id,
275 'subscribed' => $subscribed->id));
277 $act->selfLink = $url;
278 $act->editLink = $url;
284 * Stream of subscriptions with the same subscriber
286 * Useful for showing pages that list subscriptions in reverse
287 * chronological order. Has offset & limit to make paging
290 * @param integer $subscriberId Profile ID of the subscriber
291 * @param integer $offset Offset from latest
292 * @param integer $limit Maximum number to fetch
294 * @return Subscription stream of subscriptions; use fetch() to iterate
296 static function bySubscriber($subscriberId,
298 $limit = PROFILES_PER_PAGE)
300 if ($offset + $limit > self::CACHE_WINDOW) {
301 return new ArrayWrapper(self::realBySubscriber($subscriberId,
305 $key = 'subscription:by-subscriber:'.$subscriberId;
306 $window = self::cacheGet($key);
307 if ($window === false) {
308 $window = self::realBySubscriber($subscriberId,
311 self::cacheSet($key, $window);
313 return new ArrayWrapper(array_slice($window,
319 private static function realBySubscriber($subscriberId,
323 $sub = new Subscription();
325 $sub->subscriber = $subscriberId;
327 $sub->whereAdd('subscribed != ' . $subscriberId);
329 $sub->orderBy('created DESC');
330 $sub->limit($offset, $limit);
336 while ($sub->fetch()) {
337 $subs[] = clone($sub);
344 * Stream of subscriptions with the same subscribed profile
346 * Useful for showing pages that list subscribers in reverse
347 * chronological order. Has offset & limit to make paging
350 * @param integer $subscribedId Profile ID of the subscribed
351 * @param integer $offset Offset from latest
352 * @param integer $limit Maximum number to fetch
354 * @return Subscription stream of subscriptions; use fetch() to iterate
356 static function bySubscribed($subscribedId,
358 $limit = PROFILES_PER_PAGE)
360 if ($offset + $limit > self::CACHE_WINDOW) {
361 return new ArrayWrapper(self::realBySubscribed($subscribedId,
365 $key = 'subscription:by-subscribed:'.$subscribedId;
366 $window = self::cacheGet($key);
367 if ($window === false) {
368 $window = self::realBySubscribed($subscribedId,
371 self::cacheSet($key, $window);
373 return new ArrayWrapper(array_slice($window,
379 private static function realBySubscribed($subscribedId,
383 $sub = new Subscription();
385 $sub->subscribed = $subscribedId;
387 $sub->whereAdd('subscriber != ' . $subscribedId);
389 $sub->orderBy('created DESC');
390 $sub->limit($offset, $limit);
396 while ($sub->fetch()) {
397 $subs[] = clone($sub);
404 * Flush cached subscriptions when subscription is updated
406 * Because we cache subscriptions, it's useful to flush them
409 * @param mixed $orig Original version of object
411 * @return boolean success flag.
413 function update($orig=null)
415 $result = parent::update($orig);
417 self::blow('subscription:by-subscriber:'.$this->subscriber);
418 self::blow('subscription:by-subscribed:'.$this->subscribed);
425 if (!empty($this->uri)) {
428 return self::newURI($this->subscriber, $this->subscribed, $this->created);
432 static function newURI($subscriber_id, $subscribed_id, $created)
434 return TagURI::mint('follow:%d:%d:%s',
437 common_date_iso8601($created));