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');
321 Event::handle('EndShowJQueryScripts', array($this));
323 if (Event::handle('StartShowStatusNetScripts', array($this)) &&
324 Event::handle('StartShowLaconicaScripts', array($this))) {
325 if (common_config('site', 'minify')) {
326 $this->script('util.min.js');
328 $this->script('util.js');
329 $this->script('xbImportNode.js');
330 $this->script('geometa.js');
333 $this->inlineScript('var _peopletagAC = "' .
334 common_local_url('peopletagautocomplete') . '";');
335 $this->showScriptMessages();
336 // Frame-busting code to avoid clickjacking attacks.
337 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
338 Event::handle('EndShowStatusNetScripts', array($this));
339 Event::handle('EndShowLaconicaScripts', array($this));
341 Event::handle('EndShowScripts', array($this));
346 * Exports a map of localized text strings to JavaScript code.
348 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
349 * events and appending to the array. Try to avoid adding strings that won't be used, as
350 * they'll be added to HTML output.
353 function showScriptMessages()
357 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
358 // Common messages needed for timeline views etc...
360 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
361 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
363 // TRANS: Inline reply form submit button: submits a reply comment.
364 $messages['reply_submit'] = _m('BUTTON', 'Reply');
366 // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
367 $messages['reply_placeholder'] = _m('Write a reply...');
369 $messages = array_merge($messages, $this->getScriptMessages());
371 Event::handle('EndScriptMessages', array($this, &$messages));
374 if (!empty($messages)) {
375 $this->inlineScript('SN.messages=' . json_encode($messages));
382 * If the action will need localizable text strings, export them here like so:
384 * return array('pool_deepend' => _('Deep end'),
385 * 'pool_shallow' => _('Shallow end'));
387 * The exported map will be available via SN.msg() to JS code:
389 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
390 * $('#pool .deepend').text(SN.msg('pool_deepend'));
391 * $('#pool .shallow').text(SN.msg('pool_shallow'));
393 * Exports a map of localized text strings to JavaScript code.
395 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
396 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
397 * be used, as they'll be added to HTML output.
399 function getScriptMessages()
405 * Show OpenSearch headers
409 function showOpenSearch()
411 $this->element('link', array('rel' => 'search',
412 'type' => 'application/opensearchdescription+xml',
413 'href' => common_local_url('opensearch', array('type' => 'people')),
414 'title' => common_config('site', 'name').' People Search'));
415 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
416 'href' => common_local_url('opensearch', array('type' => 'notice')),
417 'title' => common_config('site', 'name').' Notice Search'));
429 $feeds = $this->getFeeds();
432 foreach ($feeds as $feed) {
433 $this->element('link', array('rel' => $feed->rel(),
434 'href' => $feed->url,
435 'type' => $feed->mimeType(),
436 'title' => $feed->title));
448 function showDescription()
450 // does nothing by default
454 * Show extra stuff in <head>.
462 // does nothing by default
468 * Calls template methods
474 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
475 'class' => 'user_in')
476 : array('id' => strtolower($this->trimmed('action'))));
477 $this->elementStart('div', array('id' => 'wrap'));
478 if (Event::handle('StartShowHeader', array($this))) {
481 Event::handle('EndShowHeader', array($this));
485 if (Event::handle('StartShowFooter', array($this))) {
488 Event::handle('EndShowFooter', array($this));
490 $this->elementEnd('div');
491 $this->showScripts();
492 $this->elementEnd('body');
496 * Show header of the page.
498 * Calls template methods
502 function showHeader()
504 $this->elementStart('div', array('id' => 'header'));
506 $this->showPrimaryNav();
507 if (Event::handle('StartShowSiteNotice', array($this))) {
508 $this->showSiteNotice();
510 Event::handle('EndShowSiteNotice', array($this));
513 $this->elementEnd('div');
517 * Show configured logo.
523 $this->elementStart('address', array('id' => 'site_contact',
524 'class' => 'vcard'));
525 if (Event::handle('StartAddressData', array($this))) {
526 if (common_config('singleuser', 'enabled')) {
527 $user = User::singleUser();
528 $url = common_local_url('showstream',
529 array('nickname' => $user->nickname));
530 } else if (common_logged_in()) {
531 $cur = common_current_user();
532 $url = common_local_url('all', array('nickname' => $cur->nickname));
534 $url = common_local_url('public');
537 $this->elementStart('a', array('class' => 'url home bookmark',
540 if (StatusNet::isHTTPS()) {
541 $logoUrl = common_config('site', 'ssllogo');
542 if (empty($logoUrl)) {
543 // if logo is an uploaded file, try to fall back to HTTPS file URL
544 $httpUrl = common_config('site', 'logo');
545 if (!empty($httpUrl)) {
546 $f = File::staticGet('url', $httpUrl);
547 if (!empty($f) && !empty($f->filename)) {
548 // this will handle the HTTPS case
549 $logoUrl = File::url($f->filename);
554 $logoUrl = common_config('site', 'logo');
557 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
558 // This should handle the HTTPS case internally
559 $logoUrl = Theme::path('logo.png');
562 if (!empty($logoUrl)) {
563 $this->element('img', array('class' => 'logo photo',
565 'alt' => common_config('site', 'name')));
569 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
570 $this->elementEnd('a');
572 Event::handle('EndAddressData', array($this));
574 $this->elementEnd('address');
578 * Show primary navigation.
582 function showPrimaryNav()
584 $this->elementStart('div', array('id' => 'site_nav_global_primary'));
585 $pn = new PrimaryNav($this);
587 $this->elementEnd('div');
595 function showSiteNotice()
597 // Revist. Should probably do an hAtom pattern here
598 $text = common_config('site', 'notice');
600 $this->elementStart('div', array('id' => 'site_notice',
601 'class' => 'system_notice'));
603 $this->elementEnd('div');
610 * MAY overload if no notice form needed... or direct message box????
614 function showNoticeForm()
616 // TRANS: Tab on the notice form.
617 $tabs = array('status' => _m('TAB','Status'));
619 $this->elementStart('div', 'input_forms');
621 if (Event::handle('StartShowEntryForms', array(&$tabs))) {
622 $this->elementStart('ul', array('class' => 'nav',
623 'id' => 'input_form_nav'));
625 foreach ($tabs as $tag => $title) {
626 $attrs = array('id' => 'input_form_nav_'.$tag,
627 'class' => 'input_form_nav_tab');
629 if ($tag == 'status') {
630 // We're actually showing the placeholder form,
631 // but we special-case the 'Status' tab as if
632 // it were a small version of it.
633 $attrs['class'] .= ' current';
635 $this->elementStart('li', $attrs);
638 array('href' => 'javascript:SN.U.switchInputFormTab("'.$tag.'")'),
640 $this->elementEnd('li');
643 $this->elementEnd('ul');
645 $attrs = array('class' => 'input_form current',
646 'id' => 'input_form_placeholder');
647 $this->elementStart('div', $attrs);
648 $form = new NoticePlaceholderForm($this);
650 $this->elementEnd('div');
652 foreach ($tabs as $tag => $title) {
653 $attrs = array('class' => 'input_form',
654 'id' => 'input_form_'.$tag);
656 $this->elementStart('div', $attrs);
660 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
661 if ($tag == 'status') {
662 $options = $this->noticeFormOptions();
663 $form = new NoticeForm($this, $options);
665 Event::handle('EndMakeEntryForm', array($tag, $this, $form));
672 $this->elementEnd('div');
676 $this->elementEnd('div');
679 function noticeFormOptions()
685 * Show anonymous message.
691 function showAnonymousMessage()
693 // needs to be defined by the class
699 * Shows local navigation, content block and aside.
705 $this->elementStart('div', array('id' => 'core'));
706 $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
707 $this->elementStart('div', array('id' => 'content_wrapper'));
708 $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
709 if (Event::handle('StartShowLocalNavBlock', array($this))) {
710 $this->showLocalNavBlock();
712 Event::handle('EndShowLocalNavBlock', array($this));
714 if (Event::handle('StartShowContentBlock', array($this))) {
715 $this->showContentBlock();
717 Event::handle('EndShowContentBlock', array($this));
719 if (Event::handle('StartShowAside', array($this))) {
722 Event::handle('EndShowAside', array($this));
724 $this->elementEnd('div');
725 $this->elementEnd('div');
726 $this->elementEnd('div');
727 $this->elementEnd('div');
731 * Show local navigation block.
735 function showLocalNavBlock()
737 // Need to have this ID for CSS; I'm too lazy to add it to
739 $this->elementStart('div', array('id' => 'site_nav_local_views'));
740 // Cheat cheat cheat!
741 $this->showLocalNav();
742 $this->elementEnd('div');
746 * If there's a logged-in user, show a bit of login context
751 function showProfileBlock()
753 if (common_logged_in()) {
754 $block = new DefaultProfileBlock($this);
760 * Show local navigation.
766 function showLocalNav()
768 $nav = new DefaultLocalNav($this);
773 * Show menu for an object (group, profile)
775 * This block will only show if a subclass has overridden
776 * the showObjectNav() method.
780 function showObjectNavBlock()
782 $rmethod = new ReflectionMethod($this, 'showObjectNav');
783 $dclass = $rmethod->getDeclaringClass()->getName();
785 if ($dclass != 'Action') {
786 // Need to have this ID for CSS; I'm too lazy to add it to
788 $this->elementStart('div', array('id' => 'site_nav_object',
789 'class' => 'section'));
790 $this->showObjectNav();
791 $this->elementEnd('div');
796 * Show object navigation.
798 * If there are things to do with this object, show it here.
802 function showObjectNav()
808 * Show content block.
812 function showContentBlock()
814 $this->elementStart('div', array('id' => 'content'));
815 if (common_logged_in()) {
816 if (Event::handle('StartShowNoticeForm', array($this))) {
817 $this->showNoticeForm();
818 Event::handle('EndShowNoticeForm', array($this));
821 if (Event::handle('StartShowPageTitle', array($this))) {
822 $this->showPageTitle();
823 Event::handle('EndShowPageTitle', array($this));
825 $this->showPageNoticeBlock();
826 $this->elementStart('div', array('id' => 'content_inner'));
827 // show the actual content (forms, lists, whatever)
828 $this->showContent();
829 $this->elementEnd('div');
830 $this->elementEnd('div');
838 function showPageTitle()
840 $this->element('h1', null, $this->title());
844 * Show page notice block.
846 * Only show the block if a subclassed action has overrided
847 * Action::showPageNotice(), or an event handler is registered for
848 * the StartShowPageNotice event, in which case we assume the
849 * 'page_notice' definition list is desired. This is to prevent
850 * empty 'page_notice' definition lists from being output everywhere.
854 function showPageNoticeBlock()
856 $rmethod = new ReflectionMethod($this, 'showPageNotice');
857 $dclass = $rmethod->getDeclaringClass()->getName();
859 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
861 $this->elementStart('div', array('id' => 'page_notice',
862 'class' => 'system_notice'));
863 if (Event::handle('StartShowPageNotice', array($this))) {
864 $this->showPageNotice();
865 Event::handle('EndShowPageNotice', array($this));
867 $this->elementEnd('div');
874 * SHOULD overload (unless there's not a notice)
878 function showPageNotice()
885 * MUST overload (unless there's not a notice)
889 function showContent()
900 $this->elementStart('div', array('id' => 'aside_primary',
901 'class' => 'aside'));
902 $this->showProfileBlock();
903 if (Event::handle('StartShowObjectNavBlock', array($this))) {
904 $this->showObjectNavBlock();
905 Event::handle('EndShowObjectNavBlock', array($this));
907 if (Event::handle('StartShowSections', array($this))) {
908 $this->showSections();
909 Event::handle('EndShowSections', array($this));
911 if (Event::handle('StartShowExportData', array($this))) {
912 $this->showExportData();
913 Event::handle('EndShowExportData', array($this));
915 $this->elementEnd('div');
919 * Show export data feeds.
923 function showExportData()
925 $feeds = $this->getFeeds();
927 $fl = new FeedList($this);
939 function showSections()
941 // for each section, show it
949 function showFooter()
951 $this->elementStart('div', array('id' => 'footer'));
952 if (Event::handle('StartShowInsideFooter', array($this))) {
953 $this->showSecondaryNav();
954 $this->showLicenses();
955 Event::handle('EndShowInsideFooter', array($this));
957 $this->elementEnd('div');
961 * Show secondary navigation.
965 function showSecondaryNav()
967 $sn = new SecondaryNav($this);
976 function showLicenses()
978 $this->showStatusNetLicense();
979 $this->showContentLicense();
983 * Show StatusNet license.
987 function showStatusNetLicense()
989 if (common_config('site', 'broughtby')) {
990 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
991 // TRANS: Text between [] is a link description, text between () is the link itself.
992 // TRANS: Make sure there is no whitespace between "]" and "(".
993 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
994 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
996 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
997 $instr = _('**%%site.name%%** is a microblogging service.');
1000 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
1001 // TRANS: Make sure there is no whitespace between "]" and "(".
1002 // TRANS: Text between [] is a link description, text between () is the link itself.
1003 // TRANS: %s is the version of StatusNet that is being used.
1004 $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);
1005 $output = common_markup_to_html($instr);
1006 $this->raw($output);
1011 * Show content license.
1015 function showContentLicense()
1017 if (Event::handle('StartShowContentLicense', array($this))) {
1018 switch (common_config('license', 'type')) {
1020 // TRANS: Content license displayed when license is set to 'private'.
1021 // TRANS: %1$s is the site name.
1022 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
1023 common_config('site', 'name')));
1025 case 'allrightsreserved':
1026 if (common_config('license', 'owner')) {
1027 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
1028 // TRANS: %1$s is the copyright owner.
1029 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
1030 common_config('license', 'owner')));
1032 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
1033 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
1036 case 'cc': // fall through
1038 $this->elementStart('p');
1040 $image = common_config('license', 'image');
1041 $sslimage = common_config('license', 'sslimage');
1043 if (StatusNet::isHTTPS()) {
1044 if (!empty($sslimage)) {
1046 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1047 // CC support HTTPS on their images
1048 $url = preg_replace('/^http/', 'https', $image);
1050 // Better to show mixed content than no content
1057 $this->element('img', array('id' => 'license_cc',
1059 'alt' => common_config('license', 'title'),
1063 // TRANS: license message in footer.
1064 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1065 $notice = _('All %1$s content and data are available under the %2$s license.');
1066 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1067 htmlspecialchars(common_config('license', 'url')) .
1069 htmlspecialchars(common_config('license', 'title')) .
1071 $this->raw(sprintf(htmlspecialchars($notice),
1072 htmlspecialchars(common_config('site', 'name')),
1074 $this->elementEnd('p');
1078 Event::handle('EndShowContentLicense', array($this));
1083 * Return last modified, if applicable.
1087 * @return string last modified http header
1089 function lastModified()
1091 // For comparison with If-Last-Modified
1092 // If not applicable, return null
1097 * Return etag, if applicable.
1101 * @return string etag http header
1109 * Return true if read only.
1113 * @param array $args other arguments
1115 * @return boolean is read only action?
1117 function isReadOnly($args)
1123 * Returns query argument or default value if not found
1125 * @param string $key requested argument
1126 * @param string $def default value to return if $key is not provided
1128 * @return boolean is read only action?
1130 function arg($key, $def=null)
1132 if (array_key_exists($key, $this->args)) {
1133 return $this->args[$key];
1140 * Returns trimmed query argument or default value if not found
1142 * @param string $key requested argument
1143 * @param string $def default value to return if $key is not provided
1145 * @return boolean is read only action?
1147 function trimmed($key, $def=null)
1149 $arg = $this->arg($key, $def);
1150 return is_string($arg) ? trim($arg) : $arg;
1156 * @param array $argarray is ignored since it's now passed in in prepare()
1158 * @return boolean is read only action?
1160 function handle($argarray=null)
1162 header('Vary: Accept-Encoding,Cookie');
1164 $lm = $this->lastModified();
1165 $etag = $this->etag();
1168 header('ETag: ' . $etag);
1172 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1173 if ($this->isCacheable()) {
1174 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1175 header( "Cache-Control: private, must-revalidate, max-age=0" );
1182 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1183 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1184 if ($if_none_match) {
1185 // If this check fails, ignore the if-modified-since below.
1187 if ($this->_hasEtag($etag, $if_none_match)) {
1188 header('HTTP/1.1 304 Not Modified');
1189 // Better way to do this?
1195 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1196 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1197 $ims = strtotime($if_modified_since);
1199 header('HTTP/1.1 304 Not Modified');
1200 // Better way to do this?
1207 * Is this action cacheable?
1209 * If the action returns a last-modified
1211 * @param array $argarray is ignored since it's now passed in in prepare()
1213 * @return boolean is read only action?
1215 function isCacheable()
1221 * Has etag? (private)
1223 * @param string $etag etag http header
1224 * @param string $if_none_match ifNoneMatch http header
1228 function _hasEtag($etag, $if_none_match)
1230 $etags = explode(',', $if_none_match);
1231 return in_array($etag, $etags) || in_array('*', $etags);
1235 * Boolean understands english (yes, no, true, false)
1237 * @param string $key query key we're interested in
1238 * @param string $def default value
1240 * @return boolean interprets yes/no strings as boolean
1242 function boolean($key, $def=false)
1244 $arg = strtolower($this->trimmed($key));
1246 if (is_null($arg)) {
1248 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1250 } else if (in_array($arg, array('false', 'no', '0'))) {
1258 * Integer value of an argument
1260 * @param string $key query key we're interested in
1261 * @param string $defValue optional default value (default null)
1262 * @param string $maxValue optional max value (default null)
1263 * @param string $minValue optional min value (default null)
1265 * @return integer integer value
1267 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1269 $arg = strtolower($this->trimmed($key));
1271 if (is_null($arg) || !is_integer($arg)) {
1275 if (!is_null($maxValue)) {
1276 $arg = min($arg, $maxValue);
1279 if (!is_null($minValue)) {
1280 $arg = max($arg, $minValue);
1289 * @param string $msg error message to display
1290 * @param integer $code http error code, 500 by default
1294 function serverError($msg, $code=500)
1296 $action = $this->trimmed('action');
1297 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1298 throw new ServerException($msg, $code);
1304 * @param string $msg error message to display
1305 * @param integer $code http error code, 400 by default
1309 function clientError($msg, $code=400)
1311 $action = $this->trimmed('action');
1312 common_debug("User error '$code' on '$action': $msg", __FILE__);
1313 throw new ClientException($msg, $code);
1317 * Returns the current URL
1319 * @return string current URL
1323 list($action, $args) = $this->returnToArgs();
1324 return common_local_url($action, $args);
1328 * Returns arguments sufficient for re-constructing URL
1330 * @return array two elements: action, other args
1332 function returnToArgs()
1334 $action = $this->trimmed('action');
1335 $args = $this->args;
1336 unset($args['action']);
1337 if (common_config('site', 'fancy')) {
1340 if (array_key_exists('submit', $args)) {
1341 unset($args['submit']);
1343 foreach (array_keys($_COOKIE) as $cookie) {
1344 unset($args[$cookie]);
1346 return array($action, $args);
1350 * Generate a menu item
1352 * @param string $url menu URL
1353 * @param string $text menu name
1354 * @param string $title title attribute, null by default
1355 * @param boolean $is_selected current menu item, false by default
1356 * @param string $id element id, null by default
1360 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1362 // Added @id to li for some control.
1363 // XXX: We might want to move this to htmloutputter.php
1366 $lattrs['class'] = 'current';
1369 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1371 $this->elementStart('li', $lattrs);
1372 $attrs['href'] = $url;
1374 $attrs['title'] = $title;
1376 $this->element('a', $attrs, $text);
1377 $this->elementEnd('li');
1381 * Generate pagination links
1383 * @param boolean $have_before is there something before?
1384 * @param boolean $have_after is there something after?
1385 * @param integer $page current page
1386 * @param string $action current action
1387 * @param array $args rest of query arguments
1391 // XXX: The messages in this pagination method only tailor to navigating
1392 // notices. In other lists, "Previous"/"Next" type navigation is
1393 // desirable, but not available.
1394 function pagination($have_before, $have_after, $page, $action, $args=null)
1396 // Does a little before-after block for next/prev page
1397 if ($have_before || $have_after) {
1398 $this->elementStart('ul', array('class' => 'nav',
1399 'id' => 'pagination'));
1402 $pargs = array('page' => $page-1);
1403 $this->elementStart('li', array('class' => 'nav_prev'));
1404 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1406 // TRANS: Pagination message to go to a page displaying information more in the
1407 // TRANS: present than the currently displayed information.
1409 $this->elementEnd('li');
1412 $pargs = array('page' => $page+1);
1413 $this->elementStart('li', array('class' => 'nav_next'));
1414 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1416 // TRANS: Pagination message to go to a page displaying information more in the
1417 // TRANS: past than the currently displayed information.
1419 $this->elementEnd('li');
1421 if ($have_before || $have_after) {
1422 $this->elementEnd('ul');
1427 * An array of feeds for this action.
1429 * Returns an array of potential feeds for this action.
1431 * @return array Feed object to show in head and links
1439 * A design for this action
1441 * @return Design a design object to use
1443 function getDesign()
1445 return Design::siteDesign();
1449 * Check the session token.
1451 * Checks that the current form has the correct session token,
1452 * and throw an exception if it does not.
1456 // XXX: Finding this type of check with the same message about 50 times.
1457 // Possible to refactor?
1458 function checkSessionToken()
1461 $token = $this->trimmed('token');
1462 if (empty($token) || $token != common_session_token()) {
1463 // TRANS: Client error text when there is a problem with the session token.
1464 $this->clientError(_('There was a problem with your session token.'));
1469 * Check if the current request is a POST
1471 * @return boolean true if POST; otherwise false.
1476 return ($_SERVER['REQUEST_METHOD'] == 'POST');