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));
118 if (isset($_startTime)) {
119 $endTime = microtime(true);
120 $diff = round(($endTime - $_startTime) * 1000);
121 $this->raw("<!-- ${diff}ms -->");
124 return parent::endHTML();
128 * Show head, a template method.
134 // XXX: attributes (profile?)
135 $this->elementStart('head');
136 if (Event::handle('StartShowHeadElements', array($this))) {
137 if (Event::handle('StartShowHeadTitle', array($this))) {
139 Event::handle('EndShowHeadTitle', array($this));
141 $this->showShortcutIcon();
142 $this->showStylesheets();
143 $this->showOpenSearch();
145 $this->showDescription();
147 Event::handle('EndShowHeadElements', array($this));
149 $this->elementEnd('head');
153 * Show title, a template method.
159 $this->element('title', null,
160 // TRANS: Page title. %1$s is the title, %2$s is the site name.
161 sprintf(_("%1\$s - %2\$s"),
163 common_config('site', 'name')));
167 * Returns the page title
171 * @return string page title
176 // TRANS: Page title for a page without a title set.
177 return _("Untitled page");
181 * Show themed shortcut icon
185 function showShortcutIcon()
187 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
188 $this->element('link', array('rel' => 'shortcut icon',
189 'href' => Theme::path('favicon.ico')));
191 // favicon.ico should be HTTPS if the rest of the page is
192 $this->element('link', array('rel' => 'shortcut icon',
193 'href' => common_path('favicon.ico', StatusNet::isHTTPS())));
196 if (common_config('site', 'mobile')) {
197 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
198 $this->element('link', array('rel' => 'apple-touch-icon',
199 'href' => Theme::path('apple-touch-icon.png')));
201 $this->element('link', array('rel' => 'apple-touch-icon',
202 'href' => common_path('apple-touch-icon.png')));
212 function showStylesheets()
214 if (Event::handle('StartShowStyles', array($this))) {
216 // Use old name for StatusNet for compatibility on events
218 if (Event::handle('StartShowStatusNetStyles', array($this)) &&
219 Event::handle('StartShowLaconicaStyles', array($this))) {
220 $this->primaryCssLink(null, 'screen, projection, tv, print');
221 Event::handle('EndShowStatusNetStyles', array($this));
222 Event::handle('EndShowLaconicaStyles', array($this));
225 if (Event::handle('StartShowUAStyles', array($this))) {
226 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
227 'href="'.Theme::path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
228 foreach (array(6,7) as $ver) {
229 if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
230 // Yes, IE people should be put in jail.
231 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
232 'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
235 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
236 'href="'.Theme::path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
237 Event::handle('EndShowUAStyles', array($this));
240 if (Event::handle('StartShowDesign', array($this))) {
242 $user = common_current_user();
244 if (empty($user) || $user->viewdesigns) {
245 $design = $this->getDesign();
247 if (!empty($design)) {
248 $design->showCSS($this);
252 Event::handle('EndShowDesign', array($this));
254 Event::handle('EndShowStyles', array($this));
256 if (common_config('custom_css', 'enabled')) {
257 $css = common_config('custom_css', 'css');
258 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
259 if (trim($css) != '') {
262 Event::handle('EndShowCustomCss', array($this));
268 function primaryCssLink($mainTheme=null, $media=null)
270 // If the currently-selected theme has dependencies on other themes,
271 // we'll need to load their display.css files as well in order.
272 $theme = new Theme($mainTheme);
273 $baseThemes = $theme->getDeps();
274 foreach ($baseThemes as $baseTheme) {
275 $this->cssLink('css/display.css', $baseTheme, $media);
277 $this->cssLink('css/display.css', $mainTheme, $media);
281 * Show javascript headers
285 function showScripts()
287 if (Event::handle('StartShowScripts', array($this))) {
288 if (Event::handle('StartShowJQueryScripts', array($this))) {
289 $this->script('jquery.min.js');
290 $this->script('jquery.form.min.js');
291 $this->script('jquery.cookie.min.js');
292 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.min.js').'"); }');
293 $this->script('jquery.joverlay.min.js');
294 Event::handle('EndShowJQueryScripts', array($this));
296 if (Event::handle('StartShowStatusNetScripts', array($this)) &&
297 Event::handle('StartShowLaconicaScripts', array($this))) {
298 $this->script('util.min.js');
299 $this->showScriptMessages();
300 // Frame-busting code to avoid clickjacking attacks.
301 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
302 Event::handle('EndShowStatusNetScripts', array($this));
303 Event::handle('EndShowLaconicaScripts', array($this));
305 Event::handle('EndShowScripts', array($this));
310 * Exports a map of localized text strings to JavaScript code.
312 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
313 * events and appending to the array. Try to avoid adding strings that won't be used, as
314 * they'll be added to HTML output.
317 function showScriptMessages()
321 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
322 // Common messages needed for timeline views etc...
324 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
325 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
327 $messages = array_merge($messages, $this->getScriptMessages());
329 Event::handle('EndScriptMessages', array($this, &$messages));
332 if (!empty($messages)) {
333 $this->inlineScript('SN.messages=' . json_encode($messages));
340 * If the action will need localizable text strings, export them here like so:
342 * return array('pool_deepend' => _('Deep end'),
343 * 'pool_shallow' => _('Shallow end'));
345 * The exported map will be available via SN.msg() to JS code:
347 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
348 * $('#pool .deepend').text(SN.msg('pool_deepend'));
349 * $('#pool .shallow').text(SN.msg('pool_shallow'));
351 * Exports a map of localized text strings to JavaScript code.
353 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
354 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
355 * be used, as they'll be added to HTML output.
357 function getScriptMessages()
363 * Show OpenSearch headers
367 function showOpenSearch()
369 $this->element('link', array('rel' => 'search',
370 'type' => 'application/opensearchdescription+xml',
371 'href' => common_local_url('opensearch', array('type' => 'people')),
372 'title' => common_config('site', 'name').' People Search'));
373 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
374 'href' => common_local_url('opensearch', array('type' => 'notice')),
375 'title' => common_config('site', 'name').' Notice Search'));
387 $feeds = $this->getFeeds();
390 foreach ($feeds as $feed) {
391 $this->element('link', array('rel' => $feed->rel(),
392 'href' => $feed->url,
393 'type' => $feed->mimeType(),
394 'title' => $feed->title));
406 function showDescription()
408 // does nothing by default
412 * Show extra stuff in <head>.
420 // does nothing by default
426 * Calls template methods
432 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
433 'class' => 'user_in')
434 : array('id' => strtolower($this->trimmed('action'))));
435 $this->elementStart('div', array('id' => 'wrap'));
436 if (Event::handle('StartShowHeader', array($this))) {
438 Event::handle('EndShowHeader', array($this));
441 if (Event::handle('StartShowFooter', array($this))) {
443 Event::handle('EndShowFooter', array($this));
445 $this->elementEnd('div');
446 $this->showScripts();
447 $this->elementEnd('body');
451 * Show header of the page.
453 * Calls template methods
457 function showHeader()
459 $this->elementStart('div', array('id' => 'header'));
461 $this->showPrimaryNav();
462 if (Event::handle('StartShowSiteNotice', array($this))) {
463 $this->showSiteNotice();
465 Event::handle('EndShowSiteNotice', array($this));
468 $this->elementEnd('div');
472 * Show configured logo.
478 $this->elementStart('address', array('id' => 'site_contact',
479 'class' => 'vcard'));
480 if (Event::handle('StartAddressData', array($this))) {
481 if (common_config('singleuser', 'enabled')) {
482 $user = User::singleUser();
483 $url = common_local_url('showstream',
484 array('nickname' => $user->nickname));
485 } else if (common_logged_in()) {
486 $cur = common_current_user();
487 $url = common_local_url('all', array('nickname' => $cur->nickname));
489 $url = common_local_url('public');
492 $this->elementStart('a', array('class' => 'url home bookmark',
495 if (StatusNet::isHTTPS()) {
496 $logoUrl = common_config('site', 'ssllogo');
497 if (empty($logoUrl)) {
498 // if logo is an uploaded file, try to fall back to HTTPS file URL
499 $httpUrl = common_config('site', 'logo');
500 if (!empty($httpUrl)) {
501 $f = File::staticGet('url', $httpUrl);
502 if (!empty($f) && !empty($f->filename)) {
503 // this will handle the HTTPS case
504 $logoUrl = File::url($f->filename);
509 $logoUrl = common_config('site', 'logo');
512 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
513 // This should handle the HTTPS case internally
514 $logoUrl = Theme::path('logo.png');
517 if (!empty($logoUrl)) {
518 $this->element('img', array('class' => 'logo photo',
520 'alt' => common_config('site', 'name')));
524 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
525 $this->elementEnd('a');
527 Event::handle('EndAddressData', array($this));
529 $this->elementEnd('address');
533 * Show primary navigation.
537 function showPrimaryNav()
539 $pn = new PrimaryNav($this);
548 function showSiteNotice()
550 // Revist. Should probably do an hAtom pattern here
551 $text = common_config('site', 'notice');
553 $this->elementStart('div', array('id' => 'site_notice',
554 'class' => 'system_notice'));
556 $this->elementEnd('div');
563 * MAY overload if no notice form needed... or direct message box????
567 function showNoticeForm()
569 $notice_form = new NoticeForm($this);
570 $notice_form->show();
574 * Show anonymous message.
580 function showAnonymousMessage()
582 // needs to be defined by the class
588 * Shows local navigation, content block and aside.
594 $this->elementStart('div', array('id' => 'core'));
595 if (Event::handle('StartShowLocalNavBlock', array($this))) {
596 $this->showLocalNavBlock();
597 Event::handle('EndShowLocalNavBlock', array($this));
599 if (Event::handle('StartShowContentBlock', array($this))) {
600 $this->showContentBlock();
601 Event::handle('EndShowContentBlock', array($this));
603 if (Event::handle('StartShowObjectNavBlock', array($this))) {
604 $this->showObjectNavBlock();
605 Event::handle('EndShowObjectNavBlock', array($this));
607 if (Event::handle('StartShowAside', array($this))) {
609 Event::handle('EndShowAside', array($this));
611 $this->elementEnd('div');
615 * Show local navigation block.
619 function showLocalNavBlock()
621 // Need to have this ID for CSS; I'm too lazy to add it to
623 $this->elementStart('div', array('id' => 'site_nav_local_views'));
624 $this->showLocalNav();
625 $this->elementEnd('div');
629 * Show local navigation.
635 function showLocalNav()
637 $nav = new DefaultLocalNav($this);
642 * Show menu for an object (group, profile)
646 function showObjectNavBlock()
648 // Need to have this ID for CSS; I'm too lazy to add it to
650 $this->elementStart('div', array('id' => 'site_nav_object'));
651 $this->showObjectNav();
652 $this->elementEnd('div');
656 * Show object navigation.
658 * If there are things to do with this object, show it here.
662 function showObjectNav()
668 * Show content block.
672 function showContentBlock()
674 $this->elementStart('div', array('id' => 'content'));
675 if (common_logged_in()) {
676 if (Event::handle('StartShowNoticeForm', array($this))) {
677 $this->showNoticeForm();
678 Event::handle('EndShowNoticeForm', array($this));
681 if (Event::handle('StartShowPageTitle', array($this))) {
682 $this->showPageTitle();
683 Event::handle('EndShowPageTitle', array($this));
685 $this->showPageNoticeBlock();
686 $this->elementStart('div', array('id' => 'content_inner'));
687 // show the actual content (forms, lists, whatever)
688 $this->showContent();
689 $this->elementEnd('div');
690 $this->elementEnd('div');
698 function showPageTitle()
700 $this->element('h1', null, $this->title());
704 * Show page notice block.
706 * Only show the block if a subclassed action has overrided
707 * Action::showPageNotice(), or an event handler is registered for
708 * the StartShowPageNotice event, in which case we assume the
709 * 'page_notice' definition list is desired. This is to prevent
710 * empty 'page_notice' definition lists from being output everywhere.
714 function showPageNoticeBlock()
716 $rmethod = new ReflectionMethod($this, 'showPageNotice');
717 $dclass = $rmethod->getDeclaringClass()->getName();
719 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
721 $this->elementStart('div', array('id' => 'page_notice',
722 'class' => 'system_notice'));
723 if (Event::handle('StartShowPageNotice', array($this))) {
724 $this->showPageNotice();
725 Event::handle('EndShowPageNotice', array($this));
727 $this->elementEnd('div');
734 * SHOULD overload (unless there's not a notice)
738 function showPageNotice()
745 * MUST overload (unless there's not a notice)
749 function showContent()
760 $this->elementStart('div', array('id' => 'aside_primary',
761 'class' => 'aside'));
762 if (Event::handle('StartShowSections', array($this))) {
763 $this->showSections();
764 Event::handle('EndShowSections', array($this));
766 if (Event::handle('StartShowExportData', array($this))) {
767 $this->showExportData();
768 Event::handle('EndShowExportData', array($this));
770 $this->elementEnd('div');
774 * Show export data feeds.
778 function showExportData()
780 $feeds = $this->getFeeds();
782 $fl = new FeedList($this);
794 function showSections()
796 // for each section, show it
804 function showFooter()
806 $this->elementStart('div', array('id' => 'footer'));
807 if (Event::handle('StartShowInsideFooter', array($this))) {
808 $this->showSecondaryNav();
809 $this->showLicenses();
810 Event::handle('EndShowInsideFooter', array($this));
812 $this->elementEnd('div');
816 * Show secondary navigation.
820 function showSecondaryNav()
822 $sn = new SecondaryNav($this);
831 function showLicenses()
833 $this->showStatusNetLicense();
834 $this->showContentLicense();
838 * Show StatusNet license.
842 function showStatusNetLicense()
844 if (common_config('site', 'broughtby')) {
845 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
846 // TRANS: Text between [] is a link description, text between () is the link itself.
847 // TRANS: Make sure there is no whitespace between "]" and "(".
848 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
849 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
851 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
852 $instr = _('**%%site.name%%** is a microblogging service.');
855 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
856 // TRANS: Make sure there is no whitespace between "]" and "(".
857 // TRANS: Text between [] is a link description, text between () is the link itself.
858 // TRANS: %s is the version of StatusNet that is being used.
859 $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);
860 $output = common_markup_to_html($instr);
866 * Show content license.
870 function showContentLicense()
872 if (Event::handle('StartShowContentLicense', array($this))) {
873 switch (common_config('license', 'type')) {
875 // TRANS: Content license displayed when license is set to 'private'.
876 // TRANS: %1$s is the site name.
877 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
878 common_config('site', 'name')));
880 case 'allrightsreserved':
881 if (common_config('license', 'owner')) {
882 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
883 // TRANS: %1$s is the copyright owner.
884 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
885 common_config('license', 'owner')));
887 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
888 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
891 case 'cc': // fall through
893 $this->elementStart('p');
895 $image = common_config('license', 'image');
896 $sslimage = common_config('license', 'sslimage');
898 if (StatusNet::isHTTPS()) {
899 if (!empty($sslimage)) {
901 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
902 // CC support HTTPS on their images
903 $url = preg_replace('/^http/', 'https', $image);
905 // Better to show mixed content than no content
912 $this->element('img', array('id' => 'license_cc',
914 'alt' => common_config('license', 'title'),
918 // TRANS: license message in footer.
919 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
920 $notice = _('All %1$s content and data are available under the %2$s license.');
921 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
922 htmlspecialchars(common_config('license', 'url')) .
924 htmlspecialchars(common_config('license', 'title')) .
926 $this->raw(sprintf(htmlspecialchars($notice),
927 htmlspecialchars(common_config('site', 'name')),
929 $this->elementEnd('p');
933 Event::handle('EndShowContentLicense', array($this));
938 * Return last modified, if applicable.
942 * @return string last modified http header
944 function lastModified()
946 // For comparison with If-Last-Modified
947 // If not applicable, return null
952 * Return etag, if applicable.
956 * @return string etag http header
964 * Return true if read only.
968 * @param array $args other arguments
970 * @return boolean is read only action?
972 function isReadOnly($args)
978 * Returns query argument or default value if not found
980 * @param string $key requested argument
981 * @param string $def default value to return if $key is not provided
983 * @return boolean is read only action?
985 function arg($key, $def=null)
987 if (array_key_exists($key, $this->args)) {
988 return $this->args[$key];
995 * Returns trimmed query argument or default value if not found
997 * @param string $key requested argument
998 * @param string $def default value to return if $key is not provided
1000 * @return boolean is read only action?
1002 function trimmed($key, $def=null)
1004 $arg = $this->arg($key, $def);
1005 return is_string($arg) ? trim($arg) : $arg;
1011 * @param array $argarray is ignored since it's now passed in in prepare()
1013 * @return boolean is read only action?
1015 function handle($argarray=null)
1017 header('Vary: Accept-Encoding,Cookie');
1019 $lm = $this->lastModified();
1020 $etag = $this->etag();
1023 header('ETag: ' . $etag);
1027 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1028 if ($this->isCacheable()) {
1029 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1030 header( "Cache-Control: private, must-revalidate, max-age=0" );
1037 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1038 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1039 if ($if_none_match) {
1040 // If this check fails, ignore the if-modified-since below.
1042 if ($this->_hasEtag($etag, $if_none_match)) {
1043 header('HTTP/1.1 304 Not Modified');
1044 // Better way to do this?
1050 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1051 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1052 $ims = strtotime($if_modified_since);
1054 header('HTTP/1.1 304 Not Modified');
1055 // Better way to do this?
1062 * Is this action cacheable?
1064 * If the action returns a last-modified
1066 * @param array $argarray is ignored since it's now passed in in prepare()
1068 * @return boolean is read only action?
1070 function isCacheable()
1076 * Has etag? (private)
1078 * @param string $etag etag http header
1079 * @param string $if_none_match ifNoneMatch http header
1083 function _hasEtag($etag, $if_none_match)
1085 $etags = explode(',', $if_none_match);
1086 return in_array($etag, $etags) || in_array('*', $etags);
1090 * Boolean understands english (yes, no, true, false)
1092 * @param string $key query key we're interested in
1093 * @param string $def default value
1095 * @return boolean interprets yes/no strings as boolean
1097 function boolean($key, $def=false)
1099 $arg = strtolower($this->trimmed($key));
1101 if (is_null($arg)) {
1103 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1105 } else if (in_array($arg, array('false', 'no', '0'))) {
1113 * Integer value of an argument
1115 * @param string $key query key we're interested in
1116 * @param string $defValue optional default value (default null)
1117 * @param string $maxValue optional max value (default null)
1118 * @param string $minValue optional min value (default null)
1120 * @return integer integer value
1122 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1124 $arg = strtolower($this->trimmed($key));
1126 if (is_null($arg) || !is_integer($arg)) {
1130 if (!is_null($maxValue)) {
1131 $arg = min($arg, $maxValue);
1134 if (!is_null($minValue)) {
1135 $arg = max($arg, $minValue);
1144 * @param string $msg error message to display
1145 * @param integer $code http error code, 500 by default
1149 function serverError($msg, $code=500)
1151 $action = $this->trimmed('action');
1152 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1153 throw new ServerException($msg, $code);
1159 * @param string $msg error message to display
1160 * @param integer $code http error code, 400 by default
1164 function clientError($msg, $code=400)
1166 $action = $this->trimmed('action');
1167 common_debug("User error '$code' on '$action': $msg", __FILE__);
1168 throw new ClientException($msg, $code);
1172 * Returns the current URL
1174 * @return string current URL
1178 list($action, $args) = $this->returnToArgs();
1179 return common_local_url($action, $args);
1183 * Returns arguments sufficient for re-constructing URL
1185 * @return array two elements: action, other args
1187 function returnToArgs()
1189 $action = $this->trimmed('action');
1190 $args = $this->args;
1191 unset($args['action']);
1192 if (common_config('site', 'fancy')) {
1195 if (array_key_exists('submit', $args)) {
1196 unset($args['submit']);
1198 foreach (array_keys($_COOKIE) as $cookie) {
1199 unset($args[$cookie]);
1201 return array($action, $args);
1205 * Generate a menu item
1207 * @param string $url menu URL
1208 * @param string $text menu name
1209 * @param string $title title attribute, null by default
1210 * @param boolean $is_selected current menu item, false by default
1211 * @param string $id element id, null by default
1215 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1217 // Added @id to li for some control.
1218 // XXX: We might want to move this to htmloutputter.php
1221 $lattrs['class'] = 'current';
1224 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1226 $this->elementStart('li', $lattrs);
1227 $attrs['href'] = $url;
1229 $attrs['title'] = $title;
1231 $this->element('a', $attrs, $text);
1232 $this->elementEnd('li');
1236 * Generate pagination links
1238 * @param boolean $have_before is there something before?
1239 * @param boolean $have_after is there something after?
1240 * @param integer $page current page
1241 * @param string $action current action
1242 * @param array $args rest of query arguments
1246 // XXX: The messages in this pagination method only tailor to navigating
1247 // notices. In other lists, "Previous"/"Next" type navigation is
1248 // desirable, but not available.
1249 function pagination($have_before, $have_after, $page, $action, $args=null)
1251 // Does a little before-after block for next/prev page
1252 if ($have_before || $have_after) {
1253 $this->elementStart('ul', array('class' => 'nav',
1254 'id' => 'pagination'));
1257 $pargs = array('page' => $page-1);
1258 $this->elementStart('li', array('class' => 'nav_prev'));
1259 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1261 // TRANS: Pagination message to go to a page displaying information more in the
1262 // TRANS: present than the currently displayed information.
1264 $this->elementEnd('li');
1267 $pargs = array('page' => $page+1);
1268 $this->elementStart('li', array('class' => 'nav_next'));
1269 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1271 // TRANS: Pagination message to go to a page displaying information more in the
1272 // TRANS: past than the currently displayed information.
1274 $this->elementEnd('li');
1276 if ($have_before || $have_after) {
1277 $this->elementEnd('ul');
1282 * An array of feeds for this action.
1284 * Returns an array of potential feeds for this action.
1286 * @return array Feed object to show in head and links
1294 * A design for this action
1296 * @return Design a design object to use
1298 function getDesign()
1300 return Design::siteDesign();
1304 * Check the session token.
1306 * Checks that the current form has the correct session token,
1307 * and throw an exception if it does not.
1311 // XXX: Finding this type of check with the same message about 50 times.
1312 // Possible to refactor?
1313 function checkSessionToken()
1316 $token = $this->trimmed('token');
1317 if (empty($token) || $token != common_session_token()) {
1318 // TRANS: Client error text when there is a problem with the session token.
1319 $this->clientError(_('There was a problem with your session token.'));
1324 * Check if the current request is a POST
1326 * @return boolean true if POST; otherwise false.
1331 return ($_SERVER['REQUEST_METHOD'] == 'POST');