3 * Laconica, the distributed open-source microblogging tool
5 * Base class for all actions (~views)
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Evan Prodromou <evan@controlyourself.ca>
25 * @author Sarven Capadisli <csarven@controlyourself.ca>
26 * @copyright 2008 Control Yourself, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://laconi.ca/
31 if (!defined('LACONICA')) {
35 require_once INSTALLDIR.'/lib/noticeform.php';
36 require_once INSTALLDIR.'/lib/htmloutputter.php';
39 * Base class for all actions
41 * This is the base class for all actions in the package. An action is
42 * more or less a "view" in an MVC framework.
44 * Actions are responsible for extracting and validating parameters; using
45 * model classes to read and write to the database; and doing ouput.
49 * @author Evan Prodromou <evan@controlyourself.ca>
50 * @author Sarven Capadisli <csarven@controlyourself.ca>
51 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
52 * @link http://laconi.ca/
56 class Action extends HTMLOutputter // lawsuit
63 * Just wraps the HTMLOutputter constructor.
65 * @param string $output URI to output to, default = stdout
66 * @param boolean $indent Whether to indent output, default true
68 * @see XMLOutputter::__construct
69 * @see HTMLOutputter::__construct
71 function __construct($output='php://output', $indent=true)
73 parent::__construct($output, $indent);
77 * For initializing members of the class.
79 * @param array $argarray misc. arguments
81 * @return boolean true
83 function prepare($argarray)
85 $this->args =& common_copy_args($argarray);
90 * Show page, a template method.
96 if (Event::handle('StartShowHTML', array($this))) {
98 Event::handle('EndShowHTML', array($this));
100 if (Event::handle('StartShowHead', array($this))) {
102 Event::handle('EndShowHead', array($this));
104 if (Event::handle('StartShowBody', array($this))) {
106 Event::handle('EndShowBody', array($this));
108 if (Event::handle('StartEndHTML', array($this))) {
110 Event::handle('EndEndHTML', array($this));
115 * Show head, a template method.
121 // XXX: attributes (profile?)
122 $this->elementStart('head');
124 $this->showShortcutIcon();
125 $this->showStylesheets();
126 $this->showScripts();
127 $this->showOpenSearch();
129 $this->showDescription();
131 $this->elementEnd('head');
135 * Show title, a template method.
141 $this->element('title', null,
142 sprintf(_("%s - %s"),
144 common_config('site', 'name')));
148 * Returns the page title
152 * @return string page title
157 return _("Untitled page");
161 * Show themed shortcut icon
165 function showShortcutIcon()
167 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/favicon.ico')) {
168 $this->element('link', array('rel' => 'shortcut icon',
169 'href' => theme_path('favicon.ico')));
171 $this->element('link', array('rel' => 'shortcut icon',
172 'href' => common_path('favicon.ico')));
175 if (common_config('site', 'mobile')) {
176 if (is_readable(INSTALLDIR . '/theme/' . common_config('site', 'theme') . '/apple-touch-icon.png')) {
177 $this->element('link', array('rel' => 'apple-touch-icon',
178 'href' => theme_path('apple-touch-icon.png')));
180 $this->element('link', array('rel' => 'apple-touch-icon',
181 'href' => common_path('apple-touch-icon.png')));
191 function showStylesheets()
193 if (Event::handle('StartShowStyles', array($this))) {
195 if (Event::handle('StartShowLaconicaStyles', array($this))) {
196 $this->cssLink('css/display.css',null,'screen, projection, tv');
197 if (common_config('site', 'mobile')) {
198 // TODO: "handheld" CSS for other mobile devices
199 $this->cssLink('css/mobile.css','base','only screen and (max-device-width: 480px)'); // Mobile WebKit
201 $this->cssLink('css/print.css','base','print');
202 Event::handle('EndShowLaconicaStyles', array($this));
205 if (Event::handle('StartShowUAStyles', array($this))) {
206 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
207 'href="'.theme_path('css/ie.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
208 foreach (array(6,7) as $ver) {
209 if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
210 // Yes, IE people should be put in jail.
211 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
212 'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
215 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
216 'href="'.theme_path('css/ie.css', null).'?version='.LACONICA_VERSION.'" /><![endif]');
217 Event::handle('EndShowUAStyles', array($this));
220 if (Event::handle('StartShowDesign', array($this))) {
222 $user = common_current_user();
224 if (empty($user) || $user->viewdesigns) {
225 $design = $this->getDesign();
227 if (!empty($design)) {
228 $design->showCSS($this);
232 Event::handle('EndShowDesign', array($this));
234 Event::handle('EndShowStyles', array($this));
239 * Show javascript headers
243 function showScripts()
245 if (Event::handle('StartShowScripts', array($this))) {
246 if (Event::handle('StartShowJQueryScripts', array($this))) {
247 $this->script('js/jquery.min.js');
248 $this->script('js/jquery.form.js');
249 $this->script('js/jquery.joverlay.min.js');
250 Event::handle('EndShowJQueryScripts', array($this));
252 if (Event::handle('StartShowLaconicaScripts', array($this))) {
253 $this->script('js/xbImportNode.js');
254 $this->script('js/util.js');
255 // Frame-busting code to avoid clickjacking attacks.
256 $this->element('script', array('type' => 'text/javascript'),
257 'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
258 Event::handle('EndShowLaconicaScripts', array($this));
260 Event::handle('EndShowScripts', array($this));
265 * Show OpenSearch headers
269 function showOpenSearch()
271 $this->element('link', array('rel' => 'search',
272 'type' => 'application/opensearchdescription+xml',
273 'href' => common_local_url('opensearch', array('type' => 'people')),
274 'title' => common_config('site', 'name').' People Search'));
275 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
276 'href' => common_local_url('opensearch', array('type' => 'notice')),
277 'title' => common_config('site', 'name').' Notice Search'));
290 $feeds = $this->getFeeds();
293 foreach ($feeds as $feed) {
294 $this->element('link', array('rel' => $feed->rel(),
295 'href' => $feed->url,
296 'type' => $feed->mimeType(),
297 'title' => $feed->title));
309 function showDescription()
311 // does nothing by default
315 * Show extra stuff in <head>.
323 // does nothing by default
329 * Calls template methods
335 $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
336 'class' => 'user_in')
337 : array('id' => $this->trimmed('action')));
338 $this->elementStart('div', array('id' => 'wrap'));
339 if (Event::handle('StartShowHeader', array($this))) {
341 Event::handle('EndShowHeader', array($this));
344 if (Event::handle('StartShowFooter', array($this))) {
346 Event::handle('EndShowFooter', array($this));
348 $this->elementEnd('div');
349 $this->elementEnd('body');
353 * Show header of the page.
355 * Calls template methods
359 function showHeader()
361 $this->elementStart('div', array('id' => 'header'));
363 $this->showPrimaryNav();
364 $this->showSiteNotice();
365 if (common_logged_in()) {
366 $this->showNoticeForm();
368 $this->showAnonymousMessage();
370 $this->elementEnd('div');
374 * Show configured logo.
380 $this->elementStart('address', array('id' => 'site_contact',
381 'class' => 'vcard'));
382 if (Event::handle('StartAddressData', array($this))) {
383 $this->elementStart('a', array('class' => 'url home bookmark',
384 'href' => common_local_url('public')));
385 if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
386 $this->element('img', array('class' => 'logo photo',
387 'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
388 'alt' => common_config('site', 'name')));
390 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
391 $this->elementEnd('a');
392 Event::handle('EndAddressData', array($this));
394 $this->elementEnd('address');
398 * Show primary navigation.
402 function showPrimaryNav()
404 $user = common_current_user();
406 if (common_config('xmpp', 'enabled')) {
407 $connect = 'imsettings';
408 } else if (common_config('sms', 'enabled')) {
409 $connect = 'smssettings';
410 } else if (common_config('twitter', 'enabled')) {
411 $connect = 'twittersettings';
414 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
415 $this->element('dt', null, _('Primary site navigation'));
416 $this->elementStart('dd');
417 $this->elementStart('ul', array('class' => 'nav'));
418 if (Event::handle('StartPrimaryNav', array($this))) {
420 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
421 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
422 $this->menuItem(common_local_url('profilesettings'),
423 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
425 $this->menuItem(common_local_url($connect),
426 _('Connect'), _('Connect to services'), false, 'nav_connect');
428 if (common_config('invite', 'enabled')) {
429 $this->menuItem(common_local_url('invite'),
431 sprintf(_('Invite friends and colleagues to join you on %s'),
432 common_config('site', 'name')),
433 false, 'nav_invitecontact');
435 $this->menuItem(common_local_url('logout'),
436 _('Logout'), _('Logout from the site'), false, 'nav_logout');
439 if (!common_config('site', 'closed')) {
440 $this->menuItem(common_local_url('register'),
441 _('Register'), _('Create an account'), false, 'nav_register');
443 $this->menuItem(common_local_url('login'),
444 _('Login'), _('Login to the site'), false, 'nav_login');
446 $this->menuItem(common_local_url('doc', array('title' => 'help')),
447 _('Help'), _('Help me!'), false, 'nav_help');
448 $this->menuItem(common_local_url('peoplesearch'),
449 _('Search'), _('Search for people or text'), false, 'nav_search');
450 Event::handle('EndPrimaryNav', array($this));
452 $this->elementEnd('ul');
453 $this->elementEnd('dd');
454 $this->elementEnd('dl');
462 function showSiteNotice()
464 // Revist. Should probably do an hAtom pattern here
465 $text = common_config('site', 'notice');
467 $this->elementStart('dl', array('id' => 'site_notice',
468 'class' => 'system_notice'));
469 $this->element('dt', null, _('Site notice'));
470 $this->elementStart('dd', null);
472 $this->elementEnd('dd');
473 $this->elementEnd('dl');
480 * MAY overload if no notice form needed... or direct message box????
484 function showNoticeForm()
486 $notice_form = new NoticeForm($this);
487 $notice_form->show();
491 * Show anonymous message.
497 function showAnonymousMessage()
499 // needs to be defined by the class
505 * Shows local navigation, content block and aside.
511 $this->elementStart('div', array('id' => 'core'));
512 if (Event::handle('StartShowLocalNavBlock', array($this))) {
513 $this->showLocalNavBlock();
514 Event::handle('EndShowLocalNavBlock', array($this));
516 if (Event::handle('StartShowContentBlock', array($this))) {
517 $this->showContentBlock();
518 Event::handle('EndShowContentBlock', array($this));
521 $this->elementEnd('div');
525 * Show local navigation block.
529 function showLocalNavBlock()
531 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
532 $this->element('dt', null, _('Local views'));
533 $this->elementStart('dd');
534 $this->showLocalNav();
535 $this->elementEnd('dd');
536 $this->elementEnd('dl');
540 * Show local navigation.
546 function showLocalNav()
548 // does nothing by default
552 * Show content block.
556 function showContentBlock()
558 $this->elementStart('div', array('id' => 'content'));
559 $this->showPageTitle();
560 $this->showPageNoticeBlock();
561 $this->elementStart('div', array('id' => 'content_inner'));
562 // show the actual content (forms, lists, whatever)
563 $this->showContent();
564 $this->elementEnd('div');
565 $this->elementEnd('div');
573 function showPageTitle()
575 $this->element('h1', null, $this->title());
579 * Show page notice block.
581 * Only show the block if a subclassed action has overrided
582 * Action::showPageNotice(), or an event handler is registered for
583 * the StartShowPageNotice event, in which case we assume the
584 * 'page_notice' definition list is desired. This is to prevent
585 * empty 'page_notice' definition lists from being output everywhere.
589 function showPageNoticeBlock()
591 $rmethod = new ReflectionMethod($this, 'showPageNotice');
592 $dclass = $rmethod->getDeclaringClass()->getName();
594 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
596 $this->elementStart('dl', array('id' => 'page_notice',
597 'class' => 'system_notice'));
598 $this->element('dt', null, _('Page notice'));
599 $this->elementStart('dd');
600 if (Event::handle('StartShowPageNotice', array($this))) {
601 $this->showPageNotice();
602 Event::handle('EndShowPageNotice', array($this));
604 $this->elementEnd('dd');
605 $this->elementEnd('dl');
612 * SHOULD overload (unless there's not a notice)
616 function showPageNotice()
623 * MUST overload (unless there's not a notice)
627 function showContent()
639 $this->elementStart('div', array('id' => 'aside_primary',
640 'class' => 'aside'));
641 if (Event::handle('StartShowExportData', array($this))) {
642 $this->showExportData();
643 Event::handle('EndShowExportData', array($this));
645 if (Event::handle('StartShowSections', array($this))) {
646 $this->showSections();
647 Event::handle('EndShowSections', array($this));
649 $this->elementEnd('div');
653 * Show export data feeds.
658 function showExportData()
660 $feeds = $this->getFeeds();
662 $fl = new FeedList($this);
674 function showSections()
676 // for each section, show it
684 function showFooter()
686 $this->elementStart('div', array('id' => 'footer'));
687 $this->showSecondaryNav();
688 $this->showLicenses();
689 $this->elementEnd('div');
693 * Show secondary navigation.
697 function showSecondaryNav()
699 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
700 $this->element('dt', null, _('Secondary site navigation'));
701 $this->elementStart('dd', null);
702 $this->elementStart('ul', array('class' => 'nav'));
703 if (Event::handle('StartSecondaryNav', array($this))) {
704 $this->menuItem(common_local_url('doc', array('title' => 'help')),
706 $this->menuItem(common_local_url('doc', array('title' => 'about')),
708 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
710 $bb = common_config('site', 'broughtby');
712 $this->menuItem(common_local_url('doc', array('title' => 'tos')),
715 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
717 $this->menuItem(common_local_url('doc', array('title' => 'source')),
719 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
721 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
723 Event::handle('EndSecondaryNav', array($this));
725 $this->elementEnd('ul');
726 $this->elementEnd('dd');
727 $this->elementEnd('dl');
735 function showLicenses()
737 $this->elementStart('dl', array('id' => 'licenses'));
738 $this->showLaconicaLicense();
739 $this->showContentLicense();
740 $this->elementEnd('dl');
744 * Show Laconica license.
748 function showLaconicaLicense()
750 $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
751 $this->elementStart('dd', null);
752 if (common_config('site', 'broughtby')) {
753 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
755 $instr = _('**%%site.name%%** is a microblogging service. ');
757 $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);
758 $output = common_markup_to_html($instr);
760 $this->elementEnd('dd');
765 * Show content license.
769 function showContentLicense()
771 $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
772 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
773 $this->elementStart('p');
774 $this->element('img', array('id' => 'license_cc',
775 'src' => common_config('license', 'image'),
776 'alt' => common_config('license', 'title'),
779 //TODO: This is dirty: i18n
780 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
781 $this->element('a', array('class' => 'license',
782 'rel' => 'external license',
783 'href' => common_config('license', 'url')),
784 common_config('license', 'title'));
785 $this->text(_('license.'));
786 $this->elementEnd('p');
787 $this->elementEnd('dd');
791 * Return last modified, if applicable.
795 * @return string last modified http header
797 function lastModified()
799 // For comparison with If-Last-Modified
800 // If not applicable, return null
805 * Return etag, if applicable.
809 * @return string etag http header
817 * Return true if read only.
821 * @param array $args other arguments
823 * @return boolean is read only action?
826 function isReadOnly($args)
832 * Returns 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 arg($key, $def=null)
841 if (array_key_exists($key, $this->args)) {
842 return $this->args[$key];
849 * Returns trimmed query argument or default value if not found
851 * @param string $key requested argument
852 * @param string $def default value to return if $key is not provided
854 * @return boolean is read only action?
856 function trimmed($key, $def=null)
858 $arg = $this->arg($key, $def);
859 return is_string($arg) ? trim($arg) : $arg;
865 * @param array $argarray is ignored since it's now passed in in prepare()
867 * @return boolean is read only action?
869 function handle($argarray=null)
871 $lm = $this->lastModified();
872 $etag = $this->etag();
874 header('ETag: ' . $etag);
877 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
878 if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
879 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
880 $ims = strtotime($if_modified_since);
882 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
883 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
884 if (!$if_none_match ||
886 $this->_hasEtag($etag, $if_none_match)) {
887 header('HTTP/1.1 304 Not Modified');
888 // Better way to do this?
897 * HasĀ etag? (private)
899 * @param string $etag etag http header
900 * @param string $if_none_match ifNoneMatch http header
905 function _hasEtag($etag, $if_none_match)
907 $etags = explode(',', $if_none_match);
908 return in_array($etag, $etags) || in_array('*', $etags);
912 * Boolean understands english (yes, no, true, false)
914 * @param string $key query key we're interested in
915 * @param string $def default value
917 * @return boolean interprets yes/no strings as boolean
919 function boolean($key, $def=false)
921 $arg = strtolower($this->trimmed($key));
925 } else if (in_array($arg, array('true', 'yes', '1'))) {
927 } else if (in_array($arg, array('false', 'no', '0'))) {
937 * @param string $msg error message to display
938 * @param integer $code http error code, 500 by default
943 function serverError($msg, $code=500)
945 $action = $this->trimmed('action');
946 common_debug("Server error '$code' on '$action': $msg", __FILE__);
947 throw new ServerException($msg, $code);
953 * @param string $msg error message to display
954 * @param integer $code http error code, 400 by default
959 function clientError($msg, $code=400)
961 $action = $this->trimmed('action');
962 common_debug("User error '$code' on '$action': $msg", __FILE__);
963 throw new ClientException($msg, $code);
967 * Returns the current URL
969 * @return string current URL
974 $action = $this->trimmed('action');
976 unset($args['action']);
977 if (common_config('site', 'fancy')) {
980 if (array_key_exists('submit', $args)) {
981 unset($args['submit']);
983 foreach (array_keys($_COOKIE) as $cookie) {
984 unset($args[$cookie]);
987 return common_local_url($action, $args);
991 * Generate a menu item
993 * @param string $url menu URL
994 * @param string $text menu name
995 * @param string $title title attribute, null by default
996 * @param boolean $is_selected current menu item, false by default
997 * @param string $id element id, null by default
1001 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
1003 // Added @id to li for some control.
1004 // XXX: We might want to move this to htmloutputter.php
1007 $lattrs['class'] = 'current';
1010 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1012 $this->elementStart('li', $lattrs);
1013 $attrs['href'] = $url;
1015 $attrs['title'] = $title;
1017 $this->element('a', $attrs, $text);
1018 $this->elementEnd('li');
1022 * Generate pagination links
1024 * @param boolean $have_before is there something before?
1025 * @param boolean $have_after is there something after?
1026 * @param integer $page current page
1027 * @param string $action current action
1028 * @param array $args rest of query arguments
1032 function pagination($have_before, $have_after, $page, $action, $args=null)
1034 // Does a little before-after block for next/prev page
1035 if ($have_before || $have_after) {
1036 $this->elementStart('div', array('class' => 'pagination'));
1037 $this->elementStart('dl', null);
1038 $this->element('dt', null, _('Pagination'));
1039 $this->elementStart('dd', null);
1040 $this->elementStart('ul', array('class' => 'nav'));
1043 $pargs = array('page' => $page-1);
1044 $this->elementStart('li', array('class' => 'nav_prev'));
1045 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1048 $this->elementEnd('li');
1051 $pargs = array('page' => $page+1);
1052 $this->elementStart('li', array('class' => 'nav_next'));
1053 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1056 $this->elementEnd('li');
1058 if ($have_before || $have_after) {
1059 $this->elementEnd('ul');
1060 $this->elementEnd('dd');
1061 $this->elementEnd('dl');
1062 $this->elementEnd('div');
1067 * An array of feeds for this action.
1069 * Returns an array of potential feeds for this action.
1071 * @return array Feed object to show in head and links
1080 * A design for this action
1082 * @return Design a design object to use
1085 function getDesign()
1087 return Design::siteDesign();