]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - classes/Subscription.php
Merge remote-tracking branch 'origin/1.0.x' into 1.0.x
[quix0rs-gnu-social.git] / 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 Managed_DataObject
28 {
29     const CACHE_WINDOW = 201;
30     const FORCE = true;
31
32     ###START_AUTOCODE
33     /* the code below is auto generated do not remove the above tag */
34
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
45
46     public static function schemaDef()
47     {
48         return array(
49             'fields' => array(
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'),
59             ),
60             'primary key' => array('subscriber', 'subscribed'),
61             'unique keys' => array(
62                 'subscription_uri_key' => array('uri'),
63             ),
64             'indexes' => array(
65                 'subscription_subscriber_idx' => array('subscriber', 'created'),
66                 'subscription_subscribed_idx' => array('subscribed', 'created'),
67                 'subscription_token_idx' => array('token'),
68             ),
69         );
70     }    
71
72     /* Static get */
73     function staticGet($k,$v=null)
74     { return Memcached_DataObject::staticGet('Subscription',$k,$v); }
75
76     /* the code above is auto generated do not remove the tag below */
77     ###END_AUTOCODE
78
79     function pkeyGet($kv)
80     {
81         return Memcached_DataObject::pkeyGet('Subscription', $kv);
82     }
83
84     /**
85      * Make a new subscription
86      *
87      * @param Profile $subscriber party to receive new notices
88      * @param Profile $other      party sending notices; publisher
89      * @param bool    $force      pass Subscription::FORCE to override local subscription approval
90      *
91      * @return mixed Subscription or Subscription_queue: new subscription info
92      */
93
94     static function start($subscriber, $other, $force=false)
95     {
96         // @fixme should we enforce this as profiles in callers instead?
97         if ($subscriber instanceof User) {
98             $subscriber = $subscriber->getProfile();
99         }
100         if ($other instanceof User) {
101             $other = $other->getProfile();
102         }
103
104         if (!$subscriber->hasRight(Right::SUBSCRIBE)) {
105             // TRANS: Exception thrown when trying to subscribe while being banned from subscribing.
106             throw new Exception(_('You have been banned from subscribing.'));
107         }
108
109         if (self::exists($subscriber, $other)) {
110             // TRANS: Exception thrown when trying to subscribe while already subscribed.
111             throw new Exception(_('Already subscribed!'));
112         }
113
114         if ($other->hasBlocked($subscriber)) {
115             // TRANS: Exception thrown when trying to subscribe to a user who has blocked the subscribing user.
116             throw new Exception(_('User has blocked you.'));
117         }
118
119         if (Event::handle('StartSubscribe', array($subscriber, $other))) {
120             $otherUser = User::staticGet('id', $other->id);
121             if ($otherUser && $otherUser->subscribe_policy == User::SUBSCRIBE_POLICY_MODERATE && !$force) {
122                 $sub = Subscription_queue::saveNew($subscriber, $other);
123                 $sub->notify();
124             } else {
125                 $sub = self::saveNew($subscriber->id, $other->id);
126                 $sub->notify();
127
128                 self::blow('user:notices_with_friends:%d', $subscriber->id);
129
130                 self::blow('subscription:by-subscriber:'.$subscriber->id);
131                 self::blow('subscription:by-subscribed:'.$other->id);
132
133                 $subscriber->blowSubscriptionCount();
134                 $other->blowSubscriberCount();
135
136                 if (!empty($otherUser) &&
137                     $otherUser->autosubscribe &&
138                     !self::exists($other, $subscriber) &&
139                     !$subscriber->hasBlocked($other)) {
140
141                     try {
142                         self::start($other, $subscriber);
143                     } catch (Exception $e) {
144                         common_log(LOG_ERR, "Exception during autosubscribe of {$other->nickname} to profile {$subscriber->id}: {$e->getMessage()}");
145                     }
146                 }
147             }
148
149             Event::handle('EndSubscribe', array($subscriber, $other));
150         }
151
152         return $sub;
153     }
154
155     /**
156      * Low-level subscription save.
157      * Outside callers should use Subscription::start()
158      */
159     protected function saveNew($subscriber_id, $other_id)
160     {
161         $sub = new Subscription();
162
163         $sub->subscriber = $subscriber_id;
164         $sub->subscribed = $other_id;
165         $sub->jabber     = 1;
166         $sub->sms        = 1;
167         $sub->created    = common_sql_now();
168         $sub->uri        = self::newURI($sub->subscriber,
169                                         $sub->subscribed,
170                                         $sub->created);
171
172         $result = $sub->insert();
173
174         if (!$result) {
175             common_log_db_error($sub, 'INSERT', __FILE__);
176             // TRANS: Exception thrown when a subscription could not be stored on the server.
177             throw new Exception(_('Could not save subscription.'));
178         }
179
180         return $sub;
181     }
182
183     function notify()
184     {
185         // XXX: add other notifications (Jabber, SMS) here
186         // XXX: queue this and handle it offline
187         // XXX: Whatever happens, do it in Twitter-like API, too
188
189         $this->notifyEmail();
190     }
191
192     function notifyEmail()
193     {
194         $subscribedUser = User::staticGet('id', $this->subscribed);
195
196         if (!empty($subscribedUser)) {
197
198             $subscriber = Profile::staticGet('id', $this->subscriber);
199
200             mail_subscribe_notify_profile($subscribedUser, $subscriber);
201         }
202     }
203
204     /**
205      * Cancel a subscription
206      *
207      */
208     function cancel($subscriber, $other)
209     {
210         if (!self::exists($subscriber, $other)) {
211             // TRANS: Exception thrown when trying to unsibscribe without a subscription.
212             throw new Exception(_('Not subscribed!'));
213         }
214
215         // Don't allow deleting self subs
216
217         if ($subscriber->id == $other->id) {
218             // TRANS: Exception thrown when trying to unsubscribe a user from themselves.
219             throw new Exception(_('Could not delete self-subscription.'));
220         }
221
222         if (Event::handle('StartUnsubscribe', array($subscriber, $other))) {
223
224             $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
225                                                'subscribed' => $other->id));
226
227             // note we checked for existence above
228
229             assert(!empty($sub));
230
231             $result = $sub->delete();
232
233             if (!$result) {
234                 common_log_db_error($sub, 'DELETE', __FILE__);
235                 // TRANS: Exception thrown when a subscription could not be deleted on the server.
236                 throw new Exception(_('Could not delete subscription.'));
237             }
238
239             self::blow('user:notices_with_friends:%d', $subscriber->id);
240
241             self::blow('subscription:by-subscriber:'.$subscriber->id);
242             self::blow('subscription:by-subscribed:'.$other->id);
243
244             $subscriber->blowSubscriptionCount();
245             $other->blowSubscriberCount();
246
247             Event::handle('EndUnsubscribe', array($subscriber, $other));
248         }
249
250         return;
251     }
252
253     function exists($subscriber, $other)
254     {
255         $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
256                                            'subscribed' => $other->id));
257         return (empty($sub)) ? false : true;
258     }
259
260     function asActivity()
261     {
262         $subscriber = Profile::staticGet('id', $this->subscriber);
263         $subscribed = Profile::staticGet('id', $this->subscribed);
264
265         $act = new Activity();
266
267         $act->verb = ActivityVerb::FOLLOW;
268
269         // XXX: rationalize this with the URL
270
271         $act->id   = $this->getURI();
272
273         $act->time    = strtotime($this->created);
274         // TRANS: Activity title when subscribing to another person.
275         $act->title = _m('TITLE','Follow');
276         // TRANS: Notification given when one person starts following another.
277         // TRANS: %1$s is the subscriber, %2$s is the subscribed.
278         $act->content = sprintf(_('%1$s is now following %2$s.'),
279                                $subscriber->getBestName(),
280                                $subscribed->getBestName());
281
282         $act->actor     = ActivityObject::fromProfile($subscriber);
283         $act->objects[] = ActivityObject::fromProfile($subscribed);
284
285         $url = common_local_url('AtomPubShowSubscription',
286                                 array('subscriber' => $subscriber->id,
287                                       'subscribed' => $subscribed->id));
288
289         $act->selfLink = $url;
290         $act->editLink = $url;
291
292         return $act;
293     }
294
295     /**
296      * Stream of subscriptions with the same subscriber
297      *
298      * Useful for showing pages that list subscriptions in reverse
299      * chronological order. Has offset & limit to make paging
300      * easy.
301      *
302      * @param integer $subscriberId Profile ID of the subscriber
303      * @param integer $offset       Offset from latest
304      * @param integer $limit        Maximum number to fetch
305      *
306      * @return Subscription stream of subscriptions; use fetch() to iterate
307      */
308     static function bySubscriber($subscriberId,
309                                  $offset = 0,
310                                  $limit = PROFILES_PER_PAGE)
311     {
312         if ($offset + $limit > self::CACHE_WINDOW) {
313             return new ArrayWrapper(self::realBySubscriber($subscriberId,
314                                                            $offset,
315                                                            $limit));
316         } else {
317             $key = 'subscription:by-subscriber:'.$subscriberId;
318             $window = self::cacheGet($key);
319             if ($window === false) {
320                 $window = self::realBySubscriber($subscriberId,
321                                                  0,
322                                                  self::CACHE_WINDOW);
323                 self::cacheSet($key, $window);
324             }
325             return new ArrayWrapper(array_slice($window,
326                                                 $offset,
327                                                 $limit));
328         }
329     }
330
331     private static function realBySubscriber($subscriberId,
332                                              $offset,
333                                              $limit)
334     {
335         $sub = new Subscription();
336
337         $sub->subscriber = $subscriberId;
338
339         $sub->whereAdd('subscribed != ' . $subscriberId);
340
341         $sub->orderBy('created DESC');
342         $sub->limit($offset, $limit);
343
344         $sub->find();
345
346         $subs = array();
347
348         while ($sub->fetch()) {
349             $subs[] = clone($sub);
350         }
351
352         return $subs;
353     }
354
355     /**
356      * Stream of subscriptions with the same subscribed profile
357      *
358      * Useful for showing pages that list subscribers in reverse
359      * chronological order. Has offset & limit to make paging
360      * easy.
361      *
362      * @param integer $subscribedId Profile ID of the subscribed
363      * @param integer $offset       Offset from latest
364      * @param integer $limit        Maximum number to fetch
365      *
366      * @return Subscription stream of subscriptions; use fetch() to iterate
367      */
368     static function bySubscribed($subscribedId,
369                                  $offset = 0,
370                                  $limit = PROFILES_PER_PAGE)
371     {
372         if ($offset + $limit > self::CACHE_WINDOW) {
373             return new ArrayWrapper(self::realBySubscribed($subscribedId,
374                                                            $offset,
375                                                            $limit));
376         } else {
377             $key = 'subscription:by-subscribed:'.$subscribedId;
378             $window = self::cacheGet($key);
379             if ($window === false) {
380                 $window = self::realBySubscribed($subscribedId,
381                                                  0,
382                                                  self::CACHE_WINDOW);
383                 self::cacheSet($key, $window);
384             }
385             return new ArrayWrapper(array_slice($window,
386                                                 $offset,
387                                                 $limit));
388         }
389     }
390
391     private static function realBySubscribed($subscribedId,
392                                              $offset,
393                                              $limit)
394     {
395         $sub = new Subscription();
396
397         $sub->subscribed = $subscribedId;
398
399         $sub->whereAdd('subscriber != ' . $subscribedId);
400
401         $sub->orderBy('created DESC');
402         $sub->limit($offset, $limit);
403
404         $sub->find();
405
406         $subs = array();
407
408         while ($sub->fetch()) {
409             $subs[] = clone($sub);
410         }
411
412         return $subs;
413     }
414
415     /**
416      * Flush cached subscriptions when subscription is updated
417      *
418      * Because we cache subscriptions, it's useful to flush them
419      * here.
420      *
421      * @param mixed $orig Original version of object
422      *
423      * @return boolean success flag.
424      */
425     function update($orig=null)
426     {
427         $result = parent::update($orig);
428
429         self::blow('subscription:by-subscriber:'.$this->subscriber);
430         self::blow('subscription:by-subscribed:'.$this->subscribed);
431
432         return $result;
433     }
434
435     function getURI()
436     {
437         if (!empty($this->uri)) {
438             return $this->uri;
439         } else {
440             return self::newURI($this->subscriber, $this->subscribed, $this->created);
441         }
442     }
443
444     static function newURI($subscriber_id, $subscribed_id, $created)
445     {
446         return TagURI::mint('follow:%d:%d:%s',
447                             $subscriber_id,
448                             $subscribed_id,
449                             common_date_iso8601($created));
450     }
451 }