classes/Subscription.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 if (!defined('GNUSOCIAL')) { exit(1); }
  21
  22 /**
  23  * Table Definition for subscription
  24  */
  25 class Subscription extends Managed_DataObject
  26 {
  27     const CACHE_WINDOW = 201;
  28     const FORCE = true;
  29
  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
  40
  41     public static function schemaDef()
  42     {
  43         return array(
  44             'fields' => array(
  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'),
  54             ),
  55             'primary key' => array('subscriber', 'subscribed'),
  56             'unique keys' => array(
  57                 'subscription_uri_key' => array('uri'),
  58             ),
  59             'indexes' => array(
  60                 'subscription_subscriber_idx' => array('subscriber', 'created'),
  61                 'subscription_subscribed_idx' => array('subscribed', 'created'),
  62                 'subscription_token_idx' => array('token'),
  63             ),
  64         );
  65     }
  66
  67     /**
  68      * Make a new subscription
  69      *
  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
  73      *
  74      * @return mixed Subscription or Subscription_queue: new subscription info
  75      */
  76
  77     static function start(Profile $subscriber, Profile $other, $force=false)
  78     {
  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.'));
  82         }
  83
  84         if (self::exists($subscriber, $other)) {
  85             // TRANS: Exception thrown when trying to subscribe while already subscribed.
  86             throw new AlreadyFulfilledException(_('Already subscribed!'));
  87         }
  88
  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.'));
  92         }
  93
  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) {
  97                 $sub = Subscription_queue::saveNew($subscriber, $other);
  98                 $sub->notify();
  99             } else {
 100                 $sub = self::saveNew($subscriber->id, $other->id);
 101                 $sub->notify();
 102
 103                 self::blow('user:notices_with_friends:%d', $subscriber->id);
 104
 105                 self::blow('subscription:by-subscriber:'.$subscriber->id);
 106                 self::blow('subscription:by-subscribed:'.$other->id);
 107
 108                 $subscriber->blowSubscriptionCount();
 109                 $other->blowSubscriberCount();
 110
 111                 if ($otherUser instanceof User &&
 112                     $otherUser->autosubscribe &&
 113                     !self::exists($other, $subscriber) &&
 114                     !$subscriber->hasBlocked($other)) {
 115
 116                     try {
 117                         self::start($other, $subscriber);
 118                     } catch (AlreadyFulfilledException $e) {
 119                         // This shouldn't happen due to !self::exists above
 120                         common_debug('Tried to autosubscribe a user to its new subscriber.');
 121                     } catch (Exception $e) {
 122                         common_log(LOG_ERR, "Exception during autosubscribe of {$other->nickname} to profile {$subscriber->id}: {$e->getMessage()}");
 123                     }
 124                 }
 125             }
 126
 127             if ($sub instanceof Subscription) { // i.e. not SubscriptionQueue
 128                 Event::handle('EndSubscribe', array($subscriber, $other));
 129             }
 130         }
 131
 132         return $sub;
 133     }
 134
 135     /**
 136      * Low-level subscription save.
 137      * Outside callers should use Subscription::start()
 138      */
 139     protected function saveNew($subscriber_id, $other_id)
 140     {
 141         $sub = new Subscription();
 142
 143         $sub->subscriber = $subscriber_id;
 144         $sub->subscribed = $other_id;
 145         $sub->jabber     = 1;
 146         $sub->sms        = 1;
 147         $sub->created    = common_sql_now();
 148         $sub->uri        = self::newURI($sub->subscriber,
 149                                         $sub->subscribed,
 150                                         $sub->created);
 151
 152         $result = $sub->insert();
 153
 154         if ($result===false) {
 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.'));
 158         }
 159
 160         return $sub;
 161     }
 162
 163     function notify()
 164     {
 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
 168
 169         $this->notifyEmail();
 170     }
 171
 172     function notifyEmail()
 173     {
 174         $subscribedUser = User::getKV('id', $this->subscribed);
 175
 176         if ($subscribedUser instanceof User) {
 177
 178             $subscriber = Profile::getKV('id', $this->subscriber);
 179
 180             mail_subscribe_notify_profile($subscribedUser, $subscriber);
 181         }
 182     }
 183
 184     /**
 185      * Cancel a subscription
 186      *
 187      */
 188     static function cancel(Profile $subscriber, Profile $other)
 189     {
 190         if (!self::exists($subscriber, $other)) {
 191             // TRANS: Exception thrown when trying to unsibscribe without a subscription.
 192             throw new AlreadyFulfilledException(_('Not subscribed!'));
 193         }
 194
 195         // Don't allow deleting self subs
 196
 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.'));
 200         }
 201
 202         if (Event::handle('StartUnsubscribe', array($subscriber, $other))) {
 203
 204             $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
 205                                                'subscribed' => $other->id));
 206
 207             // note we checked for existence above
 208
 209             assert(!empty($sub));
 210
 211             $result = $sub->delete();
 212
 213             if (!$result) {
 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.'));
 217             }
 218
 219             self::blow('user:notices_with_friends:%d', $subscriber->id);
 220
 221             self::blow('subscription:by-subscriber:'.$subscriber->id);
 222             self::blow('subscription:by-subscribed:'.$other->id);
 223
 224             $subscriber->blowSubscriptionCount();
 225             $other->blowSubscriberCount();
 226
 227             Event::handle('EndUnsubscribe', array($subscriber, $other));
 228         }
 229
 230         return;
 231     }
 232
 233     static function exists(Profile $subscriber, Profile $other)
 234     {
 235         $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
 236                                            'subscribed' => $other->id));
 237         return ($sub instanceof Subscription);
 238     }
 239
 240     function asActivity()
 241     {
 242         $subscriber = Profile::getKV('id', $this->subscriber);
 243         $subscribed = Profile::getKV('id', $this->subscribed);
 244
 245         if (!$subscriber instanceof Profile) {
 246             throw new NoProfileException($this->subscriber);
 247         }
 248
 249         if (!$subscribed instanceof Profile) {
 250             throw new NoProfileException($this->subscribed);
 251         }
 252
 253         $act = new Activity();
 254
 255         $act->verb = ActivityVerb::FOLLOW;
 256
 257         // XXX: rationalize this with the URL
 258
 259         $act->id   = $this->getURI();
 260
 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());
 269
 270         $act->actor     = $subscriber->asActivityObject();
 271         $act->objects[] = $subscribed->asActivityObject();
 272
 273         $url = common_local_url('AtomPubShowSubscription',
 274                                 array('subscriber' => $subscriber->id,
 275                                       'subscribed' => $subscribed->id));
 276
 277         $act->selfLink = $url;
 278         $act->editLink = $url;
 279
 280         return $act;
 281     }
 282
 283     /**
 284      * Stream of subscriptions with the same subscriber
 285      *
 286      * Useful for showing pages that list subscriptions in reverse
 287      * chronological order. Has offset & limit to make paging
 288      * easy.
 289      *
 290      * @param integer $profile_id   ID of the subscriber profile
 291      * @param integer $offset       Offset from latest
 292      * @param integer $limit        Maximum number to fetch
 293      *
 294      * @return Subscription stream of subscriptions; use fetch() to iterate
 295      */
 296     public static function bySubscriber($profile_id, $offset = 0, $limit = PROFILES_PER_PAGE)
 297     {
 298         // "by subscriber" means it is the list of subscribed users we want
 299         $ids = self::getSubscribedIDs($profile_id, $offset, $limit);
 300         return Subscription::listFind('subscribed', $ids);
 301     }
 302
 303     /**
 304      * Stream of subscriptions with the same subscriber
 305      *
 306      * Useful for showing pages that list subscriptions in reverse
 307      * chronological order. Has offset & limit to make paging
 308      * easy.
 309      *
 310      * @param integer $profile_id   ID of the subscribed profile
 311      * @param integer $offset       Offset from latest
 312      * @param integer $limit        Maximum number to fetch
 313      *
 314      * @return Subscription stream of subscriptions; use fetch() to iterate
 315      */
 316     public static function bySubscribed($profile_id, $offset = 0, $limit = PROFILES_PER_PAGE)
 317     {
 318         // "by subscribed" means it is the list of subscribers we want
 319         $ids = self::getSubscriberIDs($profile_id, $offset, $limit);
 320         return Subscription::listFind('subscriber', $ids);
 321     }
 322
 323
 324     // The following are helper functions to the subscription lists,
 325     // notably the public ones get used in places such as Profile
 326     public static function getSubscribedIDs($profile_id, $offset, $limit) {
 327         return self::getSubscriptionIDs('subscribed', $profile_id, $offset, $limit);
 328     }
 329
 330     public static function getSubscriberIDs($profile_id, $offset, $limit) {
 331         return self::getSubscriptionIDs('subscriber', $profile_id, $offset, $limit);
 332     }
 333
 334     private static function getSubscriptionIDs($get_type, $profile_id, $offset, $limit)
 335     {
 336         switch ($get_type) {
 337         case 'subscribed':
 338             $by_type  = 'subscriber';
 339             break;
 340         case 'subscriber':
 341             $by_type  = 'subscribed';
 342             break;
 343         default:
 344             throw new Exception('Bad type argument to getSubscriptionIDs');
 345         }
 346
 347         $cacheKey = 'subscription:by-'.$by_type.':'.$profile_id;
 348
 349         $queryoffset = $offset;
 350         $querylimit = $limit;
 351
 352         if ($offset + $limit <= self::CACHE_WINDOW) {
 353             // Oh, it seems it should be cached
 354             $ids = self::cacheGet($cacheKey);
 355             if (is_array($ids)) {
 356                 return array_slice($ids, $offset, $limit);
 357             }
 358             // Being here indicates we didn't find anything cached
 359             // so we'll have to fill it up simultaneously
 360             $queryoffset = 0;
 361             $querylimit  = self::CACHE_WINDOW;
 362         }
 363
 364         $sub = new Subscription();
 365         $sub->$by_type = $profile_id;
 366         $sub->selectAdd($get_type);
 367         $sub->whereAdd("{$get_type} != {$profile_id}");
 368         $sub->orderBy('created DESC');
 369         $sub->limit($queryoffset, $querylimit);
 370
 371         if (!$sub->find()) {
 372             return array();
 373         }
 374
 375         $ids = $sub->fetchAll($get_type);
 376
 377         // If we're simultaneously filling up cache, remember to slice
 378         if ($queryoffset === 0 && $querylimit === self::CACHE_WINDOW) {
 379             self::cacheSet($cacheKey, $ids);
 380             return array_slice($ids, $offset, $limit);
 381         }
 382
 383         return $ids;
 384     }
 385
 386     /**
 387      * Flush cached subscriptions when subscription is updated
 388      *
 389      * Because we cache subscriptions, it's useful to flush them
 390      * here.
 391      *
 392      * @param mixed $dataObject Original version of object
 393      *
 394      * @return boolean success flag.
 395      */
 396     function update($dataObject=false)
 397     {
 398         self::blow('subscription:by-subscriber:'.$this->subscriber);
 399         self::blow('subscription:by-subscribed:'.$this->subscribed);
 400
 401         return parent::update($dataObject);
 402     }
 403
 404     function getURI()
 405     {
 406         if (!empty($this->uri)) {
 407             return $this->uri;
 408         } else {
 409             return self::newURI($this->subscriber, $this->subscribed, $this->created);
 410         }
 411     }
 412
 413     static function newURI($subscriber_id, $subscribed_id, $created)
 414     {
 415         return TagURI::mint('follow:%d:%d:%s',
 416                             $subscriber_id,
 417                             $subscribed_id,
 418                             common_date_iso8601($created));
 419     }
 420 }