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')),
250 Event::handle('EndShowJQueryScripts', array($this));
252 if (Event::handle('StartShowLaconicaScripts', array($this))) {
253 $this->element('script', array('type' => 'text/javascript',
254 'src' => common_path('js/xbImportNode.js')),
256 $this->element('script', array('type' => 'text/javascript',
257 'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
259 // Frame-busting code to avoid clickjacking attacks.
260 $this->element('script', array('type' => 'text/javascript'),
261 'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
262 Event::handle('EndShowLaconicaScripts', array($this));
264 Event::handle('EndShowScripts', array($this));
269 * Show OpenSearch headers
273 function showOpenSearch()
275 $this->element('link', array('rel' => 'search',
276 'type' => 'application/opensearchdescription+xml',
277 'href' => common_local_url('opensearch', array('type' => 'people')),
278 'title' => common_config('site', 'name').' People Search'));
279 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
280 'href' => common_local_url('opensearch', array('type' => 'notice')),
281 'title' => common_config('site', 'name').' Notice Search'));
294 $feeds = $this->getFeeds();
297 foreach ($feeds as $feed) {
298 $this->element('link', array('rel' => $feed->rel(),
299 'href' => $feed->url,
300 'type' => $feed->mimeType(),
301 'title' => $feed->title));
313 function showDescription()
315 // does nothing by default
319 * Show extra stuff in <head>.
327 // does nothing by default
333 * Calls template methods
339 $this->elementStart('body', (common_current_user()) ? array('id' => $this->trimmed('action'),
340 'class' => 'user_in')
341 : array('id' => $this->trimmed('action')));
342 $this->elementStart('div', array('id' => 'wrap'));
343 if (Event::handle('StartShowHeader', array($this))) {
345 Event::handle('EndShowHeader', array($this));
348 if (Event::handle('StartShowFooter', array($this))) {
350 Event::handle('EndShowFooter', array($this));
352 $this->elementEnd('div');
353 $this->elementEnd('body');
357 * Show header of the page.
359 * Calls template methods
363 function showHeader()
365 $this->elementStart('div', array('id' => 'header'));
367 $this->showPrimaryNav();
368 $this->showSiteNotice();
369 if (common_logged_in()) {
370 $this->showNoticeForm();
372 $this->showAnonymousMessage();
374 $this->elementEnd('div');
378 * Show configured logo.
384 $this->elementStart('address', array('id' => 'site_contact',
385 'class' => 'vcard'));
386 $this->elementStart('a', array('class' => 'url home bookmark',
387 'href' => common_local_url('public')));
388 if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
389 $this->element('img', array('class' => 'logo photo',
390 'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
391 'alt' => common_config('site', 'name')));
393 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
394 $this->elementEnd('a');
395 $this->elementEnd('address');
399 * Show primary navigation.
403 function showPrimaryNav()
405 $user = common_current_user();
407 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
408 $this->element('dt', null, _('Primary site navigation'));
409 $this->elementStart('dd');
410 $this->elementStart('ul', array('class' => 'nav'));
411 if (Event::handle('StartPrimaryNav', array($this))) {
413 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
414 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
415 $this->menuItem(common_local_url('profilesettings'),
416 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
417 if (common_config('xmpp', 'enabled')) {
418 $this->menuItem(common_local_url('imsettings'),
419 _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
421 $this->menuItem(common_local_url('smssettings'),
422 _('Connect'), _('Connect to SMS, Twitter'), false, 'nav_connect');
424 $this->menuItem(common_local_url('invite'),
426 sprintf(_('Invite friends and colleagues to join you on %s'),
427 common_config('site', 'name')),
428 false, 'nav_invitecontact');
429 $this->menuItem(common_local_url('logout'),
430 _('Logout'), _('Logout from the site'), false, 'nav_logout');
433 if (!common_config('site', 'closed')) {
434 $this->menuItem(common_local_url('register'),
435 _('Register'), _('Create an account'), false, 'nav_register');
437 $this->menuItem(common_local_url('openidlogin'),
438 _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
439 $this->menuItem(common_local_url('login'),
440 _('Login'), _('Login to the site'), false, 'nav_login');
442 $this->menuItem(common_local_url('doc', array('title' => 'help')),
443 _('Help'), _('Help me!'), false, 'nav_help');
444 $this->menuItem(common_local_url('peoplesearch'),
445 _('Search'), _('Search for people or text'), false, 'nav_search');
446 Event::handle('EndPrimaryNav', array($this));
448 $this->elementEnd('ul');
449 $this->elementEnd('dd');
450 $this->elementEnd('dl');
458 function showSiteNotice()
460 // Revist. Should probably do an hAtom pattern here
461 $text = common_config('site', 'notice');
463 $this->elementStart('dl', array('id' => 'site_notice',
464 'class' => 'system_notice'));
465 $this->element('dt', null, _('Site notice'));
466 $this->elementStart('dd', null);
468 $this->elementEnd('dd');
469 $this->elementEnd('dl');
476 * MAY overload if no notice form needed... or direct message box????
480 function showNoticeForm()
482 $notice_form = new NoticeForm($this);
483 $notice_form->show();
487 * Show anonymous message.
493 function showAnonymousMessage()
495 // needs to be defined by the class
501 * Shows local navigation, content block and aside.
507 $this->elementStart('div', array('id' => 'core'));
508 if (Event::handle('StartShowLocalNavBlock', array($this))) {
509 $this->showLocalNavBlock();
510 Event::handle('EndShowLocalNavBlock', array($this));
512 if (Event::handle('StartShowContentBlock', array($this))) {
513 $this->showContentBlock();
514 Event::handle('EndShowContentBlock', array($this));
517 $this->elementEnd('div');
521 * Show local navigation block.
525 function showLocalNavBlock()
527 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
528 $this->element('dt', null, _('Local views'));
529 $this->elementStart('dd');
530 $this->showLocalNav();
531 $this->elementEnd('dd');
532 $this->elementEnd('dl');
536 * Show local navigation.
542 function showLocalNav()
544 // does nothing by default
548 * Show content block.
552 function showContentBlock()
554 $this->elementStart('div', array('id' => 'content'));
555 $this->showPageTitle();
556 $this->showPageNoticeBlock();
557 $this->elementStart('div', array('id' => 'content_inner'));
558 // show the actual content (forms, lists, whatever)
559 $this->showContent();
560 $this->elementEnd('div');
561 $this->elementEnd('div');
569 function showPageTitle()
571 $this->element('h1', null, $this->title());
575 * Show page notice block.
577 * Only show the block if a subclassed action has overrided
578 * Action::showPageNotice(), or an event handler is registered for
579 * the StartShowPageNotice event, in which case we assume the
580 * 'page_notice' definition list is desired. This is to prevent
581 * empty 'page_notice' definition lists from being output everywhere.
585 function showPageNoticeBlock()
587 $rmethod = new ReflectionMethod($this, 'showPageNotice');
588 $dclass = $rmethod->getDeclaringClass()->getName();
590 if ($dclass != 'Action' || Event::hasHandler('StartShowPageNotice')) {
592 $this->elementStart('dl', array('id' => 'page_notice',
593 'class' => 'system_notice'));
594 $this->element('dt', null, _('Page notice'));
595 $this->elementStart('dd');
596 if (Event::handle('StartShowPageNotice', array($this))) {
597 $this->showPageNotice();
598 Event::handle('EndShowPageNotice', array($this));
600 $this->elementEnd('dd');
601 $this->elementEnd('dl');
608 * SHOULD overload (unless there's not a notice)
612 function showPageNotice()
619 * MUST overload (unless there's not a notice)
623 function showContent()
635 $this->elementStart('div', array('id' => 'aside_primary',
636 'class' => 'aside'));
637 if (Event::handle('StartShowExportData', array($this))) {
638 $this->showExportData();
639 Event::handle('EndShowExportData', array($this));
641 if (Event::handle('StartShowSections', array($this))) {
642 $this->showSections();
643 Event::handle('EndShowSections', array($this));
645 $this->elementEnd('div');
649 * Show export data feeds.
654 function showExportData()
656 $feeds = $this->getFeeds();
658 $fl = new FeedList($this);
670 function showSections()
672 // for each section, show it
680 function showFooter()
682 $this->elementStart('div', array('id' => 'footer'));
683 $this->showSecondaryNav();
684 $this->showLicenses();
685 $this->elementEnd('div');
689 * Show secondary navigation.
693 function showSecondaryNav()
695 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
696 $this->element('dt', null, _('Secondary site navigation'));
697 $this->elementStart('dd', null);
698 $this->elementStart('ul', array('class' => 'nav'));
699 if (Event::handle('StartSecondaryNav', array($this))) {
700 $this->menuItem(common_local_url('doc', array('title' => 'help')),
702 $this->menuItem(common_local_url('doc', array('title' => 'about')),
704 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
706 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
708 $this->menuItem(common_local_url('doc', array('title' => 'source')),
710 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
712 $this->menuItem(common_local_url('doc', array('title' => 'badge')),
714 Event::handle('EndSecondaryNav', array($this));
716 $this->elementEnd('ul');
717 $this->elementEnd('dd');
718 $this->elementEnd('dl');
726 function showLicenses()
728 $this->elementStart('dl', array('id' => 'licenses'));
729 $this->showLaconicaLicense();
730 $this->showContentLicense();
731 $this->elementEnd('dl');
735 * Show Laconica license.
739 function showLaconicaLicense()
741 $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
742 $this->elementStart('dd', null);
743 if (common_config('site', 'broughtby')) {
744 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
746 $instr = _('**%%site.name%%** is a microblogging service. ');
748 $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);
749 $output = common_markup_to_html($instr);
751 $this->elementEnd('dd');
756 * Show content license.
760 function showContentLicense()
762 $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
763 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
764 $this->elementStart('p');
765 $this->element('img', array('id' => 'license_cc',
766 'src' => common_config('license', 'image'),
767 'alt' => common_config('license', 'title')));
768 //TODO: This is dirty: i18n
769 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
770 $this->element('a', array('class' => 'license',
771 'rel' => 'external license',
772 'href' => common_config('license', 'url')),
773 common_config('license', 'title'));
774 $this->text(_('license.'));
775 $this->elementEnd('p');
776 $this->elementEnd('dd');
780 * Return last modified, if applicable.
784 * @return string last modified http header
786 function lastModified()
788 // For comparison with If-Last-Modified
789 // If not applicable, return null
794 * Return etag, if applicable.
798 * @return string etag http header
806 * Return true if read only.
810 * @param array $args other arguments
812 * @return boolean is read only action?
815 function isReadOnly($args)
821 * Returns query argument or default value if not found
823 * @param string $key requested argument
824 * @param string $def default value to return if $key is not provided
826 * @return boolean is read only action?
828 function arg($key, $def=null)
830 if (array_key_exists($key, $this->args)) {
831 return $this->args[$key];
838 * Returns trimmed query argument or default value if not found
840 * @param string $key requested argument
841 * @param string $def default value to return if $key is not provided
843 * @return boolean is read only action?
845 function trimmed($key, $def=null)
847 $arg = $this->arg($key, $def);
848 return is_string($arg) ? trim($arg) : $arg;
854 * @param array $argarray is ignored since it's now passed in in prepare()
856 * @return boolean is read only action?
858 function handle($argarray=null)
860 $lm = $this->lastModified();
861 $etag = $this->etag();
863 header('ETag: ' . $etag);
866 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
867 if (array_key_exists('HTTP_IF_MODIFIED_SINCE', $_SERVER)) {
868 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
869 $ims = strtotime($if_modified_since);
871 $if_none_match = (array_key_exists('HTTP_IF_NONE_MATCH', $_SERVER)) ?
872 $_SERVER['HTTP_IF_NONE_MATCH'] : null;
873 if (!$if_none_match ||
875 $this->_hasEtag($etag, $if_none_match)) {
876 header('HTTP/1.1 304 Not Modified');
877 // Better way to do this?
886 * HasĀ etag? (private)
888 * @param string $etag etag http header
889 * @param string $if_none_match ifNoneMatch http header
894 function _hasEtag($etag, $if_none_match)
896 $etags = explode(',', $if_none_match);
897 return in_array($etag, $etags) || in_array('*', $etags);
901 * Boolean understands english (yes, no, true, false)
903 * @param string $key query key we're interested in
904 * @param string $def default value
906 * @return boolean interprets yes/no strings as boolean
908 function boolean($key, $def=false)
910 $arg = strtolower($this->trimmed($key));
914 } else if (in_array($arg, array('true', 'yes', '1'))) {
916 } else if (in_array($arg, array('false', 'no', '0'))) {
926 * @param string $msg error message to display
927 * @param integer $code http error code, 500 by default
932 function serverError($msg, $code=500)
934 $action = $this->trimmed('action');
935 common_debug("Server error '$code' on '$action': $msg", __FILE__);
936 throw new ServerException($msg, $code);
942 * @param string $msg error message to display
943 * @param integer $code http error code, 400 by default
948 function clientError($msg, $code=400)
950 $action = $this->trimmed('action');
951 common_debug("User error '$code' on '$action': $msg", __FILE__);
952 throw new ClientException($msg, $code);
956 * Returns the current URL
958 * @return string current URL
963 $action = $this->trimmed('action');
965 unset($args['action']);
966 if (common_config('site', 'fancy')) {
969 if (array_key_exists('submit', $args)) {
970 unset($args['submit']);
972 foreach (array_keys($_COOKIE) as $cookie) {
973 unset($args[$cookie]);
976 return common_local_url($action, $args);
980 * Generate a menu item
982 * @param string $url menu URL
983 * @param string $text menu name
984 * @param string $title title attribute, null by default
985 * @param boolean $is_selected current menu item, false by default
986 * @param string $id element id, null by default
990 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
992 // Added @id to li for some control.
993 // XXX: We might want to move this to htmloutputter.php
996 $lattrs['class'] = 'current';
999 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
1001 $this->elementStart('li', $lattrs);
1002 $attrs['href'] = $url;
1004 $attrs['title'] = $title;
1006 $this->element('a', $attrs, $text);
1007 $this->elementEnd('li');
1011 * Generate pagination links
1013 * @param boolean $have_before is there something before?
1014 * @param boolean $have_after is there something after?
1015 * @param integer $page current page
1016 * @param string $action current action
1017 * @param array $args rest of query arguments
1021 function pagination($have_before, $have_after, $page, $action, $args=null)
1023 // Does a little before-after block for next/prev page
1024 if ($have_before || $have_after) {
1025 $this->elementStart('div', array('class' => 'pagination'));
1026 $this->elementStart('dl', null);
1027 $this->element('dt', null, _('Pagination'));
1028 $this->elementStart('dd', null);
1029 $this->elementStart('ul', array('class' => 'nav'));
1032 $pargs = array('page' => $page-1);
1033 $this->elementStart('li', array('class' => 'nav_prev'));
1034 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1037 $this->elementEnd('li');
1040 $pargs = array('page' => $page+1);
1041 $this->elementStart('li', array('class' => 'nav_next'));
1042 $this->element('a', array('href' => common_local_url($action, $args, $pargs),
1045 $this->elementEnd('li');
1047 if ($have_before || $have_after) {
1048 $this->elementEnd('ul');
1049 $this->elementEnd('dd');
1050 $this->elementEnd('dl');
1051 $this->elementEnd('div');
1056 * An array of feeds for this action.
1058 * Returns an array of potential feeds for this action.
1060 * @return array Feed object to show in head and links