*/
require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
-class Subscription extends Memcached_DataObject
+class Subscription extends Managed_DataObject
{
+ const CACHE_WINDOW = 201;
+ const FORCE = true;
+
###START_AUTOCODE
/* the code below is auto generated do not remove the above tag */
public $created; // datetime() not_null
public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
+ public static function schemaDef()
+ {
+ return array(
+ 'fields' => array(
+ 'subscriber' => array('type' => 'int', 'not null' => true, 'description' => 'profile listening'),
+ 'subscribed' => array('type' => 'int', 'not null' => true, 'description' => 'profile being listened to'),
+ 'jabber' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'deliver jabber messages'),
+ 'sms' => array('type' => 'int', 'size' => 'tiny', 'default' => 1, 'description' => 'deliver sms messages'),
+ 'token' => array('type' => 'varchar', 'length' => 255, 'description' => 'authorization token'),
+ 'secret' => array('type' => 'varchar', 'length' => 255, 'description' => 'token secret'),
+ 'created' => array('type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'),
+ 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
+ ),
+ 'primary key' => array('subscriber', 'subscribed'),
+ 'indexes' => array(
+ 'subscription_subscriber_idx' => array('subscriber', 'created'),
+ 'subscription_subscribed_idx' => array('subscribed', 'created'),
+ 'subscription_token_idx' => array('token'),
+ ),
+ );
+ }
+
/* Static get */
function staticGet($k,$v=null)
{ return Memcached_DataObject::staticGet('Subscription',$k,$v); }
*
* @param Profile $subscriber party to receive new notices
* @param Profile $other party sending notices; publisher
+ * @param bool $force pass Subscription::FORCE to override local subscription approval
*
- * @return Subscription new subscription
+ * @return mixed Subscription or Subscription_queue: new subscription info
*/
- static function start($subscriber, $other)
+ static function start($subscriber, $other, $force=false)
{
// @fixme should we enforce this as profiles in callers instead?
if ($subscriber instanceof User) {
}
if (!$subscriber->hasRight(Right::SUBSCRIBE)) {
+ // TRANS: Exception thrown when trying to subscribe while being banned from subscribing.
throw new Exception(_('You have been banned from subscribing.'));
}
if (self::exists($subscriber, $other)) {
+ // TRANS: Exception thrown when trying to subscribe while already subscribed.
throw new Exception(_('Already subscribed!'));
}
if ($other->hasBlocked($subscriber)) {
+ // TRANS: Exception thrown when trying to subscribe to a user who has blocked the subscribing user.
throw new Exception(_('User has blocked you.'));
}
if (Event::handle('StartSubscribe', array($subscriber, $other))) {
- $sub = self::saveNew($subscriber->id, $other->id);
- $sub->notify();
-
- self::blow('user:notices_with_friends:%d', $subscriber->id);
-
- $subscriber->blowSubscriptionCount();
- $other->blowSubscriberCount();
-
$otherUser = User::staticGet('id', $other->id);
-
- if (!empty($otherUser) &&
- $otherUser->autosubscribe &&
- !self::exists($other, $subscriber) &&
- !$subscriber->hasBlocked($other)) {
-
- try {
- self::start($other, $subscriber);
- } catch (Exception $e) {
- common_log(LOG_ERR, "Exception during autosubscribe of {$other->nickname} to profile {$subscriber->id}: {$e->getMessage()}");
+ if ($otherUser && $otherUser->subscribe_policy == User::SUBSCRIBE_POLICY_MODERATE && !$force) {
+ $sub = Subscription_queue::saveNew($subscriber, $other);
+ $sub->notify();
+ } else {
+ $sub = self::saveNew($subscriber->id, $other->id);
+ $sub->notify();
+
+ self::blow('user:notices_with_friends:%d', $subscriber->id);
+
+ self::blow('subscription:by-subscriber:'.$subscriber->id);
+ self::blow('subscription:by-subscribed:'.$other->id);
+
+ $subscriber->blowSubscriptionCount();
+ $other->blowSubscriberCount();
+
+ if (!empty($otherUser) &&
+ $otherUser->autosubscribe &&
+ !self::exists($other, $subscriber) &&
+ !$subscriber->hasBlocked($other)) {
+
+ try {
+ self::start($other, $subscriber);
+ } catch (Exception $e) {
+ common_log(LOG_ERR, "Exception during autosubscribe of {$other->nickname} to profile {$subscriber->id}: {$e->getMessage()}");
+ }
}
}
Event::handle('EndSubscribe', array($subscriber, $other));
}
- return true;
+ return $sub;
}
/**
if (!$result) {
common_log_db_error($sub, 'INSERT', __FILE__);
+ // TRANS: Exception thrown when a subscription could not be stored on the server.
throw new Exception(_('Could not save subscription.'));
}
function notify()
{
- # XXX: add other notifications (Jabber, SMS) here
- # XXX: queue this and handle it offline
- # XXX: Whatever happens, do it in Twitter-like API, too
+ // XXX: add other notifications (Jabber, SMS) here
+ // XXX: queue this and handle it offline
+ // XXX: Whatever happens, do it in Twitter-like API, too
$this->notifyEmail();
}
* Cancel a subscription
*
*/
-
function cancel($subscriber, $other)
{
if (!self::exists($subscriber, $other)) {
+ // TRANS: Exception thrown when trying to unsibscribe without a subscription.
throw new Exception(_('Not subscribed!'));
}
// Don't allow deleting self subs
if ($subscriber->id == $other->id) {
- throw new Exception(_('Couldn\'t delete self-subscription.'));
+ // TRANS: Exception thrown when trying to unsubscribe a user from themselves.
+ throw new Exception(_('Could not delete self-subscription.'));
}
if (Event::handle('StartUnsubscribe', array($subscriber, $other))) {
assert(!empty($sub));
- // @todo: move this block to EndSubscribe handler for
- // OMB plugin when it exists.
-
- if (!empty($sub->token)) {
-
- $token = new Token();
-
- $token->tok = $sub->token;
-
- if ($token->find(true)) {
-
- $result = $token->delete();
-
- if (!$result) {
- common_log_db_error($token, 'DELETE', __FILE__);
- throw new Exception(_('Couldn\'t delete subscription OMB token.'));
- }
- } else {
- common_log(LOG_ERR, "Couldn't find credentials with token {$token->tok}");
- }
- }
-
$result = $sub->delete();
if (!$result) {
common_log_db_error($sub, 'DELETE', __FILE__);
- throw new Exception(_('Couldn\'t delete subscription.'));
+ // TRANS: Exception thrown when a subscription could not be deleted on the server.
+ throw new Exception(_('Could not delete subscription.'));
}
self::blow('user:notices_with_friends:%d', $subscriber->id);
+ self::blow('subscription:by-subscriber:'.$subscriber->id);
+ self::blow('subscription:by-subscribed:'.$other->id);
+
$subscriber->blowSubscriptionCount();
$other->blowSubscriberCount();
'subscribed' => $other->id));
return (empty($sub)) ? false : true;
}
+
+ function asActivity()
+ {
+ $subscriber = Profile::staticGet('id', $this->subscriber);
+ $subscribed = Profile::staticGet('id', $this->subscribed);
+
+ $act = new Activity();
+
+ $act->verb = ActivityVerb::FOLLOW;
+
+ // XXX: rationalize this with the URL
+
+ $act->id = TagURI::mint('follow:%d:%d:%s',
+ $subscriber->id,
+ $subscribed->id,
+ common_date_iso8601($this->created));
+
+ $act->time = strtotime($this->created);
+ // TRANS: Activity title when subscribing to another person.
+ $act->title = _m('TITLE','Follow');
+ // TRANS: Notification given when one person starts following another.
+ // TRANS: %1$s is the subscriber, %2$s is the subscribed.
+ $act->content = sprintf(_('%1$s is now following %2$s.'),
+ $subscriber->getBestName(),
+ $subscribed->getBestName());
+
+ $act->actor = ActivityObject::fromProfile($subscriber);
+ $act->objects[] = ActivityObject::fromProfile($subscribed);
+
+ $url = common_local_url('AtomPubShowSubscription',
+ array('subscriber' => $subscriber->id,
+ 'subscribed' => $subscribed->id));
+
+ $act->selfLink = $url;
+ $act->editLink = $url;
+
+ return $act;
+ }
+
+ /**
+ * Stream of subscriptions with the same subscriber
+ *
+ * Useful for showing pages that list subscriptions in reverse
+ * chronological order. Has offset & limit to make paging
+ * easy.
+ *
+ * @param integer $subscriberId Profile ID of the subscriber
+ * @param integer $offset Offset from latest
+ * @param integer $limit Maximum number to fetch
+ *
+ * @return Subscription stream of subscriptions; use fetch() to iterate
+ */
+ static function bySubscriber($subscriberId,
+ $offset = 0,
+ $limit = PROFILES_PER_PAGE)
+ {
+ if ($offset + $limit > self::CACHE_WINDOW) {
+ return new ArrayWrapper(self::realBySubscriber($subscriberId,
+ $offset,
+ $limit));
+ } else {
+ $key = 'subscription:by-subscriber:'.$subscriberId;
+ $window = self::cacheGet($key);
+ if ($window === false) {
+ $window = self::realBySubscriber($subscriberId,
+ 0,
+ self::CACHE_WINDOW);
+ self::cacheSet($key, $window);
+ }
+ return new ArrayWrapper(array_slice($window,
+ $offset,
+ $limit));
+ }
+ }
+
+ private static function realBySubscriber($subscriberId,
+ $offset,
+ $limit)
+ {
+ $sub = new Subscription();
+
+ $sub->subscriber = $subscriberId;
+
+ $sub->whereAdd('subscribed != ' . $subscriberId);
+
+ $sub->orderBy('created DESC');
+ $sub->limit($offset, $limit);
+
+ $sub->find();
+
+ $subs = array();
+
+ while ($sub->fetch()) {
+ $subs[] = clone($sub);
+ }
+
+ return $subs;
+ }
+
+ /**
+ * Stream of subscriptions with the same subscribed profile
+ *
+ * Useful for showing pages that list subscribers in reverse
+ * chronological order. Has offset & limit to make paging
+ * easy.
+ *
+ * @param integer $subscribedId Profile ID of the subscribed
+ * @param integer $offset Offset from latest
+ * @param integer $limit Maximum number to fetch
+ *
+ * @return Subscription stream of subscriptions; use fetch() to iterate
+ */
+ static function bySubscribed($subscribedId,
+ $offset = 0,
+ $limit = PROFILES_PER_PAGE)
+ {
+ if ($offset + $limit > self::CACHE_WINDOW) {
+ return new ArrayWrapper(self::realBySubscribed($subscribedId,
+ $offset,
+ $limit));
+ } else {
+ $key = 'subscription:by-subscribed:'.$subscribedId;
+ $window = self::cacheGet($key);
+ if ($window === false) {
+ $window = self::realBySubscribed($subscribedId,
+ 0,
+ self::CACHE_WINDOW);
+ self::cacheSet($key, $window);
+ }
+ return new ArrayWrapper(array_slice($window,
+ $offset,
+ $limit));
+ }
+ }
+
+ private static function realBySubscribed($subscribedId,
+ $offset,
+ $limit)
+ {
+ $sub = new Subscription();
+
+ $sub->subscribed = $subscribedId;
+
+ $sub->whereAdd('subscriber != ' . $subscribedId);
+
+ $sub->orderBy('created DESC');
+ $sub->limit($offset, $limit);
+
+ $sub->find();
+
+ $subs = array();
+
+ while ($sub->fetch()) {
+ $subs[] = clone($sub);
+ }
+
+ return $subs;
+ }
+
+ /**
+ * Flush cached subscriptions when subscription is updated
+ *
+ * Because we cache subscriptions, it's useful to flush them
+ * here.
+ *
+ * @param mixed $orig Original version of object
+ *
+ * @return boolean success flag.
+ */
+ function update($orig=null)
+ {
+ $result = parent::update($orig);
+
+ self::blow('subscription:by-subscriber:'.$this->subscriber);
+ self::blow('subscription:by-subscribed:'.$this->subscribed);
+
+ return $result;
+ }
}