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))) {
103 Event::handle('EndShowHTML', array($this));
105 if (Event::handle('StartShowHead', array($this))) {
107 Event::handle('EndShowHead', array($this));
109 if (Event::handle('StartShowBody', array($this))) {
111 Event::handle('EndShowBody', array($this));
113 if (Event::handle('StartEndHTML', array($this))) {
115 Event::handle('EndEndHTML', array($this));
123 if (isset($_startTime)) {
124 $endTime = microtime(true);
125 $diff = round(($endTime - $_startTime) * 1000);
126 $this->raw("<!-- ${diff}ms -->");
129 return parent::endHTML();
133 * Show head, a template method.
139 // XXX: attributes (profile?)
140 $this->elementStart('head');
141 if (Event::handle('StartShowHeadElements', array($this))) {
142 if (Event::handle('StartShowHeadTitle', array($this))) {
144 Event::handle('EndShowHeadTitle', array($this));
146 $this->showShortcutIcon();
147 $this->showStylesheets();
148 $this->showOpenSearch();
150 $this->showDescription();
152 Event::handle('EndShowHeadElements', array($this));
154 $this->elementEnd('head');
158 * Show title, a template method.
164 $this->element('title', null,
165 // TRANS: Page title. %1$s is the title, %2$s is the site name.
166 sprintf(_("%1\$s - %2\$s"),
168 common_config('site', 'name')));
172 * Returns the page title
176 * @return string page title
181 // TRANS: Page title for a page without a title set.
182 return _("Untitled page");
186 * Show themed shortcut icon
190 function showShortcutIcon()
192 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
193 $this->element('link', array('rel' => 'shortcut icon',
194 'href' => Theme::path('favicon.ico')));
196 // favicon.ico should be HTTPS if the rest of the page is
197 $this->element('link', array('rel' => 'shortcut icon',
198 'href' => common_path('favicon.ico', StatusNet::isHTTPS())));
201 if (common_config('site', 'mobile')) {
202 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
203 $this->element('link', array('rel' => 'apple-touch-icon',
204 'href' => Theme::path('apple-touch-icon.png')));
206 $this->element('link', array('rel' => 'apple-touch-icon',
207 'href' => common_path('apple-touch-icon.png')));
217 function showStylesheets()
219 if (Event::handle('StartShowStyles', array($this))) {
221 // Use old name for StatusNet for compatibility on events
223 if (Event::handle('StartShowStatusNetStyles', array($this)) &&
224 Event::handle('StartShowLaconicaStyles', array($this))) {
225 $this->primaryCssLink(null, 'screen, projection, tv, print');
226 Event::handle('EndShowStatusNetStyles', array($this));
227 Event::handle('EndShowLaconicaStyles', array($this));
230 $this->cssLink(common_path('js/css/smoothness/jquery-ui.css'));
232 if (Event::handle('StartShowUAStyles', array($this))) {
233 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
234 'href="'.Theme::path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
235 foreach (array(6,7) as $ver) {
236 if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
237 // Yes, IE people should be put in jail.
238 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
239 'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
242 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
243 'href="'.Theme::path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
244 Event::handle('EndShowUAStyles', array($this));
247 if (Event::handle('StartShowDesign', array($this))) {
249 $user = common_current_user();
251 if (empty($user) || $user->viewdesigns) {
252 $design = $this->getDesign();
254 if (!empty($design)) {
255 $design->showCSS($this);
259 Event::handle('EndShowDesign', array($this));
261 Event::handle('EndShowStyles', array($this));
263 if (common_config('custom_css', 'enabled')) {
264 $css = common_config('custom_css', 'css');
265 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
266 if (trim($css) != '') {
269 Event::handle('EndShowCustomCss', array($this));
275 function primaryCssLink($mainTheme=null, $media=null)
277 $theme = new Theme($mainTheme);
279 // Some themes may have external stylesheets, such as using the
280 // Google Font APIs to load webfonts.
281 foreach ($theme->getExternals() as $url) {
282 $this->cssLink($url, $mainTheme, $media);
285 // If the currently-selected theme has dependencies on other themes,
286 // we'll need to load their display.css files as well in order.
287 $baseThemes = $theme->getDeps();
288 foreach ($baseThemes as $baseTheme) {
289 $this->cssLink('css/display.css', $baseTheme, $media);
291 $this->cssLink('css/display.css', $mainTheme, $media);
295 * Show javascript headers
299 function showScripts()
301 if (Event::handle('StartShowScripts', array($this))) {
302 if (Event::handle('StartShowJQueryScripts', array($this))) {
303 if (common_config('site', 'minify')) {
304 $this->script('jquery.min.js');
305 $this->script('jquery.form.min.js');
306 $this->script('jquery-ui.min.js');
307 $this->script('jquery.cookie.min.js');
308 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.min.js').'"); }');
309 $this->script('jquery.joverlay.min.js');
311 $this->script('jquery.js');
312 $this->script('jquery.form.js');
313 $this->script('jquery-ui.min.js');
314 $this->script('jquery.cookie.js');
315 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.js').'"); }');
316 $this->script('jquery.joverlay.js');
318 Event::handle('EndShowJQueryScripts', array($this));
320 if (Event::handle('StartShowStatusNetScripts', array($this)) &&
321 Event::handle('StartShowLaconicaScripts', array($this))) {
322 if (common_config('site', 'minify')) {
323 $this->script('util.min.js');
325 $this->script('util.js');
326 $this->script('xbImportNode.js');
327 $this->script('geometa.js');
329 $this->showScriptMessages();
330 // Frame-busting code to avoid clickjacking attacks.
331 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
332 Event::handle('EndShowStatusNetScripts', array($this));
333 Event::handle('EndShowLaconicaScripts', array($this));
335 Event::handle('EndShowScripts', array($this));
340 * Exports a map of localized text strings to JavaScript code.
342 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
343 * events and appending to the array. Try to avoid adding strings that won't be used, as
344 * they'll be added to HTML output.
347 function showScriptMessages()
351 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
352 // Common messages needed for timeline views etc...
354 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
355 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
357 // TRANS: Inline reply form submit button: submits a reply comment.
358 $messages['reply_submit'] = _m('BUTTON', 'Reply');
360 // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
361 $messages['reply_placeholder'] = _m('Write a reply...');
363 $messages = array_merge($messages, $this->getScriptMessages());
365 Event::handle('EndScriptMessages', array($this, &$messages));
368 if (!empty($messages)) {
369 $this->inlineScript('SN.messages=' . json_encode($messages));
376 * If the action will need localizable text strings, export them here like so:
378 * return array('pool_deepend' => _('Deep end'),
379 * 'pool_shallow' => _('Shallow end'));
381 * The exported map will be available via SN.msg() to JS code:
383 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
384 * $('#pool .deepend').text(SN.msg('pool_deepend'));
385 * $('#pool .shallow').text(SN.msg('pool_shallow'));
387 * Exports a map of localized text strings to JavaScript code.
389 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
390 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
391 * be used, as they'll be added to HTML output.
393 function getScriptMessages()
399 * Show OpenSearch headers
403 function showOpenSearch()
405 $this->element('link', array('rel' => 'search',
406 'type' => 'application/opensearchdescription+xml',
407 'href' => common_local_url('opensearch', array('type' => 'people')),
408 'title' => common_config('site', 'name').' People Search'));
409 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
410 'href' => common_local_url('opensearch', array('type' => 'notice')),
411 'title' => common_config('site', 'name').' Notice Search'));
423 $feeds = $this->getFeeds();
426 foreach ($feeds as $feed) {
427 $this->element('link', array('rel' => $feed->rel(),
428 'href' => $feed->url,
429 'type' => $feed->mimeType(),
430 'title' => $feed->title));
442 function showDescription()
444 // does nothing by default
448 * Show extra stuff in <head>.
456 // does nothing by default
462 * Calls template methods
468 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
469 'class' => 'user_in')
470 : array('id' => strtolower($this->trimmed('action'))));
471 $this->elementStart('div', array('id' => 'wrap'));
472 if (Event::handle('StartShowHeader', array($this))) {
474 Event::handle('EndShowHeader', array($this));
477 if (Event::handle('StartShowFooter', array($this))) {
479 Event::handle('EndShowFooter', array($this));
481 $this->elementEnd('div');
482 $this->showScripts();
483 $this->elementEnd('body');
487 * Show header of the page.
489 * Calls template methods
493 function showHeader()
495 $this->elementStart('div', array('id' => 'header'));
497 $this->showPrimaryNav();
498 if (Event::handle('StartShowSiteNotice', array($this))) {
499 $this->showSiteNotice();
501 Event::handle('EndShowSiteNotice', array($this));
504 $this->elementEnd('div');
508 * Show configured logo.
514 $this->elementStart('address', array('id' => 'site_contact',
515 'class' => 'vcard'));
516 if (Event::handle('StartAddressData', array($this))) {
517 if (common_config('singleuser', 'enabled')) {
518 $user = User::singleUser();
519 $url = common_local_url('showstream',
520 array('nickname' => $user->nickname));
521 } else if (common_logged_in()) {
522 $cur = common_current_user();
523 $url = common_local_url('all', array('nickname' => $cur->nickname));
525 $url = common_local_url('public');
528 $this->elementStart('a', array('class' => 'url home bookmark',
531 if (StatusNet::isHTTPS()) {
532 $logoUrl = common_config('site', 'ssllogo');
533 if (empty($logoUrl)) {
534 // if logo is an uploaded file, try to fall back to HTTPS file URL
535 $httpUrl = common_config('site', 'logo');
536 if (!empty($httpUrl)) {
537 $f = File::staticGet('url', $httpUrl);
538 if (!empty($f) && !empty($f->filename)) {
539 // this will handle the HTTPS case
540 $logoUrl = File::url($f->filename);
545 $logoUrl = common_config('site', 'logo');
548 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
549 // This should handle the HTTPS case internally
550 $logoUrl = Theme::path('logo.png');
553 if (!empty($logoUrl)) {
554 $this->element('img', array('class' => 'logo photo',
556 'alt' => common_config('site', 'name')));
560 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
561 $this->elementEnd('a');
563 Event::handle('EndAddressData', array($this));
565 $this->elementEnd('address');
569 * Show primary navigation.
573 function showPrimaryNav()
575 $this->elementStart('div', array('id' => 'site_nav_global_primary'));
576 $pn = new PrimaryNav($this);
578 $this->elementEnd('div');
586 function showSiteNotice()
588 // Revist. Should probably do an hAtom pattern here
589 $text = common_config('site', 'notice');
591 $this->elementStart('div', array('id' => 'site_notice',
592 'class' => 'system_notice'));
594 $this->elementEnd('div');
601 * MAY overload if no notice form needed... or direct message box????
605 function showNoticeForm()
607 $tabs = array('status' => _('Status'));
609 $this->elementStart('div', 'input_forms');
611 if (Event::handle('StartShowEntryForms', array(&$tabs))) {
613 $this->elementStart('ul', array('class' => 'nav',
614 'id' => 'input_form_nav'));
616 foreach ($tabs as $tag => $title) {
618 $attrs = array('id' => 'input_form_nav_'.$tag,
619 'class' => 'input_form_nav_tab');
621 if ($tag == 'status') {
622 // We're actually showing the placeholder form,
623 // but we special-case the 'Status' tab as if
624 // it were a small version of it.
625 $attrs['class'] .= ' current';
627 $this->elementStart('li', $attrs);
630 array('href' => 'javascript:SN.U.switchInputFormTab("'.$tag.'")'),
632 $this->elementEnd('li');
635 $this->elementEnd('ul');
637 $attrs = array('class' => 'input_form current',
638 'id' => 'input_form_placeholder');
639 $this->elementStart('div', $attrs);
640 $form = new NoticePlaceholderForm($this);
642 $this->elementEnd('div');
644 foreach ($tabs as $tag => $title) {
646 $attrs = array('class' => 'input_form',
647 'id' => 'input_form_'.$tag);
649 $this->elementStart('div', $attrs);
653 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
654 if ($tag == 'status') {
655 $form = new NoticeForm($this);
657 Event::handle('EndMakeEntryForm', array($tag, $this, $form));
664 $this->elementEnd('div');
668 $this->elementEnd('div');
672 * Show anonymous message.
678 function showAnonymousMessage()
680 // needs to be defined by the class
686 * Shows local navigation, content block and aside.
692 $this->elementStart('div', array('id' => 'core'));
693 $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
694 $this->elementStart('div', array('id' => 'content_wrapper'));
695 $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
696 if (Event::handle('StartShowLocalNavBlock', array($this))) {
697 $this->showLocalNavBlock();
698 Event::handle('EndShowLocalNavBlock', array($this));
700 if (Event::handle('StartShowContentBlock', array($this))) {
701 $this->showContentBlock();
702 Event::handle('EndShowContentBlock', array($this));
704 if (Event::handle('StartShowAside', array($this))) {
706 Event::handle('EndShowAside', array($this));
708 $this->elementEnd('div');
709 $this->elementEnd('div');
710 $this->elementEnd('div');
711 $this->elementEnd('div');
715 * Show local navigation block.
719 function showLocalNavBlock()
721 // Need to have this ID for CSS; I'm too lazy to add it to
723 $this->elementStart('div', array('id' => 'site_nav_local_views'));
724 // Cheat cheat cheat!
725 $this->showLocalNav();
726 $this->elementEnd('div');
730 * If there's a logged-in user, show a bit of login context
735 function showProfileBlock()
737 if (common_logged_in()) {
738 $block = new DefaultProfileBlock($this);
744 * Show local navigation.
750 function showLocalNav()
752 $nav = new DefaultLocalNav($this);
757 * Show menu for an object (group, profile)
759 * This block will only show if a subclass has overridden
760 * the showObjectNav() method.
764 function showObjectNavBlock()
766 $rmethod = new ReflectionMethod($this, 'showObjectNav');
767 $dclass = $rmethod->getDeclaringClass()->getName();
769 if ($dclass != 'Action') {
770 // Need to have this ID for CSS; I'm too lazy to add it to
772 $this->elementStart('div', array('id' => 'site_nav_object',
773 'class' => 'section'));
774 $this->showObjectNav();
775 $this->elementEnd('div');
780 * Show object navigation.
782 * If there are things to do with this object, show it here.
786 function showObjectNav()
792 * Show content block.
796 function showContentBlock()
798 $this->elementStart('div', array('id' => 'content'));
799 if (common_logged_in()) {
800 if (Event::handle('StartShowNoticeForm', array($this))) {
801 $this->showNoticeForm();
802 Event::handle('EndShowNoticeForm', array($this));
805 if (Event::handle('StartShowPageTitle', array($this))) {
806 $this->showPageTitle();
807 Event::handle('EndShowPageTitle', array($this));
809 $this->showPageNoticeBlock();
810 $this->elementStart('div', array('id' => 'content_inner'));
811 // show the actual content (forms, lists, whatever)
812 $this->showContent();
813 $this->elementEnd('div');
814 $this->elementEnd('div');
822 function showPageTitle()
824 $this->element('h1', null, $this->title());
828 * Show page notice block.
830 * Only show the block if a subclassed action has overrided
831 * Action::showPageNotice(), or an event handler is registered for
832 * the StartShowPageNotice event, in which case we assume the
833 * 'page_notice' definition list is desired. This is to prevent
834 * empty 'page_notice' definition lists from being output everywhere.
838 function showPageNoticeBlock()
840 $rmethod = new ReflectionMethod($this, 'showPageNotice');
841 $dclass = $rmethod->getDeclaringClass()->getName();
843 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
845 $this->elementStart('div', array('id' => 'page_notice',
846 'class' => 'system_notice'));
847 if (Event::handle('StartShowPageNotice', array($this))) {
848 $this->showPageNotice();
849 Event::handle('EndShowPageNotice', array($this));
851 $this->elementEnd('div');
858 * SHOULD overload (unless there's not a notice)
862 function showPageNotice()
869 * MUST overload (unless there's not a notice)
873 function showContent()
884 $this->elementStart('div', array('id' => 'aside_primary',
885 'class' => 'aside'));
886 $this->showProfileBlock();
887 if (Event::handle('StartShowObjectNavBlock', array($this))) {
888 $this->showObjectNavBlock();
889 Event::handle('EndShowObjectNavBlock', array($this));
891 if (Event::handle('StartShowSections', array($this))) {
892 $this->showSections();
893 Event::handle('EndShowSections', array($this));
895 if (Event::handle('StartShowExportData', array($this))) {
896 $this->showExportData();
897 Event::handle('EndShowExportData', array($this));
899 $this->elementEnd('div');
903 * Show export data feeds.
907 function showExportData()
909 $feeds = $this->getFeeds();
911 $fl = new FeedList($this);
923 function showSections()
925 // for each section, show it
933 function showFooter()
935 $this->elementStart('div', array('id' => 'footer'));
936 if (Event::handle('StartShowInsideFooter', array($this))) {
937 $this->showSecondaryNav();
938 $this->showLicenses();
939 Event::handle('EndShowInsideFooter', array($this));
941 $this->elementEnd('div');
945 * Show secondary navigation.
949 function showSecondaryNav()
951 $sn = new SecondaryNav($this);
960 function showLicenses()
962 $this->showStatusNetLicense();
963 $this->showContentLicense();
967 * Show StatusNet license.
971 function showStatusNetLicense()
973 if (common_config('site', 'broughtby')) {
974 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
975 // TRANS: Text between [] is a link description, text between () is the link itself.
976 // TRANS: Make sure there is no whitespace between "]" and "(".
977 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
978 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
980 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
981 $instr = _('**%%site.name%%** is a microblogging service.');
984 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
985 // TRANS: Make sure there is no whitespace between "]" and "(".
986 // TRANS: Text between [] is a link description, text between () is the link itself.
987 // TRANS: %s is the version of StatusNet that is being used.
988 $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);
989 $output = common_markup_to_html($instr);
995 * Show content license.
999 function showContentLicense()
1001 if (Event::handle('StartShowContentLicense', array($this))) {
1002 switch (common_config('license', 'type')) {
1004 // TRANS: Content license displayed when license is set to 'private'.
1005 // TRANS: %1$s is the site name.
1006 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
1007 common_config('site', 'name')));
1009 case 'allrightsreserved':
1010 if (common_config('license', 'owner')) {
1011 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
1012 // TRANS: %1$s is the copyright owner.
1013 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
1014 common_config('license', 'owner')));
1016 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
1017 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
1020 case 'cc': // fall through
1022 $this->elementStart('p');
1024 $image = common_config('license', 'image');
1025 $sslimage = common_config('license', 'sslimage');
1027 if (StatusNet::isHTTPS()) {
1028 if (!empty($sslimage)) {
1030 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1031 // CC support HTTPS on their images
1032 $url = preg_replace('/^http/', 'https', $image);
1034 // Better to show mixed content than no content
1041 $this->element('img', array('id' => 'license_cc',
1043 'alt' => common_config('license', 'title'),
1047 // TRANS: license message in footer.
1048 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1049 $notice = _('All %1$s content and data are available under the %2$s license.');
1050 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1051 htmlspecialchars(common_config('license', 'url')) .
1053 htmlspecialchars(common_config('license', 'title')) .
1055 $this->raw(sprintf(htmlspecialchars($notice),
1056 htmlspecialchars(common_config('site', 'name')),
1058 $this->elementEnd('p');
1062 Event::handle('EndShowContentLicense', array($this));
1067 * Return last modified, if applicable.
1071 * @return string last modified http header
1073 function lastModified()
1075 // For comparison with If-Last-Modified
1076 // If not applicable, return null
1081 * Return etag, if applicable.
1085 * @return string etag http header
1093 * Return true if read only.
1097 * @param array $args other arguments
1099 * @return boolean is read only action?
1101 function isReadOnly($args)
1107 * Returns query argument or default value if not found
1109 * @param string $key requested argument
1110 * @param string $def default value to return if $key is not provided
1112 * @return boolean is read only action?
1114 function arg($key, $def=null)
1116 if (array_key_exists($key, $this->args)) {
1117 return $this->args[$key];
1124 * Returns trimmed query argument or default value if not found
1126 * @param string $key requested argument
1127 * @param string $def default value to return if $key is not provided
1129 * @return boolean is read only action?
1131 function trimmed($key, $def=null)
1133 $arg = $this->arg($key, $def);
1134 return is_string($arg) ? trim($arg) : $arg;
1140 * @param array $argarray is ignored since it's now passed in in prepare()
1142 * @return boolean is read only action?
1144 function handle($argarray=null)
1146 header('Vary: Accept-Encoding,Cookie');
1148 $lm = $this->lastModified();
1149 $etag = $this->etag();
1152 header('ETag: ' . $etag);
1156 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1157 if ($this->isCacheable()) {
1158 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1159 header( "Cache-Control: private, must-revalidate, max-age=0" );
1166 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1167 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1168 if ($if_none_match) {
1169 // If this check fails, ignore the if-modified-since below.
1171 if ($this->_hasEtag($etag, $if_none_match)) {
1172 header('HTTP/1.1 304 Not Modified');
1173 // Better way to do this?
1179 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1180 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1181 $ims = strtotime($if_modified_since);
1183 header('HTTP/1.1 304 Not Modified');
1184 // Better way to do this?
1191 * Is this action cacheable?
1193 * If the action returns a last-modified
1195 * @param array $argarray is ignored since it's now passed in in prepare()
1197 * @return boolean is read only action?
1199 function isCacheable()
1205 * HasĀ etag? (private)
1207 * @param string $etag etag http header
1208 * @param string $if_none_match ifNoneMatch http header
1212 function _hasEtag($etag, $if_none_match)
1214 $etags = explode(',', $if_none_match);
1215 return in_array($etag, $etags) || in_array('*', $etags);
1219 * Boolean understands english (yes, no, true, false)
1221 * @param string $key query key we're interested in
1222 * @param string $def default value
1224 * @return boolean interprets yes/no strings as boolean
1226 function boolean($key, $def=false)
1228 $arg = strtolower($this->trimmed($key));
1230 if (is_null($arg)) {
1232 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1234 } else if (in_array($arg, array('false', 'no', '0'))) {
1242 * Integer value of an argument
1244 * @param string $key query key we're interested in
1245 * @param string $defValue optional default value (default null)
1246 * @param string $maxValue optional max value (default null)
1247 * @param string $minValue optional min value (default null)
1249 * @return integer integer value
1251 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1253 $arg = strtolower($this->trimmed($key));
1255 if (is_null($arg) || !is_integer($arg)) {
1259 if (!is_null($maxValue)) {
1260 $arg = min($arg, $maxValue);
1263 if (!is_null($minValue)) {
1264 $arg = max($arg, $minValue);
1273 * @param string $msg error message to display
1274 * @param integer $code http error code, 500 by default
1278 function serverError($msg, $code=500)
1280 $action = $this->trimmed('action');
1281 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1282 throw new ServerException($msg, $code);
1288 * @param string $msg error message to display
1289 * @param integer $code http error code, 400 by default
1293 function clientError($msg, $code=400)
1295 $action = $this->trimmed('action');
1296 common_debug("User error '$code' on '$action': $msg", __FILE__);
1297 throw new ClientException($msg, $code);
1301 * Returns the current URL
1303 * @return string current URL
1307 list($action, $args) = $this->returnToArgs();
1308 return common_local_url($action, $args);
1312 * Returns arguments sufficient for re-constructing URL
1314 * @return array two elements: action, other args
1316 function returnToArgs()
1318 $action = $this->trimmed('action');
1319 $args = $this->args;
1320 unset($args['action']);
1321 if (common_config('site', 'fancy')) {
1324 if (array_key_exists('submit', $args)) {
1325 unset($args['submit']);
1327 foreach (array_keys($_COOKIE) as $cookie) {
1328 unset($args[$cookie]);
1330 return array($action, $args);
1334 * Generate a menu item
1336 * @param string $url menu URL
1337 * @param string $text menu name
1338 * @param string $title title attribute, null by default
1339 * @param boolean $is_selected current menu item, false by default
1340 * @param string $id element id, null by default
1344 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1346 // Added @id to li for some control.
1347 // XXX: We might want to move this to htmloutputter.php
1350 $lattrs['class'] = 'current';
1353 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1355 $this->elementStart('li', $lattrs);
1356 $attrs['href'] = $url;
1358 $attrs['title'] = $title;
1360 $this->element('a', $attrs, $text);
1361 $this->elementEnd('li');
1365 * Generate pagination links
1367 * @param boolean $have_before is there something before?
1368 * @param boolean $have_after is there something after?
1369 * @param integer $page current page
1370 * @param string $action current action
1371 * @param array $args rest of query arguments
1375 // XXX: The messages in this pagination method only tailor to navigating
1376 // notices. In other lists, "Previous"/"Next" type navigation is
1377 // desirable, but not available.
1378 function pagination($have_before, $have_after, $page, $action, $args=null)
1380 // Does a little before-after block for next/prev page
1381 if ($have_before || $have_after) {
1382 $this->elementStart('ul', array('class' => 'nav',
1383 'id' => 'pagination'));
1386 $pargs = array('page' => $page-1);
1387 $this->elementStart('li', array('class' => 'nav_prev'));
1388 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1390 // TRANS: Pagination message to go to a page displaying information more in the
1391 // TRANS: present than the currently displayed information.
1393 $this->elementEnd('li');
1396 $pargs = array('page' => $page+1);
1397 $this->elementStart('li', array('class' => 'nav_next'));
1398 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1400 // TRANS: Pagination message to go to a page displaying information more in the
1401 // TRANS: past than the currently displayed information.
1403 $this->elementEnd('li');
1405 if ($have_before || $have_after) {
1406 $this->elementEnd('ul');
1411 * An array of feeds for this action.
1413 * Returns an array of potential feeds for this action.
1415 * @return array Feed object to show in head and links
1423 * A design for this action
1425 * @return Design a design object to use
1427 function getDesign()
1429 return Design::siteDesign();
1433 * Check the session token.
1435 * Checks that the current form has the correct session token,
1436 * and throw an exception if it does not.
1440 // XXX: Finding this type of check with the same message about 50 times.
1441 // Possible to refactor?
1442 function checkSessionToken()
1445 $token = $this->trimmed('token');
1446 if (empty($token) || $token != common_session_token()) {
1447 // TRANS: Client error text when there is a problem with the session token.
1448 $this->clientError(_('There was a problem with your session token.'));
1453 * Check if the current request is a POST
1455 * @return boolean true if POST; otherwise false.
1460 return ($_SERVER['REQUEST_METHOD'] == 'POST');