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 if (Event::handle('StartActionExecute', array($this, &$args))) {
122 $prepared = $this->prepare($args);
124 $this->handle($args);
126 common_debug('Prepare failed for Action.');
132 Event::handle('EndActionExecute', array($this));
136 * For initializing members of the class.
138 * @param array $argarray misc. arguments
140 * @return boolean true
142 protected function prepare(array $args=array())
144 if ($this->needPost && !$this->isPost()) {
145 // TRANS: Client error. POST is a HTTP command. It should not be translated.
146 $this->clientError(_('This method requires a POST.'), 405);
149 // needPost, of course, overrides canPost if true
150 if (!$this->canPost) {
151 $this->canPost = $this->needPost;
154 $this->args = common_copy_args($args);
156 // This could be set with get_called_action and then
157 // chop off 'Action' from the class name. In lower case.
158 $this->action = strtolower($this->trimmed('action'));
160 if ($this->ajax || $this->boolean('ajax')) {
161 // check with GNUsocial::isAjax()
162 GNUsocial::setAjax(true);
165 if ($this->needLogin) {
166 $this->checkLogin(); // if not logged in, this redirs/excepts
169 $this->updateScopedProfile();
174 public function updateScopedProfile()
176 $this->scoped = Profile::current();
177 return $this->scoped;
180 public function getScoped()
182 return ($this->scoped instanceof Profile) ? $this->scoped : null;
185 // Must be run _after_ prepare
186 public function getActionName()
188 return $this->action;
191 public function isAction(array $names)
193 foreach ($names as $class) {
194 // PHP is case insensitive, and we have stuff like ApiUpperCaseAction,
195 // but we at least make a point out of wanting to do stuff case-sensitive.
196 $class = ucfirst($class) . 'Action';
197 if ($this instanceof $class) {
205 * Show page, a template method.
211 if (GNUsocial::isAjax()) {
215 if (Event::handle('StartShowHTML', array($this))) {
218 Event::handle('EndShowHTML', array($this));
220 if (Event::handle('StartShowHead', array($this))) {
223 Event::handle('EndShowHead', array($this));
225 if (Event::handle('StartShowBody', array($this))) {
227 Event::handle('EndShowBody', array($this));
229 if (Event::handle('StartEndHTML', array($this))) {
231 Event::handle('EndEndHTML', array($this));
235 public function showAjax()
237 $this->startHTML('text/xml;charset=utf-8');
238 $this->elementStart('head');
239 // TRANS: Title for conversation page.
240 $this->element('title', null, $this->title());
241 $this->elementEnd('head');
242 $this->elementStart('body');
243 if ($this->getError()) {
244 $this->element('p', array('id'=>'error'), $this->getError());
246 $this->showContent();
248 $this->elementEnd('body');
256 if (isset($_startTime)) {
257 $endTime = microtime(true);
258 $diff = round(($endTime - $_startTime) * 1000);
259 $this->raw("<!-- ${diff}ms -->");
262 return parent::endHTML();
266 * Show head, a template method.
272 // XXX: attributes (profile?)
273 $this->elementStart('head');
274 if (Event::handle('StartShowHeadElements', array($this))) {
275 if (Event::handle('StartShowHeadTitle', array($this))) {
277 Event::handle('EndShowHeadTitle', array($this));
279 $this->showShortcutIcon();
280 $this->showStylesheets();
281 $this->showOpenSearch();
283 $this->showDescription();
285 Event::handle('EndShowHeadElements', array($this));
287 $this->elementEnd('head');
291 * Show title, a template method.
297 $this->element('title', null,
298 // TRANS: Page title. %1$s is the title, %2$s is the site name.
299 sprintf(_('%1$s - %2$s'),
301 common_config('site', 'name')));
305 * Returns the page title
309 * @return string page title
314 // TRANS: Page title for a page without a title set.
315 return _('Untitled page');
319 * Show themed shortcut icon
323 function showShortcutIcon()
325 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
326 $this->element('link', array('rel' => 'shortcut icon',
327 'href' => Theme::path('favicon.ico')));
329 // favicon.ico should be HTTPS if the rest of the page is
330 $this->element('link', array('rel' => 'shortcut icon',
331 'href' => common_path('favicon.ico', GNUsocial::isHTTPS())));
334 if (common_config('site', 'mobile')) {
335 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
336 $this->element('link', array('rel' => 'apple-touch-icon',
337 'href' => Theme::path('apple-touch-icon.png')));
339 $this->element('link', array('rel' => 'apple-touch-icon',
340 'href' => common_path('apple-touch-icon.png')));
350 function showStylesheets()
352 if (Event::handle('StartShowStyles', array($this))) {
354 // Use old name for StatusNet for compatibility on events
356 if (Event::handle('StartShowStylesheets', array($this))) {
357 $this->primaryCssLink(null, 'screen, projection, tv, print');
358 Event::handle('EndShowStylesheets', array($this));
361 $this->cssLink('js/extlib/jquery-ui/css/smoothness/jquery-ui.css');
363 if (Event::handle('StartShowUAStyles', array($this))) {
364 Event::handle('EndShowUAStyles', array($this));
367 Event::handle('EndShowStyles', array($this));
369 if (common_config('custom_css', 'enabled')) {
370 $css = common_config('custom_css', 'css');
371 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
372 if (trim($css) != '') {
375 Event::handle('EndShowCustomCss', array($this));
381 function primaryCssLink($mainTheme=null, $media=null)
383 $theme = new Theme($mainTheme);
385 // Some themes may have external stylesheets, such as using the
386 // Google Font APIs to load webfonts.
387 foreach ($theme->getExternals() as $url) {
388 $this->cssLink($url, $mainTheme, $media);
391 // If the currently-selected theme has dependencies on other themes,
392 // we'll need to load their display.css files as well in order.
393 $baseThemes = $theme->getDeps();
394 foreach ($baseThemes as $baseTheme) {
395 $this->cssLink('css/display.css', $baseTheme, $media);
397 $this->cssLink('css/display.css', $mainTheme, $media);
399 // Additional styles for RTL languages
400 if (is_rtl(common_language())) {
401 if (file_exists(Theme::file('css/rtl.css'))) {
402 $this->cssLink('css/rtl.css', $mainTheme, $media);
408 * Show javascript headers
412 function showScripts()
414 if (Event::handle('StartShowScripts', array($this))) {
415 if (Event::handle('StartShowJQueryScripts', array($this))) {
416 $this->script('extlib/jquery.js');
417 $this->script('extlib/jquery.form.js');
418 $this->script('extlib/jquery-ui/jquery-ui.js');
419 $this->script('extlib/jquery.cookie.js');
420 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/extlib/json2.js', GNUsocial::isHTTPS()).'"); }');
421 $this->script('extlib/jquery.infieldlabel.js');
423 Event::handle('EndShowJQueryScripts', array($this));
425 if (Event::handle('StartShowStatusNetScripts', array($this))) {
426 $this->script('util.js');
427 $this->script('xbImportNode.js');
428 $this->script('geometa.js');
430 // This route isn't available in single-user mode.
431 // Not sure why, but it causes errors here.
432 $this->inlineScript('var _peopletagAC = "' .
433 common_local_url('peopletagautocomplete') . '";');
434 $this->showScriptMessages();
435 // Anti-framing code to avoid clickjacking attacks in older browsers.
436 // This will show a blank page if the page is being framed, which is
437 // consistent with the behavior of the 'X-Frame-Options: SAMEORIGIN'
438 // header, which prevents framing in newer browser.
439 if (common_config('javascript', 'bustframes')) {
440 $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 = ""; }; }');
442 Event::handle('EndShowStatusNetScripts', array($this));
444 Event::handle('EndShowScripts', array($this));
449 * Exports a map of localized text strings to JavaScript code.
451 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
452 * events and appending to the array. Try to avoid adding strings that won't be used, as
453 * they'll be added to HTML output.
455 function showScriptMessages()
459 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
460 // Common messages needed for timeline views etc...
462 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
463 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
465 $messages = array_merge($messages, $this->getScriptMessages());
467 Event::handle('EndScriptMessages', array($this, &$messages));
470 if (!empty($messages)) {
471 $this->inlineScript('SN.messages=' . json_encode($messages));
478 * If the action will need localizable text strings, export them here like so:
480 * return array('pool_deepend' => _('Deep end'),
481 * 'pool_shallow' => _('Shallow end'));
483 * The exported map will be available via SN.msg() to JS code:
485 * $('#pool').html('<div class="deepend"></div><div class="shallow"></div>');
486 * $('#pool .deepend').text(SN.msg('pool_deepend'));
487 * $('#pool .shallow').text(SN.msg('pool_shallow'));
489 * Exports a map of localized text strings to JavaScript code.
491 * Plugins can add to what's exported on any action by hooking the StartScriptMessages or
492 * EndScriptMessages events and appending to the array. Try to avoid adding strings that won't
493 * be used, as they'll be added to HTML output.
495 function getScriptMessages()
501 * Show OpenSearch headers
505 function showOpenSearch()
507 $this->element('link', array('rel' => 'search',
508 'type' => 'application/opensearchdescription+xml',
509 'href' => common_local_url('opensearch', array('type' => 'people')),
510 'title' => common_config('site', 'name').' People Search'));
511 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
512 'href' => common_local_url('opensearch', array('type' => 'notice')),
513 'title' => common_config('site', 'name').' Notice Search'));
525 $feeds = $this->getFeeds();
528 foreach ($feeds as $feed) {
529 $this->element('link', array('rel' => $feed->rel(),
530 'href' => $feed->url,
531 'type' => $feed->mimeType(),
532 'title' => $feed->title));
544 function showDescription()
546 // does nothing by default
550 * Show extra stuff in <head>.
558 // does nothing by default
564 * Calls template methods
570 $params = array('id' => $this->getActionName());
571 if ($this->scoped instanceof Profile) {
572 $params['class'] = 'user_in';
574 $this->elementStart('body', $params);
575 $this->elementStart('div', array('id' => 'wrap'));
576 if (Event::handle('StartShowHeader', array($this))) {
579 Event::handle('EndShowHeader', array($this));
583 if (Event::handle('StartShowFooter', array($this))) {
586 Event::handle('EndShowFooter', array($this));
588 $this->elementEnd('div');
589 $this->showScripts();
590 $this->elementEnd('body');
594 * Show header of the page.
596 * Calls template methods
600 function showHeader()
602 $this->elementStart('div', array('id' => 'header'));
604 $this->showPrimaryNav();
605 if (Event::handle('StartShowSiteNotice', array($this))) {
606 $this->showSiteNotice();
608 Event::handle('EndShowSiteNotice', array($this));
611 $this->elementEnd('div');
615 * Show configured logo.
621 $this->elementStart('address', array('id' => 'site_contact', 'class' => 'h-card'));
622 if (Event::handle('StartAddressData', array($this))) {
623 if (common_config('singleuser', 'enabled')) {
624 $user = User::singleUser();
625 $url = common_local_url('showstream',
626 array('nickname' => $user->nickname));
627 } else if (common_logged_in()) {
628 $cur = common_current_user();
629 $url = common_local_url('all', array('nickname' => $cur->nickname));
631 $url = common_local_url('public');
634 $this->elementStart('a', array('class' => 'home bookmark',
637 if (GNUsocial::isHTTPS()) {
638 $logoUrl = common_config('site', 'ssllogo');
639 if (empty($logoUrl)) {
640 // if logo is an uploaded file, try to fall back to HTTPS file URL
641 $httpUrl = common_config('site', 'logo');
642 if (!empty($httpUrl)) {
643 $f = File::getKV('url', $httpUrl);
644 if (!empty($f) && !empty($f->filename)) {
645 // this will handle the HTTPS case
646 $logoUrl = File::url($f->filename);
651 $logoUrl = common_config('site', 'logo');
654 if (empty($logoUrl) && file_exists(Theme::file('logo.png'))) {
655 // This should handle the HTTPS case internally
656 $logoUrl = Theme::path('logo.png');
659 if (!empty($logoUrl)) {
660 $this->element('img', array('class' => 'logo u-photo p-name',
662 'alt' => common_config('site', 'name')));
665 $this->elementEnd('a');
667 Event::handle('EndAddressData', array($this));
669 $this->elementEnd('address');
673 * Show primary navigation.
677 function showPrimaryNav()
679 $this->elementStart('div', array('id' => 'site_nav_global_primary'));
681 $user = common_current_user();
683 if (!empty($user) || !common_config('site', 'private')) {
684 $form = new SearchForm($this);
688 $pn = new PrimaryNav($this);
690 $this->elementEnd('div');
698 function showSiteNotice()
700 // Revist. Should probably do an hAtom pattern here
701 $text = common_config('site', 'notice');
703 $this->elementStart('div', array('id' => 'site_notice',
704 'class' => 'system_notice'));
706 $this->elementEnd('div');
713 * MAY overload if no notice form needed... or direct message box????
717 function showNoticeForm()
719 // TRANS: Tab on the notice form.
720 $tabs = array('status' => array('title' => _m('TAB','Status'),
721 'href' => common_local_url('newnotice')));
723 $this->elementStart('div', 'input_forms');
725 $this->element('label', array('for'=>'input_form_nav'), _m('TAB', 'Share your:'));
727 if (Event::handle('StartShowEntryForms', array(&$tabs))) {
728 $this->elementStart('ul', array('class' => 'nav',
729 'id' => 'input_form_nav'));
731 foreach ($tabs as $tag => $data) {
732 $tag = htmlspecialchars($tag);
733 $attrs = array('id' => 'input_form_nav_'.$tag,
734 'class' => 'input_form_nav_tab');
736 if ($tag == 'status') {
737 $attrs['class'] .= ' current';
739 $this->elementStart('li', $attrs);
742 array('onclick' => 'return SN.U.switchInputFormTab("'.$tag.'");',
743 'href' => $data['href']),
745 $this->elementEnd('li');
748 $this->elementEnd('ul');
750 foreach ($tabs as $tag => $data) {
751 $attrs = array('class' => 'input_form',
752 'id' => 'input_form_'.$tag);
753 if ($tag == 'status') {
754 $attrs['class'] .= ' current';
757 $this->elementStart('div', $attrs);
761 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
762 if ($tag == 'status') {
763 $options = $this->noticeFormOptions();
764 $form = new NoticeForm($this, $options);
766 Event::handle('EndMakeEntryForm', array($tag, $this, $form));
773 $this->elementEnd('div');
777 $this->elementEnd('div');
780 function noticeFormOptions()
786 * Show anonymous message.
792 function showAnonymousMessage()
794 // needs to be defined by the class
800 * Shows local navigation, content block and aside.
806 $this->elementStart('div', array('id' => 'core'));
807 $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
808 $this->elementStart('div', array('id' => 'content_wrapper'));
809 $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
810 if (Event::handle('StartShowLocalNavBlock', array($this))) {
811 $this->showLocalNavBlock();
813 Event::handle('EndShowLocalNavBlock', array($this));
815 if (Event::handle('StartShowContentBlock', array($this))) {
816 $this->showContentBlock();
818 Event::handle('EndShowContentBlock', array($this));
820 if (Event::handle('StartShowAside', array($this))) {
823 Event::handle('EndShowAside', array($this));
825 $this->elementEnd('div');
826 $this->elementEnd('div');
827 $this->elementEnd('div');
828 $this->elementEnd('div');
832 * Show local navigation block.
836 function showLocalNavBlock()
838 // Need to have this ID for CSS; I'm too lazy to add it to
840 $this->elementStart('div', array('id' => 'site_nav_local_views'));
841 // Cheat cheat cheat!
842 $this->showLocalNav();
843 $this->elementEnd('div');
847 * If there's a logged-in user, show a bit of login context
851 function showProfileBlock()
853 if (common_logged_in()) {
854 $block = new DefaultProfileBlock($this);
860 * Show local navigation.
866 function showLocalNav()
868 $nav = new DefaultLocalNav($this);
873 * Show menu for an object (group, profile)
875 * This block will only show if a subclass has overridden
876 * the showObjectNav() method.
880 function showObjectNavBlock()
882 $rmethod = new ReflectionMethod($this, 'showObjectNav');
883 $dclass = $rmethod->getDeclaringClass()->getName();
885 if ($dclass != 'Action') {
886 // Need to have this ID for CSS; I'm too lazy to add it to
888 $this->elementStart('div', array('id' => 'site_nav_object',
889 'class' => 'section'));
890 $this->showObjectNav();
891 $this->elementEnd('div');
896 * Show object navigation.
898 * If there are things to do with this object, show it here.
902 function showObjectNav()
908 * Show content block.
912 function showContentBlock()
914 $this->elementStart('div', array('id' => 'content'));
915 if (common_logged_in()) {
916 if (Event::handle('StartShowNoticeForm', array($this))) {
917 $this->showNoticeForm();
918 Event::handle('EndShowNoticeForm', array($this));
921 if (Event::handle('StartShowPageTitle', array($this))) {
922 $this->showPageTitle();
923 Event::handle('EndShowPageTitle', array($this));
925 $this->showPageNoticeBlock();
926 $this->elementStart('div', array('id' => 'content_inner'));
927 // show the actual content (forms, lists, whatever)
928 $this->showContent();
929 $this->elementEnd('div');
930 $this->elementEnd('div');
938 function showPageTitle()
940 $this->element('h1', null, $this->title());
944 * Show page notice block.
946 * Only show the block if a subclassed action has overrided
947 * Action::showPageNotice(), or an event handler is registered for
948 * the StartShowPageNotice event, in which case we assume the
949 * 'page_notice' definition list is desired. This is to prevent
950 * empty 'page_notice' definition lists from being output everywhere.
954 function showPageNoticeBlock()
956 $rmethod = new ReflectionMethod($this, 'showPageNotice');
957 $dclass = $rmethod->getDeclaringClass()->getName();
959 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
961 $this->elementStart('div', array('id' => 'page_notice',
962 'class' => 'system_notice'));
963 if (Event::handle('StartShowPageNotice', array($this))) {
964 $this->showPageNotice();
965 Event::handle('EndShowPageNotice', array($this));
967 $this->elementEnd('div');
974 * SHOULD overload (unless there's not a notice)
978 function showPageNotice()
985 * MUST overload (unless there's not a notice)
989 protected function showContent()
1000 $this->elementStart('div', array('id' => 'aside_primary',
1001 'class' => 'aside'));
1002 $this->showProfileBlock();
1003 if (Event::handle('StartShowObjectNavBlock', array($this))) {
1004 $this->showObjectNavBlock();
1005 Event::handle('EndShowObjectNavBlock', array($this));
1007 if (Event::handle('StartShowSections', array($this))) {
1008 $this->showSections();
1009 Event::handle('EndShowSections', array($this));
1011 if (Event::handle('StartShowExportData', array($this))) {
1012 $this->showExportData();
1013 Event::handle('EndShowExportData', array($this));
1015 $this->elementEnd('div');
1019 * Show export data feeds.
1023 function showExportData()
1025 $feeds = $this->getFeeds();
1027 $fl = new FeedList($this);
1039 function showSections()
1041 // for each section, show it
1049 function showFooter()
1051 $this->elementStart('div', array('id' => 'footer'));
1052 if (Event::handle('StartShowInsideFooter', array($this))) {
1053 $this->showSecondaryNav();
1054 $this->showLicenses();
1055 Event::handle('EndShowInsideFooter', array($this));
1057 $this->elementEnd('div');
1061 * Show secondary navigation.
1065 function showSecondaryNav()
1067 $sn = new SecondaryNav($this);
1076 function showLicenses()
1078 $this->showGNUsocialLicense();
1079 $this->showContentLicense();
1083 * Show GNU social license.
1087 function showGNUsocialLicense()
1089 if (common_config('site', 'broughtby')) {
1090 // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is set.
1091 // TRANS: Text between [] is a link description, text between () is the link itself.
1092 // TRANS: Make sure there is no whitespace between "]" and "(".
1093 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
1094 $instr = _('**%%site.name%%** is a social network, courtesy of [%%site.broughtby%%](%%site.broughtbyurl%%).');
1096 // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is not set.
1097 $instr = _('**%%site.name%%** is a social network.');
1100 // TRANS: Second sentence of the GNU social site license. Mentions the GNU social source code license.
1101 // TRANS: Make sure there is no whitespace between "]" and "(".
1102 // TRANS: [%1$s](%2$s) is a link description followed by the link itself
1103 // TRANS: %3$s is the version of GNU social that is being used.
1104 $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);
1105 $output = common_markup_to_html($instr);
1106 $this->raw($output);
1111 * Show content license.
1115 function showContentLicense()
1117 if (Event::handle('StartShowContentLicense', array($this))) {
1118 switch (common_config('license', 'type')) {
1120 // TRANS: Content license displayed when license is set to 'private'.
1121 // TRANS: %1$s is the site name.
1122 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
1123 common_config('site', 'name')));
1125 case 'allrightsreserved':
1126 if (common_config('license', 'owner')) {
1127 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
1128 // TRANS: %1$s is the copyright owner.
1129 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
1130 common_config('license', 'owner')));
1132 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
1133 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
1136 case 'cc': // fall through
1138 $this->elementStart('p');
1140 $image = common_config('license', 'image');
1141 $sslimage = common_config('license', 'sslimage');
1143 if (GNUsocial::isHTTPS()) {
1144 if (!empty($sslimage)) {
1146 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1147 // CC support HTTPS on their images
1148 $url = preg_replace('/^http/', 'https', $image);
1150 // Better to show mixed content than no content
1157 $this->element('img', array('id' => 'license_cc',
1159 'alt' => common_config('license', 'title'),
1163 // TRANS: license message in footer.
1164 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1165 $notice = _('All %1$s content and data are available under the %2$s license.');
1166 $link = sprintf('<a class="license" rel="external license" href="%1$s">%2$s</a>',
1167 htmlspecialchars(common_config('license', 'url')),
1168 htmlspecialchars(common_config('license', 'title')));
1169 $this->raw(@sprintf(htmlspecialchars($notice),
1170 htmlspecialchars(common_config('site', 'name')),
1172 $this->elementEnd('p');
1176 Event::handle('EndShowContentLicense', array($this));
1181 * Return last modified, if applicable.
1185 * @return string last modified http header
1187 function lastModified()
1189 // For comparison with If-Last-Modified
1190 // If not applicable, return null
1195 * Return etag, if applicable.
1199 * @return string etag http header
1207 * Return true if read only.
1211 * @param array $args other arguments
1213 * @return boolean is read only action?
1215 function isReadOnly($args)
1221 * Returns query argument or default value if not found
1223 * @param string $key requested argument
1224 * @param string $def default value to return if $key is not provided
1226 * @return boolean is read only action?
1228 function arg($key, $def=null)
1230 if (array_key_exists($key, $this->args)) {
1231 return $this->args[$key];
1238 * Returns trimmed query argument or default value if not found
1240 * @param string $key requested argument
1241 * @param string $def default value to return if $key is not provided
1243 * @return boolean is read only action?
1245 function trimmed($key, $def=null)
1247 $arg = $this->arg($key, $def);
1248 return is_string($arg) ? trim($arg) : $arg;
1254 * @return boolean is read only action?
1256 protected function handle()
1258 header('Vary: Accept-Encoding,Cookie');
1260 $lm = $this->lastModified();
1261 $etag = $this->etag();
1264 header('ETag: ' . $etag);
1268 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1269 if ($this->isCacheable()) {
1270 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1271 header( "Cache-Control: private, must-revalidate, max-age=0" );
1278 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1279 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1280 if ($if_none_match) {
1281 // If this check fails, ignore the if-modified-since below.
1283 if ($this->_hasEtag($etag, $if_none_match)) {
1284 header('HTTP/1.1 304 Not Modified');
1285 // Better way to do this?
1291 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1292 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1293 $ims = strtotime($if_modified_since);
1295 header('HTTP/1.1 304 Not Modified');
1296 // Better way to do this?
1303 * Is this action cacheable?
1305 * If the action returns a last-modified
1307 * @param array $argarray is ignored since it's now passed in in prepare()
1309 * @return boolean is read only action?
1311 function isCacheable()
1317 * Has etag? (private)
1319 * @param string $etag etag http header
1320 * @param string $if_none_match ifNoneMatch http header
1324 function _hasEtag($etag, $if_none_match)
1326 $etags = explode(',', $if_none_match);
1327 return in_array($etag, $etags) || in_array('*', $etags);
1331 * Boolean understands english (yes, no, true, false)
1333 * @param string $key query key we're interested in
1334 * @param string $def default value
1336 * @return boolean interprets yes/no strings as boolean
1338 function boolean($key, $def=false)
1340 $arg = strtolower($this->trimmed($key));
1342 if (is_null($arg)) {
1344 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1346 } else if (in_array($arg, array('false', 'no', '0'))) {
1354 * This is a cheap hack to avoid a bug in DB_DataObject
1355 * where '' is non-type-aware compared to 0, which means it
1356 * will always be true for values like false and 0 too...
1359 * https://pear.php.net/bugs/bug.php?id=20291
1361 function booleanintstring($key, $def)
1363 return $this->boolean($key, $def) ? '1' : '0';
1367 * Integer value of an argument
1369 * @param string $key query key we're interested in
1370 * @param string $defValue optional default value (default null)
1371 * @param string $maxValue optional max value (default null)
1372 * @param string $minValue optional min value (default null)
1374 * @return integer integer value
1376 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1378 $arg = intval($this->arg($key));
1380 if (!is_numeric($this->arg($key)) || $arg != $this->arg($key)) {
1384 if (!is_null($maxValue)) {
1385 $arg = min($arg, $maxValue);
1388 if (!is_null($minValue)) {
1389 $arg = max($arg, $minValue);
1398 * @param string $msg error message to display
1399 * @param integer $code http error code, 500 by default
1403 function serverError($msg, $code=500, $format=null)
1405 if ($format === null) {
1406 $format = $this->format;
1409 common_debug("Server error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1411 if (!array_key_exists($code, ServerErrorAction::$status)) {
1415 $status_string = ServerErrorAction::$status[$code];
1419 header("HTTP/1.1 {$code} {$status_string}");
1420 $this->initDocument('xml');
1421 $this->elementStart('hash');
1422 $this->element('error', null, $msg);
1423 $this->element('request', null, $_SERVER['REQUEST_URI']);
1424 $this->elementEnd('hash');
1425 $this->endDocument('xml');
1428 if (!isset($this->callback)) {
1429 header("HTTP/1.1 {$code} {$status_string}");
1431 $this->initDocument('json');
1432 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1433 print(json_encode($error_array));
1434 $this->endDocument('json');
1437 throw new ServerException($msg, $code);
1446 * @param string $msg error message to display
1447 * @param integer $code http error code, 400 by default
1448 * @param string $format error format (json, xml, text) for ApiAction
1451 * @throws ClientException always
1453 function clientError($msg, $code=400, $format=null)
1455 // $format is currently only relevant for an ApiAction anyway
1456 if ($format === null) {
1457 $format = $this->format;
1460 common_debug("User error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1462 if (!array_key_exists($code, ClientErrorAction::$status)) {
1466 $status_string = ClientErrorAction::$status[$code];
1470 header("HTTP/1.1 {$code} {$status_string}");
1471 $this->initDocument('xml');
1472 $this->elementStart('hash');
1473 $this->element('error', null, $msg);
1474 $this->element('request', null, $_SERVER['REQUEST_URI']);
1475 $this->elementEnd('hash');
1476 $this->endDocument('xml');
1479 if (!isset($this->callback)) {
1480 header("HTTP/1.1 {$code} {$status_string}");
1482 $this->initDocument('json');
1483 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1484 $this->text(json_encode($error_array));
1485 $this->endDocument('json');
1488 header("HTTP/1.1 {$code} {$status_string}");
1489 header('Content-Type: text/plain; charset=utf-8');
1493 throw new ClientException($msg, $code);
1499 * If not logged in, take appropriate action (redir or exception)
1501 * @param boolean $redir Redirect to login if not logged in
1503 * @return boolean true if logged in (never returns if not)
1505 public function checkLogin($redir=true)
1507 if (common_logged_in()) {
1512 common_set_returnto($_SERVER['REQUEST_URI']);
1513 common_redirect(common_local_url('login'));
1516 // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
1517 $this->clientError(_('Not logged in.'), 403);
1521 * Returns the current URL
1523 * @return string current URL
1527 list($action, $args) = $this->returnToArgs();
1528 return common_local_url($action, $args);
1532 * Returns arguments sufficient for re-constructing URL
1534 * @return array two elements: action, other args
1536 function returnToArgs()
1538 $action = $this->getActionName();
1539 $args = $this->args;
1540 unset($args['action']);
1541 if (common_config('site', 'fancy')) {
1544 if (array_key_exists('submit', $args)) {
1545 unset($args['submit']);
1547 foreach (array_keys($_COOKIE) as $cookie) {
1548 unset($args[$cookie]);
1550 return array($action, $args);
1554 * Generate a menu item
1556 * @param string $url menu URL
1557 * @param string $text menu name
1558 * @param string $title title attribute, null by default
1559 * @param boolean $is_selected current menu item, false by default
1560 * @param string $id element id, null by default
1564 function menuItem($url, $text, $title=null, $is_selected=false, $id=null, $class=null)
1566 // Added @id to li for some control.
1567 // XXX: We might want to move this to htmloutputter.php
1570 if ($class !== null) {
1571 $classes[] = trim($class);
1574 $classes[] = 'current';
1577 if (!empty($classes)) {
1578 $lattrs['class'] = implode(' ', $classes);
1581 if (!is_null($id)) {
1582 $lattrs['id'] = $id;
1585 $this->elementStart('li', $lattrs);
1586 $attrs['href'] = $url;
1588 $attrs['title'] = $title;
1590 $this->element('a', $attrs, $text);
1591 $this->elementEnd('li');
1595 * Generate pagination links
1597 * @param boolean $have_before is there something before?
1598 * @param boolean $have_after is there something after?
1599 * @param integer $page current page
1600 * @param string $action current action
1601 * @param array $args rest of query arguments
1605 // XXX: The messages in this pagination method only tailor to navigating
1606 // notices. In other lists, "Previous"/"Next" type navigation is
1607 // desirable, but not available.
1608 function pagination($have_before, $have_after, $page, $action, $args=null)
1610 // Does a little before-after block for next/prev page
1611 if ($have_before || $have_after) {
1612 $this->elementStart('ul', array('class' => 'nav',
1613 'id' => 'pagination'));
1616 $pargs = array('page' => $page-1);
1617 $this->elementStart('li', array('class' => 'nav_prev'));
1618 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1620 // TRANS: Pagination message to go to a page displaying information more in the
1621 // TRANS: present than the currently displayed information.
1623 $this->elementEnd('li');
1626 $pargs = array('page' => $page+1);
1627 $this->elementStart('li', array('class' => 'nav_next'));
1628 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1630 // TRANS: Pagination message to go to a page displaying information more in the
1631 // TRANS: past than the currently displayed information.
1633 $this->elementEnd('li');
1635 if ($have_before || $have_after) {
1636 $this->elementEnd('ul');
1641 * An array of feeds for this action.
1643 * Returns an array of potential feeds for this action.
1645 * @return array Feed object to show in head and links
1653 * Check the session token.
1655 * Checks that the current form has the correct session token,
1656 * and throw an exception if it does not.
1660 // XXX: Finding this type of check with the same message about 50 times.
1661 // Possible to refactor?
1662 function checkSessionToken()
1665 $token = $this->trimmed('token');
1666 if (empty($token) || $token != common_session_token()) {
1667 // TRANS: Client error text when there is a problem with the session token.
1668 $this->clientError(_('There was a problem with your session token.'));
1673 * Check if the current request is a POST
1675 * @return boolean true if POST; otherwise false.
1680 return ($_SERVER['REQUEST_METHOD'] == 'POST');