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');
332 $this->inlineScript('var _peopletagAC = "' .
333 common_local_url('peopletagautocomplete') . '";');
334 $this->showScriptMessages();
335 // Frame-busting code to avoid clickjacking attacks.
336 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
337 Event::handle('EndShowStatusNetScripts', array($this));
338 Event::handle('EndShowLaconicaScripts', array($this));
340 Event::handle('EndShowScripts', array($this));
345 * Exports a map of localized text strings to JavaScript code.
347 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
348 * events and appending to the array. Try to avoid adding strings that won't be used, as
349 * they'll be added to HTML output.
351 function showScriptMessages()
355 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
356 // Common messages needed for timeline views etc...
358 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
359 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
361 // TRANS: Inline reply form submit button: submits a reply comment.
362 $messages['reply_submit'] = _m('BUTTON', 'Reply');
364 // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
365 $messages['reply_placeholder'] = _m('Write a reply...');
367 $messages = array_merge($messages, $this->getScriptMessages());
369 Event::handle('EndScriptMessages', array($this, &$messages));
372 if (!empty($messages)) {
373 $this->inlineScript('SN.messages=' . json_encode($messages));
380 * If the action will need localizable text strings, export them here like so:
382 * return array('pool_deepend' => _('Deep end'),
383 * 'pool_shallow' => _('Shallow end'));
385 * The exported map will be available via SN.msg() to JS code:
387 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
388 * $('#pool .deepend').text(SN.msg('pool_deepend'));
389 * $('#pool .shallow').text(SN.msg('pool_shallow'));
391 * Exports a map of localized text strings to JavaScript code.
393 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
394 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
395 * be used, as they'll be added to HTML output.
397 function getScriptMessages()
403 * Show OpenSearch headers
407 function showOpenSearch()
409 $this->element('link', array('rel' => 'search',
410 'type' => 'application/opensearchdescription+xml',
411 'href' => common_local_url('opensearch', array('type' => 'people')),
412 'title' => common_config('site', 'name').' People Search'));
413 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
414 'href' => common_local_url('opensearch', array('type' => 'notice')),
415 'title' => common_config('site', 'name').' Notice Search'));
427 $feeds = $this->getFeeds();
430 foreach ($feeds as $feed) {
431 $this->element('link', array('rel' => $feed->rel(),
432 'href' => $feed->url,
433 'type' => $feed->mimeType(),
434 'title' => $feed->title));
446 function showDescription()
448 // does nothing by default
452 * Show extra stuff in <head>.
460 // does nothing by default
466 * Calls template methods
472 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
473 'class' => 'user_in')
474 : array('id' => strtolower($this->trimmed('action'))));
475 $this->elementStart('div', array('id' => 'wrap'));
476 if (Event::handle('StartShowHeader', array($this))) {
479 Event::handle('EndShowHeader', array($this));
483 if (Event::handle('StartShowFooter', array($this))) {
486 Event::handle('EndShowFooter', array($this));
488 $this->elementEnd('div');
489 $this->showScripts();
490 $this->elementEnd('body');
494 * Show header of the page.
496 * Calls template methods
500 function showHeader()
502 $this->elementStart('div', array('id' => 'header'));
504 $this->showPrimaryNav();
505 if (Event::handle('StartShowSiteNotice', array($this))) {
506 $this->showSiteNotice();
508 Event::handle('EndShowSiteNotice', array($this));
511 $this->elementEnd('div');
515 * Show configured logo.
521 $this->elementStart('address', array('id' => 'site_contact',
522 'class' => 'vcard'));
523 if (Event::handle('StartAddressData', array($this))) {
524 if (common_config('singleuser', 'enabled')) {
525 $user = User::singleUser();
526 $url = common_local_url('showstream',
527 array('nickname' => $user->nickname));
528 } else if (common_logged_in()) {
529 $cur = common_current_user();
530 $url = common_local_url('all', array('nickname' => $cur->nickname));
532 $url = common_local_url('public');
535 $this->elementStart('a', array('class' => 'url home bookmark',
538 if (StatusNet::isHTTPS()) {
539 $logoUrl = common_config('site', 'ssllogo');
540 if (empty($logoUrl)) {
541 // if logo is an uploaded file, try to fall back to HTTPS file URL
542 $httpUrl = common_config('site', 'logo');
543 if (!empty($httpUrl)) {
544 $f = File::staticGet('url', $httpUrl);
545 if (!empty($f) && !empty($f->filename)) {
546 // this will handle the HTTPS case
547 $logoUrl = File::url($f->filename);
552 $logoUrl = common_config('site', 'logo');
555 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
556 // This should handle the HTTPS case internally
557 $logoUrl = Theme::path('logo.png');
560 if (!empty($logoUrl)) {
561 $this->element('img', array('class' => 'logo photo',
563 'alt' => common_config('site', 'name')));
567 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
568 $this->elementEnd('a');
570 Event::handle('EndAddressData', array($this));
572 $this->elementEnd('address');
576 * Show primary navigation.
580 function showPrimaryNav()
582 $this->elementStart('div', array('id' => 'site_nav_global_primary'));
583 $pn = new PrimaryNav($this);
585 $this->elementEnd('div');
593 function showSiteNotice()
595 // Revist. Should probably do an hAtom pattern here
596 $text = common_config('site', 'notice');
598 $this->elementStart('div', array('id' => 'site_notice',
599 'class' => 'system_notice'));
601 $this->elementEnd('div');
608 * MAY overload if no notice form needed... or direct message box????
612 function showNoticeForm()
614 // TRANS: Tab on the notice form.
615 $tabs = array('status' => _m('TAB','Status'));
617 $this->elementStart('div', 'input_forms');
619 if (Event::handle('StartShowEntryForms', array(&$tabs))) {
620 $this->elementStart('ul', array('class' => 'nav',
621 'id' => 'input_form_nav'));
623 foreach ($tabs as $tag => $title) {
624 $attrs = array('id' => 'input_form_nav_'.$tag,
625 'class' => 'input_form_nav_tab');
627 if ($tag == 'status') {
628 // We're actually showing the placeholder form,
629 // but we special-case the 'Status' tab as if
630 // it were a small version of it.
631 $attrs['class'] .= ' current';
633 $this->elementStart('li', $attrs);
636 array('href' => 'javascript:SN.U.switchInputFormTab("'.$tag.'")'),
638 $this->elementEnd('li');
641 $this->elementEnd('ul');
643 $attrs = array('class' => 'input_form current',
644 'id' => 'input_form_placeholder');
645 $this->elementStart('div', $attrs);
646 $form = new NoticePlaceholderForm($this);
648 $this->elementEnd('div');
650 foreach ($tabs as $tag => $title) {
651 $attrs = array('class' => 'input_form',
652 'id' => 'input_form_'.$tag);
654 $this->elementStart('div', $attrs);
658 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
659 if ($tag == 'status') {
660 $options = $this->noticeFormOptions();
661 $form = new NoticeForm($this, $options);
663 Event::handle('EndMakeEntryForm', array($tag, $this, $form));
670 $this->elementEnd('div');
674 $this->elementEnd('div');
677 function noticeFormOptions()
683 * Show anonymous message.
689 function showAnonymousMessage()
691 // needs to be defined by the class
697 * Shows local navigation, content block and aside.
703 $this->elementStart('div', array('id' => 'core'));
704 $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
705 $this->elementStart('div', array('id' => 'content_wrapper'));
706 $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
707 if (Event::handle('StartShowLocalNavBlock', array($this))) {
708 $this->showLocalNavBlock();
710 Event::handle('EndShowLocalNavBlock', array($this));
712 if (Event::handle('StartShowContentBlock', array($this))) {
713 $this->showContentBlock();
715 Event::handle('EndShowContentBlock', array($this));
717 if (Event::handle('StartShowAside', array($this))) {
720 Event::handle('EndShowAside', array($this));
722 $this->elementEnd('div');
723 $this->elementEnd('div');
724 $this->elementEnd('div');
725 $this->elementEnd('div');
729 * Show local navigation block.
733 function showLocalNavBlock()
735 // Need to have this ID for CSS; I'm too lazy to add it to
737 $this->elementStart('div', array('id' => 'site_nav_local_views'));
738 // Cheat cheat cheat!
739 $this->showLocalNav();
740 $this->elementEnd('div');
744 * If there's a logged-in user, show a bit of login context
748 function showProfileBlock()
750 if (common_logged_in()) {
751 $block = new DefaultProfileBlock($this);
757 * Show local navigation.
763 function showLocalNav()
765 $nav = new DefaultLocalNav($this);
770 * Show menu for an object (group, profile)
772 * This block will only show if a subclass has overridden
773 * the showObjectNav() method.
777 function showObjectNavBlock()
779 $rmethod = new ReflectionMethod($this, 'showObjectNav');
780 $dclass = $rmethod->getDeclaringClass()->getName();
782 if ($dclass != 'Action') {
783 // Need to have this ID for CSS; I'm too lazy to add it to
785 $this->elementStart('div', array('id' => 'site_nav_object',
786 'class' => 'section'));
787 $this->showObjectNav();
788 $this->elementEnd('div');
793 * Show object navigation.
795 * If there are things to do with this object, show it here.
799 function showObjectNav()
805 * Show content block.
809 function showContentBlock()
811 $this->elementStart('div', array('id' => 'content'));
812 if (common_logged_in()) {
813 if (Event::handle('StartShowNoticeForm', array($this))) {
814 $this->showNoticeForm();
815 Event::handle('EndShowNoticeForm', array($this));
818 if (Event::handle('StartShowPageTitle', array($this))) {
819 $this->showPageTitle();
820 Event::handle('EndShowPageTitle', array($this));
822 $this->showPageNoticeBlock();
823 $this->elementStart('div', array('id' => 'content_inner'));
824 // show the actual content (forms, lists, whatever)
825 $this->showContent();
826 $this->elementEnd('div');
827 $this->elementEnd('div');
835 function showPageTitle()
837 $this->element('h1', null, $this->title());
841 * Show page notice block.
843 * Only show the block if a subclassed action has overrided
844 * Action::showPageNotice(), or an event handler is registered for
845 * the StartShowPageNotice event, in which case we assume the
846 * 'page_notice' definition list is desired. This is to prevent
847 * empty 'page_notice' definition lists from being output everywhere.
851 function showPageNoticeBlock()
853 $rmethod = new ReflectionMethod($this, 'showPageNotice');
854 $dclass = $rmethod->getDeclaringClass()->getName();
856 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
858 $this->elementStart('div', array('id' => 'page_notice',
859 'class' => 'system_notice'));
860 if (Event::handle('StartShowPageNotice', array($this))) {
861 $this->showPageNotice();
862 Event::handle('EndShowPageNotice', array($this));
864 $this->elementEnd('div');
871 * SHOULD overload (unless there's not a notice)
875 function showPageNotice()
882 * MUST overload (unless there's not a notice)
886 function showContent()
897 $this->elementStart('div', array('id' => 'aside_primary',
898 'class' => 'aside'));
899 $this->showProfileBlock();
900 if (Event::handle('StartShowObjectNavBlock', array($this))) {
901 $this->showObjectNavBlock();
902 Event::handle('EndShowObjectNavBlock', array($this));
904 if (Event::handle('StartShowSections', array($this))) {
905 $this->showSections();
906 Event::handle('EndShowSections', array($this));
908 if (Event::handle('StartShowExportData', array($this))) {
909 $this->showExportData();
910 Event::handle('EndShowExportData', array($this));
912 $this->elementEnd('div');
916 * Show export data feeds.
920 function showExportData()
922 $feeds = $this->getFeeds();
924 $fl = new FeedList($this);
936 function showSections()
938 // for each section, show it
946 function showFooter()
948 $this->elementStart('div', array('id' => 'footer'));
949 if (Event::handle('StartShowInsideFooter', array($this))) {
950 $this->showSecondaryNav();
951 $this->showLicenses();
952 Event::handle('EndShowInsideFooter', array($this));
954 $this->elementEnd('div');
958 * Show secondary navigation.
962 function showSecondaryNav()
964 $sn = new SecondaryNav($this);
973 function showLicenses()
975 $this->showStatusNetLicense();
976 $this->showContentLicense();
980 * Show StatusNet license.
984 function showStatusNetLicense()
986 if (common_config('site', 'broughtby')) {
987 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
988 // TRANS: Text between [] is a link description, text between () is the link itself.
989 // TRANS: Make sure there is no whitespace between "]" and "(".
990 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
991 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
993 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
994 $instr = _('**%%site.name%%** is a microblogging service.');
997 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
998 // TRANS: Make sure there is no whitespace between "]" and "(".
999 // TRANS: Text between [] is a link description, text between () is the link itself.
1000 // TRANS: %s is the version of StatusNet that is being used.
1001 $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);
1002 $output = common_markup_to_html($instr);
1003 $this->raw($output);
1008 * Show content license.
1012 function showContentLicense()
1014 if (Event::handle('StartShowContentLicense', array($this))) {
1015 switch (common_config('license', 'type')) {
1017 // TRANS: Content license displayed when license is set to 'private'.
1018 // TRANS: %1$s is the site name.
1019 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
1020 common_config('site', 'name')));
1022 case 'allrightsreserved':
1023 if (common_config('license', 'owner')) {
1024 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
1025 // TRANS: %1$s is the copyright owner.
1026 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
1027 common_config('license', 'owner')));
1029 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
1030 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
1033 case 'cc': // fall through
1035 $this->elementStart('p');
1037 $image = common_config('license', 'image');
1038 $sslimage = common_config('license', 'sslimage');
1040 if (StatusNet::isHTTPS()) {
1041 if (!empty($sslimage)) {
1043 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1044 // CC support HTTPS on their images
1045 $url = preg_replace('/^http/', 'https', $image);
1047 // Better to show mixed content than no content
1054 $this->element('img', array('id' => 'license_cc',
1056 'alt' => common_config('license', 'title'),
1060 // TRANS: license message in footer.
1061 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1062 $notice = _('All %1$s content and data are available under the %2$s license.');
1063 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1064 htmlspecialchars(common_config('license', 'url')) .
1066 htmlspecialchars(common_config('license', 'title')) .
1068 $this->raw(sprintf(htmlspecialchars($notice),
1069 htmlspecialchars(common_config('site', 'name')),
1071 $this->elementEnd('p');
1075 Event::handle('EndShowContentLicense', array($this));
1080 * Return last modified, if applicable.
1084 * @return string last modified http header
1086 function lastModified()
1088 // For comparison with If-Last-Modified
1089 // If not applicable, return null
1094 * Return etag, if applicable.
1098 * @return string etag http header
1106 * Return true if read only.
1110 * @param array $args other arguments
1112 * @return boolean is read only action?
1114 function isReadOnly($args)
1120 * Returns query argument or default value if not found
1122 * @param string $key requested argument
1123 * @param string $def default value to return if $key is not provided
1125 * @return boolean is read only action?
1127 function arg($key, $def=null)
1129 if (array_key_exists($key, $this->args)) {
1130 return $this->args[$key];
1137 * Returns trimmed query argument or default value if not found
1139 * @param string $key requested argument
1140 * @param string $def default value to return if $key is not provided
1142 * @return boolean is read only action?
1144 function trimmed($key, $def=null)
1146 $arg = $this->arg($key, $def);
1147 return is_string($arg) ? trim($arg) : $arg;
1153 * @param array $argarray is ignored since it's now passed in in prepare()
1155 * @return boolean is read only action?
1157 function handle($argarray=null)
1159 header('Vary: Accept-Encoding,Cookie');
1161 $lm = $this->lastModified();
1162 $etag = $this->etag();
1165 header('ETag: ' . $etag);
1169 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1170 if ($this->isCacheable()) {
1171 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1172 header( "Cache-Control: private, must-revalidate, max-age=0" );
1179 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1180 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1181 if ($if_none_match) {
1182 // If this check fails, ignore the if-modified-since below.
1184 if ($this->_hasEtag($etag, $if_none_match)) {
1185 header('HTTP/1.1 304 Not Modified');
1186 // Better way to do this?
1192 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1193 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1194 $ims = strtotime($if_modified_since);
1196 header('HTTP/1.1 304 Not Modified');
1197 // Better way to do this?
1204 * Is this action cacheable?
1206 * If the action returns a last-modified
1208 * @param array $argarray is ignored since it's now passed in in prepare()
1210 * @return boolean is read only action?
1212 function isCacheable()
1218 * Has etag? (private)
1220 * @param string $etag etag http header
1221 * @param string $if_none_match ifNoneMatch http header
1225 function _hasEtag($etag, $if_none_match)
1227 $etags = explode(',', $if_none_match);
1228 return in_array($etag, $etags) || in_array('*', $etags);
1232 * Boolean understands english (yes, no, true, false)
1234 * @param string $key query key we're interested in
1235 * @param string $def default value
1237 * @return boolean interprets yes/no strings as boolean
1239 function boolean($key, $def=false)
1241 $arg = strtolower($this->trimmed($key));
1243 if (is_null($arg)) {
1245 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1247 } else if (in_array($arg, array('false', 'no', '0'))) {
1255 * Integer value of an argument
1257 * @param string $key query key we're interested in
1258 * @param string $defValue optional default value (default null)
1259 * @param string $maxValue optional max value (default null)
1260 * @param string $minValue optional min value (default null)
1262 * @return integer integer value
1264 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1266 $arg = strtolower($this->trimmed($key));
1268 if (is_null($arg) || !is_integer($arg)) {
1272 if (!is_null($maxValue)) {
1273 $arg = min($arg, $maxValue);
1276 if (!is_null($minValue)) {
1277 $arg = max($arg, $minValue);
1286 * @param string $msg error message to display
1287 * @param integer $code http error code, 500 by default
1291 function serverError($msg, $code=500)
1293 $action = $this->trimmed('action');
1294 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1295 throw new ServerException($msg, $code);
1301 * @param string $msg error message to display
1302 * @param integer $code http error code, 400 by default
1306 function clientError($msg, $code=400)
1308 $action = $this->trimmed('action');
1309 common_debug("User error '$code' on '$action': $msg", __FILE__);
1310 throw new ClientException($msg, $code);
1314 * Returns the current URL
1316 * @return string current URL
1320 list($action, $args) = $this->returnToArgs();
1321 return common_local_url($action, $args);
1325 * Returns arguments sufficient for re-constructing URL
1327 * @return array two elements: action, other args
1329 function returnToArgs()
1331 $action = $this->trimmed('action');
1332 $args = $this->args;
1333 unset($args['action']);
1334 if (common_config('site', 'fancy')) {
1337 if (array_key_exists('submit', $args)) {
1338 unset($args['submit']);
1340 foreach (array_keys($_COOKIE) as $cookie) {
1341 unset($args[$cookie]);
1343 return array($action, $args);
1347 * Generate a menu item
1349 * @param string $url menu URL
1350 * @param string $text menu name
1351 * @param string $title title attribute, null by default
1352 * @param boolean $is_selected current menu item, false by default
1353 * @param string $id element id, null by default
1357 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1359 // Added @id to li for some control.
1360 // XXX: We might want to move this to htmloutputter.php
1363 $lattrs['class'] = 'current';
1366 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1368 $this->elementStart('li', $lattrs);
1369 $attrs['href'] = $url;
1371 $attrs['title'] = $title;
1373 $this->element('a', $attrs, $text);
1374 $this->elementEnd('li');
1378 * Generate pagination links
1380 * @param boolean $have_before is there something before?
1381 * @param boolean $have_after is there something after?
1382 * @param integer $page current page
1383 * @param string $action current action
1384 * @param array $args rest of query arguments
1388 // XXX: The messages in this pagination method only tailor to navigating
1389 // notices. In other lists, "Previous"/"Next" type navigation is
1390 // desirable, but not available.
1391 function pagination($have_before, $have_after, $page, $action, $args=null)
1393 // Does a little before-after block for next/prev page
1394 if ($have_before || $have_after) {
1395 $this->elementStart('ul', array('class' => 'nav',
1396 'id' => 'pagination'));
1399 $pargs = array('page' => $page-1);
1400 $this->elementStart('li', array('class' => 'nav_prev'));
1401 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1403 // TRANS: Pagination message to go to a page displaying information more in the
1404 // TRANS: present than the currently displayed information.
1406 $this->elementEnd('li');
1409 $pargs = array('page' => $page+1);
1410 $this->elementStart('li', array('class' => 'nav_next'));
1411 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1413 // TRANS: Pagination message to go to a page displaying information more in the
1414 // TRANS: past than the currently displayed information.
1416 $this->elementEnd('li');
1418 if ($have_before || $have_after) {
1419 $this->elementEnd('ul');
1424 * An array of feeds for this action.
1426 * Returns an array of potential feeds for this action.
1428 * @return array Feed object to show in head and links
1436 * A design for this action
1438 * @return Design a design object to use
1440 function getDesign()
1442 return Design::siteDesign();
1446 * Check the session token.
1448 * Checks that the current form has the correct session token,
1449 * and throw an exception if it does not.
1453 // XXX: Finding this type of check with the same message about 50 times.
1454 // Possible to refactor?
1455 function checkSessionToken()
1458 $token = $this->trimmed('token');
1459 if (empty($token) || $token != common_session_token()) {
1460 // TRANS: Client error text when there is a problem with the session token.
1461 $this->clientError(_('There was a problem with your session token.'));
1466 * Check if the current request is a POST
1468 * @return boolean true if POST; otherwise false.
1473 return ($_SERVER['REQUEST_METHOD'] == 'POST');