268 lines
		
	
	
		
			9.0 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			268 lines
		
	
	
		
			9.0 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
<?php
 | 
						|
/*
 | 
						|
 * StatusNet - the distributed open-source microblogging tool
 | 
						|
 * Copyright (C) 2008, 2009, StatusNet, Inc.
 | 
						|
 *
 | 
						|
 * This program is free software: you can redistribute it and/or modify
 | 
						|
 * it under the terms of the GNU Affero General Public License as published by
 | 
						|
 * the Free Software Foundation, either version 3 of the License, or
 | 
						|
 * (at your option) any later version.
 | 
						|
 *
 | 
						|
 * This program is distributed in the hope that it will be useful,
 | 
						|
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
						|
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
						|
 * GNU Affero General Public License for more details.
 | 
						|
 *
 | 
						|
 * You should have received a copy of the GNU Affero General Public License
 | 
						|
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
						|
 */
 | 
						|
 | 
						|
if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
 | 
						|
 | 
						|
/**
 | 
						|
 * Table Definition for subscription
 | 
						|
 */
 | 
						|
require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
 | 
						|
 | 
						|
class Subscription extends Memcached_DataObject
 | 
						|
{
 | 
						|
    ###START_AUTOCODE
 | 
						|
    /* the code below is auto generated do not remove the above tag */
 | 
						|
 | 
						|
    public $__table = 'subscription';                    // table name
 | 
						|
    public $subscriber;                      // int(4)  primary_key not_null
 | 
						|
    public $subscribed;                      // int(4)  primary_key not_null
 | 
						|
    public $jabber;                          // tinyint(1)   default_1
 | 
						|
    public $sms;                             // tinyint(1)   default_1
 | 
						|
    public $token;                           // varchar(255)
 | 
						|
    public $secret;                          // varchar(255)
 | 
						|
    public $created;                         // datetime()   not_null
 | 
						|
    public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
 | 
						|
 | 
						|
    /* Static get */
 | 
						|
    function staticGet($k,$v=null)
 | 
						|
    { return Memcached_DataObject::staticGet('Subscription',$k,$v); }
 | 
						|
 | 
						|
    /* the code above is auto generated do not remove the tag below */
 | 
						|
    ###END_AUTOCODE
 | 
						|
 | 
						|
    function pkeyGet($kv)
 | 
						|
    {
 | 
						|
        return Memcached_DataObject::pkeyGet('Subscription', $kv);
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Make a new subscription
 | 
						|
     *
 | 
						|
     * @param Profile $subscriber party to receive new notices
 | 
						|
     * @param Profile $other      party sending notices; publisher
 | 
						|
     *
 | 
						|
     * @return Subscription new subscription
 | 
						|
     */
 | 
						|
 | 
						|
    static function start($subscriber, $other)
 | 
						|
    {
 | 
						|
        // @fixme should we enforce this as profiles in callers instead?
 | 
						|
        if ($subscriber instanceof User) {
 | 
						|
            $subscriber = $subscriber->getProfile();
 | 
						|
        }
 | 
						|
        if ($other instanceof User) {
 | 
						|
            $other = $other->getProfile();
 | 
						|
        }
 | 
						|
 | 
						|
        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()}");
 | 
						|
                }
 | 
						|
            }
 | 
						|
 | 
						|
            Event::handle('EndSubscribe', array($subscriber, $other));
 | 
						|
        }
 | 
						|
 | 
						|
        return true;
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * Low-level subscription save.
 | 
						|
     * Outside callers should use Subscription::start()
 | 
						|
     */
 | 
						|
    protected function saveNew($subscriber_id, $other_id)
 | 
						|
    {
 | 
						|
        $sub = new Subscription();
 | 
						|
 | 
						|
        $sub->subscriber = $subscriber_id;
 | 
						|
        $sub->subscribed = $other_id;
 | 
						|
        $sub->jabber     = 1;
 | 
						|
        $sub->sms        = 1;
 | 
						|
        $sub->created    = common_sql_now();
 | 
						|
 | 
						|
        $result = $sub->insert();
 | 
						|
 | 
						|
        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.'));
 | 
						|
        }
 | 
						|
 | 
						|
        return $sub;
 | 
						|
    }
 | 
						|
 | 
						|
    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
 | 
						|
 | 
						|
        $this->notifyEmail();
 | 
						|
    }
 | 
						|
 | 
						|
    function notifyEmail()
 | 
						|
    {
 | 
						|
        $subscribedUser = User::staticGet('id', $this->subscribed);
 | 
						|
 | 
						|
        if (!empty($subscribedUser)) {
 | 
						|
 | 
						|
            $subscriber = Profile::staticGet('id', $this->subscriber);
 | 
						|
 | 
						|
            mail_subscribe_notify_profile($subscribedUser, $subscriber);
 | 
						|
        }
 | 
						|
    }
 | 
						|
 | 
						|
    /**
 | 
						|
     * 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) {
 | 
						|
            // 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))) {
 | 
						|
 | 
						|
            $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
 | 
						|
                                               'subscribed' => $other->id));
 | 
						|
 | 
						|
            // note we checked for existence above
 | 
						|
 | 
						|
            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__);
 | 
						|
                        // TRANS: Exception thrown when the OMB token for a subscription could not deleted on the server.
 | 
						|
                        throw new Exception(_('Could not 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__);
 | 
						|
                // 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);
 | 
						|
 | 
						|
            $subscriber->blowSubscriptionCount();
 | 
						|
            $other->blowSubscriberCount();
 | 
						|
 | 
						|
            Event::handle('EndUnsubscribe', array($subscriber, $other));
 | 
						|
        }
 | 
						|
 | 
						|
        return;
 | 
						|
    }
 | 
						|
 | 
						|
    function exists($subscriber, $other)
 | 
						|
    {
 | 
						|
        $sub = Subscription::pkeyGet(array('subscriber' => $subscriber->id,
 | 
						|
                                           '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;
 | 
						|
 | 
						|
        $act->id   = TagURI::mint('follow:%d:%d:%s',
 | 
						|
                                  $subscriber->id,
 | 
						|
                                  $subscribed->id,
 | 
						|
                                  common_date_iso8601($this->created));
 | 
						|
 | 
						|
        $act->time    = strtotime($this->created);
 | 
						|
        // TRANS: Activity tile when subscribing to another person.
 | 
						|
        $act->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);
 | 
						|
 | 
						|
        return $act;
 | 
						|
    }
 | 
						|
}
 |