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));
115 * Show head, a template method.
121 // XXX: attributes (profile?)
122 $this->elementStart('head');
123 if (Event::handle('StartShowHeadElements', array($this))) {
124 if (Event::handle('StartShowHeadTitle', array($this))) {
126 Event::handle('EndShowHeadTitle', array($this));
128 $this->showShortcutIcon();
129 $this->showStylesheets();
130 $this->showOpenSearch();
132 $this->showDescription();
134 Event::handle('EndShowHeadElements', array($this));
136 $this->elementEnd('head');
140 * Show title, a template method.
146 $this->element('title', null,
147 // TRANS: Page title. %1$s is the title, %2$s is the site name.
148 sprintf(_("%1\$s - %2\$s"),
150 common_config('site', 'name')));
154 * Returns the page title
158 * @return string page title
163 // TRANS: Page title for a page without a title set.
164 return _("Untitled page");
168 * Show themed shortcut icon
172 function showShortcutIcon()
174 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
175 $this->element('link', array('rel' => 'shortcut icon',
176 'href' => Theme::path('favicon.ico')));
178 // favicon.ico should be HTTPS if the rest of the page is
179 $this->element('link', array('rel' => 'shortcut icon',
180 'href' => common_path('favicon.ico', StatusNet::isHTTPS())));
183 if (common_config('site', 'mobile')) {
184 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
185 $this->element('link', array('rel' => 'apple-touch-icon',
186 'href' => Theme::path('apple-touch-icon.png')));
188 $this->element('link', array('rel' => 'apple-touch-icon',
189 'href' => common_path('apple-touch-icon.png')));
199 function showStylesheets()
201 if (Event::handle('StartShowStyles', array($this))) {
203 // Use old name for StatusNet for compatibility on events
205 if (Event::handle('StartShowStatusNetStyles', array($this)) &&
206 Event::handle('StartShowLaconicaStyles', array($this))) {
207 $this->primaryCssLink(null, 'screen, projection, tv, print');
208 Event::handle('EndShowStatusNetStyles', array($this));
209 Event::handle('EndShowLaconicaStyles', array($this));
212 if (Event::handle('StartShowUAStyles', array($this))) {
213 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
214 'href="'.Theme::path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
215 foreach (array(6,7) as $ver) {
216 if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
217 // Yes, IE people should be put in jail.
218 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
219 'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
222 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
223 'href="'.Theme::path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
224 Event::handle('EndShowUAStyles', array($this));
227 if (Event::handle('StartShowDesign', array($this))) {
229 $user = common_current_user();
231 if (empty($user) || $user->viewdesigns) {
232 $design = $this->getDesign();
234 if (!empty($design)) {
235 $design->showCSS($this);
239 Event::handle('EndShowDesign', array($this));
241 Event::handle('EndShowStyles', array($this));
243 if (common_config('custom_css', 'enabled')) {
244 $css = common_config('custom_css', 'css');
245 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
246 if (trim($css) != '') {
249 Event::handle('EndShowCustomCss', array($this));
255 function primaryCssLink($mainTheme=null, $media=null)
257 // If the currently-selected theme has dependencies on other themes,
258 // we'll need to load their display.css files as well in order.
259 $theme = new Theme($mainTheme);
260 $baseThemes = $theme->getDeps();
261 foreach ($baseThemes as $baseTheme) {
262 $this->cssLink('css/display.css', $baseTheme, $media);
264 $this->cssLink('css/display.css', $mainTheme, $media);
268 * Show javascript headers
272 function showScripts()
274 if (Event::handle('StartShowScripts', array($this))) {
275 if (Event::handle('StartShowJQueryScripts', array($this))) {
276 $this->script('jquery.min.js');
277 $this->script('jquery.form.js');
278 $this->script('jquery.cookie.js');
279 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.js').'"); }');
280 $this->script('jquery.joverlay.min.js');
281 Event::handle('EndShowJQueryScripts', array($this));
283 if (Event::handle('StartShowStatusNetScripts', array($this)) &&
284 Event::handle('StartShowLaconicaScripts', array($this))) {
285 $this->script('util.js');
286 // Frame-busting code to avoid clickjacking attacks.
287 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
288 Event::handle('EndShowStatusNetScripts', array($this));
289 Event::handle('EndShowLaconicaScripts', array($this));
291 Event::handle('EndShowScripts', array($this));
296 * Show OpenSearch headers
300 function showOpenSearch()
302 $this->element('link', array('rel' => 'search',
303 'type' => 'application/opensearchdescription+xml',
304 'href' => common_local_url('opensearch', array('type' => 'people')),
305 'title' => common_config('site', 'name').' People Search'));
306 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
307 'href' => common_local_url('opensearch', array('type' => 'notice')),
308 'title' => common_config('site', 'name').' Notice Search'));
320 $feeds = $this->getFeeds();
323 foreach ($feeds as $feed) {
324 $this->element('link', array('rel' => $feed->rel(),
325 'href' => $feed->url,
326 'type' => $feed->mimeType(),
327 'title' => $feed->title));
339 function showDescription()
341 // does nothing by default
345 * Show extra stuff in <head>.
353 // does nothing by default
359 * Calls template methods
365 $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
366 'class' => 'user_in')
367 : array('id' => $this->trimmed('action')));
368 $this->elementStart('div', array('id' => 'wrap'));
369 if (Event::handle('StartShowHeader', array($this))) {
371 Event::handle('EndShowHeader', array($this));
374 if (Event::handle('StartShowFooter', array($this))) {
376 Event::handle('EndShowFooter', array($this));
378 $this->elementEnd('div');
379 $this->showScripts();
380 $this->elementEnd('body');
384 * Show header of the page.
386 * Calls template methods
390 function showHeader()
392 $this->elementStart('div', array('id' => 'header'));
394 $this->showPrimaryNav();
395 if (Event::handle('StartShowSiteNotice', array($this))) {
396 $this->showSiteNotice();
398 Event::handle('EndShowSiteNotice', array($this));
400 if (common_logged_in()) {
401 if (Event::handle('StartShowNoticeForm', array($this))) {
402 $this->showNoticeForm();
403 Event::handle('EndShowNoticeForm', array($this));
406 $this->showAnonymousMessage();
408 $this->elementEnd('div');
412 * Show configured logo.
418 $this->elementStart('address', array('id' => 'site_contact',
419 'class' => 'vcard'));
420 if (Event::handle('StartAddressData', array($this))) {
421 if (common_config('singleuser', 'enabled')) {
422 $url = common_local_url('showstream',
423 array('nickname' => common_config('singleuser', 'nickname')));
425 $url = common_local_url('public');
427 $this->elementStart('a', array('class' => 'url home bookmark',
429 if (common_config('site', 'logo') || file_exists(Theme::file('logo.png'))) {
430 $this->element('img', array('class' => 'logo photo',
431 'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : Theme::path('logo.png'),
432 'alt' => common_config('site', 'name')));
435 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
436 $this->elementEnd('a');
437 Event::handle('EndAddressData', array($this));
439 $this->elementEnd('address');
443 * Show primary navigation.
447 function showPrimaryNav()
449 $user = common_current_user();
450 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
451 // TRANS: DT element for primary navigation menu. String is hidden in default CSS.
452 $this->element('dt', null, _('Primary site navigation'));
453 $this->elementStart('dd');
454 $this->elementStart('ul', array('class' => 'nav'));
455 if (Event::handle('StartPrimaryNav', array($this))) {
457 // TRANS: Tooltip for main menu option "Personal"
458 $tooltip = _m('TOOLTIP', 'Personal profile and friends timeline');
459 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
460 // TRANS: Main menu option when logged in for access to personal profile and friends timeline
461 _m('MENU', 'Personal'), $tooltip, false, 'nav_home');
462 // TRANS: Tooltip for main menu option "Account"
463 $tooltip = _m('TOOLTIP', 'Change your email, avatar, password, profile');
464 $this->menuItem(common_local_url('profilesettings'),
465 // TRANS: Main menu option when logged in for access to user settings
466 _('Account'), $tooltip, false, 'nav_account');
467 // TRANS: Tooltip for main menu option "Services"
468 $tooltip = _m('TOOLTIP', 'Connect to services');
469 $this->menuItem(common_local_url('oauthconnectionssettings'),
470 // TRANS: Main menu option when logged in and connection are possible for access to options to connect to other services
471 _('Connect'), $tooltip, false, 'nav_connect');
472 if ($user->hasRight(Right::CONFIGURESITE)) {
473 // TRANS: Tooltip for menu option "Admin"
474 $tooltip = _m('TOOLTIP', 'Change site configuration');
475 $this->menuItem(common_local_url('siteadminpanel'),
476 // TRANS: Main menu option when logged in and site admin for access to site configuration
477 _m('MENU', 'Admin'), $tooltip, false, 'nav_admin');
479 if (common_config('invite', 'enabled')) {
480 // TRANS: Tooltip for main menu option "Invite"
481 $tooltip = _m('TOOLTIP', 'Invite friends and colleagues to join you on %s');
482 $this->menuItem(common_local_url('invite'),
483 // TRANS: Main menu option when logged in and invitations are allowed for inviting new users
484 _m('MENU', 'Invite'),
486 common_config('site', 'name')),
487 false, 'nav_invitecontact');
489 // TRANS: Tooltip for main menu option "Logout"
490 $tooltip = _m('TOOLTIP', 'Logout from the site');
491 $this->menuItem(common_local_url('logout'),
492 // TRANS: Main menu option when logged in to log out the current user
493 _m('MENU', 'Logout'), $tooltip, false, 'nav_logout');
496 if (!common_config('site', 'closed') && !common_config('site', 'inviteonly')) {
497 // TRANS: Tooltip for main menu option "Register"
498 $tooltip = _m('TOOLTIP', 'Create an account');
499 $this->menuItem(common_local_url('register'),
500 // TRANS: Main menu option when not logged in to register a new account
501 _m('MENU', 'Register'), $tooltip, false, 'nav_register');
503 // TRANS: Tooltip for main menu option "Login"
504 $tooltip = _m('TOOLTIP', 'Login to the site');
505 // TRANS: Main menu option when not logged in to log in
506 $this->menuItem(common_local_url('login'),
507 _m('MENU', 'Login'), $tooltip, false, 'nav_login');
509 // TRANS: Tooltip for main menu option "Help"
510 $tooltip = _m('TOOLTIP', 'Help me!');
511 // TRANS: Main menu option for help on the StatusNet site
512 $this->menuItem(common_local_url('doc', array('title' => 'help')),
513 _m('MENU', 'Help'), $tooltip, false, 'nav_help');
514 if ($user || !common_config('site', 'private')) {
515 // TRANS: Tooltip for main menu option "Search"
516 $tooltip = _m('TOOLTIP', 'Search for people or text');
517 // TRANS: Main menu option when logged in or when the StatusNet instance is not private
518 $this->menuItem(common_local_url('peoplesearch'),
519 _m('MENU', 'Search'), $tooltip, false, 'nav_search');
521 Event::handle('EndPrimaryNav', array($this));
523 $this->elementEnd('ul');
524 $this->elementEnd('dd');
525 $this->elementEnd('dl');
533 function showSiteNotice()
535 // Revist. Should probably do an hAtom pattern here
536 $text = common_config('site', 'notice');
538 $this->elementStart('dl', array('id' => 'site_notice',
539 'class' => 'system_notice'));
540 // TRANS: DT element for site notice. String is hidden in default CSS.
541 $this->element('dt', null, _('Site notice'));
542 $this->elementStart('dd', null);
544 $this->elementEnd('dd');
545 $this->elementEnd('dl');
552 * MAY overload if no notice form needed... or direct message box????
556 function showNoticeForm()
558 $notice_form = new NoticeForm($this);
559 $notice_form->show();
563 * Show anonymous message.
569 function showAnonymousMessage()
571 // needs to be defined by the class
577 * Shows local navigation, content block and aside.
583 $this->elementStart('div', array('id' => 'core'));
584 if (Event::handle('StartShowLocalNavBlock', array($this))) {
585 $this->showLocalNavBlock();
586 Event::handle('EndShowLocalNavBlock', array($this));
588 if (Event::handle('StartShowContentBlock', array($this))) {
589 $this->showContentBlock();
590 Event::handle('EndShowContentBlock', array($this));
592 if (Event::handle('StartShowAside', array($this))) {
594 Event::handle('EndShowAside', array($this));
596 $this->elementEnd('div');
600 * Show local navigation block.
604 function showLocalNavBlock()
606 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
607 // TRANS: DT element for local views block. String is hidden in default CSS.
608 $this->element('dt', null, _('Local views'));
609 $this->elementStart('dd');
610 $this->showLocalNav();
611 $this->elementEnd('dd');
612 $this->elementEnd('dl');
616 * Show local navigation.
622 function showLocalNav()
624 // does nothing by default
628 * Show content block.
632 function showContentBlock()
634 $this->elementStart('div', array('id' => 'content'));
635 if (Event::handle('StartShowPageTitle', array($this))) {
636 $this->showPageTitle();
637 Event::handle('EndShowPageTitle', array($this));
639 $this->showPageNoticeBlock();
640 $this->elementStart('div', array('id' => 'content_inner'));
641 // show the actual content (forms, lists, whatever)
642 $this->showContent();
643 $this->elementEnd('div');
644 $this->elementEnd('div');
652 function showPageTitle()
654 $this->element('h1', null, $this->title());
658 * Show page notice block.
660 * Only show the block if a subclassed action has overrided
661 * Action::showPageNotice(), or an event handler is registered for
662 * the StartShowPageNotice event, in which case we assume the
663 * 'page_notice' definition list is desired. This is to prevent
664 * empty 'page_notice' definition lists from being output everywhere.
668 function showPageNoticeBlock()
670 $rmethod = new ReflectionMethod($this, 'showPageNotice');
671 $dclass = $rmethod->getDeclaringClass()->getName();
673 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
675 $this->elementStart('dl', array('id' => 'page_notice',
676 'class' => 'system_notice'));
677 // TRANS: DT element for page notice. String is hidden in default CSS.
678 $this->element('dt', null, _('Page notice'));
679 $this->elementStart('dd');
680 if (Event::handle('StartShowPageNotice', array($this))) {
681 $this->showPageNotice();
682 Event::handle('EndShowPageNotice', array($this));
684 $this->elementEnd('dd');
685 $this->elementEnd('dl');
692 * SHOULD overload (unless there's not a notice)
696 function showPageNotice()
703 * MUST overload (unless there's not a notice)
707 function showContent()
718 $this->elementStart('div', array('id' => 'aside_primary',
719 'class' => 'aside'));
720 if (Event::handle('StartShowSections', array($this))) {
721 $this->showSections();
722 Event::handle('EndShowSections', array($this));
724 if (Event::handle('StartShowExportData', array($this))) {
725 $this->showExportData();
726 Event::handle('EndShowExportData', array($this));
728 $this->elementEnd('div');
732 * Show export data feeds.
736 function showExportData()
738 $feeds = $this->getFeeds();
740 $fl = new FeedList($this);
752 function showSections()
754 // for each section, show it
762 function showFooter()
764 $this->elementStart('div', array('id' => 'footer'));
765 $this->showSecondaryNav();
766 $this->showLicenses();
767 $this->elementEnd('div');
771 * Show secondary navigation.
775 function showSecondaryNav()
777 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
778 // TRANS: DT element for secondary navigation menu. String is hidden in default CSS.
779 $this->element('dt', null, _('Secondary site navigation'));
780 $this->elementStart('dd', null);
781 $this->elementStart('ul', array('class' => 'nav'));
782 if (Event::handle('StartSecondaryNav', array($this))) {
783 $this->menuItem(common_local_url('doc', array('title' => 'help')),
784 // TRANS: Secondary navigation menu option leading to help on StatusNet.
786 $this->menuItem(common_local_url('doc', array('title' => 'about')),
787 // TRANS: Secondary navigation menu option leading to text about StatusNet site.
789 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
790 // TRANS: Secondary navigation menu option leading to Frequently Asked Questions.
792 $bb = common_config('site', 'broughtby');
794 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
795 // TRANS: Secondary navigation menu option leading to Terms of Service.
798 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
799 // TRANS: Secondary navigation menu option leading to privacy policy.
801 $this->menuItem(common_local_url('doc', array('title' => 'source')),
802 // TRANS: Secondary navigation menu option.
804 $this->menuItem(common_local_url('version'),
805 // TRANS: Secondary navigation menu option leading to version information on the StatusNet site.
807 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
808 // TRANS: Secondary navigation menu option leading to contact information on the StatusNet site.
810 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
811 // TRANS: Secondary navigation menu option.
813 Event::handle('EndSecondaryNav', array($this));
815 $this->elementEnd('ul');
816 $this->elementEnd('dd');
817 $this->elementEnd('dl');
825 function showLicenses()
827 $this->elementStart('dl', array('id' => 'licenses'));
828 $this->showStatusNetLicense();
829 $this->showContentLicense();
830 $this->elementEnd('dl');
834 * Show StatusNet license.
838 function showStatusNetLicense()
840 // TRANS: DT element for StatusNet software license.
841 $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
842 $this->elementStart('dd', null);
843 if (common_config('site', 'broughtby')) {
844 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
845 // TRANS: Text between [] is a link description, text between () is the link itself.
846 // TRANS: Make sure there is no whitespace between "]" and "(".
847 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
848 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
850 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
851 $instr = _('**%%site.name%%** is a microblogging service.');
854 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
855 // TRANS: Make sure there is no whitespace between "]" and "(".
856 // TRANS: Text between [] is a link description, text between () is the link itself.
857 // TRANS: %s is the version of StatusNet that is being used.
858 $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);
859 $output = common_markup_to_html($instr);
861 $this->elementEnd('dd');
866 * Show content license.
870 function showContentLicense()
872 if (Event::handle('StartShowContentLicense', array($this))) {
873 // TRANS: DT element for StatusNet site content license.
874 $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
875 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
877 switch (common_config('license', 'type')) {
879 // TRANS: Content license displayed when license is set to 'private'.
880 // TRANS: %1$s is the site name.
881 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
882 common_config('site', 'name')));
884 case 'allrightsreserved':
885 if (common_config('license', 'owner')) {
886 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
887 // TRANS: %1$s is the copyright owner.
888 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
889 common_config('license', 'owner')));
891 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
892 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
895 case 'cc': // fall through
897 $this->elementStart('p');
899 $image = common_config('license', 'image');
900 $sslimage = common_config('license', 'sslimage');
902 if (StatusNet::isHTTPS()) {
903 if (!empty($sslimage)) {
905 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
906 // CC support HTTPS on their images
907 $url = preg_replace('/^http/', 'https', $image);
909 // Better to show mixed content than no content
916 $this->element('img', array('id' => 'license_cc',
918 'alt' => common_config('license', 'title'),
922 // TRANS: license message in footer.
923 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
924 $notice = _('All %1$s content and data are available under the %2$s license.');
925 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
926 htmlspecialchars(common_config('license', 'url')) .
928 htmlspecialchars(common_config('license', 'title')) .
930 $this->raw(sprintf(htmlspecialchars($notice),
931 htmlspecialchars(common_config('site', 'name')),
933 $this->elementEnd('p');
937 $this->elementEnd('dd');
938 Event::handle('EndShowContentLicense', array($this));
943 * Return last modified, if applicable.
947 * @return string last modified http header
949 function lastModified()
951 // For comparison with If-Last-Modified
952 // If not applicable, return null
957 * Return etag, if applicable.
961 * @return string etag http header
969 * Return true if read only.
973 * @param array $args other arguments
975 * @return boolean is read only action?
977 function isReadOnly($args)
983 * Returns query argument or default value if not found
985 * @param string $key requested argument
986 * @param string $def default value to return if $key is not provided
988 * @return boolean is read only action?
990 function arg($key, $def=null)
992 if (array_key_exists($key, $this->args)) {
993 return $this->args[$key];
1000 * Returns trimmed query argument or default value if not found
1002 * @param string $key requested argument
1003 * @param string $def default value to return if $key is not provided
1005 * @return boolean is read only action?
1007 function trimmed($key, $def=null)
1009 $arg = $this->arg($key, $def);
1010 return is_string($arg) ? trim($arg) : $arg;
1016 * @param array $argarray is ignored since it's now passed in in prepare()
1018 * @return boolean is read only action?
1020 function handle($argarray=null)
1022 header('Vary: Accept-Encoding,Cookie');
1024 $lm = $this->lastModified();
1025 $etag = $this->etag();
1028 header('ETag: ' . $etag);
1032 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1033 if ($this->isCacheable()) {
1034 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1035 header( "Cache-Control: private, must-revalidate, max-age=0" );
1042 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1043 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1044 if ($if_none_match) {
1045 // If this check fails, ignore the if-modified-since below.
1047 if ($this->_hasEtag($etag, $if_none_match)) {
1048 header('HTTP/1.1 304 Not Modified');
1049 // Better way to do this?
1055 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1056 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1057 $ims = strtotime($if_modified_since);
1059 header('HTTP/1.1 304 Not Modified');
1060 // Better way to do this?
1067 * Is this action cacheable?
1069 * If the action returns a last-modified
1071 * @param array $argarray is ignored since it's now passed in in prepare()
1073 * @return boolean is read only action?
1075 function isCacheable()
1081 * Has etag? (private)
1083 * @param string $etag etag http header
1084 * @param string $if_none_match ifNoneMatch http header
1088 function _hasEtag($etag, $if_none_match)
1090 $etags = explode(',', $if_none_match);
1091 return in_array($etag, $etags) || in_array('*', $etags);
1095 * Boolean understands english (yes, no, true, false)
1097 * @param string $key query key we're interested in
1098 * @param string $def default value
1100 * @return boolean interprets yes/no strings as boolean
1102 function boolean($key, $def=false)
1104 $arg = strtolower($this->trimmed($key));
1106 if (is_null($arg)) {
1108 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1110 } else if (in_array($arg, array('false', 'no', '0'))) {
1118 * Integer value of an argument
1120 * @param string $key query key we're interested in
1121 * @param string $defValue optional default value (default null)
1122 * @param string $maxValue optional max value (default null)
1123 * @param string $minValue optional min value (default null)
1125 * @return integer integer value
1127 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1129 $arg = strtolower($this->trimmed($key));
1131 if (is_null($arg) || !is_integer($arg)) {
1135 if (!is_null($maxValue)) {
1136 $arg = min($arg, $maxValue);
1139 if (!is_null($minValue)) {
1140 $arg = max($arg, $minValue);
1149 * @param string $msg error message to display
1150 * @param integer $code http error code, 500 by default
1154 function serverError($msg, $code=500)
1156 $action = $this->trimmed('action');
1157 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1158 throw new ServerException($msg, $code);
1164 * @param string $msg error message to display
1165 * @param integer $code http error code, 400 by default
1169 function clientError($msg, $code=400)
1171 $action = $this->trimmed('action');
1172 common_debug("User error '$code' on '$action': $msg", __FILE__);
1173 throw new ClientException($msg, $code);
1177 * Returns the current URL
1179 * @return string current URL
1183 list($action, $args) = $this->returnToArgs();
1184 return common_local_url($action, $args);
1188 * Returns arguments sufficient for re-constructing URL
1190 * @return array two elements: action, other args
1192 function returnToArgs()
1194 $action = $this->trimmed('action');
1195 $args = $this->args;
1196 unset($args['action']);
1197 if (common_config('site', 'fancy')) {
1200 if (array_key_exists('submit', $args)) {
1201 unset($args['submit']);
1203 foreach (array_keys($_COOKIE) as $cookie) {
1204 unset($args[$cookie]);
1206 return array($action, $args);
1210 * Generate a menu item
1212 * @param string $url menu URL
1213 * @param string $text menu name
1214 * @param string $title title attribute, null by default
1215 * @param boolean $is_selected current menu item, false by default
1216 * @param string $id element id, null by default
1220 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1222 // Added @id to li for some control.
1223 // XXX: We might want to move this to htmloutputter.php
1226 $lattrs['class'] = 'current';
1229 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1231 $this->elementStart('li', $lattrs);
1232 $attrs['href'] = $url;
1234 $attrs['title'] = $title;
1236 $this->element('a', $attrs, $text);
1237 $this->elementEnd('li');
1241 * Generate pagination links
1243 * @param boolean $have_before is there something before?
1244 * @param boolean $have_after is there something after?
1245 * @param integer $page current page
1246 * @param string $action current action
1247 * @param array $args rest of query arguments
1251 // XXX: The messages in this pagination method only tailor to navigating
1252 // notices. In other lists, "Previous"/"Next" type navigation is
1253 // desirable, but not available.
1254 function pagination($have_before, $have_after, $page, $action, $args=null)
1256 // Does a little before-after block for next/prev page
1257 if ($have_before || $have_after) {
1258 $this->elementStart('dl', 'pagination');
1259 // TRANS: DT element for pagination (previous/next, etc.).
1260 $this->element('dt', null, _('Pagination'));
1261 $this->elementStart('dd', null);
1262 $this->elementStart('ul', array('class' => 'nav'));
1265 $pargs = array('page' => $page-1);
1266 $this->elementStart('li', array('class' => 'nav_prev'));
1267 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1269 // TRANS: Pagination message to go to a page displaying information more in the
1270 // TRANS: present than the currently displayed information.
1272 $this->elementEnd('li');
1275 $pargs = array('page' => $page+1);
1276 $this->elementStart('li', array('class' => 'nav_next'));
1277 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1279 // TRANS: Pagination message to go to a page displaying information more in the
1280 // TRANS: past than the currently displayed information.
1282 $this->elementEnd('li');
1284 if ($have_before || $have_after) {
1285 $this->elementEnd('ul');
1286 $this->elementEnd('dd');
1287 $this->elementEnd('dl');
1292 * An array of feeds for this action.
1294 * Returns an array of potential feeds for this action.
1296 * @return array Feed object to show in head and links
1304 * A design for this action
1306 * @return Design a design object to use
1308 function getDesign()
1310 return Design::siteDesign();
1314 * Check the session token.
1316 * Checks that the current form has the correct session token,
1317 * and throw an exception if it does not.
1321 // XXX: Finding this type of check with the same message about 50 times.
1322 // Possible to refactor?
1323 function checkSessionToken()
1326 $token = $this->trimmed('token');
1327 if (empty($token) || $token != common_session_token()) {
1328 // TRANS: Client error text when there is a problem with the session token.
1329 $this->clientError(_('There was a problem with your session token.'));