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 if (Event::handle('StartShowUAStyles', array($this))) {
226 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
227 'href="'.Theme::path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
228 foreach (array(6,7) as $ver) {
229 if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
230 // Yes, IE people should be put in jail.
231 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
232 'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
235 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
236 'href="'.Theme::path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
237 Event::handle('EndShowUAStyles', array($this));
240 if (Event::handle('StartShowDesign', array($this))) {
242 $user = common_current_user();
244 if (empty($user) || $user->viewdesigns) {
245 $design = $this->getDesign();
247 if (!empty($design)) {
248 $design->showCSS($this);
252 Event::handle('EndShowDesign', array($this));
254 Event::handle('EndShowStyles', array($this));
256 if (common_config('custom_css', 'enabled')) {
257 $css = common_config('custom_css', 'css');
258 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
259 if (trim($css) != '') {
262 Event::handle('EndShowCustomCss', array($this));
268 function primaryCssLink($mainTheme=null, $media=null)
270 // If the currently-selected theme has dependencies on other themes,
271 // we'll need to load their display.css files as well in order.
272 $theme = new Theme($mainTheme);
273 $baseThemes = $theme->getDeps();
274 foreach ($baseThemes as $baseTheme) {
275 $this->cssLink('css/display.css', $baseTheme, $media);
277 $this->cssLink('css/display.css', $mainTheme, $media);
281 * Show javascript headers
285 function showScripts()
287 if (Event::handle('StartShowScripts', array($this))) {
288 if (Event::handle('StartShowJQueryScripts', array($this))) {
289 $this->script('jquery.min.js');
290 $this->script('jquery.form.min.js');
291 $this->script('jquery.cookie.min.js');
292 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.min.js').'"); }');
293 $this->script('jquery.joverlay.min.js');
294 Event::handle('EndShowJQueryScripts', array($this));
296 if (Event::handle('StartShowStatusNetScripts', array($this)) &&
297 Event::handle('StartShowLaconicaScripts', array($this))) {
298 $this->script('util.min.js');
299 $this->showScriptMessages();
300 // Frame-busting code to avoid clickjacking attacks.
301 if (common_config('javascript', 'bustframes')) {
302 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
304 Event::handle('EndShowStatusNetScripts', array($this));
305 Event::handle('EndShowLaconicaScripts', array($this));
307 Event::handle('EndShowScripts', array($this));
312 * Exports a map of localized text strings to JavaScript code.
314 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
315 * events and appending to the array. Try to avoid adding strings that won't be used, as
316 * they'll be added to HTML output.
319 function showScriptMessages()
323 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
324 // Common messages needed for timeline views etc...
326 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
327 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
329 $messages = array_merge($messages, $this->getScriptMessages());
331 Event::handle('EndScriptMessages', array($this, &$messages));
334 if (!empty($messages)) {
335 $this->inlineScript('SN.messages=' . json_encode($messages));
342 * If the action will need localizable text strings, export them here like so:
344 * return array('pool_deepend' => _('Deep end'),
345 * 'pool_shallow' => _('Shallow end'));
347 * The exported map will be available via SN.msg() to JS code:
349 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
350 * $('#pool .deepend').text(SN.msg('pool_deepend'));
351 * $('#pool .shallow').text(SN.msg('pool_shallow'));
353 * Exports a map of localized text strings to JavaScript code.
355 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
356 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
357 * be used, as they'll be added to HTML output.
359 function getScriptMessages()
365 * Show OpenSearch headers
369 function showOpenSearch()
371 $this->element('link', array('rel' => 'search',
372 'type' => 'application/opensearchdescription+xml',
373 'href' => common_local_url('opensearch', array('type' => 'people')),
374 'title' => common_config('site', 'name').' People Search'));
375 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
376 'href' => common_local_url('opensearch', array('type' => 'notice')),
377 'title' => common_config('site', 'name').' Notice Search'));
389 $feeds = $this->getFeeds();
392 foreach ($feeds as $feed) {
393 $this->element('link', array('rel' => $feed->rel(),
394 'href' => $feed->url,
395 'type' => $feed->mimeType(),
396 'title' => $feed->title));
408 function showDescription()
410 // does nothing by default
414 * Show extra stuff in <head>.
422 // does nothing by default
428 * Calls template methods
434 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
435 'class' => 'user_in')
436 : array('id' => strtolower($this->trimmed('action'))));
437 $this->elementStart('div', array('id' => 'wrap'));
438 if (Event::handle('StartShowHeader', array($this))) {
440 Event::handle('EndShowHeader', array($this));
443 if (Event::handle('StartShowFooter', array($this))) {
445 Event::handle('EndShowFooter', array($this));
447 $this->elementEnd('div');
448 $this->showScripts();
449 $this->elementEnd('body');
453 * Show header of the page.
455 * Calls template methods
459 function showHeader()
461 $this->elementStart('div', array('id' => 'header'));
463 $this->showPrimaryNav();
464 if (Event::handle('StartShowSiteNotice', array($this))) {
465 $this->showSiteNotice();
467 Event::handle('EndShowSiteNotice', array($this));
469 if (common_logged_in()) {
470 if (Event::handle('StartShowNoticeForm', array($this))) {
471 $this->showNoticeForm();
472 Event::handle('EndShowNoticeForm', array($this));
475 $this->showAnonymousMessage();
477 $this->elementEnd('div');
481 * Show configured logo.
487 $this->elementStart('address', array('id' => 'site_contact',
488 'class' => 'vcard'));
489 if (Event::handle('StartAddressData', array($this))) {
490 if (common_config('singleuser', 'enabled')) {
491 $user = User::singleUser();
492 $url = common_local_url('showstream',
493 array('nickname' => $user->nickname));
495 $url = common_local_url('public');
497 $this->elementStart('a', array('class' => 'url home bookmark',
500 if (StatusNet::isHTTPS()) {
501 $logoUrl = common_config('site', 'ssllogo');
502 if (empty($logoUrl)) {
503 // if logo is an uploaded file, try to fall back to HTTPS file URL
504 $httpUrl = common_config('site', 'logo');
505 if (!empty($httpUrl)) {
506 $f = File::staticGet('url', $httpUrl);
507 if (!empty($f) && !empty($f->filename)) {
508 // this will handle the HTTPS case
509 $logoUrl = File::url($f->filename);
514 $logoUrl = common_config('site', 'logo');
517 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
518 // This should handle the HTTPS case internally
519 $logoUrl = Theme::path('logo.png');
522 if (!empty($logoUrl)) {
523 $this->element('img', array('class' => 'logo photo',
525 'alt' => common_config('site', 'name')));
529 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
530 $this->elementEnd('a');
531 Event::handle('EndAddressData', array($this));
533 $this->elementEnd('address');
537 * Show primary navigation.
541 function showPrimaryNav()
543 $user = common_current_user();
544 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
545 // TRANS: DT element for primary navigation menu. String is hidden in default CSS.
546 $this->element('dt', null, _('Primary site navigation'));
547 $this->elementStart('dd');
548 $this->elementStart('ul', array('class' => 'nav'));
549 if (Event::handle('StartPrimaryNav', array($this))) {
551 // TRANS: Tooltip for main menu option "Personal".
552 $tooltip = _m('TOOLTIP', 'Personal profile and friends timeline');
553 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
554 // TRANS: Main menu option when logged in for access to personal profile and friends timeline.
555 _m('MENU', 'Personal'), $tooltip, false, 'nav_home');
556 // TRANS: Tooltip for main menu option "Account".
557 $tooltip = _m('TOOLTIP', 'Change your email, avatar, password, profile');
558 $this->menuItem(common_local_url('profilesettings'),
559 // TRANS: Main menu option when logged in for access to user settings.
560 _('Account'), $tooltip, false, 'nav_account');
561 // TRANS: Tooltip for main menu option "Services".
562 $tooltip = _m('TOOLTIP', 'Connect to services');
563 $this->menuItem(common_local_url('oauthconnectionssettings'),
564 // TRANS: Main menu option when logged in and connection are possible for access to options to connect to other services.
565 _('Connect'), $tooltip, false, 'nav_connect');
566 if ($user->hasRight(Right::CONFIGURESITE)) {
567 // TRANS: Tooltip for menu option "Admin".
568 $tooltip = _m('TOOLTIP', 'Change site configuration');
569 $this->menuItem(common_local_url('siteadminpanel'),
570 // TRANS: Main menu option when logged in and site admin for access to site configuration.
571 _m('MENU', 'Admin'), $tooltip, false, 'nav_admin');
573 if (common_config('invite', 'enabled')) {
574 // TRANS: Tooltip for main menu option "Invite".
575 $tooltip = _m('TOOLTIP', 'Invite friends and colleagues to join you on %s');
576 $this->menuItem(common_local_url('invite'),
577 // TRANS: Main menu option when logged in and invitations are allowed for inviting new users.
578 _m('MENU', 'Invite'),
580 common_config('site', 'name')),
581 false, 'nav_invitecontact');
583 // TRANS: Tooltip for main menu option "Logout"
584 $tooltip = _m('TOOLTIP', 'Logout from the site');
585 $this->menuItem(common_local_url('logout'),
586 // TRANS: Main menu option when logged in to log out the current user.
587 _m('MENU', 'Logout'), $tooltip, false, 'nav_logout');
590 if (!common_config('site', 'closed') && !common_config('site', 'inviteonly')) {
591 // TRANS: Tooltip for main menu option "Register".
592 $tooltip = _m('TOOLTIP', 'Create an account');
593 $this->menuItem(common_local_url('register'),
594 // TRANS: Main menu option when not logged in to register a new account.
595 _m('MENU', 'Register'), $tooltip, false, 'nav_register');
597 // TRANS: Tooltip for main menu option "Login".
598 $tooltip = _m('TOOLTIP', 'Login to the site');
599 $this->menuItem(common_local_url('login'),
600 // TRANS: Main menu option when not logged in to log in.
601 _m('MENU', 'Login'), $tooltip, false, 'nav_login');
603 // TRANS: Tooltip for main menu option "Help".
604 $tooltip = _m('TOOLTIP', 'Help me!');
605 $this->menuItem(common_local_url('doc', array('title' => 'help')),
606 // TRANS: Main menu option for help on the StatusNet site.
607 _m('MENU', 'Help'), $tooltip, false, 'nav_help');
608 if ($user || !common_config('site', 'private')) {
609 // TRANS: Tooltip for main menu option "Search".
610 $tooltip = _m('TOOLTIP', 'Search for people or text');
611 $this->menuItem(common_local_url('peoplesearch'),
612 // TRANS: Main menu option when logged in or when the StatusNet instance is not private.
613 _m('MENU', 'Search'), $tooltip, false, 'nav_search');
615 Event::handle('EndPrimaryNav', array($this));
617 $this->elementEnd('ul');
618 $this->elementEnd('dd');
619 $this->elementEnd('dl');
627 function showSiteNotice()
629 // Revist. Should probably do an hAtom pattern here
630 $text = common_config('site', 'notice');
632 $this->elementStart('dl', array('id' => 'site_notice',
633 'class' => 'system_notice'));
634 // TRANS: DT element for site notice. String is hidden in default CSS.
635 $this->element('dt', null, _('Site notice'));
636 $this->elementStart('dd', null);
638 $this->elementEnd('dd');
639 $this->elementEnd('dl');
646 * MAY overload if no notice form needed... or direct message box????
650 function showNoticeForm()
652 $notice_form = new NoticeForm($this);
653 $notice_form->show();
657 * Show anonymous message.
663 function showAnonymousMessage()
665 // needs to be defined by the class
671 * Shows local navigation, content block and aside.
677 $this->elementStart('div', array('id' => 'core'));
678 if (Event::handle('StartShowLocalNavBlock', array($this))) {
679 $this->showLocalNavBlock();
680 Event::handle('EndShowLocalNavBlock', array($this));
682 if (Event::handle('StartShowContentBlock', array($this))) {
683 $this->showContentBlock();
684 Event::handle('EndShowContentBlock', array($this));
686 if (Event::handle('StartShowAside', array($this))) {
688 Event::handle('EndShowAside', array($this));
690 $this->elementEnd('div');
694 * Show local navigation block.
698 function showLocalNavBlock()
700 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
701 // TRANS: DT element for local views block. String is hidden in default CSS.
702 $this->element('dt', null, _('Local views'));
703 $this->elementStart('dd');
704 $this->showLocalNav();
705 $this->elementEnd('dd');
706 $this->elementEnd('dl');
710 * Show local navigation.
716 function showLocalNav()
718 // does nothing by default
722 * Show content block.
726 function showContentBlock()
728 $this->elementStart('div', array('id' => 'content'));
729 if (Event::handle('StartShowPageTitle', array($this))) {
730 $this->showPageTitle();
731 Event::handle('EndShowPageTitle', array($this));
733 $this->showPageNoticeBlock();
734 $this->elementStart('div', array('id' => 'content_inner'));
735 // show the actual content (forms, lists, whatever)
736 $this->showContent();
737 $this->elementEnd('div');
738 $this->elementEnd('div');
746 function showPageTitle()
748 $this->element('h1', null, $this->title());
752 * Show page notice block.
754 * Only show the block if a subclassed action has overrided
755 * Action::showPageNotice(), or an event handler is registered for
756 * the StartShowPageNotice event, in which case we assume the
757 * 'page_notice' definition list is desired. This is to prevent
758 * empty 'page_notice' definition lists from being output everywhere.
762 function showPageNoticeBlock()
764 $rmethod = new ReflectionMethod($this, 'showPageNotice');
765 $dclass = $rmethod->getDeclaringClass()->getName();
767 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
769 $this->elementStart('dl', array('id' => 'page_notice',
770 'class' => 'system_notice'));
771 // TRANS: DT element for page notice. String is hidden in default CSS.
772 $this->element('dt', null, _('Page notice'));
773 $this->elementStart('dd');
774 if (Event::handle('StartShowPageNotice', array($this))) {
775 $this->showPageNotice();
776 Event::handle('EndShowPageNotice', array($this));
778 $this->elementEnd('dd');
779 $this->elementEnd('dl');
786 * SHOULD overload (unless there's not a notice)
790 function showPageNotice()
797 * MUST overload (unless there's not a notice)
801 function showContent()
812 $this->elementStart('div', array('id' => 'aside_primary',
813 'class' => 'aside'));
814 if (Event::handle('StartShowSections', array($this))) {
815 $this->showSections();
816 Event::handle('EndShowSections', array($this));
818 if (Event::handle('StartShowExportData', array($this))) {
819 $this->showExportData();
820 Event::handle('EndShowExportData', array($this));
822 $this->elementEnd('div');
826 * Show export data feeds.
830 function showExportData()
832 $feeds = $this->getFeeds();
834 $fl = new FeedList($this);
846 function showSections()
848 // for each section, show it
856 function showFooter()
858 $this->elementStart('div', array('id' => 'footer'));
859 if (Event::handle('StartShowInsideFooter', array($this))) {
860 $this->showSecondaryNav();
861 $this->showLicenses();
862 Event::handle('EndShowInsideFooter', array($this));
864 $this->elementEnd('div');
868 * Show secondary navigation.
872 function showSecondaryNav()
874 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
875 // TRANS: DT element for secondary navigation menu. String is hidden in default CSS.
876 $this->element('dt', null, _('Secondary site navigation'));
877 $this->elementStart('dd', null);
878 $this->elementStart('ul', array('class' => 'nav'));
879 if (Event::handle('StartSecondaryNav', array($this))) {
880 $this->menuItem(common_local_url('doc', array('title' => 'help')),
881 // TRANS: Secondary navigation menu option leading to help on StatusNet.
883 $this->menuItem(common_local_url('doc', array('title' => 'about')),
884 // TRANS: Secondary navigation menu option leading to text about StatusNet site.
886 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
887 // TRANS: Secondary navigation menu option leading to Frequently Asked Questions.
889 $bb = common_config('site', 'broughtby');
891 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
892 // TRANS: Secondary navigation menu option leading to Terms of Service.
895 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
896 // TRANS: Secondary navigation menu option leading to privacy policy.
898 $this->menuItem(common_local_url('doc', array('title' => 'source')),
899 // TRANS: Secondary navigation menu option. Leads to information about StatusNet and its license.
901 $this->menuItem(common_local_url('version'),
902 // TRANS: Secondary navigation menu option leading to version information on the StatusNet site.
904 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
905 // TRANS: Secondary navigation menu option leading to e-mail contact information on the
906 // TRANS: StatusNet site, where to report bugs, ...
908 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
909 // TRANS: Secondary navigation menu option. Leads to information about embedding a timeline widget.
911 Event::handle('EndSecondaryNav', array($this));
913 $this->elementEnd('ul');
914 $this->elementEnd('dd');
915 $this->elementEnd('dl');
923 function showLicenses()
925 $this->elementStart('dl', array('id' => 'licenses'));
926 $this->showStatusNetLicense();
927 $this->showContentLicense();
928 $this->elementEnd('dl');
932 * Show StatusNet license.
936 function showStatusNetLicense()
938 // TRANS: DT element for StatusNet software license.
939 $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
940 $this->elementStart('dd', null);
941 if (common_config('site', 'broughtby')) {
942 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
943 // TRANS: Text between [] is a link description, text between () is the link itself.
944 // TRANS: Make sure there is no whitespace between "]" and "(".
945 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
946 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
948 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
949 $instr = _('**%%site.name%%** is a microblogging service.');
952 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
953 // TRANS: Make sure there is no whitespace between "]" and "(".
954 // TRANS: Text between [] is a link description, text between () is the link itself.
955 // TRANS: %s is the version of StatusNet that is being used.
956 $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);
957 $output = common_markup_to_html($instr);
959 $this->elementEnd('dd');
964 * Show content license.
968 function showContentLicense()
970 if (Event::handle('StartShowContentLicense', array($this))) {
971 // TRANS: DT element for StatusNet site content license.
972 $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
973 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
975 switch (common_config('license', 'type')) {
977 // TRANS: Content license displayed when license is set to 'private'.
978 // TRANS: %1$s is the site name.
979 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
980 common_config('site', 'name')));
982 case 'allrightsreserved':
983 if (common_config('license', 'owner')) {
984 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
985 // TRANS: %1$s is the copyright owner.
986 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
987 common_config('license', 'owner')));
989 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
990 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
993 case 'cc': // fall through
995 $this->elementStart('p');
997 $image = common_config('license', 'image');
998 $sslimage = common_config('license', 'sslimage');
1000 if (StatusNet::isHTTPS()) {
1001 if (!empty($sslimage)) {
1003 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1004 // CC support HTTPS on their images
1005 $url = preg_replace('/^http/', 'https', $image);
1007 // Better to show mixed content than no content
1014 $this->element('img', array('id' => 'license_cc',
1016 'alt' => common_config('license', 'title'),
1020 // TRANS: license message in footer.
1021 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1022 $notice = _('All %1$s content and data are available under the %2$s license.');
1023 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1024 htmlspecialchars(common_config('license', 'url')) .
1026 htmlspecialchars(common_config('license', 'title')) .
1028 $this->raw(sprintf(htmlspecialchars($notice),
1029 htmlspecialchars(common_config('site', 'name')),
1031 $this->elementEnd('p');
1035 $this->elementEnd('dd');
1036 Event::handle('EndShowContentLicense', array($this));
1041 * Return last modified, if applicable.
1045 * @return string last modified http header
1047 function lastModified()
1049 // For comparison with If-Last-Modified
1050 // If not applicable, return null
1055 * Return etag, if applicable.
1059 * @return string etag http header
1067 * Return true if read only.
1071 * @param array $args other arguments
1073 * @return boolean is read only action?
1075 function isReadOnly($args)
1081 * Returns query argument or default value if not found
1083 * @param string $key requested argument
1084 * @param string $def default value to return if $key is not provided
1086 * @return boolean is read only action?
1088 function arg($key, $def=null)
1090 if (array_key_exists($key, $this->args)) {
1091 return $this->args[$key];
1098 * Returns trimmed query argument or default value if not found
1100 * @param string $key requested argument
1101 * @param string $def default value to return if $key is not provided
1103 * @return boolean is read only action?
1105 function trimmed($key, $def=null)
1107 $arg = $this->arg($key, $def);
1108 return is_string($arg) ? trim($arg) : $arg;
1114 * @param array $argarray is ignored since it's now passed in in prepare()
1116 * @return boolean is read only action?
1118 function handle($argarray=null)
1120 header('Vary: Accept-Encoding,Cookie');
1122 $lm = $this->lastModified();
1123 $etag = $this->etag();
1126 header('ETag: ' . $etag);
1130 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1131 if ($this->isCacheable()) {
1132 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1133 header( "Cache-Control: private, must-revalidate, max-age=0" );
1140 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1141 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1142 if ($if_none_match) {
1143 // If this check fails, ignore the if-modified-since below.
1145 if ($this->_hasEtag($etag, $if_none_match)) {
1146 header('HTTP/1.1 304 Not Modified');
1147 // Better way to do this?
1153 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1154 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1155 $ims = strtotime($if_modified_since);
1157 header('HTTP/1.1 304 Not Modified');
1158 // Better way to do this?
1165 * Is this action cacheable?
1167 * If the action returns a last-modified
1169 * @param array $argarray is ignored since it's now passed in in prepare()
1171 * @return boolean is read only action?
1173 function isCacheable()
1179 * Has etag? (private)
1181 * @param string $etag etag http header
1182 * @param string $if_none_match ifNoneMatch http header
1186 function _hasEtag($etag, $if_none_match)
1188 $etags = explode(',', $if_none_match);
1189 return in_array($etag, $etags) || in_array('*', $etags);
1193 * Boolean understands english (yes, no, true, false)
1195 * @param string $key query key we're interested in
1196 * @param string $def default value
1198 * @return boolean interprets yes/no strings as boolean
1200 function boolean($key, $def=false)
1202 $arg = strtolower($this->trimmed($key));
1204 if (is_null($arg)) {
1206 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1208 } else if (in_array($arg, array('false', 'no', '0'))) {
1216 * Integer value of an argument
1218 * @param string $key query key we're interested in
1219 * @param string $defValue optional default value (default null)
1220 * @param string $maxValue optional max value (default null)
1221 * @param string $minValue optional min value (default null)
1223 * @return integer integer value
1225 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1227 $arg = strtolower($this->trimmed($key));
1229 if (is_null($arg) || !is_integer($arg)) {
1233 if (!is_null($maxValue)) {
1234 $arg = min($arg, $maxValue);
1237 if (!is_null($minValue)) {
1238 $arg = max($arg, $minValue);
1247 * @param string $msg error message to display
1248 * @param integer $code http error code, 500 by default
1252 function serverError($msg, $code=500)
1254 $action = $this->trimmed('action');
1255 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1256 throw new ServerException($msg, $code);
1262 * @param string $msg error message to display
1263 * @param integer $code http error code, 400 by default
1267 function clientError($msg, $code=400)
1269 $action = $this->trimmed('action');
1270 common_debug("User error '$code' on '$action': $msg", __FILE__);
1271 throw new ClientException($msg, $code);
1275 * Returns the current URL
1277 * @return string current URL
1281 list($action, $args) = $this->returnToArgs();
1282 return common_local_url($action, $args);
1286 * Returns arguments sufficient for re-constructing URL
1288 * @return array two elements: action, other args
1290 function returnToArgs()
1292 $action = $this->trimmed('action');
1293 $args = $this->args;
1294 unset($args['action']);
1295 if (common_config('site', 'fancy')) {
1298 if (array_key_exists('submit', $args)) {
1299 unset($args['submit']);
1301 foreach (array_keys($_COOKIE) as $cookie) {
1302 unset($args[$cookie]);
1304 return array($action, $args);
1308 * Generate a menu item
1310 * @param string $url menu URL
1311 * @param string $text menu name
1312 * @param string $title title attribute, null by default
1313 * @param boolean $is_selected current menu item, false by default
1314 * @param string $id element id, null by default
1318 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1320 // Added @id to li for some control.
1321 // XXX: We might want to move this to htmloutputter.php
1324 $lattrs['class'] = 'current';
1327 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1329 $this->elementStart('li', $lattrs);
1330 $attrs['href'] = $url;
1332 $attrs['title'] = $title;
1334 $this->element('a', $attrs, $text);
1335 $this->elementEnd('li');
1339 * Generate pagination links
1341 * @param boolean $have_before is there something before?
1342 * @param boolean $have_after is there something after?
1343 * @param integer $page current page
1344 * @param string $action current action
1345 * @param array $args rest of query arguments
1349 // XXX: The messages in this pagination method only tailor to navigating
1350 // notices. In other lists, "Previous"/"Next" type navigation is
1351 // desirable, but not available.
1352 function pagination($have_before, $have_after, $page, $action, $args=null)
1354 // Does a little before-after block for next/prev page
1355 if ($have_before || $have_after) {
1356 $this->elementStart('dl', 'pagination');
1357 // TRANS: DT element for pagination (previous/next, etc.).
1358 $this->element('dt', null, _('Pagination'));
1359 $this->elementStart('dd', null);
1360 $this->elementStart('ul', array('class' => 'nav'));
1363 $pargs = array('page' => $page-1);
1364 $this->elementStart('li', array('class' => 'nav_prev'));
1365 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1367 // TRANS: Pagination message to go to a page displaying information more in the
1368 // TRANS: present than the currently displayed information.
1370 $this->elementEnd('li');
1373 $pargs = array('page' => $page+1);
1374 $this->elementStart('li', array('class' => 'nav_next'));
1375 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1377 // TRANS: Pagination message to go to a page displaying information more in the
1378 // TRANS: past than the currently displayed information.
1380 $this->elementEnd('li');
1382 if ($have_before || $have_after) {
1383 $this->elementEnd('ul');
1384 $this->elementEnd('dd');
1385 $this->elementEnd('dl');
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');