actions/favorited.php

   1 <?php
   2 /**
   3  * Laconica, the distributed open-source microblogging tool
   4  *
   5  * List of popular notices
   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  Public
  23  * @package   Laconica
  24  * @author    Zach Copley <zach@controlyourself.ca>
  25  * @author    Evan Prodromou <evan@controlyourself.ca>
  26  * @copyright 2008-2009 Control Yourself, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://laconi.ca/
  29  */
  30
  31 if (!defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/publicgroupnav.php';
  36 require_once INSTALLDIR.'/lib/noticelist.php';
  37
  38 /**
  39  * List of popular notices
  40  *
  41  * We provide a list of the most popular notices. Popularity
  42  * is measured by
  43  *
  44  * @category Personal
  45  * @package  Laconica
  46  * @author   Zach Copley <zach@controlyourself.ca>
  47  * @author   Evan Prodromou <evan@controlyourself.ca>
  48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  49  * @link     http://laconi.ca/
  50  */
  51
  52 class FavoritedAction extends Action
  53 {
  54     var $page = null;
  55
  56     /**
  57      * Title of the page
  58      *
  59      * @return string Title of the page
  60      */
  61
  62     function title()
  63     {
  64         if ($this->page == 1) {
  65             return _('Popular notices');
  66         } else {
  67             return sprintf(_('Popular notices, page %d'), $this->page);
  68         }
  69     }
  70
  71     /**
  72      * Instructions for use
  73      *
  74      * @return instructions for use
  75      */
  76
  77     function getInstructions()
  78     {
  79         return _('The most popular notices on the site right now.');
  80     }
  81
  82     /**
  83      * Is this page read-only?
  84      *
  85      * @return boolean true
  86      */
  87
  88     function isReadOnly()
  89     {
  90         return true;
  91     }
  92
  93     /**
  94      * Take arguments for running
  95      *
  96      * @param array $args $_REQUEST args
  97      *
  98      * @return boolean success flag
  99      *
 100      * @todo move queries from showContent() to here
 101      */
 102
 103     function prepare($args)
 104     {
 105         parent::prepare($args);
 106         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
 107
 108         common_set_returnto($this->selfUrl());
 109
 110         return true;
 111     }
 112
 113     /**
 114      * Handle request
 115      *
 116      * Shows a page with list of favorite notices
 117      *
 118      * @param array $args $_REQUEST args; handled in prepare()
 119      *
 120      * @return void
 121      */
 122
 123     function handle($args)
 124     {
 125         parent::handle($args);
 126
 127         $this->showPage();
 128     }
 129
 130     /**
 131      * Show the page notice
 132      *
 133      * Shows instructions for the page
 134      *
 135      * @return void
 136      */
 137
 138     function showPageNotice()
 139     {
 140         $instr  = $this->getInstructions();
 141         $output = common_markup_to_html($instr);
 142
 143         $this->elementStart('div', 'instructions');
 144         $this->raw($output);
 145         $this->elementEnd('div');
 146     }
 147
 148     /**
 149      * Local navigation
 150      *
 151      * This page is part of the public group, so show that.
 152      *
 153      * @return void
 154      */
 155
 156     function showLocalNav()
 157     {
 158         $nav = new PublicGroupNav($this);
 159         $nav->show();
 160     }
 161
 162     /**
 163      * Content area
 164      *
 165      * Shows the list of popular notices
 166      *
 167      * @return void
 168      */
 169
 170     function showContent()
 171     {
 172         $qry = 'SELECT notice.*, '.
 173           'sum(exp(-(now() - fave.modified) / %s)) as weight ' .
 174           'FROM notice JOIN fave ON notice.id = fave.notice_id ' .
 175           'GROUP BY fave.notice_id ' .
 176           'ORDER BY weight DESC';
 177
 178         $offset = ($this->page - 1) * NOTICES_PER_PAGE;
 179         $limit  = NOTICES_PER_PAGE + 1;
 180
 181         if (common_config('db', 'type') == 'pgsql') {
 182             $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
 183         } else {
 184             $qry .= ' LIMIT ' . $offset . ', ' . $limit;
 185         }
 186
 187         $notice = Memcached_DataObject::cachedQuery('Notice',
 188                                                     sprintf($qry, common_config('popular', 'dropoff')),
 189                                                     600);
 190
 191         $nl = new NoticeList($notice, $this);
 192
 193         $cnt = $nl->show();
 194
 195         $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
 196                           $this->page, 'favorited');
 197     }
 198
 199     /**
 200      * Output document relationship links
 201      *
 202      * @return void
 203      */
 204     function showRelationshipLinks()
 205     {
 206         $this->sequenceRelationships($this->page > 1, $this->count > NOTICES_PER_PAGE, // FIXME
 207                                      $this->page, 'favorited');
 208     }
 209 }