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->showRelationshipLinks();
128 $this->showOpenSearch();
130 $this->showDescription();
132 $this->elementEnd('head');
136 * Show title, a template method.
142 $this->element('title', null,
143 sprintf(_("%s - %s"),
145 common_config('site', 'name')));
149 * Returns the page title
153 * @return string page title
158 return _("Untitled page");
162 * Show themed shortcut icon
166 function showShortcutIcon()
168 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
169 $this->element('link', array('rel' => 'shortcut icon',
170 'href' => theme_path('favicon.ico')));
172 $this->element('link', array('rel' => 'shortcut icon',
173 'href' => common_path('favicon.ico')));
176 if (common_config('site', 'mobile')) {
177 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
178 $this->element('link', array('rel' => 'apple-touch-icon',
179 'href' => theme_path('apple-touch-icon.png')));
181 $this->element('link', array('rel' => 'apple-touch-icon',
182 'href' => common_path('apple-touch-icon.png')));
192 function showStylesheets()
194 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));
213 if (Event::handle('StartShowUAStyles', array($this))) {
214 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
215 'href="'.theme_path('css/ie.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
216 foreach (array(6,7) as $ver) {
217 if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
218 // Yes, IE people should be put in jail.
219 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
220 'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
223 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
224 'href="'.theme_path('css/ie.css', null).'?version='.LACONICA_VERSION.'" /><![endif]');
225 Event::handle('EndShowUAStyles', array($this));
227 Event::handle('EndShowStyles', array($this));
232 * Show javascript headers
236 function showScripts()
238 if (Event::handle('StartShowScripts', array($this))) {
239 if (Event::handle('StartShowJQueryScripts', array($this))) {
240 $this->element('script', array('type' => 'text/javascript',
241 'src' => common_path('js/jquery.min.js')),
243 $this->element('script', array('type' => 'text/javascript',
244 'src' => common_path('js/jquery.form.js')),
246 Event::handle('EndShowJQueryScripts', array($this));
248 if (Event::handle('StartShowLaconicaScripts', array($this))) {
249 $this->element('script', array('type' => 'text/javascript',
250 'src' => common_path('js/xbImportNode.js')),
252 $this->element('script', array('type' => 'text/javascript',
253 'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
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 document relationship links
271 function showRelationshipLinks()
273 // output <link> elements with appropriate HTML4.01 link types:
274 // http://www.w3.org/TR/html401/types.html#type-links
278 * Show OpenSearch headers
282 function showOpenSearch()
284 $this->element('link', array('rel' => 'search',
285 'type' => 'application/opensearchdescription+xml',
286 'href' => common_local_url('opensearch', array('type' => 'people')),
287 'title' => common_config('site', 'name').' People Search'));
288 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
289 'href' => common_local_url('opensearch', array('type' => 'notice')),
290 'title' => common_config('site', 'name').' Notice Search'));
303 $feeds = $this->getFeeds();
306 foreach ($feeds as $feed) {
307 $this->element('link', array('rel' => $feed->rel(),
308 'href' => $feed->url,
309 'type' => $feed->mimeType(),
310 'title' => $feed->title));
322 function showDescription()
324 // does nothing by default
328 * Show extra stuff in <head>.
336 // does nothing by default
342 * Calls template methods
348 $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
349 'class' => 'user_in')
350 : array('id' => $this->trimmed('action')));
351 $this->elementStart('div', array('id' => 'wrap'));
352 if (Event::handle('StartShowHeader', array($this))) {
354 Event::handle('EndShowHeader', array($this));
357 if (Event::handle('StartShowFooter', array($this))) {
359 Event::handle('EndShowFooter', array($this));
361 $this->elementEnd('div');
362 $this->elementEnd('body');
366 * Show header of the page.
368 * Calls template methods
372 function showHeader()
374 $this->elementStart('div', array('id' => 'header'));
376 $this->showPrimaryNav();
377 $this->showSiteNotice();
378 if (common_logged_in()) {
379 $this->showNoticeForm();
381 $this->showAnonymousMessage();
383 $this->elementEnd('div');
387 * Show configured logo.
393 $this->elementStart('address', array('id' => 'site_contact',
394 'class' => 'vcard'));
395 $this->elementStart('a', array('class' => 'url home bookmark',
396 'href' => common_local_url('public')));
397 if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
398 $this->element('img', array('class' => 'logo photo',
399 'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
400 'alt' => common_config('site', 'name')));
402 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
403 $this->elementEnd('a');
404 $this->elementEnd('address');
408 * Show primary navigation.
412 function showPrimaryNav()
414 $user = common_current_user();
416 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
417 $this->element('dt', null, _('Primary site navigation'));
418 $this->elementStart('dd');
419 $this->elementStart('ul', array('class' => 'nav'));
420 if (Event::handle('StartPrimaryNav', array($this))) {
422 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
423 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
424 $this->menuItem(common_local_url('profilesettings'),
425 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
426 if (common_config('xmpp', 'enabled')) {
427 $this->menuItem(common_local_url('imsettings'),
428 _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
430 $this->menuItem(common_local_url('smssettings'),
431 _('Connect'), _('Connect to SMS, Twitter'), false, 'nav_connect');
433 $this->menuItem(common_local_url('invite'),
435 sprintf(_('Invite friends and colleagues to join you on %s'),
436 common_config('site', 'name')),
437 false, 'nav_invitecontact');
438 $this->menuItem(common_local_url('logout'),
439 _('Logout'), _('Logout from the site'), false, 'nav_logout');
442 if (!common_config('site', 'closed')) {
443 $this->menuItem(common_local_url('register'),
444 _('Register'), _('Create an account'), false, 'nav_register');
446 $this->menuItem(common_local_url('openidlogin'),
447 _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
448 $this->menuItem(common_local_url('login'),
449 _('Login'), _('Login to the site'), false, 'nav_login');
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.
588 function showPageNoticeBlock()
590 $this->elementStart('dl', array('id' => 'page_notice',
591 'class' => 'system_notice'));
592 $this->element('dt', null, _('Page notice'));
593 $this->elementStart('dd');
594 $this->showPageNotice();
595 $this->elementEnd('dd');
596 $this->elementEnd('dl');
602 * SHOULD overload (unless there's not a notice)
606 function showPageNotice()
613 * MUST overload (unless there's not a notice)
617 function showContent()
629 $this->elementStart('div', array('id' => 'aside_primary',
630 'class' => 'aside'));
631 if (Event::handle('StartShowExportData', array($this))) {
632 $this->showExportData();
633 Event::handle('EndShowExportData', array($this));
635 if (Event::handle('StartShowSections', array($this))) {
636 $this->showSections();
637 Event::handle('EndShowSections', array($this));
639 $this->elementEnd('div');
643 * Show export data feeds.
648 function showExportData()
650 $feeds = $this->getFeeds();
652 $fl = new FeedList($this);
664 function showSections()
666 // for each section, show it
674 function showFooter()
676 $this->elementStart('div', array('id' => 'footer'));
677 $this->showSecondaryNav();
678 $this->showLicenses();
679 $this->elementEnd('div');
683 * Show secondary navigation.
687 function showSecondaryNav()
689 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
690 $this->element('dt', null, _('Secondary site navigation'));
691 $this->elementStart('dd', null);
692 $this->elementStart('ul', array('class' => 'nav'));
693 if (Event::handle('StartSecondaryNav', array($this))) {
694 $this->menuItem(common_local_url('doc', array('title' => 'help')),
696 $this->menuItem(common_local_url('doc', array('title' => 'about')),
698 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
700 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
702 $this->menuItem(common_local_url('doc', array('title' => 'source')),
704 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
706 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
708 Event::handle('EndSecondaryNav', array($this));
710 $this->elementEnd('ul');
711 $this->elementEnd('dd');
712 $this->elementEnd('dl');
720 function showLicenses()
722 $this->elementStart('dl', array('id' => 'licenses'));
723 $this->showLaconicaLicense();
724 $this->showContentLicense();
725 $this->elementEnd('dl');
729 * Show Laconica license.
733 function showLaconicaLicense()
735 $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
736 $this->elementStart('dd', null);
737 if (common_config('site', 'broughtby')) {
738 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
740 $instr = _('**%%site.name%%** is a microblogging service. ');
742 $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);
743 $output = common_markup_to_html($instr);
745 $this->elementEnd('dd');
750 * Show content license.
754 function showContentLicense()
756 $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
757 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
758 $this->elementStart('p');
759 $this->element('img', array('id' => 'license_cc',
760 'src' => common_config('license', 'image'),
761 'alt' => common_config('license', 'title')));
762 //TODO: This is dirty: i18n
763 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
764 $this->element('a', array('class' => 'license',
765 'rel' => 'external license',
766 'href' => common_config('license', 'url')),
767 common_config('license', 'title'));
768 $this->text(_('license.'));
769 $this->elementEnd('p');
770 $this->elementEnd('dd');
774 * Return last modified, if applicable.
778 * @return string last modified http header
780 function lastModified()
782 // For comparison with If-Last-Modified
783 // If not applicable, return null
788 * Return etag, if applicable.
792 * @return string etag http header
800 * Return true if read only.
804 * @param array $args other arguments
806 * @return boolean is read only action?
809 function isReadOnly($args)
815 * Returns query argument or default value if not found
817 * @param string $key requested argument
818 * @param string $def default value to return if $key is not provided
820 * @return boolean is read only action?
822 function arg($key, $def=null)
824 if (array_key_exists($key, $this->args)) {
825 return $this->args[$key];
832 * Returns trimmed query argument or default value if not found
834 * @param string $key requested argument
835 * @param string $def default value to return if $key is not provided
837 * @return boolean is read only action?
839 function trimmed($key, $def=null)
841 $arg = $this->arg($key, $def);
842 return is_string($arg) ? trim($arg) : $arg;
848 * @param array $argarray is ignored since it's now passed in in prepare()
850 * @return boolean is read only action?
852 function handle($argarray=null)
854 $lm = $this->lastModified();
855 $etag = $this->etag();
857 header('ETag: ' . $etag);
860 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
861 if (isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
862 $ims = strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']);
864 $if_none_match = $_SERVER['HTTP_IF_NONE_MATCH'];
865 if (!$if_none_match ||
867 $this->_hasEtag($etag, $if_none_match)) {
868 header('HTTP/1.1 304 Not Modified');
869 // Better way to do this?
878 * HasĀ etag? (private)
880 * @param string $etag etag http header
881 * @param string $if_none_match ifNoneMatch http header
886 function _hasEtag($etag, $if_none_match)
888 $etags = explode(',', $if_none_match);
889 return in_array($etag, $etags) || in_array('*', $etags);
893 * Boolean understands english (yes, no, true, false)
895 * @param string $key query key we're interested in
896 * @param string $def default value
898 * @return boolean interprets yes/no strings as boolean
900 function boolean($key, $def=false)
902 $arg = strtolower($this->trimmed($key));
906 } else if (in_array($arg, array('true', 'yes', '1'))) {
908 } else if (in_array($arg, array('false', 'no', '0'))) {
918 * @param string $msg error message to display
919 * @param integer $code http error code, 500 by default
924 function serverError($msg, $code=500)
926 $action = $this->trimmed('action');
927 common_debug("Server error '$code' on '$action': $msg", __FILE__);
928 throw new ServerException($msg, $code);
934 * @param string $msg error message to display
935 * @param integer $code http error code, 400 by default
940 function clientError($msg, $code=400)
942 $action = $this->trimmed('action');
943 common_debug("User error '$code' on '$action': $msg", __FILE__);
944 throw new ClientException($msg, $code);
948 * Returns the current URL
950 * @return string current URL
955 $action = $this->trimmed('action');
957 unset($args['action']);
958 if (array_key_exists('submit', $args)) {
959 unset($args['submit']);
961 foreach (array_keys($_COOKIE) as $cookie) {
962 unset($args[$cookie]);
964 return common_local_url($action, $args);
968 * Generate a menu item
970 * @param string $url menu URL
971 * @param string $text menu name
972 * @param string $title title attribute, null by default
973 * @param boolean $is_selected current menu item, false by default
974 * @param string $id element id, null by default
978 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
980 // Added @id to li for some control.
981 // XXX: We might want to move this to htmloutputter.php
984 $lattrs['class'] = 'current';
987 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
989 $this->elementStart('li', $lattrs);
990 $attrs['href'] = $url;
992 $attrs['title'] = $title;
994 $this->element('a', $attrs, $text);
995 $this->elementEnd('li');
999 * Generate pagination links
1001 * @param boolean $have_before is there something before?
1002 * @param boolean $have_after is there something after?
1003 * @param integer $page current page
1004 * @param string $action current action
1005 * @param array $args rest of query arguments
1009 function pagination($have_before, $have_after, $page, $action, $args=null)
1011 // Does a little before-after block for next/prev page
1012 if ($have_before || $have_after) {
1013 $this->elementStart('div', array('class' => 'pagination'));
1014 $this->elementStart('dl', null);
1015 $this->element('dt', null, _('Pagination'));
1016 $this->elementStart('dd', null);
1017 $this->elementStart('ul', array('class' => 'nav'));
1020 $pargs = array('page' => $page-1);
1021 $this->elementStart('li', array('class' => 'nav_prev'));
1022 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1025 $this->elementEnd('li');
1028 $pargs = array('page' => $page+1);
1029 $this->elementStart('li', array('class' => 'nav_next'));
1030 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1033 $this->elementEnd('li');
1035 if ($have_before || $have_after) {
1036 $this->elementEnd('ul');
1037 $this->elementEnd('dd');
1038 $this->elementEnd('dl');
1039 $this->elementEnd('div');
1044 * An array of feeds for this action.
1046 * Returns an array of potential feeds for this action.
1048 * @return array Feed object to show in head and links
1057 * Generate document metadata for sequential navigation
1059 * @param boolean $have_before is there something before?
1060 * @param boolean $have_after is there something after?
1061 * @param integer $page current page
1062 * @param string $action current action
1063 * @param array $args rest of query arguments
1067 function sequenceRelationships($have_next, $have_previous, $page, $action, $args=null)
1069 // Outputs machine-readable pagination in <link> elements.
1070 // Pattern taken from $this->pagination() method.
1072 // "next" is equivalent to "after"
1074 $pargs = array('page' => $page-1);
1075 $this->element('link', array('rel' => 'next',
1076 'href' => common_local_url($action, $args, $pargs),
1077 'title' => _('Next')));
1079 // "previous" is equivalent to "before"
1080 if ($have_previous=true) { // FIXME
1081 $pargs = array('page' => $page+1);
1082 $this->element('link', array('rel' => 'prev',
1083 'href' => common_local_url($action, $args, $pargs),
1084 'title' => _('Previous')));