plugins/Bookmark/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('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/rssaction.php';
  36 require_once 'bookmarksnoticestream.php';
  37
  38 /**
  39  * RSS feed for user bookmarks action class.
  40  *
  41  * Formatting of RSS handled by Rss10Action
  42  *
  43  * @category Action
  44  * @package  StatusNet
  45  * @author   Evan Prodromou <evan@status.net>
  46  * @author   Robin Millette <millette@status.net>
  47  * @author   Zach Copley <zach@status.net>
  48  * @author   Stephane Berube <chimo@chromic.org> (modified 'favoritesrss.php' to show bookmarks instead)
  49  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  50  * @link     http://status.net/
  51  */
  52 class BookmarksrssAction extends Rss10Action
  53 {
  54     /** The user whose bookmarks to display */
  55
  56     var $user = null;
  57
  58     /**
  59      * Find the user to display by supplied nickname
  60      *
  61      * @param array $args Arguments from $_REQUEST
  62      *
  63      * @return boolean success
  64      */
  65     function prepare($args)
  66     {
  67         parent::prepare($args);
  68
  69         $nickname   = $this->trimmed('nickname');
  70         $this->user = User::staticGet('nickname', $nickname);
  71
  72         if (!$this->user) {
  73             // TRANS: Client error displayed when trying to get the RSS feed with bookmarks of a user that does not exist.
  74             $this->clientError(_('No such user.'));
  75             return false;
  76         } else {
  77             $this->notices = $this->getNotices($this->limit);
  78             return true;
  79         }
  80     }
  81
  82     /**
  83      * Get notices
  84      *
  85      * @param integer $limit max number of notices to return
  86      *
  87      * @return array notices
  88      */
  89     function getNotices($limit=0)
  90     {
  91         $user    = $this->user;
  92
  93         $notice = new BookmarksNoticeStream($this->user->id, true);
  94         $notice = $notice->getNotices(0, NOTICES_PER_PAGE);
  95
  96         $notices = array();
  97         while ($notice->fetch()) {
  98             $notices[] = clone($notice);
  99         }
 100         return $notices;
 101     }
 102
 103      /**
 104      * Get channel.
 105      *
 106      * @return array associative array on channel information
 107      */
 108     function getChannel()
 109     {
 110         $user = $this->user;
 111         $c    = array('url' => common_local_url('bookmarksrss',
 112                                         array('nickname' =>
 113                                         $user->nickname)),
 114                    // TRANS: Title of RSS feed with bookmarks of a user.
 115                    // TRANS: %s is a user's nickname.
 116                    'title' => sprintf(_("%s's bookmarks"), $user->nickname),
 117                    'link' => common_local_url('bookmarks',
 118                                         array('nickname' =>
 119                                         $user->nickname)),
 120                    // TRANS: Desciption of RSS feed with bookmarks of a user.
 121                    // TRANS: %1$s is a user's nickname, %2$s is the name of the StatusNet site.
 122                    'description' => sprintf(_('Bookmarks posted by %1$s on %2$s!'),
 123                                         $user->nickname, common_config('site', 'name')));
 124         return $c;
 125     }
 126
 127     /**
 128      * Get image.
 129      *
 130      * @return void
 131     */
 132     function getImage()
 133     {
 134         return null;
 135     }
 136
 137 }