3 * StatusNet, the distributed open-source microblogging tool
5 * Action for displaying the public stream
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.
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.
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/>.
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/
30 if (!defined('GNUSOCIAL')) { exit(1); }
32 // Farther than any human will go
34 define('MAX_PUBLIC_PAGE', 100);
37 * Action for displaying the public stream
41 * @author Evan Prodromou <evan@status.net>
42 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
43 * @link http://status.net/
45 * @see PublicrssAction
46 * @see PublicxrdsAction
48 class PublicAction extends Action
51 * page of the stream we're on; default = 1
56 var $userProfile = null;
58 function isReadOnly(array $args=array())
64 * Read and validate arguments
66 * @param array $args URL parameters
68 * @return boolean success value
70 function prepare(array $args=array())
72 parent::prepare($args);
73 $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
75 if ($this->page > MAX_PUBLIC_PAGE) {
76 // TRANS: Client error displayed when requesting a public timeline page beyond the page limit.
77 // TRANS: %s is the page limit.
78 $this->clientError(sprintf(_('Beyond the page limit (%s).'), MAX_PUBLIC_PAGE));
81 common_set_returnto($this->selfUrl());
83 $this->userProfile = Profile::current();
85 $user = common_current_user();
87 if (!empty($user) && $user->streamModeOnly()) {
88 $stream = new PublicNoticeStream($this->userProfile);
90 $stream = new ThreadingPublicNoticeStream($this->userProfile);
93 $this->notice = $stream->getNotices(($this->page-1)*NOTICES_PER_PAGE,
94 NOTICES_PER_PAGE + 1);
97 // TRANS: Server error displayed when a public timeline cannot be retrieved.
98 $this->serverError(_('Could not retrieve public timeline.'));
101 if($this->page > 1 && $this->notice->N == 0){
102 // TRANS: Server error when page not found (404).
103 $this->serverError(_('No such page.'),$code=404);
112 * Show the public stream, using recipe method showPage()
114 * @param array $args arguments, mostly unused
118 function handle(array $args=array())
120 parent::handle($args);
128 * @return page title, including page number if over 1
132 if ($this->page > 1) {
133 // TRANS: Title for all public timeline pages but the first.
134 // TRANS: %d is the page number.
135 return sprintf(_('Public timeline, page %d'), $this->page);
137 // TRANS: Title for the first public timeline page.
138 return _('Public timeline');
145 $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
146 'content' => common_local_url('publicxrds')));
148 $rsd = common_local_url('rsd');
150 // RSD, http://tales.phrasewise.com/rfc/rsd
152 $this->element('link', array('rel' => 'EditURI',
153 'type' => 'application/rsd+xml',
156 if ($this->page != 1) {
157 $this->element('link', array('rel' => 'canonical',
158 'href' => common_local_url('public')));
163 * Output <head> elements for RSS and Atom feeds
169 return array(new Feed(Feed::JSON,
170 common_local_url('ApiTimelinePublic',
171 array('format' => 'as')),
172 // TRANS: Link description for public timeline feed.
173 _('Public Timeline Feed (Activity Streams JSON)')),
174 new Feed(Feed::RSS1, common_local_url('publicrss'),
175 // TRANS: Link description for public timeline feed.
176 _('Public Timeline Feed (RSS 1.0)')),
178 common_local_url('ApiTimelinePublic',
179 array('format' => 'rss')),
180 // TRANS: Link description for public timeline feed.
181 _('Public Timeline Feed (RSS 2.0)')),
183 common_local_url('ApiTimelinePublic',
184 array('format' => 'atom')),
185 // TRANS: Link description for public timeline feed.
186 _('Public Timeline Feed (Atom)')));
189 function showEmptyList()
191 // TRANS: Text displayed for public feed when there are no public notices.
192 $message = _('This is the public timeline for %%site.name%% but no one has posted anything yet.') . ' ';
194 if (common_logged_in()) {
195 // TRANS: Additional text displayed for public feed when there are no public notices for a logged in user.
196 $message .= _('Be the first to post!');
199 if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
200 // TRANS: Additional text displayed for public feed when there are no public notices for a not logged in user.
201 $message .= _('Why not [register an account](%%action.register%%) and be the first to post!');
205 $this->elementStart('div', 'guide');
206 $this->raw(common_markup_to_html($message));
207 $this->elementEnd('div');
211 * Fill the content area
213 * Shows a list of the notices in the public stream, with some pagination
218 function showContent()
220 $user = common_current_user();
222 if (!empty($user) && $user->streamModeOnly()) {
223 $nl = new NoticeList($this->notice, $this);
225 $nl = new ThreadedNoticeList($this->notice, $this, $this->userProfile);
231 $this->showEmptyList();
234 $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
235 $this->page, 'public');
238 function showSections()
240 // Show invite button, as long as site isn't closed, and
241 // we have a logged in user.
242 if (common_config('invite', 'enabled') && !common_config('site', 'closed') && common_logged_in()) {
243 if (!common_config('site', 'private')) {
244 $ibs = new InviteButtonSection(
246 // TRANS: Button text for inviting more users to the StatusNet instance.
247 // TRANS: Less business/enterprise-oriented language for public sites.
248 _m('BUTTON', 'Send invite')
251 $ibs = new InviteButtonSection($this);
256 $p = Profile::current();
258 if (!common_config('performance', 'high')) {
259 $cloud = new PublicTagCloudSection($this);
262 $feat = new FeaturedUsersSection($this);
266 function showAnonymousMessage()
268 if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
269 // TRANS: Message for not logged in users at an invite-only site trying to view the public feed of notices.
270 // TRANS: This message contains Markdown links. Please mind the formatting.
271 $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
272 'based on the Free Software [StatusNet](http://status.net/) tool. ' .
273 '[Join now](%%action.register%%) to share notices about yourself with friends, family, and colleagues! ' .
274 '([Read more](%%doc.help%%))');
276 // TRANS: Message for not logged in users at a closed site trying to view the public feed of notices.
277 // TRANS: This message contains Markdown links. Please mind the formatting.
278 $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
279 'based on the Free Software [StatusNet](http://status.net/) tool.');
281 $this->elementStart('div', array('id' => 'anon_notice'));
282 $this->raw(common_markup_to_html($m));
283 $this->elementEnd('div');
287 class ThreadingPublicNoticeStream extends ThreadingNoticeStream
289 function __construct($profile)
291 parent::__construct(new PublicNoticeStream($profile));