actions/showfavorites.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * List of replies
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  Personal
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2008-2009 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR.'/lib/personalgroupnav.php';
  35 require_once INSTALLDIR.'/lib/noticelist.php';
  36 require_once INSTALLDIR.'/lib/feedlist.php';
  37
  38 /**
  39  * List of replies
  40  *
  41  * @category Personal
  42  * @package  StatusNet
  43  * @author   Evan Prodromou <evan@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47 class ShowfavoritesAction extends OwnerDesignAction
  48 {
  49     /** User we're getting the faves of */
  50     var $user = null;
  51     /** Page of the faves we're on */
  52     var $page = null;
  53
  54     /**
  55      * Is this a read-only page?
  56      *
  57      * @return boolean true
  58      */
  59     function isReadOnly($args)
  60     {
  61         return true;
  62     }
  63
  64     /**
  65      * Title of the page
  66      *
  67      * Includes name of user and page number.
  68      *
  69      * @return string title of page
  70      */
  71     function title()
  72     {
  73         if ($this->page == 1) {
  74             // TRANS: Title for first page of favourite notices of a user.
  75             // TRANS: %s is the user for whom the favourite notices are displayed.
  76             return sprintf(_('%s\'s favorite notices'), $this->user->nickname);
  77         } else {
  78             // TRANS: Title for all but the first page of favourite notices of a user.
  79             // TRANS: %1$s is the user for whom the favourite notices are displayed, %2$d is the page number.
  80             return sprintf(_('%1$s\'s favorite notices, page %2$d'),
  81                            $this->user->nickname,
  82                            $this->page);
  83         }
  84     }
  85
  86     /**
  87      * Prepare the object
  88      *
  89      * Check the input values and initialize the object.
  90      * Shows an error page on bad input.
  91      *
  92      * @param array $args $_REQUEST data
  93      *
  94      * @return boolean success flag
  95      */
  96     function prepare($args)
  97     {
  98         parent::prepare($args);
  99
 100         $nickname = common_canonical_nickname($this->arg('nickname'));
 101
 102         $this->user = User::staticGet('nickname', $nickname);
 103
 104         if (!$this->user) {
 105             // TRANS: Client error displayed when trying to display favourite notices for a non-existing user.
 106             $this->clientError(_('No such user.'));
 107             return false;
 108         }
 109
 110         $this->page = $this->trimmed('page');
 111
 112         if (!$this->page) {
 113             $this->page = 1;
 114         }
 115
 116         common_set_returnto($this->selfUrl());
 117
 118         $cur = common_current_user();
 119
 120         if (!empty($cur) && $cur->id == $this->user->id) {
 121
 122             // Show imported/gateway notices as well as local if
 123             // the user is looking at their own favorites
 124
 125             $this->notice = $this->user->favoriteNotices(true, ($this->page-1)*NOTICES_PER_PAGE,
 126                                                    NOTICES_PER_PAGE + 1);
 127         } else {
 128             $this->notice = $this->user->favoriteNotices(false, ($this->page-1)*NOTICES_PER_PAGE,
 129                                                    NOTICES_PER_PAGE + 1);
 130         }
 131
 132         if (empty($this->notice)) {
 133             // TRANS: Server error displayed when favourite notices could not be retrieved from the database.
 134             $this->serverError(_('Could not retrieve favorite notices.'));
 135             return;
 136         }
 137
 138         if($this->page > 1 && $this->notice->N == 0){
 139             // TRANS: Server error when page not found (404)
 140             $this->serverError(_('No such page.'),$code=404);
 141         }
 142
 143         return true;
 144     }
 145
 146     /**
 147      * Handle a request
 148      *
 149      * Just show the page. All args already handled.
 150      *
 151      * @param array $args $_REQUEST data
 152      *
 153      * @return void
 154      */
 155     function handle($args)
 156     {
 157         parent::handle($args);
 158         $this->showPage();
 159     }
 160
 161     /**
 162      * Feeds for the <head> section
 163      *
 164      * @return array Feed objects to show
 165      */
 166     function getFeeds()
 167     {
 168         return array(new Feed(Feed::RSS1,
 169                               common_local_url('favoritesrss',
 170                                                array('nickname' => $this->user->nickname)),
 171                               // TRANS: Feed link text. %s is a username.
 172                               sprintf(_('Feed for favorites of %s (RSS 1.0)'),
 173                                       $this->user->nickname)),
 174                      new Feed(Feed::RSS2,
 175                               common_local_url('ApiTimelineFavorites',
 176                                                array(
 177                                                     'id' => $this->user->nickname,
 178                                                     'format' => 'rss')),
 179                               // TRANS: Feed link text. %s is a username.
 180                               sprintf(_('Feed for favorites of %s (RSS 2.0)'),
 181                                       $this->user->nickname)),
 182                      new Feed(Feed::ATOM,
 183                               common_local_url('ApiTimelineFavorites',
 184                                                array(
 185                                                     'id' => $this->user->nickname,
 186                                                     'format' => 'atom')),
 187                               // TRANS: Feed link text. %s is a username.
 188                               sprintf(_('Feed for favorites of %s (Atom)'),
 189                                       $this->user->nickname)));
 190     }
 191
 192     function showEmptyListMessage()
 193     {
 194         if (common_logged_in()) {
 195             $current_user = common_current_user();
 196             if ($this->user->id === $current_user->id) {
 197                 // TRANS: Text displayed instead of favourite notices for the current logged in user that has no favourites.
 198                 $message = _('You haven\'t chosen any favorite notices yet. Click the fave button on notices you like to bookmark them for later or shed a spotlight on them.');
 199             } else {
 200                 // TRANS: Text displayed instead of favourite notices for a user that has no favourites while logged in.
 201                 // TRANS: %s is a username.
 202                 $message = sprintf(_('%s hasn\'t added any favorite notices yet. Post something interesting they would add to their favorites :)'), $this->user->nickname);
 203             }
 204         }
 205         else {
 206                 // TRANS: Text displayed instead of favourite notices for a user that has no favourites while not logged in.
 207                 // TRANS: %s is a username, %%%%action.register%%%% is a link to the user registration page.
 208                 // TRANS: (link text)[link] is a Mark Down link.
 209             $message = sprintf(_('%s hasn\'t added any favorite notices yet. Why not [register an account](%%%%action.register%%%%) and then post something interesting they would add to their favorites :)'), $this->user->nickname);
 210         }
 211
 212         $this->elementStart('div', 'guide');
 213         $this->raw(common_markup_to_html($message));
 214         $this->elementEnd('div');
 215     }
 216
 217     /**
 218      * Show the content
 219      *
 220      * A list of notices that this user has marked as a favorite
 221      *
 222      * @return void
 223      */
 224     function showContent()
 225     {
 226         $nl = new FavoritesNoticeList($this->notice, $this);
 227
 228         $cnt = $nl->show();
 229         if (0 == $cnt) {
 230             $this->showEmptyListMessage();
 231         }
 232
 233         $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
 234                           $this->page, 'showfavorites',
 235                           array('nickname' => $this->user->nickname));
 236     }
 237
 238     function showPageNotice() {
 239         // TRANS: Page notice for show favourites page.
 240         $this->element('p', 'instructions', _('This is a way to share what you like.'));
 241     }
 242 }
 243
 244 class FavoritesNoticeList extends NoticeList
 245 {
 246     function newListItem($notice)
 247     {
 248         return new FavoritesNoticeListItem($notice, $this->out);
 249     }
 250 }
 251
 252 // All handled by superclass
 253 class FavoritesNoticeListItem extends DoFollowListItem
 254 {
 255 }