<?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * Laconica, the distributed open-source microblogging tool
*
- * This program is free software: you can redistribute it and/or modify
+ * Action for displaying the public stream
+ *
+ * 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.
*
* 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/>.
+ *
+ * @category Public
+ * @package Laconica
+ * @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);
+}
+
+require_once INSTALLDIR.'/lib/publicgroupnav.php';
+require_once INSTALLDIR.'/lib/noticelist.php';
+require_once INSTALLDIR.'/lib/feedlist.php';
+
+/**
+ * Action for displaying the public stream
+ *
+ * @category Public
+ * @package Laconica
+ * @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/
+ *
+ * @see PublicrssAction
+ * @see PublicxrdsAction
*/
-if (!defined('LACONICA')) { exit(1); }
+class PublicAction extends Action
+{
+ /**
+ * page of the stream we're on; default = 1
+ */
+
+ var $page = null;
+
+ /**
+ * Number of notices being shown on this page.
+ */
+ // Does this need to be here? Should it be?
+ // If it does, this property needs to be
+ // added to other actions as well, like $page.
+ // I'm trying to find a way to capture the
+ // output of the $cnt variable from this
+ // action's showContent() method but need
+ // to do so earlier, I think...?
+ var $count = null;
-require_once(INSTALLDIR.'/lib/stream.php');
+ function isReadOnly()
+ {
+ return true;
+ }
-class PublicAction extends StreamAction {
+ /**
+ * Read and validate arguments
+ *
+ * @param array $args URL parameters
+ *
+ * @return boolean success value
+ */
- function handle($args) {
- parent::handle($args);
+ function prepare($args)
+ {
+ parent::prepare($args);
+ $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
- $page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
+ common_set_returnto($this->selfUrl());
- header('X-XRDS-Location: '. common_local_url('publicxrds'));
+ return true;
+ }
- common_show_header(_('Public timeline'),
- array($this, 'show_header'), NULL,
- array($this, 'show_top'));
+ /**
+ * handle request
+ *
+ * Show the public stream, using recipe method showPage()
+ *
+ * @param array $args arguments, mostly unused
+ *
+ * @return void
+ */
- # XXX: Public sidebar here?
+ function handle($args)
+ {
+ parent::handle($args);
- $this->show_notices($page);
+ header('X-XRDS-Location: '. common_local_url('publicxrds'));
- common_show_footer();
- }
+ $this->showPage();
+ }
- function show_top() {
- if (common_logged_in()) {
- common_notice_form('public');
- } else {
- $instr = $this->get_instructions();
- $output = common_markup_to_html($instr);
- common_element_start('div', 'instructions');
- common_raw($output);
- common_element_end('div');
- }
+ /**
+ * Title of the page
+ *
+ * @return page title, including page number if over 1
+ */
- $this->public_views_menu();
+ function title()
+ {
+ if ($this->page > 1) {
+ return sprintf(_('Public timeline, page %d'), $this->page);
+ } else {
+ return _('Public timeline');
+ }
+ }
- $this->show_feeds_list(array(0=>array('href'=>common_local_url('publicrss'),
- 'type' => 'rss',
- 'version' => 'RSS 1.0',
- 'item' => 'publicrss'),
- 1=>array('href'=>common_local_url('publicatom'),
- 'type' => 'atom',
- 'version' => 'Atom 1.0',
- 'item' => 'publicatom')));
- }
+ /**
+ * Output <head> elements for RSS and Atom feeds
+ *
+ * @return void
+ */
- function get_instructions() {
- return _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
- 'based on the Free Software [Laconica](http://laconi.ca/) tool. ' .
- '[Join now](%%action.register%%) to share notices about yourself with friends, family, and colleagues! ([Read more](%%doc.help%%))');
- }
+ function getFeeds()
+ {
+ return array(new Feed(Feed::RSS1, common_local_url('publicrss'),
+ _('Public Stream Feed (RSS 1.0)')),
+ new Feed(Feed::RSS2,
+ common_local_url('api',
+ array('apiaction' => 'statuses',
+ 'method' => 'public_timeline.rss')),
+ _('Public Stream Feed (RSS 2.0)')),
+ new Feed(Feed::ATOM,
+ common_local_url('api',
+ array('apiaction' => 'statuses',
+ 'method' => 'public_timeline.atom')),
+ _('Public Stream Feed (Atom)')));
+ }
- function show_header() {
- common_element('link', array('rel' => 'alternate',
- 'href' => common_local_url('publicrss'),
- 'type' => 'application/rss+xml',
- 'title' => _('Public Stream Feed')));
- # for client side of OpenID authentication
- common_element('meta', array('http-equiv' => 'X-XRDS-Location',
- 'content' => common_local_url('publicxrds')));
- }
+ /**
+ * Output document relationship links
+ *
+ * @return void
+ */
+ function showRelationshipLinks()
+ {
+ $this->sequenceRelationships($this->page > 1, $this->count > NOTICES_PER_PAGE, // FIXME
+ $this->page, 'public');
+ }
- function show_notices($page) {
+ /**
+ * Extra head elements
+ *
+ * We include a <meta> element linking to the publicxrds page, for OpenID
+ * client-side authentication.
+ *
+ * @return void
+ */
- $cnt = 0;
- $notice = Notice::publicStream(($page-1)*NOTICES_PER_PAGE,
- NOTICES_PER_PAGE + 1);
+ function extraHead()
+ {
+ // for client side of OpenID authentication
+ $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
+ 'content' => common_local_url('publicxrds')));
+ }
- if (!$notice) {
- $this->server_error(_('Could not retrieve public stream.'));
+ /**
+ * Show tabset for this page
+ *
+ * Uses the PublicGroupNav widget
+ *
+ * @return void
+ * @see PublicGroupNav
+ */
+
+ function showLocalNav()
+ {
+ $nav = new PublicGroupNav($this);
+ $nav->show();
+ }
+
+ function showEmptyList()
+ {
+ $message = _('This is the public timeline for %%site.name%% but no one has posted anything yet.') . ' ';
+
+ if (common_logged_in()) {
+ $message .= _('Be the first to post!');
+ }
+ else {
+ $message .= _('Why not [register an account](%%action.register%%) and be the first to post!');
+ }
+
+ $this->elementStart('div', 'guide');
+ $this->raw(common_markup_to_html($message));
+ $this->elementEnd('div');
+ }
+
+ /**
+ * Fill the content area
+ *
+ * Shows a list of the notices in the public stream, with some pagination
+ * controls.
+ *
+ * @return void
+ */
+
+ function showContent()
+ {
+ $notice = Notice::publicStream(($this->page-1)*NOTICES_PER_PAGE,
+ NOTICES_PER_PAGE + 1);
+
+ if (!$notice) {
+ $this->serverError(_('Could not retrieve public stream.'));
return;
- }
+ }
+
+ $nl = new NoticeList($notice, $this);
+
+ $cnt = $nl->show();
+
+ if ($cnt == 0) {
+ $this->showEmptyList();
+ }
+
+ $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
+ $this->page, 'public');
+ }
- $cnt = $this->show_notice_list($notice);
+ function showSections()
+ {
+ // $top = new TopPostersSection($this);
+ // $top->show();
+ $pop = new PopularNoticeSection($this);
+ $pop->show();
+ $gbp = new GroupsByPostsSection($this);
+ $gbp->show();
+ $feat = new FeaturedUsersSection($this);
+ $feat->show();
+ }
- common_pagination($page > 1, $cnt > NOTICES_PER_PAGE,
- $page, 'public');
- }
+ function showAnonymousMessage()
+ {
+ if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
+ $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
+ 'based on the Free Software [Laconica](http://laconi.ca/) tool. ' .
+ '[Join now](%%action.register%%) to share notices about yourself with friends, family, and colleagues! ([Read more](%%doc.help%%))');
+ } else {
+ $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
+ 'based on the Free Software [Laconica](http://laconi.ca/) tool.');
+ }
+ $this->elementStart('div', array('id' => 'anon_notice'));
+ $this->raw(common_markup_to_html($m));
+ $this->elementEnd('div');
+ }
}
projects / quix0rs-gnu-social.git / blobdiff