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 $theme = new Theme($mainTheme);
272 // Some themes may have external stylesheets, such as using the
273 // Google Font APIs to load webfonts.
274 foreach ($theme->getExternals() as $url) {
275 $this->cssLink($url, $mainTheme, $media);
278 // If the currently-selected theme has dependencies on other themes,
279 // we'll need to load their display.css files as well in order.
280 $baseThemes = $theme->getDeps();
281 foreach ($baseThemes as $baseTheme) {
282 $this->cssLink('css/display.css', $baseTheme, $media);
284 $this->cssLink('css/display.css', $mainTheme, $media);
288 * Show javascript headers
292 function showScripts()
294 if (Event::handle('StartShowScripts', array($this))) {
295 if (Event::handle('StartShowJQueryScripts', array($this))) {
296 $this->script('jquery.min.js');
297 $this->script('jquery.form.min.js');
298 $this->script('jquery.cookie.min.js');
299 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.min.js').'"); }');
300 $this->script('jquery.joverlay.min.js');
301 Event::handle('EndShowJQueryScripts', array($this));
303 if (Event::handle('StartShowStatusNetScripts', array($this)) &&
304 Event::handle('StartShowLaconicaScripts', array($this))) {
305 if (common_config('site', 'minify')) {
306 $this->script('util.min.js');
308 $this->script('util.js');
309 $this->script('xbImportNode.js');
310 $this->script('geometa.js');
312 $this->showScriptMessages();
313 // Frame-busting code to avoid clickjacking attacks.
314 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
315 Event::handle('EndShowStatusNetScripts', array($this));
316 Event::handle('EndShowLaconicaScripts', array($this));
318 Event::handle('EndShowScripts', array($this));
323 * Exports a map of localized text strings to JavaScript code.
325 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
326 * events and appending to the array. Try to avoid adding strings that won't be used, as
327 * they'll be added to HTML output.
330 function showScriptMessages()
334 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
335 // Common messages needed for timeline views etc...
337 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
338 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
340 // TRANS: Inline reply form submit button: submits a reply comment.
341 $messages['reply_submit'] = _m('BUTTON', 'Reply');
343 // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
344 $messages['reply_placeholder'] = _m('Write a reply...');
346 $messages = array_merge($messages, $this->getScriptMessages());
348 Event::handle('EndScriptMessages', array($this, &$messages));
351 if (!empty($messages)) {
352 $this->inlineScript('SN.messages=' . json_encode($messages));
359 * If the action will need localizable text strings, export them here like so:
361 * return array('pool_deepend' => _('Deep end'),
362 * 'pool_shallow' => _('Shallow end'));
364 * The exported map will be available via SN.msg() to JS code:
366 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
367 * $('#pool .deepend').text(SN.msg('pool_deepend'));
368 * $('#pool .shallow').text(SN.msg('pool_shallow'));
370 * Exports a map of localized text strings to JavaScript code.
372 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
373 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
374 * be used, as they'll be added to HTML output.
376 function getScriptMessages()
382 * Show OpenSearch headers
386 function showOpenSearch()
388 $this->element('link', array('rel' => 'search',
389 'type' => 'application/opensearchdescription+xml',
390 'href' => common_local_url('opensearch', array('type' => 'people')),
391 'title' => common_config('site', 'name').' People Search'));
392 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
393 'href' => common_local_url('opensearch', array('type' => 'notice')),
394 'title' => common_config('site', 'name').' Notice Search'));
406 $feeds = $this->getFeeds();
409 foreach ($feeds as $feed) {
410 $this->element('link', array('rel' => $feed->rel(),
411 'href' => $feed->url,
412 'type' => $feed->mimeType(),
413 'title' => $feed->title));
425 function showDescription()
427 // does nothing by default
431 * Show extra stuff in <head>.
439 // does nothing by default
445 * Calls template methods
451 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
452 'class' => 'user_in')
453 : array('id' => strtolower($this->trimmed('action'))));
454 $this->elementStart('div', array('id' => 'wrap'));
455 if (Event::handle('StartShowHeader', array($this))) {
457 Event::handle('EndShowHeader', array($this));
460 if (Event::handle('StartShowFooter', array($this))) {
462 Event::handle('EndShowFooter', array($this));
464 $this->elementEnd('div');
465 $this->showScripts();
466 $this->elementEnd('body');
470 * Show header of the page.
472 * Calls template methods
476 function showHeader()
478 $this->elementStart('div', array('id' => 'header'));
480 $this->showPrimaryNav();
481 if (Event::handle('StartShowSiteNotice', array($this))) {
482 $this->showSiteNotice();
484 Event::handle('EndShowSiteNotice', array($this));
487 $this->elementEnd('div');
491 * Show configured logo.
497 $this->elementStart('address', array('id' => 'site_contact',
498 'class' => 'vcard'));
499 if (Event::handle('StartAddressData', array($this))) {
500 if (common_config('singleuser', 'enabled')) {
501 $user = User::singleUser();
502 $url = common_local_url('showstream',
503 array('nickname' => $user->nickname));
504 } else if (common_logged_in()) {
505 $cur = common_current_user();
506 $url = common_local_url('all', array('nickname' => $cur->nickname));
508 $url = common_local_url('public');
511 $this->elementStart('a', array('class' => 'url home bookmark',
514 if (StatusNet::isHTTPS()) {
515 $logoUrl = common_config('site', 'ssllogo');
516 if (empty($logoUrl)) {
517 // if logo is an uploaded file, try to fall back to HTTPS file URL
518 $httpUrl = common_config('site', 'logo');
519 if (!empty($httpUrl)) {
520 $f = File::staticGet('url', $httpUrl);
521 if (!empty($f) && !empty($f->filename)) {
522 // this will handle the HTTPS case
523 $logoUrl = File::url($f->filename);
528 $logoUrl = common_config('site', 'logo');
531 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
532 // This should handle the HTTPS case internally
533 $logoUrl = Theme::path('logo.png');
536 if (!empty($logoUrl)) {
537 $this->element('img', array('class' => 'logo photo',
539 'alt' => common_config('site', 'name')));
543 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
544 $this->elementEnd('a');
546 Event::handle('EndAddressData', array($this));
548 $this->elementEnd('address');
552 * Show primary navigation.
556 function showPrimaryNav()
558 $this->elementStart('div', array('id' => 'site_nav_global_primary'));
559 $pn = new PrimaryNav($this);
561 $this->elementEnd('div');
569 function showSiteNotice()
571 // Revist. Should probably do an hAtom pattern here
572 $text = common_config('site', 'notice');
574 $this->elementStart('div', array('id' => 'site_notice',
575 'class' => 'system_notice'));
577 $this->elementEnd('div');
584 * MAY overload if no notice form needed... or direct message box????
588 function showNoticeForm()
590 $tabs = array('status' => _('Status'));
592 $this->elementStart('div', 'input_forms');
594 if (Event::handle('StartShowEntryForms', array(&$tabs))) {
596 $this->elementStart('ul', array('class' => 'nav',
597 'id' => 'input_form_nav'));
599 foreach ($tabs as $tag => $title) {
601 $attrs = array('id' => 'input_form_nav_'.$tag,
602 'class' => 'input_form_nav_tab');
604 if ($tag == 'status') {
605 $attrs['class'] .= ' current';
608 $this->elementStart('li', $attrs);
611 array('href' => 'javascript:SN.U.switchInputFormTab("'.$tag.'")'),
613 $this->elementEnd('li');
616 $this->elementEnd('ul');
618 foreach ($tabs as $tag => $title) {
620 $attrs = array('class' => 'input_form',
621 'id' => 'input_form_'.$tag);
623 if ($tag == 'status') {
624 $attrs['class'] .= ' current';
627 $this->elementStart('div', $attrs);
631 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
632 if ($tag == 'status') {
633 $form = new NoticeForm($this);
635 Event::handle('EndMakeEntryForm', array($tag, $this, $form));
642 $this->elementEnd('div');
646 $this->elementEnd('div');
650 * Show anonymous message.
656 function showAnonymousMessage()
658 // needs to be defined by the class
664 * Shows local navigation, content block and aside.
670 $this->elementStart('div', array('id' => 'core'));
671 if (Event::handle('StartShowLocalNavBlock', array($this))) {
672 $this->showLocalNavBlock();
673 Event::handle('EndShowLocalNavBlock', array($this));
675 if (Event::handle('StartShowContentBlock', array($this))) {
676 $this->showContentBlock();
677 Event::handle('EndShowContentBlock', array($this));
679 if (Event::handle('StartShowAside', array($this))) {
681 Event::handle('EndShowAside', array($this));
683 $this->elementEnd('div');
687 * Show local navigation block.
691 function showLocalNavBlock()
693 // Need to have this ID for CSS; I'm too lazy to add it to
695 $this->elementStart('div', array('id' => 'site_nav_local_views'));
696 $this->showLocalNav();
697 $this->elementEnd('div');
701 * Show local navigation.
707 function showLocalNav()
709 $nav = new DefaultLocalNav($this);
714 * Show menu for an object (group, profile)
716 * This block will only show if a subclass has overridden
717 * the showObjectNav() method.
721 function showObjectNavBlock()
723 $rmethod = new ReflectionMethod($this, 'showObjectNav');
724 $dclass = $rmethod->getDeclaringClass()->getName();
726 if ($dclass != 'Action') {
727 // Need to have this ID for CSS; I'm too lazy to add it to
729 $this->elementStart('div', array('id' => 'site_nav_object',
730 'class' => 'section'));
731 $this->showObjectNav();
732 $this->elementEnd('div');
737 * Show object navigation.
739 * If there are things to do with this object, show it here.
743 function showObjectNav()
749 * Show content block.
753 function showContentBlock()
755 $this->elementStart('div', array('id' => 'content'));
756 if (common_logged_in()) {
757 if (Event::handle('StartShowNoticeForm', array($this))) {
758 $this->showNoticeForm();
759 Event::handle('EndShowNoticeForm', array($this));
762 if (Event::handle('StartShowPageTitle', array($this))) {
763 $this->showPageTitle();
764 Event::handle('EndShowPageTitle', array($this));
766 $this->showPageNoticeBlock();
767 $this->elementStart('div', array('id' => 'content_inner'));
768 // show the actual content (forms, lists, whatever)
769 $this->showContent();
770 $this->elementEnd('div');
771 $this->elementEnd('div');
779 function showPageTitle()
781 $this->element('h1', null, $this->title());
785 * Show page notice block.
787 * Only show the block if a subclassed action has overrided
788 * Action::showPageNotice(), or an event handler is registered for
789 * the StartShowPageNotice event, in which case we assume the
790 * 'page_notice' definition list is desired. This is to prevent
791 * empty 'page_notice' definition lists from being output everywhere.
795 function showPageNoticeBlock()
797 $rmethod = new ReflectionMethod($this, 'showPageNotice');
798 $dclass = $rmethod->getDeclaringClass()->getName();
800 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
802 $this->elementStart('div', array('id' => 'page_notice',
803 'class' => 'system_notice'));
804 if (Event::handle('StartShowPageNotice', array($this))) {
805 $this->showPageNotice();
806 Event::handle('EndShowPageNotice', array($this));
808 $this->elementEnd('div');
815 * SHOULD overload (unless there's not a notice)
819 function showPageNotice()
826 * MUST overload (unless there's not a notice)
830 function showContent()
841 $this->elementStart('div', array('id' => 'aside_primary',
842 'class' => 'aside'));
843 if (Event::handle('StartShowObjectNavBlock', array($this))) {
844 $this->showObjectNavBlock();
845 Event::handle('EndShowObjectNavBlock', array($this));
847 if (Event::handle('StartShowSections', array($this))) {
848 $this->showSections();
849 Event::handle('EndShowSections', array($this));
851 if (Event::handle('StartShowExportData', array($this))) {
852 $this->showExportData();
853 Event::handle('EndShowExportData', array($this));
855 $this->elementEnd('div');
859 * Show export data feeds.
863 function showExportData()
865 $feeds = $this->getFeeds();
867 $fl = new FeedList($this);
879 function showSections()
881 // for each section, show it
889 function showFooter()
891 $this->elementStart('div', array('id' => 'footer'));
892 if (Event::handle('StartShowInsideFooter', array($this))) {
893 $this->showSecondaryNav();
894 $this->showLicenses();
895 Event::handle('EndShowInsideFooter', array($this));
897 $this->elementEnd('div');
901 * Show secondary navigation.
905 function showSecondaryNav()
907 $sn = new SecondaryNav($this);
916 function showLicenses()
918 $this->showStatusNetLicense();
919 $this->showContentLicense();
923 * Show StatusNet license.
927 function showStatusNetLicense()
929 if (common_config('site', 'broughtby')) {
930 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
931 // TRANS: Text between [] is a link description, text between () is the link itself.
932 // TRANS: Make sure there is no whitespace between "]" and "(".
933 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
934 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
936 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
937 $instr = _('**%%site.name%%** is a microblogging service.');
940 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
941 // TRANS: Make sure there is no whitespace between "]" and "(".
942 // TRANS: Text between [] is a link description, text between () is the link itself.
943 // TRANS: %s is the version of StatusNet that is being used.
944 $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);
945 $output = common_markup_to_html($instr);
951 * Show content license.
955 function showContentLicense()
957 if (Event::handle('StartShowContentLicense', array($this))) {
958 switch (common_config('license', 'type')) {
960 // TRANS: Content license displayed when license is set to 'private'.
961 // TRANS: %1$s is the site name.
962 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
963 common_config('site', 'name')));
965 case 'allrightsreserved':
966 if (common_config('license', 'owner')) {
967 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
968 // TRANS: %1$s is the copyright owner.
969 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
970 common_config('license', 'owner')));
972 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
973 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
976 case 'cc': // fall through
978 $this->elementStart('p');
980 $image = common_config('license', 'image');
981 $sslimage = common_config('license', 'sslimage');
983 if (StatusNet::isHTTPS()) {
984 if (!empty($sslimage)) {
986 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
987 // CC support HTTPS on their images
988 $url = preg_replace('/^http/', 'https', $image);
990 // Better to show mixed content than no content
997 $this->element('img', array('id' => 'license_cc',
999 'alt' => common_config('license', 'title'),
1003 // TRANS: license message in footer.
1004 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1005 $notice = _('All %1$s content and data are available under the %2$s license.');
1006 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1007 htmlspecialchars(common_config('license', 'url')) .
1009 htmlspecialchars(common_config('license', 'title')) .
1011 $this->raw(sprintf(htmlspecialchars($notice),
1012 htmlspecialchars(common_config('site', 'name')),
1014 $this->elementEnd('p');
1018 Event::handle('EndShowContentLicense', array($this));
1023 * Return last modified, if applicable.
1027 * @return string last modified http header
1029 function lastModified()
1031 // For comparison with If-Last-Modified
1032 // If not applicable, return null
1037 * Return etag, if applicable.
1041 * @return string etag http header
1049 * Return true if read only.
1053 * @param array $args other arguments
1055 * @return boolean is read only action?
1057 function isReadOnly($args)
1063 * Returns query argument or default value if not found
1065 * @param string $key requested argument
1066 * @param string $def default value to return if $key is not provided
1068 * @return boolean is read only action?
1070 function arg($key, $def=null)
1072 if (array_key_exists($key, $this->args)) {
1073 return $this->args[$key];
1080 * Returns trimmed query argument or default value if not found
1082 * @param string $key requested argument
1083 * @param string $def default value to return if $key is not provided
1085 * @return boolean is read only action?
1087 function trimmed($key, $def=null)
1089 $arg = $this->arg($key, $def);
1090 return is_string($arg) ? trim($arg) : $arg;
1096 * @param array $argarray is ignored since it's now passed in in prepare()
1098 * @return boolean is read only action?
1100 function handle($argarray=null)
1102 header('Vary: Accept-Encoding,Cookie');
1104 $lm = $this->lastModified();
1105 $etag = $this->etag();
1108 header('ETag: ' . $etag);
1112 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1113 if ($this->isCacheable()) {
1114 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1115 header( "Cache-Control: private, must-revalidate, max-age=0" );
1122 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1123 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1124 if ($if_none_match) {
1125 // If this check fails, ignore the if-modified-since below.
1127 if ($this->_hasEtag($etag, $if_none_match)) {
1128 header('HTTP/1.1 304 Not Modified');
1129 // Better way to do this?
1135 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1136 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1137 $ims = strtotime($if_modified_since);
1139 header('HTTP/1.1 304 Not Modified');
1140 // Better way to do this?
1147 * Is this action cacheable?
1149 * If the action returns a last-modified
1151 * @param array $argarray is ignored since it's now passed in in prepare()
1153 * @return boolean is read only action?
1155 function isCacheable()
1161 * HasĀ etag? (private)
1163 * @param string $etag etag http header
1164 * @param string $if_none_match ifNoneMatch http header
1168 function _hasEtag($etag, $if_none_match)
1170 $etags = explode(',', $if_none_match);
1171 return in_array($etag, $etags) || in_array('*', $etags);
1175 * Boolean understands english (yes, no, true, false)
1177 * @param string $key query key we're interested in
1178 * @param string $def default value
1180 * @return boolean interprets yes/no strings as boolean
1182 function boolean($key, $def=false)
1184 $arg = strtolower($this->trimmed($key));
1186 if (is_null($arg)) {
1188 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1190 } else if (in_array($arg, array('false', 'no', '0'))) {
1198 * Integer value of an argument
1200 * @param string $key query key we're interested in
1201 * @param string $defValue optional default value (default null)
1202 * @param string $maxValue optional max value (default null)
1203 * @param string $minValue optional min value (default null)
1205 * @return integer integer value
1207 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1209 $arg = strtolower($this->trimmed($key));
1211 if (is_null($arg) || !is_integer($arg)) {
1215 if (!is_null($maxValue)) {
1216 $arg = min($arg, $maxValue);
1219 if (!is_null($minValue)) {
1220 $arg = max($arg, $minValue);
1229 * @param string $msg error message to display
1230 * @param integer $code http error code, 500 by default
1234 function serverError($msg, $code=500)
1236 $action = $this->trimmed('action');
1237 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1238 throw new ServerException($msg, $code);
1244 * @param string $msg error message to display
1245 * @param integer $code http error code, 400 by default
1249 function clientError($msg, $code=400)
1251 $action = $this->trimmed('action');
1252 common_debug("User error '$code' on '$action': $msg", __FILE__);
1253 throw new ClientException($msg, $code);
1257 * Returns the current URL
1259 * @return string current URL
1263 list($action, $args) = $this->returnToArgs();
1264 return common_local_url($action, $args);
1268 * Returns arguments sufficient for re-constructing URL
1270 * @return array two elements: action, other args
1272 function returnToArgs()
1274 $action = $this->trimmed('action');
1275 $args = $this->args;
1276 unset($args['action']);
1277 if (common_config('site', 'fancy')) {
1280 if (array_key_exists('submit', $args)) {
1281 unset($args['submit']);
1283 foreach (array_keys($_COOKIE) as $cookie) {
1284 unset($args[$cookie]);
1286 return array($action, $args);
1290 * Generate a menu item
1292 * @param string $url menu URL
1293 * @param string $text menu name
1294 * @param string $title title attribute, null by default
1295 * @param boolean $is_selected current menu item, false by default
1296 * @param string $id element id, null by default
1300 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1302 // Added @id to li for some control.
1303 // XXX: We might want to move this to htmloutputter.php
1306 $lattrs['class'] = 'current';
1309 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1311 $this->elementStart('li', $lattrs);
1312 $attrs['href'] = $url;
1314 $attrs['title'] = $title;
1316 $this->element('a', $attrs, $text);
1317 $this->elementEnd('li');
1321 * Generate pagination links
1323 * @param boolean $have_before is there something before?
1324 * @param boolean $have_after is there something after?
1325 * @param integer $page current page
1326 * @param string $action current action
1327 * @param array $args rest of query arguments
1331 // XXX: The messages in this pagination method only tailor to navigating
1332 // notices. In other lists, "Previous"/"Next" type navigation is
1333 // desirable, but not available.
1334 function pagination($have_before, $have_after, $page, $action, $args=null)
1336 // Does a little before-after block for next/prev page
1337 if ($have_before || $have_after) {
1338 $this->elementStart('ul', array('class' => 'nav',
1339 'id' => 'pagination'));
1342 $pargs = array('page' => $page-1);
1343 $this->elementStart('li', array('class' => 'nav_prev'));
1344 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1346 // TRANS: Pagination message to go to a page displaying information more in the
1347 // TRANS: present than the currently displayed information.
1349 $this->elementEnd('li');
1352 $pargs = array('page' => $page+1);
1353 $this->elementStart('li', array('class' => 'nav_next'));
1354 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1356 // TRANS: Pagination message to go to a page displaying information more in the
1357 // TRANS: past than the currently displayed information.
1359 $this->elementEnd('li');
1361 if ($have_before || $have_after) {
1362 $this->elementEnd('ul');
1367 * An array of feeds for this action.
1369 * Returns an array of potential feeds for this action.
1371 * @return array Feed object to show in head and links
1379 * A design for this action
1381 * @return Design a design object to use
1383 function getDesign()
1385 return Design::siteDesign();
1389 * Check the session token.
1391 * Checks that the current form has the correct session token,
1392 * and throw an exception if it does not.
1396 // XXX: Finding this type of check with the same message about 50 times.
1397 // Possible to refactor?
1398 function checkSessionToken()
1401 $token = $this->trimmed('token');
1402 if (empty($token) || $token != common_session_token()) {
1403 // TRANS: Client error text when there is a problem with the session token.
1404 $this->clientError(_('There was a problem with your session token.'));
1409 * Check if the current request is a POST
1411 * @return boolean true if POST; otherwise false.
1416 return ($_SERVER['REQUEST_METHOD'] == 'POST');