3 * Laconica, 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@controlyourself.ca>
25 * @author Sarven Capadisli <csarven@controlyourself.ca>
26 * @copyright 2008 Control Yourself, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://laconi.ca/
31 if (!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@controlyourself.ca>
50 * @author Sarven Capadisli <csarven@controlyourself.ca>
51 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
52 * @link http://laconi.ca/
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 if (Event::handle('StartShowLaconicaStyles', array($this))) {
196 $this->cssLink('css/display.css',null,'screen, projection, tv');
197 if (common_config('site', 'mobile')) {
198 // TODO: "handheld" CSS for other mobile devices
199 $this->cssLink('css/mobile.css','base','only screen and (max-device-width: 480px)'); // Mobile WebKit
201 $this->cssLink('css/print.css','base','print');
202 Event::handle('EndShowLaconicaStyles', array($this));
205 if (Event::handle('StartShowUAStyles', array($this))) {
206 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
207 'href="'.theme_path('css/ie.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
208 foreach (array(6,7) as $ver) {
209 if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
210 // Yes, IE people should be put in jail.
211 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
212 'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
215 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
216 'href="'.theme_path('css/ie.css', null).'?version='.LACONICA_VERSION.'" /><![endif]');
217 Event::handle('EndShowUAStyles', array($this));
220 if (Event::handle('StartShowDesign', array($this))) {
222 $user = common_current_user();
224 if (empty($user) || $user->viewdesigns) {
225 $design = $this->getDesign();
227 if (!empty($design)) {
228 $design->showCSS($this);
232 Event::handle('EndShowDesign', array($this));
234 Event::handle('EndShowStyles', array($this));
239 * Show javascript headers
243 function showScripts()
245 if (Event::handle('StartShowScripts', array($this))) {
246 if (Event::handle('StartShowJQueryScripts', array($this))) {
247 $this->script('js/jquery.min.js');
248 $this->script('js/jquery.form.js');
249 $this->script('js/jquery.joverlay.min.js');
250 Event::handle('EndShowJQueryScripts', array($this));
252 if (Event::handle('StartShowLaconicaScripts', array($this))) {
253 $this->script('js/xbImportNode.js');
254 $this->script('js/util.js');
255 // Frame-busting code to avoid clickjacking attacks.
256 $this->element('script', array('type' => 'text/javascript'),
257 'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
258 Event::handle('EndShowLaconicaScripts', array($this));
260 Event::handle('EndShowScripts', array($this));
265 * Show OpenSearch headers
269 function showOpenSearch()
271 $this->element('link', array('rel' => 'search',
272 'type' => 'application/opensearchdescription+xml',
273 'href' => common_local_url('opensearch', array('type' => 'people')),
274 'title' => common_config('site', 'name').' People Search'));
275 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
276 'href' => common_local_url('opensearch', array('type' => 'notice')),
277 'title' => common_config('site', 'name').' Notice Search'));
290 $feeds = $this->getFeeds();
293 foreach ($feeds as $feed) {
294 $this->element('link', array('rel' => $feed->rel(),
295 'href' => $feed->url,
296 'type' => $feed->mimeType(),
297 'title' => $feed->title));
309 function showDescription()
311 // does nothing by default
315 * Show extra stuff in <head>.
323 // does nothing by default
329 * Calls template methods
335 $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
336 'class' => 'user_in')
337 : array('id' => $this->trimmed('action')));
338 $this->elementStart('div', array('id' => 'wrap'));
339 if (Event::handle('StartShowHeader', array($this))) {
341 Event::handle('EndShowHeader', array($this));
344 if (Event::handle('StartShowFooter', array($this))) {
346 Event::handle('EndShowFooter', array($this));
348 $this->elementEnd('div');
349 $this->elementEnd('body');
353 * Show header of the page.
355 * Calls template methods
359 function showHeader()
361 $this->elementStart('div', array('id' => 'header'));
363 $this->showPrimaryNav();
364 $this->showSiteNotice();
365 if (common_logged_in()) {
366 $this->showNoticeForm();
368 $this->showAnonymousMessage();
370 $this->elementEnd('div');
374 * Show configured logo.
380 $this->elementStart('address', array('id' => 'site_contact',
381 'class' => 'vcard'));
382 if (Event::handle('StartAddressData', array($this))) {
383 $this->elementStart('a', array('class' => 'url home bookmark',
384 'href' => common_local_url('public')));
385 if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
386 $this->element('img', array('class' => 'logo photo',
387 'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
388 'alt' => common_config('site', 'name')));
390 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
391 $this->elementEnd('a');
392 Event::handle('EndAddressData', array($this));
394 $this->elementEnd('address');
398 * Show primary navigation.
402 function showPrimaryNav()
404 $user = common_current_user();
406 if (common_config('xmpp', 'enabled')) {
407 $connect = 'imsettings';
408 } else if (common_config('sms', 'enabled')) {
409 $connect = 'smssettings';
410 } else if (common_config('twitter', 'enabled')) {
411 $connect = 'twittersettings';
414 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
415 $this->element('dt', null, _('Primary site navigation'));
416 $this->elementStart('dd');
417 $this->elementStart('ul', array('class' => 'nav'));
418 if (Event::handle('StartPrimaryNav', array($this))) {
420 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
421 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
422 $this->menuItem(common_local_url('profilesettings'),
423 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
425 $this->menuItem(common_local_url($connect),
426 _('Connect'), _('Connect to services'), false, 'nav_connect');
428 if (common_config('invite', 'enabled')) {
429 $this->menuItem(common_local_url('invite'),
431 sprintf(_('Invite friends and colleagues to join you on %s'),
432 common_config('site', 'name')),
433 false, 'nav_invitecontact');
435 $this->menuItem(common_local_url('logout'),
436 _('Logout'), _('Logout from the site'), false, 'nav_logout');
439 if (!common_config('site', 'openidonly')) {
440 if (!common_config('site', 'closed')) {
441 $this->menuItem(common_local_url('register'),
442 _('Register'), _('Create an account'), false, 'nav_register');
444 $this->menuItem(common_local_url('login'),
445 _('Login'), _('Login to the site'), false, 'nav_login');
447 $this->menuItem(common_local_url('openidlogin'),
448 _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
451 $this->menuItem(common_local_url('doc', array('title' => 'help')),
452 _('Help'), _('Help me!'), false, 'nav_help');
453 $this->menuItem(common_local_url('peoplesearch'),
454 _('Search'), _('Search for people or text'), false, 'nav_search');
455 Event::handle('EndPrimaryNav', array($this));
457 $this->elementEnd('ul');
458 $this->elementEnd('dd');
459 $this->elementEnd('dl');
467 function showSiteNotice()
469 // Revist. Should probably do an hAtom pattern here
470 $text = common_config('site', 'notice');
472 $this->elementStart('dl', array('id' => 'site_notice',
473 'class' => 'system_notice'));
474 $this->element('dt', null, _('Site notice'));
475 $this->elementStart('dd', null);
477 $this->elementEnd('dd');
478 $this->elementEnd('dl');
485 * MAY overload if no notice form needed... or direct message box????
489 function showNoticeForm()
491 $notice_form = new NoticeForm($this);
492 $notice_form->show();
496 * Show anonymous message.
502 function showAnonymousMessage()
504 // needs to be defined by the class
510 * Shows local navigation, content block and aside.
516 $this->elementStart('div', array('id' => 'core'));
517 if (Event::handle('StartShowLocalNavBlock', array($this))) {
518 $this->showLocalNavBlock();
519 Event::handle('EndShowLocalNavBlock', array($this));
521 if (Event::handle('StartShowContentBlock', array($this))) {
522 $this->showContentBlock();
523 Event::handle('EndShowContentBlock', array($this));
526 $this->elementEnd('div');
530 * Show local navigation block.
534 function showLocalNavBlock()
536 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
537 $this->element('dt', null, _('Local views'));
538 $this->elementStart('dd');
539 $this->showLocalNav();
540 $this->elementEnd('dd');
541 $this->elementEnd('dl');
545 * Show local navigation.
551 function showLocalNav()
553 // does nothing by default
557 * Show content block.
561 function showContentBlock()
563 $this->elementStart('div', array('id' => 'content'));
564 $this->showPageTitle();
565 $this->showPageNoticeBlock();
566 $this->elementStart('div', array('id' => 'content_inner'));
567 // show the actual content (forms, lists, whatever)
568 $this->showContent();
569 $this->elementEnd('div');
570 $this->elementEnd('div');
578 function showPageTitle()
580 $this->element('h1', null, $this->title());
584 * Show page notice block.
586 * Only show the block if a subclassed action has overrided
587 * Action::showPageNotice(), or an event handler is registered for
588 * the StartShowPageNotice event, in which case we assume the
589 * 'page_notice' definition list is desired. This is to prevent
590 * empty 'page_notice' definition lists from being output everywhere.
594 function showPageNoticeBlock()
596 $rmethod = new ReflectionMethod($this, 'showPageNotice');
597 $dclass = $rmethod->getDeclaringClass()->getName();
599 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
601 $this->elementStart('dl', array('id' => 'page_notice',
602 'class' => 'system_notice'));
603 $this->element('dt', null, _('Page notice'));
604 $this->elementStart('dd');
605 if (Event::handle('StartShowPageNotice', array($this))) {
606 $this->showPageNotice();
607 Event::handle('EndShowPageNotice', array($this));
609 $this->elementEnd('dd');
610 $this->elementEnd('dl');
617 * SHOULD overload (unless there's not a notice)
621 function showPageNotice()
628 * MUST overload (unless there's not a notice)
632 function showContent()
644 $this->elementStart('div', array('id' => 'aside_primary',
645 'class' => 'aside'));
646 if (Event::handle('StartShowExportData', array($this))) {
647 $this->showExportData();
648 Event::handle('EndShowExportData', array($this));
650 if (Event::handle('StartShowSections', array($this))) {
651 $this->showSections();
652 Event::handle('EndShowSections', array($this));
654 $this->elementEnd('div');
658 * Show export data feeds.
663 function showExportData()
665 $feeds = $this->getFeeds();
667 $fl = new FeedList($this);
679 function showSections()
681 // for each section, show it
689 function showFooter()
691 $this->elementStart('div', array('id' => 'footer'));
692 $this->showSecondaryNav();
693 $this->showLicenses();
694 $this->elementEnd('div');
698 * Show secondary navigation.
702 function showSecondaryNav()
704 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
705 $this->element('dt', null, _('Secondary site navigation'));
706 $this->elementStart('dd', null);
707 $this->elementStart('ul', array('class' => 'nav'));
708 if (Event::handle('StartSecondaryNav', array($this))) {
709 $this->menuItem(common_local_url('doc', array('title' => 'help')),
711 $this->menuItem(common_local_url('doc', array('title' => 'about')),
713 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
715 $bb = common_config('site', 'broughtby');
717 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
720 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
722 $this->menuItem(common_local_url('doc', array('title' => 'source')),
724 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
726 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
728 Event::handle('EndSecondaryNav', array($this));
730 $this->elementEnd('ul');
731 $this->elementEnd('dd');
732 $this->elementEnd('dl');
740 function showLicenses()
742 $this->elementStart('dl', array('id' => 'licenses'));
743 $this->showLaconicaLicense();
744 $this->showContentLicense();
745 $this->elementEnd('dl');
749 * Show Laconica license.
753 function showLaconicaLicense()
755 $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
756 $this->elementStart('dd', null);
757 if (common_config('site', 'broughtby')) {
758 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
760 $instr = _('**%%site.name%%** is a microblogging service. ');
762 $instr .= sprintf(_('It runs the [Laconica](http://laconi.ca/) microblogging software, version %s, available under the [GNU Affero General Public License](http://www.fsf.org/licensing/licenses/agpl-3.0.html).'), LACONICA_VERSION);
763 $output = common_markup_to_html($instr);
765 $this->elementEnd('dd');
770 * Show content license.
774 function showContentLicense()
776 $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
777 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
778 $this->elementStart('p');
779 $this->element('img', array('id' => 'license_cc',
780 'src' => common_config('license', 'image'),
781 'alt' => common_config('license', 'title'),
784 //TODO: This is dirty: i18n
785 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
786 $this->element('a', array('class' => 'license',
787 'rel' => 'external license',
788 'href' => common_config('license', 'url')),
789 common_config('license', 'title'));
790 $this->text(_('license.'));
791 $this->elementEnd('p');
792 $this->elementEnd('dd');
796 * Return last modified, if applicable.
800 * @return string last modified http header
802 function lastModified()
804 // For comparison with If-Last-Modified
805 // If not applicable, return null
810 * Return etag, if applicable.
814 * @return string etag http header
822 * Return true if read only.
826 * @param array $args other arguments
828 * @return boolean is read only action?
831 function isReadOnly($args)
837 * Returns query argument or default value if not found
839 * @param string $key requested argument
840 * @param string $def default value to return if $key is not provided
842 * @return boolean is read only action?
844 function arg($key, $def=null)
846 if (array_key_exists($key, $this->args)) {
847 return $this->args[$key];
854 * Returns trimmed query argument or default value if not found
856 * @param string $key requested argument
857 * @param string $def default value to return if $key is not provided
859 * @return boolean is read only action?
861 function trimmed($key, $def=null)
863 $arg = $this->arg($key, $def);
864 return is_string($arg) ? trim($arg) : $arg;
870 * @param array $argarray is ignored since it's now passed in in prepare()
872 * @return boolean is read only action?
874 function handle($argarray=null)
876 $lm = $this->lastModified();
877 $etag = $this->etag();
879 header('ETag: ' . $etag);
882 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
883 if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
884 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
885 $ims = strtotime($if_modified_since);
887 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
888 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
889 if (!$if_none_match ||
891 $this->_hasEtag($etag, $if_none_match)) {
892 header('HTTP/1.1 304 Not Modified');
893 // Better way to do this?
902 * HasĀ etag? (private)
904 * @param string $etag etag http header
905 * @param string $if_none_match ifNoneMatch http header
910 function _hasEtag($etag, $if_none_match)
912 $etags = explode(',', $if_none_match);
913 return in_array($etag, $etags) || in_array('*', $etags);
917 * Boolean understands english (yes, no, true, false)
919 * @param string $key query key we're interested in
920 * @param string $def default value
922 * @return boolean interprets yes/no strings as boolean
924 function boolean($key, $def=false)
926 $arg = strtolower($this->trimmed($key));
930 } else if (in_array($arg, array('true', 'yes', '1'))) {
932 } else if (in_array($arg, array('false', 'no', '0'))) {
942 * @param string $msg error message to display
943 * @param integer $code http error code, 500 by default
948 function serverError($msg, $code=500)
950 $action = $this->trimmed('action');
951 common_debug("Server error '$code' on '$action': $msg", __FILE__);
952 throw new ServerException($msg, $code);
958 * @param string $msg error message to display
959 * @param integer $code http error code, 400 by default
964 function clientError($msg, $code=400)
966 $action = $this->trimmed('action');
967 common_debug("User error '$code' on '$action': $msg", __FILE__);
968 throw new ClientException($msg, $code);
972 * Returns the current URL
974 * @return string current URL
979 $action = $this->trimmed('action');
981 unset($args['action']);
982 if (common_config('site', 'fancy')) {
985 if (array_key_exists('submit', $args)) {
986 unset($args['submit']);
988 foreach (array_keys($_COOKIE) as $cookie) {
989 unset($args[$cookie]);
992 return common_local_url($action, $args);
996 * Generate a menu item
998 * @param string $url menu URL
999 * @param string $text menu name
1000 * @param string $title title attribute, null by default
1001 * @param boolean $is_selected current menu item, false by default
1002 * @param string $id element id, null by default
1006 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1008 // Added @id to li for some control.
1009 // XXX: We might want to move this to htmloutputter.php
1012 $lattrs['class'] = 'current';
1015 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1017 $this->elementStart('li', $lattrs);
1018 $attrs['href'] = $url;
1020 $attrs['title'] = $title;
1022 $this->element('a', $attrs, $text);
1023 $this->elementEnd('li');
1027 * Generate pagination links
1029 * @param boolean $have_before is there something before?
1030 * @param boolean $have_after is there something after?
1031 * @param integer $page current page
1032 * @param string $action current action
1033 * @param array $args rest of query arguments
1037 function pagination($have_before, $have_after, $page, $action, $args=null)
1039 // Does a little before-after block for next/prev page
1040 if ($have_before || $have_after) {
1041 $this->elementStart('div', array('class' => 'pagination'));
1042 $this->elementStart('dl', null);
1043 $this->element('dt', null, _('Pagination'));
1044 $this->elementStart('dd', null);
1045 $this->elementStart('ul', array('class' => 'nav'));
1048 $pargs = array('page' => $page-1);
1049 $this->elementStart('li', array('class' => 'nav_prev'));
1050 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1053 $this->elementEnd('li');
1056 $pargs = array('page' => $page+1);
1057 $this->elementStart('li', array('class' => 'nav_next'));
1058 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1061 $this->elementEnd('li');
1063 if ($have_before || $have_after) {
1064 $this->elementEnd('ul');
1065 $this->elementEnd('dd');
1066 $this->elementEnd('dl');
1067 $this->elementEnd('div');
1072 * An array of feeds for this action.
1074 * Returns an array of potential feeds for this action.
1076 * @return array Feed object to show in head and links
1085 * A design for this action
1087 * @return Design a design object to use
1090 function getDesign()
1092 return Design::siteDesign();