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 public function updateScopedProfile()
174 $this->scoped = Profile::current();
175 return $this->scoped;
178 public function getScoped()
180 return ($this->scoped instanceof Profile) ? $this->scoped : null;
183 // Must be run _after_ prepare
184 public function getActionName()
186 return $this->action;
189 public function isAction(array $names)
191 foreach ($names as $class) {
192 // PHP is case insensitive, and we have stuff like ApiUpperCaseAction,
193 // but we at least make a point out of wanting to do stuff case-sensitive.
194 $class = ucfirst($class) . 'Action';
195 if ($this instanceof $class) {
203 * Show page, a template method.
209 if (StatusNet::isAjax()) {
213 if (Event::handle('StartShowHTML', array($this))) {
216 Event::handle('EndShowHTML', array($this));
218 if (Event::handle('StartShowHead', array($this))) {
221 Event::handle('EndShowHead', array($this));
223 if (Event::handle('StartShowBody', array($this))) {
225 Event::handle('EndShowBody', array($this));
227 if (Event::handle('StartEndHTML', array($this))) {
229 Event::handle('EndEndHTML', array($this));
233 public function showAjax()
235 $this->startHTML('text/xml;charset=utf-8');
236 $this->elementStart('head');
237 // TRANS: Title for conversation page.
238 $this->element('title', null, _m('TITLE','Notice'));
239 $this->elementEnd('head');
240 $this->elementStart('body');
241 $this->showContent();
242 $this->elementEnd('body');
250 if (isset($_startTime)) {
251 $endTime = microtime(true);
252 $diff = round(($endTime - $_startTime) * 1000);
253 $this->raw("<!-- ${diff}ms -->");
256 return parent::endHTML();
260 * Show head, a template method.
266 // XXX: attributes (profile?)
267 $this->elementStart('head');
268 if (Event::handle('StartShowHeadElements', array($this))) {
269 if (Event::handle('StartShowHeadTitle', array($this))) {
271 Event::handle('EndShowHeadTitle', array($this));
273 $this->showShortcutIcon();
274 $this->showStylesheets();
275 $this->showOpenSearch();
277 $this->showDescription();
279 Event::handle('EndShowHeadElements', array($this));
281 $this->elementEnd('head');
285 * Show title, a template method.
291 $this->element('title', null,
292 // TRANS: Page title. %1$s is the title, %2$s is the site name.
293 sprintf(_('%1$s - %2$s'),
295 common_config('site', 'name')));
299 * Returns the page title
303 * @return string page title
308 // TRANS: Page title for a page without a title set.
309 return _('Untitled page');
313 * Show themed shortcut icon
317 function showShortcutIcon()
319 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
320 $this->element('link', array('rel' => 'shortcut icon',
321 'href' => Theme::path('favicon.ico')));
323 // favicon.ico should be HTTPS if the rest of the page is
324 $this->element('link', array('rel' => 'shortcut icon',
325 'href' => common_path('favicon.ico', StatusNet::isHTTPS())));
328 if (common_config('site', 'mobile')) {
329 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
330 $this->element('link', array('rel' => 'apple-touch-icon',
331 'href' => Theme::path('apple-touch-icon.png')));
333 $this->element('link', array('rel' => 'apple-touch-icon',
334 'href' => common_path('apple-touch-icon.png')));
344 function showStylesheets()
346 if (Event::handle('StartShowStyles', array($this))) {
348 // Use old name for StatusNet for compatibility on events
350 if (Event::handle('StartShowStylesheets', array($this))) {
351 $this->primaryCssLink(null, 'screen, projection, tv, print');
352 Event::handle('EndShowStylesheets', array($this));
355 $this->cssLink('js/extlib/jquery-ui/css/smoothness/jquery-ui.css');
357 if (Event::handle('StartShowUAStyles', array($this))) {
358 Event::handle('EndShowUAStyles', array($this));
361 Event::handle('EndShowStyles', array($this));
363 if (common_config('custom_css', 'enabled')) {
364 $css = common_config('custom_css', 'css');
365 if (Event::handle('StartShowCustomCss', array($this, &$css))) {
366 if (trim($css) != '') {
369 Event::handle('EndShowCustomCss', array($this));
375 function primaryCssLink($mainTheme=null, $media=null)
377 $theme = new Theme($mainTheme);
379 // Some themes may have external stylesheets, such as using the
380 // Google Font APIs to load webfonts.
381 foreach ($theme->getExternals() as $url) {
382 $this->cssLink($url, $mainTheme, $media);
385 // If the currently-selected theme has dependencies on other themes,
386 // we'll need to load their display.css files as well in order.
387 $baseThemes = $theme->getDeps();
388 foreach ($baseThemes as $baseTheme) {
389 $this->cssLink('css/display.css', $baseTheme, $media);
391 $this->cssLink('css/display.css', $mainTheme, $media);
393 // Additional styles for RTL languages
394 if (is_rtl(common_language())) {
395 if (file_exists(Theme::file('css/rtl.css'))) {
396 $this->cssLink('css/rtl.css', $mainTheme, $media);
402 * Show javascript headers
406 function showScripts()
408 if (Event::handle('StartShowScripts', array($this))) {
409 if (Event::handle('StartShowJQueryScripts', array($this))) {
410 $this->script('extlib/jquery.js');
411 $this->script('extlib/jquery.form.js');
412 $this->script('extlib/jquery-ui/jquery-ui.js');
413 $this->script('extlib/jquery.cookie.js');
414 $this->inlineScript('if (typeof window.JSON !== "object") { $.getScript("'.common_path('js/extlib/json2.js', StatusNet::isHTTPS()).'"); }');
415 $this->script('extlib/jquery.infieldlabel.js');
417 Event::handle('EndShowJQueryScripts', array($this));
419 if (Event::handle('StartShowStatusNetScripts', array($this))) {
420 $this->script('util.js');
421 $this->script('xbImportNode.js');
422 $this->script('geometa.js');
424 // This route isn't available in single-user mode.
425 // Not sure why, but it causes errors here.
426 $this->inlineScript('var _peopletagAC = "' .
427 common_local_url('peopletagautocomplete') . '";');
428 $this->showScriptMessages();
429 // Anti-framing code to avoid clickjacking attacks in older browsers.
430 // This will show a blank page if the page is being framed, which is
431 // consistent with the behavior of the 'X-Frame-Options: SAMEORIGIN'
432 // header, which prevents framing in newer browser.
433 if (common_config('javascript', 'bustframes')) {
434 $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 = ""; }; }');
436 Event::handle('EndShowStatusNetScripts', array($this));
438 Event::handle('EndShowScripts', array($this));
443 * Exports a map of localized text strings to JavaScript code.
445 * Plugins can add to what's exported by hooking the StartScriptMessages or EndScriptMessages
446 * events and appending to the array. Try to avoid adding strings that won't be used, as
447 * they'll be added to HTML output.
449 function showScriptMessages()
453 if (Event::handle('StartScriptMessages', array($this, &$messages))) {
454 // Common messages needed for timeline views etc...
456 // TRANS: Localized tooltip for '...' expansion button on overlong remote messages.
457 $messages['showmore_tooltip'] = _m('TOOLTIP', 'Show more');
459 // TRANS: Inline reply form submit button: submits a reply comment.
460 $messages['reply_submit'] = _m('BUTTON', 'Reply');
462 // TRANS: Placeholder text for inline reply form. Clicking in this box will turn it into a mini notice form.
463 $messages['reply_placeholder'] = _m('Write a reply...');
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 (StatusNet::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 if (Event::handle('StartShowEntryForms', array(&$tabs))) {
726 $this->elementStart('ul', array('class' => 'nav',
727 'id' => 'input_form_nav'));
729 foreach ($tabs as $tag => $data) {
730 $tag = htmlspecialchars($tag);
731 $attrs = array('id' => 'input_form_nav_'.$tag,
732 'class' => 'input_form_nav_tab');
734 if ($tag == 'status') {
735 // We're actually showing the placeholder form,
736 // but we special-case the 'Status' tab as if
737 // it were a small version of it.
738 $attrs['class'] .= ' current';
740 $this->elementStart('li', $attrs);
743 array('onclick' => 'return SN.U.switchInputFormTab("'.$tag.'");',
744 'href' => $data['href']),
746 $this->elementEnd('li');
749 $this->elementEnd('ul');
751 $attrs = array('class' => 'input_form current',
752 'id' => 'input_form_placeholder');
753 $this->elementStart('div', $attrs);
754 $form = new NoticePlaceholderForm($this);
756 $this->elementEnd('div');
758 foreach ($tabs as $tag => $data) {
759 $attrs = array('class' => 'input_form',
760 'id' => 'input_form_'.$tag);
762 $this->elementStart('div', $attrs);
766 if (Event::handle('StartMakeEntryForm', array($tag, $this, &$form))) {
767 if ($tag == 'status') {
768 $options = $this->noticeFormOptions();
769 $form = new NoticeForm($this, $options);
771 Event::handle('EndMakeEntryForm', array($tag, $this, $form));
778 $this->elementEnd('div');
782 $this->elementEnd('div');
785 function noticeFormOptions()
791 * Show anonymous message.
797 function showAnonymousMessage()
799 // needs to be defined by the class
805 * Shows local navigation, content block and aside.
811 $this->elementStart('div', array('id' => 'core'));
812 $this->elementStart('div', array('id' => 'aside_primary_wrapper'));
813 $this->elementStart('div', array('id' => 'content_wrapper'));
814 $this->elementStart('div', array('id' => 'site_nav_local_views_wrapper'));
815 if (Event::handle('StartShowLocalNavBlock', array($this))) {
816 $this->showLocalNavBlock();
818 Event::handle('EndShowLocalNavBlock', array($this));
820 if (Event::handle('StartShowContentBlock', array($this))) {
821 $this->showContentBlock();
823 Event::handle('EndShowContentBlock', array($this));
825 if (Event::handle('StartShowAside', array($this))) {
828 Event::handle('EndShowAside', array($this));
830 $this->elementEnd('div');
831 $this->elementEnd('div');
832 $this->elementEnd('div');
833 $this->elementEnd('div');
837 * Show local navigation block.
841 function showLocalNavBlock()
843 // Need to have this ID for CSS; I'm too lazy to add it to
845 $this->elementStart('div', array('id' => 'site_nav_local_views'));
846 // Cheat cheat cheat!
847 $this->showLocalNav();
848 $this->elementEnd('div');
852 * If there's a logged-in user, show a bit of login context
856 function showProfileBlock()
858 if (common_logged_in()) {
859 $block = new DefaultProfileBlock($this);
865 * Show local navigation.
871 function showLocalNav()
873 $nav = new DefaultLocalNav($this);
878 * Show menu for an object (group, profile)
880 * This block will only show if a subclass has overridden
881 * the showObjectNav() method.
885 function showObjectNavBlock()
887 $rmethod = new ReflectionMethod($this, 'showObjectNav');
888 $dclass = $rmethod->getDeclaringClass()->getName();
890 if ($dclass != 'Action') {
891 // Need to have this ID for CSS; I'm too lazy to add it to
893 $this->elementStart('div', array('id' => 'site_nav_object',
894 'class' => 'section'));
895 $this->showObjectNav();
896 $this->elementEnd('div');
901 * Show object navigation.
903 * If there are things to do with this object, show it here.
907 function showObjectNav()
913 * Show content block.
917 function showContentBlock()
919 $this->elementStart('div', array('id' => 'content'));
920 if (common_logged_in()) {
921 if (Event::handle('StartShowNoticeForm', array($this))) {
922 $this->showNoticeForm();
923 Event::handle('EndShowNoticeForm', array($this));
926 if (Event::handle('StartShowPageTitle', array($this))) {
927 $this->showPageTitle();
928 Event::handle('EndShowPageTitle', array($this));
930 $this->showPageNoticeBlock();
931 $this->elementStart('div', array('id' => 'content_inner'));
932 // show the actual content (forms, lists, whatever)
933 $this->showContent();
934 $this->elementEnd('div');
935 $this->elementEnd('div');
943 function showPageTitle()
945 $this->element('h1', null, $this->title());
949 * Show page notice block.
951 * Only show the block if a subclassed action has overrided
952 * Action::showPageNotice(), or an event handler is registered for
953 * the StartShowPageNotice event, in which case we assume the
954 * 'page_notice' definition list is desired. This is to prevent
955 * empty 'page_notice' definition lists from being output everywhere.
959 function showPageNoticeBlock()
961 $rmethod = new ReflectionMethod($this, 'showPageNotice');
962 $dclass = $rmethod->getDeclaringClass()->getName();
964 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
966 $this->elementStart('div', array('id' => 'page_notice',
967 'class' => 'system_notice'));
968 if (Event::handle('StartShowPageNotice', array($this))) {
969 $this->showPageNotice();
970 Event::handle('EndShowPageNotice', array($this));
972 $this->elementEnd('div');
979 * SHOULD overload (unless there's not a notice)
983 function showPageNotice()
990 * MUST overload (unless there's not a notice)
994 protected function showContent()
1003 function showAside()
1005 $this->elementStart('div', array('id' => 'aside_primary',
1006 'class' => 'aside'));
1007 $this->showProfileBlock();
1008 if (Event::handle('StartShowObjectNavBlock', array($this))) {
1009 $this->showObjectNavBlock();
1010 Event::handle('EndShowObjectNavBlock', array($this));
1012 if (Event::handle('StartShowSections', array($this))) {
1013 $this->showSections();
1014 Event::handle('EndShowSections', array($this));
1016 if (Event::handle('StartShowExportData', array($this))) {
1017 $this->showExportData();
1018 Event::handle('EndShowExportData', array($this));
1020 $this->elementEnd('div');
1024 * Show export data feeds.
1028 function showExportData()
1030 $feeds = $this->getFeeds();
1032 $fl = new FeedList($this);
1044 function showSections()
1046 // for each section, show it
1054 function showFooter()
1056 $this->elementStart('div', array('id' => 'footer'));
1057 if (Event::handle('StartShowInsideFooter', array($this))) {
1058 $this->showSecondaryNav();
1059 $this->showLicenses();
1060 Event::handle('EndShowInsideFooter', array($this));
1062 $this->elementEnd('div');
1066 * Show secondary navigation.
1070 function showSecondaryNav()
1072 $sn = new SecondaryNav($this);
1081 function showLicenses()
1083 $this->showGNUsocialLicense();
1084 $this->showContentLicense();
1088 * Show GNU social license.
1092 function showGNUsocialLicense()
1094 if (common_config('site', 'broughtby')) {
1095 // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is set.
1096 // TRANS: Text between [] is a link description, text between () is the link itself.
1097 // TRANS: Make sure there is no whitespace between "]" and "(".
1098 // TRANS: "%%site.broughtby%%" is the value of the variable site.broughtby
1099 $instr = _('**%%site.name%%** is a social network, courtesy of [%%site.broughtby%%](%%site.broughtbyurl%%).');
1101 // TRANS: First sentence of the GNU social site license. Used if 'broughtby' is not set.
1102 $instr = _('**%%site.name%%** is a social network.');
1105 // TRANS: Second sentence of the GNU social site license. Mentions the GNU social source code license.
1106 // TRANS: Make sure there is no whitespace between "]" and "(".
1107 // TRANS: [%1$s](%2$s) is a link description followed by the link itself
1108 // TRANS: %3$s is the version of GNU social that is being used.
1109 $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);
1110 $output = common_markup_to_html($instr);
1111 $this->raw($output);
1116 * Show content license.
1120 function showContentLicense()
1122 if (Event::handle('StartShowContentLicense', array($this))) {
1123 switch (common_config('license', 'type')) {
1125 // TRANS: Content license displayed when license is set to 'private'.
1126 // TRANS: %1$s is the site name.
1127 $this->element('p', null, sprintf(_('Content and data of %1$s are private and confidential.'),
1128 common_config('site', 'name')));
1130 case 'allrightsreserved':
1131 if (common_config('license', 'owner')) {
1132 // TRANS: Content license displayed when license is set to 'allrightsreserved'.
1133 // TRANS: %1$s is the copyright owner.
1134 $this->element('p', null, sprintf(_('Content and data copyright by %1$s. All rights reserved.'),
1135 common_config('license', 'owner')));
1137 // TRANS: Content license displayed when license is set to 'allrightsreserved' and no owner is set.
1138 $this->element('p', null, _('Content and data copyright by contributors. All rights reserved.'));
1141 case 'cc': // fall through
1143 $this->elementStart('p');
1145 $image = common_config('license', 'image');
1146 $sslimage = common_config('license', 'sslimage');
1148 if (StatusNet::isHTTPS()) {
1149 if (!empty($sslimage)) {
1151 } else if (preg_match('#^http://i.creativecommons.org/#', $image)) {
1152 // CC support HTTPS on their images
1153 $url = preg_replace('/^http/', 'https', $image);
1155 // Better to show mixed content than no content
1162 $this->element('img', array('id' => 'license_cc',
1164 'alt' => common_config('license', 'title'),
1168 // TRANS: license message in footer.
1169 // TRANS: %1$s is the site name, %2$s is a link to the license URL, with a licence name set in configuration.
1170 $notice = _('All %1$s content and data are available under the %2$s license.');
1171 $link = "<a class=\"license\" rel=\"external license\" href=\"" .
1172 htmlspecialchars(common_config('license', 'url')) .
1174 htmlspecialchars(common_config('license', 'title')) .
1176 $this->raw(sprintf(htmlspecialchars($notice),
1177 htmlspecialchars(common_config('site', 'name')),
1179 $this->elementEnd('p');
1183 Event::handle('EndShowContentLicense', array($this));
1188 * Return last modified, if applicable.
1192 * @return string last modified http header
1194 function lastModified()
1196 // For comparison with If-Last-Modified
1197 // If not applicable, return null
1202 * Return etag, if applicable.
1206 * @return string etag http header
1214 * Return true if read only.
1218 * @param array $args other arguments
1220 * @return boolean is read only action?
1222 function isReadOnly($args)
1228 * Returns query argument or default value if not found
1230 * @param string $key requested argument
1231 * @param string $def default value to return if $key is not provided
1233 * @return boolean is read only action?
1235 function arg($key, $def=null)
1237 if (array_key_exists($key, $this->args)) {
1238 return $this->args[$key];
1245 * Returns trimmed query argument or default value if not found
1247 * @param string $key requested argument
1248 * @param string $def default value to return if $key is not provided
1250 * @return boolean is read only action?
1252 function trimmed($key, $def=null)
1254 $arg = $this->arg($key, $def);
1255 return is_string($arg) ? trim($arg) : $arg;
1261 * @return boolean is read only action?
1263 protected function handle()
1265 header('Vary: Accept-Encoding,Cookie');
1267 $lm = $this->lastModified();
1268 $etag = $this->etag();
1271 header('ETag: ' . $etag);
1275 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
1276 if ($this->isCacheable()) {
1277 header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
1278 header( "Cache-Control: private, must-revalidate, max-age=0" );
1285 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
1286 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
1287 if ($if_none_match) {
1288 // If this check fails, ignore the if-modified-since below.
1290 if ($this->_hasEtag($etag, $if_none_match)) {
1291 header('HTTP/1.1 304 Not Modified');
1292 // Better way to do this?
1298 if (!$checked && $lm && array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
1299 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
1300 $ims = strtotime($if_modified_since);
1302 header('HTTP/1.1 304 Not Modified');
1303 // Better way to do this?
1310 * Is this action cacheable?
1312 * If the action returns a last-modified
1314 * @param array $argarray is ignored since it's now passed in in prepare()
1316 * @return boolean is read only action?
1318 function isCacheable()
1324 * Has etag? (private)
1326 * @param string $etag etag http header
1327 * @param string $if_none_match ifNoneMatch http header
1331 function _hasEtag($etag, $if_none_match)
1333 $etags = explode(',', $if_none_match);
1334 return in_array($etag, $etags) || in_array('*', $etags);
1338 * Boolean understands english (yes, no, true, false)
1340 * @param string $key query key we're interested in
1341 * @param string $def default value
1343 * @return boolean interprets yes/no strings as boolean
1345 function boolean($key, $def=false)
1347 $arg = strtolower($this->trimmed($key));
1349 if (is_null($arg)) {
1351 } else if (in_array($arg, array('true', 'yes', '1', 'on'))) {
1353 } else if (in_array($arg, array('false', 'no', '0'))) {
1361 * Integer value of an argument
1363 * @param string $key query key we're interested in
1364 * @param string $defValue optional default value (default null)
1365 * @param string $maxValue optional max value (default null)
1366 * @param string $minValue optional min value (default null)
1368 * @return integer integer value
1370 function int($key, $defValue=null, $maxValue=null, $minValue=null)
1372 $arg = intval($this->arg($key));
1374 if (!is_numeric($this->arg($key)) || $arg != $this->arg($key)) {
1378 if (!is_null($maxValue)) {
1379 $arg = min($arg, $maxValue);
1382 if (!is_null($minValue)) {
1383 $arg = max($arg, $minValue);
1392 * @param string $msg error message to display
1393 * @param integer $code http error code, 500 by default
1397 function serverError($msg, $code=500, $format=null)
1399 if ($format === null) {
1400 $format = $this->format;
1403 common_debug("Server error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1405 if (!array_key_exists($code, ServerErrorAction::$status)) {
1409 $status_string = ServerErrorAction::$status[$code];
1413 header("HTTP/1.1 {$code} {$status_string}");
1414 $this->initDocument('xml');
1415 $this->elementStart('hash');
1416 $this->element('error', null, $msg);
1417 $this->element('request', null, $_SERVER['REQUEST_URI']);
1418 $this->elementEnd('hash');
1419 $this->endDocument('xml');
1422 if (!isset($this->callback)) {
1423 header("HTTP/1.1 {$code} {$status_string}");
1425 $this->initDocument('json');
1426 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1427 print(json_encode($error_array));
1428 $this->endDocument('json');
1431 throw new ServerException($msg, $code);
1440 * @param string $msg error message to display
1441 * @param integer $code http error code, 400 by default
1442 * @param string $format error format (json, xml, text) for ApiAction
1445 * @throws ClientException always
1447 function clientError($msg, $code=400, $format=null)
1449 // $format is currently only relevant for an ApiAction anyway
1450 if ($format === null) {
1451 $format = $this->format;
1454 common_debug("User error '{$code}' on '{$this->action}': {$msg}", __FILE__);
1456 if (!array_key_exists($code, ClientErrorAction::$status)) {
1460 $status_string = ClientErrorAction::$status[$code];
1464 header("HTTP/1.1 {$code} {$status_string}");
1465 $this->initDocument('xml');
1466 $this->elementStart('hash');
1467 $this->element('error', null, $msg);
1468 $this->element('request', null, $_SERVER['REQUEST_URI']);
1469 $this->elementEnd('hash');
1470 $this->endDocument('xml');
1473 if (!isset($this->callback)) {
1474 header("HTTP/1.1 {$code} {$status_string}");
1476 $this->initDocument('json');
1477 $error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
1478 $this->text(json_encode($error_array));
1479 $this->endDocument('json');
1482 header("HTTP/1.1 {$code} {$status_string}");
1483 header('Content-Type: text/plain; charset=utf-8');
1487 throw new ClientException($msg, $code);
1493 * If not logged in, take appropriate action (redir or exception)
1495 * @param boolean $redir Redirect to login if not logged in
1497 * @return boolean true if logged in (never returns if not)
1499 public function checkLogin($redir=true)
1501 if (common_logged_in()) {
1506 common_set_returnto($_SERVER['REQUEST_URI']);
1507 common_redirect(common_local_url('login'));
1510 // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
1511 $this->clientError(_('Not logged in.'), 403);
1515 * Returns the current URL
1517 * @return string current URL
1521 list($action, $args) = $this->returnToArgs();
1522 return common_local_url($action, $args);
1526 * Returns arguments sufficient for re-constructing URL
1528 * @return array two elements: action, other args
1530 function returnToArgs()
1532 $action = $this->getActionName();
1533 $args = $this->args;
1534 unset($args['action']);
1535 if (common_config('site', 'fancy')) {
1538 if (array_key_exists('submit', $args)) {
1539 unset($args['submit']);
1541 foreach (array_keys($_COOKIE) as $cookie) {
1542 unset($args[$cookie]);
1544 return array($action, $args);
1548 * Generate a menu item
1550 * @param string $url menu URL
1551 * @param string $text menu name
1552 * @param string $title title attribute, null by default
1553 * @param boolean $is_selected current menu item, false by default
1554 * @param string $id element id, null by default
1558 function menuItem($url, $text, $title=null, $is_selected=false, $id=null, $class=null)
1560 // Added @id to li for some control.
1561 // XXX: We might want to move this to htmloutputter.php
1564 if ($class !== null) {
1565 $classes[] = trim($class);
1568 $classes[] = 'current';
1571 if (!empty($classes)) {
1572 $lattrs['class'] = implode(' ', $classes);
1575 if (!is_null($id)) {
1576 $lattrs['id'] = $id;
1579 $this->elementStart('li', $lattrs);
1580 $attrs['href'] = $url;
1582 $attrs['title'] = $title;
1584 $this->element('a', $attrs, $text);
1585 $this->elementEnd('li');
1589 * Generate pagination links
1591 * @param boolean $have_before is there something before?
1592 * @param boolean $have_after is there something after?
1593 * @param integer $page current page
1594 * @param string $action current action
1595 * @param array $args rest of query arguments
1599 // XXX: The messages in this pagination method only tailor to navigating
1600 // notices. In other lists, "Previous"/"Next" type navigation is
1601 // desirable, but not available.
1602 function pagination($have_before, $have_after, $page, $action, $args=null)
1604 // Does a little before-after block for next/prev page
1605 if ($have_before || $have_after) {
1606 $this->elementStart('ul', array('class' => 'nav',
1607 'id' => 'pagination'));
1610 $pargs = array('page' => $page-1);
1611 $this->elementStart('li', array('class' => 'nav_prev'));
1612 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1614 // TRANS: Pagination message to go to a page displaying information more in the
1615 // TRANS: present than the currently displayed information.
1617 $this->elementEnd('li');
1620 $pargs = array('page' => $page+1);
1621 $this->elementStart('li', array('class' => 'nav_next'));
1622 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1624 // TRANS: Pagination message to go to a page displaying information more in the
1625 // TRANS: past than the currently displayed information.
1627 $this->elementEnd('li');
1629 if ($have_before || $have_after) {
1630 $this->elementEnd('ul');
1635 * An array of feeds for this action.
1637 * Returns an array of potential feeds for this action.
1639 * @return array Feed object to show in head and links
1647 * Check the session token.
1649 * Checks that the current form has the correct session token,
1650 * and throw an exception if it does not.
1654 // XXX: Finding this type of check with the same message about 50 times.
1655 // Possible to refactor?
1656 function checkSessionToken()
1659 $token = $this->trimmed('token');
1660 if (empty($token) || $token != common_session_token()) {
1661 // TRANS: Client error text when there is a problem with the session token.
1662 $this->clientError(_('There was a problem with your session token.'));
1667 * Check if the current request is a POST
1669 * @return boolean true if POST; otherwise false.
1674 return ($_SERVER['REQUEST_METHOD'] == 'POST');