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');
123 if (Event::handle('StartHeadChildren', array($this))) {
125 $this->showShortcutIcon();
126 $this->showStylesheets();
127 $this->showScripts();
128 $this->showOpenSearch();
130 $this->showDescription();
132 Event::handle('EndHeadChildren', array($this));
134 $this->elementEnd('head');
138 * Show title, a template method.
144 $this->element('title', null,
145 sprintf(_("%s - %s"),
147 common_config('site', 'name')));
151 * Returns the page title
155 * @return string page title
160 return _("Untitled page");
164 * Show themed shortcut icon
168 function showShortcutIcon()
170 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
171 $this->element('link', array('rel' => 'shortcut icon',
172 'href' => theme_path('favicon.ico')));
174 $this->element('link', array('rel' => 'shortcut icon',
175 'href' => common_path('favicon.ico')));
178 if (common_config('site', 'mobile')) {
179 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
180 $this->element('link', array('rel' => 'apple-touch-icon',
181 'href' => theme_path('apple-touch-icon.png')));
183 $this->element('link', array('rel' => 'apple-touch-icon',
184 'href' => common_path('apple-touch-icon.png')));
194 function showStylesheets()
196 if (Event::handle('StartShowStyles', array($this))) {
198 if (Event::handle('StartShowLaconicaStyles', array($this))) {
199 $this->element('link', array('rel' => 'stylesheet',
200 'type' => 'text/css',
201 'href' => theme_path('css/display.css', null) . '?version=' . LACONICA_VERSION,
202 'media' => 'screen, projection, tv'));
203 if (common_config('site', 'mobile')) {
204 $this->element('link', array('rel' => 'stylesheet',
205 'type' => 'text/css',
206 'href' => theme_path('css/mobile.css', 'base') . '?version=' . LACONICA_VERSION,
207 // TODO: "handheld" CSS for other mobile devices
208 'media' => 'only screen and (max-device-width: 480px)')); // Mobile WebKit
210 $this->element('link', array('rel' => 'stylesheet',
211 'type' => 'text/css',
212 'href' => theme_path('css/print.css', 'base') . '?version=' . LACONICA_VERSION,
213 'media' => 'print'));
214 Event::handle('EndShowLaconicaStyles', array($this));
217 if (Event::handle('StartShowUAStyles', array($this))) {
218 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
219 'href="'.theme_path('css/ie.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
220 foreach (array(6,7) as $ver) {
221 if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
222 // Yes, IE people should be put in jail.
223 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
224 'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
227 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
228 'href="'.theme_path('css/ie.css', null).'?version='.LACONICA_VERSION.'" /><![endif]');
229 Event::handle('EndShowUAStyles', array($this));
232 if (Event::handle('StartShowDesign', array($this))) {
234 $user = common_current_user();
236 if (empty($user) || $user->viewdesigns) {
237 $design = $this->getDesign();
239 if (!empty($design)) {
240 $design->showCSS($this);
244 Event::handle('EndShowDesign', array($this));
246 Event::handle('EndShowStyles', array($this));
251 * Show javascript headers
255 function showScripts()
257 if (Event::handle('StartShowScripts', array($this))) {
258 if (Event::handle('StartShowJQueryScripts', array($this))) {
259 $this->element('script', array('type' => 'text/javascript',
260 'src' => common_path('js/jquery.min.js')),
262 $this->element('script', array('type' => 'text/javascript',
263 'src' => common_path('js/jquery.form.js')),
266 $this->element('script', array('type' => 'text/javascript',
267 'src' => common_path('js/jquery.joverlay.min.js')),
270 Event::handle('EndShowJQueryScripts', array($this));
272 if (Event::handle('StartShowLaconicaScripts', array($this))) {
273 $this->element('script', array('type' => 'text/javascript',
274 'src' => common_path('js/xbImportNode.js')),
276 $this->element('script', array('type' => 'text/javascript',
277 'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
279 // Frame-busting code to avoid clickjacking attacks.
280 $this->element('script', array('type' => 'text/javascript'),
281 'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
282 Event::handle('EndShowLaconicaScripts', array($this));
284 Event::handle('EndShowScripts', array($this));
289 * Show OpenSearch headers
293 function showOpenSearch()
295 $this->element('link', array('rel' => 'search',
296 'type' => 'application/opensearchdescription+xml',
297 'href' => common_local_url('opensearch', array('type' => 'people')),
298 'title' => common_config('site', 'name').' People Search'));
299 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
300 'href' => common_local_url('opensearch', array('type' => 'notice')),
301 'title' => common_config('site', 'name').' Notice Search'));
314 $feeds = $this->getFeeds();
317 foreach ($feeds as $feed) {
318 $this->element('link', array('rel' => $feed->rel(),
319 'href' => $feed->url,
320 'type' => $feed->mimeType(),
321 'title' => $feed->title));
333 function showDescription()
335 // does nothing by default
339 * Show extra stuff in <head>.
347 // does nothing by default
353 * Calls template methods
359 $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
360 'class' => 'user_in')
361 : array('id' => $this->trimmed('action')));
362 $this->elementStart('div', array('id' => 'wrap'));
363 if (Event::handle('StartShowHeader', array($this))) {
365 Event::handle('EndShowHeader', array($this));
368 if (Event::handle('StartShowFooter', array($this))) {
370 Event::handle('EndShowFooter', array($this));
372 $this->elementEnd('div');
373 $this->elementEnd('body');
377 * Show header of the page.
379 * Calls template methods
383 function showHeader()
385 $this->elementStart('div', array('id' => 'header'));
387 $this->showPrimaryNav();
388 $this->showSiteNotice();
389 if (common_logged_in()) {
390 $this->showNoticeForm();
392 $this->showAnonymousMessage();
394 $this->elementEnd('div');
398 * Show configured logo.
404 $this->elementStart('address', array('id' => 'site_contact',
405 'class' => 'vcard'));
406 if (Event::handle('StartAddressData', array($this))) {
407 $this->elementStart('a', array('class' => 'url home bookmark',
408 'href' => common_local_url('public')));
409 if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
410 $this->element('img', array('class' => 'logo photo',
411 'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
412 'alt' => common_config('site', 'name')));
414 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
415 $this->elementEnd('a');
416 Event::handle('EndAddressData', array($this));
418 $this->elementEnd('address');
422 * Show primary navigation.
426 function showPrimaryNav()
428 $user = common_current_user();
430 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
431 $this->element('dt', null, _('Primary site navigation'));
432 $this->elementStart('dd');
433 $this->elementStart('ul', array('class' => 'nav'));
434 if (Event::handle('StartPrimaryNav', array($this))) {
436 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
437 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
438 $this->menuItem(common_local_url('profilesettings'),
439 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
440 if (common_config('xmpp', 'enabled')) {
441 $this->menuItem(common_local_url('imsettings'),
442 _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
444 $this->menuItem(common_local_url('smssettings'),
445 _('Connect'), _('Connect to SMS, Twitter'), false, 'nav_connect');
447 if (common_config('invite', 'enabled')) {
448 $this->menuItem(common_local_url('invite'),
450 sprintf(_('Invite friends and colleagues to join you on %s'),
451 common_config('site', 'name')),
452 false, 'nav_invitecontact');
454 $this->menuItem(common_local_url('logout'),
455 _('Logout'), _('Logout from the site'), false, 'nav_logout');
458 if (!common_config('site', 'closed')) {
459 $this->menuItem(common_local_url('register'),
460 _('Register'), _('Create an account'), false, 'nav_register');
462 $this->menuItem(common_local_url('login'),
463 _('Login'), _('Login to the site'), false, 'nav_login');
465 $this->menuItem(common_local_url('doc', array('title' => 'help')),
466 _('Help'), _('Help me!'), false, 'nav_help');
467 $this->menuItem(common_local_url('peoplesearch'),
468 _('Search'), _('Search for people or text'), false, 'nav_search');
469 Event::handle('EndPrimaryNav', array($this));
471 $this->elementEnd('ul');
472 $this->elementEnd('dd');
473 $this->elementEnd('dl');
481 function showSiteNotice()
483 // Revist. Should probably do an hAtom pattern here
484 $text = common_config('site', 'notice');
486 $this->elementStart('dl', array('id' => 'site_notice',
487 'class' => 'system_notice'));
488 $this->element('dt', null, _('Site notice'));
489 $this->elementStart('dd', null);
491 $this->elementEnd('dd');
492 $this->elementEnd('dl');
499 * MAY overload if no notice form needed... or direct message box????
503 function showNoticeForm()
505 $notice_form = new NoticeForm($this);
506 $notice_form->show();
510 * Show anonymous message.
516 function showAnonymousMessage()
518 // needs to be defined by the class
524 * Shows local navigation, content block and aside.
530 $this->elementStart('div', array('id' => 'core'));
531 if (Event::handle('StartShowLocalNavBlock', array($this))) {
532 $this->showLocalNavBlock();
533 Event::handle('EndShowLocalNavBlock', array($this));
535 if (Event::handle('StartShowContentBlock', array($this))) {
536 $this->showContentBlock();
537 Event::handle('EndShowContentBlock', array($this));
540 $this->elementEnd('div');
544 * Show local navigation block.
548 function showLocalNavBlock()
550 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
551 $this->element('dt', null, _('Local views'));
552 $this->elementStart('dd');
553 $this->showLocalNav();
554 $this->elementEnd('dd');
555 $this->elementEnd('dl');
559 * Show local navigation.
565 function showLocalNav()
567 // does nothing by default
571 * Show content block.
575 function showContentBlock()
577 $this->elementStart('div', array('id' => 'content'));
578 $this->showPageTitle();
579 $this->showPageNoticeBlock();
580 $this->elementStart('div', array('id' => 'content_inner'));
581 // show the actual content (forms, lists, whatever)
582 $this->showContent();
583 $this->elementEnd('div');
584 $this->elementEnd('div');
592 function showPageTitle()
594 $this->element('h1', null, $this->title());
598 * Show page notice block.
600 * Only show the block if a subclassed action has overrided
601 * Action::showPageNotice(), or an event handler is registered for
602 * the StartShowPageNotice event, in which case we assume the
603 * 'page_notice' definition list is desired. This is to prevent
604 * empty 'page_notice' definition lists from being output everywhere.
608 function showPageNoticeBlock()
610 $rmethod = new ReflectionMethod($this, 'showPageNotice');
611 $dclass = $rmethod->getDeclaringClass()->getName();
613 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
615 $this->elementStart('dl', array('id' => 'page_notice',
616 'class' => 'system_notice'));
617 $this->element('dt', null, _('Page notice'));
618 $this->elementStart('dd');
619 if (Event::handle('StartShowPageNotice', array($this))) {
620 $this->showPageNotice();
621 Event::handle('EndShowPageNotice', array($this));
623 $this->elementEnd('dd');
624 $this->elementEnd('dl');
631 * SHOULD overload (unless there's not a notice)
635 function showPageNotice()
642 * MUST overload (unless there's not a notice)
646 function showContent()
658 $this->elementStart('div', array('id' => 'aside_primary',
659 'class' => 'aside'));
660 if (Event::handle('StartShowExportData', array($this))) {
661 $this->showExportData();
662 Event::handle('EndShowExportData', array($this));
664 if (Event::handle('StartShowSections', array($this))) {
665 $this->showSections();
666 Event::handle('EndShowSections', array($this));
668 $this->elementEnd('div');
672 * Show export data feeds.
677 function showExportData()
679 $feeds = $this->getFeeds();
681 $fl = new FeedList($this);
693 function showSections()
695 // for each section, show it
703 function showFooter()
705 $this->elementStart('div', array('id' => 'footer'));
706 $this->showSecondaryNav();
707 $this->showLicenses();
708 $this->elementEnd('div');
712 * Show secondary navigation.
716 function showSecondaryNav()
718 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
719 $this->element('dt', null, _('Secondary site navigation'));
720 $this->elementStart('dd', null);
721 $this->elementStart('ul', array('class' => 'nav'));
722 if (Event::handle('StartSecondaryNav', array($this))) {
723 $this->menuItem(common_local_url('doc', array('title' => 'help')),
725 $this->menuItem(common_local_url('doc', array('title' => 'about')),
727 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
729 $bb = common_config('site', 'broughtby');
731 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
734 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
736 $this->menuItem(common_local_url('doc', array('title' => 'source')),
738 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
740 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
742 Event::handle('EndSecondaryNav', array($this));
744 $this->elementEnd('ul');
745 $this->elementEnd('dd');
746 $this->elementEnd('dl');
754 function showLicenses()
756 $this->elementStart('dl', array('id' => 'licenses'));
757 $this->showLaconicaLicense();
758 $this->showContentLicense();
759 $this->elementEnd('dl');
763 * Show Laconica license.
767 function showLaconicaLicense()
769 $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
770 $this->elementStart('dd', null);
771 if (common_config('site', 'broughtby')) {
772 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
774 $instr = _('**%%site.name%%** is a microblogging service. ');
776 $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);
777 $output = common_markup_to_html($instr);
779 $this->elementEnd('dd');
784 * Show content license.
788 function showContentLicense()
790 $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
791 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
792 $this->elementStart('p');
793 $this->element('img', array('id' => 'license_cc',
794 'src' => common_config('license', 'image'),
795 'alt' => common_config('license', 'title'),
798 //TODO: This is dirty: i18n
799 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
800 $this->element('a', array('class' => 'license',
801 'rel' => 'external license',
802 'href' => common_config('license', 'url')),
803 common_config('license', 'title'));
804 $this->text(_('license.'));
805 $this->elementEnd('p');
806 $this->elementEnd('dd');
810 * Return last modified, if applicable.
814 * @return string last modified http header
816 function lastModified()
818 // For comparison with If-Last-Modified
819 // If not applicable, return null
824 * Return etag, if applicable.
828 * @return string etag http header
836 * Return true if read only.
840 * @param array $args other arguments
842 * @return boolean is read only action?
845 function isReadOnly($args)
851 * Returns query argument or default value if not found
853 * @param string $key requested argument
854 * @param string $def default value to return if $key is not provided
856 * @return boolean is read only action?
858 function arg($key, $def=null)
860 if (array_key_exists($key, $this->args)) {
861 return $this->args[$key];
868 * Returns trimmed query argument or default value if not found
870 * @param string $key requested argument
871 * @param string $def default value to return if $key is not provided
873 * @return boolean is read only action?
875 function trimmed($key, $def=null)
877 $arg = $this->arg($key, $def);
878 return is_string($arg) ? trim($arg) : $arg;
884 * @param array $argarray is ignored since it's now passed in in prepare()
886 * @return boolean is read only action?
888 function handle($argarray=null)
890 $lm = $this->lastModified();
891 $etag = $this->etag();
893 header('ETag: ' . $etag);
896 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
897 if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
898 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
899 $ims = strtotime($if_modified_since);
901 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
902 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
903 if (!$if_none_match ||
905 $this->_hasEtag($etag, $if_none_match)) {
906 header('HTTP/1.1 304 Not Modified');
907 // Better way to do this?
916 * HasĀ etag? (private)
918 * @param string $etag etag http header
919 * @param string $if_none_match ifNoneMatch http header
924 function _hasEtag($etag, $if_none_match)
926 $etags = explode(',', $if_none_match);
927 return in_array($etag, $etags) || in_array('*', $etags);
931 * Boolean understands english (yes, no, true, false)
933 * @param string $key query key we're interested in
934 * @param string $def default value
936 * @return boolean interprets yes/no strings as boolean
938 function boolean($key, $def=false)
940 $arg = strtolower($this->trimmed($key));
944 } else if (in_array($arg, array('true', 'yes', '1'))) {
946 } else if (in_array($arg, array('false', 'no', '0'))) {
956 * @param string $msg error message to display
957 * @param integer $code http error code, 500 by default
962 function serverError($msg, $code=500)
964 $action = $this->trimmed('action');
965 common_debug("Server error '$code' on '$action': $msg", __FILE__);
966 throw new ServerException($msg, $code);
972 * @param string $msg error message to display
973 * @param integer $code http error code, 400 by default
978 function clientError($msg, $code=400)
980 $action = $this->trimmed('action');
981 common_debug("User error '$code' on '$action': $msg", __FILE__);
982 throw new ClientException($msg, $code);
986 * Returns the current URL
988 * @return string current URL
993 $action = $this->trimmed('action');
995 unset($args['action']);
996 if (common_config('site', 'fancy')) {
999 if (array_key_exists('submit', $args)) {
1000 unset($args['submit']);
1002 foreach (array_keys($_COOKIE) as $cookie) {
1003 unset($args[$cookie]);
1006 return common_local_url($action, $args);
1010 * Generate a menu item
1012 * @param string $url menu URL
1013 * @param string $text menu name
1014 * @param string $title title attribute, null by default
1015 * @param boolean $is_selected current menu item, false by default
1016 * @param string $id element id, null by default
1020 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1022 // Added @id to li for some control.
1023 // XXX: We might want to move this to htmloutputter.php
1026 $lattrs['class'] = 'current';
1029 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1031 $this->elementStart('li', $lattrs);
1032 $attrs['href'] = $url;
1034 $attrs['title'] = $title;
1036 $this->element('a', $attrs, $text);
1037 $this->elementEnd('li');
1041 * Generate pagination links
1043 * @param boolean $have_before is there something before?
1044 * @param boolean $have_after is there something after?
1045 * @param integer $page current page
1046 * @param string $action current action
1047 * @param array $args rest of query arguments
1051 function pagination($have_before, $have_after, $page, $action, $args=null)
1053 // Does a little before-after block for next/prev page
1054 if ($have_before || $have_after) {
1055 $this->elementStart('div', array('class' => 'pagination'));
1056 $this->elementStart('dl', null);
1057 $this->element('dt', null, _('Pagination'));
1058 $this->elementStart('dd', null);
1059 $this->elementStart('ul', array('class' => 'nav'));
1062 $pargs = array('page' => $page-1);
1063 $this->elementStart('li', array('class' => 'nav_prev'));
1064 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1067 $this->elementEnd('li');
1070 $pargs = array('page' => $page+1);
1071 $this->elementStart('li', array('class' => 'nav_next'));
1072 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1075 $this->elementEnd('li');
1077 if ($have_before || $have_after) {
1078 $this->elementEnd('ul');
1079 $this->elementEnd('dd');
1080 $this->elementEnd('dl');
1081 $this->elementEnd('div');
1086 * An array of feeds for this action.
1088 * Returns an array of potential feeds for this action.
1090 * @return array Feed object to show in head and links
1099 * A design for this action
1101 * @return Design a design object to use
1104 function getDesign()
1106 return Design::siteDesign();