gnu-social/lib/inboxnoticestream.php

<?php
/**
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2011, StatusNet, Inc.
 *
 * Stream of notices for a profile's "all" feed
 *
 * 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/>.
 *
 * @category  NoticeStream
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @author    Mikael Nordfeldth <mmn@hethane.se>
 * @author    Alexei Sorokin <sor.alexei@meowr.ru>
 * @copyright 2011 StatusNet, Inc.
 * @copyright 2014 Free Software Foundation, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */

if (!defined('GNUSOCIAL')) {
    exit(1);
}

/**
 * Stream of notices for a profile's "all" feed
 *
 * @category  General
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @author    Mikael Nordfeldth <mmn@hethane.se>
 * @author    Alexei Sorokin <sor.alexei@meowr.ru>
 * @copyright 2011 StatusNet, Inc.
 * @copyright 2014 Free Software Foundation, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */
class InboxNoticeStream extends ScopingNoticeStream
{
    /**
     * Constructor
     *
     * @param Profile $target Profile to get a stream for
     * @param Profile $scoped Currently scoped profile (if null, it is fetched)
     */
    public function __construct(Profile $target, Profile $scoped = null)
    {
        // FIXME: we don't use CachingNoticeStream - but maybe we should?
        parent::__construct(new CachingNoticeStream(new RawInboxNoticeStream($target), 'profileall'), $scoped);
    }
}

/**
 * Raw stream of notices for the target's inbox
 *
 * @category  General
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @author    Mikael Nordfeldth <mmn@hethane.se>
 * @author    Alexei Sorokin <sor.alexei@meowr.ru>
 * @copyright 2011 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */
class RawInboxNoticeStream extends FullNoticeStream
{
    protected $target = null;
    protected $inbox = null;

    /**
     * Constructor
     *
     * @param Profile $target Profile to get a stream for
     */
    public function __construct(Profile $target)
    {
        parent::__construct();
        $this->target = $target;
    }

    /**
     * Get IDs in a range
     *
     * @param int $offset Offset from start
     * @param int $limit Limit of number to get
     * @param int $since_id Since this notice
     * @param int $max_id Before this notice
     *
     * @return array IDs found
     */
    public function getNoticeIds($offset, $limit, $since_id = null, $max_id = null)
    {
        $notice_ids = [];

        // Grab all the profiles target is subscribed to (every user is subscribed to themselves)
        $subscription = new Subscription();
        $subscription->selectAdd();
        $subscription->selectAdd('subscribed');
        $subscription->whereAdd(sprintf('subscriber = %1$d', $this->target->id));
        $subscription_profile_ids = $subscription->fetchAll('subscribed');

        // Grab all the notices were target was mentioned
        $reply = new Reply();
        $reply->selectAdd();
        $reply->selectAdd('notice_id');
        $reply->whereAdd(sprintf('profile_id = %1$d', $this->target->id));
        $notice_ids += $reply->fetchAll('notice_id');

        // Grab all the notices that require target's attention
        $attention = new Attention();
        $attention->selectAdd();
        $attention->selectAdd('notice_id');
        $attention->whereAdd(sprintf('profile_id = %1$d', $this->target->id));
        $notice_ids += $attention->fetchAll('notice_id');

        // Grab all the notices posted on groups target is a member of
        $group_inbox = new Group_inbox();
        $group_inbox->selectAdd();
        $group_inbox->selectAdd('notice_id');
        $group_inbox->whereAdd(
            sprintf(
                'group_id IN (SELECT group_id FROM group_member WHERE profile_id = %1$d)',
                $this->target->id
            )
        );
        $notice_ids += $group_inbox->fetchAll('notice_id');

        // This is just to make the query lighter when processed by the Database server
        $notice_ids = array_filter($notice_ids, function ($id) {
            // Keep id (a.k.a.: return true) if:
            // - id higher than since id (just constrain if specified)
            // - id lower than max id (just constrain if specified)
            return (empty($since_id) || $id > $since_id) && (empty($max_id) || $id <= $max_id);
        });

        $query_ids = '';

        if (!empty($notice_ids)) { // Replies, Attentions and Groups
            $query_ids .= 'notice.id IN (' . implode(', ', $notice_ids) . ') OR ';
        }
        // every user is at least subscribed to themselves
        $query_ids .= 'notice.profile_id IN (' . implode(', ', $subscription_profile_ids) . ')';

        $notice = new Notice();
        $notice->selectAdd();
        $notice->selectAdd('id');
        $notice->whereAdd(sprintf('notice.created > "%s"', $notice->escape($this->target->created)));
        $notice->whereAdd($query_ids);

        if (!empty($since_id)) {
            $notice->whereAdd(sprintf('notice.id > %d', $since_id));
        }
        if (!empty($max_id)) {
            $notice->whereAdd(sprintf('notice.id <= %d', $max_id));
        }

        self::filterVerbs($notice, $this->selectVerbs);

        $notice->limit($offset, $limit);
        // notice.id will give us even really old posts, which were
        // recently imported. For example if a remote instance had
        // problems and just managed to post here. Another solution
        // would be to have a 'notice.imported' field and order by it.
        $notice->orderBy('notice.id DESC');

        if (!$notice->find()) {
            return [];
        }


        return $notice->fetchAll('id');
    }
}