]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - actions/public.php
Use array_merge instead of array_replace (same effect, and array_merge works with...
[quix0rs-gnu-social.git] / actions / public.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Action for displaying the public stream
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   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/publicgroupnav.php';
35 require_once INSTALLDIR.'/lib/noticelist.php';
36 require_once INSTALLDIR.'/lib/feedlist.php';
37
38 // Farther than any human will go
39
40 define('MAX_PUBLIC_PAGE', 100);
41
42 /**
43  * Action for displaying the public stream
44  *
45  * @category Public
46  * @package  StatusNet
47  * @author   Evan Prodromou <evan@status.net>
48  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
49  * @link     http://status.net/
50  *
51  * @see      PublicrssAction
52  * @see      PublicxrdsAction
53  */
54 class PublicAction extends Action
55 {
56     /**
57      * page of the stream we're on; default = 1
58      */
59
60     var $page = null;
61     var $notice;
62     var $userProfile = null;
63
64     function isReadOnly($args)
65     {
66         return true;
67     }
68
69     /**
70      * Read and validate arguments
71      *
72      * @param array $args URL parameters
73      *
74      * @return boolean success value
75      */
76     function prepare($args)
77     {
78         parent::prepare($args);
79         $this->page = ($this->arg('page')) ? ($this->arg('page')+0) : 1;
80
81         if ($this->page > MAX_PUBLIC_PAGE) {
82             // TRANS: Client error displayed when requesting a public timeline page beyond the page limit.
83             // TRANS: %s is the page limit.
84             $this->clientError(sprintf(_('Beyond the page limit (%s).'), MAX_PUBLIC_PAGE));
85         }
86
87         common_set_returnto($this->selfUrl());
88
89         $this->userProfile = Profile::current();
90
91         $stream = new ThreadingPublicNoticeStream($this->userProfile);
92
93         $this->notice = $stream->getNotices(($this->page-1)*NOTICES_PER_PAGE,
94                                             NOTICES_PER_PAGE + 1);
95
96         if (!$this->notice) {
97             // TRANS: Server error displayed when a public timeline cannot be retrieved.
98             $this->serverError(_('Could not retrieve public timeline.'));
99             return;
100         }
101
102         if($this->page > 1 && $this->notice->N == 0){
103             // TRANS: Server error when page not found (404).
104             $this->serverError(_('No such page.'),$code=404);
105         }
106
107         return true;
108     }
109
110     /**
111      * handle request
112      *
113      * Show the public stream, using recipe method showPage()
114      *
115      * @param array $args arguments, mostly unused
116      *
117      * @return void
118      */
119     function handle($args)
120     {
121         parent::handle($args);
122
123         $this->showPage();
124     }
125
126     /**
127      * Title of the page
128      *
129      * @return page title, including page number if over 1
130      */
131     function title()
132     {
133         if ($this->page > 1) {
134             // TRANS: Title for all public timeline pages but the first.
135             // TRANS: %d is the page number.
136             return sprintf(_('Public timeline, page %d'), $this->page);
137         } else {
138             // TRANS: Title for the first public timeline page.
139             return _('Public timeline');
140         }
141     }
142
143     function extraHead()
144     {
145         parent::extraHead();
146         $this->element('meta', array('http-equiv' => 'X-XRDS-Location',
147                                            'content' => common_local_url('publicxrds')));
148
149         $rsd = common_local_url('rsd');
150
151         // RSD, http://tales.phrasewise.com/rfc/rsd
152
153         $this->element('link', array('rel' => 'EditURI',
154                                      'type' => 'application/rsd+xml',
155                                      'href' => $rsd));
156     }
157
158     /**
159      * Output <head> elements for RSS and Atom feeds
160      *
161      * @return void
162      */
163     function getFeeds()
164     {
165         return array(new Feed(Feed::JSON,
166                               common_local_url('ApiTimelinePublic',
167                                                array('format' => 'as')),
168                               // TRANS: Link description for public timeline feed.
169                               _('Public Timeline Feed (Activity Streams JSON)')),
170                     new Feed(Feed::RSS1, common_local_url('publicrss'),
171                               // TRANS: Link description for public timeline feed.
172                               _('Public Timeline Feed (RSS 1.0)')),
173                      new Feed(Feed::RSS2,
174                               common_local_url('ApiTimelinePublic',
175                                                array('format' => 'rss')),
176                               // TRANS: Link description for public timeline feed.
177                               _('Public Timeline Feed (RSS 2.0)')),
178                      new Feed(Feed::ATOM,
179                               common_local_url('ApiTimelinePublic',
180                                                array('format' => 'atom')),
181                               // TRANS: Link description for public timeline feed.
182                               _('Public Timeline Feed (Atom)')));
183     }
184
185     function showEmptyList()
186     {
187         // TRANS: Text displayed for public feed when there are no public notices.
188         $message = _('This is the public timeline for %%site.name%% but no one has posted anything yet.') . ' ';
189
190         if (common_logged_in()) {
191             // TRANS: Additional text displayed for public feed when there are no public notices for a logged in user.
192             $message .= _('Be the first to post!');
193         }
194         else {
195             if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
196                 // TRANS: Additional text displayed for public feed when there are no public notices for a not logged in user.
197                 $message .= _('Why not [register an account](%%action.register%%) and be the first to post!');
198             }
199         }
200
201         $this->elementStart('div', 'guide');
202         $this->raw(common_markup_to_html($message));
203         $this->elementEnd('div');
204     }
205
206     /**
207      * Fill the content area
208      *
209      * Shows a list of the notices in the public stream, with some pagination
210      * controls.
211      *
212      * @return void
213      */
214     function showContent()
215     {
216         $nl = new ThreadedNoticeList($this->notice, $this, $this->userProfile);
217
218         $cnt = $nl->show();
219
220         if ($cnt == 0) {
221             $this->showEmptyList();
222         }
223
224         $this->pagination($this->page > 1, $cnt > NOTICES_PER_PAGE,
225                           $this->page, 'public');
226     }
227
228     function showSections()
229     {
230         // Show invite button, as long as site isn't closed, and
231         // we have a logged in user.
232         if (!common_config('site', 'closed') && common_logged_in()) {
233             if (!common_config('site', 'private')) {
234                 $ibs = new InviteButtonSection(
235                     $this,
236                     // TRANS: Button text for inviting more users to the StatusNet instance.
237                     // TRANS: Less business/enterprise-oriented language for public sites.
238                     _m('BUTTON', 'Send invite')
239                 );
240             } else {
241                 $ibs = new InviteButtonSection($this);
242             }
243             $ibs->show();
244         }
245
246         $pop = new PopularNoticeSection($this);
247         $pop->show();
248         if (!common_config('performance', 'high')) {
249             $cloud = new PublicTagCloudSection($this);
250             $cloud->show();
251         }
252         $feat = new FeaturedUsersSection($this);
253         $feat->show();
254     }
255
256     function showAnonymousMessage()
257     {
258         if (! (common_config('site','closed') || common_config('site','inviteonly'))) {
259             // TRANS: Message for not logged in users at an invite-only site trying to view the public feed of notices.
260             // TRANS: This message contains Markdown links. Please mind the formatting.
261             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
262                    'based on the Free Software [StatusNet](http://status.net/) tool. ' .
263                    '[Join now](%%action.register%%) to share notices about yourself with friends, family, and colleagues! ' .
264                    '([Read more](%%doc.help%%))');
265         } else {
266             // TRANS: Message for not logged in users at a closed site trying to view the public feed of notices.
267             // TRANS: This message contains Markdown links. Please mind the formatting.
268             $m = _('This is %%site.name%%, a [micro-blogging](http://en.wikipedia.org/wiki/Micro-blogging) service ' .
269                    'based on the Free Software [StatusNet](http://status.net/) tool.');
270         }
271         $this->elementStart('div', array('id' => 'anon_notice'));
272         $this->raw(common_markup_to_html($m));
273         $this->elementEnd('div');
274     }
275 }
276
277 class ThreadingPublicNoticeStream extends ThreadingNoticeStream
278 {
279     function __construct($profile)
280     {
281         parent::__construct(new PublicNoticeStream($profile));
282     }
283 }