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 if (common_config('site', 'minify')) {
299 $this->script('util.min.js');
301 $this->script('util.js');
302 $this->script('xbImportNode.js');
303 $this->script('geometa.js');
305 $this->showScriptMessages();
306 // Frame-busting code to avoid clickjacking attacks.
307 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
308 Event::handle('EndShowStatusNetScripts', array($this));
309 Event::handle('EndShowLaconicaScripts', array($this));
311 Event::handle('EndShowScripts', array($this));
316 * Exports a map of localized text strings to JavaScript code.
318 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
319 * events and appending to the array. Try to avoid adding strings that won't be used, as
320 * they'll be added to HTML output.
323 function showScriptMessages()
327 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
328 // Common messages needed for timeline views etc...
330 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
331 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
333 // TRANS: Inline reply form submit button: submits a reply comment.
334 $messages['reply_submit'] = _m('BUTTON', 'Reply');
336 // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
337 $messages['reply_placeholder'] = _m('Write a reply...');
339 $messages = array_merge($messages, $this->getScriptMessages());
341 Event::handle('EndScriptMessages', array($this, &$messages));
344 if (!empty($messages)) {
345 $this->inlineScript('SN.messages=' . json_encode($messages));
352 * If the action will need localizable text strings, export them here like so:
354 * return array('pool_deepend' => _('Deep end'),
355 * 'pool_shallow' => _('Shallow end'));
357 * The exported map will be available via SN.msg() to JS code:
359 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
360 * $('#pool .deepend').text(SN.msg('pool_deepend'));
361 * $('#pool .shallow').text(SN.msg('pool_shallow'));
363 * Exports a map of localized text strings to JavaScript code.
365 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
366 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
367 * be used, as they'll be added to HTML output.
369 function getScriptMessages()
375 * Show OpenSearch headers
379 function showOpenSearch()
381 $this->element('link', array('rel' => 'search',
382 'type' => 'application/opensearchdescription+xml',
383 'href' => common_local_url('opensearch', array('type' => 'people')),
384 'title' => common_config('site', 'name').' People Search'));
385 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
386 'href' => common_local_url('opensearch', array('type' => 'notice')),
387 'title' => common_config('site', 'name').' Notice Search'));
399 $feeds = $this->getFeeds();
402 foreach ($feeds as $feed) {
403 $this->element('link', array('rel' => $feed->rel(),
404 'href' => $feed->url,
405 'type' => $feed->mimeType(),
406 'title' => $feed->title));
418 function showDescription()
420 // does nothing by default
424 * Show extra stuff in <head>.
432 // does nothing by default
438 * Calls template methods
444 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
445 'class' => 'user_in')
446 : array('id' => strtolower($this->trimmed('action'))));
447 $this->elementStart('div', array('id' => 'wrap'));
448 if (Event::handle('StartShowHeader', array($this))) {
450 Event::handle('EndShowHeader', array($this));
453 if (Event::handle('StartShowFooter', array($this))) {
455 Event::handle('EndShowFooter', array($this));
457 $this->elementEnd('div');
458 $this->showScripts();
459 $this->elementEnd('body');
463 * Show header of the page.
465 * Calls template methods
469 function showHeader()
471 $this->elementStart('div', array('id' => 'header'));
473 $this->showPrimaryNav();
474 if (Event::handle('StartShowSiteNotice', array($this))) {
475 $this->showSiteNotice();
477 Event::handle('EndShowSiteNotice', array($this));
479 if (common_logged_in()) {
480 if (Event::handle('StartShowNoticeForm', array($this))) {
481 $this->showNoticeForm();
482 Event::handle('EndShowNoticeForm', array($this));
485 $this->showAnonymousMessage();
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 $user = common_current_user();
559 $this->elementStart('ul', array('class' => 'nav',
560 'id' => 'site_nav_global_primary'));
561 if (Event::handle('StartPrimaryNav', array($this))) {
563 $this->menuItem(common_local_url('all',
564 array('nickname' => $user->nickname)),
566 _m('Friends timeline'),
569 $this->menuItem(common_local_url('showstream',
570 array('nickname' => $user->nickname)),
575 $this->menuItem(common_local_url('public'),
577 _m('Everyone on this site'),
580 $this->menuItem(common_local_url('profilesettings'),
582 _m('Change your personal settings'),
585 if ($user->hasRight(Right::CONFIGURESITE)) {
586 $this->menuItem(common_local_url('siteadminpanel'),
588 _m('Site configuration'),
592 $this->menuItem(common_local_url('logout'),
594 _m('Logout from the site'),
598 $this->menuItem(common_local_url('public'),
600 _m('Everyone on this site'),
603 $this->menuItem(common_local_url('login'),
605 _m('Login to the site'),
610 if (!empty($user) || !common_config('site', 'private')) {
611 $this->menuItem(common_local_url('noticesearch'),
613 _m('Search the site'),
618 Event::handle('EndPrimaryNav', array($this));
620 $this->elementEnd('ul');
628 function showSiteNotice()
630 // Revist. Should probably do an hAtom pattern here
631 $text = common_config('site', 'notice');
633 $this->elementStart('div', array('id' => 'site_notice',
634 'class' => 'system_notice'));
636 $this->elementEnd('div');
643 * MAY overload if no notice form needed... or direct message box????
647 function showNoticeForm()
649 $notice_form = new NoticeForm($this);
650 $notice_form->show();
654 * Show anonymous message.
660 function showAnonymousMessage()
662 // needs to be defined by the class
668 * Shows local navigation, content block and aside.
674 $this->elementStart('div', array('id' => 'core'));
675 if (Event::handle('StartShowLocalNavBlock', array($this))) {
676 $this->showLocalNavBlock();
677 Event::handle('EndShowLocalNavBlock', array($this));
679 if (Event::handle('StartShowContentBlock', array($this))) {
680 $this->showContentBlock();
681 Event::handle('EndShowContentBlock', array($this));
683 if (Event::handle('StartShowAside', array($this))) {
685 Event::handle('EndShowAside', array($this));
687 $this->elementEnd('div');
691 * Show local navigation block.
695 function showLocalNavBlock()
697 // Need to have this ID for CSS; I'm too lazy to add it to
699 $this->elementStart('div', array('id' => 'site_nav_local_views'));
700 $this->showLocalNav();
701 $this->elementEnd('div');
705 * Show local navigation.
711 function showLocalNav()
713 // does nothing by default
717 * Show content block.
721 function showContentBlock()
723 $this->elementStart('div', array('id' => 'content'));
724 if (Event::handle('StartShowPageTitle', array($this))) {
725 $this->showPageTitle();
726 Event::handle('EndShowPageTitle', array($this));
728 $this->showPageNoticeBlock();
729 $this->elementStart('div', array('id' => 'content_inner'));
730 // show the actual content (forms, lists, whatever)
731 $this->showContent();
732 $this->elementEnd('div');
733 $this->elementEnd('div');
741 function showPageTitle()
743 $this->element('h1', null, $this->title());
747 * Show page notice block.
749 * Only show the block if a subclassed action has overrided
750 * Action::showPageNotice(), or an event handler is registered for
751 * the StartShowPageNotice event, in which case we assume the
752 * 'page_notice' definition list is desired. This is to prevent
753 * empty 'page_notice' definition lists from being output everywhere.
757 function showPageNoticeBlock()
759 $rmethod = new ReflectionMethod($this, 'showPageNotice');
760 $dclass = $rmethod->getDeclaringClass()->getName();
762 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
764 $this->elementStart('div', array('id' => 'page_notice',
765 'class' => 'system_notice'));
766 if (Event::handle('StartShowPageNotice', array($this))) {
767 $this->showPageNotice();
768 Event::handle('EndShowPageNotice', array($this));
770 $this->elementEnd('div');
777 * SHOULD overload (unless there's not a notice)
781 function showPageNotice()
788 * MUST overload (unless there's not a notice)
792 function showContent()
803 $this->elementStart('div', array('id' => 'aside_primary',
804 'class' => 'aside'));
805 if (Event::handle('StartShowSections', array($this))) {
806 $this->showSections();
807 Event::handle('EndShowSections', array($this));
809 if (Event::handle('StartShowExportData', array($this))) {
810 $this->showExportData();
811 Event::handle('EndShowExportData', array($this));
813 $this->elementEnd('div');
817 * Show export data feeds.
821 function showExportData()
823 $feeds = $this->getFeeds();
825 $fl = new FeedList($this);
837 function showSections()
839 // for each section, show it
847 function showFooter()
849 $this->elementStart('div', array('id' => 'footer'));
850 if (Event::handle('StartShowInsideFooter', array($this))) {
851 $this->showSecondaryNav();
852 $this->showLicenses();
853 Event::handle('EndShowInsideFooter', array($this));
855 $this->elementEnd('div');
859 * Show secondary navigation.
863 function showSecondaryNav()
865 $this->elementStart('ul', array('class' => 'nav',
866 'id' => 'site_nav_global_secondary'));
867 if (Event::handle('StartSecondaryNav', array($this))) {
868 $this->menuItem(common_local_url('doc', array('title' => 'help')),
869 // TRANS: Secondary navigation menu option leading to help on StatusNet.
871 $this->menuItem(common_local_url('doc', array('title' => 'about')),
872 // TRANS: Secondary navigation menu option leading to text about StatusNet site.
874 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
875 // TRANS: Secondary navigation menu option leading to Frequently Asked Questions.
877 $bb = common_config('site', 'broughtby');
879 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
880 // TRANS: Secondary navigation menu option leading to Terms of Service.
883 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
884 // TRANS: Secondary navigation menu option leading to privacy policy.
886 $this->menuItem(common_local_url('doc', array('title' => 'source')),
887 // TRANS: Secondary navigation menu option. Leads to information about StatusNet and its license.
889 $this->menuItem(common_local_url('version'),
890 // TRANS: Secondary navigation menu option leading to version information on the StatusNet site.
892 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
893 // TRANS: Secondary navigation menu option leading to e-mail contact information on the
894 // TRANS: StatusNet site, where to report bugs, ...
896 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
897 // TRANS: Secondary navigation menu option. Leads to information about embedding a timeline widget.
899 Event::handle('EndSecondaryNav', array($this));
901 $this->elementEnd('ul');
909 function showLicenses()
911 $this->showStatusNetLicense();
912 $this->showContentLicense();
916 * Show StatusNet license.
920 function showStatusNetLicense()
922 if (common_config('site', 'broughtby')) {
923 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
924 // TRANS: Text between [] is a link description, text between () is the link itself.
925 // TRANS: Make sure there is no whitespace between "]" and "(".
926 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
927 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
929 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
930 $instr = _('**%%site.name%%** is a microblogging service.');
933 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
934 // TRANS: Make sure there is no whitespace between "]" and "(".
935 // TRANS: Text between [] is a link description, text between () is the link itself.
936 // TRANS: %s is the version of StatusNet that is being used.
937 $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);
938 $output = common_markup_to_html($instr);
944 * Show content license.
948 function showContentLicense()
950 if (Event::handle('StartShowContentLicense', array($this))) {
951 switch (common_config('license', 'type')) {
953 // TRANS: Content license displayed when license is set to 'private'.
954 // TRANS: %1$s is the site name.
955 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
956 common_config('site', 'name')));
958 case 'allrightsreserved':
959 if (common_config('license', 'owner')) {
960 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
961 // TRANS: %1$s is the copyright owner.
962 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
963 common_config('license', 'owner')));
965 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
966 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
969 case 'cc': // fall through
971 $this->elementStart('p');
973 $image = common_config('license', 'image');
974 $sslimage = common_config('license', 'sslimage');
976 if (StatusNet::isHTTPS()) {
977 if (!empty($sslimage)) {
979 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
980 // CC support HTTPS on their images
981 $url = preg_replace('/^http/', 'https', $image);
983 // Better to show mixed content than no content
990 $this->element('img', array('id' => 'license_cc',
992 'alt' => common_config('license', 'title'),
996 // TRANS: license message in footer.
997 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
998 $notice = _('All %1$s content and data are available under the %2$s license.');
999 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1000 htmlspecialchars(common_config('license', 'url')) .
1002 htmlspecialchars(common_config('license', 'title')) .
1004 $this->raw(sprintf(htmlspecialchars($notice),
1005 htmlspecialchars(common_config('site', 'name')),
1007 $this->elementEnd('p');
1011 Event::handle('EndShowContentLicense', array($this));
1016 * Return last modified, if applicable.
1020 * @return string last modified http header
1022 function lastModified()
1024 // For comparison with If-Last-Modified
1025 // If not applicable, return null
1030 * Return etag, if applicable.
1034 * @return string etag http header
1042 * Return true if read only.
1046 * @param array $args other arguments
1048 * @return boolean is read only action?
1050 function isReadOnly($args)
1056 * Returns query argument or default value if not found
1058 * @param string $key requested argument
1059 * @param string $def default value to return if $key is not provided
1061 * @return boolean is read only action?
1063 function arg($key, $def=null)
1065 if (array_key_exists($key, $this->args)) {
1066 return $this->args[$key];
1073 * Returns trimmed query argument or default value if not found
1075 * @param string $key requested argument
1076 * @param string $def default value to return if $key is not provided
1078 * @return boolean is read only action?
1080 function trimmed($key, $def=null)
1082 $arg = $this->arg($key, $def);
1083 return is_string($arg) ? trim($arg) : $arg;
1089 * @param array $argarray is ignored since it's now passed in in prepare()
1091 * @return boolean is read only action?
1093 function handle($argarray=null)
1095 header('Vary: Accept-Encoding,Cookie');
1097 $lm = $this->lastModified();
1098 $etag = $this->etag();
1101 header('ETag: ' . $etag);
1105 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1106 if ($this->isCacheable()) {
1107 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1108 header( "Cache-Control: private, must-revalidate, max-age=0" );
1115 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1116 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1117 if ($if_none_match) {
1118 // If this check fails, ignore the if-modified-since below.
1120 if ($this->_hasEtag($etag, $if_none_match)) {
1121 header('HTTP/1.1 304 Not Modified');
1122 // Better way to do this?
1128 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1129 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1130 $ims = strtotime($if_modified_since);
1132 header('HTTP/1.1 304 Not Modified');
1133 // Better way to do this?
1140 * Is this action cacheable?
1142 * If the action returns a last-modified
1144 * @param array $argarray is ignored since it's now passed in in prepare()
1146 * @return boolean is read only action?
1148 function isCacheable()
1154 * HasĀ etag? (private)
1156 * @param string $etag etag http header
1157 * @param string $if_none_match ifNoneMatch http header
1161 function _hasEtag($etag, $if_none_match)
1163 $etags = explode(',', $if_none_match);
1164 return in_array($etag, $etags) || in_array('*', $etags);
1168 * Boolean understands english (yes, no, true, false)
1170 * @param string $key query key we're interested in
1171 * @param string $def default value
1173 * @return boolean interprets yes/no strings as boolean
1175 function boolean($key, $def=false)
1177 $arg = strtolower($this->trimmed($key));
1179 if (is_null($arg)) {
1181 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1183 } else if (in_array($arg, array('false', 'no', '0'))) {
1191 * Integer value of an argument
1193 * @param string $key query key we're interested in
1194 * @param string $defValue optional default value (default null)
1195 * @param string $maxValue optional max value (default null)
1196 * @param string $minValue optional min value (default null)
1198 * @return integer integer value
1200 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1202 $arg = strtolower($this->trimmed($key));
1204 if (is_null($arg) || !is_integer($arg)) {
1208 if (!is_null($maxValue)) {
1209 $arg = min($arg, $maxValue);
1212 if (!is_null($minValue)) {
1213 $arg = max($arg, $minValue);
1222 * @param string $msg error message to display
1223 * @param integer $code http error code, 500 by default
1227 function serverError($msg, $code=500)
1229 $action = $this->trimmed('action');
1230 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1231 throw new ServerException($msg, $code);
1237 * @param string $msg error message to display
1238 * @param integer $code http error code, 400 by default
1242 function clientError($msg, $code=400)
1244 $action = $this->trimmed('action');
1245 common_debug("User error '$code' on '$action': $msg", __FILE__);
1246 throw new ClientException($msg, $code);
1250 * Returns the current URL
1252 * @return string current URL
1256 list($action, $args) = $this->returnToArgs();
1257 return common_local_url($action, $args);
1261 * Returns arguments sufficient for re-constructing URL
1263 * @return array two elements: action, other args
1265 function returnToArgs()
1267 $action = $this->trimmed('action');
1268 $args = $this->args;
1269 unset($args['action']);
1270 if (common_config('site', 'fancy')) {
1273 if (array_key_exists('submit', $args)) {
1274 unset($args['submit']);
1276 foreach (array_keys($_COOKIE) as $cookie) {
1277 unset($args[$cookie]);
1279 return array($action, $args);
1283 * Generate a menu item
1285 * @param string $url menu URL
1286 * @param string $text menu name
1287 * @param string $title title attribute, null by default
1288 * @param boolean $is_selected current menu item, false by default
1289 * @param string $id element id, null by default
1293 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1295 // Added @id to li for some control.
1296 // XXX: We might want to move this to htmloutputter.php
1299 $lattrs['class'] = 'current';
1302 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1304 $this->elementStart('li', $lattrs);
1305 $attrs['href'] = $url;
1307 $attrs['title'] = $title;
1309 $this->element('a', $attrs, $text);
1310 $this->elementEnd('li');
1314 * Generate pagination links
1316 * @param boolean $have_before is there something before?
1317 * @param boolean $have_after is there something after?
1318 * @param integer $page current page
1319 * @param string $action current action
1320 * @param array $args rest of query arguments
1324 // XXX: The messages in this pagination method only tailor to navigating
1325 // notices. In other lists, "Previous"/"Next" type navigation is
1326 // desirable, but not available.
1327 function pagination($have_before, $have_after, $page, $action, $args=null)
1329 // Does a little before-after block for next/prev page
1330 if ($have_before || $have_after) {
1331 $this->elementStart('ul', array('class' => 'nav',
1332 'id' => 'pagination'));
1335 $pargs = array('page' => $page-1);
1336 $this->elementStart('li', array('class' => 'nav_prev'));
1337 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1339 // TRANS: Pagination message to go to a page displaying information more in the
1340 // TRANS: present than the currently displayed information.
1342 $this->elementEnd('li');
1345 $pargs = array('page' => $page+1);
1346 $this->elementStart('li', array('class' => 'nav_next'));
1347 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1349 // TRANS: Pagination message to go to a page displaying information more in the
1350 // TRANS: past than the currently displayed information.
1352 $this->elementEnd('li');
1354 if ($have_before || $have_after) {
1355 $this->elementEnd('ul');
1360 * An array of feeds for this action.
1362 * Returns an array of potential feeds for this action.
1364 * @return array Feed object to show in head and links
1372 * A design for this action
1374 * @return Design a design object to use
1376 function getDesign()
1378 return Design::siteDesign();
1382 * Check the session token.
1384 * Checks that the current form has the correct session token,
1385 * and throw an exception if it does not.
1389 // XXX: Finding this type of check with the same message about 50 times.
1390 // Possible to refactor?
1391 function checkSessionToken()
1394 $token = $this->trimmed('token');
1395 if (empty($token) || $token != common_session_token()) {
1396 // TRANS: Client error text when there is a problem with the session token.
1397 $this->clientError(_('There was a problem with your session token.'));
1402 * Check if the current request is a POST
1404 * @return boolean true if POST; otherwise false.
1409 return ($_SERVER['REQUEST_METHOD'] == 'POST');