3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, Controlez-Vous, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 /* XXX: break up into separate modules (HTTP, HTML, user, files) */
24 function common_server_error($msg, $code=500) {
25 static $status = array(500 => 'Internal Server Error',
26 501 => 'Not Implemented',
28 503 => 'Service Unavailable',
29 504 => 'Gateway Timeout',
30 505 => 'HTTP Version Not Supported');
32 if (!array_key_exists($code, $status)) {
36 $status_string = $status[$code];
38 header('HTTP/1.1 '.$code.' '.$status_string);
39 header('Content-type: text/plain');
47 function common_user_error($msg, $code=400) {
48 static $status = array(400 => 'Bad Request',
49 401 => 'Unauthorized',
50 402 => 'Payment Required',
53 405 => 'Method Not Allowed',
54 406 => 'Not Acceptable',
55 407 => 'Proxy Authentication Required',
56 408 => 'Request Timeout',
59 411 => 'Length Required',
60 412 => 'Precondition Failed',
61 413 => 'Request Entity Too Large',
62 414 => 'Request-URI Too Long',
63 415 => 'Unsupported Media Type',
64 416 => 'Requested Range Not Satisfiable',
65 417 => 'Expectation Failed');
67 if (!array_key_exists($code, $status)) {
71 $status_string = $status[$code];
73 header('HTTP/1.1 '.$code.' '.$status_string);
75 common_show_header('Error');
76 common_element('div', array('class' => 'error'), $msg);
82 # Start an HTML element
83 function common_element_start($tag, $attrs=NULL) {
85 $xw->startElement($tag);
86 if (is_array($attrs)) {
87 foreach ($attrs as $name => $value) {
88 $xw->writeAttribute($name, $value);
90 } else if (is_string($attrs)) {
91 $xw->writeAttribute('class', $attrs);
95 function common_element_end($tag) {
100 function common_element($tag, $attrs=NULL, $content=NULL) {
101 common_element_start($tag, $attrs);
106 common_element_end($tag);
109 function common_start_xml($doc=NULL, $public=NULL, $system=NULL) {
111 $xw = new XMLWriter();
112 $xw->openURI('php://output');
113 $xw->setIndent(true);
114 $xw->startDocument('1.0', 'UTF-8');
116 $xw->writeDTD($doc, $public, $system);
120 function common_end_xml() {
126 function common_show_header($pagetitle, $callable=NULL, $data=NULL, $headercall=NULL) {
129 header('Content-Type: application/xhtml+xml');
131 common_start_xml('html',
132 '-//W3C//DTD XHTML 1.0 Strict//EN',
133 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
135 # FIXME: correct language for interface
137 common_element_start('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
141 common_element_start('head');
142 common_element('title', NULL,
143 $pagetitle . " - " . $config['site']['name']);
144 common_element('link', array('rel' => 'stylesheet',
145 'type' => 'text/css',
146 'href' => theme_path('display.css'),
147 'media' => 'screen, projection, tv'));
148 foreach (array(6,7) as $ver) {
149 if (file_exists(theme_file('ie'.$ver.'.css'))) {
150 # Yes, IE people should be put in jail.
151 $xw->writeComment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
152 'href="'.theme_path('ie'.$ver.'.css').' /><![endif]');
157 call_user_func($callable, $data);
159 call_user_func($callable);
162 common_element_end('head');
163 common_element_start('body');
164 common_element_start('div', array('id' => 'wrap'));
165 common_element_start('div', array('id' => 'header'));
167 common_element_start('a', array('href' => common_local_url('public')));
168 common_element('img', array('src' => ($config['site']['logo']) ?
169 ($config['site']['logo']) : theme_path('logo.png'),
170 'alt' => $config['site']['name'],
172 common_element_end('a');
175 call_user_func($headercall, $data);
177 call_user_func($headercall);
180 common_element_end('div');
181 common_element_start('div', array('id' => 'content'));
184 function common_show_footer() {
186 common_element_end('div'); # content div
188 common_element_start('div', array('id' => 'footer'));
189 common_element('img', array('id' => 'cc',
190 'src' => $config['license']['image'],
191 'alt' => $config['license']['title']));
192 common_element_start('p');
193 common_text(_t('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
194 common_element('a', array('class' => 'license',
196 href => $config['license']['url']),
197 $config['license']['title']);
198 common_text(_t('. Contributors should be attributed by full name or nickname.'));
199 common_element_end('p');
200 common_element_end('div');
201 common_element_end('div');
202 common_element_end('body');
203 common_element_end('html');
207 function common_text($txt) {
212 function common_raw($xml) {
217 function common_nav_menu() {
218 $user = common_current_user();
219 common_element_start('ul', array('id' => 'nav'));
221 common_menu_item(common_local_url('all', array('nickname' => $user->nickname)),
224 common_menu_item(common_local_url('public'), _t('Public'));
225 common_menu_item(common_local_url('doc', array('title' => 'help')),
228 common_menu_item(common_local_url('profilesettings'),
230 common_menu_item(common_local_url('logout'),
233 common_menu_item(common_local_url('login'), _t('Login'));
234 common_menu_item(common_local_url('register'), _t('Register'));
236 common_element_end('ul');
239 function common_foot_menu() {
240 common_element_start('ul', array('id' => 'nav_sub'));
241 common_menu_item(common_local_url('doc', array('title' => 'about')),
243 common_menu_item(common_local_url('doc', array('title' => 'privacy')),
245 common_menu_item(common_local_url('doc', array('title' => 'source')),
247 common_element_end('ul');
250 function common_menu_item($url, $text, $title=NULL, $is_selected=false) {
253 $lattrs['class'] = 'current';
255 common_element_start('li', $lattrs);
256 $attrs['href'] = $url;
258 $attrs['title'] = $title;
260 common_element('a', $attrs, $text);
261 common_element_end('li');
264 function common_input($id, $label, $value=NULL,$instructions=NULL) {
265 common_element_start('p');
266 common_element('label', array('for' => $id), $label);
267 $attrs = array('name' => $id,
271 $attrs['value'] = htmlspecialchars($value);
273 common_element('input', $attrs);
275 common_element('span', 'input_instructions', $instructions);
277 common_element_end('p');
280 function common_hidden($id, $value) {
281 common_element('input', array('name' => $id,
287 function common_password($id, $label, $instructions=NULL) {
288 common_element_start('p');
289 common_element('label', array('for' => $id), $label);
290 $attrs = array('name' => $id,
291 'type' => 'password',
293 common_element('input', $attrs);
295 common_element('span', 'input_instructions', $instructions);
297 common_element_end('p');
300 function common_submit($id, $label) {
302 common_element_start('p');
303 common_element('input', array('type' => 'submit',
307 common_element_end('p');
310 function common_textarea($id, $label, $content=NULL, $instructions=NULL) {
311 common_element_start('p');
312 common_element('label', array('for' => $id), $label);
313 common_element('textarea', array('rows' => 3,
317 ($content) ? $content : ' ');
319 common_element('span', 'input_instructions', $instructions);
321 common_element_end('p');
324 # salted, hashed passwords are stored in the DB
326 function common_munge_password($id, $password) {
327 return md5($id . $password);
330 # check if a username exists and has matching password
331 function common_check_user($nickname, $password) {
332 $user = User::staticGet('nickname', $nickname);
333 if (is_null($user)) {
336 return (0 == strcmp(common_munge_password($password, $user->id),
341 # is the current user logged in?
342 function common_logged_in() {
343 return (!is_null(common_current_user()));
346 function common_have_session() {
347 return (0 != strcmp(session_id(), ''));
350 function common_ensure_session() {
351 if (!common_have_session()) {
356 function common_set_user($nickname) {
357 if (is_null($nickname) && common_have_session()) {
358 unset($_SESSION['userid']);
361 $user = User::staticGet('nickname', $nickname);
363 common_ensure_session();
364 $_SESSION['userid'] = $user->id;
373 # who is the current user?
374 function common_current_user() {
375 static $user = NULL; # FIXME: global memcached
376 if (is_null($user)) {
377 common_ensure_session();
378 $id = $_SESSION['userid'];
380 $user = User::staticGet($id);
386 # get canonical version of nickname for comparison
387 function common_canonical_nickname($nickname) {
388 # XXX: UTF-8 canonicalization (like combining chars)
389 return strtolower($nickname);
392 # get canonical version of email for comparison
393 function common_canonical_email($email) {
394 # XXX: canonicalize UTF-8
395 # XXX: lcase the domain part
399 define('URL_REGEX', '^|[ \t\r\n])((ftp|http|https|gopher|mailto|news|nntp|telnet|wais|file|prospero|aim|webcal):(([A-Za-z0-9$_.+!*(),;/?:@&~=-])|%[A-Fa-f0-9]{2}){2,}(#([a-zA-Z0-9][a-zA-Z0-9$_.+!*(),;/?:@&~=%-]*))?([A-Za-z0-9$_+!*();/?:~-]))');
401 function common_render_content($text, $notice) {
402 $r = htmlspecialchars($text);
403 $id = $notice->profile_id;
404 $r = preg_replace('@https?://\S+@', '<a href="\0" class="extlink">\0</a>', $r);
405 $r = preg_replace('/(^|\b)@([\w-]+)($|\b)/e', "'\\1@'.common_at_link($id, '\\2').'\\3'", $r);
411 function common_at_link($sender_id, $nickname) {
412 # Try to find profiles this profile is subscribed to that have this nickname
413 $recipient = new Profile();
414 # XXX: chokety and bad
415 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender_id.' and subscribed = id)', 'AND');
416 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
417 if ($recipient->find(TRUE)) {
418 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink tolistenee">'.$nickname.'</a>';
420 # Try to find profiles that listen to this profile and that have this nickname
421 $recipient = new Profile();
422 # XXX: chokety and bad
423 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender_id.' and subscriber = id)', 'AND');
424 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
425 if ($recipient->find(TRUE)) {
426 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink tolistener">'.$nickname.'</a>';
428 # If this is a local user, try to find a local user with that nickname.
429 $sender = User::staticGet($sender_id);
431 $recipient_user = User::staticGet('nickname', $nickname);
432 if ($recipient_user) {
433 $recipient = $recipient->getProfile();
434 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink usertouser">'.$nickname.'</a>';
437 # Otherwise, no links. @messages from local users to remote users,
438 # or from remote users to other remote users, are just
439 # outside our ability to make intelligent guesses about
443 // where should the avatar go for this user?
445 function common_avatar_filename($id, $extension, $size=NULL, $extra=NULL) {
449 return $id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
451 return $id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
455 function common_avatar_path($filename) {
457 return INSTALLDIR . '/avatar/' . $filename;
460 function common_avatar_url($filename) {
461 return common_path('avatar/'.$filename);
464 function common_default_avatar($size) {
465 static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
466 AVATAR_STREAM_SIZE => 'stream',
467 AVATAR_MINI_SIZE => 'mini');
468 return theme_path('default-avatar-'.$sizenames[$size].'.png');
471 function common_local_url($action, $args=NULL) {
473 if ($config['site']['fancy']) {
474 return common_fancy_url($action, $args);
476 return common_simple_url($action, $args);
480 function common_fancy_url($action, $args=NULL) {
481 switch (strtolower($action)) {
483 return common_path('');
485 return common_path('rss');
487 return common_path('doc/'.$args['title']);
493 return common_path('main/'.$action);
496 return common_path('settings/'.$action);
497 case 'profilesettings':
498 return common_path('settings/profile');
500 return common_path('notice/new');
502 return common_path('notice/'.$args['notice']);
503 case 'subscriptions':
508 return common_path($args['nickname'].'/'.$action);
510 return common_path($args['nickname'].'/all/rss');
512 return common_path($args['nickname'].'/rss');
514 return common_path($args['nickname']);
516 return common_simple_url($action, $args);
520 function common_simple_url($action, $args=NULL) {
522 /* XXX: pretty URLs */
525 foreach ($args as $key => $value) {
526 $extra .= "&${key}=${value}";
529 return common_path("index.php?action=${action}${extra}");
532 function common_path($relative) {
534 $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
535 return "http://".$config['site']['server'].'/'.$pathpart.$relative;
538 function common_date_string($dt) {
539 // XXX: do some sexy date formatting
540 // return date(DATE_RFC822, $dt);
544 function common_date_w3dtf($dt) {
546 return date(DATE_W3C, $t);
549 function common_redirect($url, $code=307) {
550 static $status = array(301 => "Moved Permanently",
553 307 => "Temporary Redirect");
554 header("Status: ${code} $status[$code]");
555 header("Location: $url");
556 common_element('a', array('href' => $url), $url);
559 function common_broadcast_notice($notice, $remote=false) {
560 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
562 # Make sure we have the OMB stuff
563 require_once(INSTALLDIR.'/lib/omb.php');
564 omb_broadcast_remote_subscribers($notice);
566 // XXX: broadcast notices to Jabber
567 // XXX: broadcast notices to SMS
568 // XXX: broadcast notices to other IM
572 function common_broadcast_profile($profile) {
573 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
574 require_once(INSTALLDIR.'/lib/omb.php');
575 omb_broadcast_profile($profile);
576 // XXX: Other broadcasts...?
580 function common_profile_url($nickname) {
581 return common_local_url('showstream', array('nickname' => $nickname));
584 # Don't call if nobody's logged in
586 function common_notice_form() {
587 $user = common_current_user();
588 assert(!is_null($user));
589 common_element_start('form', array('id' => 'status_form',
591 'action' => common_local_url('newnotice')));
592 common_element_start('p');
593 common_element('label', array('for' => 'status_update',
594 'id' => 'status_label'),
595 _t('What\'s up, ').$user->nickname.'?');
596 common_element('textarea', array('id' => 'status_textarea',
597 'name' => 'status_textarea'));
598 common_element('input', array('id' => 'status_submit',
599 'name' => 'status_submit',
601 'value' => _t('Send')));
602 common_element_end('p');
603 common_element_end('form');
606 function common_mint_tag($extra) {
609 'tag:'.$config['tag']['authority'].','.
610 $config['tag']['date'].':'.$config['tag']['prefix'].$extra;
613 # Should make up a reasonable root URL
615 function common_root_url() {
616 return common_path('');
619 # returns $bytes bytes of random data as a hexadecimal string
620 # "good" here is a goal and not a guarantee
622 function common_good_rand($bytes) {
623 # XXX: use random.org...?
624 if (file_exists('/dev/urandom')) {
625 return common_urandom($bytes);
626 } else { # FIXME: this is probably not good enough
627 return common_mtrand($bytes);
631 function common_urandom($bytes) {
632 $h = fopen('/dev/urandom', 'rb');
634 $src = fread($h, $bytes);
637 for ($i = 0; $i < $bytes; $i++) {
638 $enc .= sprintf("%02x", (ord($src[$i])));
643 function common_mtrand($bytes) {
645 for ($i = 0; $i < $bytes; $i++) {
646 $enc .= sprintf("%02x", mt_rand(0, 255));
651 function common_set_returnto($url) {
652 common_ensure_session();
653 $_SESSION['returnto'] = $url;
656 function common_get_returnto() {
657 common_ensure_session();
658 return $_SESSION['returnto'];
661 function common_timestamp() {
662 return date('YmdHis');
665 // XXX: set up gettext
671 function common_ensure_syslog() {
672 static $initialized = false;
675 define_syslog_variables();
676 openlog($config['syslog']['appname'], 0, LOG_USER);
681 function common_log($priority, $msg, $filename=NULL) {
682 common_ensure_syslog();
683 syslog($priority, $msg);
686 function common_debug($msg, $filename=NULL) {
688 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
690 common_log(LOG_DEBUG, $msg);
694 function common_valid_http_url($url) {
695 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
698 function common_valid_tag($tag) {
699 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
700 return (Validate::email($matches[1]) ||
701 preg_match('/^([\w-\.]+)$/', $matches[1]));
706 # Does a little before-after block for next/prev page
708 function common_pagination($have_before, $have_after, $page, $action, $args=NULL) {
710 if ($have_before || $have_after) {
711 common_element_start('div', array('id' => 'pagination'));
712 common_element_start('ul', array('id' => 'nav_pagination'));
716 $pargs = array('page' => $page-1);
717 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
719 common_element_start('li', 'before');
720 common_element('a', array('href' => common_local_url($action, $newargs)),
722 common_element_end('li');
726 $pargs = array('page' => $page+1);
727 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
728 common_element_start('li', 'after');
729 common_element('a', array('href' => common_local_url($action, $newargs)),
731 common_element_end('li');
734 if ($have_before || $have_after) {
735 common_element_end('ul');
736 common_element_end('div');