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.min.js');
278 $this->script('jquery.cookie.min.js');
279 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/json2.min.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.min.js');
286 $this->showScriptMessages();
287 // Frame-busting code to avoid clickjacking attacks.
288 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
289 Event::handle('EndShowStatusNetScripts', array($this));
290 Event::handle('EndShowLaconicaScripts', array($this));
292 Event::handle('EndShowScripts', array($this));
297 * Exports a map of localized text strings to JavaScript code.
299 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
300 * events and appending to the array. Try to avoid adding strings that won't be used, as
301 * they'll be added to HTML output.
304 function showScriptMessages()
308 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
309 // Common messages needed for timeline views etc...
311 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
312 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
314 $messages = array_merge($messages, $this->getScriptMessages());
316 Event::handle('EndScriptMessages', array($this, &$messages));
319 if (!empty($messages)) {
320 $this->inlineScript('SN.messages=' . json_encode($messages));
327 * If the action will need localizable text strings, export them here like so:
329 * return array('pool_deepend' => _('Deep end'),
330 * 'pool_shallow' => _('Shallow end'));
332 * The exported map will be available via SN.msg() to JS code:
334 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
335 * $('#pool .deepend').text(SN.msg('pool_deepend'));
336 * $('#pool .shallow').text(SN.msg('pool_shallow'));
338 * Exports a map of localized text strings to JavaScript code.
340 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
341 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
342 * be used, as they'll be added to HTML output.
344 function getScriptMessages()
350 * Show OpenSearch headers
354 function showOpenSearch()
356 $this->element('link', array('rel' => 'search',
357 'type' => 'application/opensearchdescription+xml',
358 'href' => common_local_url('opensearch', array('type' => 'people')),
359 'title' => common_config('site', 'name').' People Search'));
360 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
361 'href' => common_local_url('opensearch', array('type' => 'notice')),
362 'title' => common_config('site', 'name').' Notice Search'));
374 $feeds = $this->getFeeds();
377 foreach ($feeds as $feed) {
378 $this->element('link', array('rel' => $feed->rel(),
379 'href' => $feed->url,
380 'type' => $feed->mimeType(),
381 'title' => $feed->title));
393 function showDescription()
395 // does nothing by default
399 * Show extra stuff in <head>.
407 // does nothing by default
413 * Calls template methods
419 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
420 'class' => 'user_in')
421 : array('id' => strtolower($this->trimmed('action'))));
422 $this->elementStart('div', array('id' => 'wrap'));
423 if (Event::handle('StartShowHeader', array($this))) {
425 Event::handle('EndShowHeader', array($this));
428 if (Event::handle('StartShowFooter', array($this))) {
430 Event::handle('EndShowFooter', array($this));
432 $this->elementEnd('div');
433 $this->showScripts();
434 $this->elementEnd('body');
438 * Show header of the page.
440 * Calls template methods
444 function showHeader()
446 $this->elementStart('div', array('id' => 'header'));
448 $this->showPrimaryNav();
449 if (Event::handle('StartShowSiteNotice', array($this))) {
450 $this->showSiteNotice();
452 Event::handle('EndShowSiteNotice', array($this));
454 if (common_logged_in()) {
455 if (Event::handle('StartShowNoticeForm', array($this))) {
456 $this->showNoticeForm();
457 Event::handle('EndShowNoticeForm', array($this));
460 $this->showAnonymousMessage();
462 $this->elementEnd('div');
466 * Show configured logo.
472 $this->elementStart('address', array('id' => 'site_contact',
473 'class' => 'vcard'));
474 if (Event::handle('StartAddressData', array($this))) {
475 if (common_config('singleuser', 'enabled')) {
476 $user = User::singleUser();
477 $url = common_local_url('showstream',
478 array('nickname' => $user->nickname));
480 $url = common_local_url('public');
482 $this->elementStart('a', array('class' => 'url home bookmark',
485 if (StatusNet::isHTTPS()) {
486 $logoUrl = common_config('site', 'ssllogo');
487 if (empty($logoUrl)) {
488 // if logo is an uploaded file, try to fall back to HTTPS file URL
489 $httpUrl = common_config('site', 'logo');
490 if (!empty($httpUrl)) {
491 $f = File::staticGet('url', $httpUrl);
492 if (!empty($f) && !empty($f->filename)) {
493 // this will handle the HTTPS case
494 $logoUrl = File::url($f->filename);
499 $logoUrl = common_config('site', 'logo');
502 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
503 // This should handle the HTTPS case internally
504 $logoUrl = Theme::path('logo.png');
507 if (!empty($logoUrl)) {
508 $this->element('img', array('class' => 'logo photo',
510 'alt' => common_config('site', 'name')));
514 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
515 $this->elementEnd('a');
516 Event::handle('EndAddressData', array($this));
518 $this->elementEnd('address');
522 * Show primary navigation.
526 function showPrimaryNav()
528 $user = common_current_user();
529 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
530 // TRANS: DT element for primary navigation menu. String is hidden in default CSS.
531 $this->element('dt', null, _('Primary site navigation'));
532 $this->elementStart('dd');
533 $this->elementStart('ul', array('class' => 'nav'));
534 if (Event::handle('StartPrimaryNav', array($this))) {
536 // TRANS: Tooltip for main menu option "Personal"
537 $tooltip = _m('TOOLTIP', 'Personal profile and friends timeline');
538 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
539 // TRANS: Main menu option when logged in for access to personal profile and friends timeline
540 _m('MENU', 'Personal'), $tooltip, false, 'nav_home');
541 // TRANS: Tooltip for main menu option "Account"
542 $tooltip = _m('TOOLTIP', 'Change your email, avatar, password, profile');
543 $this->menuItem(common_local_url('profilesettings'),
544 // TRANS: Main menu option when logged in for access to user settings
545 _('Account'), $tooltip, false, 'nav_account');
546 // TRANS: Tooltip for main menu option "Services"
547 $tooltip = _m('TOOLTIP', 'Connect to services');
548 $this->menuItem(common_local_url('oauthconnectionssettings'),
549 // TRANS: Main menu option when logged in and connection are possible for access to options to connect to other services
550 _('Connect'), $tooltip, false, 'nav_connect');
551 if ($user->hasRight(Right::CONFIGURESITE)) {
552 // TRANS: Tooltip for menu option "Admin"
553 $tooltip = _m('TOOLTIP', 'Change site configuration');
554 $this->menuItem(common_local_url('siteadminpanel'),
555 // TRANS: Main menu option when logged in and site admin for access to site configuration
556 _m('MENU', 'Admin'), $tooltip, false, 'nav_admin');
558 if (common_config('invite', 'enabled')) {
559 // TRANS: Tooltip for main menu option "Invite"
560 $tooltip = _m('TOOLTIP', 'Invite friends and colleagues to join you on %s');
561 $this->menuItem(common_local_url('invite'),
562 // TRANS: Main menu option when logged in and invitations are allowed for inviting new users
563 _m('MENU', 'Invite'),
565 common_config('site', 'name')),
566 false, 'nav_invitecontact');
568 // TRANS: Tooltip for main menu option "Logout"
569 $tooltip = _m('TOOLTIP', 'Logout from the site');
570 $this->menuItem(common_local_url('logout'),
571 // TRANS: Main menu option when logged in to log out the current user
572 _m('MENU', 'Logout'), $tooltip, false, 'nav_logout');
575 if (!common_config('site', 'closed') && !common_config('site', 'inviteonly')) {
576 // TRANS: Tooltip for main menu option "Register"
577 $tooltip = _m('TOOLTIP', 'Create an account');
578 $this->menuItem(common_local_url('register'),
579 // TRANS: Main menu option when not logged in to register a new account
580 _m('MENU', 'Register'), $tooltip, false, 'nav_register');
582 // TRANS: Tooltip for main menu option "Login"
583 $tooltip = _m('TOOLTIP', 'Login to the site');
584 $this->menuItem(common_local_url('login'),
585 // TRANS: Main menu option when not logged in to log in
586 _m('MENU', 'Login'), $tooltip, false, 'nav_login');
588 // TRANS: Tooltip for main menu option "Help"
589 $tooltip = _m('TOOLTIP', 'Help me!');
590 $this->menuItem(common_local_url('doc', array('title' => 'help')),
591 // TRANS: Main menu option for help on the StatusNet site
592 _m('MENU', 'Help'), $tooltip, false, 'nav_help');
593 if ($user || !common_config('site', 'private')) {
594 // TRANS: Tooltip for main menu option "Search"
595 $tooltip = _m('TOOLTIP', 'Search for people or text');
596 $this->menuItem(common_local_url('peoplesearch'),
597 // TRANS: Main menu option when logged in or when the StatusNet instance is not private
598 _m('MENU', 'Search'), $tooltip, false, 'nav_search');
600 Event::handle('EndPrimaryNav', array($this));
602 $this->elementEnd('ul');
603 $this->elementEnd('dd');
604 $this->elementEnd('dl');
612 function showSiteNotice()
614 // Revist. Should probably do an hAtom pattern here
615 $text = common_config('site', 'notice');
617 $this->elementStart('dl', array('id' => 'site_notice',
618 'class' => 'system_notice'));
619 // TRANS: DT element for site notice. String is hidden in default CSS.
620 $this->element('dt', null, _('Site notice'));
621 $this->elementStart('dd', null);
623 $this->elementEnd('dd');
624 $this->elementEnd('dl');
631 * MAY overload if no notice form needed... or direct message box????
635 function showNoticeForm()
637 $notice_form = new NoticeForm($this);
638 $notice_form->show();
642 * Show anonymous message.
648 function showAnonymousMessage()
650 // needs to be defined by the class
656 * Shows local navigation, content block and aside.
662 $this->elementStart('div', array('id' => 'core'));
663 if (Event::handle('StartShowLocalNavBlock', array($this))) {
664 $this->showLocalNavBlock();
665 Event::handle('EndShowLocalNavBlock', array($this));
667 if (Event::handle('StartShowContentBlock', array($this))) {
668 $this->showContentBlock();
669 Event::handle('EndShowContentBlock', array($this));
671 if (Event::handle('StartShowAside', array($this))) {
673 Event::handle('EndShowAside', array($this));
675 $this->elementEnd('div');
679 * Show local navigation block.
683 function showLocalNavBlock()
685 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
686 // TRANS: DT element for local views block. String is hidden in default CSS.
687 $this->element('dt', null, _('Local views'));
688 $this->elementStart('dd');
689 $this->showLocalNav();
690 $this->elementEnd('dd');
691 $this->elementEnd('dl');
695 * Show local navigation.
701 function showLocalNav()
703 // does nothing by default
707 * Show content block.
711 function showContentBlock()
713 $this->elementStart('div', array('id' => 'content'));
714 if (Event::handle('StartShowPageTitle', array($this))) {
715 $this->showPageTitle();
716 Event::handle('EndShowPageTitle', array($this));
718 $this->showPageNoticeBlock();
719 $this->elementStart('div', array('id' => 'content_inner'));
720 // show the actual content (forms, lists, whatever)
721 $this->showContent();
722 $this->elementEnd('div');
723 $this->elementEnd('div');
731 function showPageTitle()
733 $this->element('h1', null, $this->title());
737 * Show page notice block.
739 * Only show the block if a subclassed action has overrided
740 * Action::showPageNotice(), or an event handler is registered for
741 * the StartShowPageNotice event, in which case we assume the
742 * 'page_notice' definition list is desired. This is to prevent
743 * empty 'page_notice' definition lists from being output everywhere.
747 function showPageNoticeBlock()
749 $rmethod = new ReflectionMethod($this, 'showPageNotice');
750 $dclass = $rmethod->getDeclaringClass()->getName();
752 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
754 $this->elementStart('dl', array('id' => 'page_notice',
755 'class' => 'system_notice'));
756 // TRANS: DT element for page notice. String is hidden in default CSS.
757 $this->element('dt', null, _('Page notice'));
758 $this->elementStart('dd');
759 if (Event::handle('StartShowPageNotice', array($this))) {
760 $this->showPageNotice();
761 Event::handle('EndShowPageNotice', array($this));
763 $this->elementEnd('dd');
764 $this->elementEnd('dl');
771 * SHOULD overload (unless there's not a notice)
775 function showPageNotice()
782 * MUST overload (unless there's not a notice)
786 function showContent()
797 $this->elementStart('div', array('id' => 'aside_primary',
798 'class' => 'aside'));
799 if (Event::handle('StartShowSections', array($this))) {
800 $this->showSections();
801 Event::handle('EndShowSections', array($this));
803 if (Event::handle('StartShowExportData', array($this))) {
804 $this->showExportData();
805 Event::handle('EndShowExportData', array($this));
807 $this->elementEnd('div');
811 * Show export data feeds.
815 function showExportData()
817 $feeds = $this->getFeeds();
819 $fl = new FeedList($this);
831 function showSections()
833 // for each section, show it
841 function showFooter()
843 $this->elementStart('div', array('id' => 'footer'));
844 $this->showSecondaryNav();
845 $this->showLicenses();
846 $this->elementEnd('div');
850 * Show secondary navigation.
854 function showSecondaryNav()
856 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
857 // TRANS: DT element for secondary navigation menu. String is hidden in default CSS.
858 $this->element('dt', null, _('Secondary site navigation'));
859 $this->elementStart('dd', null);
860 $this->elementStart('ul', array('class' => 'nav'));
861 if (Event::handle('StartSecondaryNav', array($this))) {
862 $this->menuItem(common_local_url('doc', array('title' => 'help')),
863 // TRANS: Secondary navigation menu option leading to help on StatusNet.
865 $this->menuItem(common_local_url('doc', array('title' => 'about')),
866 // TRANS: Secondary navigation menu option leading to text about StatusNet site.
868 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
869 // TRANS: Secondary navigation menu option leading to Frequently Asked Questions.
871 $bb = common_config('site', 'broughtby');
873 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
874 // TRANS: Secondary navigation menu option leading to Terms of Service.
877 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
878 // TRANS: Secondary navigation menu option leading to privacy policy.
880 $this->menuItem(common_local_url('doc', array('title' => 'source')),
881 // TRANS: Secondary navigation menu option. Leads to information about StatusNet and its license.
883 $this->menuItem(common_local_url('version'),
884 // TRANS: Secondary navigation menu option leading to version information on the StatusNet site.
886 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
887 // TRANS: Secondary navigation menu option leading to e-mail contact information on the
888 // TRANS: StatusNet site, where to report bugs, ...
890 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
891 // TRANS: Secondary navigation menu option. Leads to information about embedding a timeline widget.
893 Event::handle('EndSecondaryNav', array($this));
895 $this->elementEnd('ul');
896 $this->elementEnd('dd');
897 $this->elementEnd('dl');
905 function showLicenses()
907 $this->elementStart('dl', array('id' => 'licenses'));
908 $this->showStatusNetLicense();
909 $this->showContentLicense();
910 $this->elementEnd('dl');
914 * Show StatusNet license.
918 function showStatusNetLicense()
920 // TRANS: DT element for StatusNet software license.
921 $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
922 $this->elementStart('dd', null);
923 if (common_config('site', 'broughtby')) {
924 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
925 // TRANS: Text between [] is a link description, text between () is the link itself.
926 // TRANS: Make sure there is no whitespace between "]" and "(".
927 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
928 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
930 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
931 $instr = _('**%%site.name%%** is a microblogging service.');
934 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
935 // TRANS: Make sure there is no whitespace between "]" and "(".
936 // TRANS: Text between [] is a link description, text between () is the link itself.
937 // TRANS: %s is the version of StatusNet that is being used.
938 $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);
939 $output = common_markup_to_html($instr);
941 $this->elementEnd('dd');
946 * Show content license.
950 function showContentLicense()
952 if (Event::handle('StartShowContentLicense', array($this))) {
953 // TRANS: DT element for StatusNet site content license.
954 $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
955 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
957 switch (common_config('license', 'type')) {
959 // TRANS: Content license displayed when license is set to 'private'.
960 // TRANS: %1$s is the site name.
961 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
962 common_config('site', 'name')));
964 case 'allrightsreserved':
965 if (common_config('license', 'owner')) {
966 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
967 // TRANS: %1$s is the copyright owner.
968 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
969 common_config('license', 'owner')));
971 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
972 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
975 case 'cc': // fall through
977 $this->elementStart('p');
979 $image = common_config('license', 'image');
980 $sslimage = common_config('license', 'sslimage');
982 if (StatusNet::isHTTPS()) {
983 if (!empty($sslimage)) {
985 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
986 // CC support HTTPS on their images
987 $url = preg_replace('/^http/', 'https', $image);
989 // Better to show mixed content than no content
996 $this->element('img', array('id' => 'license_cc',
998 'alt' => common_config('license', 'title'),
1002 // TRANS: license message in footer.
1003 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1004 $notice = _('All %1$s content and data are available under the %2$s license.');
1005 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1006 htmlspecialchars(common_config('license', 'url')) .
1008 htmlspecialchars(common_config('license', 'title')) .
1010 $this->raw(sprintf(htmlspecialchars($notice),
1011 htmlspecialchars(common_config('site', 'name')),
1013 $this->elementEnd('p');
1017 $this->elementEnd('dd');
1018 Event::handle('EndShowContentLicense', array($this));
1023 * Return last modified, if applicable.
1027 * @return string last modified http header
1029 function lastModified()
1031 // For comparison with If-Last-Modified
1032 // If not applicable, return null
1037 * Return etag, if applicable.
1041 * @return string etag http header
1049 * Return true if read only.
1053 * @param array $args other arguments
1055 * @return boolean is read only action?
1057 function isReadOnly($args)
1063 * Returns query argument or default value if not found
1065 * @param string $key requested argument
1066 * @param string $def default value to return if $key is not provided
1068 * @return boolean is read only action?
1070 function arg($key, $def=null)
1072 if (array_key_exists($key, $this->args)) {
1073 return $this->args[$key];
1080 * Returns trimmed query argument or default value if not found
1082 * @param string $key requested argument
1083 * @param string $def default value to return if $key is not provided
1085 * @return boolean is read only action?
1087 function trimmed($key, $def=null)
1089 $arg = $this->arg($key, $def);
1090 return is_string($arg) ? trim($arg) : $arg;
1096 * @param array $argarray is ignored since it's now passed in in prepare()
1098 * @return boolean is read only action?
1100 function handle($argarray=null)
1102 header('Vary: Accept-Encoding,Cookie');
1104 $lm = $this->lastModified();
1105 $etag = $this->etag();
1108 header('ETag: ' . $etag);
1112 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1113 if ($this->isCacheable()) {
1114 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1115 header( "Cache-Control: private, must-revalidate, max-age=0" );
1122 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1123 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1124 if ($if_none_match) {
1125 // If this check fails, ignore the if-modified-since below.
1127 if ($this->_hasEtag($etag, $if_none_match)) {
1128 header('HTTP/1.1 304 Not Modified');
1129 // Better way to do this?
1135 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1136 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1137 $ims = strtotime($if_modified_since);
1139 header('HTTP/1.1 304 Not Modified');
1140 // Better way to do this?
1147 * Is this action cacheable?
1149 * If the action returns a last-modified
1151 * @param array $argarray is ignored since it's now passed in in prepare()
1153 * @return boolean is read only action?
1155 function isCacheable()
1161 * Has etag? (private)
1163 * @param string $etag etag http header
1164 * @param string $if_none_match ifNoneMatch http header
1168 function _hasEtag($etag, $if_none_match)
1170 $etags = explode(',', $if_none_match);
1171 return in_array($etag, $etags) || in_array('*', $etags);
1175 * Boolean understands english (yes, no, true, false)
1177 * @param string $key query key we're interested in
1178 * @param string $def default value
1180 * @return boolean interprets yes/no strings as boolean
1182 function boolean($key, $def=false)
1184 $arg = strtolower($this->trimmed($key));
1186 if (is_null($arg)) {
1188 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1190 } else if (in_array($arg, array('false', 'no', '0'))) {
1198 * Integer value of an argument
1200 * @param string $key query key we're interested in
1201 * @param string $defValue optional default value (default null)
1202 * @param string $maxValue optional max value (default null)
1203 * @param string $minValue optional min value (default null)
1205 * @return integer integer value
1207 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1209 $arg = strtolower($this->trimmed($key));
1211 if (is_null($arg) || !is_integer($arg)) {
1215 if (!is_null($maxValue)) {
1216 $arg = min($arg, $maxValue);
1219 if (!is_null($minValue)) {
1220 $arg = max($arg, $minValue);
1229 * @param string $msg error message to display
1230 * @param integer $code http error code, 500 by default
1234 function serverError($msg, $code=500)
1236 $action = $this->trimmed('action');
1237 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1238 throw new ServerException($msg, $code);
1244 * @param string $msg error message to display
1245 * @param integer $code http error code, 400 by default
1249 function clientError($msg, $code=400)
1251 $action = $this->trimmed('action');
1252 common_debug("User error '$code' on '$action': $msg", __FILE__);
1253 throw new ClientException($msg, $code);
1257 * Returns the current URL
1259 * @return string current URL
1263 list($action, $args) = $this->returnToArgs();
1264 return common_local_url($action, $args);
1268 * Returns arguments sufficient for re-constructing URL
1270 * @return array two elements: action, other args
1272 function returnToArgs()
1274 $action = $this->trimmed('action');
1275 $args = $this->args;
1276 unset($args['action']);
1277 if (common_config('site', 'fancy')) {
1280 if (array_key_exists('submit', $args)) {
1281 unset($args['submit']);
1283 foreach (array_keys($_COOKIE) as $cookie) {
1284 unset($args[$cookie]);
1286 return array($action, $args);
1290 * Generate a menu item
1292 * @param string $url menu URL
1293 * @param string $text menu name
1294 * @param string $title title attribute, null by default
1295 * @param boolean $is_selected current menu item, false by default
1296 * @param string $id element id, null by default
1300 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1302 // Added @id to li for some control.
1303 // XXX: We might want to move this to htmloutputter.php
1306 $lattrs['class'] = 'current';
1309 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1311 $this->elementStart('li', $lattrs);
1312 $attrs['href'] = $url;
1314 $attrs['title'] = $title;
1316 $this->element('a', $attrs, $text);
1317 $this->elementEnd('li');
1321 * Generate pagination links
1323 * @param boolean $have_before is there something before?
1324 * @param boolean $have_after is there something after?
1325 * @param integer $page current page
1326 * @param string $action current action
1327 * @param array $args rest of query arguments
1331 // XXX: The messages in this pagination method only tailor to navigating
1332 // notices. In other lists, "Previous"/"Next" type navigation is
1333 // desirable, but not available.
1334 function pagination($have_before, $have_after, $page, $action, $args=null)
1336 // Does a little before-after block for next/prev page
1337 if ($have_before || $have_after) {
1338 $this->elementStart('dl', 'pagination');
1339 // TRANS: DT element for pagination (previous/next, etc.).
1340 $this->element('dt', null, _('Pagination'));
1341 $this->elementStart('dd', null);
1342 $this->elementStart('ul', array('class' => 'nav'));
1345 $pargs = array('page' => $page-1);
1346 $this->elementStart('li', array('class' => 'nav_prev'));
1347 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1349 // TRANS: Pagination message to go to a page displaying information more in the
1350 // TRANS: present than the currently displayed information.
1352 $this->elementEnd('li');
1355 $pargs = array('page' => $page+1);
1356 $this->elementStart('li', array('class' => 'nav_next'));
1357 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1359 // TRANS: Pagination message to go to a page displaying information more in the
1360 // TRANS: past than the currently displayed information.
1362 $this->elementEnd('li');
1364 if ($have_before || $have_after) {
1365 $this->elementEnd('ul');
1366 $this->elementEnd('dd');
1367 $this->elementEnd('dl');
1372 * An array of feeds for this action.
1374 * Returns an array of potential feeds for this action.
1376 * @return array Feed object to show in head and links
1384 * A design for this action
1386 * @return Design a design object to use
1388 function getDesign()
1390 return Design::siteDesign();
1394 * Check the session token.
1396 * Checks that the current form has the correct session token,
1397 * and throw an exception if it does not.
1401 // XXX: Finding this type of check with the same message about 50 times.
1402 // Possible to refactor?
1403 function checkSessionToken()
1406 $token = $this->trimmed('token');
1407 if (empty($token) || $token != common_session_token()) {
1408 // TRANS: Client error text when there is a problem with the session token.
1409 $this->clientError(_('There was a problem with your session token.'));
1414 * Check if the current request is a POST
1416 * @return boolean true if POST; otherwise false.
1421 return ($_SERVER['REQUEST_METHOD'] == 'POST');