3 * StatusNet, the distributed open-source microblogging tool
5 * Base class for all actions (~views)
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@status.net>
25 * @author Sarven Capadisli <csarven@status.net>
26 * @copyright 2008 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 require_once INSTALLDIR.'/lib/noticeform.php';
36 require_once INSTALLDIR.'/lib/htmloutputter.php';
39 * Base class for all actions
41 * This is the base class for all actions in the package. An action is
42 * more or less a "view" in an MVC framework.
44 * Actions are responsible for extracting and validating parameters; using
45 * model classes to read and write to the database; and doing ouput.
49 * @author Evan Prodromou <evan@status.net>
50 * @author Sarven Capadisli <csarven@status.net>
51 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
52 * @link http://status.net/
56 class Action extends HTMLOutputter // lawsuit
63 * Just wraps the HTMLOutputter constructor.
65 * @param string $output URI to output to, default = stdout
66 * @param boolean $indent Whether to indent output, default true
68 * @see XMLOutputter::__construct
69 * @see HTMLOutputter::__construct
71 function __construct($output='php://output', $indent=true)
73 parent::__construct($output, $indent);
77 * For initializing members of the class.
79 * @param array $argarray misc. arguments
81 * @return boolean true
83 function prepare($argarray)
85 $this->args =& common_copy_args($argarray);
90 * Show page, a template method.
96 if (Event::handle('StartShowHTML', array($this))) {
98 Event::handle('EndShowHTML', array($this));
100 if (Event::handle('StartShowHead', array($this))) {
102 Event::handle('EndShowHead', array($this));
104 if (Event::handle('StartShowBody', array($this))) {
106 Event::handle('EndShowBody', array($this));
108 if (Event::handle('StartEndHTML', array($this))) {
110 Event::handle('EndEndHTML', array($this));
115 * Show head, a template method.
121 // XXX: attributes (profile?)
122 $this->elementStart('head');
124 $this->showShortcutIcon();
125 $this->showStylesheets();
126 $this->showScripts();
127 $this->showOpenSearch();
129 $this->showDescription();
131 $this->elementEnd('head');
135 * Show title, a template method.
141 $this->element('title', null,
142 sprintf(_("%s - %s"),
144 common_config('site', 'name')));
148 * Returns the page title
152 * @return string page title
157 return _("Untitled page");
161 * Show themed shortcut icon
165 function showShortcutIcon()
167 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
168 $this->element('link', array('rel' => 'shortcut icon',
169 'href' => theme_path('favicon.ico')));
171 $this->element('link', array('rel' => 'shortcut icon',
172 'href' => common_path('favicon.ico')));
175 if (common_config('site', 'mobile')) {
176 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
177 $this->element('link', array('rel' => 'apple-touch-icon',
178 'href' => theme_path('apple-touch-icon.png')));
180 $this->element('link', array('rel' => 'apple-touch-icon',
181 'href' => common_path('apple-touch-icon.png')));
191 function showStylesheets()
193 if (Event::handle('StartShowStyles', array($this))) {
195 // Use old name for StatusNet for compatibility on events
197 if (Event::handle('StartShowStatusNetStyles', array($this)) &&
198 Event::handle('StartShowLaconicaStyles', array($this))) {
199 $this->cssLink('css/display.css',null,'screen, projection, tv');
200 if (common_config('site', 'mobile')) {
201 // TODO: "handheld" CSS for other mobile devices
202 $this->cssLink('css/mobile.css','base','only screen and (max-device-width: 480px)'); // Mobile WebKit
204 $this->cssLink('css/print.css','base','print');
205 Event::handle('EndShowStatusNetStyles', array($this));
206 Event::handle('EndShowLaconicaStyles', array($this));
209 if (Event::handle('StartShowUAStyles', array($this))) {
210 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
211 'href="'.theme_path('css/ie.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
212 foreach (array(6,7) as $ver) {
213 if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
214 // Yes, IE people should be put in jail.
215 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
216 'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.STATUSNET_VERSION.'" /><![endif]');
219 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
220 'href="'.theme_path('css/ie.css', null).'?version='.STATUSNET_VERSION.'" /><![endif]');
221 Event::handle('EndShowUAStyles', array($this));
224 if (Event::handle('StartShowDesign', array($this))) {
226 $user = common_current_user();
228 if (empty($user) || $user->viewdesigns) {
229 $design = $this->getDesign();
231 if (!empty($design)) {
232 $design->showCSS($this);
236 Event::handle('EndShowDesign', array($this));
238 Event::handle('EndShowStyles', array($this));
243 * Show javascript headers
247 function showScripts()
249 if (Event::handle('StartShowScripts', array($this))) {
250 if (Event::handle('StartShowJQueryScripts', array($this))) {
251 $this->script('js/jquery.min.js');
252 $this->script('js/jquery.form.js');
253 $this->script('js/jquery.joverlay.min.js');
254 Event::handle('EndShowJQueryScripts', array($this));
256 if (Event::handle('StartShowStatusNetScripts', array($this)) &&
257 Event::handle('StartShowLaconicaScripts', array($this))) {
258 $this->script('js/xbImportNode.js');
259 $this->script('js/util.js');
260 // Frame-busting code to avoid clickjacking attacks.
261 $this->element('script', array('type' => 'text/javascript'),
262 'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
263 Event::handle('EndShowStatusNetScripts', array($this));
264 Event::handle('EndShowLaconicaScripts', array($this));
266 Event::handle('EndShowScripts', array($this));
271 * Show OpenSearch headers
275 function showOpenSearch()
277 $this->element('link', array('rel' => 'search',
278 'type' => 'application/opensearchdescription+xml',
279 'href' => common_local_url('opensearch', array('type' => 'people')),
280 'title' => common_config('site', 'name').' People Search'));
281 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
282 'href' => common_local_url('opensearch', array('type' => 'notice')),
283 'title' => common_config('site', 'name').' Notice Search'));
296 $feeds = $this->getFeeds();
299 foreach ($feeds as $feed) {
300 $this->element('link', array('rel' => $feed->rel(),
301 'href' => $feed->url,
302 'type' => $feed->mimeType(),
303 'title' => $feed->title));
315 function showDescription()
317 // does nothing by default
321 * Show extra stuff in <head>.
329 // does nothing by default
335 * Calls template methods
341 $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
342 'class' => 'user_in')
343 : array('id' => $this->trimmed('action')));
344 $this->elementStart('div', array('id' => 'wrap'));
345 if (Event::handle('StartShowHeader', array($this))) {
347 Event::handle('EndShowHeader', array($this));
350 if (Event::handle('StartShowFooter', array($this))) {
352 Event::handle('EndShowFooter', array($this));
354 $this->elementEnd('div');
355 $this->elementEnd('body');
359 * Show header of the page.
361 * Calls template methods
365 function showHeader()
367 $this->elementStart('div', array('id' => 'header'));
369 $this->showPrimaryNav();
370 $this->showSiteNotice();
371 if (common_logged_in()) {
372 $this->showNoticeForm();
374 $this->showAnonymousMessage();
376 $this->elementEnd('div');
380 * Show configured logo.
386 $this->elementStart('address', array('id' => 'site_contact',
387 'class' => 'vcard'));
388 if (Event::handle('StartAddressData', array($this))) {
389 $this->elementStart('a', array('class' => 'url home bookmark',
390 'href' => common_local_url('public')));
391 if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
392 $this->element('img', array('class' => 'logo photo',
393 'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
394 'alt' => common_config('site', 'name')));
396 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
397 $this->elementEnd('a');
398 Event::handle('EndAddressData', array($this));
400 $this->elementEnd('address');
404 * Show primary navigation.
408 function showPrimaryNav()
410 $user = common_current_user();
412 if (common_config('xmpp', 'enabled')) {
413 $connect = 'imsettings';
414 } else if (common_config('sms', 'enabled')) {
415 $connect = 'smssettings';
416 } else if (common_config('twitter', 'enabled')) {
417 $connect = 'twittersettings';
420 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
421 $this->element('dt', null, _('Primary site navigation'));
422 $this->elementStart('dd');
423 $this->elementStart('ul', array('class' => 'nav'));
424 if (Event::handle('StartPrimaryNav', array($this))) {
426 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
427 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
428 $this->menuItem(common_local_url('profilesettings'),
429 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
431 $this->menuItem(common_local_url($connect),
432 _('Connect'), _('Connect to services'), false, 'nav_connect');
434 if (common_config('invite', 'enabled')) {
435 $this->menuItem(common_local_url('invite'),
437 sprintf(_('Invite friends and colleagues to join you on %s'),
438 common_config('site', 'name')),
439 false, 'nav_invitecontact');
441 $this->menuItem(common_local_url('logout'),
442 _('Logout'), _('Logout from the site'), false, 'nav_logout');
445 if (!common_config('site', 'openidonly')) {
446 if (!common_config('site', 'closed')) {
447 $this->menuItem(common_local_url('register'),
448 _('Register'), _('Create an account'), false, 'nav_register');
450 $this->menuItem(common_local_url('login'),
451 _('Login'), _('Login to the site'), false, 'nav_login');
453 $this->menuItem(common_local_url('openidlogin'),
454 _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
457 $this->menuItem(common_local_url('doc', array('title' => 'help')),
458 _('Help'), _('Help me!'), false, 'nav_help');
459 if ($user || !common_config('site', 'private')) {
460 $this->menuItem(common_local_url('peoplesearch'),
461 _('Search'), _('Search for people or text'), false, 'nav_search');
463 Event::handle('EndPrimaryNav', array($this));
465 $this->elementEnd('ul');
466 $this->elementEnd('dd');
467 $this->elementEnd('dl');
475 function showSiteNotice()
477 // Revist. Should probably do an hAtom pattern here
478 $text = common_config('site', 'notice');
480 $this->elementStart('dl', array('id' => 'site_notice',
481 'class' => 'system_notice'));
482 $this->element('dt', null, _('Site notice'));
483 $this->elementStart('dd', null);
485 $this->elementEnd('dd');
486 $this->elementEnd('dl');
493 * MAY overload if no notice form needed... or direct message box????
497 function showNoticeForm()
499 $notice_form = new NoticeForm($this);
500 $notice_form->show();
504 * Show anonymous message.
510 function showAnonymousMessage()
512 // needs to be defined by the class
518 * Shows local navigation, content block and aside.
524 $this->elementStart('div', array('id' => 'core'));
525 if (Event::handle('StartShowLocalNavBlock', array($this))) {
526 $this->showLocalNavBlock();
527 Event::handle('EndShowLocalNavBlock', array($this));
529 if (Event::handle('StartShowContentBlock', array($this))) {
530 $this->showContentBlock();
531 Event::handle('EndShowContentBlock', array($this));
534 $this->elementEnd('div');
538 * Show local navigation block.
542 function showLocalNavBlock()
544 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
545 $this->element('dt', null, _('Local views'));
546 $this->elementStart('dd');
547 $this->showLocalNav();
548 $this->elementEnd('dd');
549 $this->elementEnd('dl');
553 * Show local navigation.
559 function showLocalNav()
561 // does nothing by default
565 * Show content block.
569 function showContentBlock()
571 $this->elementStart('div', array('id' => 'content'));
572 $this->showPageTitle();
573 $this->showPageNoticeBlock();
574 $this->elementStart('div', array('id' => 'content_inner'));
575 // show the actual content (forms, lists, whatever)
576 $this->showContent();
577 $this->elementEnd('div');
578 $this->elementEnd('div');
586 function showPageTitle()
588 $this->element('h1', null, $this->title());
592 * Show page notice block.
594 * Only show the block if a subclassed action has overrided
595 * Action::showPageNotice(), or an event handler is registered for
596 * the StartShowPageNotice event, in which case we assume the
597 * 'page_notice' definition list is desired. This is to prevent
598 * empty 'page_notice' definition lists from being output everywhere.
602 function showPageNoticeBlock()
604 $rmethod = new ReflectionMethod($this, 'showPageNotice');
605 $dclass = $rmethod->getDeclaringClass()->getName();
607 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
609 $this->elementStart('dl', array('id' => 'page_notice',
610 'class' => 'system_notice'));
611 $this->element('dt', null, _('Page notice'));
612 $this->elementStart('dd');
613 if (Event::handle('StartShowPageNotice', array($this))) {
614 $this->showPageNotice();
615 Event::handle('EndShowPageNotice', array($this));
617 $this->elementEnd('dd');
618 $this->elementEnd('dl');
625 * SHOULD overload (unless there's not a notice)
629 function showPageNotice()
636 * MUST overload (unless there's not a notice)
640 function showContent()
652 $this->elementStart('div', array('id' => 'aside_primary',
653 'class' => 'aside'));
654 if (Event::handle('StartShowExportData', array($this))) {
655 $this->showExportData();
656 Event::handle('EndShowExportData', array($this));
658 if (Event::handle('StartShowSections', array($this))) {
659 $this->showSections();
660 Event::handle('EndShowSections', array($this));
662 $this->elementEnd('div');
666 * Show export data feeds.
671 function showExportData()
673 $feeds = $this->getFeeds();
675 $fl = new FeedList($this);
687 function showSections()
689 // for each section, show it
697 function showFooter()
699 $this->elementStart('div', array('id' => 'footer'));
700 $this->showSecondaryNav();
701 $this->showLicenses();
702 $this->elementEnd('div');
706 * Show secondary navigation.
710 function showSecondaryNav()
712 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
713 $this->element('dt', null, _('Secondary site navigation'));
714 $this->elementStart('dd', null);
715 $this->elementStart('ul', array('class' => 'nav'));
716 if (Event::handle('StartSecondaryNav', array($this))) {
717 $this->menuItem(common_local_url('doc', array('title' => 'help')),
719 $this->menuItem(common_local_url('doc', array('title' => 'about')),
721 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
723 $bb = common_config('site', 'broughtby');
725 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
728 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
730 $this->menuItem(common_local_url('doc', array('title' => 'source')),
732 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
734 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
736 Event::handle('EndSecondaryNav', array($this));
738 $this->elementEnd('ul');
739 $this->elementEnd('dd');
740 $this->elementEnd('dl');
748 function showLicenses()
750 $this->elementStart('dl', array('id' => 'licenses'));
751 $this->showStatusNetLicense();
752 $this->showContentLicense();
753 $this->elementEnd('dl');
757 * Show StatusNet license.
761 function showStatusNetLicense()
763 $this->element('dt', array('id' => 'site_statusnet_license'), _('StatusNet software license'));
764 $this->elementStart('dd', null);
765 if (common_config('site', 'broughtby')) {
766 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
768 $instr = _('**%%site.name%%** is a microblogging service. ');
770 $instr .= sprintf(_('It runs the [StatusNet](http://status.net/) microblogging software, version %s, available under the [GNU Affero General Public License](http://www.fsf.org/licensing/licenses/agpl-3.0.html).'), STATUSNET_VERSION);
771 $output = common_markup_to_html($instr);
773 $this->elementEnd('dd');
778 * Show content license.
782 function showContentLicense()
784 $this->element('dt', array('id' => 'site_content_license'), _('Site content license'));
785 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
786 $this->elementStart('p');
787 $this->element('img', array('id' => 'license_cc',
788 'src' => common_config('license', 'image'),
789 'alt' => common_config('license', 'title'),
792 //TODO: This is dirty: i18n
793 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
794 $this->element('a', array('class' => 'license',
795 'rel' => 'external license',
796 'href' => common_config('license', 'url')),
797 common_config('license', 'title'));
798 $this->text(_('license.'));
799 $this->elementEnd('p');
800 $this->elementEnd('dd');
804 * Return last modified, if applicable.
808 * @return string last modified http header
810 function lastModified()
812 // For comparison with If-Last-Modified
813 // If not applicable, return null
818 * Return etag, if applicable.
822 * @return string etag http header
830 * Return true if read only.
834 * @param array $args other arguments
836 * @return boolean is read only action?
839 function isReadOnly($args)
845 * Returns query argument or default value if not found
847 * @param string $key requested argument
848 * @param string $def default value to return if $key is not provided
850 * @return boolean is read only action?
852 function arg($key, $def=null)
854 if (array_key_exists($key, $this->args)) {
855 return $this->args[$key];
862 * Returns trimmed query argument or default value if not found
864 * @param string $key requested argument
865 * @param string $def default value to return if $key is not provided
867 * @return boolean is read only action?
869 function trimmed($key, $def=null)
871 $arg = $this->arg($key, $def);
872 return is_string($arg) ? trim($arg) : $arg;
878 * @param array $argarray is ignored since it's now passed in in prepare()
880 * @return boolean is read only action?
882 function handle($argarray=null)
884 header('Vary: Accept-Encoding,Cookie');
885 $lm = $this->lastModified();
886 $etag = $this->etag();
888 header('ETag: ' . $etag);
891 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
892 if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
893 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
894 $ims = strtotime($if_modified_since);
896 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
897 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
898 if (!$if_none_match ||
900 $this->_hasEtag($etag, $if_none_match)) {
901 header('HTTP/1.1 304 Not Modified');
902 // Better way to do this?
911 * HasĀ etag? (private)
913 * @param string $etag etag http header
914 * @param string $if_none_match ifNoneMatch http header
919 function _hasEtag($etag, $if_none_match)
921 $etags = explode(',', $if_none_match);
922 return in_array($etag, $etags) || in_array('*', $etags);
926 * Boolean understands english (yes, no, true, false)
928 * @param string $key query key we're interested in
929 * @param string $def default value
931 * @return boolean interprets yes/no strings as boolean
933 function boolean($key, $def=false)
935 $arg = strtolower($this->trimmed($key));
939 } else if (in_array($arg, array('true', 'yes', '1'))) {
941 } else if (in_array($arg, array('false', 'no', '0'))) {
951 * @param string $msg error message to display
952 * @param integer $code http error code, 500 by default
957 function serverError($msg, $code=500)
959 $action = $this->trimmed('action');
960 common_debug("Server error '$code' on '$action': $msg", __FILE__);
961 throw new ServerException($msg, $code);
967 * @param string $msg error message to display
968 * @param integer $code http error code, 400 by default
973 function clientError($msg, $code=400)
975 $action = $this->trimmed('action');
976 common_debug("User error '$code' on '$action': $msg", __FILE__);
977 throw new ClientException($msg, $code);
981 * Returns the current URL
983 * @return string current URL
988 $action = $this->trimmed('action');
990 unset($args['action']);
991 if (common_config('site', 'fancy')) {
994 if (array_key_exists('submit', $args)) {
995 unset($args['submit']);
997 foreach (array_keys($_COOKIE) as $cookie) {
998 unset($args[$cookie]);
1001 return common_local_url($action, $args);
1005 * Generate a menu item
1007 * @param string $url menu URL
1008 * @param string $text menu name
1009 * @param string $title title attribute, null by default
1010 * @param boolean $is_selected current menu item, false by default
1011 * @param string $id element id, null by default
1015 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1017 // Added @id to li for some control.
1018 // XXX: We might want to move this to htmloutputter.php
1021 $lattrs['class'] = 'current';
1024 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1026 $this->elementStart('li', $lattrs);
1027 $attrs['href'] = $url;
1029 $attrs['title'] = $title;
1031 $this->element('a', $attrs, $text);
1032 $this->elementEnd('li');
1036 * Generate pagination links
1038 * @param boolean $have_before is there something before?
1039 * @param boolean $have_after is there something after?
1040 * @param integer $page current page
1041 * @param string $action current action
1042 * @param array $args rest of query arguments
1046 function pagination($have_before, $have_after, $page, $action, $args=null)
1048 // Does a little before-after block for next/prev page
1049 if ($have_before || $have_after) {
1050 $this->elementStart('div', array('class' => 'pagination'));
1051 $this->elementStart('dl', null);
1052 $this->element('dt', null, _('Pagination'));
1053 $this->elementStart('dd', null);
1054 $this->elementStart('ul', array('class' => 'nav'));
1057 $pargs = array('page' => $page-1);
1058 $this->elementStart('li', array('class' => 'nav_prev'));
1059 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1062 $this->elementEnd('li');
1065 $pargs = array('page' => $page+1);
1066 $this->elementStart('li', array('class' => 'nav_next'));
1067 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1070 $this->elementEnd('li');
1072 if ($have_before || $have_after) {
1073 $this->elementEnd('ul');
1074 $this->elementEnd('dd');
1075 $this->elementEnd('dl');
1076 $this->elementEnd('div');
1081 * An array of feeds for this action.
1083 * Returns an array of potential feeds for this action.
1085 * @return array Feed object to show in head and links
1094 * A design for this action
1096 * @return Design a design object to use
1099 function getDesign()
1101 return Design::siteDesign();