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))) {
194 if (Event::handle('StartShowLaconicaStyles', array($this))) {
195 $this->element('link', array('rel' => 'stylesheet',
196 'type' => 'text/css',
197 'href' => theme_path('css/display.css', null) . '?version=' . LACONICA_VERSION,
198 'media' => 'screen, projection, tv'));
199 if (common_config('site', 'mobile')) {
200 $this->element('link', array('rel' => 'stylesheet',
201 'type' => 'text/css',
202 'href' => theme_path('css/mobile.css', 'base') . '?version=' . LACONICA_VERSION,
203 // TODO: "handheld" CSS for other mobile devices
204 'media' => 'only screen and (max-device-width: 480px)')); // Mobile WebKit
206 $this->element('link', array('rel' => 'stylesheet',
207 'type' => 'text/css',
208 'href' => theme_path('css/print.css', 'base') . '?version=' . LACONICA_VERSION,
209 'media' => 'print'));
210 Event::handle('EndShowLaconicaStyles', array($this));
212 if (Event::handle('StartShowUAStyles', array($this))) {
213 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
214 'href="'.theme_path('css/ie.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
215 foreach (array(6,7) as $ver) {
216 if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
217 // Yes, IE people should be put in jail.
218 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
219 'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
222 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
223 'href="'.theme_path('css/ie.css', null).'?version='.LACONICA_VERSION.'" /><![endif]');
224 Event::handle('EndShowUAStyles', array($this));
226 Event::handle('EndShowStyles', array($this));
231 * Show javascript headers
235 function showScripts()
237 if (Event::handle('StartShowScripts', array($this))) {
238 if (Event::handle('StartShowJQueryScripts', array($this))) {
239 $this->element('script', array('type' => 'text/javascript',
240 'src' => common_path('js/jquery.min.js')),
242 $this->element('script', array('type' => 'text/javascript',
243 'src' => common_path('js/jquery.form.js')),
246 $this->element('script', array('type' => 'text/javascript',
247 'src' => common_path('js/jquery.joverlay.min.js')),
251 Event::handle('EndShowJQueryScripts', array($this));
253 if (Event::handle('StartShowLaconicaScripts', array($this))) {
254 $this->element('script', array('type' => 'text/javascript',
255 'src' => common_path('js/xbImportNode.js')),
257 $this->element('script', array('type' => 'text/javascript',
258 'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
260 // Frame-busting code to avoid clickjacking attacks.
261 $this->element('script', array('type' => 'text/javascript'),
262 'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
263 Event::handle('EndShowLaconicaScripts', array($this));
265 Event::handle('EndShowScripts', array($this));
270 * Show OpenSearch headers
274 function showOpenSearch()
276 $this->element('link', array('rel' => 'search',
277 'type' => 'application/opensearchdescription+xml',
278 'href' => common_local_url('opensearch', array('type' => 'people')),
279 'title' => common_config('site', 'name').' People Search'));
280 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
281 'href' => common_local_url('opensearch', array('type' => 'notice')),
282 'title' => common_config('site', 'name').' Notice Search'));
295 $feeds = $this->getFeeds();
298 foreach ($feeds as $feed) {
299 $this->element('link', array('rel' => $feed->rel(),
300 'href' => $feed->url,
301 'type' => $feed->mimeType(),
302 'title' => $feed->title));
314 function showDescription()
316 // does nothing by default
320 * Show extra stuff in <head>.
328 // does nothing by default
334 * Calls template methods
340 $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
341 'class' => 'user_in')
342 : array('id' => $this->trimmed('action')));
343 $this->elementStart('div', array('id' => 'wrap'));
344 if (Event::handle('StartShowHeader', array($this))) {
346 Event::handle('EndShowHeader', array($this));
349 if (Event::handle('StartShowFooter', array($this))) {
351 Event::handle('EndShowFooter', array($this));
353 $this->elementEnd('div');
354 $this->elementEnd('body');
358 * Show header of the page.
360 * Calls template methods
364 function showHeader()
366 $this->elementStart('div', array('id' => 'header'));
368 $this->showPrimaryNav();
369 $this->showSiteNotice();
370 if (common_logged_in()) {
371 $this->showNoticeForm();
373 $this->showAnonymousMessage();
375 $this->elementEnd('div');
379 * Show configured logo.
385 $this->elementStart('address', array('id' => 'site_contact',
386 'class' => 'vcard'));
387 $this->elementStart('a', array('class' => 'url home bookmark',
388 'href' => common_local_url('public')));
389 if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
390 $this->element('img', array('class' => 'logo photo',
391 'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
392 'alt' => common_config('site', 'name')));
394 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
395 $this->elementEnd('a');
396 $this->elementEnd('address');
400 * Show primary navigation.
404 function showPrimaryNav()
406 $user = common_current_user();
408 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
409 $this->element('dt', null, _('Primary site navigation'));
410 $this->elementStart('dd');
411 $this->elementStart('ul', array('class' => 'nav'));
412 if (Event::handle('StartPrimaryNav', array($this))) {
414 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
415 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
416 $this->menuItem(common_local_url('profilesettings'),
417 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
418 if (common_config('xmpp', 'enabled')) {
419 $this->menuItem(common_local_url('imsettings'),
420 _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
422 $this->menuItem(common_local_url('smssettings'),
423 _('Connect'), _('Connect to SMS, Twitter'), false, 'nav_connect');
425 if (common_config('invite', 'enabled')) {
426 $this->menuItem(common_local_url('invite'),
428 sprintf(_('Invite friends and colleagues to join you on %s'),
429 common_config('site', 'name')),
430 false, 'nav_invitecontact');
432 $this->menuItem(common_local_url('logout'),
433 _('Logout'), _('Logout from the site'), false, 'nav_logout');
436 if (!common_config('site', 'closed')) {
437 $this->menuItem(common_local_url('register'),
438 _('Register'), _('Create an account'), false, 'nav_register');
440 $this->menuItem(common_local_url('openidlogin'),
441 _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
442 $this->menuItem(common_local_url('login'),
443 _('Login'), _('Login to the site'), false, 'nav_login');
445 $this->menuItem(common_local_url('doc', array('title' => 'help')),
446 _('Help'), _('Help me!'), false, 'nav_help');
447 $this->menuItem(common_local_url('peoplesearch'),
448 _('Search'), _('Search for people or text'), false, 'nav_search');
449 Event::handle('EndPrimaryNav', array($this));
451 $this->elementEnd('ul');
452 $this->elementEnd('dd');
453 $this->elementEnd('dl');
461 function showSiteNotice()
463 // Revist. Should probably do an hAtom pattern here
464 $text = common_config('site', 'notice');
466 $this->elementStart('dl', array('id' => 'site_notice',
467 'class' => 'system_notice'));
468 $this->element('dt', null, _('Site notice'));
469 $this->elementStart('dd', null);
471 $this->elementEnd('dd');
472 $this->elementEnd('dl');
479 * MAY overload if no notice form needed... or direct message box????
483 function showNoticeForm()
485 $notice_form = new NoticeForm($this);
486 $notice_form->show();
490 * Show anonymous message.
496 function showAnonymousMessage()
498 // needs to be defined by the class
504 * Shows local navigation, content block and aside.
510 $this->elementStart('div', array('id' => 'core'));
511 if (Event::handle('StartShowLocalNavBlock', array($this))) {
512 $this->showLocalNavBlock();
513 Event::handle('EndShowLocalNavBlock', array($this));
515 if (Event::handle('StartShowContentBlock', array($this))) {
516 $this->showContentBlock();
517 Event::handle('EndShowContentBlock', array($this));
520 $this->elementEnd('div');
524 * Show local navigation block.
528 function showLocalNavBlock()
530 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
531 $this->element('dt', null, _('Local views'));
532 $this->elementStart('dd');
533 $this->showLocalNav();
534 $this->elementEnd('dd');
535 $this->elementEnd('dl');
539 * Show local navigation.
545 function showLocalNav()
547 // does nothing by default
551 * Show content block.
555 function showContentBlock()
557 $this->elementStart('div', array('id' => 'content'));
558 $this->showPageTitle();
559 $this->showPageNoticeBlock();
560 $this->elementStart('div', array('id' => 'content_inner'));
561 // show the actual content (forms, lists, whatever)
562 $this->showContent();
563 $this->elementEnd('div');
564 $this->elementEnd('div');
572 function showPageTitle()
574 $this->element('h1', null, $this->title());
578 * Show page notice block.
580 * Only show the block if a subclassed action has overrided
581 * Action::showPageNotice(), or an event handler is registered for
582 * the StartShowPageNotice event, in which case we assume the
583 * 'page_notice' definition list is desired. This is to prevent
584 * empty 'page_notice' definition lists from being output everywhere.
588 function showPageNoticeBlock()
590 $rmethod = new ReflectionMethod($this, 'showPageNotice');
591 $dclass = $rmethod->getDeclaringClass()->getName();
593 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
595 $this->elementStart('dl', array('id' => 'page_notice',
596 'class' => 'system_notice'));
597 $this->element('dt', null, _('Page notice'));
598 $this->elementStart('dd');
599 if (Event::handle('StartShowPageNotice', array($this))) {
600 $this->showPageNotice();
601 Event::handle('EndShowPageNotice', array($this));
603 $this->elementEnd('dd');
604 $this->elementEnd('dl');
611 * SHOULD overload (unless there's not a notice)
615 function showPageNotice()
622 * MUST overload (unless there's not a notice)
626 function showContent()
638 $this->elementStart('div', array('id' => 'aside_primary',
639 'class' => 'aside'));
640 if (Event::handle('StartShowExportData', array($this))) {
641 $this->showExportData();
642 Event::handle('EndShowExportData', array($this));
644 if (Event::handle('StartShowSections', array($this))) {
645 $this->showSections();
646 Event::handle('EndShowSections', array($this));
648 $this->elementEnd('div');
652 * Show export data feeds.
657 function showExportData()
659 $feeds = $this->getFeeds();
661 $fl = new FeedList($this);
673 function showSections()
675 // for each section, show it
683 function showFooter()
685 $this->elementStart('div', array('id' => 'footer'));
686 $this->showSecondaryNav();
687 $this->showLicenses();
688 $this->elementEnd('div');
692 * Show secondary navigation.
696 function showSecondaryNav()
698 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
699 $this->element('dt', null, _('Secondary site navigation'));
700 $this->elementStart('dd', null);
701 $this->elementStart('ul', array('class' => 'nav'));
702 if (Event::handle('StartSecondaryNav', array($this))) {
703 $this->menuItem(common_local_url('doc', array('title' => 'help')),
705 $this->menuItem(common_local_url('doc', array('title' => 'about')),
707 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
709 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
711 $this->menuItem(common_local_url('doc', array('title' => 'source')),
713 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
715 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
717 Event::handle('EndSecondaryNav', array($this));
719 $this->elementEnd('ul');
720 $this->elementEnd('dd');
721 $this->elementEnd('dl');
729 function showLicenses()
731 $this->elementStart('dl', array('id' => 'licenses'));
732 $this->showLaconicaLicense();
733 $this->showContentLicense();
734 $this->elementEnd('dl');
738 * Show Laconica license.
742 function showLaconicaLicense()
744 $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
745 $this->elementStart('dd', null);
746 if (common_config('site', 'broughtby')) {
747 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
749 $instr = _('**%%site.name%%** is a microblogging service. ');
751 $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);
752 $output = common_markup_to_html($instr);
754 $this->elementEnd('dd');
759 * Show content license.
763 function showContentLicense()
765 $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
766 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
767 $this->elementStart('p');
768 $this->element('img', array('id' => 'license_cc',
769 'src' => common_config('license', 'image'),
770 'alt' => common_config('license', 'title')));
771 //TODO: This is dirty: i18n
772 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
773 $this->element('a', array('class' => 'license',
774 'rel' => 'external license',
775 'href' => common_config('license', 'url')),
776 common_config('license', 'title'));
777 $this->text(_('license.'));
778 $this->elementEnd('p');
779 $this->elementEnd('dd');
783 * Return last modified, if applicable.
787 * @return string last modified http header
789 function lastModified()
791 // For comparison with If-Last-Modified
792 // If not applicable, return null
797 * Return etag, if applicable.
801 * @return string etag http header
809 * Return true if read only.
813 * @param array $args other arguments
815 * @return boolean is read only action?
818 function isReadOnly($args)
824 * Returns query argument or default value if not found
826 * @param string $key requested argument
827 * @param string $def default value to return if $key is not provided
829 * @return boolean is read only action?
831 function arg($key, $def=null)
833 if (array_key_exists($key, $this->args)) {
834 return $this->args[$key];
841 * Returns trimmed query argument or default value if not found
843 * @param string $key requested argument
844 * @param string $def default value to return if $key is not provided
846 * @return boolean is read only action?
848 function trimmed($key, $def=null)
850 $arg = $this->arg($key, $def);
851 return is_string($arg) ? trim($arg) : $arg;
857 * @param array $argarray is ignored since it's now passed in in prepare()
859 * @return boolean is read only action?
861 function handle($argarray=null)
863 $lm = $this->lastModified();
864 $etag = $this->etag();
866 header('ETag: ' . $etag);
869 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
870 if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
871 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
872 $ims = strtotime($if_modified_since);
874 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
875 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
876 if (!$if_none_match ||
878 $this->_hasEtag($etag, $if_none_match)) {
879 header('HTTP/1.1 304 Not Modified');
880 // Better way to do this?
889 * HasĀ etag? (private)
891 * @param string $etag etag http header
892 * @param string $if_none_match ifNoneMatch http header
897 function _hasEtag($etag, $if_none_match)
899 $etags = explode(',', $if_none_match);
900 return in_array($etag, $etags) || in_array('*', $etags);
904 * Boolean understands english (yes, no, true, false)
906 * @param string $key query key we're interested in
907 * @param string $def default value
909 * @return boolean interprets yes/no strings as boolean
911 function boolean($key, $def=false)
913 $arg = strtolower($this->trimmed($key));
917 } else if (in_array($arg, array('true', 'yes', '1'))) {
919 } else if (in_array($arg, array('false', 'no', '0'))) {
929 * @param string $msg error message to display
930 * @param integer $code http error code, 500 by default
935 function serverError($msg, $code=500)
937 $action = $this->trimmed('action');
938 common_debug("Server error '$code' on '$action': $msg", __FILE__);
939 throw new ServerException($msg, $code);
945 * @param string $msg error message to display
946 * @param integer $code http error code, 400 by default
951 function clientError($msg, $code=400)
953 $action = $this->trimmed('action');
954 common_debug("User error '$code' on '$action': $msg", __FILE__);
955 throw new ClientException($msg, $code);
959 * Returns the current URL
961 * @return string current URL
966 $action = $this->trimmed('action');
968 unset($args['action']);
969 if (array_key_exists('submit', $args)) {
970 unset($args['submit']);
972 foreach (array_keys($_COOKIE) as $cookie) {
973 unset($args[$cookie]);
975 return common_local_url($action, $args);
979 * Generate a menu item
981 * @param string $url menu URL
982 * @param string $text menu name
983 * @param string $title title attribute, null by default
984 * @param boolean $is_selected current menu item, false by default
985 * @param string $id element id, null by default
989 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
991 // Added @id to li for some control.
992 // XXX: We might want to move this to htmloutputter.php
995 $lattrs['class'] = 'current';
998 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1000 $this->elementStart('li', $lattrs);
1001 $attrs['href'] = $url;
1003 $attrs['title'] = $title;
1005 $this->element('a', $attrs, $text);
1006 $this->elementEnd('li');
1010 * Generate pagination links
1012 * @param boolean $have_before is there something before?
1013 * @param boolean $have_after is there something after?
1014 * @param integer $page current page
1015 * @param string $action current action
1016 * @param array $args rest of query arguments
1020 function pagination($have_before, $have_after, $page, $action, $args=null)
1022 // Does a little before-after block for next/prev page
1023 if ($have_before || $have_after) {
1024 $this->elementStart('div', array('class' => 'pagination'));
1025 $this->elementStart('dl', null);
1026 $this->element('dt', null, _('Pagination'));
1027 $this->elementStart('dd', null);
1028 $this->elementStart('ul', array('class' => 'nav'));
1031 $pargs = array('page' => $page-1);
1032 $this->elementStart('li', array('class' => 'nav_prev'));
1033 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1036 $this->elementEnd('li');
1039 $pargs = array('page' => $page+1);
1040 $this->elementStart('li', array('class' => 'nav_next'));
1041 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1044 $this->elementEnd('li');
1046 if ($have_before || $have_after) {
1047 $this->elementEnd('ul');
1048 $this->elementEnd('dd');
1049 $this->elementEnd('dl');
1050 $this->elementEnd('div');
1055 * An array of feeds for this action.
1057 * Returns an array of potential feeds for this action.
1059 * @return array Feed object to show in head and links