util.php 13.4 KB
Newer Older
1
<?php
Evan Prodromou's avatar
Evan Prodromou committed
2
/*
3 4
 * Laconica - a distributed open-source microblogging tool
 * Copyright (C) 2008, Controlez-Vous, Inc.
Evan Prodromou's avatar
Evan Prodromou committed
5
 *
6 7 8 9
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
Evan Prodromou's avatar
Evan Prodromou committed
10
 *
11 12 13 14
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
Evan Prodromou's avatar
Evan Prodromou committed
15
 *
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/* XXX: break up into separate modules (HTTP, HTML, user, files) */

# Show a server error

function common_server_error($msg) {
	header('Status: 500 Server Error');
	header('Content-type: text/plain');

	print $msg;
	exit();
}

# Show a user error
function common_user_error($msg, $code=200) {
	common_show_header('Error');
	common_element('div', array('class' => 'error'), $msg);
	common_show_footer();
}

39 40
$xw = null;

41 42
# Start an HTML element
function common_element_start($tag, $attrs=NULL) {
43 44
	global $xw;
	$xw->startElement($tag);
45 46
	if (is_array($attrs)) {
		foreach ($attrs as $name => $value) {
47
			$xw->writeAttribute($name, $value);
48 49
		}
	} else if (is_string($attrs)) {
50
		$xw->writeAttribute('class', $attrs);
51 52 53 54
	}
}

function common_element_end($tag) {
55 56
	global $xw;
	$xw->endElement();
57 58 59 60
}

function common_element($tag, $attrs=NULL, $content=NULL) {
    common_element_start($tag, $attrs);
61 62 63 64
	if ($content) {
		global $xw;
		$xw->text($content);
	}
65 66 67
	common_element_end($tag);
}

Evan Prodromou's avatar
Evan Prodromou committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
function common_start_xml($doc=NULL, $public=NULL, $system=NULL) {
	global $xw;
	$xw = new XMLWriter();
	$xw->openURI('php://output');
	$xw->setIndent(true);
	$xw->startDocument('1.0', 'UTF-8');
	if ($doc) {
		$xw->writeDTD($doc, $public, $system);
	}
}

function common_end_xml() {
	global $xw;
	$xw->endDocument();
	$xw->flush();
}

85
function common_show_header($pagetitle, $callable=NULL, $data=NULL) {
86
	global $config, $xw;
Evan Prodromou's avatar
Evan Prodromou committed
87 88

	header('Content-Type: application/xhtml+xml');
Evan Prodromou's avatar
Evan Prodromou committed
89

Evan Prodromou's avatar
Evan Prodromou committed
90 91 92
	common_start_xml('html',
					 '-//W3C//DTD XHTML 1.0 Strict//EN',
					 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
93 94

	# FIXME: correct language for interface
Evan Prodromou's avatar
Evan Prodromou committed
95

96 97 98
	common_element_start('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
									   'xml:lang' => 'en',
									   'lang' => 'en'));
Evan Prodromou's avatar
Evan Prodromou committed
99

100
	common_element_start('head');
Evan Prodromou's avatar
Evan Prodromou committed
101
	common_element('title', NULL,
102
				   $pagetitle . " - " . $config['site']['name']);
103 104 105 106 107 108 109 110 111 112 113 114
	common_element('link', array('rel' => 'stylesheet',
								 'type' => 'text/css',
								 'href' => $config['site']['path'] . 'theme/default/style/html.css',
								 'media' => 'screen, projection, tv'));
	common_element('link', array('rel' => 'stylesheet',
								 'type' => 'text/css',
								 'href' => $config['site']['path'] . 'theme/default/style/layout.css',
								 'media' => 'screen, projection, tv'));
	common_element('link', array('rel' => 'stylesheet',
								 'type' => 'text/css',
								 'href' => $config['site']['path'] . 'theme/default/style/print.css',
								 'media' => 'print'));
115 116 117 118 119 120 121
	if ($callable) {
		if ($data) {
			call_user_func($callable, $data);
		} else {
			call_user_func($callable);
		}
	}
122 123
	common_element_end('head');
	common_element_start('body');
124 125
	common_element_start('div', array('id' => 'wrapper'));
	common_element_start('div', array('id' => 'content'));
Evan Prodromou's avatar
Evan Prodromou committed
126
	common_element_start('div', array('id' => 'header'));
127
	common_element('h1', 'title', $pagetitle);
128 129
	common_element('h2', 'subtitle', $config['site']['name']);
	common_element_end('div');
130
	common_head_menu();
131
	common_element_start('div', array('id' => 'page'));
132 133 134
}

function common_show_footer() {
135
	global $xw, $config;
Evan Prodromou's avatar
Evan Prodromou committed
136
	common_element_start('div', 'footer');
137
	common_foot_menu();
138
	common_license_block();
139
	common_element_end('div');
140 141 142
	common_element_end('div');
	common_element_end('div');
	common_element_end('div');
143 144
	common_element_end('body');
	common_element_end('html');
Evan Prodromou's avatar
Evan Prodromou committed
145
	common_end_xml();
146 147
}

148 149 150 151 152
function common_text($txt) {
	global $xw;
	$xw->text($txt);
}

Evan Prodromou's avatar
Evan Prodromou committed
153 154 155 156 157
function common_raw($xml) {
	global $xw;
	$xw->writeRaw($xml);
}

158 159
function common_license_block() {
	global $config, $xw;
Evan Prodromou's avatar
Evan Prodromou committed
160
	common_element_start('p', 'license greenBg');
Evan Prodromou's avatar
Evan Prodromou committed
161 162
	common_element_start('span', 'floatLeft width25');
	common_element_start('a', array('class' => 'license',
163 164 165
									'rel' => 'license',
									href => $config['license']['url']));
	common_element('img', array('class' => 'license',
Evan Prodromou's avatar
Evan Prodromou committed
166 167
								'src' => $config['license']['image'],
								'alt' => $config['license']['title']));
168
	common_element_end('a');
Evan Prodromou's avatar
Evan Prodromou committed
169
	common_element_end('span');
Evan Prodromou's avatar
Evan Prodromou committed
170
	common_element_start('span', 'floatRight width75');
171 172 173 174
	common_text(_t('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
	common_element('a', array('class' => 'license',
							  'rel' => 'license',
							  href => $config['license']['url']),
Evan Prodromou's avatar
Evan Prodromou committed
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');
179 180
}

181 182
function common_head_menu() {
	$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'));
185
	if ($user) {
Evan Prodromou's avatar
Evan Prodromou committed
186
		common_menu_item(common_local_url('all', array('nickname' =>
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
													   $user->nickname)),
						 _t('Home'));
		common_menu_item(common_local_url('showstream', array('nickname' =>
															  $user->nickname)),
						 _t('Profile'),  $user->fullname || $user->nickname);
		common_menu_item(common_local_url('profilesettings'),
						 _t('Settings'));
		common_menu_item(common_local_url('logout'),
						 _t('Logout'));
	} else {
		common_menu_item(common_local_url('login'),
						 _t('Login'));
		common_menu_item(common_local_url('register'),
						 _t('Register'));
	}
	common_element_end('ul');
}

function common_foot_menu() {
Evan Prodromou's avatar
Evan Prodromou committed
206
	common_element_start('ul', 'footmenu menuish');
207 208 209 210 211 212
	common_menu_item(common_local_url('doc', array('title' => 'about')),
					 _t('About'));
	common_menu_item(common_local_url('doc', array('title' => 'help')),
					 _t('Help'));
	common_menu_item(common_local_url('doc', array('title' => 'privacy')),
					 _t('Privacy'));
213
	common_menu_item(common_local_url('doc', array('title' => 'source')),
Evan Prodromou's avatar
Evan Prodromou committed
214
					 _t('Source'));
Evan Prodromou's avatar
Evan Prodromou committed
215
	common_element_end('ul');
216 217 218 219 220 221 222 223 224 225 226 227 228
}

function common_menu_item($url, $text, $title=NULL) {
	$attrs['href'] = $url;
	if ($title) {
		$attrs['title'] = $title;
	}
	common_element_start('li', 'menuitem');
	common_element('a', $attrs, $text);
	common_element_end('li');
}

function common_input($id, $label, $value=NULL) {
Evan Prodromou's avatar
Evan Prodromou committed
229
	common_element_start('p');
230 231 232 233 234 235 236 237
	common_element('label', array('for' => $id), $label);
	$attrs = array('name' => $id,
				   'type' => 'text',
				   'id' => $id);
	if ($value) {
		$attrs['value'] = htmlspecialchars($value);
	}
	common_element('input', $attrs);
Evan Prodromou's avatar
Evan Prodromou committed
238
	common_element_end('p');
239 240 241
}

function common_password($id, $label) {
Evan Prodromou's avatar
Evan Prodromou committed
242
	common_element_start('p');
243 244 245 246 247
	common_element('label', array('for' => $id), $label);
	$attrs = array('name' => $id,
				   'type' => 'password',
				   'id' => $id);
	common_element('input', $attrs);
Evan Prodromou's avatar
Evan Prodromou committed
248
	common_element_end('p');
Evan Prodromou's avatar
Evan Prodromou committed
249 250 251
}

function common_submit($id, $label) {
252
	global $xw;
Evan Prodromou's avatar
Evan Prodromou committed
253
	common_element_start('p');
254 255 256
	common_element_start('label', array('for' => $id));
	$xw->writeRaw('&nbsp;');
	common_element_end('label');
Evan Prodromou's avatar
Evan Prodromou committed
257 258 259
	common_element('input', array('type' => 'submit',
								  'id' => $id,
								  'name' => $id,
Evan Prodromou's avatar
Evan Prodromou committed
260 261
								  'value' => $label,
								  'class' => 'button'));
Evan Prodromou's avatar
Evan Prodromou committed
262
	common_element_end('p');
263 264
}

265 266 267
function common_textarea($id, $label, $content=NULL) {
	common_element_start('p');
	common_element('label', array('for' => $id), $label);
Evan Prodromou's avatar
Evan Prodromou committed
268 269
	common_element('textarea', array('rows' => 3,
									 'cols' => 40,
270 271 272 273 274 275 276
									 'name' => $id,
									 'id' => $id, 
									 'class' => 'width50'),
				   ($content) ? $content : ' ');
	common_element_end('p');
}

277 278 279 280 281 282 283 284 285 286 287 288
# salted, hashed passwords are stored in the DB

function common_munge_password($id, $password) {
	return md5($id . $password);
}

# check if a username exists and has matching password
function common_check_user($nickname, $password) {
	$user = User::staticGet('nickname', $nickname);
	if (is_null($user)) {
		return false;
	} else {
Evan Prodromou's avatar
Evan Prodromou committed
289
		return (0 == strcmp(common_munge_password($password, $user->id),
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
							$user->password));
	}
}

# is the current user logged in?
function common_logged_in() {
	return (!is_null(common_current_user()));
}

function common_have_session() {
	return (0 != strcmp(session_id(), ''));
}

function common_ensure_session() {
	if (!common_have_session()) {
		@session_start();
	}
}

function common_set_user($nickname) {
	if (is_null($nickname) && common_have_session()) {
		unset($_SESSION['userid']);
		return true;
	} else {
		$user = User::staticGet('nickname', $nickname);
		if ($user) {
			common_ensure_session();
			$_SESSION['userid'] = $user->id;
			return true;
		} else {
			return false;
		}
	}
	return false;
}

# who is the current user?
function common_current_user() {
	static $user = NULL; # FIXME: global memcached
	if (is_null($user)) {
		common_ensure_session();
		$id = $_SESSION['userid'];
		if ($id) {
			$user = User::staticGet($id);
		}
	}
	return $user;
}

# get canonical version of nickname for comparison
function common_canonical_nickname($nickname) {
	# XXX: UTF-8 canonicalization (like combining chars)
	return $nickname;
}

# get canonical version of email for comparison
function common_canonical_email($email) {
	# XXX: canonicalize UTF-8
	# XXX: lcase the domain part
	return $email;
}

function common_render_content($text) {
	# XXX: @ messages
	# XXX: # tags
	# XXX: machine tags
	return htmlspecialchars($text);
}

// where should the avatar go for this user?

361
function common_avatar_filename($user, $extension, $size=NULL, $extra=NULL) {
362 363 364
	global $config;

	if ($size) {
365
		return $user->id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
366
	} else {
367
		return $user->id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
368 369 370 371 372 373 374 375 376 377
	}
}

function common_avatar_path($filename) {
	global $config;
	return $config['avatar']['directory'] . '/' . $filename;
}

function common_avatar_url($filename) {
	global $config;
Evan Prodromou's avatar
Evan Prodromou committed
378
	return "http://".$config['site']['server'].$config['avatar']['path'].'/'.$filename;
379 380
}

381 382 383 384 385
function common_default_avatar($size) {
	static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
							  AVATAR_STREAM_SIZE => 'stream',
							  AVATAR_MINI_SIZE => 'mini');
	global $config;
Evan Prodromou's avatar
Evan Prodromou committed
386
	return "http://".$config['site']['server'].$config['site']['path'].'/'.$config['avatar']['default'][$sizenames[$size]];
387 388
}

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
function common_local_url($action, $args=NULL) {
	global $config;
	/* XXX: pretty URLs */
	$extra = '';
	if ($args) {
		foreach ($args as $key => $value) {
			$extra .= "&${key}=${value}";
		}
	}
	$pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
	return "http://".$config['site']['server'].'/'.$pathpart."index.php?action=${action}${extra}";
}

function common_date_string($dt) {
	// XXX: do some sexy date formatting
	// return date(DATE_RFC822, $dt);
	return $dt;
}

408 409 410 411 412
function common_date_w3dtf($dt) {
	$t = strtotime($dt);
	return date(DATE_W3C, $t);
}

413 414 415 416 417 418 419 420 421 422
function common_redirect($url, $code=307) {
	static $status = array(301 => "Moved Permanently",
						   302 => "Found",
						   303 => "See Other",
						   307 => "Temporary Redirect");
	header("Status: ${code} $status[$code]");
	header("Location: $url");
	common_element('a', array('href' => $url), $url);
}

423
function common_broadcast_notice($notice) {
424 425 426 427 428 429 430 431 432 433 434 435
	// XXX: broadcast notices to remote subscribers
	// XXX: broadcast notices to SMS
	// XXX: broadcast notices to Jabber
	// XXX: broadcast notices to other IM
	// XXX: use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
	return true;
}

function common_profile_url($nickname) {
	return common_local_url('showstream', array('nickname' => $nickname));
}

Evan Prodromou's avatar
Evan Prodromou committed
436 437 438
function common_notice_form() {
	common_element_start('form', array('id' => 'newnotice', 'method' => 'POST',
									   'action' => common_local_url('newnotice')));
Evan Prodromou's avatar
Evan Prodromou committed
439
	common_textarea('noticecontent', _t('What\'s up?'));
Evan Prodromou's avatar
Evan Prodromou committed
440 441
	common_submit('submit', _t('Send'));
	common_element_end('form');
Evan Prodromou's avatar
Evan Prodromou committed
442
}
Evan Prodromou's avatar
Evan Prodromou committed
443

Evan Prodromou's avatar
Evan Prodromou committed
444 445 446 447
function common_mint_tag($extra) {
	global $config;
	return 
	  'tag:'.$config['tag']['authority'].','.
Evan Prodromou's avatar
Evan Prodromou committed
448
	  $config['tag']['date'].':'.$config['tag']['prefix'].$extra;
Evan Prodromou's avatar
Evan Prodromou committed
449 450
}

451 452 453 454 455 456 457 458
# Should make up a reasonable root URL

function common_root_url() {
	global $config;
	$pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
	return "http://".$config['site']['server'].'/'.$pathpart;
}

Evan Prodromou's avatar
Evan Prodromou committed
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
# returns $bytes bytes of random data as a hexadecimal string
# "good" here is a goal and not a guarantee

function common_good_rand($bytes) {
	# XXX: use random.org...?
	if (file_exists('/dev/urandom')) {
		return common_urandom($bytes);
	} else { # FIXME: this is probably not good enough
		return common_mtrand($bytes);
	}
}

function common_urandom($bytes) {
	$h = fopen('/dev/urandom', 'rb');
	# should not block
	$src = fread($h, $bytes);
	fclose($h);
	$enc = '';
	for ($i = 0; $i < $bytes; $i++) {
		$enc .= sprintf("%02x", (ord($src[$i])));
	}
	return $enc;
}

function common_mtrand($bytes) {
	$enc = '';
	for ($i = 0; $i < $bytes; $i++) {
		$enc .= sprintf("%02x", mt_rand(0, 255));
	}
	return $enc;
}

491
function common_timestamp() {
492
	return date('YmdHis');
493 494
}
	
495 496
// XXX: set up gettext

Evan Prodromou's avatar
Evan Prodromou committed
497
function _t($str) {
498 499
	return $str;
}