]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/action.php
Merge branch 'quitagram' into nightly
[quix0rs-gnu-social.git] / lib / action.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Base class for all actions (~views)
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  Action
23  * @package   StatusNet
24  * @author    Evan Prodromou <evan@status.net>
25  * @author    Sarven Capadisli <csarven@status.net>
26  * @copyright 2008 StatusNet, Inc.
27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28  * @link      http://status.net/
29  */
30
31 if (!defined('GNUSOCIAL')) { exit(1); }
32
33 /**
34  * Base class for all actions
35  *
36  * This is the base class for all actions in the package. An action is
37  * more or less a "view" in an MVC framework.
38  *
39  * Actions are responsible for extracting and validating parameters; using
40  * model classes to read and write to the database; and doing ouput.
41  *
42  * @category Output
43  * @package  StatusNet
44  * @author   Evan Prodromou <evan@status.net>
45  * @author   Sarven Capadisli <csarven@status.net>
46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47  * @link     http://status.net/
48  *
49  * @see      HTMLOutputter
50  */
51 class Action extends HTMLOutputter // lawsuit
52 {
53     // This should be protected/private in the future
54     public $args = array();
55
56     // Action properties, set per-class
57     protected $action = false;
58     protected $ajax   = false;
59     protected $menus  = true;
60     protected $needLogin = false;
61     protected $needPost = false;    // implies canPost if true
62     protected $canPost = false;     // can this action handle POST method?
63
64     // The currently scoped profile (normally Profile::current; from $this->auth_user for API)
65     protected $scoped = null;
66
67     // Related to front-end user representation
68     protected $format = null;
69     protected $error  = null;
70     protected $msg    = null;
71
72     /**
73      * Constructor
74      *
75      * Just wraps the HTMLOutputter constructor.
76      *
77      * @param string  $output URI to output to, default = stdout
78      * @param boolean $indent Whether to indent output, default true
79      *
80      * @see XMLOutputter::__construct
81      * @see HTMLOutputter::__construct
82      */
83     function __construct($output='php://output', $indent=null)
84     {
85         parent::__construct($output, $indent);
86     }
87
88     function getError()
89     {
90         return $this->error;
91     }
92
93     function getInfo()
94     {
95         return $this->msg;
96     }
97
98     static public function run(array $args=array(), $output='php://output', $indent=null) {
99         $class = get_called_class();
100         $action = new $class($output, $indent);
101         $action->execute($args);
102         return $action;
103     }
104
105     public function execute(array $args=array()) {
106         // checkMirror stuff
107         if (common_config('db', 'mirror') && $this->isReadOnly($args)) {
108             if (is_array(common_config('db', 'mirror'))) {
109                 // "load balancing", ha ha
110                 $arr = common_config('db', 'mirror');
111                 $k = array_rand($arr);
112                 $mirror = $arr[$k];
113             } else {
114                 $mirror = common_config('db', 'mirror');
115             }
116
117             // everyone else uses the mirror
118             common_config_set('db', 'database', $mirror);
119         }
120
121         if (Event::handle('StartActionExecute', array($this, &$args))) {
122             $prepared = $this->prepare($args);
123             if ($prepared) {
124                 $this->handle($args);
125             } else {
126                 common_debug('Prepare failed for Action.');
127             }
128         }
129
130         $this->flush();
131
132         Event::handle('EndActionExecute', array($this));
133     }
134
135     /**
136      * For initializing members of the class.
137      *
138      * @param array $argarray misc. arguments
139      *
140      * @return boolean true
141      */
142     protected function prepare(array $args=array())
143     {
144         if ($this->needPost && !$this->isPost()) {
145             // TRANS: Client error. POST is a HTTP command. It should not be translated.
146             $this->clientError(_('This method requires a POST.'), 405);
147         }
148
149         // needPost, of course, overrides canPost if true
150         if (!$this->canPost) {
151             $this->canPost = $this->needPost;
152         }
153
154         $this->args = common_copy_args($args);
155
156         // This could be set with get_called_action and then
157         // chop off 'Action' from the class name. In lower case.
158         $this->action = strtolower($this->trimmed('action'));
159
160         if ($this->ajax || $this->boolean('ajax')) {
161             // check with GNUsocial::isAjax()
162             GNUsocial::setAjax(true);
163         }
164
165         if ($this->needLogin) {
166             $this->checkLogin(); // if not logged in, this redirs/excepts
167         }
168
169         $this->updateScopedProfile();
170
171         return true;
172     }
173
174     public function updateScopedProfile()
175     {
176         $this->scoped = Profile::current();
177         return $this->scoped;
178     }
179
180     public function getScoped()
181     {
182         return ($this->scoped instanceof Profile) ? $this->scoped : null;
183     }
184
185     // Must be run _after_ prepare
186     public function getActionName()
187     {
188         return $this->action;
189     }
190
191     public function isAction(array $names)
192     {
193         foreach ($names as $class) {
194             // PHP is case insensitive, and we have stuff like ApiUpperCaseAction,
195             // but we at least make a point out of wanting to do stuff case-sensitive.
196             $class = ucfirst($class) . 'Action';
197             if ($this instanceof $class) {
198                 return true;
199             }
200         }
201         return false;
202     }
203
204     /**
205      * Show page, a template method.
206      *
207      * @return nothing
208      */
209     function showPage()
210     {
211         if (GNUsocial::isAjax()) {
212             self::showAjax();
213             return;
214         }
215         if (Event::handle('StartShowHTML', array($this))) {
216             $this->startHTML();
217             $this->flush();
218             Event::handle('EndShowHTML', array($this));
219         }
220         if (Event::handle('StartShowHead', array($this))) {
221             $this->showHead();
222             $this->flush();
223             Event::handle('EndShowHead', array($this));
224         }
225         if (Event::handle('StartShowBody', array($this))) {
226             $this->showBody();
227             Event::handle('EndShowBody', array($this));
228         }
229         if (Event::handle('StartEndHTML', array($this))) {
230             $this->endHTML();
231             Event::handle('EndEndHTML', array($this));
232         }
233     }
234
235     public function showAjax()
236     {
237         $this->startHTML('text/xml;charset=utf-8');
238         $this->elementStart('head');
239         // TRANS: Title for conversation page.
240         $this->element('title', null, $this->title());
241         $this->elementEnd('head');
242         $this->elementStart('body');
243         if ($this->getError()) {
244             $this->element('p', array('id'=>'error'), $this->getError());
245         } else {
246             $this->showContent();
247         }
248         $this->elementEnd('body');
249         $this->endHTML();
250     }
251
252     function endHTML()
253     {
254         global $_startTime;
255
256         if (isset($_startTime)) {
257             $endTime = microtime(true);
258             $diff = round(($endTime - $_startTime) * 1000);
259             $this->raw("<!-- ${diff}ms -->");
260         }
261
262         return parent::endHTML();
263     }
264
265     /**
266      * Show head, a template method.
267      *
268      * @return nothing
269      */
270     function showHead()
271     {
272         // XXX: attributes (profile?)
273         $this->elementStart('head');
274         if (Event::handle('StartShowHeadElements', array($this))) {
275             if (Event::handle('StartShowHeadTitle', array($this))) {
276                 $this->showTitle();
277                 Event::handle('EndShowHeadTitle', array($this));
278             }
279             $this->showShortcutIcon();
280             $this->showStylesheets();
281             $this->showOpenSearch();
282             $this->showFeeds();
283             $this->showDescription();
284             $this->extraHead();
285             Event::handle('EndShowHeadElements', array($this));
286         }
287         $this->elementEnd('head');
288     }
289
290     /**
291      * Show title, a template method.
292      *
293      * @return nothing
294      */
295     function showTitle()
296     {
297         $this->element('title', null,
298                        // TRANS: Page title. %1$s is the title, %2$s is the site name.
299                        sprintf(_('%1$s - %2$s'),
300                                $this->title(),
301                                common_config('site', 'name')));
302     }
303
304     /**
305      * Returns the page title
306      *
307      * SHOULD overload
308      *
309      * @return string page title
310      */
311
312     function title()
313     {
314         // TRANS: Page title for a page without a title set.
315         return _('Untitled page');
316     }
317
318     /**
319      * Show themed shortcut icon
320      *
321      * @return nothing
322      */
323     function showShortcutIcon()
324     {
325         if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
326             $this->element('link', array('rel' => 'shortcut icon',
327                                          'href' => Theme::path('favicon.ico')));
328         } else {
329             // favicon.ico should be HTTPS if the rest of the page is
330             $this->element('link', array('rel' => 'shortcut icon',
331                                          'href' => common_path('favicon.ico', GNUsocial::isHTTPS())));
332         }
333
334         if (common_config('site', 'mobile')) {
335             if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
336                 $this->element('link', array('rel' => 'apple-touch-icon',
337                                              'href' => Theme::path('apple-touch-icon.png')));
338             } else {
339                 $this->element('link', array('rel' => 'apple-touch-icon',
340                                              'href' => common_path('apple-touch-icon.png')));
341             }
342         }
343     }
344
345     /**
346      * Show stylesheets
347      *
348      * @return nothing
349      */
350     function showStylesheets()
351     {
352         if (Event::handle('StartShowStyles', array($this))) {
353
354             // Use old name for StatusNet for compatibility on events
355
356             if (Event::handle('StartShowStylesheets', array($this))) {
357                 $this->primaryCssLink(null, 'screen, projection, tv, print');
358                 Event::handle('EndShowStylesheets', array($this));
359             }
360
361             $this->cssLink('js/extlib/jquery-ui/css/smoothness/jquery-ui.css');
362
363             if (Event::handle('StartShowUAStyles', array($this))) {
364                 Event::handle('EndShowUAStyles', array($this));
365             }
366
367             Event::handle('EndShowStyles', array($this));
368
369             if (common_config('custom_css', 'enabled')) {
370                 $css = common_config('custom_css', 'css');
371                 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
372                     if (trim($css) != '') {
373                         $this->style($css);
374                     }
375                     Event::handle('EndShowCustomCss', array($this));
376                 }
377             }
378         }
379     }
380
381     function primaryCssLink($mainTheme=null, $media=null)
382     {
383         $theme = new Theme($mainTheme);
384
385         // Some themes may have external stylesheets, such as using the
386         // Google Font APIs to load webfonts.
387         foreach ($theme->getExternals() as $url) {
388             $this->cssLink($url, $mainTheme, $media);
389         }
390
391         // If the currently-selected theme has dependencies on other themes,
392         // we'll need to load their display.css files as well in order.
393         $baseThemes = $theme->getDeps();
394         foreach ($baseThemes as $baseTheme) {
395             $this->cssLink('css/display.css', $baseTheme, $media);
396         }
397         $this->cssLink('css/display.css', $mainTheme, $media);
398
399         // Additional styles for RTL languages
400         if (is_rtl(common_language())) {
401             if (file_exists(Theme::file('css/rtl.css'))) {
402                 $this->cssLink('css/rtl.css', $mainTheme, $media);
403             }
404         }
405     }
406
407     /**
408      * Show javascript headers
409      *
410      * @return nothing
411      */
412     function showScripts()
413     {
414         if (Event::handle('StartShowScripts', array($this))) {
415             if (Event::handle('StartShowJQueryScripts', array($this))) {
416                 $this->script('extlib/jquery.js');
417                 $this->script('extlib/jquery.form.js');
418                 $this->script('extlib/jquery-ui/jquery-ui.js');
419                 $this->script('extlib/jquery.cookie.js');
420                 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/extlib/json2.js', GNUsocial::isHTTPS()).'"); }');
421
422                 Event::handle('EndShowJQueryScripts', array($this));
423             }
424             if (Event::handle('StartShowStatusNetScripts', array($this))) {
425                 $this->script('util.js');
426                 $this->script('xbImportNode.js');
427                 $this->script('geometa.js');
428
429                 // This route isn't available in single-user mode.
430                 // Not sure why, but it causes errors here.
431                 $this->inlineScript('var _peopletagAC = "' .
432                                     common_local_url('peopletagautocomplete') . '";');
433                 $this->showScriptMessages();
434                 $this->showScriptVariables();
435                 // Anti-framing code to avoid clickjacking attacks in older browsers.
436                 // This will show a blank page if the page is being framed, which is
437                 // consistent with the behavior of the 'X-Frame-Options: SAMEORIGIN'
438                 // header, which prevents framing in newer browser.
439                 if (common_config('javascript', 'bustframes')) {
440                     $this->inlineScript('if (window.top !== window.self) { document.write = ""; window.top.location = window.self.location; setTimeout(function () { document.body.innerHTML = ""; }, 1); window.self.onload = function () { document.body.innerHTML = ""; }; }');
441                 }
442                 Event::handle('EndShowStatusNetScripts', array($this));
443             }
444             Event::handle('EndShowScripts', array($this));
445         }
446     }
447
448     /**
449      * Exports a map of localized text strings to JavaScript code.
450      *
451      * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
452      * events and appending to the array. Try to avoid adding strings that won't be used, as
453      * they'll be added to HTML output.
454      */
455     function showScriptMessages()
456     {
457         $messages = array();
458
459         if (Event::handle('StartScriptMessages', array($this, &$messages))) {
460             // Common messages needed for timeline views etc...
461
462             // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
463             $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
464
465             $messages = array_merge($messages, $this->getScriptMessages());
466
467             Event::handle('EndScriptMessages', array($this, &$messages));
468         }
469
470         if (!empty($messages)) {
471             $this->inlineScript('SN.messages=' . json_encode($messages));
472         }
473
474         return $messages;
475     }
476
477     protected function showScriptVariables()
478     {
479         $vars = array();
480
481         if (Event::handle('StartScriptVariables', array($this, &$vars))) {
482             $vars['urlNewNotice'] = common_local_url('newnotice');
483         }
484         if (!empty($vars)) {
485             $this->inlineScript('SN.V = ' . json_encode($vars));
486         }
487         return $vars;
488     }
489
490     /**
491      * If the action will need localizable text strings, export them here like so:
492      *
493      * return array('pool_deepend' => _('Deep end'),
494      *              'pool_shallow' => _('Shallow end'));
495      *
496      * The exported map will be available via SN.msg() to JS code:
497      *
498      *   $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
499      *   $('#pool .deepend').text(SN.msg('pool_deepend'));
500      *   $('#pool .shallow').text(SN.msg('pool_shallow'));
501      *
502      * Exports a map of localized text strings to JavaScript code.
503      *
504      * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
505      * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
506      * be used, as they'll be added to HTML output.
507      */
508     function getScriptMessages()
509     {
510         return array();
511     }
512
513     /**
514      * Show OpenSearch headers
515      *
516      * @return nothing
517      */
518     function showOpenSearch()
519     {
520         $this->element('link', array('rel' => 'search',
521                                      'type' => 'application/opensearchdescription+xml',
522                                      'href' =>  common_local_url('opensearch', array('type' => 'people')),
523                                      'title' => common_config('site', 'name').' People Search'));
524         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
525                                      'href' =>  common_local_url('opensearch', array('type' => 'notice')),
526                                      'title' => common_config('site', 'name').' Notice Search'));
527     }
528
529     /**
530      * Show feed headers
531      *
532      * MAY overload
533      *
534      * @return nothing
535      */
536     function showFeeds()
537     {
538         $feeds = $this->getFeeds();
539
540         if ($feeds) {
541             foreach ($feeds as $feed) {
542                 $this->element('link', array('rel' => $feed->rel(),
543                                              'href' => $feed->url,
544                                              'type' => $feed->mimeType(),
545                                              'title' => $feed->title));
546             }
547         }
548     }
549
550     /**
551      * Show description.
552      *
553      * SHOULD overload
554      *
555      * @return nothing
556      */
557     function showDescription()
558     {
559         // does nothing by default
560     }
561
562     /**
563      * Show extra stuff in <head>.
564      *
565      * MAY overload
566      *
567      * @return nothing
568      */
569     function extraHead()
570     {
571         // does nothing by default
572     }
573
574     /**
575      * Show body.
576      *
577      * Calls template methods
578      *
579      * @return nothing
580      */
581     function showBody()
582     {
583         $params = array('id' => $this->getActionName());
584         if ($this->scoped instanceof Profile) {
585             $params['class'] = 'user_in';
586         }
587         $this->elementStart('body', $params);
588         $this->elementStart('div', array('id' => 'wrap'));
589         if (Event::handle('StartShowHeader', array($this))) {
590             $this->showHeader();
591             $this->flush();
592             Event::handle('EndShowHeader', array($this));
593         }
594         $this->showCore();
595         $this->flush();
596         if (Event::handle('StartShowFooter', array($this))) {
597             $this->showFooter();
598             $this->flush();
599             Event::handle('EndShowFooter', array($this));
600         }
601         $this->elementEnd('div');
602         $this->showScripts();
603         $this->elementEnd('body');
604     }
605
606     /**
607      * Show header of the page.
608      *
609      * Calls template methods
610      *
611      * @return nothing
612      */
613     function showHeader()
614     {
615         $this->elementStart('div', array('id' => 'header'));
616         $this->showLogo();
617         $this->showPrimaryNav();
618         if (Event::handle('StartShowSiteNotice', array($this))) {
619             $this->showSiteNotice();
620
621             Event::handle('EndShowSiteNotice', array($this));
622         }
623
624         $this->elementEnd('div');
625     }
626
627     /**
628      * Show configured logo.
629      *
630      * @return nothing
631      */
632     function showLogo()
633     {
634         $this->elementStart('address', array('id' => 'site_contact', 'class' => 'h-card'));
635         if (Event::handle('StartAddressData', array($this))) {
636             if (common_config('singleuser', 'enabled')) {
637                 $user = User::singleUser();
638                 $url = common_local_url('showstream',
639                                         array('nickname' => $user->nickname));
640             } else if (common_logged_in()) {
641                 $cur = common_current_user();
642                 $url = common_local_url('all', array('nickname' => $cur->nickname));
643             } else {
644                 $url = common_local_url('public');
645             }
646
647             $this->elementStart('a', array('class' => 'home bookmark',
648                                            'href' => $url));
649
650             if (GNUsocial::isHTTPS()) {
651                 $logoUrl = common_config('site', 'ssllogo');
652                 if (empty($logoUrl)) {
653                     // if logo is an uploaded file, try to fall back to HTTPS file URL
654                     $httpUrl = common_config('site', 'logo');
655                     if (!empty($httpUrl)) {
656                         $f = File::getKV('url', $httpUrl);
657                         if (!empty($f) && !empty($f->filename)) {
658                             // this will handle the HTTPS case
659                             $logoUrl = File::url($f->filename);
660                         }
661                     }
662                 }
663             } else {
664                 $logoUrl = common_config('site', 'logo');
665             }
666
667             if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
668                 // This should handle the HTTPS case internally
669                 $logoUrl = Theme::path('logo.png');
670             }
671
672             if (!empty($logoUrl)) {
673                 $this->element('img', array('class' => 'logo u-photo p-name',
674                                             'src' => $logoUrl,
675                                             'alt' => common_config('site', 'name')));
676             }
677
678             $this->elementEnd('a');
679
680             Event::handle('EndAddressData', array($this));
681         }
682         $this->elementEnd('address');
683     }
684
685     /**
686      * Show primary navigation.
687      *
688      * @return nothing
689      */
690     function showPrimaryNav()
691     {
692         $this->elementStart('div', array('id' => 'site_nav_global_primary'));
693
694         $user = common_current_user();
695
696         if (!empty($user) || !common_config('site', 'private')) {
697             $form = new SearchForm($this);
698             $form->show();
699         }
700
701         $pn = new PrimaryNav($this);
702         $pn->show();
703         $this->elementEnd('div');
704     }
705
706     /**
707      * Show site notice.
708      *
709      * @return nothing
710      */
711     function showSiteNotice()
712     {
713         // Revist. Should probably do an hAtom pattern here
714         $text = common_config('site', 'notice');
715         if ($text) {
716             $this->elementStart('div', array('id' => 'site_notice',
717                                             'class' => 'system_notice'));
718             $this->raw($text);
719             $this->elementEnd('div');
720         }
721     }
722
723     /**
724      * Show notice form.
725      *
726      * MAY overload if no notice form needed... or direct message box????
727      *
728      * @return nothing
729      */
730     function showNoticeForm()
731     {
732         // TRANS: Tab on the notice form.
733         $tabs = array('status' => array('title' => _m('TAB','Status'),
734                                         'href'  => common_local_url('newnotice')));
735
736         $this->elementStart('div', 'input_forms');
737
738         $this->element('label', array('for'=>'input_form_nav'), _m('TAB', 'Share your:'));
739
740         if (Event::handle('StartShowEntryForms', array(&$tabs))) {
741             $this->elementStart('ul', array('class' => 'nav',
742                                             'id' => 'input_form_nav'));
743
744             foreach ($tabs as $tag => $data) {
745                 $tag = htmlspecialchars($tag);
746                 $attrs = array('id' => 'input_form_nav_'.$tag,
747                                'class' => 'input_form_nav_tab');
748
749                 if ($tag == 'status') {
750                     $attrs['class'] .= ' current';
751                 }
752                 $this->elementStart('li', $attrs);
753
754                 $this->element('a',
755                                array('onclick' => 'return SN.U.switchInputFormTab("'.$tag.'");',
756                                      'href' => $data['href']),
757                                $data['title']);
758                 $this->elementEnd('li');
759             }
760
761             $this->elementEnd('ul');
762
763             foreach ($tabs as $tag => $data) {
764                 $attrs = array('class' => 'input_form',
765                                'id' => 'input_form_'.$tag);
766                 if ($tag == 'status') {
767                     $attrs['class'] .= ' current';
768                 }
769
770                 $this->elementStart('div', $attrs);
771
772                 $form = null;
773
774                 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
775                     if ($tag == 'status') {
776                         $options = $this->noticeFormOptions();
777                         $form = new NoticeForm($this, $options);
778                     }
779                     Event::handle('EndMakeEntryForm', array($tag, $this, $form));
780                 }
781
782                 if (!empty($form)) {
783                     $form->show();
784                 }
785
786                 $this->elementEnd('div');
787             }
788         }
789
790         $this->elementEnd('div');
791     }
792
793     function noticeFormOptions()
794     {
795         return array();
796     }
797
798     /**
799      * Show anonymous message.
800      *
801      * SHOULD overload
802      *
803      * @return nothing
804      */
805     function showAnonymousMessage()
806     {
807         // needs to be defined by the class
808     }
809
810     /**
811      * Show core.
812      *
813      * Shows local navigation, content block and aside.
814      *
815      * @return nothing
816      */
817     function showCore()
818     {
819         $this->elementStart('div', array('id' => 'core'));
820         $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
821         $this->elementStart('div', array('id' => 'content_wrapper'));
822         $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
823         if (Event::handle('StartShowLocalNavBlock', array($this))) {
824             $this->showLocalNavBlock();
825             $this->flush();
826             Event::handle('EndShowLocalNavBlock', array($this));
827         }
828         if (Event::handle('StartShowContentBlock', array($this))) {
829             $this->showContentBlock();
830             $this->flush();
831             Event::handle('EndShowContentBlock', array($this));
832         }
833         if (Event::handle('StartShowAside', array($this))) {
834             $this->showAside();
835             $this->flush();
836             Event::handle('EndShowAside', array($this));
837         }
838         $this->elementEnd('div');
839         $this->elementEnd('div');
840         $this->elementEnd('div');
841         $this->elementEnd('div');
842     }
843
844     /**
845      * Show local navigation block.
846      *
847      * @return nothing
848      */
849     function showLocalNavBlock()
850     {
851         // Need to have this ID for CSS; I'm too lazy to add it to
852         // all menus
853         $this->elementStart('div', array('id' => 'site_nav_local_views'));
854         // Cheat cheat cheat!
855         $this->showLocalNav();
856         $this->elementEnd('div');
857     }
858
859     /**
860      * If there's a logged-in user, show a bit of login context
861      *
862      * @return nothing
863      */
864     function showProfileBlock()
865     {
866         if (common_logged_in()) {
867             $block = new DefaultProfileBlock($this);
868             $block->show();
869         }
870     }
871
872     /**
873      * Show local navigation.
874      *
875      * SHOULD overload
876      *
877      * @return nothing
878      */
879     function showLocalNav()
880     {
881         $nav = new DefaultLocalNav($this);
882         $nav->show();
883     }
884
885     /**
886      * Show menu for an object (group, profile)
887      *
888      * This block will only show if a subclass has overridden
889      * the showObjectNav() method.
890      *
891      * @return nothing
892      */
893     function showObjectNavBlock()
894     {
895         $rmethod = new ReflectionMethod($this, 'showObjectNav');
896         $dclass = $rmethod->getDeclaringClass()->getName();
897
898         if ($dclass != 'Action') {
899             // Need to have this ID for CSS; I'm too lazy to add it to
900             // all menus
901             $this->elementStart('div', array('id' => 'site_nav_object',
902                                              'class' => 'section'));
903             $this->showObjectNav();
904             $this->elementEnd('div');
905         }
906     }
907
908     /**
909      * Show object navigation.
910      *
911      * If there are things to do with this object, show it here.
912      *
913      * @return nothing
914      */
915     function showObjectNav()
916     {
917         /* Nothing here. */
918     }
919
920     /**
921      * Show content block.
922      *
923      * @return nothing
924      */
925     function showContentBlock()
926     {
927         $this->elementStart('div', array('id' => 'content'));
928         if (common_logged_in()) {
929             if (Event::handle('StartShowNoticeForm', array($this))) {
930                 $this->showNoticeForm();
931                 Event::handle('EndShowNoticeForm', array($this));
932             }
933         }
934         if (Event::handle('StartShowPageTitle', array($this))) {
935             $this->showPageTitle();
936             Event::handle('EndShowPageTitle', array($this));
937         }
938         $this->showPageNoticeBlock();
939         $this->elementStart('div', array('id' => 'content_inner'));
940         // show the actual content (forms, lists, whatever)
941         $this->showContent();
942         $this->elementEnd('div');
943         $this->elementEnd('div');
944     }
945
946     /**
947      * Show page title.
948      *
949      * @return nothing
950      */
951     function showPageTitle()
952     {
953         $this->element('h1', null, $this->title());
954     }
955
956     /**
957      * Show page notice block.
958      *
959      * Only show the block if a subclassed action has overrided
960      * Action::showPageNotice(), or an event handler is registered for
961      * the StartShowPageNotice event, in which case we assume the
962      * 'page_notice' definition list is desired.  This is to prevent
963      * empty 'page_notice' definition lists from being output everywhere.
964      *
965      * @return nothing
966      */
967     function showPageNoticeBlock()
968     {
969         $rmethod = new ReflectionMethod($this, 'showPageNotice');
970         $dclass = $rmethod->getDeclaringClass()->getName();
971
972         if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
973
974             $this->elementStart('div', array('id' => 'page_notice',
975                                             'class' => 'system_notice'));
976             if (Event::handle('StartShowPageNotice', array($this))) {
977                 $this->showPageNotice();
978                 Event::handle('EndShowPageNotice', array($this));
979             }
980             $this->elementEnd('div');
981         }
982     }
983
984     /**
985      * Show page notice.
986      *
987      * SHOULD overload (unless there's not a notice)
988      *
989      * @return nothing
990      */
991     function showPageNotice()
992     {
993     }
994
995     /**
996      * Show content.
997      *
998      * MUST overload (unless there's not a notice)
999      *
1000      * @return nothing
1001      */
1002     protected function showContent()
1003     {
1004     }
1005
1006     /**
1007      * Show Aside.
1008      *
1009      * @return nothing
1010      */
1011     function showAside()
1012     {
1013         $this->elementStart('div', array('id' => 'aside_primary',
1014                                          'class' => 'aside'));
1015         $this->showProfileBlock();
1016         if (Event::handle('StartShowObjectNavBlock', array($this))) {
1017             $this->showObjectNavBlock();
1018             Event::handle('EndShowObjectNavBlock', array($this));
1019         }
1020         if (Event::handle('StartShowSections', array($this))) {
1021             $this->showSections();
1022             Event::handle('EndShowSections', array($this));
1023         }
1024         if (Event::handle('StartShowExportData', array($this))) {
1025             $this->showExportData();
1026             Event::handle('EndShowExportData', array($this));
1027         }
1028         $this->elementEnd('div');
1029     }
1030
1031     /**
1032      * Show export data feeds.
1033      *
1034      * @return void
1035      */
1036     function showExportData()
1037     {
1038         $feeds = $this->getFeeds();
1039         if ($feeds) {
1040             $fl = new FeedList($this);
1041             $fl->show($feeds);
1042         }
1043     }
1044
1045     /**
1046      * Show sections.
1047      *
1048      * SHOULD overload
1049      *
1050      * @return nothing
1051      */
1052     function showSections()
1053     {
1054         // for each section, show it
1055     }
1056
1057     /**
1058      * Show footer.
1059      *
1060      * @return nothing
1061      */
1062     function showFooter()
1063     {
1064         $this->elementStart('div', array('id' => 'footer'));
1065         if (Event::handle('StartShowInsideFooter', array($this))) {
1066             $this->showSecondaryNav();
1067             $this->showLicenses();
1068             Event::handle('EndShowInsideFooter', array($this));
1069         }
1070         $this->elementEnd('div');
1071     }
1072
1073     /**
1074      * Show secondary navigation.
1075      *
1076      * @return nothing
1077      */
1078     function showSecondaryNav()
1079     {
1080         $sn = new SecondaryNav($this);
1081         $sn->show();
1082     }
1083
1084     /**
1085      * Show licenses.
1086      *
1087      * @return nothing
1088      */
1089     function showLicenses()
1090     {
1091         $this->showGNUsocialLicense();
1092         $this->showContentLicense();
1093     }
1094
1095     /**
1096      * Show GNU social license.
1097      *
1098      * @return nothing
1099      */
1100     function showGNUsocialLicense()
1101     {
1102         if (common_config('site', 'broughtby')) {
1103             // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is set.
1104             // TRANS: Text between [] is a link description, text between () is the link itself.
1105             // TRANS: Make sure there is no whitespace between "]" and "(".
1106             // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
1107             $instr = _('**%%site.name%%** is a social network, courtesy of [%%site.broughtby%%](%%site.broughtbyurl%%).');
1108         } else {
1109             // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is not set.
1110             $instr = _('**%%site.name%%** is a social network.');
1111         }
1112         $instr .= ' ';
1113         // TRANS: Second sentence of the GNU social site license. Mentions the GNU social source code license.
1114         // TRANS: Make sure there is no whitespace between "]" and "(".
1115         // TRANS: [%1$s](%2$s) is a link description followed by the link itself
1116         // TRANS: %3$s is the version of GNU social that is being used.
1117         $instr .= sprintf(_('It runs on [%1$s](%2$s), version %3$s, available under the [GNU Affero General Public License](http://www.fsf.org/licensing/licenses/agpl-3.0.html).'), GNUSOCIAL_ENGINE, GNUSOCIAL_ENGINE_URL, GNUSOCIAL_VERSION);
1118         $output = common_markup_to_html($instr);
1119         $this->raw($output);
1120         // do it
1121     }
1122
1123     /**
1124      * Show content license.
1125      *
1126      * @return nothing
1127      */
1128     function showContentLicense()
1129     {
1130         if (Event::handle('StartShowContentLicense', array($this))) {
1131             switch (common_config('license', 'type')) {
1132             case 'private':
1133                 // TRANS: Content license displayed when license is set to 'private'.
1134                 // TRANS: %1$s is the site name.
1135                 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
1136                                                   common_config('site', 'name')));
1137                 // fall through
1138             case 'allrightsreserved':
1139                 if (common_config('license', 'owner')) {
1140                     // TRANS: Content license displayed when license is set to 'allrightsreserved'.
1141                     // TRANS: %1$s is the copyright owner.
1142                     $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
1143                                                       common_config('license', 'owner')));
1144                 } else {
1145                     // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
1146                     $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
1147                 }
1148                 break;
1149             case 'cc': // fall through
1150             default:
1151                 $this->elementStart('p');
1152
1153                 $image    = common_config('license', 'image');
1154                 $sslimage = common_config('license', 'sslimage');
1155
1156                 if (GNUsocial::isHTTPS()) {
1157                     if (!empty($sslimage)) {
1158                         $url = $sslimage;
1159                     } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1160                         // CC support HTTPS on their images
1161                         $url = preg_replace('/^http/', 'https', $image);
1162                     } else {
1163                         // Better to show mixed content than no content
1164                         $url = $image;
1165                     }
1166                 } else {
1167                     $url = $image;
1168                 }
1169
1170                 $this->element('img', array('id' => 'license_cc',
1171                                             'src' => $url,
1172                                             'alt' => common_config('license', 'title'),
1173                                             'width' => '80',
1174                                             'height' => '15'));
1175                 $this->text(' ');
1176                 // TRANS: license message in footer.
1177                 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1178                 $notice = _('All %1$s content and data are available under the %2$s license.');
1179                 $link = sprintf('<a class="license" rel="external license" href="%1$s">%2$s</a>',
1180                                 htmlspecialchars(common_config('license', 'url')),
1181                                 htmlspecialchars(common_config('license', 'title')));
1182                 $this->raw(@sprintf(htmlspecialchars($notice),
1183                                    htmlspecialchars(common_config('site', 'name')),
1184                                    $link));
1185                 $this->elementEnd('p');
1186                 break;
1187             }
1188
1189             Event::handle('EndShowContentLicense', array($this));
1190         }
1191     }
1192
1193     /**
1194      * Return last modified, if applicable.
1195      *
1196      * MAY override
1197      *
1198      * @return string last modified http header
1199      */
1200     function lastModified()
1201     {
1202         // For comparison with If-Last-Modified
1203         // If not applicable, return null
1204         return null;
1205     }
1206
1207     /**
1208      * Return etag, if applicable.
1209      *
1210      * MAY override
1211      *
1212      * @return string etag http header
1213      */
1214     function etag()
1215     {
1216         return null;
1217     }
1218
1219     /**
1220      * Return true if read only.
1221      *
1222      * MAY override
1223      *
1224      * @param array $args other arguments
1225      *
1226      * @return boolean is read only action?
1227      */
1228     function isReadOnly($args)
1229     {
1230         return false;
1231     }
1232
1233     /**
1234      * Returns query argument or default value if not found
1235      *
1236      * @param string $key requested argument
1237      * @param string $def default value to return if $key is not provided
1238      *
1239      * @return boolean is read only action?
1240      */
1241     function arg($key, $def=null)
1242     {
1243         if (array_key_exists($key, $this->args)) {
1244             return $this->args[$key];
1245         } else {
1246             return $def;
1247         }
1248     }
1249
1250     /**
1251      * Returns trimmed query argument or default value if not found
1252      *
1253      * @param string $key requested argument
1254      * @param string $def default value to return if $key is not provided
1255      *
1256      * @return boolean is read only action?
1257      */
1258     function trimmed($key, $def=null)
1259     {
1260         $arg = $this->arg($key, $def);
1261         return is_string($arg) ? trim($arg) : $arg;
1262     }
1263
1264     /**
1265      * Handler method
1266      *
1267      * @return boolean is read only action?
1268      */
1269     protected function handle()
1270     {
1271         header('Vary: Accept-Encoding,Cookie');
1272
1273         $lm   = $this->lastModified();
1274         $etag = $this->etag();
1275
1276         if ($etag) {
1277             header('ETag: ' . $etag);
1278         }
1279
1280         if ($lm) {
1281             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1282             if ($this->isCacheable()) {
1283                 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1284                 header( "Cache-Control: private, must-revalidate, max-age=0" );
1285                 header( "Pragma:");
1286             }
1287         }
1288
1289         $checked = false;
1290         if ($etag) {
1291             $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1292               $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1293             if ($if_none_match) {
1294                 // If this check fails, ignore the if-modified-since below.
1295                 $checked = true;
1296                 if ($this->_hasEtag($etag, $if_none_match)) {
1297                     header('HTTP/1.1 304 Not Modified');
1298                     // Better way to do this?
1299                     exit(0);
1300                 }
1301             }
1302         }
1303
1304         if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1305             $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1306             $ims = strtotime($if_modified_since);
1307             if ($lm <= $ims) {
1308                 header('HTTP/1.1 304 Not Modified');
1309                 // Better way to do this?
1310                 exit(0);
1311             }
1312         }
1313     }
1314
1315     /**
1316      * Is this action cacheable?
1317      *
1318      * If the action returns a last-modified
1319      *
1320      * @param array $argarray is ignored since it's now passed in in prepare()
1321      *
1322      * @return boolean is read only action?
1323      */
1324     function isCacheable()
1325     {
1326         return true;
1327     }
1328
1329     /**
1330      * Has etag? (private)
1331      *
1332      * @param string $etag          etag http header
1333      * @param string $if_none_match ifNoneMatch http header
1334      *
1335      * @return boolean
1336      */
1337     function _hasEtag($etag, $if_none_match)
1338     {
1339         $etags = explode(',', $if_none_match);
1340         return in_array($etag, $etags) || in_array('*', $etags);
1341     }
1342
1343     /**
1344      * Boolean understands english (yes, no, true, false)
1345      *
1346      * @param string $key query key we're interested in
1347      * @param string $def default value
1348      *
1349      * @return boolean interprets yes/no strings as boolean
1350      */
1351     function boolean($key, $def=false)
1352     {
1353         $arg = strtolower($this->trimmed($key));
1354
1355         if (is_null($arg)) {
1356             return $def;
1357         } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1358             return true;
1359         } else if (in_array($arg, array('false', 'no', '0'))) {
1360             return false;
1361         } else {
1362             return $def;
1363         }
1364     }
1365
1366     /**
1367      * This is a cheap hack to avoid a bug in DB_DataObject
1368      * where '' is non-type-aware compared to 0, which means it
1369      * will always be true for values like false and 0 too...
1370      *
1371      * Upstream bug is::
1372      * https://pear.php.net/bugs/bug.php?id=20291
1373      */
1374     function booleanintstring($key, $def=false)
1375     {
1376         return $this->boolean($key, $def) ? '1' : '0';
1377     }
1378
1379     /**
1380      * Integer value of an argument
1381      *
1382      * @param string $key      query key we're interested in
1383      * @param string $defValue optional default value (default null)
1384      * @param string $maxValue optional max value (default null)
1385      * @param string $minValue optional min value (default null)
1386      *
1387      * @return integer integer value
1388      */
1389     function int($key, $defValue=null, $maxValue=null, $minValue=null)
1390     {
1391         $arg = intval($this->arg($key));
1392
1393         if (!is_numeric($this->arg($key)) || $arg != $this->arg($key)) {
1394             return $defValue;
1395         }
1396
1397         if (!is_null($maxValue)) {
1398             $arg = min($arg, $maxValue);
1399         }
1400
1401         if (!is_null($minValue)) {
1402             $arg = max($arg, $minValue);
1403         }
1404
1405         return $arg;
1406     }
1407
1408     /**
1409      * Server error
1410      *
1411      * @param string  $msg  error message to display
1412      * @param integer $code http error code, 500 by default
1413      *
1414      * @return nothing
1415      */
1416     function serverError($msg, $code=500, $format=null)
1417     {
1418         if ($format === null) {
1419             $format = $this->format;
1420         }
1421
1422         common_debug("Server error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1423
1424         if (!array_key_exists($code, ServerErrorAction::$status)) {
1425             $code = 500;
1426         }
1427
1428         $status_string = ServerErrorAction::$status[$code];
1429
1430         switch ($format) {
1431         case 'xml':
1432             header("HTTP/1.1 {$code} {$status_string}");
1433             $this->initDocument('xml');
1434             $this->elementStart('hash');
1435             $this->element('error', null, $msg);
1436             $this->element('request', null, $_SERVER['REQUEST_URI']);
1437             $this->elementEnd('hash');
1438             $this->endDocument('xml');
1439             break;
1440         case 'json':
1441             if (!isset($this->callback)) {
1442                 header("HTTP/1.1 {$code} {$status_string}");
1443             }
1444             $this->initDocument('json');
1445             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1446             print(json_encode($error_array));
1447             $this->endDocument('json');
1448             break;
1449         default:
1450             throw new ServerException($msg, $code);
1451         }
1452
1453         exit((int)$code);
1454     }
1455
1456     /**
1457      * Client error
1458      *
1459      * @param string  $msg    error message to display
1460      * @param integer $code   http error code, 400 by default
1461      * @param string  $format error format (json, xml, text) for ApiAction
1462      *
1463      * @return nothing
1464      * @throws ClientException always
1465      */
1466     function clientError($msg, $code=400, $format=null)
1467     {
1468         // $format is currently only relevant for an ApiAction anyway
1469         if ($format === null) {
1470             $format = $this->format;
1471         }
1472
1473         common_debug("User error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1474
1475         if (!array_key_exists($code, ClientErrorAction::$status)) {
1476             $code = 400;
1477         }
1478         
1479         $status_string = ClientErrorAction::$status[$code];
1480
1481         switch ($format) {
1482         case 'xml':
1483             header("HTTP/1.1 {$code} {$status_string}");
1484             $this->initDocument('xml');
1485             $this->elementStart('hash');
1486             $this->element('error', null, $msg);
1487             $this->element('request', null, $_SERVER['REQUEST_URI']);
1488             $this->elementEnd('hash');
1489             $this->endDocument('xml');
1490             break;
1491         case 'json':
1492             if (!isset($this->callback)) {
1493                 header("HTTP/1.1 {$code} {$status_string}");
1494             }
1495             $this->initDocument('json');
1496             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1497             $this->text(json_encode($error_array));
1498             $this->endDocument('json');
1499             break;
1500         case 'text':
1501             header("HTTP/1.1 {$code} {$status_string}");
1502             header('Content-Type: text/plain; charset=utf-8');
1503             echo $msg;
1504             break;
1505         default:
1506             throw new ClientException($msg, $code);
1507         }
1508         exit((int)$code);
1509     }
1510
1511     /**
1512      * If not logged in, take appropriate action (redir or exception)
1513      *
1514      * @param boolean $redir Redirect to login if not logged in
1515      *
1516      * @return boolean true if logged in (never returns if not)
1517      */
1518     public function checkLogin($redir=true)
1519     {
1520         if (common_logged_in()) {
1521             return true;
1522         }
1523
1524         if ($redir==true) {
1525             common_set_returnto($_SERVER['REQUEST_URI']);
1526             common_redirect(common_local_url('login'));
1527         }
1528
1529         // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
1530         $this->clientError(_('Not logged in.'), 403);
1531     }
1532
1533     /**
1534      * Returns the current URL
1535      *
1536      * @return string current URL
1537      */
1538     function selfUrl()
1539     {
1540         list($action, $args) = $this->returnToArgs();
1541         return common_local_url($action, $args);
1542     }
1543
1544     /**
1545      * Returns arguments sufficient for re-constructing URL
1546      *
1547      * @return array two elements: action, other args
1548      */
1549     function returnToArgs()
1550     {
1551         $action = $this->getActionName();
1552         $args   = $this->args;
1553         unset($args['action']);
1554         if (common_config('site', 'fancy')) {
1555             unset($args['p']);
1556         }
1557         if (array_key_exists('submit', $args)) {
1558             unset($args['submit']);
1559         }
1560         foreach (array_keys($_COOKIE) as $cookie) {
1561             unset($args[$cookie]);
1562         }
1563         return array($action, $args);
1564     }
1565
1566     /**
1567      * Generate a menu item
1568      *
1569      * @param string  $url         menu URL
1570      * @param string  $text        menu name
1571      * @param string  $title       title attribute, null by default
1572      * @param boolean $is_selected current menu item, false by default
1573      * @param string  $id          element id, null by default
1574      *
1575      * @return nothing
1576      */
1577     function menuItem($url, $text, $title=null, $is_selected=false, $id=null, $class=null)
1578     {
1579         // Added @id to li for some control.
1580         // XXX: We might want to move this to htmloutputter.php
1581         $lattrs  = array();
1582         $classes = array();
1583         if ($class !== null) {
1584             $classes[] = trim($class);
1585         }
1586         if ($is_selected) {
1587             $classes[] = 'current';
1588         }
1589
1590         if (!empty($classes)) {
1591             $lattrs['class'] = implode(' ', $classes);
1592         }
1593
1594         if (!is_null($id)) {
1595             $lattrs['id'] = $id;
1596         }
1597
1598         $this->elementStart('li', $lattrs);
1599         $attrs['href'] = $url;
1600         if ($title) {
1601             $attrs['title'] = $title;
1602         }
1603         $this->element('a', $attrs, $text);
1604         $this->elementEnd('li');
1605     }
1606
1607     /**
1608      * Generate pagination links
1609      *
1610      * @param boolean $have_before is there something before?
1611      * @param boolean $have_after  is there something after?
1612      * @param integer $page        current page
1613      * @param string  $action      current action
1614      * @param array   $args        rest of query arguments
1615      *
1616      * @return nothing
1617      */
1618     // XXX: The messages in this pagination method only tailor to navigating
1619     //      notices. In other lists, "Previous"/"Next" type navigation is
1620     //      desirable, but not available.
1621     function pagination($have_before, $have_after, $page, $action, $args=null)
1622     {
1623         // Does a little before-after block for next/prev page
1624         if ($have_before || $have_after) {
1625             $this->elementStart('ul', array('class' => 'nav',
1626                                             'id' => 'pagination'));
1627         }
1628         if ($have_before) {
1629             $pargs   = array('page' => $page-1);
1630             $this->elementStart('li', array('class' => 'nav_prev'));
1631             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1632                                       'rel' => 'prev'),
1633                            // TRANS: Pagination message to go to a page displaying information more in the
1634                            // TRANS: present than the currently displayed information.
1635                            _('After'));
1636             $this->elementEnd('li');
1637         }
1638         if ($have_after) {
1639             $pargs   = array('page' => $page+1);
1640             $this->elementStart('li', array('class' => 'nav_next'));
1641             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1642                                       'rel' => 'next'),
1643                            // TRANS: Pagination message to go to a page displaying information more in the
1644                            // TRANS: past than the currently displayed information.
1645                            _('Before'));
1646             $this->elementEnd('li');
1647         }
1648         if ($have_before || $have_after) {
1649             $this->elementEnd('ul');
1650         }
1651     }
1652
1653     /**
1654      * An array of feeds for this action.
1655      *
1656      * Returns an array of potential feeds for this action.
1657      *
1658      * @return array Feed object to show in head and links
1659      */
1660     function getFeeds()
1661     {
1662         return null;
1663     }
1664
1665     /**
1666      * Check the session token.
1667      *
1668      * Checks that the current form has the correct session token,
1669      * and throw an exception if it does not.
1670      *
1671      * @return void
1672      */
1673     // XXX: Finding this type of check with the same message about 50 times.
1674     //      Possible to refactor?
1675     function checkSessionToken()
1676     {
1677         // CSRF protection
1678         $token = $this->trimmed('token');
1679         if (empty($token) || $token != common_session_token()) {
1680             // TRANS: Client error text when there is a problem with the session token.
1681             $this->clientError(_('There was a problem with your session token.'));
1682         }
1683     }
1684
1685     /**
1686      * Check if the current request is a POST
1687      *
1688      * @return boolean true if POST; otherwise false.
1689      */
1690
1691     function isPost()
1692     {
1693         return ($_SERVER['REQUEST_METHOD'] == 'POST');
1694     }
1695 }