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