lib/scopingnoticestream.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * Filtering notice stream that recognizes notice scope
   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 comment
  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 ScopingNoticeStream extends FilteringNoticeStream
  45 {
  46     protected $profile;
  47
  48     function __construct(NoticeStream $upstream, Profile $scoped=null)
  49     {
  50         parent::__construct($upstream);
  51
  52         $this->profile = $scoped;   // legacy
  53         $this->scoped = $scoped;
  54     }
  55
  56     /**
  57      * Only return notices where the profile is in scope
  58      *
  59      * @param Notice $notice The notice to check
  60      *
  61      * @return boolean whether to include the notice
  62      */
  63
  64     protected function filter(Notice $notice)
  65     {
  66         return $notice->inScope($this->scoped);
  67     }
  68
  69     function prefill($notices)
  70     {
  71         // XXX: this should probably only be in the scoping one.
  72
  73         Notice::fillGroups($notices);
  74         Notice::fillReplies($notices);
  75
  76         if (common_config('notice', 'hidespam')) {
  77
  78             $profiles = Notice::getProfiles($notices);
  79
  80             foreach ($profiles as $profile) {
  81                 $pids[] = $profile->id;
  82             }
  83
  84             Profile_role::pivotGet('profile_id',
  85                                    $pids,
  86                                    array('role' => Profile_role::SILENCED));
  87         }
  88     }
  89 }