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);
87 if ($this->boolean('ajax')) {
88 StatusNet::setAjax(true);
95 * Show page, a template method.
101 if (Event::handle('StartShowHTML', array($this))) {
104 Event::handle('EndShowHTML', array($this));
106 if (Event::handle('StartShowHead', array($this))) {
109 Event::handle('EndShowHead', array($this));
111 if (Event::handle('StartShowBody', array($this))) {
113 Event::handle('EndShowBody', array($this));
115 if (Event::handle('StartEndHTML', array($this))) {
117 Event::handle('EndEndHTML', array($this));
125 if (isset($_startTime)) {
126 $endTime = microtime(true);
127 $diff = round(($endTime - $_startTime) * 1000);
128 $this->raw("<!-- ${diff}ms -->");
131 return parent::endHTML();
135 * Show head, a template method.
141 // XXX: attributes (profile?)
142 $this->elementStart('head');
143 if (Event::handle('StartShowHeadElements', array($this))) {
144 if (Event::handle('StartShowHeadTitle', array($this))) {
146 Event::handle('EndShowHeadTitle', array($this));
148 $this->showShortcutIcon();
149 $this->showStylesheets();
150 $this->showOpenSearch();
152 $this->showDescription();
154 Event::handle('EndShowHeadElements', array($this));
156 $this->elementEnd('head');
160 * Show title, a template method.
166 $this->element('title', null,
167 // TRANS: Page title. %1$s is the title, %2$s is the site name.
168 sprintf(_('%1$s - %2$s'),
170 common_config('site', 'name')));
174 * Returns the page title
178 * @return string page title
183 // TRANS: Page title for a page without a title set.
184 return _('Untitled page');
188 * Show themed shortcut icon
192 function showShortcutIcon()
194 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
195 $this->element('link', array('rel' => 'shortcut icon',
196 'href' => Theme::path('favicon.ico')));
198 // favicon.ico should be HTTPS if the rest of the page is
199 $this->element('link', array('rel' => 'shortcut icon',
200 'href' => common_path('favicon.ico', StatusNet::isHTTPS())));
203 if (common_config('site', 'mobile')) {
204 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
205 $this->element('link', array('rel' => 'apple-touch-icon',
206 'href' => Theme::path('apple-touch-icon.png')));
208 $this->element('link', array('rel' => 'apple-touch-icon',
209 'href' => common_path('apple-touch-icon.png')));
219 function showStylesheets()
221 if (Event::handle('StartShowStyles', array($this))) {
223 // Use old name for StatusNet for compatibility on events
225 if (Event::handle('StartShowStatusNetStyles', array($this)) &&
226 Event::handle('StartShowLaconicaStyles', array($this))) {
227 $this->primaryCssLink(null, 'screen, projection, tv, print');
228 Event::handle('EndShowStatusNetStyles', array($this));
229 Event::handle('EndShowLaconicaStyles', array($this));
232 $this->cssLink(common_path('js/css/smoothness/jquery-ui.css'));
234 if (Event::handle('StartShowUAStyles', array($this))) {
235 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
236 'href="'.Theme::path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
237 foreach (array(6,7) as $ver) {
238 if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
239 // Yes, IE people should be put in jail.
240 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
241 'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
244 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
245 'href="'.Theme::path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
246 Event::handle('EndShowUAStyles', array($this));
249 if (Event::handle('StartShowDesign', array($this))) {
251 $user = common_current_user();
253 if (empty($user) || $user->viewdesigns) {
254 $design = $this->getDesign();
256 if (!empty($design)) {
257 $design->showCSS($this);
261 Event::handle('EndShowDesign', array($this));
263 Event::handle('EndShowStyles', array($this));
265 if (common_config('custom_css', 'enabled')) {
266 $css = common_config('custom_css', 'css');
267 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
268 if (trim($css) != '') {
271 Event::handle('EndShowCustomCss', array($this));
277 function primaryCssLink($mainTheme=null, $media=null)
279 $theme = new Theme($mainTheme);
281 // Some themes may have external stylesheets, such as using the
282 // Google Font APIs to load webfonts.
283 foreach ($theme->getExternals() as $url) {
284 $this->cssLink($url, $mainTheme, $media);
287 // If the currently-selected theme has dependencies on other themes,
288 // we'll need to load their display.css files as well in order.
289 $baseThemes = $theme->getDeps();
290 foreach ($baseThemes as $baseTheme) {
291 $this->cssLink('css/display.css', $baseTheme, $media);
293 $this->cssLink('css/display.css', $mainTheme, $media);
297 * Show javascript headers
301 function showScripts()
303 if (Event::handle('StartShowScripts', array($this))) {
304 if (Event::handle('StartShowJQueryScripts', array($this))) {
305 if (common_config('site', 'minify')) {
306 $this->script('jquery.min.js');
307 $this->script('jquery.form.min.js');
308 $this->script('jquery-ui.min.js');
309 $this->script('jquery.cookie.min.js');
310 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.min.js').'"); }');
311 $this->script('jquery.joverlay.min.js');
313 $this->script('jquery.js');
314 $this->script('jquery.form.js');
315 $this->script('jquery-ui.min.js');
316 $this->script('jquery.cookie.js');
317 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.js').'"); }');
318 $this->script('jquery.joverlay.js');
320 Event::handle('EndShowJQueryScripts', array($this));
322 if (Event::handle('StartShowStatusNetScripts', array($this)) &&
323 Event::handle('StartShowLaconicaScripts', array($this))) {
324 if (common_config('site', 'minify')) {
325 $this->script('util.min.js');
327 $this->script('util.js');
328 $this->script('xbImportNode.js');
329 $this->script('geometa.js');
331 $this->showScriptMessages();
332 // Frame-busting code to avoid clickjacking attacks.
333 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
334 Event::handle('EndShowStatusNetScripts', array($this));
335 Event::handle('EndShowLaconicaScripts', array($this));
337 Event::handle('EndShowScripts', array($this));
342 * Exports a map of localized text strings to JavaScript code.
344 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
345 * events and appending to the array. Try to avoid adding strings that won't be used, as
346 * they'll be added to HTML output.
349 function showScriptMessages()
353 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
354 // Common messages needed for timeline views etc...
356 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
357 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
359 // TRANS: Inline reply form submit button: submits a reply comment.
360 $messages['reply_submit'] = _m('BUTTON', 'Reply');
362 // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
363 $messages['reply_placeholder'] = _m('Write a reply...');
365 $messages = array_merge($messages, $this->getScriptMessages());
367 Event::handle('EndScriptMessages', array($this, &$messages));
370 if (!empty($messages)) {
371 $this->inlineScript('SN.messages=' . json_encode($messages));
378 * If the action will need localizable text strings, export them here like so:
380 * return array('pool_deepend' => _('Deep end'),
381 * 'pool_shallow' => _('Shallow end'));
383 * The exported map will be available via SN.msg() to JS code:
385 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
386 * $('#pool .deepend').text(SN.msg('pool_deepend'));
387 * $('#pool .shallow').text(SN.msg('pool_shallow'));
389 * Exports a map of localized text strings to JavaScript code.
391 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
392 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
393 * be used, as they'll be added to HTML output.
395 function getScriptMessages()
401 * Show OpenSearch headers
405 function showOpenSearch()
407 $this->element('link', array('rel' => 'search',
408 'type' => 'application/opensearchdescription+xml',
409 'href' => common_local_url('opensearch', array('type' => 'people')),
410 'title' => common_config('site', 'name').' People Search'));
411 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
412 'href' => common_local_url('opensearch', array('type' => 'notice')),
413 'title' => common_config('site', 'name').' Notice Search'));
425 $feeds = $this->getFeeds();
428 foreach ($feeds as $feed) {
429 $this->element('link', array('rel' => $feed->rel(),
430 'href' => $feed->url,
431 'type' => $feed->mimeType(),
432 'title' => $feed->title));
444 function showDescription()
446 // does nothing by default
450 * Show extra stuff in <head>.
458 // does nothing by default
464 * Calls template methods
470 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
471 'class' => 'user_in')
472 : array('id' => strtolower($this->trimmed('action'))));
473 $this->elementStart('div', array('id' => 'wrap'));
474 if (Event::handle('StartShowHeader', array($this))) {
477 Event::handle('EndShowHeader', array($this));
481 if (Event::handle('StartShowFooter', array($this))) {
484 Event::handle('EndShowFooter', array($this));
486 $this->elementEnd('div');
487 $this->showScripts();
488 $this->elementEnd('body');
492 * Show header of the page.
494 * Calls template methods
498 function showHeader()
500 $this->elementStart('div', array('id' => 'header'));
502 $this->showPrimaryNav();
503 if (Event::handle('StartShowSiteNotice', array($this))) {
504 $this->showSiteNotice();
506 Event::handle('EndShowSiteNotice', array($this));
509 $this->elementEnd('div');
513 * Show configured logo.
519 $this->elementStart('address', array('id' => 'site_contact',
520 'class' => 'vcard'));
521 if (Event::handle('StartAddressData', array($this))) {
522 if (common_config('singleuser', 'enabled')) {
523 $user = User::singleUser();
524 $url = common_local_url('showstream',
525 array('nickname' => $user->nickname));
526 } else if (common_logged_in()) {
527 $cur = common_current_user();
528 $url = common_local_url('all', array('nickname' => $cur->nickname));
530 $url = common_local_url('public');
533 $this->elementStart('a', array('class' => 'url home bookmark',
536 if (StatusNet::isHTTPS()) {
537 $logoUrl = common_config('site', 'ssllogo');
538 if (empty($logoUrl)) {
539 // if logo is an uploaded file, try to fall back to HTTPS file URL
540 $httpUrl = common_config('site', 'logo');
541 if (!empty($httpUrl)) {
542 $f = File::staticGet('url', $httpUrl);
543 if (!empty($f) && !empty($f->filename)) {
544 // this will handle the HTTPS case
545 $logoUrl = File::url($f->filename);
550 $logoUrl = common_config('site', 'logo');
553 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
554 // This should handle the HTTPS case internally
555 $logoUrl = Theme::path('logo.png');
558 if (!empty($logoUrl)) {
559 $this->element('img', array('class' => 'logo photo',
561 'alt' => common_config('site', 'name')));
565 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
566 $this->elementEnd('a');
568 Event::handle('EndAddressData', array($this));
570 $this->elementEnd('address');
574 * Show primary navigation.
578 function showPrimaryNav()
580 $this->elementStart('div', array('id' => 'site_nav_global_primary'));
581 $pn = new PrimaryNav($this);
583 $this->elementEnd('div');
591 function showSiteNotice()
593 // Revist. Should probably do an hAtom pattern here
594 $text = common_config('site', 'notice');
596 $this->elementStart('div', array('id' => 'site_notice',
597 'class' => 'system_notice'));
599 $this->elementEnd('div');
606 * MAY overload if no notice form needed... or direct message box????
610 function showNoticeForm()
612 // TRANS: Tab on the notice form.
613 $tabs = array('status' => _m('TAB','Status'));
615 $this->elementStart('div', 'input_forms');
617 if (Event::handle('StartShowEntryForms', array(&$tabs))) {
618 $this->elementStart('ul', array('class' => 'nav',
619 'id' => 'input_form_nav'));
621 foreach ($tabs as $tag => $title) {
622 $attrs = array('id' => 'input_form_nav_'.$tag,
623 'class' => 'input_form_nav_tab');
625 if ($tag == 'status') {
626 // We're actually showing the placeholder form,
627 // but we special-case the 'Status' tab as if
628 // it were a small version of it.
629 $attrs['class'] .= ' current';
631 $this->elementStart('li', $attrs);
634 array('href' => 'javascript:SN.U.switchInputFormTab("'.$tag.'")'),
636 $this->elementEnd('li');
639 $this->elementEnd('ul');
641 $attrs = array('class' => 'input_form current',
642 'id' => 'input_form_placeholder');
643 $this->elementStart('div', $attrs);
644 $form = new NoticePlaceholderForm($this);
646 $this->elementEnd('div');
648 foreach ($tabs as $tag => $title) {
649 $attrs = array('class' => 'input_form',
650 'id' => 'input_form_'.$tag);
652 $this->elementStart('div', $attrs);
656 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
657 if ($tag == 'status') {
658 $options = $this->noticeFormOptions();
659 $form = new NoticeForm($this, $options);
661 Event::handle('EndMakeEntryForm', array($tag, $this, $form));
668 $this->elementEnd('div');
672 $this->elementEnd('div');
675 function noticeFormOptions()
681 * Show anonymous message.
687 function showAnonymousMessage()
689 // needs to be defined by the class
695 * Shows local navigation, content block and aside.
701 $this->elementStart('div', array('id' => 'core'));
702 $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
703 $this->elementStart('div', array('id' => 'content_wrapper'));
704 $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
705 if (Event::handle('StartShowLocalNavBlock', array($this))) {
706 $this->showLocalNavBlock();
708 Event::handle('EndShowLocalNavBlock', array($this));
710 if (Event::handle('StartShowContentBlock', array($this))) {
711 $this->showContentBlock();
713 Event::handle('EndShowContentBlock', array($this));
715 if (Event::handle('StartShowAside', array($this))) {
718 Event::handle('EndShowAside', array($this));
720 $this->elementEnd('div');
721 $this->elementEnd('div');
722 $this->elementEnd('div');
723 $this->elementEnd('div');
727 * Show local navigation block.
731 function showLocalNavBlock()
733 // Need to have this ID for CSS; I'm too lazy to add it to
735 $this->elementStart('div', array('id' => 'site_nav_local_views'));
736 // Cheat cheat cheat!
737 $this->showLocalNav();
738 $this->elementEnd('div');
742 * If there's a logged-in user, show a bit of login context
747 function showProfileBlock()
749 if (common_logged_in()) {
750 $block = new DefaultProfileBlock($this);
756 * Show local navigation.
762 function showLocalNav()
764 $nav = new DefaultLocalNav($this);
769 * Show menu for an object (group, profile)
771 * This block will only show if a subclass has overridden
772 * the showObjectNav() method.
776 function showObjectNavBlock()
778 $rmethod = new ReflectionMethod($this, 'showObjectNav');
779 $dclass = $rmethod->getDeclaringClass()->getName();
781 if ($dclass != 'Action') {
782 // Need to have this ID for CSS; I'm too lazy to add it to
784 $this->elementStart('div', array('id' => 'site_nav_object',
785 'class' => 'section'));
786 $this->showObjectNav();
787 $this->elementEnd('div');
792 * Show object navigation.
794 * If there are things to do with this object, show it here.
798 function showObjectNav()
804 * Show content block.
808 function showContentBlock()
810 $this->elementStart('div', array('id' => 'content'));
811 if (common_logged_in()) {
812 if (Event::handle('StartShowNoticeForm', array($this))) {
813 $this->showNoticeForm();
814 Event::handle('EndShowNoticeForm', array($this));
817 if (Event::handle('StartShowPageTitle', array($this))) {
818 $this->showPageTitle();
819 Event::handle('EndShowPageTitle', array($this));
821 $this->showPageNoticeBlock();
822 $this->elementStart('div', array('id' => 'content_inner'));
823 // show the actual content (forms, lists, whatever)
824 $this->showContent();
825 $this->elementEnd('div');
826 $this->elementEnd('div');
834 function showPageTitle()
836 $this->element('h1', null, $this->title());
840 * Show page notice block.
842 * Only show the block if a subclassed action has overrided
843 * Action::showPageNotice(), or an event handler is registered for
844 * the StartShowPageNotice event, in which case we assume the
845 * 'page_notice' definition list is desired. This is to prevent
846 * empty 'page_notice' definition lists from being output everywhere.
850 function showPageNoticeBlock()
852 $rmethod = new ReflectionMethod($this, 'showPageNotice');
853 $dclass = $rmethod->getDeclaringClass()->getName();
855 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
857 $this->elementStart('div', array('id' => 'page_notice',
858 'class' => 'system_notice'));
859 if (Event::handle('StartShowPageNotice', array($this))) {
860 $this->showPageNotice();
861 Event::handle('EndShowPageNotice', array($this));
863 $this->elementEnd('div');
870 * SHOULD overload (unless there's not a notice)
874 function showPageNotice()
881 * MUST overload (unless there's not a notice)
885 function showContent()
896 $this->elementStart('div', array('id' => 'aside_primary',
897 'class' => 'aside'));
898 $this->showProfileBlock();
899 if (Event::handle('StartShowObjectNavBlock', array($this))) {
900 $this->showObjectNavBlock();
901 Event::handle('EndShowObjectNavBlock', array($this));
903 if (Event::handle('StartShowSections', array($this))) {
904 $this->showSections();
905 Event::handle('EndShowSections', array($this));
907 if (Event::handle('StartShowExportData', array($this))) {
908 $this->showExportData();
909 Event::handle('EndShowExportData', array($this));
911 $this->elementEnd('div');
915 * Show export data feeds.
919 function showExportData()
921 $feeds = $this->getFeeds();
923 $fl = new FeedList($this);
935 function showSections()
937 // for each section, show it
945 function showFooter()
947 $this->elementStart('div', array('id' => 'footer'));
948 if (Event::handle('StartShowInsideFooter', array($this))) {
949 $this->showSecondaryNav();
950 $this->showLicenses();
951 Event::handle('EndShowInsideFooter', array($this));
953 $this->elementEnd('div');
957 * Show secondary navigation.
961 function showSecondaryNav()
963 $sn = new SecondaryNav($this);
972 function showLicenses()
974 $this->showStatusNetLicense();
975 $this->showContentLicense();
979 * Show StatusNet license.
983 function showStatusNetLicense()
985 if (common_config('site', 'broughtby')) {
986 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
987 // TRANS: Text between [] is a link description, text between () is the link itself.
988 // TRANS: Make sure there is no whitespace between "]" and "(".
989 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
990 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
992 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
993 $instr = _('**%%site.name%%** is a microblogging service.');
996 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
997 // TRANS: Make sure there is no whitespace between "]" and "(".
998 // TRANS: Text between [] is a link description, text between () is the link itself.
999 // TRANS: %s is the version of StatusNet that is being used.
1000 $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);
1001 $output = common_markup_to_html($instr);
1002 $this->raw($output);
1007 * Show content license.
1011 function showContentLicense()
1013 if (Event::handle('StartShowContentLicense', array($this))) {
1014 switch (common_config('license', 'type')) {
1016 // TRANS: Content license displayed when license is set to 'private'.
1017 // TRANS: %1$s is the site name.
1018 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
1019 common_config('site', 'name')));
1021 case 'allrightsreserved':
1022 if (common_config('license', 'owner')) {
1023 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
1024 // TRANS: %1$s is the copyright owner.
1025 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
1026 common_config('license', 'owner')));
1028 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
1029 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
1032 case 'cc': // fall through
1034 $this->elementStart('p');
1036 $image = common_config('license', 'image');
1037 $sslimage = common_config('license', 'sslimage');
1039 if (StatusNet::isHTTPS()) {
1040 if (!empty($sslimage)) {
1042 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1043 // CC support HTTPS on their images
1044 $url = preg_replace('/^http/', 'https', $image);
1046 // Better to show mixed content than no content
1053 $this->element('img', array('id' => 'license_cc',
1055 'alt' => common_config('license', 'title'),
1059 // TRANS: license message in footer.
1060 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1061 $notice = _('All %1$s content and data are available under the %2$s license.');
1062 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1063 htmlspecialchars(common_config('license', 'url')) .
1065 htmlspecialchars(common_config('license', 'title')) .
1067 $this->raw(sprintf(htmlspecialchars($notice),
1068 htmlspecialchars(common_config('site', 'name')),
1070 $this->elementEnd('p');
1074 Event::handle('EndShowContentLicense', array($this));
1079 * Return last modified, if applicable.
1083 * @return string last modified http header
1085 function lastModified()
1087 // For comparison with If-Last-Modified
1088 // If not applicable, return null
1093 * Return etag, if applicable.
1097 * @return string etag http header
1105 * Return true if read only.
1109 * @param array $args other arguments
1111 * @return boolean is read only action?
1113 function isReadOnly($args)
1119 * Returns query argument or default value if not found
1121 * @param string $key requested argument
1122 * @param string $def default value to return if $key is not provided
1124 * @return boolean is read only action?
1126 function arg($key, $def=null)
1128 if (array_key_exists($key, $this->args)) {
1129 return $this->args[$key];
1136 * Returns trimmed query argument or default value if not found
1138 * @param string $key requested argument
1139 * @param string $def default value to return if $key is not provided
1141 * @return boolean is read only action?
1143 function trimmed($key, $def=null)
1145 $arg = $this->arg($key, $def);
1146 return is_string($arg) ? trim($arg) : $arg;
1152 * @param array $argarray is ignored since it's now passed in in prepare()
1154 * @return boolean is read only action?
1156 function handle($argarray=null)
1158 header('Vary: Accept-Encoding,Cookie');
1160 $lm = $this->lastModified();
1161 $etag = $this->etag();
1164 header('ETag: ' . $etag);
1168 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1169 if ($this->isCacheable()) {
1170 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1171 header( "Cache-Control: private, must-revalidate, max-age=0" );
1178 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1179 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1180 if ($if_none_match) {
1181 // If this check fails, ignore the if-modified-since below.
1183 if ($this->_hasEtag($etag, $if_none_match)) {
1184 header('HTTP/1.1 304 Not Modified');
1185 // Better way to do this?
1191 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1192 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1193 $ims = strtotime($if_modified_since);
1195 header('HTTP/1.1 304 Not Modified');
1196 // Better way to do this?
1203 * Is this action cacheable?
1205 * If the action returns a last-modified
1207 * @param array $argarray is ignored since it's now passed in in prepare()
1209 * @return boolean is read only action?
1211 function isCacheable()
1217 * Has etag? (private)
1219 * @param string $etag etag http header
1220 * @param string $if_none_match ifNoneMatch http header
1224 function _hasEtag($etag, $if_none_match)
1226 $etags = explode(',', $if_none_match);
1227 return in_array($etag, $etags) || in_array('*', $etags);
1231 * Boolean understands english (yes, no, true, false)
1233 * @param string $key query key we're interested in
1234 * @param string $def default value
1236 * @return boolean interprets yes/no strings as boolean
1238 function boolean($key, $def=false)
1240 $arg = strtolower($this->trimmed($key));
1242 if (is_null($arg)) {
1244 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1246 } else if (in_array($arg, array('false', 'no', '0'))) {
1254 * Integer value of an argument
1256 * @param string $key query key we're interested in
1257 * @param string $defValue optional default value (default null)
1258 * @param string $maxValue optional max value (default null)
1259 * @param string $minValue optional min value (default null)
1261 * @return integer integer value
1263 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1265 $arg = strtolower($this->trimmed($key));
1267 if (is_null($arg) || !is_integer($arg)) {
1271 if (!is_null($maxValue)) {
1272 $arg = min($arg, $maxValue);
1275 if (!is_null($minValue)) {
1276 $arg = max($arg, $minValue);
1285 * @param string $msg error message to display
1286 * @param integer $code http error code, 500 by default
1290 function serverError($msg, $code=500)
1292 $action = $this->trimmed('action');
1293 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1294 throw new ServerException($msg, $code);
1300 * @param string $msg error message to display
1301 * @param integer $code http error code, 400 by default
1305 function clientError($msg, $code=400)
1307 $action = $this->trimmed('action');
1308 common_debug("User error '$code' on '$action': $msg", __FILE__);
1309 throw new ClientException($msg, $code);
1313 * Returns the current URL
1315 * @return string current URL
1319 list($action, $args) = $this->returnToArgs();
1320 return common_local_url($action, $args);
1324 * Returns arguments sufficient for re-constructing URL
1326 * @return array two elements: action, other args
1328 function returnToArgs()
1330 $action = $this->trimmed('action');
1331 $args = $this->args;
1332 unset($args['action']);
1333 if (common_config('site', 'fancy')) {
1336 if (array_key_exists('submit', $args)) {
1337 unset($args['submit']);
1339 foreach (array_keys($_COOKIE) as $cookie) {
1340 unset($args[$cookie]);
1342 return array($action, $args);
1346 * Generate a menu item
1348 * @param string $url menu URL
1349 * @param string $text menu name
1350 * @param string $title title attribute, null by default
1351 * @param boolean $is_selected current menu item, false by default
1352 * @param string $id element id, null by default
1356 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1358 // Added @id to li for some control.
1359 // XXX: We might want to move this to htmloutputter.php
1362 $lattrs['class'] = 'current';
1365 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1367 $this->elementStart('li', $lattrs);
1368 $attrs['href'] = $url;
1370 $attrs['title'] = $title;
1372 $this->element('a', $attrs, $text);
1373 $this->elementEnd('li');
1377 * Generate pagination links
1379 * @param boolean $have_before is there something before?
1380 * @param boolean $have_after is there something after?
1381 * @param integer $page current page
1382 * @param string $action current action
1383 * @param array $args rest of query arguments
1387 // XXX: The messages in this pagination method only tailor to navigating
1388 // notices. In other lists, "Previous"/"Next" type navigation is
1389 // desirable, but not available.
1390 function pagination($have_before, $have_after, $page, $action, $args=null)
1392 // Does a little before-after block for next/prev page
1393 if ($have_before || $have_after) {
1394 $this->elementStart('ul', array('class' => 'nav',
1395 'id' => 'pagination'));
1398 $pargs = array('page' => $page-1);
1399 $this->elementStart('li', array('class' => 'nav_prev'));
1400 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1402 // TRANS: Pagination message to go to a page displaying information more in the
1403 // TRANS: present than the currently displayed information.
1405 $this->elementEnd('li');
1408 $pargs = array('page' => $page+1);
1409 $this->elementStart('li', array('class' => 'nav_next'));
1410 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1412 // TRANS: Pagination message to go to a page displaying information more in the
1413 // TRANS: past than the currently displayed information.
1415 $this->elementEnd('li');
1417 if ($have_before || $have_after) {
1418 $this->elementEnd('ul');
1423 * An array of feeds for this action.
1425 * Returns an array of potential feeds for this action.
1427 * @return array Feed object to show in head and links
1435 * A design for this action
1437 * @return Design a design object to use
1439 function getDesign()
1441 return Design::siteDesign();
1445 * Check the session token.
1447 * Checks that the current form has the correct session token,
1448 * and throw an exception if it does not.
1452 // XXX: Finding this type of check with the same message about 50 times.
1453 // Possible to refactor?
1454 function checkSessionToken()
1457 $token = $this->trimmed('token');
1458 if (empty($token) || $token != common_session_token()) {
1459 // TRANS: Client error text when there is a problem with the session token.
1460 $this->clientError(_('There was a problem with your session token.'));
1465 * Check if the current request is a POST
1467 * @return boolean true if POST; otherwise false.
1472 return ($_SERVER['REQUEST_METHOD'] == 'POST');