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 $this->inlineScript('if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
302 Event::handle('EndShowStatusNetScripts', array($this));
303 Event::handle('EndShowLaconicaScripts', array($this));
305 Event::handle('EndShowScripts', array($this));
310 * Exports a map of localized text strings to JavaScript code.
312 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
313 * events and appending to the array. Try to avoid adding strings that won't be used, as
314 * they'll be added to HTML output.
317 function showScriptMessages()
321 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
322 // Common messages needed for timeline views etc...
324 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
325 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
327 $messages = array_merge($messages, $this->getScriptMessages());
329 Event::handle('EndScriptMessages', array($this, &$messages));
332 if (!empty($messages)) {
333 $this->inlineScript('SN.messages=' . json_encode($messages));
340 * If the action will need localizable text strings, export them here like so:
342 * return array('pool_deepend' => _('Deep end'),
343 * 'pool_shallow' => _('Shallow end'));
345 * The exported map will be available via SN.msg() to JS code:
347 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
348 * $('#pool .deepend').text(SN.msg('pool_deepend'));
349 * $('#pool .shallow').text(SN.msg('pool_shallow'));
351 * Exports a map of localized text strings to JavaScript code.
353 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
354 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
355 * be used, as they'll be added to HTML output.
357 function getScriptMessages()
363 * Show OpenSearch headers
367 function showOpenSearch()
369 $this->element('link', array('rel' => 'search',
370 'type' => 'application/opensearchdescription+xml',
371 'href' => common_local_url('opensearch', array('type' => 'people')),
372 'title' => common_config('site', 'name').' People Search'));
373 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
374 'href' => common_local_url('opensearch', array('type' => 'notice')),
375 'title' => common_config('site', 'name').' Notice Search'));
387 $feeds = $this->getFeeds();
390 foreach ($feeds as $feed) {
391 $this->element('link', array('rel' => $feed->rel(),
392 'href' => $feed->url,
393 'type' => $feed->mimeType(),
394 'title' => $feed->title));
406 function showDescription()
408 // does nothing by default
412 * Show extra stuff in <head>.
420 // does nothing by default
426 * Calls template methods
432 $this->elementStart('body', (common_current_user()) ? array('id' => strtolower($this->trimmed('action')),
433 'class' => 'user_in')
434 : array('id' => strtolower($this->trimmed('action'))));
435 $this->elementStart('div', array('id' => 'wrap'));
436 if (Event::handle('StartShowHeader', array($this))) {
438 Event::handle('EndShowHeader', array($this));
441 if (Event::handle('StartShowFooter', array($this))) {
443 Event::handle('EndShowFooter', array($this));
445 $this->elementEnd('div');
446 $this->showScripts();
447 $this->elementEnd('body');
451 * Show header of the page.
453 * Calls template methods
457 function showHeader()
459 $this->elementStart('div', array('id' => 'header'));
461 $this->showPrimaryNav();
462 if (Event::handle('StartShowSiteNotice', array($this))) {
463 $this->showSiteNotice();
465 Event::handle('EndShowSiteNotice', array($this));
467 if (common_logged_in()) {
468 if (Event::handle('StartShowNoticeForm', array($this))) {
469 $this->showNoticeForm();
470 Event::handle('EndShowNoticeForm', array($this));
473 $this->showAnonymousMessage();
475 $this->elementEnd('div');
479 * Show configured logo.
485 $this->elementStart('address', array('id' => 'site_contact',
486 'class' => 'vcard'));
487 if (Event::handle('StartAddressData', array($this))) {
488 if (common_config('singleuser', 'enabled')) {
489 $user = User::singleUser();
490 $url = common_local_url('showstream',
491 array('nickname' => $user->nickname));
493 $url = common_local_url('public');
495 $this->elementStart('a', array('class' => 'url home bookmark',
498 if (StatusNet::isHTTPS()) {
499 $logoUrl = common_config('site', 'ssllogo');
500 if (empty($logoUrl)) {
501 // if logo is an uploaded file, try to fall back to HTTPS file URL
502 $httpUrl = common_config('site', 'logo');
503 if (!empty($httpUrl)) {
504 $f = File::staticGet('url', $httpUrl);
505 if (!empty($f) && !empty($f->filename)) {
506 // this will handle the HTTPS case
507 $logoUrl = File::url($f->filename);
512 $logoUrl = common_config('site', 'logo');
515 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
516 // This should handle the HTTPS case internally
517 $logoUrl = Theme::path('logo.png');
520 if (!empty($logoUrl)) {
521 $this->element('img', array('class' => 'logo photo',
523 'alt' => common_config('site', 'name')));
527 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
528 $this->elementEnd('a');
529 Event::handle('EndAddressData', array($this));
531 $this->elementEnd('address');
535 * Show primary navigation.
539 function showPrimaryNav()
541 $user = common_current_user();
542 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
543 // TRANS: DT element for primary navigation menu. String is hidden in default CSS.
544 $this->element('dt', null, _('Primary site navigation'));
545 $this->elementStart('dd');
546 $this->elementStart('ul', array('class' => 'nav'));
547 if (Event::handle('StartPrimaryNav', array($this))) {
549 // TRANS: Tooltip for main menu option "Personal".
550 $tooltip = _m('TOOLTIP', 'Personal profile and friends timeline');
551 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
552 // TRANS: Main menu option when logged in for access to personal profile and friends timeline.
553 _m('MENU', 'Personal'), $tooltip, false, 'nav_home');
554 // TRANS: Tooltip for main menu option "Account".
555 $tooltip = _m('TOOLTIP', 'Change your email, avatar, password, profile');
556 $this->menuItem(common_local_url('profilesettings'),
557 // TRANS: Main menu option when logged in for access to user settings.
558 _('Account'), $tooltip, false, 'nav_account');
559 // TRANS: Tooltip for main menu option "Services".
560 $tooltip = _m('TOOLTIP', 'Connect to services');
561 $this->menuItem(common_local_url('oauthconnectionssettings'),
562 // TRANS: Main menu option when logged in and connection are possible for access to options to connect to other services.
563 _('Connect'), $tooltip, false, 'nav_connect');
564 if ($user->hasRight(Right::CONFIGURESITE)) {
565 // TRANS: Tooltip for menu option "Admin".
566 $tooltip = _m('TOOLTIP', 'Change site configuration');
567 $this->menuItem(common_local_url('siteadminpanel'),
568 // TRANS: Main menu option when logged in and site admin for access to site configuration.
569 _m('MENU', 'Admin'), $tooltip, false, 'nav_admin');
571 if (common_config('invite', 'enabled')) {
572 // TRANS: Tooltip for main menu option "Invite".
573 $tooltip = _m('TOOLTIP', 'Invite friends and colleagues to join you on %s');
574 $this->menuItem(common_local_url('invite'),
575 // TRANS: Main menu option when logged in and invitations are allowed for inviting new users.
576 _m('MENU', 'Invite'),
578 common_config('site', 'name')),
579 false, 'nav_invitecontact');
581 // TRANS: Tooltip for main menu option "Logout"
582 $tooltip = _m('TOOLTIP', 'Logout from the site');
583 $this->menuItem(common_local_url('logout'),
584 // TRANS: Main menu option when logged in to log out the current user.
585 _m('MENU', 'Logout'), $tooltip, false, 'nav_logout');
588 if (!common_config('site', 'closed') && !common_config('site', 'inviteonly')) {
589 // TRANS: Tooltip for main menu option "Register".
590 $tooltip = _m('TOOLTIP', 'Create an account');
591 $this->menuItem(common_local_url('register'),
592 // TRANS: Main menu option when not logged in to register a new account.
593 _m('MENU', 'Register'), $tooltip, false, 'nav_register');
595 // TRANS: Tooltip for main menu option "Login".
596 $tooltip = _m('TOOLTIP', 'Login to the site');
597 $this->menuItem(common_local_url('login'),
598 // TRANS: Main menu option when not logged in to log in.
599 _m('MENU', 'Login'), $tooltip, false, 'nav_login');
601 // TRANS: Tooltip for main menu option "Help".
602 $tooltip = _m('TOOLTIP', 'Help me!');
603 $this->menuItem(common_local_url('doc', array('title' => 'help')),
604 // TRANS: Main menu option for help on the StatusNet site.
605 _m('MENU', 'Help'), $tooltip, false, 'nav_help');
606 if ($user || !common_config('site', 'private')) {
607 // TRANS: Tooltip for main menu option "Search".
608 $tooltip = _m('TOOLTIP', 'Search for people or text');
609 $this->menuItem(common_local_url('peoplesearch'),
610 // TRANS: Main menu option when logged in or when the StatusNet instance is not private.
611 _m('MENU', 'Search'), $tooltip, false, 'nav_search');
613 Event::handle('EndPrimaryNav', array($this));
615 $this->elementEnd('ul');
616 $this->elementEnd('dd');
617 $this->elementEnd('dl');
625 function showSiteNotice()
627 // Revist. Should probably do an hAtom pattern here
628 $text = common_config('site', 'notice');
630 $this->elementStart('dl', array('id' => 'site_notice',
631 'class' => 'system_notice'));
632 // TRANS: DT element for site notice. String is hidden in default CSS.
633 $this->element('dt', null, _('Site notice'));
634 $this->elementStart('dd', null);
636 $this->elementEnd('dd');
637 $this->elementEnd('dl');
644 * MAY overload if no notice form needed... or direct message box????
648 function showNoticeForm()
650 $notice_form = new NoticeForm($this);
651 $notice_form->show();
655 * Show anonymous message.
661 function showAnonymousMessage()
663 // needs to be defined by the class
669 * Shows local navigation, content block and aside.
675 $this->elementStart('div', array('id' => 'core'));
676 if (Event::handle('StartShowLocalNavBlock', array($this))) {
677 $this->showLocalNavBlock();
678 Event::handle('EndShowLocalNavBlock', array($this));
680 if (Event::handle('StartShowContentBlock', array($this))) {
681 $this->showContentBlock();
682 Event::handle('EndShowContentBlock', array($this));
684 if (Event::handle('StartShowAside', array($this))) {
686 Event::handle('EndShowAside', array($this));
688 $this->elementEnd('div');
692 * Show local navigation block.
696 function showLocalNavBlock()
698 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
699 // TRANS: DT element for local views block. String is hidden in default CSS.
700 $this->element('dt', null, _('Local views'));
701 $this->elementStart('dd');
702 $this->showLocalNav();
703 $this->elementEnd('dd');
704 $this->elementEnd('dl');
708 * Show local navigation.
714 function showLocalNav()
716 // does nothing by default
720 * Show content block.
724 function showContentBlock()
726 $this->elementStart('div', array('id' => 'content'));
727 if (Event::handle('StartShowPageTitle', array($this))) {
728 $this->showPageTitle();
729 Event::handle('EndShowPageTitle', array($this));
731 $this->showPageNoticeBlock();
732 $this->elementStart('div', array('id' => 'content_inner'));
733 // show the actual content (forms, lists, whatever)
734 $this->showContent();
735 $this->elementEnd('div');
736 $this->elementEnd('div');
744 function showPageTitle()
746 $this->element('h1', null, $this->title());
750 * Show page notice block.
752 * Only show the block if a subclassed action has overrided
753 * Action::showPageNotice(), or an event handler is registered for
754 * the StartShowPageNotice event, in which case we assume the
755 * 'page_notice' definition list is desired. This is to prevent
756 * empty 'page_notice' definition lists from being output everywhere.
760 function showPageNoticeBlock()
762 $rmethod = new ReflectionMethod($this, 'showPageNotice');
763 $dclass = $rmethod->getDeclaringClass()->getName();
765 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
767 $this->elementStart('dl', array('id' => 'page_notice',
768 'class' => 'system_notice'));
769 // TRANS: DT element for page notice. String is hidden in default CSS.
770 $this->element('dt', null, _('Page notice'));
771 $this->elementStart('dd');
772 if (Event::handle('StartShowPageNotice', array($this))) {
773 $this->showPageNotice();
774 Event::handle('EndShowPageNotice', array($this));
776 $this->elementEnd('dd');
777 $this->elementEnd('dl');
784 * SHOULD overload (unless there's not a notice)
788 function showPageNotice()
795 * MUST overload (unless there's not a notice)
799 function showContent()
810 $this->elementStart('div', array('id' => 'aside_primary',
811 'class' => 'aside'));
812 if (Event::handle('StartShowSections', array($this))) {
813 $this->showSections();
814 Event::handle('EndShowSections', array($this));
816 if (Event::handle('StartShowExportData', array($this))) {
817 $this->showExportData();
818 Event::handle('EndShowExportData', array($this));
820 $this->elementEnd('div');
824 * Show export data feeds.
828 function showExportData()
830 $feeds = $this->getFeeds();
832 $fl = new FeedList($this);
844 function showSections()
846 // for each section, show it
854 function showFooter()
856 $this->elementStart('div', array('id' => 'footer'));
857 if (Event::handle('StartShowInsideFooter', array($this))) {
858 $this->showSecondaryNav();
859 $this->showLicenses();
860 Event::handle('EndShowInsideFooter', array($this));
862 $this->elementEnd('div');
866 * Show secondary navigation.
870 function showSecondaryNav()
872 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
873 // TRANS: DT element for secondary navigation menu. String is hidden in default CSS.
874 $this->element('dt', null, _('Secondary site navigation'));
875 $this->elementStart('dd', null);
876 $this->elementStart('ul', array('class' => 'nav'));
877 if (Event::handle('StartSecondaryNav', array($this))) {
878 $this->menuItem(common_local_url('doc', array('title' => 'help')),
879 // TRANS: Secondary navigation menu option leading to help on StatusNet.
881 $this->menuItem(common_local_url('doc', array('title' => 'about')),
882 // TRANS: Secondary navigation menu option leading to text about StatusNet site.
884 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
885 // TRANS: Secondary navigation menu option leading to Frequently Asked Questions.
887 $bb = common_config('site', 'broughtby');
889 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
890 // TRANS: Secondary navigation menu option leading to Terms of Service.
893 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
894 // TRANS: Secondary navigation menu option leading to privacy policy.
896 $this->menuItem(common_local_url('doc', array('title' => 'source')),
897 // TRANS: Secondary navigation menu option. Leads to information about StatusNet and its license.
899 $this->menuItem(common_local_url('version'),
900 // TRANS: Secondary navigation menu option leading to version information on the StatusNet site.
902 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
903 // TRANS: Secondary navigation menu option leading to e-mail contact information on the
904 // TRANS: StatusNet site, where to report bugs, ...
906 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
907 // TRANS: Secondary navigation menu option. Leads to information about embedding a timeline widget.
909 Event::handle('EndSecondaryNav', array($this));
911 $this->elementEnd('ul');
912 $this->elementEnd('dd');
913 $this->elementEnd('dl');
921 function showLicenses()
923 $this->elementStart('dl', array('id' => 'licenses'));
924 $this->showStatusNetLicense();
925 $this->showContentLicense();
926 $this->elementEnd('dl');
930 * Show StatusNet license.
934 function showStatusNetLicense()
936 // TRANS: DT element for StatusNet software license.
937 $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
938 $this->elementStart('dd', null);
939 if (common_config('site', 'broughtby')) {
940 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is set.
941 // TRANS: Text between [] is a link description, text between () is the link itself.
942 // TRANS: Make sure there is no whitespace between "]" and "(".
943 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
944 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%).');
946 // TRANS: First sentence of the StatusNet site license. Used if 'broughtby' is not set.
947 $instr = _('**%%site.name%%** is a microblogging service.');
950 // TRANS: Second sentence of the StatusNet site license. Mentions the StatusNet source code license.
951 // TRANS: Make sure there is no whitespace between "]" and "(".
952 // TRANS: Text between [] is a link description, text between () is the link itself.
953 // TRANS: %s is the version of StatusNet that is being used.
954 $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);
955 $output = common_markup_to_html($instr);
957 $this->elementEnd('dd');
962 * Show content license.
966 function showContentLicense()
968 if (Event::handle('StartShowContentLicense', array($this))) {
969 // TRANS: DT element for StatusNet site content license.
970 $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
971 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
973 switch (common_config('license', 'type')) {
975 // TRANS: Content license displayed when license is set to 'private'.
976 // TRANS: %1$s is the site name.
977 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
978 common_config('site', 'name')));
980 case 'allrightsreserved':
981 if (common_config('license', 'owner')) {
982 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
983 // TRANS: %1$s is the copyright owner.
984 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
985 common_config('license', 'owner')));
987 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
988 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
991 case 'cc': // fall through
993 $this->elementStart('p');
995 $image = common_config('license', 'image');
996 $sslimage = common_config('license', 'sslimage');
998 if (StatusNet::isHTTPS()) {
999 if (!empty($sslimage)) {
1001 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1002 // CC support HTTPS on their images
1003 $url = preg_replace('/^http/', 'https', $image);
1005 // Better to show mixed content than no content
1012 $this->element('img', array('id' => 'license_cc',
1014 'alt' => common_config('license', 'title'),
1018 // TRANS: license message in footer.
1019 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1020 $notice = _('All %1$s content and data are available under the %2$s license.');
1021 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1022 htmlspecialchars(common_config('license', 'url')) .
1024 htmlspecialchars(common_config('license', 'title')) .
1026 $this->raw(sprintf(htmlspecialchars($notice),
1027 htmlspecialchars(common_config('site', 'name')),
1029 $this->elementEnd('p');
1033 $this->elementEnd('dd');
1034 Event::handle('EndShowContentLicense', array($this));
1039 * Return last modified, if applicable.
1043 * @return string last modified http header
1045 function lastModified()
1047 // For comparison with If-Last-Modified
1048 // If not applicable, return null
1053 * Return etag, if applicable.
1057 * @return string etag http header
1065 * Return true if read only.
1069 * @param array $args other arguments
1071 * @return boolean is read only action?
1073 function isReadOnly($args)
1079 * Returns query argument or default value if not found
1081 * @param string $key requested argument
1082 * @param string $def default value to return if $key is not provided
1084 * @return boolean is read only action?
1086 function arg($key, $def=null)
1088 if (array_key_exists($key, $this->args)) {
1089 return $this->args[$key];
1096 * Returns trimmed query argument or default value if not found
1098 * @param string $key requested argument
1099 * @param string $def default value to return if $key is not provided
1101 * @return boolean is read only action?
1103 function trimmed($key, $def=null)
1105 $arg = $this->arg($key, $def);
1106 return is_string($arg) ? trim($arg) : $arg;
1112 * @param array $argarray is ignored since it's now passed in in prepare()
1114 * @return boolean is read only action?
1116 function handle($argarray=null)
1118 header('Vary: Accept-Encoding,Cookie');
1120 $lm = $this->lastModified();
1121 $etag = $this->etag();
1124 header('ETag: ' . $etag);
1128 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1129 if ($this->isCacheable()) {
1130 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1131 header( "Cache-Control: private, must-revalidate, max-age=0" );
1138 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1139 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1140 if ($if_none_match) {
1141 // If this check fails, ignore the if-modified-since below.
1143 if ($this->_hasEtag($etag, $if_none_match)) {
1144 header('HTTP/1.1 304 Not Modified');
1145 // Better way to do this?
1151 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1152 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1153 $ims = strtotime($if_modified_since);
1155 header('HTTP/1.1 304 Not Modified');
1156 // Better way to do this?
1163 * Is this action cacheable?
1165 * If the action returns a last-modified
1167 * @param array $argarray is ignored since it's now passed in in prepare()
1169 * @return boolean is read only action?
1171 function isCacheable()
1177 * Has etag? (private)
1179 * @param string $etag etag http header
1180 * @param string $if_none_match ifNoneMatch http header
1184 function _hasEtag($etag, $if_none_match)
1186 $etags = explode(',', $if_none_match);
1187 return in_array($etag, $etags) || in_array('*', $etags);
1191 * Boolean understands english (yes, no, true, false)
1193 * @param string $key query key we're interested in
1194 * @param string $def default value
1196 * @return boolean interprets yes/no strings as boolean
1198 function boolean($key, $def=false)
1200 $arg = strtolower($this->trimmed($key));
1202 if (is_null($arg)) {
1204 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1206 } else if (in_array($arg, array('false', 'no', '0'))) {
1214 * Integer value of an argument
1216 * @param string $key query key we're interested in
1217 * @param string $defValue optional default value (default null)
1218 * @param string $maxValue optional max value (default null)
1219 * @param string $minValue optional min value (default null)
1221 * @return integer integer value
1223 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1225 $arg = strtolower($this->trimmed($key));
1227 if (is_null($arg) || !is_integer($arg)) {
1231 if (!is_null($maxValue)) {
1232 $arg = min($arg, $maxValue);
1235 if (!is_null($minValue)) {
1236 $arg = max($arg, $minValue);
1245 * @param string $msg error message to display
1246 * @param integer $code http error code, 500 by default
1250 function serverError($msg, $code=500)
1252 $action = $this->trimmed('action');
1253 common_debug("Server error '$code' on '$action': $msg", __FILE__);
1254 throw new ServerException($msg, $code);
1260 * @param string $msg error message to display
1261 * @param integer $code http error code, 400 by default
1265 function clientError($msg, $code=400)
1267 $action = $this->trimmed('action');
1268 common_debug("User error '$code' on '$action': $msg", __FILE__);
1269 throw new ClientException($msg, $code);
1273 * Returns the current URL
1275 * @return string current URL
1279 list($action, $args) = $this->returnToArgs();
1280 return common_local_url($action, $args);
1284 * Returns arguments sufficient for re-constructing URL
1286 * @return array two elements: action, other args
1288 function returnToArgs()
1290 $action = $this->trimmed('action');
1291 $args = $this->args;
1292 unset($args['action']);
1293 if (common_config('site', 'fancy')) {
1296 if (array_key_exists('submit', $args)) {
1297 unset($args['submit']);
1299 foreach (array_keys($_COOKIE) as $cookie) {
1300 unset($args[$cookie]);
1302 return array($action, $args);
1306 * Generate a menu item
1308 * @param string $url menu URL
1309 * @param string $text menu name
1310 * @param string $title title attribute, null by default
1311 * @param boolean $is_selected current menu item, false by default
1312 * @param string $id element id, null by default
1316 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1318 // Added @id to li for some control.
1319 // XXX: We might want to move this to htmloutputter.php
1322 $lattrs['class'] = 'current';
1325 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1327 $this->elementStart('li', $lattrs);
1328 $attrs['href'] = $url;
1330 $attrs['title'] = $title;
1332 $this->element('a', $attrs, $text);
1333 $this->elementEnd('li');
1337 * Generate pagination links
1339 * @param boolean $have_before is there something before?
1340 * @param boolean $have_after is there something after?
1341 * @param integer $page current page
1342 * @param string $action current action
1343 * @param array $args rest of query arguments
1347 // XXX: The messages in this pagination method only tailor to navigating
1348 // notices. In other lists, "Previous"/"Next" type navigation is
1349 // desirable, but not available.
1350 function pagination($have_before, $have_after, $page, $action, $args=null)
1352 // Does a little before-after block for next/prev page
1353 if ($have_before || $have_after) {
1354 $this->elementStart('dl', 'pagination');
1355 // TRANS: DT element for pagination (previous/next, etc.).
1356 $this->element('dt', null, _('Pagination'));
1357 $this->elementStart('dd', null);
1358 $this->elementStart('ul', array('class' => 'nav'));
1361 $pargs = array('page' => $page-1);
1362 $this->elementStart('li', array('class' => 'nav_prev'));
1363 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1365 // TRANS: Pagination message to go to a page displaying information more in the
1366 // TRANS: present than the currently displayed information.
1368 $this->elementEnd('li');
1371 $pargs = array('page' => $page+1);
1372 $this->elementStart('li', array('class' => 'nav_next'));
1373 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1375 // TRANS: Pagination message to go to a page displaying information more in the
1376 // TRANS: past than the currently displayed information.
1378 $this->elementEnd('li');
1380 if ($have_before || $have_after) {
1381 $this->elementEnd('ul');
1382 $this->elementEnd('dd');
1383 $this->elementEnd('dl');
1388 * An array of feeds for this action.
1390 * Returns an array of potential feeds for this action.
1392 * @return array Feed object to show in head and links
1400 * A design for this action
1402 * @return Design a design object to use
1404 function getDesign()
1406 return Design::siteDesign();
1410 * Check the session token.
1412 * Checks that the current form has the correct session token,
1413 * and throw an exception if it does not.
1417 // XXX: Finding this type of check with the same message about 50 times.
1418 // Possible to refactor?
1419 function checkSessionToken()
1422 $token = $this->trimmed('token');
1423 if (empty($token) || $token != common_session_token()) {
1424 // TRANS: Client error text when there is a problem with the session token.
1425 $this->clientError(_('There was a problem with your session token.'));
1430 * Check if the current request is a POST
1432 * @return boolean true if POST; otherwise false.
1437 return ($_SERVER['REQUEST_METHOD'] == 'POST');