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.
103 * Show head, a template method.
109 // XXX: attributes (profile?)
110 $this->elementStart('head');
112 $this->showStylesheets();
113 $this->showScripts();
114 $this->showOpenSearch();
116 $this->showDescription();
118 $this->elementEnd('head');
122 * Show title, a template method.
128 $this->element('title', null,
129 sprintf(_("%s - %s"),
131 common_config('site', 'name')));
135 * Returns the page title
139 * @return string page title
144 return _("Untitled page");
152 function showStylesheets()
154 if (Event::handle('StartShowStyles', array($this))) {
155 if (Event::handle('StartShowLaconicaStyles', array($this))) {
157 $this->element('link', array('rel' => 'stylesheet',
158 'type' => 'text/css',
159 'href' => theme_path('css/display.css', 'base') . '?version=' . LACONICA_VERSION,
160 'media' => 'screen, projection, tv'));
161 $this->element('link', array('rel' => 'stylesheet',
162 'type' => 'text/css',
163 'href' => theme_path('css/modal.css', 'base') . '?version=' . LACONICA_VERSION,
164 'media' => 'screen, projection, tv'));
165 $this->element('link', array('rel' => 'stylesheet',
166 'type' => 'text/css',
167 'href' => theme_path('css/display.css', null) . '?version=' . LACONICA_VERSION,
168 'media' => 'screen, projection, tv'));
169 if (common_config('site', 'mobile')) {
170 $this->element('link', array('rel' => 'stylesheet',
171 'type' => 'text/css',
172 'href' => theme_path('css/mobile.css', 'base') . '?version=' . LACONICA_VERSION,
173 // TODO: "handheld" CSS for other mobile devices
174 'media' => 'only screen and (max-device-width: 480px)')); // Mobile WebKit
176 Event::handle('EndShowLaconicaStyles', array($this));
178 if (Event::handle('StartShowUAStyles', array($this))) {
179 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
180 'href="'.theme_path('css/ie.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
181 foreach (array(6,7) as $ver) {
182 if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
183 // Yes, IE people should be put in jail.
184 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
185 'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
188 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
189 'href="'.theme_path('css/ie.css', null).'?version='.LACONICA_VERSION.'" /><![endif]');
190 Event::handle('EndShowUAStyles', array($this));
192 Event::handle('EndShowStyles', array($this));
197 * Show javascript headers
201 function showScripts()
203 if (Event::handle('StartShowScripts', array($this))) {
204 if (Event::handle('StartShowJQueryScripts', array($this))) {
205 $this->element('script', array('type' => 'text/javascript',
206 'src' => common_path('js/jquery.min.js')),
208 $this->element('script', array('type' => 'text/javascript',
209 'src' => common_path('js/jquery.form.js')),
212 $this->element('script', array('type' => 'text/javascript',
213 'src' => common_path('js/jquery.simplemodal-1.2.2.pack.js')),
216 Event::handle('EndShowJQueryScripts', array($this));
218 if (Event::handle('StartShowLaconicaScripts', array($this))) {
219 $this->element('script', array('type' => 'text/javascript',
220 'src' => common_path('js/xbImportNode.js')),
222 $this->element('script', array('type' => 'text/javascript',
223 'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
225 // Frame-busting code to avoid clickjacking attacks.
226 $this->element('script', array('type' => 'text/javascript'),
227 'if (window.top !== window.self) { window.top.location.href = window.self.location.href; }');
229 $this->element('script', array('type' => 'text/javascript',
230 'src' => common_path('js/flowplayer-3.0.5.min.js')),
233 $this->element('script', array('type' => 'text/javascript',
234 'src' => common_path('js/video.js')),
236 Event::handle('EndShowLaconicaScripts', array($this));
238 Event::handle('EndShowScripts', array($this));
243 * Show OpenSearch headers
247 function showOpenSearch()
249 $this->element('link', array('rel' => 'search',
250 'type' => 'application/opensearchdescription+xml',
251 'href' => common_local_url('opensearch', array('type' => 'people')),
252 'title' => common_config('site', 'name').' People Search'));
253 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
254 'href' => common_local_url('opensearch', array('type' => 'notice')),
255 'title' => common_config('site', 'name').' Notice Search'));
268 $feeds = $this->getFeeds();
271 foreach ($feeds as $feed) {
272 $this->element('link', array('rel' => $feed->rel(),
273 'href' => $feed->url,
274 'type' => $feed->mimeType(),
275 'title' => $feed->title));
287 function showDescription()
289 // does nothing by default
293 * Show extra stuff in <head>.
301 // does nothing by default
307 * Calls template methods
313 $this->elementStart('body', array('id' => $this->trimmed('action')));
314 $this->elementStart('div', array('id' => 'wrap'));
315 if (Event::handle('StartShowHeader', array($this))) {
317 Event::handle('EndShowHeader', array($this));
320 if (Event::handle('StartShowFooter', array($this))) {
322 Event::handle('EndShowFooter', array($this));
324 $this->elementEnd('div');
325 $this->elementEnd('body');
329 * Show header of the page.
331 * Calls template methods
335 function showHeader()
337 $this->elementStart('div', array('id' => 'header'));
339 $this->showPrimaryNav();
340 $this->showSiteNotice();
341 if (common_logged_in()) {
342 $this->showNoticeForm();
344 $this->showAnonymousMessage();
346 $this->elementEnd('div');
350 * Show configured logo.
356 $this->elementStart('address', array('id' => 'site_contact',
357 'class' => 'vcard'));
358 $this->elementStart('a', array('class' => 'url home bookmark',
359 'href' => common_local_url('public')));
360 if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
361 $this->element('img', array('class' => 'logo photo',
362 'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
363 'alt' => common_config('site', 'name')));
365 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
366 $this->elementEnd('a');
367 $this->elementEnd('address');
371 * Show primary navigation.
375 function showPrimaryNav()
377 $user = common_current_user();
379 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
380 $this->element('dt', null, _('Primary site navigation'));
381 $this->elementStart('dd');
382 $this->elementStart('ul', array('class' => 'nav'));
383 if (Event::handle('StartPrimaryNav', array($this))) {
385 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
386 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
388 $this->menuItem(common_local_url('peoplesearch'),
389 _('Search'), _('Search for people or text'), false, 'nav_search');
391 $this->menuItem(common_local_url('profilesettings'),
392 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
394 if (common_config('xmpp', 'enabled')) {
395 $this->menuItem(common_local_url('imsettings'),
396 _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
398 $this->menuItem(common_local_url('smssettings'),
399 _('Connect'), _('Connect to SMS, Twitter'), false, 'nav_connect');
401 $this->menuItem(common_local_url('logout'),
402 _('Logout'), _('Logout from the site'), false, 'nav_logout');
404 $this->menuItem(common_local_url('login'),
405 _('Login'), _('Login to the site'), false, 'nav_login');
406 if (!common_config('site', 'closed')) {
407 $this->menuItem(common_local_url('register'),
408 _('Register'), _('Create an account'), false, 'nav_register');
410 $this->menuItem(common_local_url('openidlogin'),
411 _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
413 $this->menuItem(common_local_url('doc', array('title' => 'help')),
414 _('Help'), _('Help me!'), false, 'nav_help');
415 Event::handle('EndPrimaryNav', array($this));
417 $this->elementEnd('ul');
418 $this->elementEnd('dd');
419 $this->elementEnd('dl');
427 function showSiteNotice()
429 // Revist. Should probably do an hAtom pattern here
430 $text = common_config('site', 'notice');
432 $this->elementStart('dl', array('id' => 'site_notice',
433 'class' => 'system_notice'));
434 $this->element('dt', null, _('Site notice'));
435 $this->elementStart('dd', null);
437 $this->elementEnd('dd');
438 $this->elementEnd('dl');
445 * MAY overload if no notice form needed... or direct message box????
449 function showNoticeForm()
451 $notice_form = new NoticeForm($this);
452 $notice_form->show();
456 * Show anonymous message.
462 function showAnonymousMessage()
464 // needs to be defined by the class
470 * Shows local navigation, content block and aside.
476 $this->elementStart('div', array('id' => 'core'));
477 $this->showLocalNavBlock();
478 if (Event::handle('StartShowContentBlock', array($this))) {
479 $this->showContentBlock();
480 Event::handle('EndShowContentBlock', array($this));
483 $this->elementEnd('div');
487 * Show local navigation block.
491 function showLocalNavBlock()
493 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
494 $this->element('dt', null, _('Local views'));
495 $this->elementStart('dd');
496 $this->showLocalNav();
497 $this->elementEnd('dd');
498 $this->elementEnd('dl');
502 * Show local navigation.
508 function showLocalNav()
510 // does nothing by default
514 * Show content block.
518 function showContentBlock()
520 $this->elementStart('div', array('id' => 'content'));
521 $this->showPageTitle();
522 $this->showPageNoticeBlock();
523 $this->elementStart('div', array('id' => 'content_inner'));
524 // show the actual content (forms, lists, whatever)
525 $this->showContent();
526 $this->elementEnd('div');
527 $this->elementEnd('div');
535 function showPageTitle()
537 $this->element('h1', null, $this->title());
541 * Show page notice block.
545 function showPageNoticeBlock()
547 $this->elementStart('dl', array('id' => 'page_notice',
548 'class' => 'system_notice'));
549 $this->element('dt', null, _('Page notice'));
550 $this->elementStart('dd');
551 $this->showPageNotice();
552 $this->elementEnd('dd');
553 $this->elementEnd('dl');
559 * SHOULD overload (unless there's not a notice)
563 function showPageNotice()
570 * MUST overload (unless there's not a notice)
574 function showContent()
586 $this->elementStart('div', array('id' => 'aside_primary',
587 'class' => 'aside'));
588 $this->showExportData();
589 if (Event::handle('StartShowSections', array($this))) {
590 $this->showSections();
591 Event::handle('EndShowSections', array($this));
593 $this->elementEnd('div');
597 * Show export data feeds.
602 function showExportData()
604 $feeds = $this->getFeeds();
606 $fl = new FeedList($this);
618 function showSections()
620 // for each section, show it
628 function showFooter()
630 $this->elementStart('div', array('id' => 'footer'));
631 $this->showSecondaryNav();
632 $this->showLicenses();
633 $this->elementEnd('div');
637 * Show secondary navigation.
641 function showSecondaryNav()
643 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
644 $this->element('dt', null, _('Secondary site navigation'));
645 $this->elementStart('dd', null);
646 $this->elementStart('ul', array('class' => 'nav'));
647 if (Event::handle('StartSecondaryNav', array($this))) {
648 $this->menuItem(common_local_url('doc', array('title' => 'help')),
650 $this->menuItem(common_local_url('doc', array('title' => 'about')),
652 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
654 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
656 $this->menuItem(common_local_url('doc', array('title' => 'source')),
658 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
660 Event::handle('EndSecondaryNav', array($this));
662 $this->elementEnd('ul');
663 $this->elementEnd('dd');
664 $this->elementEnd('dl');
672 function showLicenses()
674 $this->elementStart('dl', array('id' => 'licenses'));
675 $this->showLaconicaLicense();
676 $this->showContentLicense();
677 $this->elementEnd('dl');
681 * Show Laconica license.
685 function showLaconicaLicense()
687 $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
688 $this->elementStart('dd', null);
689 if (common_config('site', 'broughtby')) {
690 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
692 $instr = _('**%%site.name%%** is a microblogging service. ');
694 $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);
695 $output = common_markup_to_html($instr);
697 $this->elementEnd('dd');
702 * Show content license.
706 function showContentLicense()
708 $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
709 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
710 $this->elementStart('p');
711 $this->element('img', array('id' => 'license_cc',
712 'src' => common_config('license', 'image'),
713 'alt' => common_config('license', 'title')));
714 //TODO: This is dirty: i18n
715 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
716 $this->element('a', array('class' => 'license',
717 'rel' => 'external license',
718 'href' => common_config('license', 'url')),
719 common_config('license', 'title'));
720 $this->text(_('license.'));
721 $this->elementEnd('p');
722 $this->elementEnd('dd');
726 * Return last modified, if applicable.
730 * @return string last modified http header
732 function lastModified()
734 // For comparison with If-Last-Modified
735 // If not applicable, return null
740 * Return etag, if applicable.
744 * @return string etag http header
752 * Return true if read only.
756 * @return boolean is read only action?
758 function isReadOnly()
764 * Returns query argument or default value if not found
766 * @param string $key requested argument
767 * @param string $def default value to return if $key is not provided
769 * @return boolean is read only action?
771 function arg($key, $def=null)
773 if (array_key_exists($key, $this->args)) {
774 return $this->args[$key];
781 * Returns trimmed query argument or default value if not found
783 * @param string $key requested argument
784 * @param string $def default value to return if $key is not provided
786 * @return boolean is read only action?
788 function trimmed($key, $def=null)
790 $arg = $this->arg($key, $def);
791 return is_string($arg) ? trim($arg) : $arg;
797 * @param array $argarray is ignored since it's now passed in in prepare()
799 * @return boolean is read only action?
801 function handle($argarray=null)
803 $lm = $this->lastModified();
804 $etag = $this->etag();
806 header('ETag: ' . $etag);
809 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
810 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
811 if ($if_modified_since) {
812 $ims = strtotime($if_modified_since);
814 $if_none_match = $_SERVER['HTTP_IF_NONE_MATCH'];
815 if (!$if_none_match ||
817 $this->_hasEtag($etag, $if_none_match)) {
818 header('HTTP/1.1 304 Not Modified');
819 // Better way to do this?
828 * HasĀ etag? (private)
830 * @param string $etag etag http header
831 * @param string $if_none_match ifNoneMatch http header
836 function _hasEtag($etag, $if_none_match)
838 $etags = explode(',', $if_none_match);
839 return in_array($etag, $etags) || in_array('*', $etags);
843 * Boolean understands english (yes, no, true, false)
845 * @param string $key query key we're interested in
846 * @param string $def default value
848 * @return boolean interprets yes/no strings as boolean
850 function boolean($key, $def=false)
852 $arg = strtolower($this->trimmed($key));
856 } else if (in_array($arg, array('true', 'yes', '1'))) {
858 } else if (in_array($arg, array('false', 'no', '0'))) {
868 * @param string $msg error message to display
869 * @param integer $code http error code, 500 by default
874 function serverError($msg, $code=500)
876 $action = $this->trimmed('action');
877 common_debug("Server error '$code' on '$action': $msg", __FILE__);
878 throw new ServerException($msg, $code);
884 * @param string $msg error message to display
885 * @param integer $code http error code, 400 by default
890 function clientError($msg, $code=400)
892 $action = $this->trimmed('action');
893 common_debug("User error '$code' on '$action': $msg", __FILE__);
894 throw new ClientException($msg, $code);
898 * Returns the current URL
900 * @return string current URL
904 $action = $this->trimmed('action');
906 unset($args['action']);
907 foreach (array_keys($_COOKIE) as $cookie) {
908 unset($args[$cookie]);
910 return common_local_url($action, $args);
914 * Generate a menu item
916 * @param string $url menu URL
917 * @param string $text menu name
918 * @param string $title title attribute, null by default
919 * @param boolean $is_selected current menu item, false by default
920 * @param string $id element id, null by default
924 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
926 // Added @id to li for some control.
927 // XXX: We might want to move this to htmloutputter.php
930 $lattrs['class'] = 'current';
933 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
935 $this->elementStart('li', $lattrs);
936 $attrs['href'] = $url;
938 $attrs['title'] = $title;
940 $this->element('a', $attrs, $text);
941 $this->elementEnd('li');
945 * Generate pagination links
947 * @param boolean $have_before is there something before?
948 * @param boolean $have_after is there something after?
949 * @param integer $page current page
950 * @param string $action current action
951 * @param array $args rest of query arguments
955 function pagination($have_before, $have_after, $page, $action, $args=null)
957 // Does a little before-after block for next/prev page
958 if ($have_before || $have_after) {
959 $this->elementStart('div', array('class' => 'pagination'));
960 $this->elementStart('dl', null);
961 $this->element('dt', null, _('Pagination'));
962 $this->elementStart('dd', null);
963 $this->elementStart('ul', array('class' => 'nav'));
966 $pargs = array('page' => $page-1);
967 $newargs = $args ? array_merge($args, $pargs) : $pargs;
968 $this->elementStart('li', array('class' => 'nav_prev'));
969 $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'prev'),
971 $this->elementEnd('li');
974 $pargs = array('page' => $page+1);
975 $newargs = $args ? array_merge($args, $pargs) : $pargs;
976 $this->elementStart('li', array('class' => 'nav_next'));
977 $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'next'),
979 $this->elementEnd('li');
981 if ($have_before || $have_after) {
982 $this->elementEnd('ul');
983 $this->elementEnd('dd');
984 $this->elementEnd('dl');
985 $this->elementEnd('div');
990 * An array of feeds for this action.
992 * Returns an array of potential feeds for this action.
994 * @return array Feed object to show in head and links