3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, Control Yourself, 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, user, files) */
22 // Show a server error
24 function common_server_error($msg, $code=500)
26 $err = new ServerErrorAction($msg, $code);
31 function common_user_error($msg, $code=400)
33 $err = new ClientErrorAction($msg, $code);
37 function common_init_locale($language=null)
40 $language = common_language();
42 putenv('LANGUAGE='.$language);
43 putenv('LANG='.$language);
44 return setlocale(LC_ALL, $language . ".utf8",
51 function common_init_language()
53 mb_internal_encoding('UTF-8');
54 $language = common_language();
55 // So we don't have to make people install the gettext locales
56 $locale_set = common_init_locale($language);
57 bindtextdomain("laconica", common_config('site','locale_path'));
58 bind_textdomain_codeset("laconica", "UTF-8");
59 textdomain("laconica");
60 setlocale(LC_CTYPE, 'C');
62 common_log(LOG_INFO,'Language requested:'.$language.' - locale could not be set:',__FILE__);
66 function common_timezone()
68 if (common_logged_in()) {
69 $user = common_current_user();
70 if ($user->timezone) {
71 return $user->timezone;
75 return common_config('site', 'timezone');
78 function common_language()
81 // If there is a user logged in and they've set a language preference
82 // then return that one...
83 if (_have_config() && common_logged_in()) {
84 $user = common_current_user();
85 $user_language = $user->language;
87 return $user_language;
90 // Otherwise, find the best match for the languages requested by the
92 $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
93 if (!empty($httplang)) {
94 $language = client_prefered_language($httplang);
99 // Finally, if none of the above worked, use the site's default...
100 return common_config('site', 'language');
102 // salted, hashed passwords are stored in the DB
104 function common_munge_password($password, $id)
106 return md5($password . $id);
109 // check if a username exists and has matching password
110 function common_check_user($nickname, $password)
112 // NEVER allow blank passwords, even if they match the DB
113 if (mb_strlen($password) == 0) {
116 $user = User::staticGet('nickname', $nickname);
117 if (is_null($user) || $user === false) {
120 if (0 == strcmp(common_munge_password($password, $user->id),
129 // is the current user logged in?
130 function common_logged_in()
132 return (!is_null(common_current_user()));
135 function common_have_session()
137 return (0 != strcmp(session_id(), ''));
140 function common_ensure_session()
143 if (array_key_exists(session_name(), $_COOKIE)) {
144 $c = $_COOKIE[session_name()];
146 if (!common_have_session()) {
147 if (common_config('sessions', 'handle')) {
148 Session::setSaveHandler();
151 if (!isset($_SESSION['started'])) {
152 $_SESSION['started'] = time();
154 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
155 ' is set but started value is null');
161 // Three kinds of arguments:
166 // Initialize to false; set to null if none found
170 function common_set_user($user)
175 if (is_null($user) && common_have_session()) {
177 unset($_SESSION['userid']);
179 } else if (is_string($user)) {
181 $user = User::staticGet('nickname', $nickname);
182 } else if (!($user instanceof User)) {
187 common_ensure_session();
188 $_SESSION['userid'] = $user->id;
195 function common_set_cookie($key, $value, $expiration=0)
197 $path = common_config('site', 'path');
198 $server = common_config('site', 'server');
200 if ($path && ($path != '/')) {
201 $cookiepath = '/' . $path . '/';
205 return setcookie($key,
212 define('REMEMBERME', 'rememberme');
213 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
215 function common_rememberme($user=null)
218 $user = common_current_user();
220 common_debug('No current user to remember', __FILE__);
225 $rm = new Remember_me();
227 $rm->code = common_good_rand(16);
228 $rm->user_id = $user->id;
230 // Wrap the insert in some good ol' fashioned transaction code
234 $result = $rm->insert();
237 common_log_db_error($rm, 'INSERT', __FILE__);
238 common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
242 $rm->query('COMMIT');
244 common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
246 $cookieval = $rm->user_id . ':' . $rm->code;
248 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
250 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
255 function common_remembered_user()
260 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
266 list($id, $code) = explode(':', $packed);
268 if (!$id || !$code) {
269 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
274 $rm = Remember_me::staticGet($code);
277 common_log(LOG_WARNING, 'No such remember code: ' . $code);
282 if ($rm->user_id != $id) {
283 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
288 $user = User::staticGet($rm->user_id);
291 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
297 $result = $rm->delete();
300 common_log_db_error($rm, 'DELETE', __FILE__);
301 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
306 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
308 common_set_user($user);
309 common_real_login(false);
311 // We issue a new cookie, so they can log in
312 // automatically again after this session
314 common_rememberme($user);
319 // must be called with a valid user!
321 function common_forgetme()
323 common_set_cookie(REMEMBERME, '', 0);
326 // who is the current user?
327 function common_current_user()
331 if (!_have_config()) {
335 if ($_cur === false) {
337 if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
338 common_ensure_session();
339 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
341 $_cur = User::staticGet($id);
346 // that didn't work; try to remember; will init $_cur to null on failure
347 $_cur = common_remembered_user();
350 common_debug("Got User " . $_cur->nickname);
351 common_debug("Faking session on remembered user");
352 // XXX: Is this necessary?
353 $_SESSION['userid'] = $_cur->id;
360 // Logins that are 'remembered' aren't 'real' -- they're subject to
361 // cookie-stealing. So, we don't let them do certain things. New reg,
362 // OpenID, and password logins _are_ real.
364 function common_real_login($real=true)
366 common_ensure_session();
367 $_SESSION['real_login'] = $real;
370 function common_is_real_login()
372 return common_logged_in() && $_SESSION['real_login'];
375 // get canonical version of nickname for comparison
376 function common_canonical_nickname($nickname)
378 // XXX: UTF-8 canonicalization (like combining chars)
379 return strtolower($nickname);
382 // get canonical version of email for comparison
383 function common_canonical_email($email)
385 // XXX: canonicalize UTF-8
386 // XXX: lcase the domain part
390 function common_render_content($text, $notice)
392 $r = common_render_text($text);
393 $id = $notice->profile_id;
394 $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
395 $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
396 $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
397 $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
401 function common_render_text($text)
403 $r = htmlspecialchars($text);
405 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
406 $r = common_replace_urls_callback($r, 'common_linkify');
407 $r = preg_replace('/(^|\(|\[|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
412 function common_replace_urls_callback($text, $callback, $notice_id = null) {
413 // Start off with a regex
415 '(?:^|[\s\(\)\[\]\{\}]+)('.
416 '(?:'. //Known protocols
418 '(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://'.
420 '(?:mailto|aim|tel|xmpp):'.
421 ')[^\s\(\)\[\]\{\}]+'.
423 '|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)'. //IPv4
425 '(?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,6}|'.
426 '(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,5}|'.
427 '(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,4}|'.
428 '(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,3}|'.
429 '(?:[0-9a-f]{1,4}:){1,5}(?::[0-9a-f]{1,4}){1,2}|'.
430 '(?:[0-9a-f]{1,4}:){1,6}(?::[0-9a-f]{1,4}){1,1}|'.
431 '(?:(?:[0-9a-f]{1,4}:){1,7}|:):|'.
432 ':(?::[0-9a-f]{1,4}){1,7}|'.
433 '(?:(?:(?:[0-9a-f]{1,4}:){6})(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3})|'.
434 '(?:(?:[0-9a-f]{1,4}:){5}[0-9a-f]{1,4}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3})|'.
435 '(?:[0-9a-f]{1,4}:){5}:[0-9a-f]{1,4}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
436 '(?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,4}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
437 '(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,3}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
438 '(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,2}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
439 '(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,1}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
440 '(?:(?:[0-9a-f]{1,4}:){1,5}|:):(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
441 ':(?::[0-9a-f]{1,4}){1,5}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}'.
443 '\S+\.(?:museum|travel|onion|local|[a-z]{2,4})'.
445 '([^\s\(\)\[\]\{\}]*)'.
448 return preg_replace_callback($regex, curry(callback_helper,$callback,$notice_id) ,$text);
451 function callback_helper($matches, $callback, $notice_id) {
452 $pos = strpos($matches[0],$matches[1]);
453 $left = substr($matches[0],0,$pos);
454 $right = substr($matches[0],$pos+strlen($matches[1]));
456 if(empty($notice_id)){
457 $result = call_user_func_array($callback,$matches[1]);
459 $result = call_user_func_array($callback, array($matches[1],$notice_id) );
461 return $left . $result . $right;
464 function curry($fn) {
465 //TODO switch to a PHP 5.3 function closure based approach if PHP 5.3 is used
466 $args = func_get_args();
468 $id = uniqid('_partial');
469 $GLOBALS[$id] = array($fn, $args);
470 return create_function(
473 $args = func_get_args();
474 return call_user_func_array(
475 $GLOBALS["'.$id.'"][0],
478 $GLOBALS["'.$id.'"][1]));
482 function common_linkify($url) {
483 // It comes in special'd, so we unspecial it before passing to the stringifying
485 $url = htmlspecialchars_decode($url);
487 if(strpos($url, '@')!==false && strpos($url, ':')===false){
488 //url is an email address without the mailto: protocol
489 return XMLStringer::estring('a', array('href' => "mailto:$url", 'rel' => 'external'), $url);
492 $canon = File_redirection::_canonUrl($url);
494 $longurl_data = File_redirection::where($url);
495 if (is_array($longurl_data)) {
496 $longurl = $longurl_data['url'];
497 } elseif (is_string($longurl_data)) {
498 $longurl = $longurl_data;
500 throw new ServerException("Can't linkify url '$url'");
503 $attrs = array('href' => $canon, 'rel' => 'external');
505 $is_attachment = false;
506 $attachment_id = null;
509 // Check to see whether there's a filename associated with this URL.
510 // If there is, it's an upload and qualifies as an attachment
512 $localfile = File::staticGet('url', $longurl);
514 if (!empty($localfile)) {
515 if (isset($localfile->filename)) {
516 $is_attachment = true;
517 $attachment_id = $localfile->id;
521 // if this URL is an attachment, then we set class='attachment' and id='attahcment-ID'
522 // where ID is the id of the attachment for the given URL.
524 // we need a better test telling what can be shown as an attachment
525 // we're currently picking up oembeds only.
526 // I think the best option is another file_view table in the db
527 // and associated dbobject.
529 $query = "select file_oembed.file_id as file_id from file join file_oembed on file.id = file_oembed.file_id where file.url='$longurl'";
531 $file->query($query);
534 if (!empty($file->file_id)) {
535 $is_attachment = true;
536 $attachment_id = $file->file_id;
538 $query = "select file_thumbnail.file_id as file_id from file join file_thumbnail on file.id = file_thumbnail.file_id where file.url='$longurl'";
540 $file2->query($query);
543 if (!empty($file2)) {
549 if ($is_attachment) {
550 $attrs['class'] = 'attachment';
552 $attrs['class'] = 'attachment thumbnail';
554 $attrs['id'] = "attachment-{$attachment_id}";
557 return XMLStringer::estring('a', $attrs, $url);
560 function common_shorten_links($text)
562 if (mb_strlen($text) <= 140) return $text;
563 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
566 function common_xml_safe_str($str)
568 // Neutralize control codes and surrogates
569 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
572 function common_tag_link($tag)
574 $canonical = common_canonical_tag($tag);
575 $url = common_local_url('tag', array('tag' => $canonical));
576 $xs = new XMLStringer();
577 $xs->elementStart('span', 'tag');
578 $xs->element('a', array('href' => $url,
581 $xs->elementEnd('span');
582 return $xs->getString();
585 function common_canonical_tag($tag)
587 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
588 return str_replace(array('-', '_', '.'), '', $tag);
591 function common_valid_profile_tag($str)
593 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
596 function common_at_link($sender_id, $nickname)
598 $sender = Profile::staticGet($sender_id);
599 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
601 $user = User::staticGet('id', $recipient->id);
603 $url = common_local_url('userbyid', array('id' => $user->id));
605 $url = $recipient->profileurl;
607 $xs = new XMLStringer(false);
608 $attrs = array('href' => $url,
610 if (!empty($recipient->fullname)) {
611 $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
613 $xs->elementStart('span', 'vcard');
614 $xs->elementStart('a', $attrs);
615 $xs->element('span', 'fn nickname', $nickname);
616 $xs->elementEnd('a');
617 $xs->elementEnd('span');
618 return $xs->getString();
624 function common_group_link($sender_id, $nickname)
626 $sender = Profile::staticGet($sender_id);
627 $group = User_group::getForNickname($nickname);
628 if ($group && $sender->isMember($group)) {
629 $attrs = array('href' => $group->permalink(),
631 if (!empty($group->fullname)) {
632 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
634 $xs = new XMLStringer();
635 $xs->elementStart('span', 'vcard');
636 $xs->elementStart('a', $attrs);
637 $xs->element('span', 'fn nickname', $nickname);
638 $xs->elementEnd('a');
639 $xs->elementEnd('span');
640 return $xs->getString();
646 function common_at_hash_link($sender_id, $tag)
648 $user = User::staticGet($sender_id);
652 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
654 $url = common_local_url('subscriptions',
655 array('nickname' => $user->nickname,
657 $xs = new XMLStringer();
658 $xs->elementStart('span', 'tag');
659 $xs->element('a', array('href' => $url,
662 $xs->elementEnd('span');
663 return $xs->getString();
669 function common_relative_profile($sender, $nickname, $dt=null)
671 // Try to find profiles this profile is subscribed to that have this nickname
672 $recipient = new Profile();
673 // XXX: use a join instead of a subquery
674 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
675 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
676 if ($recipient->find(true)) {
677 // XXX: should probably differentiate between profiles with
678 // the same name by date of most recent update
681 // Try to find profiles that listen to this profile and that have this nickname
682 $recipient = new Profile();
683 // XXX: use a join instead of a subquery
684 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
685 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
686 if ($recipient->find(true)) {
687 // XXX: should probably differentiate between profiles with
688 // the same name by date of most recent update
691 // If this is a local user, try to find a local user with that nickname.
692 $sender = User::staticGet($sender->id);
694 $recipient_user = User::staticGet('nickname', $nickname);
695 if ($recipient_user) {
696 return $recipient_user->getProfile();
699 // Otherwise, no links. @messages from local users to remote users,
700 // or from remote users to other remote users, are just
701 // outside our ability to make intelligent guesses about
705 function common_local_url($action, $args=null, $params=null, $fragment=null)
707 static $sensitive = array('login', 'register', 'passwordsettings',
708 'twittersettings', 'finishopenidlogin',
709 'finishaddopenid', 'api');
712 $path = $r->build($action, $args, $params, $fragment);
714 $ssl = in_array($action, $sensitive);
716 if (common_config('site','fancy')) {
717 $url = common_path(mb_substr($path, 1), $ssl);
719 if (mb_strpos($path, '/index.php') === 0) {
720 $url = common_path(mb_substr($path, 1), $ssl);
722 $url = common_path('index.php'.$path, $ssl);
728 function common_path($relative, $ssl=false)
730 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
732 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
733 || common_config('site', 'ssl') === 'always') {
735 if (is_string(common_config('site', 'sslserver')) &&
736 mb_strlen(common_config('site', 'sslserver')) > 0) {
737 $serverpart = common_config('site', 'sslserver');
739 $serverpart = common_config('site', 'server');
743 $serverpart = common_config('site', 'server');
746 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
749 function common_date_string($dt)
751 // XXX: do some sexy date formatting
752 // return date(DATE_RFC822, $dt);
757 if ($now < $t) { // that shouldn't happen!
758 return common_exact_date($dt);
759 } else if ($diff < 60) {
760 return _('a few seconds ago');
761 } else if ($diff < 92) {
762 return _('about a minute ago');
763 } else if ($diff < 3300) {
764 return sprintf(_('about %d minutes ago'), round($diff/60));
765 } else if ($diff < 5400) {
766 return _('about an hour ago');
767 } else if ($diff < 22 * 3600) {
768 return sprintf(_('about %d hours ago'), round($diff/3600));
769 } else if ($diff < 37 * 3600) {
770 return _('about a day ago');
771 } else if ($diff < 24 * 24 * 3600) {
772 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
773 } else if ($diff < 46 * 24 * 3600) {
774 return _('about a month ago');
775 } else if ($diff < 330 * 24 * 3600) {
776 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
777 } else if ($diff < 480 * 24 * 3600) {
778 return _('about a year ago');
780 return common_exact_date($dt);
784 function common_exact_date($dt)
790 $_utc = new DateTimeZone('UTC');
791 $_siteTz = new DateTimeZone(common_timezone());
794 $dateStr = date('d F Y H:i:s', strtotime($dt));
795 $d = new DateTime($dateStr, $_utc);
796 $d->setTimezone($_siteTz);
797 return $d->format(DATE_RFC850);
800 function common_date_w3dtf($dt)
802 $dateStr = date('d F Y H:i:s', strtotime($dt));
803 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
804 $d->setTimezone(new DateTimeZone(common_timezone()));
805 return $d->format(DATE_W3C);
808 function common_date_rfc2822($dt)
810 $dateStr = date('d F Y H:i:s', strtotime($dt));
811 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
812 $d->setTimezone(new DateTimeZone(common_timezone()));
813 return $d->format('r');
816 function common_date_iso8601($dt)
818 $dateStr = date('d F Y H:i:s', strtotime($dt));
819 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
820 $d->setTimezone(new DateTimeZone(common_timezone()));
821 return $d->format('c');
824 function common_sql_now()
826 return common_sql_date(time());
829 function common_sql_date($datetime)
831 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
834 function common_redirect($url, $code=307)
836 static $status = array(301 => "Moved Permanently",
839 307 => "Temporary Redirect");
841 header('HTTP/1.1 '.$code.' '.$status[$code]);
842 header("Location: $url");
844 $xo = new XMLOutputter();
846 '-//W3C//DTD XHTML 1.0 Strict//EN',
847 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
848 $xo->element('a', array('href' => $url), $url);
853 function common_broadcast_notice($notice, $remote=false)
855 return common_enqueue_notice($notice);
858 // Stick the notice on the queue
860 function common_enqueue_notice($notice)
862 static $localTransports = array('omb',
866 static $allTransports = array('sms');
868 $transports = $allTransports;
870 $xmpp = common_config('xmpp', 'enabled');
873 $transports[] = 'jabber';
876 if ($notice->is_local == Notice::LOCAL_PUBLIC ||
877 $notice->is_local == Notice::LOCAL_NONPUBLIC) {
878 $transports = array_merge($transports, $localTransports);
880 $transports[] = 'public';
884 $qm = QueueManager::get();
886 foreach ($transports as $transport)
888 $qm->enqueue($notice, $transport);
894 function common_broadcast_profile($profile)
896 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
897 require_once(INSTALLDIR.'/lib/omb.php');
898 omb_broadcast_profile($profile);
899 // XXX: Other broadcasts...?
903 function common_profile_url($nickname)
905 return common_local_url('showstream', array('nickname' => $nickname));
908 // Should make up a reasonable root URL
910 function common_root_url($ssl=false)
912 return common_path('', $ssl);
915 // returns $bytes bytes of random data as a hexadecimal string
916 // "good" here is a goal and not a guarantee
918 function common_good_rand($bytes)
920 // XXX: use random.org...?
921 if (@file_exists('/dev/urandom')) {
922 return common_urandom($bytes);
923 } else { // FIXME: this is probably not good enough
924 return common_mtrand($bytes);
928 function common_urandom($bytes)
930 $h = fopen('/dev/urandom', 'rb');
932 $src = fread($h, $bytes);
935 for ($i = 0; $i < $bytes; $i++) {
936 $enc .= sprintf("%02x", (ord($src[$i])));
941 function common_mtrand($bytes)
944 for ($i = 0; $i < $bytes; $i++) {
945 $enc .= sprintf("%02x", mt_rand(0, 255));
950 function common_set_returnto($url)
952 common_ensure_session();
953 $_SESSION['returnto'] = $url;
956 function common_get_returnto()
958 common_ensure_session();
959 return $_SESSION['returnto'];
962 function common_timestamp()
964 return date('YmdHis');
967 function common_ensure_syslog()
969 static $initialized = false;
971 openlog(common_config('syslog', 'appname'), 0,
972 common_config('syslog', 'facility'));
977 function common_log_line($priority, $msg)
979 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
980 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
981 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
984 function common_log($priority, $msg, $filename=null)
986 $logfile = common_config('site', 'logfile');
988 $log = fopen($logfile, "a");
990 $output = common_log_line($priority, $msg);
991 fwrite($log, $output);
995 common_ensure_syslog();
996 syslog($priority, $msg);
1000 function common_debug($msg, $filename=null)
1003 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1005 common_log(LOG_DEBUG, $msg);
1009 function common_log_db_error(&$object, $verb, $filename=null)
1011 $objstr = common_log_objstring($object);
1012 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1013 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1016 function common_log_objstring(&$object)
1018 if (is_null($object)) {
1021 if (!($object instanceof DB_DataObject)) {
1024 $arr = $object->toArray();
1026 foreach ($arr as $k => $v) {
1027 $fields[] = "$k='$v'";
1029 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1033 function common_valid_http_url($url)
1035 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1038 function common_valid_tag($tag)
1040 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1041 return (Validate::email($matches[1]) ||
1042 preg_match('/^([\w-\.]+)$/', $matches[1]));
1047 /* Following functions are copied from MediaWiki GlobalFunctions.php
1048 * and written by Evan Prodromou. */
1050 function common_accept_to_prefs($accept, $def = '*/*')
1052 // No arg means accept anything (per HTTP spec)
1054 return array($def => 1);
1059 $parts = explode(',', $accept);
1061 foreach($parts as $part) {
1062 // FIXME: doesn't deal with params like 'text/html; level=1'
1063 @list($value, $qpart) = explode(';', trim($part));
1065 if(!isset($qpart)) {
1067 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1068 $prefs[$value] = $match[1];
1075 function common_mime_type_match($type, $avail)
1077 if(array_key_exists($type, $avail)) {
1080 $parts = explode('/', $type);
1081 if(array_key_exists($parts[0] . '/*', $avail)) {
1082 return $parts[0] . '/*';
1083 } elseif(array_key_exists('*/*', $avail)) {
1091 function common_negotiate_type($cprefs, $sprefs)
1095 foreach(array_keys($sprefs) as $type) {
1096 $parts = explode('/', $type);
1097 if($parts[1] != '*') {
1098 $ckey = common_mime_type_match($type, $cprefs);
1100 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1105 foreach(array_keys($cprefs) as $type) {
1106 $parts = explode('/', $type);
1107 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1108 $skey = common_mime_type_match($type, $sprefs);
1110 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1116 $besttype = 'text/html';
1118 foreach(array_keys($combine) as $type) {
1119 if($combine[$type] > $bestq) {
1121 $bestq = $combine[$type];
1125 if ('text/html' === $besttype) {
1126 return "text/html; charset=utf-8";
1131 function common_config($main, $sub)
1134 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1137 function common_copy_args($from)
1140 $strip = get_magic_quotes_gpc();
1141 foreach ($from as $k => $v) {
1142 $to[$k] = ($strip) ? stripslashes($v) : $v;
1147 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1148 // This is used before handing a request off to OAuthRequest::from_request.
1149 function common_remove_magic_from_request()
1151 if(get_magic_quotes_gpc()) {
1152 $_POST=array_map('stripslashes',$_POST);
1153 $_GET=array_map('stripslashes',$_GET);
1157 function common_user_uri(&$user)
1159 return common_local_url('userbyid', array('id' => $user->id));
1162 function common_notice_uri(&$notice)
1164 return common_local_url('shownotice',
1165 array('notice' => $notice->id));
1168 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1170 function common_confirmation_code($bits)
1172 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1173 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1174 $chars = ceil($bits/5);
1176 for ($i = 0; $i < $chars; $i++) {
1177 // XXX: convert to string and back
1178 $num = hexdec(common_good_rand(1));
1179 // XXX: randomness is too precious to throw away almost
1180 // 40% of the bits we get!
1181 $code .= $codechars[$num%32];
1186 // convert markup to HTML
1188 function common_markup_to_html($c)
1190 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1191 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1192 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1193 return Markdown($c);
1196 function common_profile_uri($profile)
1201 $user = User::staticGet($profile->id);
1206 $remote = Remote_profile::staticGet($profile->id);
1208 return $remote->uri;
1210 // XXX: this is a very bad profile!
1214 function common_canonical_sms($sms)
1217 preg_replace('/\D/', '', $sms);
1221 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1226 case E_COMPILE_ERROR:
1230 case E_RECOVERABLE_ERROR:
1231 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1236 case E_COMPILE_WARNING:
1237 case E_CORE_WARNING:
1238 case E_USER_WARNING:
1239 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1244 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1249 case E_USER_DEPRECATED:
1250 // XXX: config variable to log this stuff, too
1254 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1259 // FIXME: show error page if we're on the Web
1260 /* Don't execute PHP internal error handler */
1264 function common_session_token()
1266 common_ensure_session();
1267 if (!array_key_exists('token', $_SESSION)) {
1268 $_SESSION['token'] = common_good_rand(64);
1270 return $_SESSION['token'];
1273 function common_cache_key($extra)
1275 $base_key = common_config('memcached', 'base');
1277 if (empty($base_key)) {
1278 $base_key = common_keyize(common_config('site', 'name'));
1281 return 'laconica:' . $base_key . ':' . $extra;
1284 function common_keyize($str)
1286 $str = strtolower($str);
1287 $str = preg_replace('/\s/', '_', $str);
1291 function common_memcache()
1293 static $cache = null;
1294 if (!common_config('memcached', 'enabled')) {
1298 $cache = new Memcache();
1299 $servers = common_config('memcached', 'server');
1300 if (is_array($servers)) {
1301 foreach($servers as $server) {
1302 $cache->addServer($server);
1305 $cache->addServer($servers);
1312 function common_compatible_license($from, $to)
1314 // XXX: better compatibility check needed here!
1315 return ($from == $to);
1319 * returns a quoted table name, if required according to config
1321 function common_database_tablename($tablename)
1324 if(common_config('db','quote_identifiers')) {
1325 $tablename = '"'. $tablename .'"';
1327 //table prefixes could be added here later
1331 function common_shorten_url($long_url)
1333 $user = common_current_user();
1335 // common current user does not find a user when called from the XMPP daemon
1336 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1339 $svc = $user->urlshorteningservice;
1342 $curlh = curl_init();
1343 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1344 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
1345 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1349 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1350 $short_url_service = new LilUrl;
1351 $short_url = $short_url_service->shorten($long_url);
1355 $short_url_service = new TightUrl;
1356 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1357 $short_url = $short_url_service->shorten($long_url);
1361 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1362 $short_url_service = new PtitUrl;
1363 $short_url = $short_url_service->shorten($long_url);
1367 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1368 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1372 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1373 $short_url = curl_exec($curlh);
1376 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1377 $short_url = curl_exec($curlh);
1379 case 'metamark.net':
1380 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1381 $short_url = curl_exec($curlh);
1384 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1385 $short_url = curl_exec($curlh);
1396 function common_client_ip()
1398 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1402 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1403 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1404 $proxy = $_SERVER['HTTP_CLIENT_IP'];
1406 $proxy = $_SERVER['REMOTE_ADDR'];
1408 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1411 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1412 $ip = $_SERVER['HTTP_CLIENT_IP'];
1414 $ip = $_SERVER['REMOTE_ADDR'];
1418 return array($proxy, $ip);