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                 $this->script('extlib/jquery.infieldlabel.js');
 422
 423                 Event::handle('EndShowJQueryScripts', array($this));
 424             }
 425             if (Event::handle('StartShowStatusNetScripts', array($this))) {
 426                 $this->script('util.js');
 427                 $this->script('xbImportNode.js');
 428                 $this->script('geometa.js');
 429
 430                 // This route isn't available in single-user mode.
 431                 // Not sure why, but it causes errors here.
 432                 $this->inlineScript('var _peopletagAC = "' .
 433                                     common_local_url('peopletagautocomplete') . '";');
 434                 $this->showScriptMessages();
 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             // TRANS: Inline reply form submit button: submits a reply comment.
 466             $messages['reply_submit'] = _m('BUTTON', 'Reply');
 467
 468             // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
 469             $messages['reply_placeholder'] = _m('Write a reply...');
 470
 471             $messages = array_merge($messages, $this->getScriptMessages());
 472
 473             Event::handle('EndScriptMessages', array($this, &$messages));
 474         }
 475
 476         if (!empty($messages)) {
 477             $this->inlineScript('SN.messages=' . json_encode($messages));
 478         }
 479
 480         return $messages;
 481     }
 482
 483     /**
 484      * If the action will need localizable text strings, export them here like so:
 485      *
 486      * return array('pool_deepend' => _('Deep end'),
 487      *              'pool_shallow' => _('Shallow end'));
 488      *
 489      * The exported map will be available via SN.msg() to JS code:
 490      *
 491      *   $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
 492      *   $('#pool .deepend').text(SN.msg('pool_deepend'));
 493      *   $('#pool .shallow').text(SN.msg('pool_shallow'));
 494      *
 495      * Exports a map of localized text strings to JavaScript code.
 496      *
 497      * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
 498      * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
 499      * be used, as they'll be added to HTML output.
 500      */
 501     function getScriptMessages()
 502     {
 503         return array();
 504     }
 505
 506     /**
 507      * Show OpenSearch headers
 508      *
 509      * @return nothing
 510      */
 511     function showOpenSearch()
 512     {
 513         $this->element('link', array('rel' => 'search',
 514                                      'type' => 'application/opensearchdescription+xml',
 515                                      'href' =>  common_local_url('opensearch', array('type' => 'people')),
 516                                      'title' => common_config('site', 'name').' People Search'));
 517         $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
 518                                      'href' =>  common_local_url('opensearch', array('type' => 'notice')),
 519                                      'title' => common_config('site', 'name').' Notice Search'));
 520     }
 521
 522     /**
 523      * Show feed headers
 524      *
 525      * MAY overload
 526      *
 527      * @return nothing
 528      */
 529     function showFeeds()
 530     {
 531         $feeds = $this->getFeeds();
 532
 533         if ($feeds) {
 534             foreach ($feeds as $feed) {
 535                 $this->element('link', array('rel' => $feed->rel(),
 536                                              'href' => $feed->url,
 537                                              'type' => $feed->mimeType(),
 538                                              'title' => $feed->title));
 539             }
 540         }
 541     }
 542
 543     /**
 544      * Show description.
 545      *
 546      * SHOULD overload
 547      *
 548      * @return nothing
 549      */
 550     function showDescription()
 551     {
 552         // does nothing by default
 553     }
 554
 555     /**
 556      * Show extra stuff in <head>.
 557      *
 558      * MAY overload
 559      *
 560      * @return nothing
 561      */
 562     function extraHead()
 563     {
 564         // does nothing by default
 565     }
 566
 567     /**
 568      * Show body.
 569      *
 570      * Calls template methods
 571      *
 572      * @return nothing
 573      */
 574     function showBody()
 575     {
 576         $params = array('id' => $this->getActionName());
 577         if ($this->scoped instanceof Profile) {
 578             $params['class'] = 'user_in';
 579         }
 580         $this->elementStart('body', $params);
 581         $this->elementStart('div', array('id' => 'wrap'));
 582         if (Event::handle('StartShowHeader', array($this))) {
 583             $this->showHeader();
 584             $this->flush();
 585             Event::handle('EndShowHeader', array($this));
 586         }
 587         $this->showCore();
 588         $this->flush();
 589         if (Event::handle('StartShowFooter', array($this))) {
 590             $this->showFooter();
 591             $this->flush();
 592             Event::handle('EndShowFooter', array($this));
 593         }
 594         $this->elementEnd('div');
 595         $this->showScripts();
 596         $this->elementEnd('body');
 597     }
 598
 599     /**
 600      * Show header of the page.
 601      *
 602      * Calls template methods
 603      *
 604      * @return nothing
 605      */
 606     function showHeader()
 607     {
 608         $this->elementStart('div', array('id' => 'header'));
 609         $this->showLogo();
 610         $this->showPrimaryNav();
 611         if (Event::handle('StartShowSiteNotice', array($this))) {
 612             $this->showSiteNotice();
 613
 614             Event::handle('EndShowSiteNotice', array($this));
 615         }
 616
 617         $this->elementEnd('div');
 618     }
 619
 620     /**
 621      * Show configured logo.
 622      *
 623      * @return nothing
 624      */
 625     function showLogo()
 626     {
 627         $this->elementStart('address', array('id' => 'site_contact', 'class' => 'h-card'));
 628         if (Event::handle('StartAddressData', array($this))) {
 629             if (common_config('singleuser', 'enabled')) {
 630                 $user = User::singleUser();
 631                 $url = common_local_url('showstream',
 632                                         array('nickname' => $user->nickname));
 633             } else if (common_logged_in()) {
 634                 $cur = common_current_user();
 635                 $url = common_local_url('all', array('nickname' => $cur->nickname));
 636             } else {
 637                 $url = common_local_url('public');
 638             }
 639
 640             $this->elementStart('a', array('class' => 'home bookmark',
 641                                            'href' => $url));
 642
 643             if (GNUsocial::isHTTPS()) {
 644                 $logoUrl = common_config('site', 'ssllogo');
 645                 if (empty($logoUrl)) {
 646                     // if logo is an uploaded file, try to fall back to HTTPS file URL
 647                     $httpUrl = common_config('site', 'logo');
 648                     if (!empty($httpUrl)) {
 649                         $f = File::getKV('url', $httpUrl);
 650                         if (!empty($f) && !empty($f->filename)) {
 651                             // this will handle the HTTPS case
 652                             $logoUrl = File::url($f->filename);
 653                         }
 654                     }
 655                 }
 656             } else {
 657                 $logoUrl = common_config('site', 'logo');
 658             }
 659
 660             if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
 661                 // This should handle the HTTPS case internally
 662                 $logoUrl = Theme::path('logo.png');
 663             }
 664
 665             if (!empty($logoUrl)) {
 666                 $this->element('img', array('class' => 'logo u-photo p-name',
 667                                             'src' => $logoUrl,
 668                                             'alt' => common_config('site', 'name')));
 669             }
 670
 671             $this->elementEnd('a');
 672
 673             Event::handle('EndAddressData', array($this));
 674         }
 675         $this->elementEnd('address');
 676     }
 677
 678     /**
 679      * Show primary navigation.
 680      *
 681      * @return nothing
 682      */
 683     function showPrimaryNav()
 684     {
 685         $this->elementStart('div', array('id' => 'site_nav_global_primary'));
 686
 687         $user = common_current_user();
 688
 689         if (!empty($user) || !common_config('site', 'private')) {
 690             $form = new SearchForm($this);
 691             $form->show();
 692         }
 693
 694         $pn = new PrimaryNav($this);
 695         $pn->show();
 696         $this->elementEnd('div');
 697     }
 698
 699     /**
 700      * Show site notice.
 701      *
 702      * @return nothing
 703      */
 704     function showSiteNotice()
 705     {
 706         // Revist. Should probably do an hAtom pattern here
 707         $text = common_config('site', 'notice');
 708         if ($text) {
 709             $this->elementStart('div', array('id' => 'site_notice',
 710                                             'class' => 'system_notice'));
 711             $this->raw($text);
 712             $this->elementEnd('div');
 713         }
 714     }
 715
 716     /**
 717      * Show notice form.
 718      *
 719      * MAY overload if no notice form needed... or direct message box????
 720      *
 721      * @return nothing
 722      */
 723     function showNoticeForm()
 724     {
 725         // TRANS: Tab on the notice form.
 726         $tabs = array('status' => array('title' => _m('TAB','Status'),
 727                                         'href'  => common_local_url('newnotice')));
 728
 729         $this->elementStart('div', 'input_forms');
 730
 731         $this->element('label', array('for'=>'input_form_nav'), _m('TAB', 'Share your:'));
 732
 733         if (Event::handle('StartShowEntryForms', array(&$tabs))) {
 734             $this->elementStart('ul', array('class' => 'nav',
 735                                             'id' => 'input_form_nav'));
 736
 737             foreach ($tabs as $tag => $data) {
 738                 $tag = htmlspecialchars($tag);
 739                 $attrs = array('id' => 'input_form_nav_'.$tag,
 740                                'class' => 'input_form_nav_tab');
 741
 742                 if ($tag == 'status') {
 743                     $attrs['class'] .= ' current';
 744                 }
 745                 $this->elementStart('li', $attrs);
 746
 747                 $this->element('a',
 748                                array('onclick' => 'return SN.U.switchInputFormTab("'.$tag.'");',
 749                                      'href' => $data['href']),
 750                                $data['title']);
 751                 $this->elementEnd('li');
 752             }
 753
 754             $this->elementEnd('ul');
 755
 756             foreach ($tabs as $tag => $data) {
 757                 $attrs = array('class' => 'input_form',
 758                                'id' => 'input_form_'.$tag);
 759                 if ($tag == 'status') {
 760                     $attrs['class'] .= ' current';
 761                 }
 762
 763                 $this->elementStart('div', $attrs);
 764
 765                 $form = null;
 766
 767                 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
 768                     if ($tag == 'status') {
 769                         $options = $this->noticeFormOptions();
 770                         $form = new NoticeForm($this, $options);
 771                     }
 772                     Event::handle('EndMakeEntryForm', array($tag, $this, $form));
 773                 }
 774
 775                 if (!empty($form)) {
 776                     $form->show();
 777                 }
 778
 779                 $this->elementEnd('div');
 780             }
 781         }
 782
 783         $this->elementEnd('div');
 784     }
 785
 786     function noticeFormOptions()
 787     {
 788         return array();
 789     }
 790
 791     /**
 792      * Show anonymous message.
 793      *
 794      * SHOULD overload
 795      *
 796      * @return nothing
 797      */
 798     function showAnonymousMessage()
 799     {
 800         // needs to be defined by the class
 801     }
 802
 803     /**
 804      * Show core.
 805      *
 806      * Shows local navigation, content block and aside.
 807      *
 808      * @return nothing
 809      */
 810     function showCore()
 811     {
 812         $this->elementStart('div', array('id' => 'core'));
 813         $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
 814         $this->elementStart('div', array('id' => 'content_wrapper'));
 815         $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
 816         if (Event::handle('StartShowLocalNavBlock', array($this))) {
 817             $this->showLocalNavBlock();
 818             $this->flush();
 819             Event::handle('EndShowLocalNavBlock', array($this));
 820         }
 821         if (Event::handle('StartShowContentBlock', array($this))) {
 822             $this->showContentBlock();
 823             $this->flush();
 824             Event::handle('EndShowContentBlock', array($this));
 825         }
 826         if (Event::handle('StartShowAside', array($this))) {
 827             $this->showAside();
 828             $this->flush();
 829             Event::handle('EndShowAside', array($this));
 830         }
 831         $this->elementEnd('div');
 832         $this->elementEnd('div');
 833         $this->elementEnd('div');
 834         $this->elementEnd('div');
 835     }
 836
 837     /**
 838      * Show local navigation block.
 839      *
 840      * @return nothing
 841      */
 842     function showLocalNavBlock()
 843     {
 844         // Need to have this ID for CSS; I'm too lazy to add it to
 845         // all menus
 846         $this->elementStart('div', array('id' => 'site_nav_local_views'));
 847         // Cheat cheat cheat!
 848         $this->showLocalNav();
 849         $this->elementEnd('div');
 850     }
 851
 852     /**
 853      * If there's a logged-in user, show a bit of login context
 854      *
 855      * @return nothing
 856      */
 857     function showProfileBlock()
 858     {
 859         if (common_logged_in()) {
 860             $block = new DefaultProfileBlock($this);
 861             $block->show();
 862         }
 863     }
 864
 865     /**
 866      * Show local navigation.
 867      *
 868      * SHOULD overload
 869      *
 870      * @return nothing
 871      */
 872     function showLocalNav()
 873     {
 874         $nav = new DefaultLocalNav($this);
 875         $nav->show();
 876     }
 877
 878     /**
 879      * Show menu for an object (group, profile)
 880      *
 881      * This block will only show if a subclass has overridden
 882      * the showObjectNav() method.
 883      *
 884      * @return nothing
 885      */
 886     function showObjectNavBlock()
 887     {
 888         $rmethod = new ReflectionMethod($this, 'showObjectNav');
 889         $dclass = $rmethod->getDeclaringClass()->getName();
 890
 891         if ($dclass != 'Action') {
 892             // Need to have this ID for CSS; I'm too lazy to add it to
 893             // all menus
 894             $this->elementStart('div', array('id' => 'site_nav_object',
 895                                              'class' => 'section'));
 896             $this->showObjectNav();
 897             $this->elementEnd('div');
 898         }
 899     }
 900
 901     /**
 902      * Show object navigation.
 903      *
 904      * If there are things to do with this object, show it here.
 905      *
 906      * @return nothing
 907      */
 908     function showObjectNav()
 909     {
 910         /* Nothing here. */
 911     }
 912
 913     /**
 914      * Show content block.
 915      *
 916      * @return nothing
 917      */
 918     function showContentBlock()
 919     {
 920         $this->elementStart('div', array('id' => 'content'));
 921         if (common_logged_in()) {
 922             if (Event::handle('StartShowNoticeForm', array($this))) {
 923                 $this->showNoticeForm();
 924                 Event::handle('EndShowNoticeForm', array($this));
 925             }
 926         }
 927         if (Event::handle('StartShowPageTitle', array($this))) {
 928             $this->showPageTitle();
 929             Event::handle('EndShowPageTitle', array($this));
 930         }
 931         $this->showPageNoticeBlock();
 932         $this->elementStart('div', array('id' => 'content_inner'));
 933         // show the actual content (forms, lists, whatever)
 934         $this->showContent();
 935         $this->elementEnd('div');
 936         $this->elementEnd('div');
 937     }
 938
 939     /**
 940      * Show page title.
 941      *
 942      * @return nothing
 943      */
 944     function showPageTitle()
 945     {
 946         $this->element('h1', null, $this->title());
 947     }
 948
 949     /**
 950      * Show page notice block.
 951      *
 952      * Only show the block if a subclassed action has overrided
 953      * Action::showPageNotice(), or an event handler is registered for
 954      * the StartShowPageNotice event, in which case we assume the
 955      * 'page_notice' definition list is desired.  This is to prevent
 956      * empty 'page_notice' definition lists from being output everywhere.
 957      *
 958      * @return nothing
 959      */
 960     function showPageNoticeBlock()
 961     {
 962         $rmethod = new ReflectionMethod($this, 'showPageNotice');
 963         $dclass = $rmethod->getDeclaringClass()->getName();
 964
 965         if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
 966
 967             $this->elementStart('div', array('id' => 'page_notice',
 968                                             'class' => 'system_notice'));
 969             if (Event::handle('StartShowPageNotice', array($this))) {
 970                 $this->showPageNotice();
 971                 Event::handle('EndShowPageNotice', array($this));
 972             }
 973             $this->elementEnd('div');
 974         }
 975     }
 976
 977     /**
 978      * Show page notice.
 979      *
 980      * SHOULD overload (unless there's not a notice)
 981      *
 982      * @return nothing
 983      */
 984     function showPageNotice()
 985     {
 986     }
 987
 988     /**
 989      * Show content.
 990      *
 991      * MUST overload (unless there's not a notice)
 992      *
 993      * @return nothing
 994      */
 995     protected function showContent()
 996     {
 997     }
 998
 999     /**
1000      * Show Aside.
1001      *
1002      * @return nothing
1003      */
1004     function showAside()
1005     {
1006         $this->elementStart('div', array('id' => 'aside_primary',
1007                                          'class' => 'aside'));
1008         $this->showProfileBlock();
1009         if (Event::handle('StartShowObjectNavBlock', array($this))) {
1010             $this->showObjectNavBlock();
1011             Event::handle('EndShowObjectNavBlock', array($this));
1012         }
1013         if (Event::handle('StartShowSections', array($this))) {
1014             $this->showSections();
1015             Event::handle('EndShowSections', array($this));
1016         }
1017         if (Event::handle('StartShowExportData', array($this))) {
1018             $this->showExportData();
1019             Event::handle('EndShowExportData', array($this));
1020         }
1021         $this->elementEnd('div');
1022     }
1023
1024     /**
1025      * Show export data feeds.
1026      *
1027      * @return void
1028      */
1029     function showExportData()
1030     {
1031         $feeds = $this->getFeeds();
1032         if ($feeds) {
1033             $fl = new FeedList($this);
1034             $fl->show($feeds);
1035         }
1036     }
1037
1038     /**
1039      * Show sections.
1040      *
1041      * SHOULD overload
1042      *
1043      * @return nothing
1044      */
1045     function showSections()
1046     {
1047         // for each section, show it
1048     }
1049
1050     /**
1051      * Show footer.
1052      *
1053      * @return nothing
1054      */
1055     function showFooter()
1056     {
1057         $this->elementStart('div', array('id' => 'footer'));
1058         if (Event::handle('StartShowInsideFooter', array($this))) {
1059             $this->showSecondaryNav();
1060             $this->showLicenses();
1061             Event::handle('EndShowInsideFooter', array($this));
1062         }
1063         $this->elementEnd('div');
1064     }
1065
1066     /**
1067      * Show secondary navigation.
1068      *
1069      * @return nothing
1070      */
1071     function showSecondaryNav()
1072     {
1073         $sn = new SecondaryNav($this);
1074         $sn->show();
1075     }
1076
1077     /**
1078      * Show licenses.
1079      *
1080      * @return nothing
1081      */
1082     function showLicenses()
1083     {
1084         $this->showGNUsocialLicense();
1085         $this->showContentLicense();
1086     }
1087
1088     /**
1089      * Show GNU social license.
1090      *
1091      * @return nothing
1092      */
1093     function showGNUsocialLicense()
1094     {
1095         if (common_config('site', 'broughtby')) {
1096             // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is set.
1097             // TRANS: Text between [] is a link description, text between () is the link itself.
1098             // TRANS: Make sure there is no whitespace between "]" and "(".
1099             // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
1100             $instr = _('**%%site.name%%** is a social network, courtesy of [%%site.broughtby%%](%%site.broughtbyurl%%).');
1101         } else {
1102             // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is not set.
1103             $instr = _('**%%site.name%%** is a social network.');
1104         }
1105         $instr .= ' ';
1106         // TRANS: Second sentence of the GNU social site license. Mentions the GNU social source code license.
1107         // TRANS: Make sure there is no whitespace between "]" and "(".
1108         // TRANS: [%1$s](%2$s) is a link description followed by the link itself
1109         // TRANS: %3$s is the version of GNU social that is being used.
1110         $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);
1111         $output = common_markup_to_html($instr);
1112         $this->raw($output);
1113         // do it
1114     }
1115
1116     /**
1117      * Show content license.
1118      *
1119      * @return nothing
1120      */
1121     function showContentLicense()
1122     {
1123         if (Event::handle('StartShowContentLicense', array($this))) {
1124             switch (common_config('license', 'type')) {
1125             case 'private':
1126                 // TRANS: Content license displayed when license is set to 'private'.
1127                 // TRANS: %1$s is the site name.
1128                 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
1129                                                   common_config('site', 'name')));
1130                 // fall through
1131             case 'allrightsreserved':
1132                 if (common_config('license', 'owner')) {
1133                     // TRANS: Content license displayed when license is set to 'allrightsreserved'.
1134                     // TRANS: %1$s is the copyright owner.
1135                     $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
1136                                                       common_config('license', 'owner')));
1137                 } else {
1138                     // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
1139                     $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
1140                 }
1141                 break;
1142             case 'cc': // fall through
1143             default:
1144                 $this->elementStart('p');
1145
1146                 $image    = common_config('license', 'image');
1147                 $sslimage = common_config('license', 'sslimage');
1148
1149                 if (GNUsocial::isHTTPS()) {
1150                     if (!empty($sslimage)) {
1151                         $url = $sslimage;
1152                     } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1153                         // CC support HTTPS on their images
1154                         $url = preg_replace('/^http/', 'https', $image);
1155                     } else {
1156                         // Better to show mixed content than no content
1157                         $url = $image;
1158                     }
1159                 } else {
1160                     $url = $image;
1161                 }
1162
1163                 $this->element('img', array('id' => 'license_cc',
1164                                             'src' => $url,
1165                                             'alt' => common_config('license', 'title'),
1166                                             'width' => '80',
1167                                             'height' => '15'));
1168                 $this->text(' ');
1169                 // TRANS: license message in footer.
1170                 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1171                 $notice = _('All %1$s content and data are available under the %2$s license.');
1172                 $link = sprintf('<a class="license" rel="external license" href="%1$s">%2$s</a>',
1173                                 htmlspecialchars(common_config('license', 'url')),
1174                                 htmlspecialchars(common_config('license', 'title')));
1175                 $this->raw(@sprintf(htmlspecialchars($notice),
1176                                    htmlspecialchars(common_config('site', 'name')),
1177                                    $link));
1178                 $this->elementEnd('p');
1179                 break;
1180             }
1181
1182             Event::handle('EndShowContentLicense', array($this));
1183         }
1184     }
1185
1186     /**
1187      * Return last modified, if applicable.
1188      *
1189      * MAY override
1190      *
1191      * @return string last modified http header
1192      */
1193     function lastModified()
1194     {
1195         // For comparison with If-Last-Modified
1196         // If not applicable, return null
1197         return null;
1198     }
1199
1200     /**
1201      * Return etag, if applicable.
1202      *
1203      * MAY override
1204      *
1205      * @return string etag http header
1206      */
1207     function etag()
1208     {
1209         return null;
1210     }
1211
1212     /**
1213      * Return true if read only.
1214      *
1215      * MAY override
1216      *
1217      * @param array $args other arguments
1218      *
1219      * @return boolean is read only action?
1220      */
1221     function isReadOnly($args)
1222     {
1223         return false;
1224     }
1225
1226     /**
1227      * Returns query argument or default value if not found
1228      *
1229      * @param string $key requested argument
1230      * @param string $def default value to return if $key is not provided
1231      *
1232      * @return boolean is read only action?
1233      */
1234     function arg($key, $def=null)
1235     {
1236         if (array_key_exists($key, $this->args)) {
1237             return $this->args[$key];
1238         } else {
1239             return $def;
1240         }
1241     }
1242
1243     /**
1244      * Returns trimmed query argument or default value if not found
1245      *
1246      * @param string $key requested argument
1247      * @param string $def default value to return if $key is not provided
1248      *
1249      * @return boolean is read only action?
1250      */
1251     function trimmed($key, $def=null)
1252     {
1253         $arg = $this->arg($key, $def);
1254         return is_string($arg) ? trim($arg) : $arg;
1255     }
1256
1257     /**
1258      * Handler method
1259      *
1260      * @return boolean is read only action?
1261      */
1262     protected function handle()
1263     {
1264         header('Vary: Accept-Encoding,Cookie');
1265
1266         $lm   = $this->lastModified();
1267         $etag = $this->etag();
1268
1269         if ($etag) {
1270             header('ETag: ' . $etag);
1271         }
1272
1273         if ($lm) {
1274             header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1275             if ($this->isCacheable()) {
1276                 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1277                 header( "Cache-Control: private, must-revalidate, max-age=0" );
1278                 header( "Pragma:");
1279             }
1280         }
1281
1282         $checked = false;
1283         if ($etag) {
1284             $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1285               $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1286             if ($if_none_match) {
1287                 // If this check fails, ignore the if-modified-since below.
1288                 $checked = true;
1289                 if ($this->_hasEtag($etag, $if_none_match)) {
1290                     header('HTTP/1.1 304 Not Modified');
1291                     // Better way to do this?
1292                     exit(0);
1293                 }
1294             }
1295         }
1296
1297         if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1298             $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1299             $ims = strtotime($if_modified_since);
1300             if ($lm <= $ims) {
1301                 header('HTTP/1.1 304 Not Modified');
1302                 // Better way to do this?
1303                 exit(0);
1304             }
1305         }
1306     }
1307
1308     /**
1309      * Is this action cacheable?
1310      *
1311      * If the action returns a last-modified
1312      *
1313      * @param array $argarray is ignored since it's now passed in in prepare()
1314      *
1315      * @return boolean is read only action?
1316      */
1317     function isCacheable()
1318     {
1319         return true;
1320     }
1321
1322     /**
1323      * Has etag? (private)
1324      *
1325      * @param string $etag          etag http header
1326      * @param string $if_none_match ifNoneMatch http header
1327      *
1328      * @return boolean
1329      */
1330     function _hasEtag($etag, $if_none_match)
1331     {
1332         $etags = explode(',', $if_none_match);
1333         return in_array($etag, $etags) || in_array('*', $etags);
1334     }
1335
1336     /**
1337      * Boolean understands english (yes, no, true, false)
1338      *
1339      * @param string $key query key we're interested in
1340      * @param string $def default value
1341      *
1342      * @return boolean interprets yes/no strings as boolean
1343      */
1344     function boolean($key, $def=false)
1345     {
1346         $arg = strtolower($this->trimmed($key));
1347
1348         if (is_null($arg)) {
1349             return $def;
1350         } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1351             return true;
1352         } else if (in_array($arg, array('false', 'no', '0'))) {
1353             return false;
1354         } else {
1355             return $def;
1356         }
1357     }
1358
1359     /**
1360      * Integer value of an argument
1361      *
1362      * @param string $key      query key we're interested in
1363      * @param string $defValue optional default value (default null)
1364      * @param string $maxValue optional max value (default null)
1365      * @param string $minValue optional min value (default null)
1366      *
1367      * @return integer integer value
1368      */
1369     function int($key, $defValue=null, $maxValue=null, $minValue=null)
1370     {
1371         $arg = intval($this->arg($key));
1372
1373         if (!is_numeric($this->arg($key)) || $arg != $this->arg($key)) {
1374             return $defValue;
1375         }
1376
1377         if (!is_null($maxValue)) {
1378             $arg = min($arg, $maxValue);
1379         }
1380
1381         if (!is_null($minValue)) {
1382             $arg = max($arg, $minValue);
1383         }
1384
1385         return $arg;
1386     }
1387
1388     /**
1389      * Server error
1390      *
1391      * @param string  $msg  error message to display
1392      * @param integer $code http error code, 500 by default
1393      *
1394      * @return nothing
1395      */
1396     function serverError($msg, $code=500, $format=null)
1397     {
1398         if ($format === null) {
1399             $format = $this->format;
1400         }
1401
1402         common_debug("Server error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1403
1404         if (!array_key_exists($code, ServerErrorAction::$status)) {
1405             $code = 500;
1406         }
1407
1408         $status_string = ServerErrorAction::$status[$code];
1409
1410         switch ($format) {
1411         case 'xml':
1412             header("HTTP/1.1 {$code} {$status_string}");
1413             $this->initDocument('xml');
1414             $this->elementStart('hash');
1415             $this->element('error', null, $msg);
1416             $this->element('request', null, $_SERVER['REQUEST_URI']);
1417             $this->elementEnd('hash');
1418             $this->endDocument('xml');
1419             break;
1420         case 'json':
1421             if (!isset($this->callback)) {
1422                 header("HTTP/1.1 {$code} {$status_string}");
1423             }
1424             $this->initDocument('json');
1425             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1426             print(json_encode($error_array));
1427             $this->endDocument('json');
1428             break;
1429         default:
1430             throw new ServerException($msg, $code);
1431         }
1432
1433         exit((int)$code);
1434     }
1435
1436     /**
1437      * Client error
1438      *
1439      * @param string  $msg    error message to display
1440      * @param integer $code   http error code, 400 by default
1441      * @param string  $format error format (json, xml, text) for ApiAction
1442      *
1443      * @return nothing
1444      * @throws ClientException always
1445      */
1446     function clientError($msg, $code=400, $format=null)
1447     {
1448         // $format is currently only relevant for an ApiAction anyway
1449         if ($format === null) {
1450             $format = $this->format;
1451         }
1452
1453         common_debug("User error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1454
1455         if (!array_key_exists($code, ClientErrorAction::$status)) {
1456             $code = 400;
1457         }
1458
1459         $status_string = ClientErrorAction::$status[$code];
1460
1461         switch ($format) {
1462         case 'xml':
1463             header("HTTP/1.1 {$code} {$status_string}");
1464             $this->initDocument('xml');
1465             $this->elementStart('hash');
1466             $this->element('error', null, $msg);
1467             $this->element('request', null, $_SERVER['REQUEST_URI']);
1468             $this->elementEnd('hash');
1469             $this->endDocument('xml');
1470             break;
1471         case 'json':
1472             if (!isset($this->callback)) {
1473                 header("HTTP/1.1 {$code} {$status_string}");
1474             }
1475             $this->initDocument('json');
1476             $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1477             $this->text(json_encode($error_array));
1478             $this->endDocument('json');
1479             break;
1480         case 'text':
1481             header("HTTP/1.1 {$code} {$status_string}");
1482             header('Content-Type: text/plain; charset=utf-8');
1483             echo $msg;
1484             break;
1485         default:
1486             throw new ClientException($msg, $code);
1487         }
1488         exit((int)$code);
1489     }
1490
1491     /**
1492      * If not logged in, take appropriate action (redir or exception)
1493      *
1494      * @param boolean $redir Redirect to login if not logged in
1495      *
1496      * @return boolean true if logged in (never returns if not)
1497      */
1498     public function checkLogin($redir=true)
1499     {
1500         if (common_logged_in()) {
1501             return true;
1502         }
1503
1504         if ($redir==true) {
1505             common_set_returnto($_SERVER['REQUEST_URI']);
1506             common_redirect(common_local_url('login'));
1507         }
1508
1509         // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
1510         $this->clientError(_('Not logged in.'), 403);
1511     }
1512
1513     /**
1514      * Returns the current URL
1515      *
1516      * @return string current URL
1517      */
1518     function selfUrl()
1519     {
1520         list($action, $args) = $this->returnToArgs();
1521         return common_local_url($action, $args);
1522     }
1523
1524     /**
1525      * Returns arguments sufficient for re-constructing URL
1526      *
1527      * @return array two elements: action, other args
1528      */
1529     function returnToArgs()
1530     {
1531         $action = $this->getActionName();
1532         $args   = $this->args;
1533         unset($args['action']);
1534         if (common_config('site', 'fancy')) {
1535             unset($args['p']);
1536         }
1537         if (array_key_exists('submit', $args)) {
1538             unset($args['submit']);
1539         }
1540         foreach (array_keys($_COOKIE) as $cookie) {
1541             unset($args[$cookie]);
1542         }
1543         return array($action, $args);
1544     }
1545
1546     /**
1547      * Generate a menu item
1548      *
1549      * @param string  $url         menu URL
1550      * @param string  $text        menu name
1551      * @param string  $title       title attribute, null by default
1552      * @param boolean $is_selected current menu item, false by default
1553      * @param string  $id          element id, null by default
1554      *
1555      * @return nothing
1556      */
1557     function menuItem($url, $text, $title=null, $is_selected=false, $id=null, $class=null)
1558     {
1559         // Added @id to li for some control.
1560         // XXX: We might want to move this to htmloutputter.php
1561         $lattrs  = array();
1562         $classes = array();
1563         if ($class !== null) {
1564             $classes[] = trim($class);
1565         }
1566         if ($is_selected) {
1567             $classes[] = 'current';
1568         }
1569
1570         if (!empty($classes)) {
1571             $lattrs['class'] = implode(' ', $classes);
1572         }
1573
1574         if (!is_null($id)) {
1575             $lattrs['id'] = $id;
1576         }
1577
1578         $this->elementStart('li', $lattrs);
1579         $attrs['href'] = $url;
1580         if ($title) {
1581             $attrs['title'] = $title;
1582         }
1583         $this->element('a', $attrs, $text);
1584         $this->elementEnd('li');
1585     }
1586
1587     /**
1588      * Generate pagination links
1589      *
1590      * @param boolean $have_before is there something before?
1591      * @param boolean $have_after  is there something after?
1592      * @param integer $page        current page
1593      * @param string  $action      current action
1594      * @param array   $args        rest of query arguments
1595      *
1596      * @return nothing
1597      */
1598     // XXX: The messages in this pagination method only tailor to navigating
1599     //      notices. In other lists, "Previous"/"Next" type navigation is
1600     //      desirable, but not available.
1601     function pagination($have_before, $have_after, $page, $action, $args=null)
1602     {
1603         // Does a little before-after block for next/prev page
1604         if ($have_before || $have_after) {
1605             $this->elementStart('ul', array('class' => 'nav',
1606                                             'id' => 'pagination'));
1607         }
1608         if ($have_before) {
1609             $pargs   = array('page' => $page-1);
1610             $this->elementStart('li', array('class' => 'nav_prev'));
1611             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1612                                       'rel' => 'prev'),
1613                            // TRANS: Pagination message to go to a page displaying information more in the
1614                            // TRANS: present than the currently displayed information.
1615                            _('After'));
1616             $this->elementEnd('li');
1617         }
1618         if ($have_after) {
1619             $pargs   = array('page' => $page+1);
1620             $this->elementStart('li', array('class' => 'nav_next'));
1621             $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1622                                       'rel' => 'next'),
1623                            // TRANS: Pagination message to go to a page displaying information more in the
1624                            // TRANS: past than the currently displayed information.
1625                            _('Before'));
1626             $this->elementEnd('li');
1627         }
1628         if ($have_before || $have_after) {
1629             $this->elementEnd('ul');
1630         }
1631     }
1632
1633     /**
1634      * An array of feeds for this action.
1635      *
1636      * Returns an array of potential feeds for this action.
1637      *
1638      * @return array Feed object to show in head and links
1639      */
1640     function getFeeds()
1641     {
1642         return null;
1643     }
1644
1645     /**
1646      * Check the session token.
1647      *
1648      * Checks that the current form has the correct session token,
1649      * and throw an exception if it does not.
1650      *
1651      * @return void
1652      */
1653     // XXX: Finding this type of check with the same message about 50 times.
1654     //      Possible to refactor?
1655     function checkSessionToken()
1656     {
1657         // CSRF protection
1658         $token = $this->trimmed('token');
1659         if (empty($token) || $token != common_session_token()) {
1660             // TRANS: Client error text when there is a problem with the session token.
1661             $this->clientError(_('There was a problem with your session token.'));
1662         }
1663     }
1664
1665     /**
1666      * Check if the current request is a POST
1667      *
1668      * @return boolean true if POST; otherwise false.
1669      */
1670
1671     function isPost()
1672     {
1673         return ($_SERVER['REQUEST_METHOD'] == 'POST');
1674     }
1675 }