actions/allrss.php

   1 <?php
   2 /**
   3  * RSS feed for user and friends timeline 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('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/rssaction.php';
  36
  37 /**
  38  * RSS feed for user and friends timeline.
  39  *
  40  * Formatting of RSS handled by Rss10Action
  41  *
  42  * @category Action
  43  * @package  StatusNet
  44  * @author   Evan Prodromou <evan@status.net>
  45  * @author   Robin Millette <millette@status.net>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  47  * @link     http://status.net/
  48  */
  49 class AllrssAction extends Rss10Action
  50 {
  51     var $user = null;
  52
  53     /**
  54      * Initialization.
  55      *
  56      * @param array $args Web and URL arguments
  57      *
  58      * @return boolean false if user doesn't exist
  59      *
  60      */
  61     function prepare(array $args=array())
  62     {
  63         parent::prepare($args);
  64         $nickname   = $this->trimmed('nickname');
  65         $this->user = User::getKV('nickname', $nickname);
  66
  67         if (!$this->user) {
  68             // TRANS: Client error when user not found for an rss related action.
  69             $this->clientError(_('No such user.'));
  70         } else {
  71             $this->notices = $this->getNotices($this->limit);
  72             return true;
  73         }
  74     }
  75
  76     /**
  77      * Get notices
  78      *
  79      * @param integer $limit max number of notices to return
  80      *
  81      * @return array notices
  82      */
  83     function getNotices($limit=0)
  84     {
  85         $stream = new InboxNoticeStream($this->user->getProfile());
  86         $notice = $stream->getNotices(0, $limit, null, null);
  87
  88         $notices = array();
  89
  90         while ($notice->fetch()) {
  91             $notices[] = clone($notice);
  92         }
  93
  94         return $notices;
  95     }
  96
  97      /**
  98      * Get channel.
  99      *
 100      * @return array associative array on channel information
 101      */
 102     function getChannel()
 103     {
 104         $user = $this->user;
 105         $c    = array('url' => common_local_url('allrss',
 106                                              array('nickname' =>
 107                                                    $user->nickname)),
 108                    // TRANS: Message is used as link title. %s is a user nickname.
 109                    'title' => sprintf(_('%s and friends'), $user->nickname),
 110                    'link' => common_local_url('all',
 111                                              array('nickname' =>
 112                                                    $user->nickname)),
 113                    // TRANS: Message is used as link description. %1$s is a username, %2$s is a site name.
 114                    'description' => sprintf(_('Updates from %1$s and friends on %2$s!'),
 115                                             $user->nickname, common_config('site', 'name')));
 116         return $c;
 117     }
 118
 119     /**
 120      * Get image.
 121      *
 122      * @return string user avatar URL or null
 123      */
 124     function getImage()
 125     {
 126         $user    = $this->user;
 127         $profile = $user->getProfile();
 128         if (!$profile) {
 129             return null;
 130         }
 131         return $profile->avatarUrl(AVATAR_PROFILE_SIZE);
 132     }
 133 }