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('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 /**
  23  * Table Definition for subscription
  24  */
  25 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
  26
  27 class Subscription extends Memcached_DataObject
  28 {
  29     ###START_AUTOCODE
  30     /* the code below is auto generated do not remove the above tag */
  31
  32     public $__table = 'subscription';                    // table name
  33     public $subscriber;                      // int(4)  primary_key not_null
  34     public $subscribed;                      // int(4)  primary_key not_null
  35     public $jabber;                          // tinyint(1)   default_1
  36     public $sms;                             // tinyint(1)   default_1
  37     public $token;                           // varchar(255)
  38     public $secret;                          // varchar(255)
  39     public $created;                         // datetime()   not_null
  40     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  41
  42     /* Static get */
  43     function staticGet($k,$v=null)
  44     { return Memcached_DataObject::staticGet('Subscription',$k,$v); }
  45
  46     /* the code above is auto generated do not remove the tag below */
  47     ###END_AUTOCODE
  48
  49     function pkeyGet($kv)
  50     {
  51         return Memcached_DataObject::pkeyGet('Subscription', $kv);
  52     }
  53
  54     /**
  55      * Make a new subscription
  56      *
  57      * @param Profile $subscriber party to receive new notices
  58      * @param Profile $other      party sending notices; publisher
  59      *
  60      * @return Subscription new subscription
  61      */
  62
  63     static function start($subscriber, $other)
  64     {
  65         if (!$subscriber->hasRight(Right::SUBSCRIBE)) {
  66             throw new Exception(_('You have been banned from subscribing.'));
  67         }
  68
  69         if (self::exists($subscriber, $other)) {
  70             throw new Exception(_('Already subscribed!'));
  71         }
  72
  73         if ($other->hasBlocked($subscriber)) {
  74             throw new Exception(_('User has blocked you.'));
  75         }
  76
  77         if (Event::handle('StartSubscribe', array($subscriber, $other))) {
  78             $sub = self::saveNew($subscriber->id, $other->id);
  79             $sub->notify();
  80
  81             self::blow('user:notices_with_friends:%d', $subscriber->id);
  82
  83             $subscriber->blowSubscriptionsCount();
  84             $other->blowSubscribersCount();
  85
  86             $otherUser = User::staticGet('id', $other->id);
  87
  88             if (!empty($otherUser) &&
  89                 $otherUser->autosubscribe &&
  90                 !self::exists($other, $subscriber) &&
  91                 !$subscriber->hasBlocked($other)) {
  92
  93                 try {
  94                     self::start($other, $subscriber);
  95                 } catch (Exception $e) {
  96                     common_log(LOG_ERR, "Exception during autosubscribe of {$other->nickname} to profile {$subscriber->id}: {$e->getMessage()}");
  97                 }
  98             }
  99
 100             Event::handle('EndSubscribe', array($subscriber, $other));
 101         }
 102
 103         return true;
 104     }
 105
 106     /**
 107      * Low-level subscription save.
 108      * Outside callers should use Subscription::start()
 109      */
 110     protected function saveNew($subscriber_id, $other_id)
 111     {
 112         $sub = new Subscription();
 113
 114         $sub->subscriber = $subscriber_id;
 115         $sub->subscribed = $other_id;
 116         $sub->jabber     = 1;
 117         $sub->sms        = 1;
 118         $sub->created    = common_sql_now();
 119
 120         $result = $sub->insert();
 121
 122         if (!$result) {
 123             common_log_db_error($sub, 'INSERT', __FILE__);
 124             throw new Exception(_('Could not save subscription.'));
 125         }
 126
 127         return $sub;
 128     }
 129
 130     function notify()
 131     {
 132         # XXX: add other notifications (Jabber, SMS) here
 133         # XXX: queue this and handle it offline
 134         # XXX: Whatever happens, do it in Twitter-like API, too
 135
 136         $this->notifyEmail();
 137     }
 138
 139     function notifyEmail()
 140     {
 141         $subscribedUser = User::staticGet('id', $this->subscribed);
 142
 143         if (!empty($subscribedUser)) {
 144
 145             $subscriber = Profile::staticGet('id', $this->subscriber);
 146
 147             mail_subscribe_notify_profile($subscribedUser, $subscriber);
 148         }
 149     }
 150
 151     /**
 152      * Cancel a subscription
 153      *
 154      */
 155
 156     function cancel($subscriber, $other)
 157     {
 158         if (!self::exists($subscriber, $other)) {
 159             throw new Exception(_('Not subscribed!'));
 160         }
 161
 162         // Don't allow deleting self subs
 163
 164         if ($subscriber->id == $other->id) {
 165             throw new Exception(_('Couldn\'t delete self-subscription.'));
 166         }
 167
 168         if (Event::handle('StartUnsubscribe', array($subscriber, $other))) {
 169
 170             $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
 171                                                'subscribed' => $other->id));
 172
 173             // note we checked for existence above
 174
 175             assert(!empty($sub));
 176
 177             // @todo: move this block to EndSubscribe handler for
 178             // OMB plugin when it exists.
 179
 180             if (!empty($sub->token)) {
 181
 182                 $token = new Token();
 183
 184                 $token->tok    = $sub->token;
 185
 186                 if ($token->find(true)) {
 187
 188                     $result = $token->delete();
 189
 190                     if (!$result) {
 191                         common_log_db_error($token, 'DELETE', __FILE__);
 192                         throw new Exception(_('Couldn\'t delete subscription OMB token.'));
 193                     }
 194                 } else {
 195                     common_log(LOG_ERR, "Couldn't find credentials with token {$token->tok}");
 196                 }
 197             }
 198
 199             $result = $sub->delete();
 200
 201             if (!$result) {
 202                 common_log_db_error($sub, 'DELETE', __FILE__);
 203                 throw new Exception(_('Couldn\'t delete subscription.'));
 204             }
 205
 206             self::blow('user:notices_with_friends:%d', $subscriber->id);
 207
 208             $subscriber->blowSubscriptionsCount();
 209             $other->blowSubscribersCount();
 210
 211             Event::handle('EndUnsubscribe', array($subscriber, $other));
 212         }
 213
 214         return;
 215     }
 216
 217     function exists($subscriber, $other)
 218     {
 219         $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
 220                                            'subscribed' => $other->id));
 221         return (empty($sub)) ? false : true;
 222     }
 223 }