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);
90 * Show page, a template method.
96 if (Event::handle('StartShowHTML', array($this))) {
98 Event::handle('EndShowHTML', array($this));
100 if (Event::handle('StartShowHead', array($this))) {
102 Event::handle('EndShowHead', array($this));
104 if (Event::handle('StartShowBody', array($this))) {
106 Event::handle('EndShowBody', array($this));
108 if (Event::handle('StartEndHTML', array($this))) {
110 Event::handle('EndEndHTML', array($this));
118 if (isset($_startTime)) {
119 $endTime = microtime(true);
120 $diff = round(($endTime - $_startTime) * 1000);
121 $this->raw("<!-- ${diff}ms -->");
124 return parent::endHTML();
128 * Show head, a template method.
134 // XXX: attributes (profile?)
135 $this->elementStart('head');
136 if (Event::handle('StartShowHeadElements', array($this))) {
137 if (Event::handle('StartShowHeadTitle', array($this))) {
139 Event::handle('EndShowHeadTitle', array($this));
141 $this->showShortcutIcon();
142 $this->showStylesheets();
143 $this->showOpenSearch();
145 $this->showDescription();
147 Event::handle('EndShowHeadElements', array($this));
149 $this->elementEnd('head');
153 * Show title, a template method.
159 $this->element('title', null,
160 // TRANS: Page title. %1$s is the title, %2$s is the site name.
161 sprintf(_("%1\$s - %2\$s"),
163 common_config('site', 'name')));
167 * Returns the page title
171 * @return string page title
176 // TRANS: Page title for a page without a title set.
177 return _("Untitled page");
181 * Show themed shortcut icon
185 function showShortcutIcon()
187 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
188 $this->element('link', array('rel' => 'shortcut icon',
189 'href' => Theme::path('favicon.ico')));
191 // favicon.ico should be HTTPS if the rest of the page is
192 $this->element('link', array('rel' => 'shortcut icon',
193 'href' => common_path('favicon.ico', StatusNet::isHTTPS())));
196 if (common_config('site', 'mobile')) {
197 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
198 $this->element('link', array('rel' => 'apple-touch-icon',
199 'href' => Theme::path('apple-touch-icon.png')));
201 $this->element('link', array('rel' => 'apple-touch-icon',
202 'href' => common_path('apple-touch-icon.png')));
212 function showStylesheets()
214 if (Event::handle('StartShowStyles', array($this))) {
216 // Use old name for StatusNet for compatibility on events
218 if (Event::handle('StartShowStatusNetStyles', array($this)) &&
219 Event::handle('StartShowLaconicaStyles', array($this))) {
220 $this->primaryCssLink(null, 'screen, projection, tv, print');
221 Event::handle('EndShowStatusNetStyles', array($this));
222 Event::handle('EndShowLaconicaStyles', array($this));
225 $this->cssLink(common_path('js/css/smoothness/jquery-ui.css'));
227 if (Event::handle('StartShowUAStyles', array($this))) {
228 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
229 'href="'.Theme::path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
230 foreach (array(6,7) as $ver) {
231 if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
232 // Yes, IE people should be put in jail.
233 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
234 'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
237 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
238 'href="'.Theme::path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
239 Event::handle('EndShowUAStyles', array($this));
242 if (Event::handle('StartShowDesign', array($this))) {
244 $user = common_current_user();
246 if (empty($user) || $user->viewdesigns) {
247 $design = $this->getDesign();
249 if (!empty($design)) {
250 $design->showCSS($this);
254 Event::handle('EndShowDesign', array($this));
256 Event::handle('EndShowStyles', array($this));
258 if (common_config('custom_css', 'enabled')) {
259 $css = common_config('custom_css', 'css');
260 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
261 if (trim($css) != '') {
264 Event::handle('EndShowCustomCss', array($this));
270 function primaryCssLink($mainTheme=null, $media=null)
272 $theme = new Theme($mainTheme);
274 // Some themes may have external stylesheets, such as using the
275 // Google Font APIs to load webfonts.
276 foreach ($theme->getExternals() as $url) {
277 $this->cssLink($url, $mainTheme, $media);
280 // If the currently-selected theme has dependencies on other themes,
281 // we'll need to load their display.css files as well in order.
282 $baseThemes = $theme->getDeps();
283 foreach ($baseThemes as $baseTheme) {
284 $this->cssLink('css/display.css', $baseTheme, $media);
286 $this->cssLink('css/display.css', $mainTheme, $media);
290 * Show javascript headers
294 function showScripts()
296 if (Event::handle('StartShowScripts', array($this))) {
297 if (Event::handle('StartShowJQueryScripts', array($this))) {
298 if (common_config('site', 'minify')) {
299 $this->script('jquery.min.js');
300 $this->script('jquery.form.min.js');
301 $this->script('jquery-ui.min.js');
302 $this->script('jquery.cookie.min.js');
303 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.min.js').'"); }');
304 $this->script('jquery.joverlay.min.js');
306 $this->script('jquery.js');
307 $this->script('jquery.form.js');
308 $this->script('jquery-ui.min.js');
309 $this->script('jquery.cookie.js');
310 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.js').'"); }');
311 $this->script('jquery.joverlay.js');
313 Event::handle('EndShowJQueryScripts', array($this));
315 if (Event::handle('StartShowStatusNetScripts', array($this)) &&
316 Event::handle('StartShowLaconicaScripts', array($this))) {
317 if (common_config('site', 'minify')) {
318 $this->script('util.min.js');
320 $this->script('util.js');
321 $this->script('xbImportNode.js');
322 $this->script('geometa.js');
324 $this->showScriptMessages();
325 // Frame-busting code to avoid clickjacking attacks.
326 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
327 Event::handle('EndShowStatusNetScripts', array($this));
328 Event::handle('EndShowLaconicaScripts', array($this));
330 Event::handle('EndShowScripts', array($this));
335 * Exports a map of localized text strings to JavaScript code.
337 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
338 * events and appending to the array. Try to avoid adding strings that won't be used, as
339 * they'll be added to HTML output.
342 function showScriptMessages()
346 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
347 // Common messages needed for timeline views etc...
349 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
350 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
352 // TRANS: Inline reply form submit button: submits a reply comment.
353 $messages['reply_submit'] = _m('BUTTON', 'Reply');
355 // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
356 $messages['reply_placeholder'] = _m('Write a reply...');
358 $messages = array_merge($messages, $this->getScriptMessages());
360 Event::handle('EndScriptMessages', array($this, &$messages));
363 if (!empty($messages)) {
364 $this->inlineScript('SN.messages=' . json_encode($messages));
371 * If the action will need localizable text strings, export them here like so:
373 * return array('pool_deepend' => _('Deep end'),
374 * 'pool_shallow' => _('Shallow end'));
376 * The exported map will be available via SN.msg() to JS code:
378 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
379 * $('#pool .deepend').text(SN.msg('pool_deepend'));
380 * $('#pool .shallow').text(SN.msg('pool_shallow'));
382 * Exports a map of localized text strings to JavaScript code.
384 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
385 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
386 * be used, as they'll be added to HTML output.
388 function getScriptMessages()
394 * Show OpenSearch headers
398 function showOpenSearch()
400 $this->element('link', array('rel' => 'search',
401 'type' => 'application/opensearchdescription+xml',
402 'href' => common_local_url('opensearch', array('type' => 'people')),
403 'title' => common_config('site', 'name').' People Search'));
404 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
405 'href' => common_local_url('opensearch', array('type' => 'notice')),
406 'title' => common_config('site', 'name').' Notice Search'));
418 $feeds = $this->getFeeds();
421 foreach ($feeds as $feed) {
422 $this->element('link', array('rel' => $feed->rel(),
423 'href' => $feed->url,
424 'type' => $feed->mimeType(),
425 'title' => $feed->title));
437 function showDescription()
439 // does nothing by default
443 * Show extra stuff in <head>.
451 // does nothing by default
457 * Calls template methods
463 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
464 'class' => 'user_in')
465 : array('id' => strtolower($this->trimmed('action'))));
466 $this->elementStart('div', array('id' => 'wrap'));
467 if (Event::handle('StartShowHeader', array($this))) {
469 Event::handle('EndShowHeader', array($this));
472 if (Event::handle('StartShowFooter', array($this))) {
474 Event::handle('EndShowFooter', array($this));
476 $this->elementEnd('div');
477 $this->showScripts();
478 $this->elementEnd('body');
482 * Show header of the page.
484 * Calls template methods
488 function showHeader()
490 $this->elementStart('div', array('id' => 'header'));
492 $this->showPrimaryNav();
493 if (Event::handle('StartShowSiteNotice', array($this))) {
494 $this->showSiteNotice();
496 Event::handle('EndShowSiteNotice', array($this));
499 $this->elementEnd('div');
503 * Show configured logo.
509 $this->elementStart('address', array('id' => 'site_contact',
510 'class' => 'vcard'));
511 if (Event::handle('StartAddressData', array($this))) {
512 if (common_config('singleuser', 'enabled')) {
513 $user = User::singleUser();
514 $url = common_local_url('showstream',
515 array('nickname' => $user->nickname));
516 } else if (common_logged_in()) {
517 $cur = common_current_user();
518 $url = common_local_url('all', array('nickname' => $cur->nickname));
520 $url = common_local_url('public');
523 $this->elementStart('a', array('class' => 'url home bookmark',
526 if (StatusNet::isHTTPS()) {
527 $logoUrl = common_config('site', 'ssllogo');
528 if (empty($logoUrl)) {
529 // if logo is an uploaded file, try to fall back to HTTPS file URL
530 $httpUrl = common_config('site', 'logo');
531 if (!empty($httpUrl)) {
532 $f = File::staticGet('url', $httpUrl);
533 if (!empty($f) && !empty($f->filename)) {
534 // this will handle the HTTPS case
535 $logoUrl = File::url($f->filename);
540 $logoUrl = common_config('site', 'logo');
543 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
544 // This should handle the HTTPS case internally
545 $logoUrl = Theme::path('logo.png');
548 if (!empty($logoUrl)) {
549 $this->element('img', array('class' => 'logo photo',
551 'alt' => common_config('site', 'name')));
555 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
556 $this->elementEnd('a');
558 Event::handle('EndAddressData', array($this));
560 $this->elementEnd('address');
564 * Show primary navigation.
568 function showPrimaryNav()
570 $this->elementStart('div', array('id' => 'site_nav_global_primary'));
571 $pn = new PrimaryNav($this);
573 $this->elementEnd('div');
581 function showSiteNotice()
583 // Revist. Should probably do an hAtom pattern here
584 $text = common_config('site', 'notice');
586 $this->elementStart('div', array('id' => 'site_notice',
587 'class' => 'system_notice'));
589 $this->elementEnd('div');
596 * MAY overload if no notice form needed... or direct message box????
600 function showNoticeForm()
602 $tabs = array('status' => _('Status'));
604 $this->elementStart('div', 'input_forms');
606 if (Event::handle('StartShowEntryForms', array(&$tabs))) {
608 $this->elementStart('ul', array('class' => 'nav',
609 'id' => 'input_form_nav'));
611 foreach ($tabs as $tag => $title) {
613 $attrs = array('id' => 'input_form_nav_'.$tag,
614 'class' => 'input_form_nav_tab');
616 if ($tag == 'status') {
617 // We're actually showing the placeholder form,
618 // but we special-case the 'Status' tab as if
619 // it were a small version of it.
620 $attrs['class'] .= ' current';
622 $this->elementStart('li', $attrs);
625 array('href' => 'javascript:SN.U.switchInputFormTab("'.$tag.'")'),
627 $this->elementEnd('li');
630 $this->elementEnd('ul');
632 $attrs = array('class' => 'input_form current',
633 'id' => 'input_form_placeholder');
634 $this->elementStart('div', $attrs);
635 $form = new NoticePlaceholderForm($this);
637 $this->elementEnd('div');
639 foreach ($tabs as $tag => $title) {
641 $attrs = array('class' => 'input_form',
642 'id' => 'input_form_'.$tag);
644 $this->elementStart('div', $attrs);
648 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
649 if ($tag == 'status') {
650 $form = new NoticeForm($this);
652 Event::handle('EndMakeEntryForm', array($tag, $this, $form));
659 $this->elementEnd('div');
663 $this->elementEnd('div');
667 * Show anonymous message.
673 function showAnonymousMessage()
675 // needs to be defined by the class
681 * Shows local navigation, content block and aside.
687 $this->elementStart('div', array('id' => 'core'));
688 $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
689 $this->elementStart('div', array('id' => 'content_wrapper'));
690 $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
691 if (Event::handle('StartShowLocalNavBlock', array($this))) {
692 $this->showLocalNavBlock();
693 Event::handle('EndShowLocalNavBlock', array($this));
695 if (Event::handle('StartShowContentBlock', array($this))) {
696 $this->showContentBlock();
697 Event::handle('EndShowContentBlock', array($this));
699 if (Event::handle('StartShowAside', array($this))) {
701 Event::handle('EndShowAside', array($this));
703 $this->elementEnd('div');
704 $this->elementEnd('div');
705 $this->elementEnd('div');
706 $this->elementEnd('div');
710 * Show local navigation block.
714 function showLocalNavBlock()
716 // Need to have this ID for CSS; I'm too lazy to add it to
718 $this->elementStart('div', array('id' => 'site_nav_local_views'));
719 $this->showLocalNav();
720 $this->elementEnd('div');
724 * Show local navigation.
730 function showLocalNav()
732 $nav = new DefaultLocalNav($this);
737 * Show menu for an object (group, profile)
739 * This block will only show if a subclass has overridden
740 * the showObjectNav() method.
744 function showObjectNavBlock()
746 $rmethod = new ReflectionMethod($this, 'showObjectNav');
747 $dclass = $rmethod->getDeclaringClass()->getName();
749 if ($dclass != 'Action') {
750 // Need to have this ID for CSS; I'm too lazy to add it to
752 $this->elementStart('div', array('id' => 'site_nav_object',
753 'class' => 'section'));
754 $this->showObjectNav();
755 $this->elementEnd('div');
760 * Show object navigation.
762 * If there are things to do with this object, show it here.
766 function showObjectNav()
772 * Show content block.
776 function showContentBlock()
778 $this->elementStart('div', array('id' => 'content'));
779 if (common_logged_in()) {
780 if (Event::handle('StartShowNoticeForm', array($this))) {
781 $this->showNoticeForm();
782 Event::handle('EndShowNoticeForm', array($this));
785 if (Event::handle('StartShowPageTitle', array($this))) {
786 $this->showPageTitle();
787 Event::handle('EndShowPageTitle', array($this));
789 $this->showPageNoticeBlock();
790 $this->elementStart('div', array('id' => 'content_inner'));
791 // show the actual content (forms, lists, whatever)
792 $this->showContent();
793 $this->elementEnd('div');
794 $this->elementEnd('div');
802 function showPageTitle()
804 $this->element('h1', null, $this->title());
808 * Show page notice block.
810 * Only show the block if a subclassed action has overrided
811 * Action::showPageNotice(), or an event handler is registered for
812 * the StartShowPageNotice event, in which case we assume the
813 * 'page_notice' definition list is desired. This is to prevent
814 * empty 'page_notice' definition lists from being output everywhere.
818 function showPageNoticeBlock()
820 $rmethod = new ReflectionMethod($this, 'showPageNotice');
821 $dclass = $rmethod->getDeclaringClass()->getName();
823 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
825 $this->elementStart('div', array('id' => 'page_notice',
826 'class' => 'system_notice'));
827 if (Event::handle('StartShowPageNotice', array($this))) {
828 $this->showPageNotice();
829 Event::handle('EndShowPageNotice', array($this));
831 $this->elementEnd('div');
838 * SHOULD overload (unless there's not a notice)
842 function showPageNotice()
849 * MUST overload (unless there's not a notice)
853 function showContent()
864 $this->elementStart('div', array('id' => 'aside_primary',
865 'class' => 'aside'));
866 if (Event::handle('StartShowObjectNavBlock', array($this))) {
867 $this->showObjectNavBlock();
868 Event::handle('EndShowObjectNavBlock', array($this));
870 if (Event::handle('StartShowSections', array($this))) {
871 $this->showSections();
872 Event::handle('EndShowSections', array($this));
874 if (Event::handle('StartShowExportData', array($this))) {
875 $this->showExportData();
876 Event::handle('EndShowExportData', array($this));
878 $this->elementEnd('div');
882 * Show export data feeds.
886 function showExportData()
888 $feeds = $this->getFeeds();
890 $fl = new FeedList($this);
902 function showSections()
904 // for each section, show it
912 function showFooter()
914 $this->elementStart('div', array('id' => 'footer'));
915 if (Event::handle('StartShowInsideFooter', array($this))) {
916 $this->showSecondaryNav();
917 $this->showLicenses();
918 Event::handle('EndShowInsideFooter', array($this));
920 $this->elementEnd('div');
924 * Show secondary navigation.
928 function showSecondaryNav()
930 $sn = new SecondaryNav($this);
939 function showLicenses()
941 $this->showStatusNetLicense();
942 $this->showContentLicense();
946 * Show StatusNet license.
950 function showStatusNetLicense()
952 if (common_config('site', 'broughtby')) {
953 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
954 // TRANS: Text between [] is a link description, text between () is the link itself.
955 // TRANS: Make sure there is no whitespace between "]" and "(".
956 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
957 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
959 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
960 $instr = _('**%%site.name%%** is a microblogging service.');
963 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
964 // TRANS: Make sure there is no whitespace between "]" and "(".
965 // TRANS: Text between [] is a link description, text between () is the link itself.
966 // TRANS: %s is the version of StatusNet that is being used.
967 $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);
968 $output = common_markup_to_html($instr);
974 * Show content license.
978 function showContentLicense()
980 if (Event::handle('StartShowContentLicense', array($this))) {
981 switch (common_config('license', 'type')) {
983 // TRANS: Content license displayed when license is set to 'private'.
984 // TRANS: %1$s is the site name.
985 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
986 common_config('site', 'name')));
988 case 'allrightsreserved':
989 if (common_config('license', 'owner')) {
990 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
991 // TRANS: %1$s is the copyright owner.
992 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
993 common_config('license', 'owner')));
995 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
996 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
999 case 'cc': // fall through
1001 $this->elementStart('p');
1003 $image = common_config('license', 'image');
1004 $sslimage = common_config('license', 'sslimage');
1006 if (StatusNet::isHTTPS()) {
1007 if (!empty($sslimage)) {
1009 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1010 // CC support HTTPS on their images
1011 $url = preg_replace('/^http/', 'https', $image);
1013 // Better to show mixed content than no content
1020 $this->element('img', array('id' => 'license_cc',
1022 'alt' => common_config('license', 'title'),
1026 // TRANS: license message in footer.
1027 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1028 $notice = _('All %1$s content and data are available under the %2$s license.');
1029 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1030 htmlspecialchars(common_config('license', 'url')) .
1032 htmlspecialchars(common_config('license', 'title')) .
1034 $this->raw(sprintf(htmlspecialchars($notice),
1035 htmlspecialchars(common_config('site', 'name')),
1037 $this->elementEnd('p');
1041 Event::handle('EndShowContentLicense', array($this));
1046 * Return last modified, if applicable.
1050 * @return string last modified http header
1052 function lastModified()
1054 // For comparison with If-Last-Modified
1055 // If not applicable, return null
1060 * Return etag, if applicable.
1064 * @return string etag http header
1072 * Return true if read only.
1076 * @param array $args other arguments
1078 * @return boolean is read only action?
1080 function isReadOnly($args)
1086 * Returns query argument or default value if not found
1088 * @param string $key requested argument
1089 * @param string $def default value to return if $key is not provided
1091 * @return boolean is read only action?
1093 function arg($key, $def=null)
1095 if (array_key_exists($key, $this->args)) {
1096 return $this->args[$key];
1103 * Returns trimmed query argument or default value if not found
1105 * @param string $key requested argument
1106 * @param string $def default value to return if $key is not provided
1108 * @return boolean is read only action?
1110 function trimmed($key, $def=null)
1112 $arg = $this->arg($key, $def);
1113 return is_string($arg) ? trim($arg) : $arg;
1119 * @param array $argarray is ignored since it's now passed in in prepare()
1121 * @return boolean is read only action?
1123 function handle($argarray=null)
1125 header('Vary: Accept-Encoding,Cookie');
1127 $lm = $this->lastModified();
1128 $etag = $this->etag();
1131 header('ETag: ' . $etag);
1135 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1136 if ($this->isCacheable()) {
1137 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1138 header( "Cache-Control: private, must-revalidate, max-age=0" );
1145 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1146 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1147 if ($if_none_match) {
1148 // If this check fails, ignore the if-modified-since below.
1150 if ($this->_hasEtag($etag, $if_none_match)) {
1151 header('HTTP/1.1 304 Not Modified');
1152 // Better way to do this?
1158 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1159 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1160 $ims = strtotime($if_modified_since);
1162 header('HTTP/1.1 304 Not Modified');
1163 // Better way to do this?
1170 * Is this action cacheable?
1172 * If the action returns a last-modified
1174 * @param array $argarray is ignored since it's now passed in in prepare()
1176 * @return boolean is read only action?
1178 function isCacheable()
1184 * HasĀ etag? (private)
1186 * @param string $etag etag http header
1187 * @param string $if_none_match ifNoneMatch http header
1191 function _hasEtag($etag, $if_none_match)
1193 $etags = explode(',', $if_none_match);
1194 return in_array($etag, $etags) || in_array('*', $etags);
1198 * Boolean understands english (yes, no, true, false)
1200 * @param string $key query key we're interested in
1201 * @param string $def default value
1203 * @return boolean interprets yes/no strings as boolean
1205 function boolean($key, $def=false)
1207 $arg = strtolower($this->trimmed($key));
1209 if (is_null($arg)) {
1211 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1213 } else if (in_array($arg, array('false', 'no', '0'))) {
1221 * Integer value of an argument
1223 * @param string $key query key we're interested in
1224 * @param string $defValue optional default value (default null)
1225 * @param string $maxValue optional max value (default null)
1226 * @param string $minValue optional min value (default null)
1228 * @return integer integer value
1230 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1232 $arg = strtolower($this->trimmed($key));
1234 if (is_null($arg) || !is_integer($arg)) {
1238 if (!is_null($maxValue)) {
1239 $arg = min($arg, $maxValue);
1242 if (!is_null($minValue)) {
1243 $arg = max($arg, $minValue);
1252 * @param string $msg error message to display
1253 * @param integer $code http error code, 500 by default
1257 function serverError($msg, $code=500)
1259 $action = $this->trimmed('action');
1260 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1261 throw new ServerException($msg, $code);
1267 * @param string $msg error message to display
1268 * @param integer $code http error code, 400 by default
1272 function clientError($msg, $code=400)
1274 $action = $this->trimmed('action');
1275 common_debug("User error '$code' on '$action': $msg", __FILE__);
1276 throw new ClientException($msg, $code);
1280 * Returns the current URL
1282 * @return string current URL
1286 list($action, $args) = $this->returnToArgs();
1287 return common_local_url($action, $args);
1291 * Returns arguments sufficient for re-constructing URL
1293 * @return array two elements: action, other args
1295 function returnToArgs()
1297 $action = $this->trimmed('action');
1298 $args = $this->args;
1299 unset($args['action']);
1300 if (common_config('site', 'fancy')) {
1303 if (array_key_exists('submit', $args)) {
1304 unset($args['submit']);
1306 foreach (array_keys($_COOKIE) as $cookie) {
1307 unset($args[$cookie]);
1309 return array($action, $args);
1313 * Generate a menu item
1315 * @param string $url menu URL
1316 * @param string $text menu name
1317 * @param string $title title attribute, null by default
1318 * @param boolean $is_selected current menu item, false by default
1319 * @param string $id element id, null by default
1323 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1325 // Added @id to li for some control.
1326 // XXX: We might want to move this to htmloutputter.php
1329 $lattrs['class'] = 'current';
1332 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1334 $this->elementStart('li', $lattrs);
1335 $attrs['href'] = $url;
1337 $attrs['title'] = $title;
1339 $this->element('a', $attrs, $text);
1340 $this->elementEnd('li');
1344 * Generate pagination links
1346 * @param boolean $have_before is there something before?
1347 * @param boolean $have_after is there something after?
1348 * @param integer $page current page
1349 * @param string $action current action
1350 * @param array $args rest of query arguments
1354 // XXX: The messages in this pagination method only tailor to navigating
1355 // notices. In other lists, "Previous"/"Next" type navigation is
1356 // desirable, but not available.
1357 function pagination($have_before, $have_after, $page, $action, $args=null)
1359 // Does a little before-after block for next/prev page
1360 if ($have_before || $have_after) {
1361 $this->elementStart('ul', array('class' => 'nav',
1362 'id' => 'pagination'));
1365 $pargs = array('page' => $page-1);
1366 $this->elementStart('li', array('class' => 'nav_prev'));
1367 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1369 // TRANS: Pagination message to go to a page displaying information more in the
1370 // TRANS: present than the currently displayed information.
1372 $this->elementEnd('li');
1375 $pargs = array('page' => $page+1);
1376 $this->elementStart('li', array('class' => 'nav_next'));
1377 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1379 // TRANS: Pagination message to go to a page displaying information more in the
1380 // TRANS: past than the currently displayed information.
1382 $this->elementEnd('li');
1384 if ($have_before || $have_after) {
1385 $this->elementEnd('ul');
1390 * An array of feeds for this action.
1392 * Returns an array of potential feeds for this action.
1394 * @return array Feed object to show in head and links
1402 * A design for this action
1404 * @return Design a design object to use
1406 function getDesign()
1408 return Design::siteDesign();
1412 * Check the session token.
1414 * Checks that the current form has the correct session token,
1415 * and throw an exception if it does not.
1419 // XXX: Finding this type of check with the same message about 50 times.
1420 // Possible to refactor?
1421 function checkSessionToken()
1424 $token = $this->trimmed('token');
1425 if (empty($token) || $token != common_session_token()) {
1426 // TRANS: Client error text when there is a problem with the session token.
1427 $this->clientError(_('There was a problem with your session token.'));
1432 * Check if the current request is a POST
1434 * @return boolean true if POST; otherwise false.
1439 return ($_SERVER['REQUEST_METHOD'] == 'POST');