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