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',
430 if (StatusNet::isHTTPS()) {
431 $logoUrl = common_config('site', 'ssllogo');
432 if (empty($logoUrl)) {
433 // if logo is an uploaded file, try to fall back to HTTPS file URL
434 $httpUrl = common_config('site', 'logo');
435 if (!empty($httpUrl)) {
436 $f = File::staticGet('url', $httpUrl);
437 if (!empty($f) && !empty($f->filename)) {
438 // this will handle the HTTPS case
439 $logoUrl = File::url($f->filename);
444 $logoUrl = common_config('site', 'logo');
447 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
448 // This should handle the HTTPS case internally
449 $logoUrl = Theme::path('logo.png');
452 if (!empty($logoUrl)) {
453 $this->element('img', array('class' => 'logo photo',
455 'alt' => common_config('site', 'name')));
459 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
460 $this->elementEnd('a');
461 Event::handle('EndAddressData', array($this));
463 $this->elementEnd('address');
467 * Show primary navigation.
471 function showPrimaryNav()
473 $user = common_current_user();
474 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
475 // TRANS: DT element for primary navigation menu. String is hidden in default CSS.
476 $this->element('dt', null, _('Primary site navigation'));
477 $this->elementStart('dd');
478 $this->elementStart('ul', array('class' => 'nav'));
479 if (Event::handle('StartPrimaryNav', array($this))) {
481 // TRANS: Tooltip for main menu option "Personal"
482 $tooltip = _m('TOOLTIP', 'Personal profile and friends timeline');
483 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
484 // TRANS: Main menu option when logged in for access to personal profile and friends timeline
485 _m('MENU', 'Personal'), $tooltip, false, 'nav_home');
486 // TRANS: Tooltip for main menu option "Account"
487 $tooltip = _m('TOOLTIP', 'Change your email, avatar, password, profile');
488 $this->menuItem(common_local_url('profilesettings'),
489 // TRANS: Main menu option when logged in for access to user settings
490 _('Account'), $tooltip, false, 'nav_account');
491 // TRANS: Tooltip for main menu option "Services"
492 $tooltip = _m('TOOLTIP', 'Connect to services');
493 $this->menuItem(common_local_url('oauthconnectionssettings'),
494 // TRANS: Main menu option when logged in and connection are possible for access to options to connect to other services
495 _('Connect'), $tooltip, false, 'nav_connect');
496 if ($user->hasRight(Right::CONFIGURESITE)) {
497 // TRANS: Tooltip for menu option "Admin"
498 $tooltip = _m('TOOLTIP', 'Change site configuration');
499 $this->menuItem(common_local_url('siteadminpanel'),
500 // TRANS: Main menu option when logged in and site admin for access to site configuration
501 _m('MENU', 'Admin'), $tooltip, false, 'nav_admin');
503 if (common_config('invite', 'enabled')) {
504 // TRANS: Tooltip for main menu option "Invite"
505 $tooltip = _m('TOOLTIP', 'Invite friends and colleagues to join you on %s');
506 $this->menuItem(common_local_url('invite'),
507 // TRANS: Main menu option when logged in and invitations are allowed for inviting new users
508 _m('MENU', 'Invite'),
510 common_config('site', 'name')),
511 false, 'nav_invitecontact');
513 // TRANS: Tooltip for main menu option "Logout"
514 $tooltip = _m('TOOLTIP', 'Logout from the site');
515 $this->menuItem(common_local_url('logout'),
516 // TRANS: Main menu option when logged in to log out the current user
517 _m('MENU', 'Logout'), $tooltip, false, 'nav_logout');
520 if (!common_config('site', 'closed') && !common_config('site', 'inviteonly')) {
521 // TRANS: Tooltip for main menu option "Register"
522 $tooltip = _m('TOOLTIP', 'Create an account');
523 $this->menuItem(common_local_url('register'),
524 // TRANS: Main menu option when not logged in to register a new account
525 _m('MENU', 'Register'), $tooltip, false, 'nav_register');
527 // TRANS: Tooltip for main menu option "Login"
528 $tooltip = _m('TOOLTIP', 'Login to the site');
529 // TRANS: Main menu option when not logged in to log in
530 $this->menuItem(common_local_url('login'),
531 _m('MENU', 'Login'), $tooltip, false, 'nav_login');
533 // TRANS: Tooltip for main menu option "Help"
534 $tooltip = _m('TOOLTIP', 'Help me!');
535 // TRANS: Main menu option for help on the StatusNet site
536 $this->menuItem(common_local_url('doc', array('title' => 'help')),
537 _m('MENU', 'Help'), $tooltip, false, 'nav_help');
538 if ($user || !common_config('site', 'private')) {
539 // TRANS: Tooltip for main menu option "Search"
540 $tooltip = _m('TOOLTIP', 'Search for people or text');
541 // TRANS: Main menu option when logged in or when the StatusNet instance is not private
542 $this->menuItem(common_local_url('peoplesearch'),
543 _m('MENU', 'Search'), $tooltip, false, 'nav_search');
545 Event::handle('EndPrimaryNav', array($this));
547 $this->elementEnd('ul');
548 $this->elementEnd('dd');
549 $this->elementEnd('dl');
557 function showSiteNotice()
559 // Revist. Should probably do an hAtom pattern here
560 $text = common_config('site', 'notice');
562 $this->elementStart('dl', array('id' => 'site_notice',
563 'class' => 'system_notice'));
564 // TRANS: DT element for site notice. String is hidden in default CSS.
565 $this->element('dt', null, _('Site notice'));
566 $this->elementStart('dd', null);
568 $this->elementEnd('dd');
569 $this->elementEnd('dl');
576 * MAY overload if no notice form needed... or direct message box????
580 function showNoticeForm()
582 $notice_form = new NoticeForm($this);
583 $notice_form->show();
587 * Show anonymous message.
593 function showAnonymousMessage()
595 // needs to be defined by the class
601 * Shows local navigation, content block and aside.
607 $this->elementStart('div', array('id' => 'core'));
608 if (Event::handle('StartShowLocalNavBlock', array($this))) {
609 $this->showLocalNavBlock();
610 Event::handle('EndShowLocalNavBlock', array($this));
612 if (Event::handle('StartShowContentBlock', array($this))) {
613 $this->showContentBlock();
614 Event::handle('EndShowContentBlock', array($this));
616 if (Event::handle('StartShowAside', array($this))) {
618 Event::handle('EndShowAside', array($this));
620 $this->elementEnd('div');
624 * Show local navigation block.
628 function showLocalNavBlock()
630 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
631 // TRANS: DT element for local views block. String is hidden in default CSS.
632 $this->element('dt', null, _('Local views'));
633 $this->elementStart('dd');
634 $this->showLocalNav();
635 $this->elementEnd('dd');
636 $this->elementEnd('dl');
640 * Show local navigation.
646 function showLocalNav()
648 // does nothing by default
652 * Show content block.
656 function showContentBlock()
658 $this->elementStart('div', array('id' => 'content'));
659 if (Event::handle('StartShowPageTitle', array($this))) {
660 $this->showPageTitle();
661 Event::handle('EndShowPageTitle', array($this));
663 $this->showPageNoticeBlock();
664 $this->elementStart('div', array('id' => 'content_inner'));
665 // show the actual content (forms, lists, whatever)
666 $this->showContent();
667 $this->elementEnd('div');
668 $this->elementEnd('div');
676 function showPageTitle()
678 $this->element('h1', null, $this->title());
682 * Show page notice block.
684 * Only show the block if a subclassed action has overrided
685 * Action::showPageNotice(), or an event handler is registered for
686 * the StartShowPageNotice event, in which case we assume the
687 * 'page_notice' definition list is desired. This is to prevent
688 * empty 'page_notice' definition lists from being output everywhere.
692 function showPageNoticeBlock()
694 $rmethod = new ReflectionMethod($this, 'showPageNotice');
695 $dclass = $rmethod->getDeclaringClass()->getName();
697 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
699 $this->elementStart('dl', array('id' => 'page_notice',
700 'class' => 'system_notice'));
701 // TRANS: DT element for page notice. String is hidden in default CSS.
702 $this->element('dt', null, _('Page notice'));
703 $this->elementStart('dd');
704 if (Event::handle('StartShowPageNotice', array($this))) {
705 $this->showPageNotice();
706 Event::handle('EndShowPageNotice', array($this));
708 $this->elementEnd('dd');
709 $this->elementEnd('dl');
716 * SHOULD overload (unless there's not a notice)
720 function showPageNotice()
727 * MUST overload (unless there's not a notice)
731 function showContent()
742 $this->elementStart('div', array('id' => 'aside_primary',
743 'class' => 'aside'));
744 if (Event::handle('StartShowSections', array($this))) {
745 $this->showSections();
746 Event::handle('EndShowSections', array($this));
748 if (Event::handle('StartShowExportData', array($this))) {
749 $this->showExportData();
750 Event::handle('EndShowExportData', array($this));
752 $this->elementEnd('div');
756 * Show export data feeds.
760 function showExportData()
762 $feeds = $this->getFeeds();
764 $fl = new FeedList($this);
776 function showSections()
778 // for each section, show it
786 function showFooter()
788 $this->elementStart('div', array('id' => 'footer'));
789 $this->showSecondaryNav();
790 $this->showLicenses();
791 $this->elementEnd('div');
795 * Show secondary navigation.
799 function showSecondaryNav()
801 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
802 // TRANS: DT element for secondary navigation menu. String is hidden in default CSS.
803 $this->element('dt', null, _('Secondary site navigation'));
804 $this->elementStart('dd', null);
805 $this->elementStart('ul', array('class' => 'nav'));
806 if (Event::handle('StartSecondaryNav', array($this))) {
807 $this->menuItem(common_local_url('doc', array('title' => 'help')),
808 // TRANS: Secondary navigation menu option leading to help on StatusNet.
810 $this->menuItem(common_local_url('doc', array('title' => 'about')),
811 // TRANS: Secondary navigation menu option leading to text about StatusNet site.
813 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
814 // TRANS: Secondary navigation menu option leading to Frequently Asked Questions.
816 $bb = common_config('site', 'broughtby');
818 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
819 // TRANS: Secondary navigation menu option leading to Terms of Service.
822 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
823 // TRANS: Secondary navigation menu option leading to privacy policy.
825 $this->menuItem(common_local_url('doc', array('title' => 'source')),
826 // TRANS: Secondary navigation menu option.
828 $this->menuItem(common_local_url('version'),
829 // TRANS: Secondary navigation menu option leading to version information on the StatusNet site.
831 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
832 // TRANS: Secondary navigation menu option leading to contact information on the StatusNet site.
834 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
835 // TRANS: Secondary navigation menu option.
837 Event::handle('EndSecondaryNav', array($this));
839 $this->elementEnd('ul');
840 $this->elementEnd('dd');
841 $this->elementEnd('dl');
849 function showLicenses()
851 $this->elementStart('dl', array('id' => 'licenses'));
852 $this->showStatusNetLicense();
853 $this->showContentLicense();
854 $this->elementEnd('dl');
858 * Show StatusNet license.
862 function showStatusNetLicense()
864 // TRANS: DT element for StatusNet software license.
865 $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
866 $this->elementStart('dd', null);
867 if (common_config('site', 'broughtby')) {
868 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
869 // TRANS: Text between [] is a link description, text between () is the link itself.
870 // TRANS: Make sure there is no whitespace between "]" and "(".
871 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
872 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
874 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
875 $instr = _('**%%site.name%%** is a microblogging service.');
878 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
879 // TRANS: Make sure there is no whitespace between "]" and "(".
880 // TRANS: Text between [] is a link description, text between () is the link itself.
881 // TRANS: %s is the version of StatusNet that is being used.
882 $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);
883 $output = common_markup_to_html($instr);
885 $this->elementEnd('dd');
890 * Show content license.
894 function showContentLicense()
896 if (Event::handle('StartShowContentLicense', array($this))) {
897 // TRANS: DT element for StatusNet site content license.
898 $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
899 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
901 switch (common_config('license', 'type')) {
903 // TRANS: Content license displayed when license is set to 'private'.
904 // TRANS: %1$s is the site name.
905 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
906 common_config('site', 'name')));
908 case 'allrightsreserved':
909 if (common_config('license', 'owner')) {
910 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
911 // TRANS: %1$s is the copyright owner.
912 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
913 common_config('license', 'owner')));
915 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
916 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
919 case 'cc': // fall through
921 $this->elementStart('p');
923 $image = common_config('license', 'image');
924 $sslimage = common_config('license', 'sslimage');
926 if (StatusNet::isHTTPS()) {
927 if (!empty($sslimage)) {
929 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
930 // CC support HTTPS on their images
931 $url = preg_replace('/^http/', 'https', $image);
933 // Better to show mixed content than no content
940 $this->element('img', array('id' => 'license_cc',
942 'alt' => common_config('license', 'title'),
946 // TRANS: license message in footer.
947 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
948 $notice = _('All %1$s content and data are available under the %2$s license.');
949 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
950 htmlspecialchars(common_config('license', 'url')) .
952 htmlspecialchars(common_config('license', 'title')) .
954 $this->raw(sprintf(htmlspecialchars($notice),
955 htmlspecialchars(common_config('site', 'name')),
957 $this->elementEnd('p');
961 $this->elementEnd('dd');
962 Event::handle('EndShowContentLicense', array($this));
967 * Return last modified, if applicable.
971 * @return string last modified http header
973 function lastModified()
975 // For comparison with If-Last-Modified
976 // If not applicable, return null
981 * Return etag, if applicable.
985 * @return string etag http header
993 * Return true if read only.
997 * @param array $args other arguments
999 * @return boolean is read only action?
1001 function isReadOnly($args)
1007 * Returns query argument or default value if not found
1009 * @param string $key requested argument
1010 * @param string $def default value to return if $key is not provided
1012 * @return boolean is read only action?
1014 function arg($key, $def=null)
1016 if (array_key_exists($key, $this->args)) {
1017 return $this->args[$key];
1024 * Returns trimmed query argument or default value if not found
1026 * @param string $key requested argument
1027 * @param string $def default value to return if $key is not provided
1029 * @return boolean is read only action?
1031 function trimmed($key, $def=null)
1033 $arg = $this->arg($key, $def);
1034 return is_string($arg) ? trim($arg) : $arg;
1040 * @param array $argarray is ignored since it's now passed in in prepare()
1042 * @return boolean is read only action?
1044 function handle($argarray=null)
1046 header('Vary: Accept-Encoding,Cookie');
1048 $lm = $this->lastModified();
1049 $etag = $this->etag();
1052 header('ETag: ' . $etag);
1056 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1057 if ($this->isCacheable()) {
1058 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1059 header( "Cache-Control: private, must-revalidate, max-age=0" );
1066 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1067 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1068 if ($if_none_match) {
1069 // If this check fails, ignore the if-modified-since below.
1071 if ($this->_hasEtag($etag, $if_none_match)) {
1072 header('HTTP/1.1 304 Not Modified');
1073 // Better way to do this?
1079 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1080 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1081 $ims = strtotime($if_modified_since);
1083 header('HTTP/1.1 304 Not Modified');
1084 // Better way to do this?
1091 * Is this action cacheable?
1093 * If the action returns a last-modified
1095 * @param array $argarray is ignored since it's now passed in in prepare()
1097 * @return boolean is read only action?
1099 function isCacheable()
1105 * Has etag? (private)
1107 * @param string $etag etag http header
1108 * @param string $if_none_match ifNoneMatch http header
1112 function _hasEtag($etag, $if_none_match)
1114 $etags = explode(',', $if_none_match);
1115 return in_array($etag, $etags) || in_array('*', $etags);
1119 * Boolean understands english (yes, no, true, false)
1121 * @param string $key query key we're interested in
1122 * @param string $def default value
1124 * @return boolean interprets yes/no strings as boolean
1126 function boolean($key, $def=false)
1128 $arg = strtolower($this->trimmed($key));
1130 if (is_null($arg)) {
1132 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1134 } else if (in_array($arg, array('false', 'no', '0'))) {
1142 * Integer value of an argument
1144 * @param string $key query key we're interested in
1145 * @param string $defValue optional default value (default null)
1146 * @param string $maxValue optional max value (default null)
1147 * @param string $minValue optional min value (default null)
1149 * @return integer integer value
1151 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1153 $arg = strtolower($this->trimmed($key));
1155 if (is_null($arg) || !is_integer($arg)) {
1159 if (!is_null($maxValue)) {
1160 $arg = min($arg, $maxValue);
1163 if (!is_null($minValue)) {
1164 $arg = max($arg, $minValue);
1173 * @param string $msg error message to display
1174 * @param integer $code http error code, 500 by default
1178 function serverError($msg, $code=500)
1180 $action = $this->trimmed('action');
1181 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1182 throw new ServerException($msg, $code);
1188 * @param string $msg error message to display
1189 * @param integer $code http error code, 400 by default
1193 function clientError($msg, $code=400)
1195 $action = $this->trimmed('action');
1196 common_debug("User error '$code' on '$action': $msg", __FILE__);
1197 throw new ClientException($msg, $code);
1201 * Returns the current URL
1203 * @return string current URL
1207 list($action, $args) = $this->returnToArgs();
1208 return common_local_url($action, $args);
1212 * Returns arguments sufficient for re-constructing URL
1214 * @return array two elements: action, other args
1216 function returnToArgs()
1218 $action = $this->trimmed('action');
1219 $args = $this->args;
1220 unset($args['action']);
1221 if (common_config('site', 'fancy')) {
1224 if (array_key_exists('submit', $args)) {
1225 unset($args['submit']);
1227 foreach (array_keys($_COOKIE) as $cookie) {
1228 unset($args[$cookie]);
1230 return array($action, $args);
1234 * Generate a menu item
1236 * @param string $url menu URL
1237 * @param string $text menu name
1238 * @param string $title title attribute, null by default
1239 * @param boolean $is_selected current menu item, false by default
1240 * @param string $id element id, null by default
1244 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1246 // Added @id to li for some control.
1247 // XXX: We might want to move this to htmloutputter.php
1250 $lattrs['class'] = 'current';
1253 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1255 $this->elementStart('li', $lattrs);
1256 $attrs['href'] = $url;
1258 $attrs['title'] = $title;
1260 $this->element('a', $attrs, $text);
1261 $this->elementEnd('li');
1265 * Generate pagination links
1267 * @param boolean $have_before is there something before?
1268 * @param boolean $have_after is there something after?
1269 * @param integer $page current page
1270 * @param string $action current action
1271 * @param array $args rest of query arguments
1275 // XXX: The messages in this pagination method only tailor to navigating
1276 // notices. In other lists, "Previous"/"Next" type navigation is
1277 // desirable, but not available.
1278 function pagination($have_before, $have_after, $page, $action, $args=null)
1280 // Does a little before-after block for next/prev page
1281 if ($have_before || $have_after) {
1282 $this->elementStart('dl', 'pagination');
1283 // TRANS: DT element for pagination (previous/next, etc.).
1284 $this->element('dt', null, _('Pagination'));
1285 $this->elementStart('dd', null);
1286 $this->elementStart('ul', array('class' => 'nav'));
1289 $pargs = array('page' => $page-1);
1290 $this->elementStart('li', array('class' => 'nav_prev'));
1291 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1293 // TRANS: Pagination message to go to a page displaying information more in the
1294 // TRANS: present than the currently displayed information.
1296 $this->elementEnd('li');
1299 $pargs = array('page' => $page+1);
1300 $this->elementStart('li', array('class' => 'nav_next'));
1301 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1303 // TRANS: Pagination message to go to a page displaying information more in the
1304 // TRANS: past than the currently displayed information.
1306 $this->elementEnd('li');
1308 if ($have_before || $have_after) {
1309 $this->elementEnd('ul');
1310 $this->elementEnd('dd');
1311 $this->elementEnd('dl');
1316 * An array of feeds for this action.
1318 * Returns an array of potential feeds for this action.
1320 * @return array Feed object to show in head and links
1328 * A design for this action
1330 * @return Design a design object to use
1332 function getDesign()
1334 return Design::siteDesign();
1338 * Check the session token.
1340 * Checks that the current form has the correct session token,
1341 * and throw an exception if it does not.
1345 // XXX: Finding this type of check with the same message about 50 times.
1346 // Possible to refactor?
1347 function checkSessionToken()
1350 $token = $this->trimmed('token');
1351 if (empty($token) || $token != common_session_token()) {
1352 // TRANS: Client error text when there is a problem with the session token.
1353 $this->clientError(_('There was a problem with your session token.'));