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) {
25 header('Status: 500 Server Error');
26 header('Content-type: text/plain');
33 function common_user_error($msg, $code=200) {
34 common_show_header('Error');
35 common_element('div', array('class' => 'error'), $msg);
41 # Start an HTML element
42 function common_element_start($tag, $attrs=NULL) {
44 $xw->startElement($tag);
45 if (is_array($attrs)) {
46 foreach ($attrs as $name => $value) {
47 $xw->writeAttribute($name, $value);
49 } else if (is_string($attrs)) {
50 $xw->writeAttribute('class', $attrs);
54 function common_element_end($tag) {
59 function common_element($tag, $attrs=NULL, $content=NULL) {
60 common_element_start($tag, $attrs);
65 common_element_end($tag);
68 function common_start_xml($doc=NULL, $public=NULL, $system=NULL) {
70 $xw = new XMLWriter();
71 $xw->openURI('php://output');
73 $xw->startDocument('1.0', 'UTF-8');
75 $xw->writeDTD($doc, $public, $system);
79 function common_end_xml() {
85 function common_show_header($pagetitle, $callable=NULL, $data=NULL) {
88 header('Content-Type: application/xhtml+xml');
90 common_start_xml('html',
91 '-//W3C//DTD XHTML 1.0 Strict//EN',
92 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
94 # FIXME: correct language for interface
96 common_element_start('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
100 common_element_start('head');
101 common_element('title', NULL,
102 $pagetitle . " - " . $config['site']['name']);
103 common_element('link', array('rel' => 'stylesheet',
104 'type' => 'text/css',
105 'href' => $config['site']['path'] . 'theme/default/style/html.css',
106 'media' => 'screen, projection, tv'));
107 common_element('link', array('rel' => 'stylesheet',
108 'type' => 'text/css',
109 'href' => $config['site']['path'] . 'theme/default/style/layout.css',
110 'media' => 'screen, projection, tv'));
111 common_element('link', array('rel' => 'stylesheet',
112 'type' => 'text/css',
113 'href' => $config['site']['path'] . 'theme/default/style/print.css',
114 'media' => 'print'));
117 call_user_func($callable, $data);
119 call_user_func($callable);
122 common_element_end('head');
123 common_element_start('body');
124 common_element_start('div', array('id' => 'wrapper'));
125 common_element_start('div', array('id' => 'content'));
126 common_element_start('div', array('id' => 'header'));
127 common_element('h1', 'title', $pagetitle);
128 common_element('h2', 'subtitle', $config['site']['name']);
129 common_element_end('div');
131 common_element_start('div', array('id' => 'page'));
134 function common_show_footer() {
136 common_element_start('div', 'footer');
138 common_license_block();
139 common_element_end('div');
140 common_element_end('div');
141 common_element_end('div');
142 common_element_end('div');
143 common_element_end('body');
144 common_element_end('html');
148 function common_text($txt) {
153 function common_raw($xml) {
158 function common_license_block() {
160 common_element_start('p', 'license greenBg');
161 common_element_start('span', 'floatLeft width25');
162 common_element_start('a', array('class' => 'license',
164 href => $config['license']['url']));
165 common_element('img', array('class' => 'license',
166 'src' => $config['license']['image'],
167 'alt' => $config['license']['title']));
168 common_element_end('a');
169 common_element_end('span');
170 common_element_start('span', 'floatRight width75');
171 common_text(_t('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
172 common_element('a', array('class' => 'license',
174 href => $config['license']['url']),
175 $config['license']['title']);
176 common_text(_t('. Contributors should be attributed by full name or nickname.'));
177 common_element_end('span');
178 common_element_end('p');
181 function common_head_menu() {
182 $user = common_current_user();
183 common_element_start('ul', array('id' => 'menu', 'class' => ($user) ? 'five' : 'three'));
184 common_menu_item(common_local_url('public'), _t('Public'));
186 common_menu_item(common_local_url('all', array('nickname' =>
189 common_menu_item(common_local_url('showstream', array('nickname' =>
191 _t('Profile'), $user->fullname || $user->nickname);
192 common_menu_item(common_local_url('profilesettings'),
194 common_menu_item(common_local_url('logout'),
197 common_menu_item(common_local_url('login'),
199 common_menu_item(common_local_url('register'),
202 common_element_end('ul');
205 function common_foot_menu() {
206 common_element_start('ul', 'footmenu menuish');
207 common_menu_item(common_local_url('doc', array('title' => 'about')),
209 common_menu_item(common_local_url('doc', array('title' => 'help')),
211 common_menu_item(common_local_url('doc', array('title' => 'privacy')),
213 common_menu_item(common_local_url('doc', array('title' => 'source')),
215 common_element_end('ul');
218 function common_menu_item($url, $text, $title=NULL) {
219 $attrs['href'] = $url;
221 $attrs['title'] = $title;
223 common_element_start('li', 'menuitem');
224 common_element('a', $attrs, $text);
225 common_element_end('li');
228 function common_input($id, $label, $value=NULL) {
229 common_element_start('p');
230 common_element('label', array('for' => $id), $label);
231 $attrs = array('name' => $id,
235 $attrs['value'] = htmlspecialchars($value);
237 common_element('input', $attrs);
238 common_element_end('p');
241 function common_password($id, $label) {
242 common_element_start('p');
243 common_element('label', array('for' => $id), $label);
244 $attrs = array('name' => $id,
245 'type' => 'password',
247 common_element('input', $attrs);
248 common_element_end('p');
251 function common_submit($id, $label) {
253 common_element_start('p');
254 common_element_start('label', array('for' => $id));
255 $xw->writeRaw(' ');
256 common_element_end('label');
257 common_element('input', array('type' => 'submit',
261 'class' => 'button'));
262 common_element_end('p');
265 function common_textarea($id, $label, $content=NULL) {
266 common_element_start('p');
267 common_element('label', array('for' => $id), $label);
268 common_element('textarea', array('rows' => 3,
272 'class' => 'width50'),
273 ($content) ? $content : ' ');
274 common_element_end('p');
277 # salted, hashed passwords are stored in the DB
279 function common_munge_password($id, $password) {
280 return md5($id . $password);
283 # check if a username exists and has matching password
284 function common_check_user($nickname, $password) {
285 $user = User::staticGet('nickname', $nickname);
286 if (is_null($user)) {
289 return (0 == strcmp(common_munge_password($password, $user->id),
294 # is the current user logged in?
295 function common_logged_in() {
296 return (!is_null(common_current_user()));
299 function common_have_session() {
300 return (0 != strcmp(session_id(), ''));
303 function common_ensure_session() {
304 if (!common_have_session()) {
309 function common_set_user($nickname) {
310 if (is_null($nickname) && common_have_session()) {
311 unset($_SESSION['userid']);
314 $user = User::staticGet('nickname', $nickname);
316 common_ensure_session();
317 $_SESSION['userid'] = $user->id;
326 # who is the current user?
327 function common_current_user() {
328 static $user = NULL; # FIXME: global memcached
329 if (is_null($user)) {
330 common_ensure_session();
331 $id = $_SESSION['userid'];
333 $user = User::staticGet($id);
339 # get canonical version of nickname for comparison
340 function common_canonical_nickname($nickname) {
341 # XXX: UTF-8 canonicalization (like combining chars)
345 # get canonical version of email for comparison
346 function common_canonical_email($email) {
347 # XXX: canonicalize UTF-8
348 # XXX: lcase the domain part
352 function common_render_content($text, $notice) {
353 $r = htmlspecialchars($text);
354 $id = $notice->profile_id;
355 $r = preg_replace('/(^|\s)@([\w-]+)($|\s)/e', "'\\1@'.common_at_link($id, '\\2').'\\3'", $r);
361 function common_at_link($sender_id, $nickname) {
362 # Try to find profiles this profile is subscribed to that have this nickname
363 $recipient = new Profile();
364 # XXX: chokety and bad
365 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender_id.' and subscribed = id)', 'AND');
366 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
367 if ($recipient->find(TRUE)) {
368 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink tolistenee">'.$nickname.'</a>';
370 # Try to find profiles that listen to this profile and that have this nickname
371 $recipient = new Profile();
372 # XXX: chokety and bad
373 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender_id.' and subscriber = id)', 'AND');
374 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
375 if ($recipient->find(TRUE)) {
376 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink tolistener">'.$nickname.'</a>';
378 # If this is a local user, try to find a local user with that nickname.
379 $sender = User::staticGet($sender_id);
381 $recipient_user = User::staticGet('nickname', $nickname);
382 if ($recipient_user) {
383 $recipient = $recipient->getProfile();
384 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink usertouser">'.$nickname.'</a>';
387 # Otherwise, no links. @messages from local users to remote users,
388 # or from remote users to other remote users, are just
389 # outside our ability to make intelligent guesses about
393 // where should the avatar go for this user?
395 function common_avatar_filename($user, $extension, $size=NULL, $extra=NULL) {
399 return $user->id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
401 return $user->id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
405 function common_avatar_path($filename) {
407 return $config['avatar']['directory'] . '/' . $filename;
410 function common_avatar_url($filename) {
412 return "http://".$config['site']['server'].$config['avatar']['path'].'/'.$filename;
415 function common_default_avatar($size) {
416 static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
417 AVATAR_STREAM_SIZE => 'stream',
418 AVATAR_MINI_SIZE => 'mini');
420 return "http://".$config['site']['server'].$config['site']['path'].'/'.$config['avatar']['default'][$sizenames[$size]];
423 function common_local_url($action, $args=NULL) {
425 /* XXX: pretty URLs */
428 foreach ($args as $key => $value) {
429 $extra .= "&${key}=${value}";
432 $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
433 return "http://".$config['site']['server'].'/'.$pathpart."index.php?action=${action}${extra}";
436 function common_date_string($dt) {
437 // XXX: do some sexy date formatting
438 // return date(DATE_RFC822, $dt);
442 function common_date_w3dtf($dt) {
444 return date(DATE_W3C, $t);
447 function common_redirect($url, $code=307) {
448 static $status = array(301 => "Moved Permanently",
451 307 => "Temporary Redirect");
452 header("Status: ${code} $status[$code]");
453 header("Location: $url");
454 common_element('a', array('href' => $url), $url);
457 function common_broadcast_notice($notice) {
458 // XXX: broadcast notices to remote subscribers
459 // XXX: broadcast notices to SMS
460 // XXX: broadcast notices to Jabber
461 // XXX: broadcast notices to other IM
462 // XXX: use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
466 function common_profile_url($nickname) {
467 return common_local_url('showstream', array('nickname' => $nickname));
470 function common_notice_form() {
471 common_element_start('form', array('id' => 'newnotice', 'method' => 'POST',
472 'action' => common_local_url('newnotice')));
473 common_textarea('noticecontent', _t('What\'s up?'));
474 common_submit('submit', _t('Send'));
475 common_element_end('form');
478 function common_mint_tag($extra) {
481 'tag:'.$config['tag']['authority'].','.
482 $config['tag']['date'].':'.$config['tag']['prefix'].$extra;
485 # Should make up a reasonable root URL
487 function common_root_url() {
489 $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
490 return "http://".$config['site']['server'].'/'.$pathpart;
493 # returns $bytes bytes of random data as a hexadecimal string
494 # "good" here is a goal and not a guarantee
496 function common_good_rand($bytes) {
497 # XXX: use random.org...?
498 if (file_exists('/dev/urandom')) {
499 return common_urandom($bytes);
500 } else { # FIXME: this is probably not good enough
501 return common_mtrand($bytes);
505 function common_urandom($bytes) {
506 $h = fopen('/dev/urandom', 'rb');
508 $src = fread($h, $bytes);
511 for ($i = 0; $i < $bytes; $i++) {
512 $enc .= sprintf("%02x", (ord($src[$i])));
517 function common_mtrand($bytes) {
519 for ($i = 0; $i < $bytes; $i++) {
520 $enc .= sprintf("%02x", mt_rand(0, 255));
525 function common_timestamp() {
526 return date('YmdHis');
529 // XXX: set up gettext