actions/publicrss.php

   1 <?php
   2 /**
   3  * Public RSS action class.
   4  *
   5  * PHP version 5
   6  *
   7  * @category Action
   8  * @package  StatusNet
   9  * @author   Evan Prodromou <evan@status.net>
  10  * @author   Robin Millette <millette@status.net>
  11  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  12  * @link     http://status.net/
  13  *
  14  * StatusNet - the distributed open-source microblogging tool
  15  * Copyright (C) 2008, 2009, StatusNet, Inc.
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU Affero General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU Affero General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU Affero General Public License
  28  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  29  */
  30
  31 if (!defined('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * RSS feed for public timeline.
  35  *
  36  * Formatting of RSS handled by Rss10Action
  37  *
  38  * @category Action
  39  * @package  StatusNet
  40  * @author   Evan Prodromou <evan@status.net>
  41  * @author   Robin Millette <millette@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  43  * @link     http://status.net/
  44  */
  45 class PublicrssAction extends Rss10Action
  46 {
  47     /**
  48      * Read arguments and initialize members
  49      *
  50      * @param array $args Arguments from $_REQUEST
  51      * @return boolean success
  52      */
  53     function prepare($args)
  54     {
  55         parent::prepare($args);
  56         $this->notices = $this->getNotices($this->limit);
  57         return true;
  58     }
  59
  60     /**
  61      * Initialization.
  62      *
  63      * @return boolean true
  64      */
  65     function init()
  66     {
  67         return true;
  68     }
  69
  70     /**
  71      * Get notices
  72      *
  73      * @param integer $limit max number of notices to return
  74      *
  75      * @return array notices
  76      */
  77     function getNotices($limit=0)
  78     {
  79         $notices = array();
  80         $notice  = Notice::publicStream(0, ($limit == 0) ? 48 : $limit);
  81         while ($notice->fetch()) {
  82             $notices[] = clone($notice);
  83         }
  84
  85         return $notices;
  86     }
  87
  88      /**
  89      * Get channel.
  90      *
  91      * @return array associative array on channel information
  92      */
  93     function getChannel()
  94     {
  95         $sitename = common_config('site', 'name');
  96         $c = array(
  97               'url' => common_local_url('publicrss'),
  98             // TRANS: Public RSS feed title. %s is the StatusNet site name.
  99               'title' => sprintf(_('%s public timeline'), $sitename),
 100               'link' => common_local_url('public'),
 101             // TRANS: Public RSS feed description. %s is the StatusNet site name.
 102               'description' => sprintf(_('%s updates from everyone.'), $sitename));
 103         return $c;
 104     }
 105
 106     /**
 107      * Get image.
 108      *
 109      * @return nothing
 110      */
 111     function getImage()
 112     {
 113         // nop
 114     }
 115
 116     function isReadOnly($args)
 117     {
 118         return true;
 119     }
 120 }