lib/tagnoticestream.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Stream of notices with a given tag
   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  * Stream of notices with a given tag
  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
  44 class TagNoticeStream extends ScopingNoticeStream
  45 {
  46     function __construct($tag, Profile $scoped=null)
  47     {
  48         parent::__construct(new CachingNoticeStream(new RawTagNoticeStream($tag),
  49                                                     'notice_tag:notice_ids:' . Cache::keyize($tag)),
  50                             $scoped);
  51     }
  52 }
  53
  54 /**
  55  * Raw stream of notices with a given tag
  56  *
  57  * @category  Stream
  58  * @package   StatusNet
  59  * @author    Evan Prodromou <evan@status.net>
  60  * @copyright 2011 StatusNet, Inc.
  61  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  62  * @link      http://status.net/
  63  */
  64
  65 class RawTagNoticeStream extends NoticeStream
  66 {
  67     protected $tag;
  68
  69     function __construct($tag)
  70     {
  71         $this->tag = $tag;
  72     }
  73
  74     function getNoticeIds($offset, $limit, $since_id, $max_id)
  75     {
  76         $nt = new Notice_tag();
  77
  78         $nt->tag = $this->tag;
  79
  80         $nt->selectAdd();
  81         $nt->selectAdd('notice_id');
  82
  83         Notice::addWhereSinceId($nt, $since_id, 'notice_id');
  84         Notice::addWhereMaxId($nt, $max_id, 'notice_id');
  85
  86         if (!empty($this->selectVerbs)) {
  87             $nt->joinAdd(array('notice_id', 'notice:id'));
  88
  89             $filter = array_keys(array_filter($this->selectVerbs));
  90             if (!empty($filter)) {
  91                 // include verbs in selectVerbs with values that equate to true
  92                 $nt->whereAddIn('notice.verb', $filter, 'string');
  93             }
  94
  95             $filter = array_keys(array_filter($this->selectVerbs, function ($v) { return !$v; }));
  96             if (!empty($filter)) {
  97                 // exclude verbs in selectVerbs with values that equate to false
  98                 $nt->whereAddIn('!notice.verb', $filter, 'string');
  99             }
 100         }
 101
 102         $nt->orderBy('notice.created DESC, notice_id DESC');
 103
 104         if (!is_null($offset)) {
 105             $nt->limit($offset, $limit);
 106         }
 107
 108         $ids = array();
 109
 110         if ($nt->find()) {
 111             while ($nt->fetch()) {
 112                 $ids[] = $nt->notice_id;
 113             }
 114         }
 115
 116         return $ids;
 117     }
 118 }