plugins/Bookmark/actions/bookmarksrss.php

   1 <?php
   2 /**
   3  * RSS feed for user bookmarks 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 bookmarks action class.
  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  * @author   Zach Copley <zach@status.net>
  43  * @author   Stephane Berube <chimo@chromic.org> (modified 'favoritesrss.php' to show bookmarks instead)
  44  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  45  * @link     http://status.net/
  46  */
  47 class BookmarksrssAction extends Rss10Action
  48 {
  49     /** The user whose bookmarks to display */
  50
  51     var $user = null;
  52
  53     /**
  54      * Find the user to display by supplied nickname
  55      *
  56      * @param array $args Arguments from $_REQUEST
  57      *
  58      * @return boolean success
  59      */
  60     function prepare($args)
  61     {
  62         parent::prepare($args);
  63
  64         $nickname   = $this->trimmed('nickname');
  65         $this->user = User::getKV('nickname', $nickname);
  66
  67         if (!$this->user) {
  68             // TRANS: Client error displayed when trying to get the RSS feed with bookmarks of a user that does not exist.
  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         $user    = $this->user;
  86
  87         $notice = new BookmarksNoticeStream($this->user->id, true);
  88         $notice = $notice->getNotices(0, NOTICES_PER_PAGE);
  89
  90         $notices = array();
  91         while ($notice->fetch()) {
  92             $notices[] = clone($notice);
  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('bookmarksrss',
 106                                         array('nickname' =>
 107                                         $user->nickname)),
 108                    // TRANS: Title of RSS feed with bookmarks of a user.
 109                    // TRANS: %s is a user's nickname.
 110                    'title' => sprintf(_("%s's bookmarks"), $user->nickname),
 111                    'link' => common_local_url('bookmarks',
 112                                         array('nickname' =>
 113                                         $user->nickname)),
 114                    // TRANS: Desciption of RSS feed with bookmarks of a user.
 115                    // TRANS: %1$s is a user's nickname, %2$s is the name of the StatusNet site.
 116                    'description' => sprintf(_('Bookmarks posted by %1$s on %2$s!'),
 117                                         $user->nickname, common_config('site', 'name')));
 118         return $c;
 119     }
 120
 121     /**
 122      * Get image.
 123      *
 124      * @return void
 125     */
 126     function getImage()
 127     {
 128         return null;
 129     }
 130
 131 }