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 // TRANS: Inline reply form submit button: submits a reply comment.
328 $messages['reply_submit'] = _m('BUTTON', 'Comment');
330 // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
331 $messages['reply_comment'] = _m('Add a comment...');
333 $messages = array_merge($messages, $this->getScriptMessages());
335 Event::handle('EndScriptMessages', array($this, &$messages));
338 if (!empty($messages)) {
339 $this->inlineScript('SN.messages=' . json_encode($messages));
346 * If the action will need localizable text strings, export them here like so:
348 * return array('pool_deepend' => _('Deep end'),
349 * 'pool_shallow' => _('Shallow end'));
351 * The exported map will be available via SN.msg() to JS code:
353 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
354 * $('#pool .deepend').text(SN.msg('pool_deepend'));
355 * $('#pool .shallow').text(SN.msg('pool_shallow'));
357 * Exports a map of localized text strings to JavaScript code.
359 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
360 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
361 * be used, as they'll be added to HTML output.
363 function getScriptMessages()
369 * Show OpenSearch headers
373 function showOpenSearch()
375 $this->element('link', array('rel' => 'search',
376 'type' => 'application/opensearchdescription+xml',
377 'href' => common_local_url('opensearch', array('type' => 'people')),
378 'title' => common_config('site', 'name').' People Search'));
379 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
380 'href' => common_local_url('opensearch', array('type' => 'notice')),
381 'title' => common_config('site', 'name').' Notice Search'));
393 $feeds = $this->getFeeds();
396 foreach ($feeds as $feed) {
397 $this->element('link', array('rel' => $feed->rel(),
398 'href' => $feed->url,
399 'type' => $feed->mimeType(),
400 'title' => $feed->title));
412 function showDescription()
414 // does nothing by default
418 * Show extra stuff in <head>.
426 // does nothing by default
432 * Calls template methods
438 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
439 'class' => 'user_in')
440 : array('id' => strtolower($this->trimmed('action'))));
441 $this->elementStart('div', array('id' => 'wrap'));
442 if (Event::handle('StartShowHeader', array($this))) {
444 Event::handle('EndShowHeader', array($this));
447 if (Event::handle('StartShowFooter', array($this))) {
449 Event::handle('EndShowFooter', array($this));
451 $this->elementEnd('div');
452 $this->showScripts();
453 $this->elementEnd('body');
457 * Show header of the page.
459 * Calls template methods
463 function showHeader()
465 $this->elementStart('div', array('id' => 'header'));
467 $this->showPrimaryNav();
468 if (Event::handle('StartShowSiteNotice', array($this))) {
469 $this->showSiteNotice();
471 Event::handle('EndShowSiteNotice', array($this));
473 if (common_logged_in()) {
474 if (Event::handle('StartShowNoticeForm', array($this))) {
475 $this->showNoticeForm();
476 Event::handle('EndShowNoticeForm', array($this));
479 $this->showAnonymousMessage();
481 $this->elementEnd('div');
485 * Show configured logo.
491 $this->elementStart('address', array('id' => 'site_contact',
492 'class' => 'vcard'));
493 if (Event::handle('StartAddressData', array($this))) {
494 if (common_config('singleuser', 'enabled')) {
495 $user = User::singleUser();
496 $url = common_local_url('showstream',
497 array('nickname' => $user->nickname));
498 } else if (common_logged_in()) {
499 $cur = common_current_user();
500 $url = common_local_url('all', array('nickname' => $cur->nickname));
502 $url = common_local_url('public');
505 $this->elementStart('a', array('class' => 'url home bookmark',
508 if (StatusNet::isHTTPS()) {
509 $logoUrl = common_config('site', 'ssllogo');
510 if (empty($logoUrl)) {
511 // if logo is an uploaded file, try to fall back to HTTPS file URL
512 $httpUrl = common_config('site', 'logo');
513 if (!empty($httpUrl)) {
514 $f = File::staticGet('url', $httpUrl);
515 if (!empty($f) && !empty($f->filename)) {
516 // this will handle the HTTPS case
517 $logoUrl = File::url($f->filename);
522 $logoUrl = common_config('site', 'logo');
525 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
526 // This should handle the HTTPS case internally
527 $logoUrl = Theme::path('logo.png');
530 if (!empty($logoUrl)) {
531 $this->element('img', array('class' => 'logo photo',
533 'alt' => common_config('site', 'name')));
537 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
538 $this->elementEnd('a');
540 Event::handle('EndAddressData', array($this));
542 $this->elementEnd('address');
546 * Show primary navigation.
550 function showPrimaryNav()
552 $user = common_current_user();
553 $this->elementStart('ul', array('class' => 'nav',
554 'id' => 'site_nav_global_primary'));
555 if (Event::handle('StartPrimaryNav', array($this))) {
557 $this->menuItem(common_local_url('all',
558 array('nickname' => $user->nickname)),
560 _m('Friends timeline'),
563 $this->menuItem(common_local_url('showstream',
564 array('nickname' => $user->nickname)),
569 $this->menuItem(common_local_url('public'),
571 _m('Everyone on this site'),
574 $this->menuItem(common_local_url('profilesettings'),
576 _m('Change your personal settings'),
579 if ($user->hasRight(Right::CONFIGURESITE)) {
580 $this->menuItem(common_local_url('siteadminpanel'),
582 _m('Site configuration'),
586 $this->menuItem(common_local_url('logout'),
588 _m('Logout from the site'),
592 $this->menuItem(common_local_url('public'),
594 _m('Everyone on this site'),
597 $this->menuItem(common_local_url('login'),
599 _m('Login to the site'),
604 if (!empty($user) || !common_config('site', 'private')) {
605 $this->menuItem(common_local_url('noticesearch'),
607 _m('Search the site'),
612 Event::handle('EndPrimaryNav', array($this));
614 $this->elementEnd('ul');
622 function showSiteNotice()
624 // Revist. Should probably do an hAtom pattern here
625 $text = common_config('site', 'notice');
627 $this->elementStart('div', array('id' => 'site_notice',
628 'class' => 'system_notice'));
630 $this->elementEnd('div');
637 * MAY overload if no notice form needed... or direct message box????
641 function showNoticeForm()
643 $notice_form = new NoticeForm($this);
644 $notice_form->show();
648 * Show anonymous message.
654 function showAnonymousMessage()
656 // needs to be defined by the class
662 * Shows local navigation, content block and aside.
668 $this->elementStart('div', array('id' => 'core'));
669 if (Event::handle('StartShowLocalNavBlock', array($this))) {
670 $this->showLocalNavBlock();
671 Event::handle('EndShowLocalNavBlock', array($this));
673 if (Event::handle('StartShowContentBlock', array($this))) {
674 $this->showContentBlock();
675 Event::handle('EndShowContentBlock', array($this));
677 if (Event::handle('StartShowAside', array($this))) {
679 Event::handle('EndShowAside', array($this));
681 $this->elementEnd('div');
685 * Show local navigation block.
689 function showLocalNavBlock()
691 // Need to have this ID for CSS; I'm too lazy to add it to
693 $this->elementStart('div', array('id' => 'site_nav_local_views'));
694 $this->showLocalNav();
695 $this->elementEnd('div');
699 * Show local navigation.
705 function showLocalNav()
707 // does nothing by default
711 * Show content block.
715 function showContentBlock()
717 $this->elementStart('div', array('id' => 'content'));
718 if (Event::handle('StartShowPageTitle', array($this))) {
719 $this->showPageTitle();
720 Event::handle('EndShowPageTitle', array($this));
722 $this->showPageNoticeBlock();
723 $this->elementStart('div', array('id' => 'content_inner'));
724 // show the actual content (forms, lists, whatever)
725 $this->showContent();
726 $this->elementEnd('div');
727 $this->elementEnd('div');
735 function showPageTitle()
737 $this->element('h1', null, $this->title());
741 * Show page notice block.
743 * Only show the block if a subclassed action has overrided
744 * Action::showPageNotice(), or an event handler is registered for
745 * the StartShowPageNotice event, in which case we assume the
746 * 'page_notice' definition list is desired. This is to prevent
747 * empty 'page_notice' definition lists from being output everywhere.
751 function showPageNoticeBlock()
753 $rmethod = new ReflectionMethod($this, 'showPageNotice');
754 $dclass = $rmethod->getDeclaringClass()->getName();
756 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
758 $this->elementStart('div', array('id' => 'page_notice',
759 'class' => 'system_notice'));
760 if (Event::handle('StartShowPageNotice', array($this))) {
761 $this->showPageNotice();
762 Event::handle('EndShowPageNotice', array($this));
764 $this->elementEnd('div');
771 * SHOULD overload (unless there's not a notice)
775 function showPageNotice()
782 * MUST overload (unless there's not a notice)
786 function showContent()
797 $this->elementStart('div', array('id' => 'aside_primary',
798 'class' => 'aside'));
799 if (Event::handle('StartShowSections', array($this))) {
800 $this->showSections();
801 Event::handle('EndShowSections', array($this));
803 if (Event::handle('StartShowExportData', array($this))) {
804 $this->showExportData();
805 Event::handle('EndShowExportData', array($this));
807 $this->elementEnd('div');
811 * Show export data feeds.
815 function showExportData()
817 $feeds = $this->getFeeds();
819 $fl = new FeedList($this);
831 function showSections()
833 // for each section, show it
841 function showFooter()
843 $this->elementStart('div', array('id' => 'footer'));
844 if (Event::handle('StartShowInsideFooter', array($this))) {
845 $this->showSecondaryNav();
846 $this->showLicenses();
847 Event::handle('EndShowInsideFooter', array($this));
849 $this->elementEnd('div');
853 * Show secondary navigation.
857 function showSecondaryNav()
859 $this->elementStart('ul', array('class' => 'nav',
860 'id' => 'site_nav_global_secondary'));
861 if (Event::handle('StartSecondaryNav', array($this))) {
862 $this->menuItem(common_local_url('doc', array('title' => 'help')),
863 // TRANS: Secondary navigation menu option leading to help on StatusNet.
865 $this->menuItem(common_local_url('doc', array('title' => 'about')),
866 // TRANS: Secondary navigation menu option leading to text about StatusNet site.
868 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
869 // TRANS: Secondary navigation menu option leading to Frequently Asked Questions.
871 $bb = common_config('site', 'broughtby');
873 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
874 // TRANS: Secondary navigation menu option leading to Terms of Service.
877 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
878 // TRANS: Secondary navigation menu option leading to privacy policy.
880 $this->menuItem(common_local_url('doc', array('title' => 'source')),
881 // TRANS: Secondary navigation menu option. Leads to information about StatusNet and its license.
883 $this->menuItem(common_local_url('version'),
884 // TRANS: Secondary navigation menu option leading to version information on the StatusNet site.
886 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
887 // TRANS: Secondary navigation menu option leading to e-mail contact information on the
888 // TRANS: StatusNet site, where to report bugs, ...
890 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
891 // TRANS: Secondary navigation menu option. Leads to information about embedding a timeline widget.
893 Event::handle('EndSecondaryNav', array($this));
895 $this->elementEnd('ul');
903 function showLicenses()
905 $this->showStatusNetLicense();
906 $this->showContentLicense();
910 * Show StatusNet license.
914 function showStatusNetLicense()
916 if (common_config('site', 'broughtby')) {
917 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
918 // TRANS: Text between [] is a link description, text between () is the link itself.
919 // TRANS: Make sure there is no whitespace between "]" and "(".
920 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
921 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
923 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
924 $instr = _('**%%site.name%%** is a microblogging service.');
927 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
928 // TRANS: Make sure there is no whitespace between "]" and "(".
929 // TRANS: Text between [] is a link description, text between () is the link itself.
930 // TRANS: %s is the version of StatusNet that is being used.
931 $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);
932 $output = common_markup_to_html($instr);
938 * Show content license.
942 function showContentLicense()
944 if (Event::handle('StartShowContentLicense', array($this))) {
945 switch (common_config('license', 'type')) {
947 // TRANS: Content license displayed when license is set to 'private'.
948 // TRANS: %1$s is the site name.
949 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
950 common_config('site', 'name')));
952 case 'allrightsreserved':
953 if (common_config('license', 'owner')) {
954 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
955 // TRANS: %1$s is the copyright owner.
956 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
957 common_config('license', 'owner')));
959 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
960 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
963 case 'cc': // fall through
965 $this->elementStart('p');
967 $image = common_config('license', 'image');
968 $sslimage = common_config('license', 'sslimage');
970 if (StatusNet::isHTTPS()) {
971 if (!empty($sslimage)) {
973 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
974 // CC support HTTPS on their images
975 $url = preg_replace('/^http/', 'https', $image);
977 // Better to show mixed content than no content
984 $this->element('img', array('id' => 'license_cc',
986 'alt' => common_config('license', 'title'),
990 // TRANS: license message in footer.
991 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
992 $notice = _('All %1$s content and data are available under the %2$s license.');
993 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
994 htmlspecialchars(common_config('license', 'url')) .
996 htmlspecialchars(common_config('license', 'title')) .
998 $this->raw(sprintf(htmlspecialchars($notice),
999 htmlspecialchars(common_config('site', 'name')),
1001 $this->elementEnd('p');
1005 Event::handle('EndShowContentLicense', array($this));
1010 * Return last modified, if applicable.
1014 * @return string last modified http header
1016 function lastModified()
1018 // For comparison with If-Last-Modified
1019 // If not applicable, return null
1024 * Return etag, if applicable.
1028 * @return string etag http header
1036 * Return true if read only.
1040 * @param array $args other arguments
1042 * @return boolean is read only action?
1044 function isReadOnly($args)
1050 * Returns query argument or default value if not found
1052 * @param string $key requested argument
1053 * @param string $def default value to return if $key is not provided
1055 * @return boolean is read only action?
1057 function arg($key, $def=null)
1059 if (array_key_exists($key, $this->args)) {
1060 return $this->args[$key];
1067 * Returns trimmed query argument or default value if not found
1069 * @param string $key requested argument
1070 * @param string $def default value to return if $key is not provided
1072 * @return boolean is read only action?
1074 function trimmed($key, $def=null)
1076 $arg = $this->arg($key, $def);
1077 return is_string($arg) ? trim($arg) : $arg;
1083 * @param array $argarray is ignored since it's now passed in in prepare()
1085 * @return boolean is read only action?
1087 function handle($argarray=null)
1089 header('Vary: Accept-Encoding,Cookie');
1091 $lm = $this->lastModified();
1092 $etag = $this->etag();
1095 header('ETag: ' . $etag);
1099 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1100 if ($this->isCacheable()) {
1101 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1102 header( "Cache-Control: private, must-revalidate, max-age=0" );
1109 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1110 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1111 if ($if_none_match) {
1112 // If this check fails, ignore the if-modified-since below.
1114 if ($this->_hasEtag($etag, $if_none_match)) {
1115 header('HTTP/1.1 304 Not Modified');
1116 // Better way to do this?
1122 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1123 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1124 $ims = strtotime($if_modified_since);
1126 header('HTTP/1.1 304 Not Modified');
1127 // Better way to do this?
1134 * Is this action cacheable?
1136 * If the action returns a last-modified
1138 * @param array $argarray is ignored since it's now passed in in prepare()
1140 * @return boolean is read only action?
1142 function isCacheable()
1148 * HasĀ etag? (private)
1150 * @param string $etag etag http header
1151 * @param string $if_none_match ifNoneMatch http header
1155 function _hasEtag($etag, $if_none_match)
1157 $etags = explode(',', $if_none_match);
1158 return in_array($etag, $etags) || in_array('*', $etags);
1162 * Boolean understands english (yes, no, true, false)
1164 * @param string $key query key we're interested in
1165 * @param string $def default value
1167 * @return boolean interprets yes/no strings as boolean
1169 function boolean($key, $def=false)
1171 $arg = strtolower($this->trimmed($key));
1173 if (is_null($arg)) {
1175 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1177 } else if (in_array($arg, array('false', 'no', '0'))) {
1185 * Integer value of an argument
1187 * @param string $key query key we're interested in
1188 * @param string $defValue optional default value (default null)
1189 * @param string $maxValue optional max value (default null)
1190 * @param string $minValue optional min value (default null)
1192 * @return integer integer value
1194 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1196 $arg = strtolower($this->trimmed($key));
1198 if (is_null($arg) || !is_integer($arg)) {
1202 if (!is_null($maxValue)) {
1203 $arg = min($arg, $maxValue);
1206 if (!is_null($minValue)) {
1207 $arg = max($arg, $minValue);
1216 * @param string $msg error message to display
1217 * @param integer $code http error code, 500 by default
1221 function serverError($msg, $code=500)
1223 $action = $this->trimmed('action');
1224 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1225 throw new ServerException($msg, $code);
1231 * @param string $msg error message to display
1232 * @param integer $code http error code, 400 by default
1236 function clientError($msg, $code=400)
1238 $action = $this->trimmed('action');
1239 common_debug("User error '$code' on '$action': $msg", __FILE__);
1240 throw new ClientException($msg, $code);
1244 * Returns the current URL
1246 * @return string current URL
1250 list($action, $args) = $this->returnToArgs();
1251 return common_local_url($action, $args);
1255 * Returns arguments sufficient for re-constructing URL
1257 * @return array two elements: action, other args
1259 function returnToArgs()
1261 $action = $this->trimmed('action');
1262 $args = $this->args;
1263 unset($args['action']);
1264 if (common_config('site', 'fancy')) {
1267 if (array_key_exists('submit', $args)) {
1268 unset($args['submit']);
1270 foreach (array_keys($_COOKIE) as $cookie) {
1271 unset($args[$cookie]);
1273 return array($action, $args);
1277 * Generate a menu item
1279 * @param string $url menu URL
1280 * @param string $text menu name
1281 * @param string $title title attribute, null by default
1282 * @param boolean $is_selected current menu item, false by default
1283 * @param string $id element id, null by default
1287 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1289 // Added @id to li for some control.
1290 // XXX: We might want to move this to htmloutputter.php
1293 $lattrs['class'] = 'current';
1296 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1298 $this->elementStart('li', $lattrs);
1299 $attrs['href'] = $url;
1301 $attrs['title'] = $title;
1303 $this->element('a', $attrs, $text);
1304 $this->elementEnd('li');
1308 * Generate pagination links
1310 * @param boolean $have_before is there something before?
1311 * @param boolean $have_after is there something after?
1312 * @param integer $page current page
1313 * @param string $action current action
1314 * @param array $args rest of query arguments
1318 // XXX: The messages in this pagination method only tailor to navigating
1319 // notices. In other lists, "Previous"/"Next" type navigation is
1320 // desirable, but not available.
1321 function pagination($have_before, $have_after, $page, $action, $args=null)
1323 // Does a little before-after block for next/prev page
1324 if ($have_before || $have_after) {
1325 $this->elementStart('ul', array('class' => 'nav',
1326 'id' => 'pagination'));
1329 $pargs = array('page' => $page-1);
1330 $this->elementStart('li', array('class' => 'nav_prev'));
1331 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1333 // TRANS: Pagination message to go to a page displaying information more in the
1334 // TRANS: present than the currently displayed information.
1336 $this->elementEnd('li');
1339 $pargs = array('page' => $page+1);
1340 $this->elementStart('li', array('class' => 'nav_next'));
1341 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1343 // TRANS: Pagination message to go to a page displaying information more in the
1344 // TRANS: past than the currently displayed information.
1346 $this->elementEnd('li');
1348 if ($have_before || $have_after) {
1349 $this->elementEnd('ul');
1354 * An array of feeds for this action.
1356 * Returns an array of potential feeds for this action.
1358 * @return array Feed object to show in head and links
1366 * A design for this action
1368 * @return Design a design object to use
1370 function getDesign()
1372 return Design::siteDesign();
1376 * Check the session token.
1378 * Checks that the current form has the correct session token,
1379 * and throw an exception if it does not.
1383 // XXX: Finding this type of check with the same message about 50 times.
1384 // Possible to refactor?
1385 function checkSessionToken()
1388 $token = $this->trimmed('token');
1389 if (empty($token) || $token != common_session_token()) {
1390 // TRANS: Client error text when there is a problem with the session token.
1391 $this->clientError(_('There was a problem with your session token.'));
1396 * Check if the current request is a POST
1398 * @return boolean true if POST; otherwise false.
1403 return ($_SERVER['REQUEST_METHOD'] == 'POST');