3 * StatusNet, the distributed open-source microblogging tool
5 * Base class for all actions (~views)
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @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/
31 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 require_once INSTALLDIR.'/lib/noticeform.php';
36 require_once INSTALLDIR.'/lib/htmloutputter.php';
39 * Base class for all actions
41 * This is the base class for all actions in the package. An action is
42 * more or less a "view" in an MVC framework.
44 * Actions are responsible for extracting and validating parameters; using
45 * model classes to read and write to the database; and doing ouput.
49 * @author Evan Prodromou <evan@status.net>
50 * @author Sarven Capadisli <csarven@status.net>
51 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
52 * @link http://status.net/
56 class Action extends HTMLOutputter // lawsuit
63 * Just wraps the HTMLOutputter constructor.
65 * @param string $output URI to output to, default = stdout
66 * @param boolean $indent Whether to indent output, default true
68 * @see XMLOutputter::__construct
69 * @see HTMLOutputter::__construct
71 function __construct($output='php://output', $indent=null)
73 parent::__construct($output, $indent);
77 * For initializing members of the class.
79 * @param array $argarray misc. arguments
81 * @return boolean true
83 function prepare($argarray)
85 $this->args =& common_copy_args($argarray);
90 * Show page, a template method.
96 if (Event::handle('StartShowHTML', array($this))) {
98 Event::handle('EndShowHTML', array($this));
100 if (Event::handle('StartShowHead', array($this))) {
102 Event::handle('EndShowHead', array($this));
104 if (Event::handle('StartShowBody', array($this))) {
106 Event::handle('EndShowBody', array($this));
108 if (Event::handle('StartEndHTML', array($this))) {
110 Event::handle('EndEndHTML', array($this));
115 * Show head, a template method.
121 // XXX: attributes (profile?)
122 $this->elementStart('head');
123 if (Event::handle('StartShowHeadElements', array($this))) {
125 $this->showShortcutIcon();
126 $this->showStylesheets();
127 $this->showOpenSearch();
129 $this->showDescription();
131 Event::handle('EndShowHeadElements', array($this));
133 $this->elementEnd('head');
137 * Show title, a template method.
143 $this->element('title', null,
144 sprintf(_("%1\$s - %2\$s"),
146 common_config('site', 'name')));
150 * Returns the page title
154 * @return string page title
159 return _("Untitled page");
163 * Show themed shortcut icon
167 function showShortcutIcon()
169 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
170 $this->element('link', array('rel' => 'shortcut icon',
171 'href' => Theme::path('favicon.ico')));
173 $this->element('link', array('rel' => 'shortcut icon',
174 'href' => common_path('favicon.ico')));
177 if (common_config('site', 'mobile')) {
178 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
179 $this->element('link', array('rel' => 'apple-touch-icon',
180 'href' => Theme::path('apple-touch-icon.png')));
182 $this->element('link', array('rel' => 'apple-touch-icon',
183 'href' => common_path('apple-touch-icon.png')));
193 function showStylesheets()
195 if (Event::handle('StartShowStyles', array($this))) {
197 // Use old name for StatusNet for compatibility on events
199 if (Event::handle('StartShowStatusNetStyles', array($this)) &&
200 Event::handle('StartShowLaconicaStyles', array($this))) {
201 $this->cssLink('css/display.css',null, 'screen, projection, tv, print');
202 Event::handle('EndShowStatusNetStyles', array($this));
203 Event::handle('EndShowLaconicaStyles', array($this));
206 if (Event::handle('StartShowUAStyles', array($this))) {
207 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
208 'href="'.Theme::path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
209 foreach (array(6,7) as $ver) {
210 if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
211 // Yes, IE people should be put in jail.
212 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
213 'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
216 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
217 'href="'.Theme::path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
218 Event::handle('EndShowUAStyles', array($this));
221 if (Event::handle('StartShowDesign', array($this))) {
223 $user = common_current_user();
225 if (empty($user) || $user->viewdesigns) {
226 $design = $this->getDesign();
228 if (!empty($design)) {
229 $design->showCSS($this);
233 Event::handle('EndShowDesign', array($this));
235 Event::handle('EndShowStyles', array($this));
237 if (common_config('custom_css', 'enabled')) {
238 $css = common_config('custom_css', 'css');
239 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
240 if (trim($css) != '') {
243 Event::handle('EndShowCustomCss', array($this));
250 * Show javascript headers
254 function showScripts()
256 if (Event::handle('StartShowScripts', array($this))) {
257 if (Event::handle('StartShowJQueryScripts', array($this))) {
258 $this->script('jquery.min.js');
259 $this->script('jquery.form.js');
260 $this->script('jquery.cookie.js');
261 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.js').'"); }');
262 $this->script('jquery.joverlay.min.js');
263 Event::handle('EndShowJQueryScripts', array($this));
265 if (Event::handle('StartShowStatusNetScripts', array($this)) &&
266 Event::handle('StartShowLaconicaScripts', array($this))) {
267 $this->script('xbImportNode.js');
268 $this->script('util.js');
269 $this->script('geometa.js');
270 // Frame-busting code to avoid clickjacking attacks.
271 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
272 Event::handle('EndShowStatusNetScripts', array($this));
273 Event::handle('EndShowLaconicaScripts', array($this));
275 Event::handle('EndShowScripts', array($this));
280 * Show OpenSearch headers
284 function showOpenSearch()
286 $this->element('link', array('rel' => 'search',
287 'type' => 'application/opensearchdescription+xml',
288 'href' => common_local_url('opensearch', array('type' => 'people')),
289 'title' => common_config('site', 'name').' People Search'));
290 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
291 'href' => common_local_url('opensearch', array('type' => 'notice')),
292 'title' => common_config('site', 'name').' Notice Search'));
305 $feeds = $this->getFeeds();
308 foreach ($feeds as $feed) {
309 $this->element('link', array('rel' => $feed->rel(),
310 'href' => $feed->url,
311 'type' => $feed->mimeType(),
312 'title' => $feed->title));
324 function showDescription()
326 // does nothing by default
330 * Show extra stuff in <head>.
338 // does nothing by default
344 * Calls template methods
350 $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
351 'class' => 'user_in')
352 : array('id' => $this->trimmed('action')));
353 $this->elementStart('div', array('id' => 'wrap'));
354 if (Event::handle('StartShowHeader', array($this))) {
356 Event::handle('EndShowHeader', array($this));
359 if (Event::handle('StartShowFooter', array($this))) {
361 Event::handle('EndShowFooter', array($this));
363 $this->elementEnd('div');
364 $this->showScripts();
365 $this->elementEnd('body');
369 * Show header of the page.
371 * Calls template methods
375 function showHeader()
377 $this->elementStart('div', array('id' => 'header'));
379 $this->showPrimaryNav();
380 if (Event::handle('StartShowSiteNotice', array($this))) {
381 $this->showSiteNotice();
383 Event::handle('EndShowSiteNotice', array($this));
385 if (common_logged_in()) {
386 $this->showNoticeForm();
388 $this->showAnonymousMessage();
390 $this->elementEnd('div');
394 * Show configured logo.
400 $this->elementStart('address', array('id' => 'site_contact',
401 'class' => 'vcard'));
402 if (Event::handle('StartAddressData', array($this))) {
403 if (common_config('singleuser', 'enabled')) {
404 $url = common_local_url('showstream',
405 array('nickname' => common_config('singleuser', 'nickname')));
407 $url = common_local_url('public');
409 $this->elementStart('a', array('class' => 'url home bookmark',
411 if (common_config('site', 'logo') || file_exists(Theme::file('logo.png'))) {
412 $this->element('img', array('class' => 'logo photo',
413 'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png'),
414 'alt' => common_config('site', 'name')));
417 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
418 $this->elementEnd('a');
419 Event::handle('EndAddressData', array($this));
421 $this->elementEnd('address');
425 * Show primary navigation.
429 function showPrimaryNav()
431 $user = common_current_user();
432 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
433 $this->element('dt', null, _('Primary site navigation'));
434 $this->elementStart('dd');
435 $this->elementStart('ul', array('class' => 'nav'));
436 if (Event::handle('StartPrimaryNav', array($this))) {
438 // TRANS: Tooltip for main menu option "Personal"
439 $tooltip = _m('TOOLTIP', 'Personal profile and friends timeline');
440 // TRANS: Main menu option when logged in for access to personal profile and friends timeline
441 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
442 _m('MENU', 'Personal'), $tooltip, false, 'nav_home');
443 // TRANS: Tooltip for main menu option "Account"
444 $tooltip = _m('TOOLTIP', 'Change your email, avatar, password, profile');
445 // TRANS: Main menu option when logged in for access to user settings
446 $this->menuItem(common_local_url('profilesettings'),
447 _('Account'), $tooltip, false, 'nav_account');
448 // TRANS: Tooltip for main menu option "Services"
449 $tooltip = _m('TOOLTIP', 'Connect to services');
450 // TRANS: Main menu option when logged in and connection are possible for access to options to connect to other services
451 $this->menuItem(common_local_url('oauthconnectionssettings'),
452 _('Connect'), $tooltip, false, 'nav_connect');
453 if ($user->hasRight(Right::CONFIGURESITE)) {
454 // TRANS: Tooltip for menu option "Admin"
455 $tooltip = _m('TOOLTIP', 'Change site configuration');
456 // TRANS: Main menu option when logged in and site admin for access to site configuration
457 $this->menuItem(common_local_url('siteadminpanel'),
458 _m('MENU', 'Admin'), $tooltip, false, 'nav_admin');
460 if (common_config('invite', 'enabled')) {
461 // TRANS: Tooltip for main menu option "Invite"
462 $tooltip = _m('TOOLTIP', 'Invite friends and colleagues to join you on %s');
463 // TRANS: Main menu option when logged in and invitations are allowed for inviting new users
464 $this->menuItem(common_local_url('invite'),
465 _m('MENU', 'Invite'),
467 common_config('site', 'name')),
468 false, 'nav_invitecontact');
470 // TRANS: Tooltip for main menu option "Logout"
471 $tooltip = _m('TOOLTIP', 'Logout from the site');
472 // TRANS: Main menu option when logged in to log out the current user
473 $this->menuItem(common_local_url('logout'),
474 _m('MENU', 'Logout'), $tooltip, false, 'nav_logout');
477 if (!common_config('site', 'closed') && !common_config('site', 'inviteonly')) {
478 // TRANS: Tooltip for main menu option "Register"
479 $tooltip = _m('TOOLTIP', 'Create an account');
480 // TRANS: Main menu option when not logged in to register a new account
481 $this->menuItem(common_local_url('register'),
482 _m('MENU', 'Register'), $tooltip, false, 'nav_register');
484 // TRANS: Tooltip for main menu option "Login"
485 $tooltip = _m('TOOLTIP', 'Login to the site');
486 // TRANS: Main menu option when not logged in to log in
487 $this->menuItem(common_local_url('login'),
488 _m('MENU', 'Login'), $tooltip, false, 'nav_login');
490 // TRANS: Tooltip for main menu option "Help"
491 $tooltip = _m('TOOLTIP', 'Help me!');
492 // TRANS: Main menu option for help on the StatusNet site
493 $this->menuItem(common_local_url('doc', array('title' => 'help')),
494 _m('MENU', 'Help'), $tooltip, false, 'nav_help');
495 if ($user || !common_config('site', 'private')) {
496 // TRANS: Tooltip for main menu option "Search"
497 $tooltip = _m('TOOLTIP', 'Search for people or text');
498 // TRANS: Main menu option when logged in or when the StatusNet instance is not private
499 $this->menuItem(common_local_url('peoplesearch'),
500 _m('MENU', 'Search'), $tooltip, false, 'nav_search');
502 Event::handle('EndPrimaryNav', array($this));
504 $this->elementEnd('ul');
505 $this->elementEnd('dd');
506 $this->elementEnd('dl');
514 function showSiteNotice()
516 // Revist. Should probably do an hAtom pattern here
517 $text = common_config('site', 'notice');
519 $this->elementStart('dl', array('id' => 'site_notice',
520 'class' => 'system_notice'));
521 // TRANS: DT element for site notice. String is hidden in default CSS.
522 $this->element('dt', null, _('Site notice'));
523 $this->elementStart('dd', null);
525 $this->elementEnd('dd');
526 $this->elementEnd('dl');
533 * MAY overload if no notice form needed... or direct message box????
537 function showNoticeForm()
539 $notice_form = new NoticeForm($this);
540 $notice_form->show();
544 * Show anonymous message.
550 function showAnonymousMessage()
552 // needs to be defined by the class
558 * Shows local navigation, content block and aside.
564 $this->elementStart('div', array('id' => 'core'));
565 if (Event::handle('StartShowLocalNavBlock', array($this))) {
566 $this->showLocalNavBlock();
567 Event::handle('EndShowLocalNavBlock', array($this));
569 if (Event::handle('StartShowContentBlock', array($this))) {
570 $this->showContentBlock();
571 Event::handle('EndShowContentBlock', array($this));
573 if (Event::handle('StartShowAside', array($this))) {
575 Event::handle('EndShowAside', array($this));
577 $this->elementEnd('div');
581 * Show local navigation block.
585 function showLocalNavBlock()
587 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
588 $this->element('dt', null, _('Local views'));
589 $this->elementStart('dd');
590 $this->showLocalNav();
591 $this->elementEnd('dd');
592 $this->elementEnd('dl');
596 * Show local navigation.
602 function showLocalNav()
604 // does nothing by default
608 * Show content block.
612 function showContentBlock()
614 $this->elementStart('div', array('id' => 'content'));
615 $this->showPageTitle();
616 $this->showPageNoticeBlock();
617 $this->elementStart('div', array('id' => 'content_inner'));
618 // show the actual content (forms, lists, whatever)
619 $this->showContent();
620 $this->elementEnd('div');
621 $this->elementEnd('div');
629 function showPageTitle()
631 $this->element('h1', null, $this->title());
635 * Show page notice block.
637 * Only show the block if a subclassed action has overrided
638 * Action::showPageNotice(), or an event handler is registered for
639 * the StartShowPageNotice event, in which case we assume the
640 * 'page_notice' definition list is desired. This is to prevent
641 * empty 'page_notice' definition lists from being output everywhere.
645 function showPageNoticeBlock()
647 $rmethod = new ReflectionMethod($this, 'showPageNotice');
648 $dclass = $rmethod->getDeclaringClass()->getName();
650 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
652 $this->elementStart('dl', array('id' => 'page_notice',
653 'class' => 'system_notice'));
654 $this->element('dt', null, _('Page notice'));
655 $this->elementStart('dd');
656 if (Event::handle('StartShowPageNotice', array($this))) {
657 $this->showPageNotice();
658 Event::handle('EndShowPageNotice', array($this));
660 $this->elementEnd('dd');
661 $this->elementEnd('dl');
668 * SHOULD overload (unless there's not a notice)
672 function showPageNotice()
679 * MUST overload (unless there's not a notice)
683 function showContent()
695 $this->elementStart('div', array('id' => 'aside_primary',
696 'class' => 'aside'));
697 if (Event::handle('StartShowExportData', array($this))) {
698 $this->showExportData();
699 Event::handle('EndShowExportData', array($this));
701 if (Event::handle('StartShowSections', array($this))) {
702 $this->showSections();
703 Event::handle('EndShowSections', array($this));
705 $this->elementEnd('div');
709 * Show export data feeds.
714 function showExportData()
716 $feeds = $this->getFeeds();
718 $fl = new FeedList($this);
730 function showSections()
732 // for each section, show it
740 function showFooter()
742 $this->elementStart('div', array('id' => 'footer'));
743 $this->showSecondaryNav();
744 $this->showLicenses();
745 $this->elementEnd('div');
749 * Show secondary navigation.
753 function showSecondaryNav()
755 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
756 $this->element('dt', null, _('Secondary site navigation'));
757 $this->elementStart('dd', null);
758 $this->elementStart('ul', array('class' => 'nav'));
759 if (Event::handle('StartSecondaryNav', array($this))) {
760 $this->menuItem(common_local_url('doc', array('title' => 'help')),
762 $this->menuItem(common_local_url('doc', array('title' => 'about')),
764 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
766 $bb = common_config('site', 'broughtby');
768 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
771 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
773 $this->menuItem(common_local_url('doc', array('title' => 'source')),
775 $this->menuItem(common_local_url('version'),
777 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
779 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
781 Event::handle('EndSecondaryNav', array($this));
783 $this->elementEnd('ul');
784 $this->elementEnd('dd');
785 $this->elementEnd('dl');
793 function showLicenses()
795 $this->elementStart('dl', array('id' => 'licenses'));
796 $this->showStatusNetLicense();
797 $this->showContentLicense();
798 $this->elementEnd('dl');
802 * Show StatusNet license.
806 function showStatusNetLicense()
808 $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
809 $this->elementStart('dd', null);
810 // @fixme drop the final spaces in the messages when at good spot
811 // to let translations get updated.
812 if (common_config('site', 'broughtby')) {
813 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
815 $instr = _('**%%site.name%%** is a microblogging service. ');
818 $instr .= sprintf(_('It runs the [StatusNet](http://status.net/) microblogging software, version %s, available under the [GNU Affero General Public License](http://www.fsf.org/licensing/licenses/agpl-3.0.html).'), STATUSNET_VERSION);
819 $output = common_markup_to_html($instr);
821 $this->elementEnd('dd');
826 * Show content license.
830 function showContentLicense()
832 if (Event::handle('StartShowContentLicense', array($this))) {
833 $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
834 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
836 switch (common_config('license', 'type')) {
838 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
839 common_config('site', 'name')));
841 case 'allrightsreserved':
842 if (common_config('license', 'owner')) {
843 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
844 common_config('license', 'owner')));
846 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
849 case 'cc': // fall through
851 $this->elementStart('p');
852 $this->element('img', array('id' => 'license_cc',
853 'src' => common_config('license', 'image'),
854 'alt' => common_config('license', 'title'),
858 // TRANS: license message in footer. %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
859 $notice = _('All %1$s content and data are available under the %2$s license.');
860 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
861 htmlspecialchars(common_config('license', 'url')) .
863 htmlspecialchars(common_config('license', 'title')) .
865 $this->raw(sprintf(htmlspecialchars($notice),
866 htmlspecialchars(common_config('site', 'name')),
868 $this->elementEnd('p');
872 $this->elementEnd('dd');
873 Event::handle('EndShowContentLicense', array($this));
878 * Return last modified, if applicable.
882 * @return string last modified http header
884 function lastModified()
886 // For comparison with If-Last-Modified
887 // If not applicable, return null
892 * Return etag, if applicable.
896 * @return string etag http header
904 * Return true if read only.
908 * @param array $args other arguments
910 * @return boolean is read only action?
913 function isReadOnly($args)
919 * Returns query argument or default value if not found
921 * @param string $key requested argument
922 * @param string $def default value to return if $key is not provided
924 * @return boolean is read only action?
926 function arg($key, $def=null)
928 if (array_key_exists($key, $this->args)) {
929 return $this->args[$key];
936 * Returns trimmed query argument or default value if not found
938 * @param string $key requested argument
939 * @param string $def default value to return if $key is not provided
941 * @return boolean is read only action?
943 function trimmed($key, $def=null)
945 $arg = $this->arg($key, $def);
946 return is_string($arg) ? trim($arg) : $arg;
952 * @param array $argarray is ignored since it's now passed in in prepare()
954 * @return boolean is read only action?
956 function handle($argarray=null)
958 header('Vary: Accept-Encoding,Cookie');
959 $lm = $this->lastModified();
960 $etag = $this->etag();
962 header('ETag: ' . $etag);
965 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
966 if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
967 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
968 $ims = strtotime($if_modified_since);
970 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
971 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
972 if (!$if_none_match ||
974 $this->_hasEtag($etag, $if_none_match)) {
975 header('HTTP/1.1 304 Not Modified');
976 // Better way to do this?
985 * Has etag? (private)
987 * @param string $etag etag http header
988 * @param string $if_none_match ifNoneMatch http header
993 function _hasEtag($etag, $if_none_match)
995 $etags = explode(',', $if_none_match);
996 return in_array($etag, $etags) || in_array('*', $etags);
1000 * Boolean understands english (yes, no, true, false)
1002 * @param string $key query key we're interested in
1003 * @param string $def default value
1005 * @return boolean interprets yes/no strings as boolean
1007 function boolean($key, $def=false)
1009 $arg = strtolower($this->trimmed($key));
1011 if (is_null($arg)) {
1013 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1015 } else if (in_array($arg, array('false', 'no', '0'))) {
1023 * Integer value of an argument
1025 * @param string $key query key we're interested in
1026 * @param string $defValue optional default value (default null)
1027 * @param string $maxValue optional max value (default null)
1028 * @param string $minValue optional min value (default null)
1030 * @return integer integer value
1033 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1035 $arg = strtolower($this->trimmed($key));
1037 if (is_null($arg) || !is_integer($arg)) {
1041 if (!is_null($maxValue)) {
1042 $arg = min($arg, $maxValue);
1045 if (!is_null($minValue)) {
1046 $arg = max($arg, $minValue);
1055 * @param string $msg error message to display
1056 * @param integer $code http error code, 500 by default
1061 function serverError($msg, $code=500)
1063 $action = $this->trimmed('action');
1064 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1065 throw new ServerException($msg, $code);
1071 * @param string $msg error message to display
1072 * @param integer $code http error code, 400 by default
1077 function clientError($msg, $code=400)
1079 $action = $this->trimmed('action');
1080 common_debug("User error '$code' on '$action': $msg", __FILE__);
1081 throw new ClientException($msg, $code);
1085 * Returns the current URL
1087 * @return string current URL
1092 list($action, $args) = $this->returnToArgs();
1093 return common_local_url($action, $args);
1097 * Returns arguments sufficient for re-constructing URL
1099 * @return array two elements: action, other args
1102 function returnToArgs()
1104 $action = $this->trimmed('action');
1105 $args = $this->args;
1106 unset($args['action']);
1107 if (common_config('site', 'fancy')) {
1110 if (array_key_exists('submit', $args)) {
1111 unset($args['submit']);
1113 foreach (array_keys($_COOKIE) as $cookie) {
1114 unset($args[$cookie]);
1116 return array($action, $args);
1120 * Generate a menu item
1122 * @param string $url menu URL
1123 * @param string $text menu name
1124 * @param string $title title attribute, null by default
1125 * @param boolean $is_selected current menu item, false by default
1126 * @param string $id element id, null by default
1130 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1132 // Added @id to li for some control.
1133 // XXX: We might want to move this to htmloutputter.php
1136 $lattrs['class'] = 'current';
1139 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1141 $this->elementStart('li', $lattrs);
1142 $attrs['href'] = $url;
1144 $attrs['title'] = $title;
1146 $this->element('a', $attrs, $text);
1147 $this->elementEnd('li');
1151 * Generate pagination links
1153 * @param boolean $have_before is there something before?
1154 * @param boolean $have_after is there something after?
1155 * @param integer $page current page
1156 * @param string $action current action
1157 * @param array $args rest of query arguments
1161 function pagination($have_before, $have_after, $page, $action, $args=null)
1163 // Does a little before-after block for next/prev page
1164 if ($have_before || $have_after) {
1165 $this->elementStart('dl', 'pagination');
1166 $this->element('dt', null, _('Pagination'));
1167 $this->elementStart('dd', null);
1168 $this->elementStart('ul', array('class' => 'nav'));
1171 $pargs = array('page' => $page-1);
1172 $this->elementStart('li', array('class' => 'nav_prev'));
1173 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1176 $this->elementEnd('li');
1179 $pargs = array('page' => $page+1);
1180 $this->elementStart('li', array('class' => 'nav_next'));
1181 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1184 $this->elementEnd('li');
1186 if ($have_before || $have_after) {
1187 $this->elementEnd('ul');
1188 $this->elementEnd('dd');
1189 $this->elementEnd('dl');
1194 * An array of feeds for this action.
1196 * Returns an array of potential feeds for this action.
1198 * @return array Feed object to show in head and links
1207 * A design for this action
1209 * @return Design a design object to use
1212 function getDesign()
1214 return Design::siteDesign();
1218 * Check the session token.
1220 * Checks that the current form has the correct session token,
1221 * and throw an exception if it does not.
1226 function checkSessionToken()
1229 $token = $this->trimmed('token');
1230 if (empty($token) || $token != common_session_token()) {
1231 $this->clientError(_('There was a problem with your session token.'));