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 $this->element('link', array('rel' => 'stylesheet',
155 'type' => 'text/css',
156 'href' => theme_path('css/display.css', 'base') . '?version=' . LACONICA_VERSION,
157 'media' => 'screen, projection, tv'));
158 $this->element('link', array('rel' => 'stylesheet',
159 'type' => 'text/css',
160 'href' => theme_path('css/display.css', null) . '?version=' . LACONICA_VERSION,
161 'media' => 'screen, projection, tv'));
162 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
163 'href="'.theme_path('css/ie.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
164 foreach (array(6,7) as $ver) {
165 if (file_exists(theme_file('css/ie'.$ver.'.css', 'base'))) {
166 // Yes, IE people should be put in jail.
167 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
168 'href="'.theme_path('css/ie'.$ver.'.css', 'base').'?version='.LACONICA_VERSION.'" /><![endif]');
171 $this->comment('[if IE]><link rel="stylesheet" type="text/css" '.
172 'href="'.theme_path('css/ie.css', null).'?version='.LACONICA_VERSION.'" /><![endif]');
176 * Show javascript headers
180 function showScripts()
182 if (Event::handle('StartShowScripts', array($this))) {
183 if (Event::handle('StartShowJQueryScripts', array($this))) {
184 $this->element('script', array('type' => 'text/javascript',
185 'src' => common_path('js/jquery.min.js')),
187 $this->element('script', array('type' => 'text/javascript',
188 'src' => common_path('js/jquery.form.js')),
190 Event::handle('EndShowJQueryScripts', array($this));
192 if (Event::handle('StartShowLaconicaScripts', array($this))) {
193 $this->element('script', array('type' => 'text/javascript',
194 'src' => common_path('js/xbImportNode.js')),
196 $this->element('script', array('type' => 'text/javascript',
197 'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
199 Event::handle('EndShowLaconicaScripts', array($this));
201 Event::handle('EndShowScripts', array($this));
206 * Show OpenSearch headers
210 function showOpenSearch()
212 $this->element('link', array('rel' => 'search',
213 'type' => 'application/opensearchdescription+xml',
214 'href' => common_local_url('opensearch', array('type' => 'people')),
215 'title' => common_config('site', 'name').' People Search'));
216 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
217 'href' => common_local_url('opensearch', array('type' => 'notice')),
218 'title' => common_config('site', 'name').' Notice Search'));
230 // does nothing by default
240 function showDescription()
242 // does nothing by default
246 * Show extra stuff in <head>.
254 // does nothing by default
260 * Calls template methods
266 $this->elementStart('body', array('id' => $this->trimmed('action')));
267 $this->elementStart('div', array('id' => 'wrap'));
271 $this->elementEnd('div');
272 $this->elementEnd('body');
276 * Show header of the page.
278 * Calls template methods
282 function showHeader()
284 $this->elementStart('div', array('id' => 'header'));
286 $this->showPrimaryNav();
287 $this->showSiteNotice();
288 if (common_logged_in()) {
289 $this->showNoticeForm();
291 $this->showAnonymousMessage();
293 $this->elementEnd('div');
297 * Show configured logo.
303 $this->elementStart('address', array('id' => 'site_contact',
304 'class' => 'vcard'));
305 $this->elementStart('a', array('class' => 'url home bookmark',
306 'href' => common_local_url('public')));
307 if (common_config('site', 'logo') || file_exists(theme_file('logo.png'))) {
308 $this->element('img', array('class' => 'logo photo',
309 'src' => (common_config('site', 'logo')) ? common_config('site', 'logo') : theme_path('logo.png'),
310 'alt' => common_config('site', 'name')));
312 $this->element('span', array('class' => 'fn org'), common_config('site', 'name'));
313 $this->elementEnd('a');
314 $this->elementEnd('address');
318 * Show primary navigation.
322 function showPrimaryNav()
324 $user = common_current_user();
326 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
327 $this->element('dt', null, _('Primary site navigation'));
328 $this->elementStart('dd');
329 $this->elementStart('ul', array('class' => 'nav'));
330 if (Event::handle('StartPrimaryNav', array($this))) {
332 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
333 _('Home'), _('Personal profile and friends timeline'), false, 'nav_home');
335 $this->menuItem(common_local_url('peoplesearch'),
336 _('Search'), _('Search for people or text'), false, 'nav_search');
338 $this->menuItem(common_local_url('profilesettings'),
339 _('Account'), _('Change your email, avatar, password, profile'), false, 'nav_account');
341 if (common_config('xmpp', 'enabled')) {
342 $this->menuItem(common_local_url('imsettings'),
343 _('Connect'), _('Connect to IM, SMS, Twitter'), false, 'nav_connect');
345 $this->menuItem(common_local_url('smssettings'),
346 _('Connect'), _('Connect to SMS, Twitter'), false, 'nav_connect');
348 $this->menuItem(common_local_url('logout'),
349 _('Logout'), _('Logout from the site'), false, 'nav_logout');
351 $this->menuItem(common_local_url('login'),
352 _('Login'), _('Login to the site'), false, 'nav_login');
353 if (!common_config('site', 'closed')) {
354 $this->menuItem(common_local_url('register'),
355 _('Register'), _('Create an account'), false, 'nav_register');
357 $this->menuItem(common_local_url('openidlogin'),
358 _('OpenID'), _('Login with OpenID'), false, 'nav_openid');
360 $this->menuItem(common_local_url('doc', array('title' => 'help')),
361 _('Help'), _('Help me!'), false, 'nav_help');
362 Event::handle('EndPrimaryNav', array($this));
364 $this->elementEnd('ul');
365 $this->elementEnd('dd');
366 $this->elementEnd('dl');
374 function showSiteNotice()
376 // Revist. Should probably do an hAtom pattern here
377 $text = common_config('site', 'notice');
379 $this->elementStart('dl', array('id' => 'site_notice',
380 'class' => 'system_notice'));
381 $this->element('dt', null, _('Site notice'));
382 $this->elementStart('dd', null);
384 $this->elementEnd('dd');
385 $this->elementEnd('dl');
392 * MAY overload if no notice form needed... or direct message box????
396 function showNoticeForm()
398 $notice_form = new NoticeForm($this);
399 $notice_form->show();
403 * Show anonymous message.
409 function showAnonymousMessage()
411 // needs to be defined by the class
417 * Shows local navigation, content block and aside.
423 $this->elementStart('div', array('id' => 'core'));
424 $this->showLocalNavBlock();
425 $this->showContentBlock();
427 $this->elementEnd('div');
431 * Show local navigation block.
435 function showLocalNavBlock()
437 $this->elementStart('dl', array('id' => 'site_nav_local_views'));
438 $this->element('dt', null, _('Local views'));
439 $this->elementStart('dd');
440 $this->showLocalNav();
441 $this->elementEnd('dd');
442 $this->elementEnd('dl');
446 * Show local navigation.
452 function showLocalNav()
454 // does nothing by default
458 * Show content block.
462 function showContentBlock()
464 $this->elementStart('div', array('id' => 'content'));
465 $this->showPageTitle();
466 $this->showPageNoticeBlock();
467 $this->elementStart('div', array('id' => 'content_inner'));
468 // show the actual content (forms, lists, whatever)
469 $this->showContent();
470 $this->elementEnd('div');
471 $this->elementEnd('div');
479 function showPageTitle()
481 $this->element('h1', null, $this->title());
485 * Show page notice block.
489 function showPageNoticeBlock()
491 $this->elementStart('dl', array('id' => 'page_notice',
492 'class' => 'system_notice'));
493 $this->element('dt', null, _('Page notice'));
494 $this->elementStart('dd');
495 $this->showPageNotice();
496 $this->elementEnd('dd');
497 $this->elementEnd('dl');
503 * SHOULD overload (unless there's not a notice)
507 function showPageNotice()
514 * MUST overload (unless there's not a notice)
518 function showContent()
530 $this->elementStart('div', array('id' => 'aside_primary',
531 'class' => 'aside'));
532 $this->showExportData();
533 if (Event::handle('StartShowSections', array($this))) {
534 $this->showSections();
535 Event::handle('EndShowSections', array($this));
537 $this->elementEnd('div');
541 * Show export data feeds.
543 * MAY overload if there are feeds
547 function showExportData()
549 // is there structure to this?
550 // list of (visible!) feed links
551 // can we reuse list of feeds from showFeeds() ?
561 function showSections()
563 // for each section, show it
571 function showFooter()
573 $this->elementStart('div', array('id' => 'footer'));
574 $this->showSecondaryNav();
575 $this->showLicenses();
576 $this->elementEnd('div');
580 * Show secondary navigation.
584 function showSecondaryNav()
586 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
587 $this->element('dt', null, _('Secondary site navigation'));
588 $this->elementStart('dd', null);
589 $this->elementStart('ul', array('class' => 'nav'));
590 if (Event::handle('StartSecondaryNav', array($this))) {
591 $this->menuItem(common_local_url('doc', array('title' => 'help')),
593 $this->menuItem(common_local_url('doc', array('title' => 'about')),
595 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
597 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
599 $this->menuItem(common_local_url('doc', array('title' => 'source')),
601 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
603 Event::handle('EndSecondaryNav', array($this));
605 $this->elementEnd('ul');
606 $this->elementEnd('dd');
607 $this->elementEnd('dl');
615 function showLicenses()
617 $this->elementStart('dl', array('id' => 'licenses'));
618 $this->showLaconicaLicense();
619 $this->showContentLicense();
620 $this->elementEnd('dl');
624 * Show Laconica license.
628 function showLaconicaLicense()
630 $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
631 $this->elementStart('dd', null);
632 if (common_config('site', 'broughtby')) {
633 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
635 $instr = _('**%%site.name%%** is a microblogging service. ');
637 $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);
638 $output = common_markup_to_html($instr);
640 $this->elementEnd('dd');
645 * Show content license.
649 function showContentLicense()
651 $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
652 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
653 $this->elementStart('p');
654 $this->element('img', array('id' => 'license_cc',
655 'src' => common_config('license', 'image'),
656 'alt' => common_config('license', 'title')));
657 //TODO: This is dirty: i18n
658 $this->text(_('All '.common_config('site', 'name').' content and data are available under the '));
659 $this->element('a', array('class' => 'license',
660 'rel' => 'external license',
661 'href' => common_config('license', 'url')),
662 common_config('license', 'title'));
663 $this->text(_('license.'));
664 $this->elementEnd('p');
665 $this->elementEnd('dd');
669 * Return last modified, if applicable.
673 * @return string last modified http header
675 function lastModified()
677 // For comparison with If-Last-Modified
678 // If not applicable, return null
683 * Return etag, if applicable.
687 * @return string etag http header
695 * Return true if read only.
699 * @return boolean is read only action?
701 function isReadOnly()
707 * Returns query argument or default value if not found
709 * @param string $key requested argument
710 * @param string $def default value to return if $key is not provided
712 * @return boolean is read only action?
714 function arg($key, $def=null)
716 if (array_key_exists($key, $this->args)) {
717 return $this->args[$key];
724 * Returns trimmed query argument or default value if not found
726 * @param string $key requested argument
727 * @param string $def default value to return if $key is not provided
729 * @return boolean is read only action?
731 function trimmed($key, $def=null)
733 $arg = $this->arg($key, $def);
734 return is_string($arg) ? trim($arg) : $arg;
740 * @param array $argarray is ignored since it's now passed in in prepare()
742 * @return boolean is read only action?
744 function handle($argarray=null)
746 $lm = $this->lastModified();
747 $etag = $this->etag();
749 header('ETag: ' . $etag);
752 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
753 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
754 if ($if_modified_since) {
755 $ims = strtotime($if_modified_since);
758 $this->_hasEtag($etag, $_SERVER['HTTP_IF_NONE_MATCH'])) {
759 header('HTTP/1.1 304 Not Modified');
760 // Better way to do this?
769 * HasĀ etag? (private)
771 * @param string $etag etag http header
772 * @param string $if_none_match ifNoneMatch http header
776 function _hasEtag($etag, $if_none_match)
778 return ($if_none_match) && in_array($etag, explode(',', $if_none_match));
782 * Boolean understands english (yes, no, true, false)
784 * @param string $key query key we're interested in
785 * @param string $def default value
787 * @return boolean interprets yes/no strings as boolean
789 function boolean($key, $def=false)
791 $arg = strtolower($this->trimmed($key));
795 } else if (in_array($arg, array('true', 'yes', '1'))) {
797 } else if (in_array($arg, array('false', 'no', '0'))) {
807 * @param string $msg error message to display
808 * @param integer $code http error code, 500 by default
813 function serverError($msg, $code=500)
815 $action = $this->trimmed('action');
816 common_debug("Server error '$code' on '$action': $msg", __FILE__);
817 throw new ServerException($msg, $code);
823 * @param string $msg error message to display
824 * @param integer $code http error code, 400 by default
829 function clientError($msg, $code=400)
831 $action = $this->trimmed('action');
832 common_debug("User error '$code' on '$action': $msg", __FILE__);
833 throw new ClientException($msg, $code);
837 * Returns the current URL
839 * @return string current URL
843 $action = $this->trimmed('action');
845 unset($args['action']);
846 foreach (array_keys($_COOKIE) as $cookie) {
847 unset($args[$cookie]);
849 return common_local_url($action, $args);
853 * Generate a menu item
855 * @param string $url menu URL
856 * @param string $text menu name
857 * @param string $title title attribute, null by default
858 * @param boolean $is_selected current menu item, false by default
859 * @param string $id element id, null by default
863 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
865 // Added @id to li for some control.
866 // XXX: We might want to move this to htmloutputter.php
869 $lattrs['class'] = 'current';
872 (is_null($id)) ? $lattrs : $lattrs['id'] = $id;
874 $this->elementStart('li', $lattrs);
875 $attrs['href'] = $url;
877 $attrs['title'] = $title;
879 $this->element('a', $attrs, $text);
880 $this->elementEnd('li');
884 * Generate pagination links
886 * @param boolean $have_before is there something before?
887 * @param boolean $have_after is there something after?
888 * @param integer $page current page
889 * @param string $action current action
890 * @param array $args rest of query arguments
894 function pagination($have_before, $have_after, $page, $action, $args=null)
896 // Does a little before-after block for next/prev page
897 if ($have_before || $have_after) {
898 $this->elementStart('div', array('class' => 'pagination'));
899 $this->elementStart('dl', null);
900 $this->element('dt', null, _('Pagination'));
901 $this->elementStart('dd', null);
902 $this->elementStart('ul', array('class' => 'nav'));
905 $pargs = array('page' => $page-1);
906 $newargs = $args ? array_merge($args, $pargs) : $pargs;
907 $this->elementStart('li', array('class' => 'nav_prev'));
908 $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'prev'),
910 $this->elementEnd('li');
913 $pargs = array('page' => $page+1);
914 $newargs = $args ? array_merge($args, $pargs) : $pargs;
915 $this->elementStart('li', array('class' => 'nav_next'));
916 $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'next'),
918 $this->elementEnd('li');
920 if ($have_before || $have_after) {
921 $this->elementEnd('ul');
922 $this->elementEnd('dd');
923 $this->elementEnd('dl');
924 $this->elementEnd('div');