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->element('link', array('rel' => 'stylesheet',
197 'type' => 'text/css',
198 'href' => theme_path('css/display.css', null) . '?version=' . LACONICA_VERSION,
199 'media' => 'screen, projection, tv'));
200 if (common_config('site', 'mobile')) {
201 $this->element('link', array('rel' => 'stylesheet',
202 'type' => 'text/css',
203 'href' => theme_path('css/mobile.css', 'base') . '?version=' . LACONICA_VERSION,
204 // TODO: "handheld" CSS for other mobile devices
205 'media' => 'only screen and (max-device-width: 480px)')); // Mobile WebKit
207 $this->element('link', array('rel' => 'stylesheet',
208 'type' => 'text/css',
209 'href' => theme_path('css/print.css', 'base') . '?version=' . LACONICA_VERSION,
210 'media' => 'print'));
211 Event::handle('EndShowLaconicaStyles', array($this));
214 if (Event::handle('StartShowUAStyles', array($this))) {
215 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
216 'href="'.theme_path('css/ie.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
217 foreach (array(6,7) as $ver) {
218 if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
219 // Yes, IE people should be put in jail.
220 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
221 'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
224 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
225 'href="'.theme_path('css/ie.css', null).'?version='.LACONICA_VERSION.'" /><![endif]');
226 Event::handle('EndShowUAStyles', array($this));
229 if (Event::handle('StartShowDesign', array($this))) {
231 $user = common_current_user();
233 if (empty($user) || $user->viewdesigns) {
234 $design = $this->getDesign();
236 if (!empty($design)) {
237 $design->showCSS($this);
241 Event::handle('EndShowDesign', array($this));
243 Event::handle('EndShowStyles', array($this));
248 * Show javascript headers
252 function showScripts()
254 if (Event::handle('StartShowScripts', array($this))) {
255 if (Event::handle('StartShowJQueryScripts', array($this))) {
256 $this->element('script', array('type' => 'text/javascript',
257 'src' => common_path('js/jquery.min.js')),
259 $this->element('script', array('type' => 'text/javascript',
260 'src' => common_path('js/jquery.form.js')),
263 $this->element('script', array('type' => 'text/javascript',
264 'src' => common_path('js/jquery.joverlay.min.js')),
267 Event::handle('EndShowJQueryScripts', array($this));
269 if (Event::handle('StartShowLaconicaScripts', array($this))) {
270 $this->element('script', array('type' => 'text/javascript',
271 'src' => common_path('js/xbImportNode.js')),
273 $this->element('script', array('type' => 'text/javascript',
274 'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
276 // Frame-busting code to avoid clickjacking attacks.
277 $this->element('script', array('type' => 'text/javascript'),
278 'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
279 Event::handle('EndShowLaconicaScripts', array($this));
281 Event::handle('EndShowScripts', array($this));
286 * Show OpenSearch headers
290 function showOpenSearch()
292 $this->element('link', array('rel' => 'search',
293 'type' => 'application/opensearchdescription+xml',
294 'href' => common_local_url('opensearch', array('type' => 'people')),
295 'title' => common_config('site', 'name').' People Search'));
296 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
297 'href' => common_local_url('opensearch', array('type' => 'notice')),
298 'title' => common_config('site', 'name').' Notice Search'));
311 $feeds = $this->getFeeds();
314 foreach ($feeds as $feed) {
315 $this->element('link', array('rel' => $feed->rel(),
316 'href' => $feed->url,
317 'type' => $feed->mimeType(),
318 'title' => $feed->title));
330 function showDescription()
332 // does nothing by default
336 * Show extra stuff in <head>.
344 // does nothing by default
350 * Calls template methods
356 $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
357 'class' => 'user_in')
358 : array('id' => $this->trimmed('action')));
359 $this->elementStart('div', array('id' => 'wrap'));
360 if (Event::handle('StartShowHeader', array($this))) {
362 Event::handle('EndShowHeader', array($this));
365 if (Event::handle('StartShowFooter', array($this))) {
367 Event::handle('EndShowFooter', array($this));
369 $this->elementEnd('div');
370 $this->elementEnd('body');
374 * Show header of the page.
376 * Calls template methods
380 function showHeader()
382 $this->elementStart('div', array('id' => 'header'));
384 $this->showPrimaryNav();
385 $this->showSiteNotice();
386 if (common_logged_in()) {
387 $this->showNoticeForm();
389 $this->showAnonymousMessage();
391 $this->elementEnd('div');
395 * Show configured logo.
401 $this->elementStart('address', array('id' => 'site_contact',
402 'class' => 'vcard'));
403 if (Event::handle('StartAddressData', array($this))) {
404 $this->elementStart('a', array('class' => 'url home bookmark',
405 'href' => common_local_url('public')));
406 if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
407 $this->element('img', array('class' => 'logo photo',
408 'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
409 'alt' => common_config('site', 'name')));
411 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
412 $this->elementEnd('a');
413 Event::handle('EndAddressData', array($this));
415 $this->elementEnd('address');
419 * Show primary navigation.
423 function showPrimaryNav()
425 $user = common_current_user();
427 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
428 $this->element('dt', null, _('Primary site navigation'));
429 $this->elementStart('dd');
430 $this->elementStart('ul', array('class' => 'nav'));
431 if (Event::handle('StartPrimaryNav', array($this))) {
433 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
434 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
435 $this->menuItem(common_local_url('profilesettings'),
436 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
437 if (common_config('xmpp', 'enabled')) {
438 $this->menuItem(common_local_url('imsettings'),
439 _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
441 $this->menuItem(common_local_url('smssettings'),
442 _('Connect'), _('Connect to SMS, Twitter'), false, 'nav_connect');
444 if (common_config('invite', 'enabled')) {
445 $this->menuItem(common_local_url('invite'),
447 sprintf(_('Invite friends and colleagues to join you on %s'),
448 common_config('site', 'name')),
449 false, 'nav_invitecontact');
451 $this->menuItem(common_local_url('logout'),
452 _('Logout'), _('Logout from the site'), false, 'nav_logout');
455 if (!common_config('site', 'closed')) {
456 $this->menuItem(common_local_url('register'),
457 _('Register'), _('Create an account'), false, 'nav_register');
459 $this->menuItem(common_local_url('login'),
460 _('Login'), _('Login to the site'), false, 'nav_login');
462 $this->menuItem(common_local_url('doc', array('title' => 'help')),
463 _('Help'), _('Help me!'), false, 'nav_help');
464 $this->menuItem(common_local_url('peoplesearch'),
465 _('Search'), _('Search for people or text'), false, 'nav_search');
466 Event::handle('EndPrimaryNav', array($this));
468 $this->elementEnd('ul');
469 $this->elementEnd('dd');
470 $this->elementEnd('dl');
478 function showSiteNotice()
480 // Revist. Should probably do an hAtom pattern here
481 $text = common_config('site', 'notice');
483 $this->elementStart('dl', array('id' => 'site_notice',
484 'class' => 'system_notice'));
485 $this->element('dt', null, _('Site notice'));
486 $this->elementStart('dd', null);
488 $this->elementEnd('dd');
489 $this->elementEnd('dl');
496 * MAY overload if no notice form needed... or direct message box????
500 function showNoticeForm()
502 $notice_form = new NoticeForm($this);
503 $notice_form->show();
507 * Show anonymous message.
513 function showAnonymousMessage()
515 // needs to be defined by the class
521 * Shows local navigation, content block and aside.
527 $this->elementStart('div', array('id' => 'core'));
528 if (Event::handle('StartShowLocalNavBlock', array($this))) {
529 $this->showLocalNavBlock();
530 Event::handle('EndShowLocalNavBlock', array($this));
532 if (Event::handle('StartShowContentBlock', array($this))) {
533 $this->showContentBlock();
534 Event::handle('EndShowContentBlock', array($this));
537 $this->elementEnd('div');
541 * Show local navigation block.
545 function showLocalNavBlock()
547 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
548 $this->element('dt', null, _('Local views'));
549 $this->elementStart('dd');
550 $this->showLocalNav();
551 $this->elementEnd('dd');
552 $this->elementEnd('dl');
556 * Show local navigation.
562 function showLocalNav()
564 // does nothing by default
568 * Show content block.
572 function showContentBlock()
574 $this->elementStart('div', array('id' => 'content'));
575 $this->showPageTitle();
576 $this->showPageNoticeBlock();
577 $this->elementStart('div', array('id' => 'content_inner'));
578 // show the actual content (forms, lists, whatever)
579 $this->showContent();
580 $this->elementEnd('div');
581 $this->elementEnd('div');
589 function showPageTitle()
591 $this->element('h1', null, $this->title());
595 * Show page notice block.
597 * Only show the block if a subclassed action has overrided
598 * Action::showPageNotice(), or an event handler is registered for
599 * the StartShowPageNotice event, in which case we assume the
600 * 'page_notice' definition list is desired. This is to prevent
601 * empty 'page_notice' definition lists from being output everywhere.
605 function showPageNoticeBlock()
607 $rmethod = new ReflectionMethod($this, 'showPageNotice');
608 $dclass = $rmethod->getDeclaringClass()->getName();
610 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
612 $this->elementStart('dl', array('id' => 'page_notice',
613 'class' => 'system_notice'));
614 $this->element('dt', null, _('Page notice'));
615 $this->elementStart('dd');
616 if (Event::handle('StartShowPageNotice', array($this))) {
617 $this->showPageNotice();
618 Event::handle('EndShowPageNotice', array($this));
620 $this->elementEnd('dd');
621 $this->elementEnd('dl');
628 * SHOULD overload (unless there's not a notice)
632 function showPageNotice()
639 * MUST overload (unless there's not a notice)
643 function showContent()
655 $this->elementStart('div', array('id' => 'aside_primary',
656 'class' => 'aside'));
657 if (Event::handle('StartShowExportData', array($this))) {
658 $this->showExportData();
659 Event::handle('EndShowExportData', array($this));
661 if (Event::handle('StartShowSections', array($this))) {
662 $this->showSections();
663 Event::handle('EndShowSections', array($this));
665 $this->elementEnd('div');
669 * Show export data feeds.
674 function showExportData()
676 $feeds = $this->getFeeds();
678 $fl = new FeedList($this);
690 function showSections()
692 // for each section, show it
700 function showFooter()
702 $this->elementStart('div', array('id' => 'footer'));
703 $this->showSecondaryNav();
704 $this->showLicenses();
705 $this->elementEnd('div');
709 * Show secondary navigation.
713 function showSecondaryNav()
715 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
716 $this->element('dt', null, _('Secondary site navigation'));
717 $this->elementStart('dd', null);
718 $this->elementStart('ul', array('class' => 'nav'));
719 if (Event::handle('StartSecondaryNav', array($this))) {
720 $this->menuItem(common_local_url('doc', array('title' => 'help')),
722 $this->menuItem(common_local_url('doc', array('title' => 'about')),
724 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
726 $bb = common_config('site', 'broughtby');
728 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
731 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
733 $this->menuItem(common_local_url('doc', array('title' => 'source')),
735 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
737 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
739 Event::handle('EndSecondaryNav', array($this));
741 $this->elementEnd('ul');
742 $this->elementEnd('dd');
743 $this->elementEnd('dl');
751 function showLicenses()
753 $this->elementStart('dl', array('id' => 'licenses'));
754 $this->showLaconicaLicense();
755 $this->showContentLicense();
756 $this->elementEnd('dl');
760 * Show Laconica license.
764 function showLaconicaLicense()
766 $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
767 $this->elementStart('dd', null);
768 if (common_config('site', 'broughtby')) {
769 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
771 $instr = _('**%%site.name%%** is a microblogging service. ');
773 $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);
774 $output = common_markup_to_html($instr);
776 $this->elementEnd('dd');
781 * Show content license.
785 function showContentLicense()
787 $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
788 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
789 $this->elementStart('p');
790 $this->element('img', array('id' => 'license_cc',
791 'src' => common_config('license', 'image'),
792 'alt' => common_config('license', 'title'),
795 //TODO: This is dirty: i18n
796 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
797 $this->element('a', array('class' => 'license',
798 'rel' => 'external license',
799 'href' => common_config('license', 'url')),
800 common_config('license', 'title'));
801 $this->text(_('license.'));
802 $this->elementEnd('p');
803 $this->elementEnd('dd');
807 * Return last modified, if applicable.
811 * @return string last modified http header
813 function lastModified()
815 // For comparison with If-Last-Modified
816 // If not applicable, return null
821 * Return etag, if applicable.
825 * @return string etag http header
833 * Return true if read only.
837 * @param array $args other arguments
839 * @return boolean is read only action?
842 function isReadOnly($args)
848 * Returns query argument or default value if not found
850 * @param string $key requested argument
851 * @param string $def default value to return if $key is not provided
853 * @return boolean is read only action?
855 function arg($key, $def=null)
857 if (array_key_exists($key, $this->args)) {
858 return $this->args[$key];
865 * Returns trimmed query argument or default value if not found
867 * @param string $key requested argument
868 * @param string $def default value to return if $key is not provided
870 * @return boolean is read only action?
872 function trimmed($key, $def=null)
874 $arg = $this->arg($key, $def);
875 return is_string($arg) ? trim($arg) : $arg;
881 * @param array $argarray is ignored since it's now passed in in prepare()
883 * @return boolean is read only action?
885 function handle($argarray=null)
887 $lm = $this->lastModified();
888 $etag = $this->etag();
890 header('ETag: ' . $etag);
893 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
894 if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
895 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
896 $ims = strtotime($if_modified_since);
898 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
899 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
900 if (!$if_none_match ||
902 $this->_hasEtag($etag, $if_none_match)) {
903 header('HTTP/1.1 304 Not Modified');
904 // Better way to do this?
913 * HasĀ etag? (private)
915 * @param string $etag etag http header
916 * @param string $if_none_match ifNoneMatch http header
921 function _hasEtag($etag, $if_none_match)
923 $etags = explode(',', $if_none_match);
924 return in_array($etag, $etags) || in_array('*', $etags);
928 * Boolean understands english (yes, no, true, false)
930 * @param string $key query key we're interested in
931 * @param string $def default value
933 * @return boolean interprets yes/no strings as boolean
935 function boolean($key, $def=false)
937 $arg = strtolower($this->trimmed($key));
941 } else if (in_array($arg, array('true', 'yes', '1'))) {
943 } else if (in_array($arg, array('false', 'no', '0'))) {
953 * @param string $msg error message to display
954 * @param integer $code http error code, 500 by default
959 function serverError($msg, $code=500)
961 $action = $this->trimmed('action');
962 common_debug("Server error '$code' on '$action': $msg", __FILE__);
963 throw new ServerException($msg, $code);
969 * @param string $msg error message to display
970 * @param integer $code http error code, 400 by default
975 function clientError($msg, $code=400)
977 $action = $this->trimmed('action');
978 common_debug("User error '$code' on '$action': $msg", __FILE__);
979 throw new ClientException($msg, $code);
983 * Returns the current URL
985 * @return string current URL
990 $action = $this->trimmed('action');
992 unset($args['action']);
993 if (common_config('site', 'fancy')) {
996 if (array_key_exists('submit', $args)) {
997 unset($args['submit']);
999 foreach (array_keys($_COOKIE) as $cookie) {
1000 unset($args[$cookie]);
1003 return common_local_url($action, $args);
1007 * Generate a menu item
1009 * @param string $url menu URL
1010 * @param string $text menu name
1011 * @param string $title title attribute, null by default
1012 * @param boolean $is_selected current menu item, false by default
1013 * @param string $id element id, null by default
1017 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1019 // Added @id to li for some control.
1020 // XXX: We might want to move this to htmloutputter.php
1023 $lattrs['class'] = 'current';
1026 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1028 $this->elementStart('li', $lattrs);
1029 $attrs['href'] = $url;
1031 $attrs['title'] = $title;
1033 $this->element('a', $attrs, $text);
1034 $this->elementEnd('li');
1038 * Generate pagination links
1040 * @param boolean $have_before is there something before?
1041 * @param boolean $have_after is there something after?
1042 * @param integer $page current page
1043 * @param string $action current action
1044 * @param array $args rest of query arguments
1048 function pagination($have_before, $have_after, $page, $action, $args=null)
1050 // Does a little before-after block for next/prev page
1051 if ($have_before || $have_after) {
1052 $this->elementStart('div', array('class' => 'pagination'));
1053 $this->elementStart('dl', null);
1054 $this->element('dt', null, _('Pagination'));
1055 $this->elementStart('dd', null);
1056 $this->elementStart('ul', array('class' => 'nav'));
1059 $pargs = array('page' => $page-1);
1060 $this->elementStart('li', array('class' => 'nav_prev'));
1061 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1064 $this->elementEnd('li');
1067 $pargs = array('page' => $page+1);
1068 $this->elementStart('li', array('class' => 'nav_next'));
1069 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1072 $this->elementEnd('li');
1074 if ($have_before || $have_after) {
1075 $this->elementEnd('ul');
1076 $this->elementEnd('dd');
1077 $this->elementEnd('dl');
1078 $this->elementEnd('div');
1083 * An array of feeds for this action.
1085 * Returns an array of potential feeds for this action.
1087 * @return array Feed object to show in head and links
1096 * A design for this action
1098 * @return Design a design object to use
1101 function getDesign()
1103 return Design::siteDesign();