lib/filteringnoticestream.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * A notice stream that filters its upstream content
   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('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * A class for presenting a filtered notice stream based on an upstream stream
  39  *
  40  * @category  Stream
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 abstract class FilteringNoticeStream extends NoticeStream
  49 {
  50     protected $upstream;
  51
  52     function __construct($upstream)
  53     {
  54         $this->upstream = $upstream;
  55     }
  56
  57     abstract function filter($notice);
  58
  59     function getNotices($offset, $limit, $sinceId=null, $maxId=null)
  60     {
  61         // "offset" is virtual; we have to get a lot
  62         $total = $offset + $limit;
  63
  64         $filtered = array();
  65
  66         $startAt = 0;
  67         $askFor  = $total;
  68
  69         // Keep going till we have $total notices in $notices array,
  70         // or we get nothing from upstream.
  71
  72         $results = null;
  73         $round = 0;
  74
  75         do {
  76
  77             common_debug(get_class($this) . ": ($offset, $limit) Round $round: fetching $askFor notices starting at $startAt");
  78
  79             $raw = $this->upstream->getNotices($startAt, $askFor, $sinceId, $maxId);
  80
  81             $results = $raw->N;
  82
  83             if ($results == 0) {
  84                 break;
  85             }
  86
  87             $notices = $raw->fetchAll();
  88
  89             $this->prefill($notices);
  90
  91             foreach ($notices as $notice) {
  92                 if ($this->filter($notice)) {
  93                     $filtered[] = $notice;
  94                     if (count($filtered) >= $total) {
  95                         break;
  96                     }
  97                 }
  98             }
  99
 100             // XXX: make these smarter; factor hit rate into $askFor
 101
 102             $startAt += $askFor;
 103
 104             $hits = count($filtered);
 105
 106             $lastAsk = $askFor;
 107
 108             if ($hits === 0) {
 109                 $askFor = max(min(2 * $askFor, NOTICES_PER_PAGE * 50), NOTICES_PER_PAGE);
 110             } else {
 111                 $askFor = max(min((($total - $hits)*$startAt)/$hits, NOTICES_PER_PAGE * 50), NOTICES_PER_PAGE);
 112             }
 113
 114             common_debug(get_class($this) . ": ($offset, $limit) Round $round hits is $hits, results = $results.");
 115
 116             $round++;
 117
 118         } while (count($filtered) < $total && $results >= $lastAsk);
 119
 120         return new ArrayWrapper(array_slice($filtered, $offset, $limit));
 121     }
 122
 123     function getNoticeIds($offset, $limit, $sinceId, $maxId)
 124     {
 125         $notices = $this->getNotices($offset, $limit, $sinceId, $maxId);
 126
 127         $ids = array();
 128
 129         while ($notices->fetch()) {
 130             $ids[] = $notices->id;
 131         }
 132
 133         return $ids;
 134     }
 135
 136     function prefill($notices)
 137     {
 138         return;
 139     }
 140 }