Update favorited for new layout and framework

actions/favorited.php

@@ -1,105 +1,196 @@
 <?php
-/*
+/**
- * Laconica - a distributed open-source microblogging tool
+ * Laconica, the distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
  *
- * This program is free software: you can redistribute it and/or modify
+ * List of popular notices
+ *
+ * PHP version 5
+ *
+ * LICENCE: This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Affero General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Affero General Public License for more details.
  *
  * You should have received a copy of the GNU Affero General Public License
- * along with this program.     If not, see <http://www.gnu.org/licenses/>.
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * @category  Public
+ * @package   Laconica
+ * @author    Zach Copley <zach@controlyourself.ca>
+ * @author    Evan Prodromou <evan@controlyourself.ca>
+ * @copyright 2008-2009 Control Yourself, Inc.
+ * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link      http://laconi.ca/
  */
 
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('LACONICA')) {
+    exit(1);
+}
 
-require_once(INSTALLDIR.'/lib/stream.php');
+require_once INSTALLDIR.'/lib/publicgroupnav.php';
+require_once INSTALLDIR.'/lib/noticelist.php';
 
-class FavoritedAction extends StreamAction
+/**
+ * List of popular notices
+ *
+ * We provide a list of the most popular notices. Popularity
+ * is measured by
+ *
+ * @category Personal
+ * @package  Laconica
+ * @author   Zach Copley <zach@controlyourself.ca>
+ * @author   Evan Prodromou <evan@controlyourself.ca>
+ * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link     http://laconi.ca/
+ */
+
+class FavoritedAction extends Action
 {
+    var $page = null;
+
+    /**
+     * Title of the page
+     *
+     * @return string Title of the page
+     */
+
+    function title()
+    {
+        if ($this->page == 1) {
+            return _('Popular notices');
+        } else {
+            return sprintf(_('Popular notices, page %d'), $this->page);
+        }
+    }
+
+    /**
+     * Instructions for use
+     *
+     * @return instructions for use
+     */
+
+    function getInstructions()
+    {
+        return _('The most popular notices on the site right now.');
+    }
+
+    /**
+     * Is this page read-only?
+     *
+     * @return boolean true
+     */
+
+    function isReadOnly()
+    {
+        return true;
+    }
+
+    /**
+     * Take arguments for running
+     *
+     * @param array $args $_REQUEST args
+     *
+     * @return boolean success flag
+     *
+     * @todo move queries from showContent() to here
+     */
+
+    function prepare($args)
+    {
+        parent::prepare($args);
+        $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
+        return true;
+    }
+
+    /**
+     * Handle request
+     *
+     * Shows a page with list of favorite notices
+     *
+     * @param array $args $_REQUEST args; handled in prepare()
+     *
+     * @return void
+     */
 
     function handle($args)
     {
         parent::handle($args);
 
-        $page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
+        $this->showPage();
-
-        common_show_header(_('Popular notices'),
-                           array($this, 'show_header'), null,
-                           array($this, 'show_top'));
-
-        $this->show_notices($page);
-
-        common_show_footer();
     }
 
-    function show_top()
+    /**
+     * Show the page notice
+     *
+     * Shows instructions for the page
+     *
+     * @return void
+     */
+
+    function showPageNotice()
     {
-        $instr = $this->get_instructions();
+        $instr  = $this->getInstructions();
         $output = common_markup_to_html($instr);
+
         $this->elementStart('div', 'instructions');
         $this->raw($output);
         $this->elementEnd('div');
-        $this->public_views_menu();
     }
 
-    function show_header()
+    /**
+     * Local navigation
+     *
+     * This page is part of the public group, so show that.
+     *
+     * @return void
+     */
+
+    function showLocalNav()
     {
-        return;
+        $nav = new PublicGroupNav($this);
+        $nav->show();
     }
 
-    function get_instructions()
+    /**
+     * Content area
+     *
+     * Shows the list of popular notices
+     *
+     * @return void
+     */
+
+    function showContent()
     {
-        return _('Showing recently popular notices');
+        $qry = 'SELECT notice.*, '.
-    }
+          'sum(exp(-(now() - fave.modified) / %s)) as weight ' .
+          'FROM notice JOIN fave ON notice.id = fave.notice_id ' .
+          'GROUP BY fave.notice_id ' .
+          'ORDER BY weight DESC';
 
-    function show_notices($page)
+        $offset = ($this->page - 1) * NOTICES_PER_PAGE;
-    {
+        $limit  = NOTICES_PER_PAGE + 1;
 
-        $qry = 'SELECT notice.*, sum(exp(-(now() - fave.modified) / %s)) as weight ' .
+        if (common_config('db', 'type') == 'pgsql') {
-                'FROM notice JOIN fave ON notice.id = fave.notice_id ' .
-                'GROUP BY fave.notice_id ' .
-                'ORDER BY weight DESC';
-
-        $offset = ($page - 1) * NOTICES_PER_PAGE;
-        $limit = NOTICES_PER_PAGE + 1;
-
-        if (common_config('db','type') == 'pgsql') {
             $qry .= ' LIMIT ' . $limit . ' OFFSET ' . $offset;
         } else {
             $qry .= ' LIMIT ' . $offset . ', ' . $limit;
         }
 
-        # Figure out how to cache this query
+        // XXX: Figure out how to cache this query
 
         $notice = new Notice;
         $notice->query(sprintf($qry, common_config('popular', 'dropoff')));
 
-        $this->elementStart('ul', array('id' => 'notices'));
+        $nl = new NoticeList($notice, $this);
 
-        $cnt = 0;
+        $cnt = $nl->show();
 
-        while ($notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
+        $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
-            $cnt++;
+                          $this->page, 'favorited');
-
-            if ($cnt > NOTICES_PER_PAGE) {
-                break;
-            }
-
-            $item = new NoticeListItem($notice);
-            $item->show();
-        }
-
-        $this->elementEnd('ul');
-
-        common_pagination($page > 1, $cnt > NOTICES_PER_PAGE,
-                          $page, 'favorited');
     }
-
 }