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 getNoticeIds($offset, $limit, $since_id, $max_id)
  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             $raw = $this->upstream->getNotices($startAt, $askFor, $since_id, $max_id);
  77
  78             $results = $raw->N;
  79             if ($results == 0) {
  80                 break;
  81             }
  82
  83             $notices = $raw->fetchAll();
  84             $this->prefill($notices);
  85             foreach ($notices as $notice) {
  86                 if ($this->filter($notice)) {
  87                     $filtered[] = $notice->id;
  88                     if (count($filtered) >= $total) {
  89                         break;
  90                     }
  91                 }
  92             }
  93
  94             // XXX: make these smarter; factor hit rate into $askFor
  95             $startAt += $askFor;
  96             $hits = count($filtered);
  97             $lastAsk = $askFor;
  98
  99             if ($hits === 0) {
 100                 $askFor = max(min(2 * $askFor, NOTICES_PER_PAGE * 50), NOTICES_PER_PAGE);
 101             } else {
 102                 $askFor = max(min(intval(ceil(($total - $hits)*$startAt/$hits)), NOTICES_PER_PAGE * 50), NOTICES_PER_PAGE);
 103             }
 104
 105             $round++;
 106         } while (count($filtered) < $total && $results >= $lastAsk);
 107
 108         return array_slice(array_values($filtered), $offset, $limit);
 109     }
 110
 111     function prefill($notices)
 112     {
 113         return;
 114     }
 115 }