lib/noticestream.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * A stream of notices
   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  Stream
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * Class for notice streams
  35  *
  36  * @category  Stream
  37  * @package   StatusNet
  38  * @author    Evan Prodromou <evan@status.net>
  39  * @copyright 2011 StatusNet, Inc.
  40  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  41  * @link      http://status.net/
  42  */
  43 abstract class NoticeStream
  44 {
  45     protected $selectVerbs   = array(ActivityVerb::POST => true,
  46                                      ActivityVerb::SHARE => true);
  47
  48     public function __construct()
  49     {
  50         foreach ($this->selectVerbs as $key=>$val) {
  51             // to avoid database inconsistency issues we select both relative and absolute verbs
  52             $this->selectVerbs[ActivityUtils::resolveUri($key)] = $val;
  53             $this->selectVerbs[ActivityUtils::resolveUri($key, true)] = $val;
  54         }
  55     }
  56
  57     abstract function getNoticeIds($offset, $limit, $since_id, $max_id);
  58
  59     function getNotices($offset, $limit, $sinceId = null, $maxId = null)
  60     {
  61         $ids = $this->getNoticeIds($offset, $limit, $sinceId, $maxId);
  62
  63         $notices = self::getStreamByIds($ids);
  64
  65         return $notices;
  66     }
  67
  68     static function getStreamByIds($ids)
  69     {
  70         return Notice::multiGet('id', $ids);
  71     }
  72
  73     static function filterVerbs(Notice $notice, array $selectVerbs)
  74     {
  75         $filter = array_keys(array_filter($selectVerbs));
  76         if (!empty($filter)) {
  77             // include verbs in selectVerbs with values that equate to true
  78             $notice->whereAddIn('verb', $filter, $notice->columnType('verb'));
  79         }
  80
  81         $filter = array_keys(array_filter($selectVerbs, function ($v) { return !$v; }));
  82         if (!empty($filter)) {
  83             // exclude verbs in selectVerbs with values that equate to false
  84             $notice->whereAddIn('!verb', $filter, $notice->columnType('verb'));
  85         }
  86
  87         unset($filter);
  88     }
  89 }