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('GNUSOCIAL')) { exit(1); }
  32
  33 /**
  34  * RSS feed for user and friends 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 AllrssAction extends Rss10Action
  46 {
  47     var $user = null;
  48
  49     /**
  50      * Initialization.
  51      *
  52      * @param array $args Web and URL arguments
  53      *
  54      * @return boolean false if user doesn't exist
  55      *
  56      */
  57     function prepare($args)
  58     {
  59         parent::prepare($args);
  60         $nickname   = $this->trimmed('nickname');
  61         $this->user = User::getKV('nickname', $nickname);
  62
  63         if (!$this->user) {
  64             // TRANS: Client error when user not found for an rss related action.
  65             $this->clientError(_('No such user.'));
  66         } else {
  67             $this->notices = $this->getNotices($this->limit);
  68             return true;
  69         }
  70     }
  71
  72     /**
  73      * Get notices
  74      *
  75      * @param integer $limit max number of notices to return
  76      *
  77      * @return array notices
  78      */
  79     function getNotices($limit=0)
  80     {
  81         $stream = new InboxNoticeStream($this->user->getProfile());
  82         $notice = $stream->getNotices(0, $limit, null, null);
  83
  84         $notices = array();
  85
  86         while ($notice->fetch()) {
  87             $notices[] = clone($notice);
  88         }
  89
  90         return $notices;
  91     }
  92
  93      /**
  94      * Get channel.
  95      *
  96      * @return array associative array on channel information
  97      */
  98     function getChannel()
  99     {
 100         $user = $this->user;
 101         $c    = array('url' => common_local_url('allrss',
 102                                              array('nickname' =>
 103                                                    $user->nickname)),
 104                    // TRANS: Message is used as link title. %s is a user nickname.
 105                    'title' => sprintf(_('%s and friends'), $user->nickname),
 106                    'link' => common_local_url('all',
 107                                              array('nickname' =>
 108                                                    $user->nickname)),
 109                    // TRANS: Message is used as link description. %1$s is a username, %2$s is a site name.
 110                    'description' => sprintf(_('Updates from %1$s and friends on %2$s!'),
 111                                             $user->nickname, common_config('site', 'name')));
 112         return $c;
 113     }
 114
 115     /**
 116      * Get image.
 117      *
 118      * @return string user avatar URL or null
 119      */
 120     function getImage()
 121     {
 122         $user    = $this->user;
 123         $profile = $user->getProfile();
 124         if (!$profile) {
 125             return null;
 126         }
 127         return $profile->avatarUrl(AVATAR_PROFILE_SIZE);
 128     }
 129 }