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('GNUSOCIAL')) { exit(1); }
34 * Base class for all actions
36 * This is the base class for all actions in the package. An action is
37 * more or less a "view" in an MVC framework.
39 * Actions are responsible for extracting and validating parameters; using
40 * model classes to read and write to the database; and doing ouput.
44 * @author Evan Prodromou <evan@status.net>
45 * @author Sarven Capadisli <csarven@status.net>
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47 * @link http://status.net/
51 class Action extends HTMLOutputter // lawsuit
53 // This should be protected/private in the future
54 public $args = array();
56 // Action properties, set per-class
57 protected $action = false;
58 protected $ajax = false;
59 protected $menus = true;
60 protected $needLogin = false;
61 protected $needPost = false; // implies canPost if true
62 protected $canPost = false; // can this action handle POST method?
64 // The currently scoped profile (normally Profile::current; from $this->auth_user for API)
65 protected $scoped = null;
67 // Related to front-end user representation
68 protected $format = null;
69 protected $error = null;
70 protected $msg = null;
75 * Just wraps the HTMLOutputter constructor.
77 * @param string $output URI to output to, default = stdout
78 * @param boolean $indent Whether to indent output, default true
80 * @see XMLOutputter::__construct
81 * @see HTMLOutputter::__construct
83 function __construct($output='php://output', $indent=null)
85 parent::__construct($output, $indent);
98 static public function run(array $args=array(), $output='php://output', $indent=null) {
99 $class = get_called_class();
100 $action = new $class($output, $indent);
101 $action->execute($args);
105 public function execute(array $args=array()) {
107 if (common_config('db', 'mirror') && $this->isReadOnly($args)) {
108 if (is_array(common_config('db', 'mirror'))) {
109 // "load balancing", ha ha
110 $arr = common_config('db', 'mirror');
111 $k = array_rand($arr);
114 $mirror = common_config('db', 'mirror');
117 // everyone else uses the mirror
118 common_config_set('db', 'database', $mirror);
121 $status = $this->prepare($args);
123 $this->handle($args);
125 common_debug('Prepare failed for Action.');
130 Event::handle('EndActionExecute', array($status, $this));
134 * For initializing members of the class.
136 * @param array $argarray misc. arguments
138 * @return boolean true
140 protected function prepare(array $args=array())
142 if ($this->needPost && !$this->isPost()) {
143 // TRANS: Client error. POST is a HTTP command. It should not be translated.
144 $this->clientError(_('This method requires a POST.'), 405);
147 // needPost, of course, overrides canPost if true
148 if (!$this->canPost) {
149 $this->canPost = $this->needPost;
152 $this->args = common_copy_args($args);
154 // This could be set with get_called_action and then
155 // chop off 'Action' from the class name. In lower case.
156 $this->action = strtolower($this->trimmed('action'));
158 if ($this->ajax || $this->boolean('ajax')) {
159 // check with StatusNet::isAjax()
160 StatusNet::setAjax(true);
163 if ($this->needLogin) {
164 $this->checkLogin(); // if not logged in, this redirs/excepts
167 $this->updateScopedProfile();
172 function updateScopedProfile() {
173 $this->scoped = Profile::current();
174 return $this->scoped;
177 // Must be run _after_ prepare
178 public function getActionName()
180 return $this->action;
184 * Show page, a template method.
190 if (Event::handle('StartShowHTML', array($this))) {
193 Event::handle('EndShowHTML', array($this));
195 if (Event::handle('StartShowHead', array($this))) {
198 Event::handle('EndShowHead', array($this));
200 if (Event::handle('StartShowBody', array($this))) {
202 Event::handle('EndShowBody', array($this));
204 if (Event::handle('StartEndHTML', array($this))) {
206 Event::handle('EndEndHTML', array($this));
214 if (isset($_startTime)) {
215 $endTime = microtime(true);
216 $diff = round(($endTime - $_startTime) * 1000);
217 $this->raw("<!-- ${diff}ms -->");
220 return parent::endHTML();
224 * Show head, a template method.
230 // XXX: attributes (profile?)
231 $this->elementStart('head');
232 if (Event::handle('StartShowHeadElements', array($this))) {
233 if (Event::handle('StartShowHeadTitle', array($this))) {
235 Event::handle('EndShowHeadTitle', array($this));
237 $this->showShortcutIcon();
238 $this->showStylesheets();
239 $this->showOpenSearch();
241 $this->showDescription();
243 Event::handle('EndShowHeadElements', array($this));
245 $this->elementEnd('head');
249 * Show title, a template method.
255 $this->element('title', null,
256 // TRANS: Page title. %1$s is the title, %2$s is the site name.
257 sprintf(_('%1$s - %2$s'),
259 common_config('site', 'name')));
263 * Returns the page title
267 * @return string page title
272 // TRANS: Page title for a page without a title set.
273 return _('Untitled page');
277 * Show themed shortcut icon
281 function showShortcutIcon()
283 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
284 $this->element('link', array('rel' => 'shortcut icon',
285 'href' => Theme::path('favicon.ico')));
287 // favicon.ico should be HTTPS if the rest of the page is
288 $this->element('link', array('rel' => 'shortcut icon',
289 'href' => common_path('favicon.ico', StatusNet::isHTTPS())));
292 if (common_config('site', 'mobile')) {
293 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
294 $this->element('link', array('rel' => 'apple-touch-icon',
295 'href' => Theme::path('apple-touch-icon.png')));
297 $this->element('link', array('rel' => 'apple-touch-icon',
298 'href' => common_path('apple-touch-icon.png')));
308 function showStylesheets()
310 if (Event::handle('StartShowStyles', array($this))) {
312 // Use old name for StatusNet for compatibility on events
314 if (Event::handle('StartShowStylesheets', array($this))) {
315 $this->primaryCssLink(null, 'screen, projection, tv, print');
316 Event::handle('EndShowStylesheets', array($this));
319 $this->cssLink('js/extlib/jquery-ui/css/smoothness/jquery-ui.css');
321 if (Event::handle('StartShowUAStyles', array($this))) {
322 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
323 'href="'.Theme::path('css/ie.css', 'base').'?version='.GNUSOCIAL_VERSION.'" /><![endif]');
324 foreach (array(6,7) as $ver) {
325 if (file_exists(Theme::file('css/ie'.$ver.'.css', 'base'))) {
326 // Yes, IE people should be put in jail.
327 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
328 'href="'.Theme::path('css/ie'.$ver.'.css', 'base').'?version='.GNUSOCIAL_VERSION.'" /><![endif]');
331 if (file_exists(Theme::file('css/ie.css'))) {
332 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
333 'href="'.Theme::path('css/ie.css', null).'?version='.GNUSOCIAL_VERSION.'" /><![endif]');
335 Event::handle('EndShowUAStyles', array($this));
338 Event::handle('EndShowStyles', array($this));
340 if (common_config('custom_css', 'enabled')) {
341 $css = common_config('custom_css', 'css');
342 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
343 if (trim($css) != '') {
346 Event::handle('EndShowCustomCss', array($this));
352 function primaryCssLink($mainTheme=null, $media=null)
354 $theme = new Theme($mainTheme);
356 // Some themes may have external stylesheets, such as using the
357 // Google Font APIs to load webfonts.
358 foreach ($theme->getExternals() as $url) {
359 $this->cssLink($url, $mainTheme, $media);
362 // If the currently-selected theme has dependencies on other themes,
363 // we'll need to load their display.css files as well in order.
364 $baseThemes = $theme->getDeps();
365 foreach ($baseThemes as $baseTheme) {
366 $this->cssLink('css/display.css', $baseTheme, $media);
368 $this->cssLink('css/display.css', $mainTheme, $media);
370 // Additional styles for RTL languages
371 if (is_rtl(common_language())) {
372 if (file_exists(Theme::file('css/rtl.css'))) {
373 $this->cssLink('css/rtl.css', $mainTheme, $media);
379 * Show javascript headers
383 function showScripts()
385 if (Event::handle('StartShowScripts', array($this))) {
386 if (Event::handle('StartShowJQueryScripts', array($this))) {
387 $this->script('extlib/jquery.js');
388 $this->script('extlib/jquery.form.js');
389 $this->script('extlib/jquery-ui/jquery-ui.js');
390 $this->script('extlib/jquery.cookie.js');
391 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/extlib/json2.js', StatusNet::isHTTPS()).'"); }');
392 $this->script('extlib/jquery.infieldlabel.js');
394 Event::handle('EndShowJQueryScripts', array($this));
396 if (Event::handle('StartShowStatusNetScripts', array($this))) {
397 $this->script('util.js');
398 $this->script('xbImportNode.js');
399 $this->script('geometa.js');
401 // This route isn't available in single-user mode.
402 // Not sure why, but it causes errors here.
403 $this->inlineScript('var _peopletagAC = "' .
404 common_local_url('peopletagautocomplete') . '";');
405 $this->showScriptMessages();
406 // Anti-framing code to avoid clickjacking attacks in older browsers.
407 // This will show a blank page if the page is being framed, which is
408 // consistent with the behavior of the 'X-Frame-Options: SAMEORIGIN'
409 // header, which prevents framing in newer browser.
410 if (common_config('javascript', 'bustframes')) {
411 $this->inlineScript('if (window.top !== window.self) { document.write = ""; window.top.location = window.self.location; setTimeout(function () { document.body.innerHTML = ""; }, 1); window.self.onload = function () { document.body.innerHTML = ""; }; }');
413 Event::handle('EndShowStatusNetScripts', array($this));
415 Event::handle('EndShowScripts', array($this));
420 * Exports a map of localized text strings to JavaScript code.
422 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
423 * events and appending to the array. Try to avoid adding strings that won't be used, as
424 * they'll be added to HTML output.
426 function showScriptMessages()
430 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
431 // Common messages needed for timeline views etc...
433 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
434 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
436 // TRANS: Inline reply form submit button: submits a reply comment.
437 $messages['reply_submit'] = _m('BUTTON', 'Reply');
439 // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
440 $messages['reply_placeholder'] = _m('Write a reply...');
442 $messages = array_merge($messages, $this->getScriptMessages());
444 Event::handle('EndScriptMessages', array($this, &$messages));
447 if (!empty($messages)) {
448 $this->inlineScript('SN.messages=' . json_encode($messages));
455 * If the action will need localizable text strings, export them here like so:
457 * return array('pool_deepend' => _('Deep end'),
458 * 'pool_shallow' => _('Shallow end'));
460 * The exported map will be available via SN.msg() to JS code:
462 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
463 * $('#pool .deepend').text(SN.msg('pool_deepend'));
464 * $('#pool .shallow').text(SN.msg('pool_shallow'));
466 * Exports a map of localized text strings to JavaScript code.
468 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
469 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
470 * be used, as they'll be added to HTML output.
472 function getScriptMessages()
478 * Show OpenSearch headers
482 function showOpenSearch()
484 $this->element('link', array('rel' => 'search',
485 'type' => 'application/opensearchdescription+xml',
486 'href' => common_local_url('opensearch', array('type' => 'people')),
487 'title' => common_config('site', 'name').' People Search'));
488 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
489 'href' => common_local_url('opensearch', array('type' => 'notice')),
490 'title' => common_config('site', 'name').' Notice Search'));
502 $feeds = $this->getFeeds();
505 foreach ($feeds as $feed) {
506 $this->element('link', array('rel' => $feed->rel(),
507 'href' => $feed->url,
508 'type' => $feed->mimeType(),
509 'title' => $feed->title));
521 function showDescription()
523 // does nothing by default
527 * Show extra stuff in <head>.
535 // does nothing by default
541 * Calls template methods
547 $params = array('id' => $this->getActionName());
548 if ($this->scoped instanceof Profile) {
549 $params['class'] = 'user_in';
551 $this->elementStart('body', $params);
552 $this->elementStart('div', array('id' => 'wrap'));
553 if (Event::handle('StartShowHeader', array($this))) {
556 Event::handle('EndShowHeader', array($this));
560 if (Event::handle('StartShowFooter', array($this))) {
563 Event::handle('EndShowFooter', array($this));
565 $this->elementEnd('div');
566 $this->showScripts();
567 $this->elementEnd('body');
571 * Show header of the page.
573 * Calls template methods
577 function showHeader()
579 $this->elementStart('div', array('id' => 'header'));
581 $this->showPrimaryNav();
582 if (Event::handle('StartShowSiteNotice', array($this))) {
583 $this->showSiteNotice();
585 Event::handle('EndShowSiteNotice', array($this));
588 $this->elementEnd('div');
592 * Show configured logo.
598 $this->elementStart('address', array('id' => 'site_contact',
599 'class' => 'vcard'));
600 if (Event::handle('StartAddressData', array($this))) {
601 if (common_config('singleuser', 'enabled')) {
602 $user = User::singleUser();
603 $url = common_local_url('showstream',
604 array('nickname' => $user->nickname));
605 } else if (common_logged_in()) {
606 $cur = common_current_user();
607 $url = common_local_url('all', array('nickname' => $cur->nickname));
609 $url = common_local_url('public');
612 $this->elementStart('a', array('class' => 'url home bookmark',
615 if (StatusNet::isHTTPS()) {
616 $logoUrl = common_config('site', 'ssllogo');
617 if (empty($logoUrl)) {
618 // if logo is an uploaded file, try to fall back to HTTPS file URL
619 $httpUrl = common_config('site', 'logo');
620 if (!empty($httpUrl)) {
621 $f = File::getKV('url', $httpUrl);
622 if (!empty($f) && !empty($f->filename)) {
623 // this will handle the HTTPS case
624 $logoUrl = File::url($f->filename);
629 $logoUrl = common_config('site', 'logo');
632 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
633 // This should handle the HTTPS case internally
634 $logoUrl = Theme::path('logo.png');
637 if (!empty($logoUrl)) {
638 $this->element('img', array('class' => 'logo photo',
640 'alt' => common_config('site', 'name')));
644 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
645 $this->elementEnd('a');
647 Event::handle('EndAddressData', array($this));
649 $this->elementEnd('address');
653 * Show primary navigation.
657 function showPrimaryNav()
659 $this->elementStart('div', array('id' => 'site_nav_global_primary'));
661 $user = common_current_user();
663 if (!empty($user) || !common_config('site', 'private')) {
664 $form = new SearchForm($this);
668 $pn = new PrimaryNav($this);
670 $this->elementEnd('div');
678 function showSiteNotice()
680 // Revist. Should probably do an hAtom pattern here
681 $text = common_config('site', 'notice');
683 $this->elementStart('div', array('id' => 'site_notice',
684 'class' => 'system_notice'));
686 $this->elementEnd('div');
693 * MAY overload if no notice form needed... or direct message box????
697 function showNoticeForm()
699 // TRANS: Tab on the notice form.
700 $tabs = array('status' => array('title' => _m('TAB','Status'),
701 'href' => common_local_url('newnotice')));
703 $this->elementStart('div', 'input_forms');
705 if (Event::handle('StartShowEntryForms', array(&$tabs))) {
706 $this->elementStart('ul', array('class' => 'nav',
707 'id' => 'input_form_nav'));
709 foreach ($tabs as $tag => $data) {
710 $tag = htmlspecialchars($tag);
711 $attrs = array('id' => 'input_form_nav_'.$tag,
712 'class' => 'input_form_nav_tab');
714 if ($tag == 'status') {
715 // We're actually showing the placeholder form,
716 // but we special-case the 'Status' tab as if
717 // it were a small version of it.
718 $attrs['class'] .= ' current';
720 $this->elementStart('li', $attrs);
723 array('onclick' => 'return SN.U.switchInputFormTab("'.$tag.'");',
724 'href' => $data['href']),
726 $this->elementEnd('li');
729 $this->elementEnd('ul');
731 $attrs = array('class' => 'input_form current',
732 'id' => 'input_form_placeholder');
733 $this->elementStart('div', $attrs);
734 $form = new NoticePlaceholderForm($this);
736 $this->elementEnd('div');
738 foreach ($tabs as $tag => $data) {
739 $attrs = array('class' => 'input_form',
740 'id' => 'input_form_'.$tag);
742 $this->elementStart('div', $attrs);
746 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
747 if ($tag == 'status') {
748 $options = $this->noticeFormOptions();
749 $form = new NoticeForm($this, $options);
751 Event::handle('EndMakeEntryForm', array($tag, $this, $form));
758 $this->elementEnd('div');
762 $this->elementEnd('div');
765 function noticeFormOptions()
771 * Show anonymous message.
777 function showAnonymousMessage()
779 // needs to be defined by the class
785 * Shows local navigation, content block and aside.
791 $this->elementStart('div', array('id' => 'core'));
792 $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
793 $this->elementStart('div', array('id' => 'content_wrapper'));
794 $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
795 if (Event::handle('StartShowLocalNavBlock', array($this))) {
796 $this->showLocalNavBlock();
798 Event::handle('EndShowLocalNavBlock', array($this));
800 if (Event::handle('StartShowContentBlock', array($this))) {
801 $this->showContentBlock();
803 Event::handle('EndShowContentBlock', array($this));
805 if (Event::handle('StartShowAside', array($this))) {
808 Event::handle('EndShowAside', array($this));
810 $this->elementEnd('div');
811 $this->elementEnd('div');
812 $this->elementEnd('div');
813 $this->elementEnd('div');
817 * Show local navigation block.
821 function showLocalNavBlock()
823 // Need to have this ID for CSS; I'm too lazy to add it to
825 $this->elementStart('div', array('id' => 'site_nav_local_views'));
826 // Cheat cheat cheat!
827 $this->showLocalNav();
828 $this->elementEnd('div');
832 * If there's a logged-in user, show a bit of login context
836 function showProfileBlock()
838 if (common_logged_in()) {
839 $block = new DefaultProfileBlock($this);
845 * Show local navigation.
851 function showLocalNav()
853 $nav = new DefaultLocalNav($this);
858 * Show menu for an object (group, profile)
860 * This block will only show if a subclass has overridden
861 * the showObjectNav() method.
865 function showObjectNavBlock()
867 $rmethod = new ReflectionMethod($this, 'showObjectNav');
868 $dclass = $rmethod->getDeclaringClass()->getName();
870 if ($dclass != 'Action') {
871 // Need to have this ID for CSS; I'm too lazy to add it to
873 $this->elementStart('div', array('id' => 'site_nav_object',
874 'class' => 'section'));
875 $this->showObjectNav();
876 $this->elementEnd('div');
881 * Show object navigation.
883 * If there are things to do with this object, show it here.
887 function showObjectNav()
893 * Show content block.
897 function showContentBlock()
899 $this->elementStart('div', array('id' => 'content'));
900 if (common_logged_in()) {
901 if (Event::handle('StartShowNoticeForm', array($this))) {
902 $this->showNoticeForm();
903 Event::handle('EndShowNoticeForm', array($this));
906 if (Event::handle('StartShowPageTitle', array($this))) {
907 $this->showPageTitle();
908 Event::handle('EndShowPageTitle', array($this));
910 $this->showPageNoticeBlock();
911 $this->elementStart('div', array('id' => 'content_inner'));
912 // show the actual content (forms, lists, whatever)
913 $this->showContent();
914 $this->elementEnd('div');
915 $this->elementEnd('div');
923 function showPageTitle()
925 $this->element('h1', null, $this->title());
929 * Show page notice block.
931 * Only show the block if a subclassed action has overrided
932 * Action::showPageNotice(), or an event handler is registered for
933 * the StartShowPageNotice event, in which case we assume the
934 * 'page_notice' definition list is desired. This is to prevent
935 * empty 'page_notice' definition lists from being output everywhere.
939 function showPageNoticeBlock()
941 $rmethod = new ReflectionMethod($this, 'showPageNotice');
942 $dclass = $rmethod->getDeclaringClass()->getName();
944 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
946 $this->elementStart('div', array('id' => 'page_notice',
947 'class' => 'system_notice'));
948 if (Event::handle('StartShowPageNotice', array($this))) {
949 $this->showPageNotice();
950 Event::handle('EndShowPageNotice', array($this));
952 $this->elementEnd('div');
959 * SHOULD overload (unless there's not a notice)
963 function showPageNotice()
970 * MUST overload (unless there's not a notice)
974 function showContent()
985 $this->elementStart('div', array('id' => 'aside_primary',
986 'class' => 'aside'));
987 $this->showProfileBlock();
988 if (Event::handle('StartShowObjectNavBlock', array($this))) {
989 $this->showObjectNavBlock();
990 Event::handle('EndShowObjectNavBlock', array($this));
992 if (Event::handle('StartShowSections', array($this))) {
993 $this->showSections();
994 Event::handle('EndShowSections', array($this));
996 if (Event::handle('StartShowExportData', array($this))) {
997 $this->showExportData();
998 Event::handle('EndShowExportData', array($this));
1000 $this->elementEnd('div');
1004 * Show export data feeds.
1008 function showExportData()
1010 $feeds = $this->getFeeds();
1012 $fl = new FeedList($this);
1024 function showSections()
1026 // for each section, show it
1034 function showFooter()
1036 $this->elementStart('div', array('id' => 'footer'));
1037 if (Event::handle('StartShowInsideFooter', array($this))) {
1038 $this->showSecondaryNav();
1039 $this->showLicenses();
1040 Event::handle('EndShowInsideFooter', array($this));
1042 $this->elementEnd('div');
1046 * Show secondary navigation.
1050 function showSecondaryNav()
1052 $sn = new SecondaryNav($this);
1061 function showLicenses()
1063 $this->showGNUsocialLicense();
1064 $this->showContentLicense();
1068 * Show GNU social license.
1072 function showGNUsocialLicense()
1074 if (common_config('site', 'broughtby')) {
1075 // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is set.
1076 // TRANS: Text between [] is a link description, text between () is the link itself.
1077 // TRANS: Make sure there is no whitespace between "]" and "(".
1078 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
1079 $instr = _('**%%site.name%%** is a social network, courtesy of [%%site.broughtby%%](%%site.broughtbyurl%%).');
1081 // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is not set.
1082 $instr = _('**%%site.name%%** is a social network.');
1085 // TRANS: Second sentence of the GNU social site license. Mentions the GNU social source code license.
1086 // TRANS: Make sure there is no whitespace between "]" and "(".
1087 // TRANS: [%1$s](%2$s) is a link description followed by the link itself
1088 // TRANS: %3$s is the version of GNU social that is being used.
1089 $instr .= sprintf(_('It runs on [%1$s](%2$s), version %3$s, available under the [GNU Affero General Public License](http://www.fsf.org/licensing/licenses/agpl-3.0.html).'), GNUSOCIAL_ENGINE, GNUSOCIAL_ENGINE_URL, GNUSOCIAL_VERSION);
1090 $output = common_markup_to_html($instr);
1091 $this->raw($output);
1096 * Show content license.
1100 function showContentLicense()
1102 if (Event::handle('StartShowContentLicense', array($this))) {
1103 switch (common_config('license', 'type')) {
1105 // TRANS: Content license displayed when license is set to 'private'.
1106 // TRANS: %1$s is the site name.
1107 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
1108 common_config('site', 'name')));
1110 case 'allrightsreserved':
1111 if (common_config('license', 'owner')) {
1112 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
1113 // TRANS: %1$s is the copyright owner.
1114 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
1115 common_config('license', 'owner')));
1117 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
1118 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
1121 case 'cc': // fall through
1123 $this->elementStart('p');
1125 $image = common_config('license', 'image');
1126 $sslimage = common_config('license', 'sslimage');
1128 if (StatusNet::isHTTPS()) {
1129 if (!empty($sslimage)) {
1131 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1132 // CC support HTTPS on their images
1133 $url = preg_replace('/^http/', 'https', $image);
1135 // Better to show mixed content than no content
1142 $this->element('img', array('id' => 'license_cc',
1144 'alt' => common_config('license', 'title'),
1148 // TRANS: license message in footer.
1149 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1150 $notice = _('All %1$s content and data are available under the %2$s license.');
1151 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1152 htmlspecialchars(common_config('license', 'url')) .
1154 htmlspecialchars(common_config('license', 'title')) .
1156 $this->raw(sprintf(htmlspecialchars($notice),
1157 htmlspecialchars(common_config('site', 'name')),
1159 $this->elementEnd('p');
1163 Event::handle('EndShowContentLicense', array($this));
1168 * Return last modified, if applicable.
1172 * @return string last modified http header
1174 function lastModified()
1176 // For comparison with If-Last-Modified
1177 // If not applicable, return null
1182 * Return etag, if applicable.
1186 * @return string etag http header
1194 * Return true if read only.
1198 * @param array $args other arguments
1200 * @return boolean is read only action?
1202 function isReadOnly($args)
1208 * Returns query argument or default value if not found
1210 * @param string $key requested argument
1211 * @param string $def default value to return if $key is not provided
1213 * @return boolean is read only action?
1215 function arg($key, $def=null)
1217 if (array_key_exists($key, $this->args)) {
1218 return $this->args[$key];
1225 * Returns trimmed query argument or default value if not found
1227 * @param string $key requested argument
1228 * @param string $def default value to return if $key is not provided
1230 * @return boolean is read only action?
1232 function trimmed($key, $def=null)
1234 $arg = $this->arg($key, $def);
1235 return is_string($arg) ? trim($arg) : $arg;
1241 * @return boolean is read only action?
1243 protected function handle()
1245 header('Vary: Accept-Encoding,Cookie');
1247 $lm = $this->lastModified();
1248 $etag = $this->etag();
1251 header('ETag: ' . $etag);
1255 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1256 if ($this->isCacheable()) {
1257 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1258 header( "Cache-Control: private, must-revalidate, max-age=0" );
1265 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1266 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1267 if ($if_none_match) {
1268 // If this check fails, ignore the if-modified-since below.
1270 if ($this->_hasEtag($etag, $if_none_match)) {
1271 header('HTTP/1.1 304 Not Modified');
1272 // Better way to do this?
1278 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1279 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1280 $ims = strtotime($if_modified_since);
1282 header('HTTP/1.1 304 Not Modified');
1283 // Better way to do this?
1290 * Is this action cacheable?
1292 * If the action returns a last-modified
1294 * @param array $argarray is ignored since it's now passed in in prepare()
1296 * @return boolean is read only action?
1298 function isCacheable()
1304 * Has etag? (private)
1306 * @param string $etag etag http header
1307 * @param string $if_none_match ifNoneMatch http header
1311 function _hasEtag($etag, $if_none_match)
1313 $etags = explode(',', $if_none_match);
1314 return in_array($etag, $etags) || in_array('*', $etags);
1318 * Boolean understands english (yes, no, true, false)
1320 * @param string $key query key we're interested in
1321 * @param string $def default value
1323 * @return boolean interprets yes/no strings as boolean
1325 function boolean($key, $def=false)
1327 $arg = strtolower($this->trimmed($key));
1329 if (is_null($arg)) {
1331 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1333 } else if (in_array($arg, array('false', 'no', '0'))) {
1341 * Integer value of an argument
1343 * @param string $key query key we're interested in
1344 * @param string $defValue optional default value (default null)
1345 * @param string $maxValue optional max value (default null)
1346 * @param string $minValue optional min value (default null)
1348 * @return integer integer value
1350 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1352 $arg = intval($this->arg($key));
1354 if (!is_numeric($this->arg($key)) || $arg != $this->arg($key)) {
1358 if (!is_null($maxValue)) {
1359 $arg = min($arg, $maxValue);
1362 if (!is_null($minValue)) {
1363 $arg = max($arg, $minValue);
1372 * @param string $msg error message to display
1373 * @param integer $code http error code, 500 by default
1377 function serverError($msg, $code=500, $format=null)
1379 if ($format === null) {
1380 $format = $this->format;
1383 common_debug("Server error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1385 if (!array_key_exists($code, ServerErrorAction::$status)) {
1389 $status_string = ServerErrorAction::$status[$code];
1393 header("HTTP/1.1 {$code} {$status_string}");
1394 $this->initDocument('xml');
1395 $this->elementStart('hash');
1396 $this->element('error', null, $msg);
1397 $this->element('request', null, $_SERVER['REQUEST_URI']);
1398 $this->elementEnd('hash');
1399 $this->endDocument('xml');
1402 if (!isset($this->callback)) {
1403 header("HTTP/1.1 {$code} {$status_string}");
1405 $this->initDocument('json');
1406 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1407 print(json_encode($error_array));
1408 $this->endDocument('json');
1411 throw new ServerException($msg, $code);
1420 * @param string $msg error message to display
1421 * @param integer $code http error code, 400 by default
1422 * @param string $format error format (json, xml, text) for ApiAction
1425 * @throws ClientException always
1427 function clientError($msg, $code=400, $format=null)
1429 // $format is currently only relevant for an ApiAction anyway
1430 if ($format === null) {
1431 $format = $this->format;
1434 common_debug("User error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1436 if (!array_key_exists($code, ClientErrorAction::$status)) {
1440 $status_string = ClientErrorAction::$status[$code];
1444 header("HTTP/1.1 {$code} {$status_string}");
1445 $this->initDocument('xml');
1446 $this->elementStart('hash');
1447 $this->element('error', null, $msg);
1448 $this->element('request', null, $_SERVER['REQUEST_URI']);
1449 $this->elementEnd('hash');
1450 $this->endDocument('xml');
1453 if (!isset($this->callback)) {
1454 header("HTTP/1.1 {$code} {$status_string}");
1456 $this->initDocument('json');
1457 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1458 $this->text(json_encode($error_array));
1459 $this->endDocument('json');
1462 header("HTTP/1.1 {$code} {$status_string}");
1463 header('Content-Type: text/plain; charset=utf-8');
1467 throw new ClientException($msg, $code);
1473 * If not logged in, take appropriate action (redir or exception)
1475 * @param boolean $redir Redirect to login if not logged in
1477 * @return boolean true if logged in (never returns if not)
1479 public function checkLogin($redir=true)
1481 if (common_logged_in()) {
1486 common_set_returnto($_SERVER['REQUEST_URI']);
1487 common_redirect(common_local_url('login'));
1490 // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
1491 $this->clientError(_('Not logged in.'), 403);
1495 * Returns the current URL
1497 * @return string current URL
1501 list($action, $args) = $this->returnToArgs();
1502 return common_local_url($action, $args);
1506 * Returns arguments sufficient for re-constructing URL
1508 * @return array two elements: action, other args
1510 function returnToArgs()
1512 $action = $this->getActionName();
1513 $args = $this->args;
1514 unset($args['action']);
1515 if (common_config('site', 'fancy')) {
1518 if (array_key_exists('submit', $args)) {
1519 unset($args['submit']);
1521 foreach (array_keys($_COOKIE) as $cookie) {
1522 unset($args[$cookie]);
1524 return array($action, $args);
1528 * Generate a menu item
1530 * @param string $url menu URL
1531 * @param string $text menu name
1532 * @param string $title title attribute, null by default
1533 * @param boolean $is_selected current menu item, false by default
1534 * @param string $id element id, null by default
1538 function menuItem($url, $text, $title=null, $is_selected=false, $id=null, $class=null)
1540 // Added @id to li for some control.
1541 // XXX: We might want to move this to htmloutputter.php
1544 if ($class !== null) {
1545 $classes[] = trim($class);
1548 $classes[] = 'current';
1551 if (!empty($classes)) {
1552 $lattrs['class'] = implode(' ', $classes);
1555 if (!is_null($id)) {
1556 $lattrs['id'] = $id;
1559 $this->elementStart('li', $lattrs);
1560 $attrs['href'] = $url;
1562 $attrs['title'] = $title;
1564 $this->element('a', $attrs, $text);
1565 $this->elementEnd('li');
1569 * Generate pagination links
1571 * @param boolean $have_before is there something before?
1572 * @param boolean $have_after is there something after?
1573 * @param integer $page current page
1574 * @param string $action current action
1575 * @param array $args rest of query arguments
1579 // XXX: The messages in this pagination method only tailor to navigating
1580 // notices. In other lists, "Previous"/"Next" type navigation is
1581 // desirable, but not available.
1582 function pagination($have_before, $have_after, $page, $action, $args=null)
1584 // Does a little before-after block for next/prev page
1585 if ($have_before || $have_after) {
1586 $this->elementStart('ul', array('class' => 'nav',
1587 'id' => 'pagination'));
1590 $pargs = array('page' => $page-1);
1591 $this->elementStart('li', array('class' => 'nav_prev'));
1592 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1594 // TRANS: Pagination message to go to a page displaying information more in the
1595 // TRANS: present than the currently displayed information.
1597 $this->elementEnd('li');
1600 $pargs = array('page' => $page+1);
1601 $this->elementStart('li', array('class' => 'nav_next'));
1602 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1604 // TRANS: Pagination message to go to a page displaying information more in the
1605 // TRANS: past than the currently displayed information.
1607 $this->elementEnd('li');
1609 if ($have_before || $have_after) {
1610 $this->elementEnd('ul');
1615 * An array of feeds for this action.
1617 * Returns an array of potential feeds for this action.
1619 * @return array Feed object to show in head and links
1627 * Check the session token.
1629 * Checks that the current form has the correct session token,
1630 * and throw an exception if it does not.
1634 // XXX: Finding this type of check with the same message about 50 times.
1635 // Possible to refactor?
1636 function checkSessionToken()
1639 $token = $this->trimmed('token');
1640 if (empty($token) || $token != common_session_token()) {
1641 // TRANS: Client error text when there is a problem with the session token.
1642 $this->clientError(_('There was a problem with your session token.'));
1647 * Check if the current request is a POST
1649 * @return boolean true if POST; otherwise false.
1654 return ($_SERVER['REQUEST_METHOD'] == 'POST');