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/
57 class Action extends HTMLOutputter // lawsuit
64 * Just wraps the HTMLOutputter constructor.
66 * @param string $output URI to output to, default = stdout
67 * @param boolean $indent Whether to indent output, default true
69 * @see XMLOutputter::__construct
70 * @see HTMLOutputter::__construct
73 function __construct($output='php://output', $indent=true)
75 parent::__construct($output, $indent);
78 // For initializing members of the class
80 function prepare($argarray)
82 $this->args =& common_copy_args($argarray);
96 // XXX: attributes (profile?)
97 $this->elementStart('head');
99 $this->showStylesheets();
100 $this->showScripts();
101 $this->showOpenSearch();
103 $this->showDescription();
105 $this->elementEnd('head');
110 $this->element('title', null,
111 sprintf(_("%s - %s"),
113 common_config('site', 'name')));
120 return _("Untitled page");
123 function showStylesheets()
125 $this->element('link', array('rel' => 'stylesheet',
126 'type' => 'text/css',
127 'href' => theme_path('css/display.css', 'base') . '?version=' . LACONICA_VERSION,
128 'media' => 'screen, projection, tv'));
129 $this->element('link', array('rel' => 'stylesheet',
130 'type' => 'text/css',
131 'href' => theme_path('css/thickbox.css', 'base') . '?version=' . LACONICA_VERSION,
132 'media' => 'screen, projection, tv'));
133 $this->element('link', array('rel' => 'stylesheet',
134 'type' => 'text/css',
135 'href' => theme_path('css/display.css', null) . '?version=' . LACONICA_VERSION,
136 'media' => 'screen, projection, tv'));
137 foreach (array(6,7) as $ver) {
138 if (file_exists(theme_file('ie'.$ver.'.css'))) {
139 // Yes, IE people should be put in jail.
140 $this->comment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
141 'href="'.theme_path('ie'.$ver.'.css').'?version='.LACONICA_VERSION.'" /><![endif]');
146 function showScripts()
148 $this->element('script', array('type' => 'text/javascript',
149 'src' => common_path('js/jquery.min.js')),
151 $this->element('script', array('type' => 'text/javascript',
152 'src' => common_path('js/jquery.form.js')),
154 $this->element('script', array('type' => 'text/javascript',
155 'src' => common_path('js/xbImportNode.js')),
157 $this->element('script', array('type' => 'text/javascript',
158 'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
162 function showOpenSearch()
164 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
165 'href' => common_local_url('opensearch', array('type' => 'people')),
166 'title' => common_config('site', 'name').' People Search'));
168 $this->element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
169 'href' => common_local_url('opensearch', array('type' => 'notice')),
170 'title' => common_config('site', 'name').' Notice Search'));
177 // does nothing by default
182 function showDescription()
184 // does nothing by default
191 // does nothing by default
196 $this->elementStart('body');
197 $this->elementStart('div', 'wrap');
201 $this->elementEnd('div', 'wrap');
202 $this->elementEnd('body');
205 function showHeader()
207 $this->elementStart('div', array('id' => 'header'));
209 $this->showPrimaryNav();
210 $this->showSiteNotice();
211 if (common_logged_in()) {
212 $this->showNoticeForm();
214 $this->showAnonymousMessage();
216 $this->elementEnd('div');
221 $this->elementStart('address', array('id' => 'site_contact',
222 'class' => 'vcard'));
223 $this->elementStart('a', array('class' => 'url home bookmark',
224 'href' => common_local_url('public')));
225 if ((isset($config['site']['logo']) && is_string($config['site']['logo']) && (strlen($config['site']['logo']) > 0))
226 || file_exists(theme_file('logo.png')))
228 $this->element('img', array('class' => 'logo photo',
229 'src' => isset($config['site']['logo']) ?
230 ($config['site']['logo']) : theme_path('logo.png'),
231 'alt' => $config['site']['name']));
233 $this->element('span', array('class' => 'fn org'), $config['site']['name']);
234 $this->elementEnd('a');
235 $this->elementEnd('address');
238 function showPrimaryNav()
240 $this->elementStart('dl', array('id' => 'site_nav_global_primary'));
241 $this->element('dt', null, _('Primary site navigation'));
242 $this->elementStart('dd');
243 $user = common_current_user();
244 $this->elementStart('ul', array('class' => 'nav'));
246 $this->menuItem(common_local_url('all', array('nickname' => $user->nickname)),
249 $this->menuItem(common_local_url('peoplesearch'), _('Search'));
251 $this->menuItem(common_local_url('profilesettings'),
253 $this->menuItem(common_local_url('invite'),
255 $this->menuItem(common_local_url('logout'),
258 $this->menuItem(common_local_url('login'), _('Login'));
259 if (!common_config('site', 'closed')) {
260 $this->menuItem(common_local_url('register'), _('Register'));
262 $this->menuItem(common_local_url('openidlogin'), _('OpenID'));
264 $this->menuItem(common_local_url('doc', array('title' => 'help')),
266 $this->elementEnd('ul');
267 $this->elementEnd('dd');
268 $this->elementEnd('dl');
271 // Revist. Should probably do an hAtom pattern here
272 function showSiteNotice()
274 $text = common_config('site', 'notice');
276 $this->elementStart('dl', array('id' => 'site_notice',
277 'class' => 'system_notice'));
278 $this->element('dt', null, _('Site notice'));
279 $this->element('dd', null, $text);
280 $this->elementEnd('dl');
284 // MAY overload if no notice form needed... or direct message box????
286 function showNoticeForm()
288 $notice_form = new NoticeForm($this);
289 $notice_form->show();
292 function showAnonymousMessage()
294 // needs to be defined by the class
299 $this->elementStart('div', array('id' => 'core'));
300 $this->showLocalNav();
301 $this->showContentBlock();
303 $this->elementEnd('div');
308 function showLocalNav()
310 // does nothing by default
313 function showContentBlock()
315 $this->elementStart('div', array('id' => 'content'));
316 $this->showPageTitle();
317 $this->showPageNoticeBlock();
318 $this->elementStart('div', array('id' => 'content_inner'));
319 // show the actual content (forms, lists, whatever)
320 $this->showContent();
321 $this->elementEnd('div');
322 $this->elementEnd('div');
325 function showPageTitle() {
326 $this->element('h1', NULL, $this->title());
329 function showPageNoticeBlock()
331 $this->elementStart('dl', array('id' => 'page_notice',
332 'class' => 'system_notice'));
333 $this->element('dt', null, _('Page notice'));
334 $this->elementStart('dd');
335 $this->showPageNotice();
336 $this->elementEnd('dd');
337 $this->elementEnd('dl');
340 // SHOULD overload (unless there's not a notice)
342 function showPageNotice()
348 function showContent()
354 $this->elementStart('div', array('id' => 'aside_primary',
355 'class' => 'aside'));
356 $this->showExportData();
357 $this->showSections();
358 $this->elementEnd('div');
361 // MAY overload if there are feeds
363 function showExportData()
365 // is there structure to this?
366 // list of (visible!) feed links
367 // can we reuse list of feeds from showFeeds() ?
372 function showSections() {
373 // for each section, show it
376 function showFooter()
378 $this->elementStart('div', array('id' => 'footer'));
379 $this->showSecondaryNav();
380 $this->showLicenses();
381 $this->elementEnd('div');
384 function showSecondaryNav()
386 $this->elementStart('dl', array('id' => 'site_nav_global_secondary'));
387 $this->element('dt', null, _('Secondary site navigation'));
388 $this->elementStart('dd', null);
389 $this->elementStart('ul', array('class' => 'nav'));
390 $this->menuItem(common_local_url('doc', array('title' => 'help')),
392 $this->menuItem(common_local_url('doc', array('title' => 'about')),
394 $this->menuItem(common_local_url('doc', array('title' => 'faq')),
396 $this->menuItem(common_local_url('doc', array('title' => 'privacy')),
398 $this->menuItem(common_local_url('doc', array('title' => 'source')),
400 $this->menuItem(common_local_url('doc', array('title' => 'contact')),
402 $this->elementEnd('ul');
403 $this->elementEnd('dd');
404 $this->elementEnd('dl');
407 function showLicenses()
409 $this->elementStart('dl', array('id' => 'licenses'));
410 $this->showLaconicaLicense();
411 $this->showContentLicense();
412 $this->elementEnd('dl');
415 function showLaconicaLicense()
417 $this->element('dt', array('id' => 'site_laconica_license'), _('Laconica software license'));
418 $this->elementStart('dd', null);
419 if (common_config('site', 'broughtby')) {
420 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
422 $instr = _('**%%site.name%%** is a microblogging service. ');
424 $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);
425 $output = common_markup_to_html($instr);
427 $this->elementEnd('dd');
431 function showContentLicense()
433 $this->element('dt', array('id' => 'site_content_license'), _('Laconica software license'));
434 $this->elementStart('dd', array('id' => 'site_content_license_cc'));
435 $this->elementStart('p');
436 $this->text(_('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
437 $this->element('a', array('class' => 'license',
438 'rel' => 'external license',
439 'href' => common_config('license', 'url')),
440 common_config('license', 'title'));
441 $this->text(_('. Contributors should be attributed by full name or nickname.'));
442 $this->elementEnd('p');
443 $this->element('img', array('id' => 'license_cc',
444 'src' => common_config('license', 'image'),
445 'alt' => common_config('license', 'title')));
446 $this->elementEnd('dd');
449 // For comparison with If-Last-Modified
450 // If not applicable, return null
452 function last_modified()
462 function isReadOnly()
467 function arg($key, $def=null)
469 if (array_key_exists($key, $this->args)) {
470 return $this->args[$key];
476 function trimmed($key, $def=null)
478 $arg = $this->arg($key, $def);
479 return (is_string($arg)) ? trim($arg) : $arg;
482 // Note: argarray ignored, since it's now passed in in prepare()
484 function handle($argarray=null)
487 $lm = $this->last_modified();
488 $etag = $this->etag();
491 header('ETag: ' . $etag);
495 header('Last-Modified: ' . date(DATE_RFC1123, $lm));
496 $if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];
497 if ($if_modified_since) {
498 $ims = strtotime($if_modified_since);
501 $this->_has_etag($etag, $_SERVER['HTTP_IF_NONE_MATCH'])) {
502 header('HTTP/1.1 304 Not Modified');
503 // Better way to do this?
511 function _has_etag($etag, $if_none_match)
513 return ($if_none_match) && in_array($etag, explode(',', $if_none_match));
516 function boolean($key, $def=false)
518 $arg = strtolower($this->trimmed($key));
522 } else if (in_array($arg, array('true', 'yes', '1'))) {
524 } else if (in_array($arg, array('false', 'no', '0'))) {
531 function serverError($msg, $code=500)
533 $action = $this->trimmed('action');
534 common_debug("Server error '$code' on '$action': $msg", __FILE__);
535 common_server_error($msg, $code);
538 function clientError($msg, $code=400)
540 $action = $this->trimmed('action');
541 common_debug("User error '$code' on '$action': $msg", __FILE__);
542 common_user_error($msg, $code);
547 $action = $this->trimmed('action');
549 unset($args['action']);
550 foreach (array_keys($_COOKIE) as $cookie) {
551 unset($args[$cookie]);
553 return common_local_url($action, $args);
556 // Added @id to li for some control.
557 // XXX: We might want to move this to htmloutputter.php
559 function menuItem($url, $text, $title=null, $is_selected=false, $id=null)
563 $lattrs['class'] = 'current';
566 $this->elementStart('li', (is_null($id)) ? null : array('id' => $id), $lattrs);
567 $attrs['href'] = $url;
569 $attrs['title'] = $title;
571 $this->element('a', $attrs, $text);
572 $this->elementEnd('li');
575 // Does a little before-after block for next/prev page
577 function pagination($have_before, $have_after, $page, $action, $args=null)
579 if ($have_before || $have_after) {
580 $this->elementStart('div', array('class' => 'pagination'));
581 $this->elementStart('dl', null);
582 $this->element('dt', null, _('Pagination'));
583 $this->elementStart('dd', null);
584 $this->elementStart('ul', array('class' => 'nav'));
588 $pargs = array('page' => $page-1);
589 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
591 $this->elementStart('li', array('class' => 'nav_prev'));
592 $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'prev'),
594 $this->elementEnd('li');
598 $pargs = array('page' => $page+1);
599 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
600 $this->elementStart('li', array('class' => 'nav_next'));
601 $this->element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'next'),
603 $this->elementEnd('li');
606 if ($have_before || $have_after) {
607 $this->elementEnd('ul');
608 $this->elementEnd('dd');
609 $this->elementEnd('dl');
610 $this->elementEnd('div');