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 Event::handle('EndShowStyles', array($this));
251 if (common_config('custom_css', 'enabled')) {
252 $css = common_config('custom_css', 'css');
253 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
254 if (trim($css) != '') {
257 Event::handle('EndShowCustomCss', array($this));
263 function primaryCssLink($mainTheme=null, $media=null)
265 $theme = new Theme($mainTheme);
267 // Some themes may have external stylesheets, such as using the
268 // Google Font APIs to load webfonts.
269 foreach ($theme->getExternals() as $url) {
270 $this->cssLink($url, $mainTheme, $media);
273 // If the currently-selected theme has dependencies on other themes,
274 // we'll need to load their display.css files as well in order.
275 $baseThemes = $theme->getDeps();
276 foreach ($baseThemes as $baseTheme) {
277 $this->cssLink('css/display.css', $baseTheme, $media);
279 $this->cssLink('css/display.css', $mainTheme, $media);
283 * Show javascript headers
287 function showScripts()
289 if (Event::handle('StartShowScripts', array($this))) {
290 if (Event::handle('StartShowJQueryScripts', array($this))) {
291 if (common_config('site', 'minify')) {
292 $this->script('jquery.min.js');
293 $this->script('jquery.form.min.js');
294 $this->script('jquery-ui.min.js');
295 $this->script('jquery.cookie.min.js');
296 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.min.js').'"); }');
297 $this->script('jquery.joverlay.min.js');
298 $this->script('jquery.infieldlabel.min.js');
300 $this->script('jquery.js');
301 $this->script('jquery.form.js');
302 $this->script('jquery-ui.min.js');
303 $this->script('jquery.cookie.js');
304 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.js').'"); }');
305 $this->script('jquery.joverlay.js');
306 $this->script('jquery.infieldlabel.js');
309 Event::handle('EndShowJQueryScripts', array($this));
311 if (Event::handle('StartShowStatusNetScripts', array($this)) &&
312 Event::handle('StartShowLaconicaScripts', array($this))) {
313 if (common_config('site', 'minify')) {
314 $this->script('util.min.js');
316 $this->script('util.js');
317 $this->script('xbImportNode.js');
318 $this->script('geometa.js');
320 $this->inlineScript('var _peopletagAC = "' .
321 common_local_url('peopletagautocomplete') . '";');
322 $this->showScriptMessages();
323 // Anti-framing code to avoid clickjacking attacks in older browsers.
324 // This will show a blank page if the page is being framed, which is
325 // consistent with the behavior of the 'X-Frame-Options: SAMEORIGIN'
326 // header, which prevents framing in newer browser.
327 if (common_config('javascript', 'bustframes')) {
328 $this->inlineScript('if (window.top !== window.self) { document.write = ""; window.top.location = window.self.location; setTimeout(function () { document.body.innerHTML = ""; }, 1); window.self.onload = function () { document.body.innerHTML = ""; }; }');
330 Event::handle('EndShowStatusNetScripts', array($this));
331 Event::handle('EndShowLaconicaScripts', array($this));
333 Event::handle('EndShowScripts', array($this));
338 * Exports a map of localized text strings to JavaScript code.
340 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
341 * events and appending to the array. Try to avoid adding strings that won't be used, as
342 * they'll be added to HTML output.
344 function showScriptMessages()
348 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
349 // Common messages needed for timeline views etc...
351 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
352 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
354 // TRANS: Inline reply form submit button: submits a reply comment.
355 $messages['reply_submit'] = _m('BUTTON', 'Reply');
357 // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
358 $messages['reply_placeholder'] = _m('Write a reply...');
360 $messages = array_merge($messages, $this->getScriptMessages());
362 Event::handle('EndScriptMessages', array($this, &$messages));
365 if (!empty($messages)) {
366 $this->inlineScript('SN.messages=' . json_encode($messages));
373 * If the action will need localizable text strings, export them here like so:
375 * return array('pool_deepend' => _('Deep end'),
376 * 'pool_shallow' => _('Shallow end'));
378 * The exported map will be available via SN.msg() to JS code:
380 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
381 * $('#pool .deepend').text(SN.msg('pool_deepend'));
382 * $('#pool .shallow').text(SN.msg('pool_shallow'));
384 * Exports a map of localized text strings to JavaScript code.
386 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
387 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
388 * be used, as they'll be added to HTML output.
390 function getScriptMessages()
396 * Show OpenSearch headers
400 function showOpenSearch()
402 $this->element('link', array('rel' => 'search',
403 'type' => 'application/opensearchdescription+xml',
404 'href' => common_local_url('opensearch', array('type' => 'people')),
405 'title' => common_config('site', 'name').' People Search'));
406 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
407 'href' => common_local_url('opensearch', array('type' => 'notice')),
408 'title' => common_config('site', 'name').' Notice Search'));
420 $feeds = $this->getFeeds();
423 foreach ($feeds as $feed) {
424 $this->element('link', array('rel' => $feed->rel(),
425 'href' => $feed->url,
426 'type' => $feed->mimeType(),
427 'title' => $feed->title));
439 function showDescription()
441 // does nothing by default
445 * Show extra stuff in <head>.
453 // does nothing by default
459 * Calls template methods
465 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
466 'class' => 'user_in')
467 : array('id' => strtolower($this->trimmed('action'))));
468 $this->elementStart('div', array('id' => 'wrap'));
469 if (Event::handle('StartShowHeader', array($this))) {
472 Event::handle('EndShowHeader', array($this));
476 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 // TRANS: Tab on the notice form.
608 $tabs = array('status' => _m('TAB','Status'));
610 $this->elementStart('div', 'input_forms');
612 if (Event::handle('StartShowEntryForms', array(&$tabs))) {
613 $this->elementStart('ul', array('class' => 'nav',
614 'id' => 'input_form_nav'));
616 foreach ($tabs as $tag => $title) {
617 $attrs = array('id' => 'input_form_nav_'.$tag,
618 'class' => 'input_form_nav_tab');
620 if ($tag == 'status') {
621 // We're actually showing the placeholder form,
622 // but we special-case the 'Status' tab as if
623 // it were a small version of it.
624 $attrs['class'] .= ' current';
626 $this->elementStart('li', $attrs);
629 array('href' => 'javascript:SN.U.switchInputFormTab("'.$tag.'")'),
631 $this->elementEnd('li');
634 $this->elementEnd('ul');
636 $attrs = array('class' => 'input_form current',
637 'id' => 'input_form_placeholder');
638 $this->elementStart('div', $attrs);
639 $form = new NoticePlaceholderForm($this);
641 $this->elementEnd('div');
643 foreach ($tabs as $tag => $title) {
644 $attrs = array('class' => 'input_form',
645 'id' => 'input_form_'.$tag);
647 $this->elementStart('div', $attrs);
651 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
652 if ($tag == 'status') {
653 $options = $this->noticeFormOptions();
654 $form = new NoticeForm($this, $options);
656 Event::handle('EndMakeEntryForm', array($tag, $this, $form));
663 $this->elementEnd('div');
667 $this->elementEnd('div');
670 function noticeFormOptions()
676 * Show anonymous message.
682 function showAnonymousMessage()
684 // needs to be defined by the class
690 * Shows local navigation, content block and aside.
696 $this->elementStart('div', array('id' => 'core'));
697 $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
698 $this->elementStart('div', array('id' => 'content_wrapper'));
699 $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
700 if (Event::handle('StartShowLocalNavBlock', array($this))) {
701 $this->showLocalNavBlock();
703 Event::handle('EndShowLocalNavBlock', array($this));
705 if (Event::handle('StartShowContentBlock', array($this))) {
706 $this->showContentBlock();
708 Event::handle('EndShowContentBlock', array($this));
710 if (Event::handle('StartShowAside', array($this))) {
713 Event::handle('EndShowAside', array($this));
715 $this->elementEnd('div');
716 $this->elementEnd('div');
717 $this->elementEnd('div');
718 $this->elementEnd('div');
722 * Show local navigation block.
726 function showLocalNavBlock()
728 // Need to have this ID for CSS; I'm too lazy to add it to
730 $this->elementStart('div', array('id' => 'site_nav_local_views'));
731 // Cheat cheat cheat!
732 $this->showLocalNav();
733 $this->elementEnd('div');
737 * If there's a logged-in user, show a bit of login context
741 function showProfileBlock()
743 if (common_logged_in()) {
744 $block = new DefaultProfileBlock($this);
750 * Show local navigation.
756 function showLocalNav()
758 $nav = new DefaultLocalNav($this);
763 * Show menu for an object (group, profile)
765 * This block will only show if a subclass has overridden
766 * the showObjectNav() method.
770 function showObjectNavBlock()
772 $rmethod = new ReflectionMethod($this, 'showObjectNav');
773 $dclass = $rmethod->getDeclaringClass()->getName();
775 if ($dclass != 'Action') {
776 // Need to have this ID for CSS; I'm too lazy to add it to
778 $this->elementStart('div', array('id' => 'site_nav_object',
779 'class' => 'section'));
780 $this->showObjectNav();
781 $this->elementEnd('div');
786 * Show object navigation.
788 * If there are things to do with this object, show it here.
792 function showObjectNav()
798 * Show content block.
802 function showContentBlock()
804 $this->elementStart('div', array('id' => 'content'));
805 if (common_logged_in()) {
806 if (Event::handle('StartShowNoticeForm', array($this))) {
807 $this->showNoticeForm();
808 Event::handle('EndShowNoticeForm', array($this));
811 if (Event::handle('StartShowPageTitle', array($this))) {
812 $this->showPageTitle();
813 Event::handle('EndShowPageTitle', array($this));
815 $this->showPageNoticeBlock();
816 $this->elementStart('div', array('id' => 'content_inner'));
817 // show the actual content (forms, lists, whatever)
818 $this->showContent();
819 $this->elementEnd('div');
820 $this->elementEnd('div');
828 function showPageTitle()
830 $this->element('h1', null, $this->title());
834 * Show page notice block.
836 * Only show the block if a subclassed action has overrided
837 * Action::showPageNotice(), or an event handler is registered for
838 * the StartShowPageNotice event, in which case we assume the
839 * 'page_notice' definition list is desired. This is to prevent
840 * empty 'page_notice' definition lists from being output everywhere.
844 function showPageNoticeBlock()
846 $rmethod = new ReflectionMethod($this, 'showPageNotice');
847 $dclass = $rmethod->getDeclaringClass()->getName();
849 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
851 $this->elementStart('div', array('id' => 'page_notice',
852 'class' => 'system_notice'));
853 if (Event::handle('StartShowPageNotice', array($this))) {
854 $this->showPageNotice();
855 Event::handle('EndShowPageNotice', array($this));
857 $this->elementEnd('div');
864 * SHOULD overload (unless there's not a notice)
868 function showPageNotice()
875 * MUST overload (unless there's not a notice)
879 function showContent()
890 $this->elementStart('div', array('id' => 'aside_primary',
891 'class' => 'aside'));
892 $this->showProfileBlock();
893 if (Event::handle('StartShowObjectNavBlock', array($this))) {
894 $this->showObjectNavBlock();
895 Event::handle('EndShowObjectNavBlock', array($this));
897 if (Event::handle('StartShowSections', array($this))) {
898 $this->showSections();
899 Event::handle('EndShowSections', array($this));
901 if (Event::handle('StartShowExportData', array($this))) {
902 $this->showExportData();
903 Event::handle('EndShowExportData', array($this));
905 $this->elementEnd('div');
909 * Show export data feeds.
913 function showExportData()
915 $feeds = $this->getFeeds();
917 $fl = new FeedList($this);
929 function showSections()
931 // for each section, show it
939 function showFooter()
941 $this->elementStart('div', array('id' => 'footer'));
942 if (Event::handle('StartShowInsideFooter', array($this))) {
943 $this->showSecondaryNav();
944 $this->showLicenses();
945 Event::handle('EndShowInsideFooter', array($this));
947 $this->elementEnd('div');
951 * Show secondary navigation.
955 function showSecondaryNav()
957 $sn = new SecondaryNav($this);
966 function showLicenses()
968 $this->showStatusNetLicense();
969 $this->showContentLicense();
973 * Show StatusNet license.
977 function showStatusNetLicense()
979 if (common_config('site', 'broughtby')) {
980 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
981 // TRANS: Text between [] is a link description, text between () is the link itself.
982 // TRANS: Make sure there is no whitespace between "]" and "(".
983 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
984 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
986 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
987 $instr = _('**%%site.name%%** is a microblogging service.');
990 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
991 // TRANS: Make sure there is no whitespace between "]" and "(".
992 // TRANS: Text between [] is a link description, text between () is the link itself.
993 // TRANS: %s is the version of StatusNet that is being used.
994 $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);
995 $output = common_markup_to_html($instr);
1001 * Show content license.
1005 function showContentLicense()
1007 if (Event::handle('StartShowContentLicense', array($this))) {
1008 switch (common_config('license', 'type')) {
1010 // TRANS: Content license displayed when license is set to 'private'.
1011 // TRANS: %1$s is the site name.
1012 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
1013 common_config('site', 'name')));
1015 case 'allrightsreserved':
1016 if (common_config('license', 'owner')) {
1017 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
1018 // TRANS: %1$s is the copyright owner.
1019 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
1020 common_config('license', 'owner')));
1022 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
1023 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
1026 case 'cc': // fall through
1028 $this->elementStart('p');
1030 $image = common_config('license', 'image');
1031 $sslimage = common_config('license', 'sslimage');
1033 if (StatusNet::isHTTPS()) {
1034 if (!empty($sslimage)) {
1036 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1037 // CC support HTTPS on their images
1038 $url = preg_replace('/^http/', 'https', $image);
1040 // Better to show mixed content than no content
1047 $this->element('img', array('id' => 'license_cc',
1049 'alt' => common_config('license', 'title'),
1053 // TRANS: license message in footer.
1054 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1055 $notice = _('All %1$s content and data are available under the %2$s license.');
1056 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1057 htmlspecialchars(common_config('license', 'url')) .
1059 htmlspecialchars(common_config('license', 'title')) .
1061 $this->raw(sprintf(htmlspecialchars($notice),
1062 htmlspecialchars(common_config('site', 'name')),
1064 $this->elementEnd('p');
1068 Event::handle('EndShowContentLicense', array($this));
1073 * Return last modified, if applicable.
1077 * @return string last modified http header
1079 function lastModified()
1081 // For comparison with If-Last-Modified
1082 // If not applicable, return null
1087 * Return etag, if applicable.
1091 * @return string etag http header
1099 * Return true if read only.
1103 * @param array $args other arguments
1105 * @return boolean is read only action?
1107 function isReadOnly($args)
1113 * Returns query argument or default value if not found
1115 * @param string $key requested argument
1116 * @param string $def default value to return if $key is not provided
1118 * @return boolean is read only action?
1120 function arg($key, $def=null)
1122 if (array_key_exists($key, $this->args)) {
1123 return $this->args[$key];
1130 * Returns trimmed query argument or default value if not found
1132 * @param string $key requested argument
1133 * @param string $def default value to return if $key is not provided
1135 * @return boolean is read only action?
1137 function trimmed($key, $def=null)
1139 $arg = $this->arg($key, $def);
1140 return is_string($arg) ? trim($arg) : $arg;
1146 * @param array $argarray is ignored since it's now passed in in prepare()
1148 * @return boolean is read only action?
1150 function handle($argarray=null)
1152 header('Vary: Accept-Encoding,Cookie');
1154 $lm = $this->lastModified();
1155 $etag = $this->etag();
1158 header('ETag: ' . $etag);
1162 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1163 if ($this->isCacheable()) {
1164 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1165 header( "Cache-Control: private, must-revalidate, max-age=0" );
1172 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1173 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1174 if ($if_none_match) {
1175 // If this check fails, ignore the if-modified-since below.
1177 if ($this->_hasEtag($etag, $if_none_match)) {
1178 header('HTTP/1.1 304 Not Modified');
1179 // Better way to do this?
1185 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1186 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1187 $ims = strtotime($if_modified_since);
1189 header('HTTP/1.1 304 Not Modified');
1190 // Better way to do this?
1197 * Is this action cacheable?
1199 * If the action returns a last-modified
1201 * @param array $argarray is ignored since it's now passed in in prepare()
1203 * @return boolean is read only action?
1205 function isCacheable()
1211 * Has etag? (private)
1213 * @param string $etag etag http header
1214 * @param string $if_none_match ifNoneMatch http header
1218 function _hasEtag($etag, $if_none_match)
1220 $etags = explode(',', $if_none_match);
1221 return in_array($etag, $etags) || in_array('*', $etags);
1225 * Boolean understands english (yes, no, true, false)
1227 * @param string $key query key we're interested in
1228 * @param string $def default value
1230 * @return boolean interprets yes/no strings as boolean
1232 function boolean($key, $def=false)
1234 $arg = strtolower($this->trimmed($key));
1236 if (is_null($arg)) {
1238 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1240 } else if (in_array($arg, array('false', 'no', '0'))) {
1248 * Integer value of an argument
1250 * @param string $key query key we're interested in
1251 * @param string $defValue optional default value (default null)
1252 * @param string $maxValue optional max value (default null)
1253 * @param string $minValue optional min value (default null)
1255 * @return integer integer value
1257 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1259 $arg = strtolower($this->trimmed($key));
1261 if (is_null($arg) || !is_integer($arg)) {
1265 if (!is_null($maxValue)) {
1266 $arg = min($arg, $maxValue);
1269 if (!is_null($minValue)) {
1270 $arg = max($arg, $minValue);
1279 * @param string $msg error message to display
1280 * @param integer $code http error code, 500 by default
1284 function serverError($msg, $code=500)
1286 $action = $this->trimmed('action');
1287 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1288 throw new ServerException($msg, $code);
1294 * @param string $msg error message to display
1295 * @param integer $code http error code, 400 by default
1299 function clientError($msg, $code=400)
1301 $action = $this->trimmed('action');
1302 common_debug("User error '$code' on '$action': $msg", __FILE__);
1303 throw new ClientException($msg, $code);
1307 * Returns the current URL
1309 * @return string current URL
1313 list($action, $args) = $this->returnToArgs();
1314 return common_local_url($action, $args);
1318 * Returns arguments sufficient for re-constructing URL
1320 * @return array two elements: action, other args
1322 function returnToArgs()
1324 $action = $this->trimmed('action');
1325 $args = $this->args;
1326 unset($args['action']);
1327 if (common_config('site', 'fancy')) {
1330 if (array_key_exists('submit', $args)) {
1331 unset($args['submit']);
1333 foreach (array_keys($_COOKIE) as $cookie) {
1334 unset($args[$cookie]);
1336 return array($action, $args);
1340 * Generate a menu item
1342 * @param string $url menu URL
1343 * @param string $text menu name
1344 * @param string $title title attribute, null by default
1345 * @param boolean $is_selected current menu item, false by default
1346 * @param string $id element id, null by default
1350 function menuItem($url, $text, $title=null, $is_selected=false, $id=null, $class=null)
1352 // Added @id to li for some control.
1353 // XXX: We might want to move this to htmloutputter.php
1356 if ($class !== null) {
1357 $classes[] = trim($class);
1360 $classes[] = 'current';
1363 $lattrs['class'] = implode(' ', $classes);
1365 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1367 $this->elementStart('li', $lattrs);
1368 $attrs['href'] = $url;
1370 $attrs['title'] = $title;
1372 $this->element('a', $attrs, $text);
1373 $this->elementEnd('li');
1377 * Generate pagination links
1379 * @param boolean $have_before is there something before?
1380 * @param boolean $have_after is there something after?
1381 * @param integer $page current page
1382 * @param string $action current action
1383 * @param array $args rest of query arguments
1387 // XXX: The messages in this pagination method only tailor to navigating
1388 // notices. In other lists, "Previous"/"Next" type navigation is
1389 // desirable, but not available.
1390 function pagination($have_before, $have_after, $page, $action, $args=null)
1392 // Does a little before-after block for next/prev page
1393 if ($have_before || $have_after) {
1394 $this->elementStart('ul', array('class' => 'nav',
1395 'id' => 'pagination'));
1398 $pargs = array('page' => $page-1);
1399 $this->elementStart('li', array('class' => 'nav_prev'));
1400 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1402 // TRANS: Pagination message to go to a page displaying information more in the
1403 // TRANS: present than the currently displayed information.
1405 $this->elementEnd('li');
1408 $pargs = array('page' => $page+1);
1409 $this->elementStart('li', array('class' => 'nav_next'));
1410 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1412 // TRANS: Pagination message to go to a page displaying information more in the
1413 // TRANS: past than the currently displayed information.
1415 $this->elementEnd('li');
1417 if ($have_before || $have_after) {
1418 $this->elementEnd('ul');
1423 * An array of feeds for this action.
1425 * Returns an array of potential feeds for this action.
1427 * @return array Feed object to show in head and links
1435 * Check the session token.
1437 * Checks that the current form has the correct session token,
1438 * and throw an exception if it does not.
1442 // XXX: Finding this type of check with the same message about 50 times.
1443 // Possible to refactor?
1444 function checkSessionToken()
1447 $token = $this->trimmed('token');
1448 if (empty($token) || $token != common_session_token()) {
1449 // TRANS: Client error text when there is a problem with the session token.
1450 $this->clientError(_('There was a problem with your session token.'));
1455 * Check if the current request is a POST
1457 * @return boolean true if POST; otherwise false.
1462 return ($_SERVER['REQUEST_METHOD'] == 'POST');