lib/inboxnoticestream.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Stream of notices for a profile's "all" feed
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  NoticeStream
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @author    Mikael Nordfeldth <mmn@hethane.se>
  27  * @copyright 2011 StatusNet, Inc.
  28  * @copyright 2014 Free Software Foundation, Inc.
  29  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  30  * @link      http://status.net/
  31  */
  32
  33 if (!defined('GNUSOCIAL') && !defined('STATUSNET')) { exit(1); }
  34
  35 /**
  36  * Stream of notices for a profile's "all" feed
  37  *
  38  * @category  General
  39  * @package   StatusNet
  40  * @author    Evan Prodromou <evan@status.net>
  41  * @author    Mikael Nordfeldth <mmn@hethane.se>
  42  * @copyright 2011 StatusNet, Inc.
  43  * @copyright 2014 Free Software Foundation, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47 class InboxNoticeStream extends ScopingNoticeStream
  48 {
  49     /**
  50      * Constructor
  51      *
  52      * @param Profile $target Profile to get a stream for
  53      * @param Profile $scoped Currently scoped profile (if null, it is fetched)
  54      */
  55     function __construct(Profile $target, Profile $scoped=null)
  56     {
  57         if ($scoped === null) {
  58             $scoped = Profile::current();
  59         }
  60         // FIXME: we don't use CachingNoticeStream - but maybe we should?
  61         parent::__construct(new CachingNoticeStream(new RawInboxNoticeStream($target), 'profileall'), $scoped);
  62     }
  63 }
  64
  65 /**
  66  * Raw stream of notices for the target's inbox
  67  *
  68  * @category  General
  69  * @package   StatusNet
  70  * @author    Evan Prodromou <evan@status.net>
  71  * @copyright 2011 StatusNet, Inc.
  72  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  73  * @link      http://status.net/
  74  */
  75 class RawInboxNoticeStream extends NoticeStream
  76 {
  77     protected $target  = null;
  78     protected $inbox = null;
  79
  80     /**
  81      * Constructor
  82      *
  83      * @param Profile $target Profile to get a stream for
  84      */
  85     function __construct(Profile $target)
  86     {
  87         $this->target  = $target;
  88     }
  89
  90     /**
  91      * Get IDs in a range
  92      *
  93      * @param int $offset   Offset from start
  94      * @param int $limit    Limit of number to get
  95      * @param int $since_id Since this notice
  96      * @param int $max_id   Before this notice
  97      *
  98      * @return Array IDs found
  99      */
 100     function getNoticeIds($offset, $limit, $since_id, $max_id)
 101     {
 102         $notice = new Notice();
 103         $notice->selectAdd();
 104         $notice->selectAdd('id');
 105         $notice->whereAdd(sprintf('notice.created > "%s"', $notice->escape($this->target->created)));
 106         // Reply:: is a table of mentions
 107         // Subscription:: is a table of subscriptions (every user is subscribed to themselves)
 108         $notice->whereAdd(
 109                 sprintf('notice.id IN (SELECT notice_id FROM reply WHERE profile_id=%1$d) ' .
 110                         'OR notice.profile_id IN (SELECT subscribed FROM subscription WHERE subscriber=%d) ' .
 111                         'OR notice.id IN (SELECT notice_id FROM attention WHERE profile_id=%1$d)',
 112                     $this->target->id)
 113             );
 114         $notice->limit($offset, $limit);
 115         $notice->orderBy('notice.created DESC');
 116
 117         if (!$notice->find()) {
 118             return array();
 119         }
 120
 121         $ids = $notice->fetchAll('id');
 122
 123         return $ids;
 124     }
 125
 126     function getNotices($offset, $limit, $sinceId, $maxId)
 127     {
 128         $all = array();
 129
 130         do {
 131
 132             $ids = $this->getNoticeIds($offset, $limit, $sinceId, $maxId);
 133
 134             $notices = Notice::pivotGet('id', $ids);
 135
 136             // By default, takes out false values
 137
 138             $notices = array_filter($notices);
 139
 140             $all = array_merge($all, $notices);
 141
 142             if (count($notices < count($ids))) {
 143                 $offset += $limit;
 144                 $limit  -= count($notices);
 145             }
 146
 147         } while (count($notices) < count($ids) && count($ids) > 0);
 148
 149         return new ArrayWrapper($all);
 150     }
 151 }