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
416 '(?:'. //Known protocols
418 '(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://'.
420 '(?:mailto|aim|tel|xmpp):'.
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})'.
449 //preg_match_all($regex,$text,$matches);
452 return preg_replace_callback($regex, curry(callback_helper,$callback,$notice_id) ,$text);
455 function callback_helper($matches, $callback, $notice_id) {
456 $spaces_left = (strlen($matches[0]) - strlen(ltrim($matches[0])));
457 $spaces_right = (strlen($matches[0]) - strlen(rtrim($matches[0])));
458 if(empty($notice_id)){
459 $result = call_user_func_array($callback,$matches[1]);
461 $result = call_user_func_array($callback, array($matches[1],$notice_id) );
463 return str_repeat(' ',$spaces_left) . $result . str_repeat(' ',$spaces_right);
466 function curry($fn) {
467 //TODO switch to a PHP 5.3 function closure based approach if PHP 5.3 is used
468 $args = func_get_args();
470 $id = uniqid('_partial');
471 $GLOBALS[$id] = array($fn, $args);
472 return create_function(
475 $args = func_get_args();
476 return call_user_func_array(
477 $GLOBALS["'.$id.'"][0],
480 $GLOBALS["'.$id.'"][1]));
484 function common_linkify($url) {
485 // It comes in special'd, so we unspecial it before passing to the stringifying
487 $url = htmlspecialchars_decode($url);
489 if(strpos($url, '@')!==false && strpos($url, ':')===false){
490 //url is an email address without the mailto: protocol
491 return XMLStringer::estring('a', array('href' => "mailto:$url", 'rel' => 'external'), $url);
494 $canon = File_redirection::_canonUrl($url);
496 $longurl_data = File_redirection::where($url);
497 if (is_array($longurl_data)) {
498 $longurl = $longurl_data['url'];
499 } elseif (is_string($longurl_data)) {
500 $longurl = $longurl_data;
502 throw new ServerException("Can't linkify url '$url'");
505 $attrs = array('href' => $canon, 'rel' => 'external');
507 $is_attachment = false;
508 $attachment_id = null;
511 // Check to see whether there's a filename associated with this URL.
512 // If there is, it's an upload and qualifies as an attachment
514 $localfile = File::staticGet('url', $longurl);
516 if (!empty($localfile)) {
517 if (isset($localfile->filename)) {
518 $is_attachment = true;
519 $attachment_id = $localfile->id;
523 // if this URL is an attachment, then we set class='attachment' and id='attahcment-ID'
524 // where ID is the id of the attachment for the given URL.
526 // we need a better test telling what can be shown as an attachment
527 // we're currently picking up oembeds only.
528 // I think the best option is another file_view table in the db
529 // and associated dbobject.
531 $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'";
533 $file->query($query);
536 if (!empty($file->file_id)) {
537 $is_attachment = true;
538 $attachment_id = $file->file_id;
540 $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'";
542 $file2->query($query);
545 if (!empty($file2)) {
551 if ($is_attachment) {
552 $attrs['class'] = 'attachment';
554 $attrs['class'] = 'attachment thumbnail';
556 $attrs['id'] = "attachment-{$attachment_id}";
559 return XMLStringer::estring('a', $attrs, $url);
562 function common_shorten_links($text)
564 if (mb_strlen($text) <= 140) return $text;
565 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
568 function common_xml_safe_str($str)
570 // Neutralize control codes and surrogates
571 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
574 function common_tag_link($tag)
576 $canonical = common_canonical_tag($tag);
577 $url = common_local_url('tag', array('tag' => $canonical));
578 $xs = new XMLStringer();
579 $xs->elementStart('span', 'tag');
580 $xs->element('a', array('href' => $url,
583 $xs->elementEnd('span');
584 return $xs->getString();
587 function common_canonical_tag($tag)
589 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
590 return str_replace(array('-', '_', '.'), '', $tag);
593 function common_valid_profile_tag($str)
595 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
598 function common_at_link($sender_id, $nickname)
600 $sender = Profile::staticGet($sender_id);
601 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
603 $user = User::staticGet('id', $recipient->id);
605 $url = common_local_url('userbyid', array('id' => $user->id));
607 $url = $recipient->profileurl;
609 $xs = new XMLStringer(false);
610 $attrs = array('href' => $url,
612 if (!empty($recipient->fullname)) {
613 $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
615 $xs->elementStart('span', 'vcard');
616 $xs->elementStart('a', $attrs);
617 $xs->element('span', 'fn nickname', $nickname);
618 $xs->elementEnd('a');
619 $xs->elementEnd('span');
620 return $xs->getString();
626 function common_group_link($sender_id, $nickname)
628 $sender = Profile::staticGet($sender_id);
629 $group = User_group::getForNickname($nickname);
630 if ($group && $sender->isMember($group)) {
631 $attrs = array('href' => $group->permalink(),
633 if (!empty($group->fullname)) {
634 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
636 $xs = new XMLStringer();
637 $xs->elementStart('span', 'vcard');
638 $xs->elementStart('a', $attrs);
639 $xs->element('span', 'fn nickname', $nickname);
640 $xs->elementEnd('a');
641 $xs->elementEnd('span');
642 return $xs->getString();
648 function common_at_hash_link($sender_id, $tag)
650 $user = User::staticGet($sender_id);
654 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
656 $url = common_local_url('subscriptions',
657 array('nickname' => $user->nickname,
659 $xs = new XMLStringer();
660 $xs->elementStart('span', 'tag');
661 $xs->element('a', array('href' => $url,
664 $xs->elementEnd('span');
665 return $xs->getString();
671 function common_relative_profile($sender, $nickname, $dt=null)
673 // Try to find profiles this profile is subscribed to that have this nickname
674 $recipient = new Profile();
675 // XXX: use a join instead of a subquery
676 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
677 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
678 if ($recipient->find(true)) {
679 // XXX: should probably differentiate between profiles with
680 // the same name by date of most recent update
683 // Try to find profiles that listen to this profile and that have this nickname
684 $recipient = new Profile();
685 // XXX: use a join instead of a subquery
686 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
687 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
688 if ($recipient->find(true)) {
689 // XXX: should probably differentiate between profiles with
690 // the same name by date of most recent update
693 // If this is a local user, try to find a local user with that nickname.
694 $sender = User::staticGet($sender->id);
696 $recipient_user = User::staticGet('nickname', $nickname);
697 if ($recipient_user) {
698 return $recipient_user->getProfile();
701 // Otherwise, no links. @messages from local users to remote users,
702 // or from remote users to other remote users, are just
703 // outside our ability to make intelligent guesses about
707 function common_local_url($action, $args=null, $params=null, $fragment=null)
709 static $sensitive = array('login', 'register', 'passwordsettings',
710 'twittersettings', 'finishopenidlogin',
711 'finishaddopenid', 'api');
714 $path = $r->build($action, $args, $params, $fragment);
716 $ssl = in_array($action, $sensitive);
718 if (common_config('site','fancy')) {
719 $url = common_path(mb_substr($path, 1), $ssl);
721 if (mb_strpos($path, '/index.php') === 0) {
722 $url = common_path(mb_substr($path, 1), $ssl);
724 $url = common_path('index.php'.$path, $ssl);
730 function common_path($relative, $ssl=false)
732 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
734 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
735 || common_config('site', 'ssl') === 'always') {
737 if (is_string(common_config('site', 'sslserver')) &&
738 mb_strlen(common_config('site', 'sslserver')) > 0) {
739 $serverpart = common_config('site', 'sslserver');
741 $serverpart = common_config('site', 'server');
745 $serverpart = common_config('site', 'server');
748 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
751 function common_date_string($dt)
753 // XXX: do some sexy date formatting
754 // return date(DATE_RFC822, $dt);
759 if ($now < $t) { // that shouldn't happen!
760 return common_exact_date($dt);
761 } else if ($diff < 60) {
762 return _('a few seconds ago');
763 } else if ($diff < 92) {
764 return _('about a minute ago');
765 } else if ($diff < 3300) {
766 return sprintf(_('about %d minutes ago'), round($diff/60));
767 } else if ($diff < 5400) {
768 return _('about an hour ago');
769 } else if ($diff < 22 * 3600) {
770 return sprintf(_('about %d hours ago'), round($diff/3600));
771 } else if ($diff < 37 * 3600) {
772 return _('about a day ago');
773 } else if ($diff < 24 * 24 * 3600) {
774 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
775 } else if ($diff < 46 * 24 * 3600) {
776 return _('about a month ago');
777 } else if ($diff < 330 * 24 * 3600) {
778 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
779 } else if ($diff < 480 * 24 * 3600) {
780 return _('about a year ago');
782 return common_exact_date($dt);
786 function common_exact_date($dt)
792 $_utc = new DateTimeZone('UTC');
793 $_siteTz = new DateTimeZone(common_timezone());
796 $dateStr = date('d F Y H:i:s', strtotime($dt));
797 $d = new DateTime($dateStr, $_utc);
798 $d->setTimezone($_siteTz);
799 return $d->format(DATE_RFC850);
802 function common_date_w3dtf($dt)
804 $dateStr = date('d F Y H:i:s', strtotime($dt));
805 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
806 $d->setTimezone(new DateTimeZone(common_timezone()));
807 return $d->format(DATE_W3C);
810 function common_date_rfc2822($dt)
812 $dateStr = date('d F Y H:i:s', strtotime($dt));
813 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
814 $d->setTimezone(new DateTimeZone(common_timezone()));
815 return $d->format('r');
818 function common_date_iso8601($dt)
820 $dateStr = date('d F Y H:i:s', strtotime($dt));
821 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
822 $d->setTimezone(new DateTimeZone(common_timezone()));
823 return $d->format('c');
826 function common_sql_now()
828 return common_sql_date(time());
831 function common_sql_date($datetime)
833 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
836 function common_redirect($url, $code=307)
838 static $status = array(301 => "Moved Permanently",
841 307 => "Temporary Redirect");
843 header('HTTP/1.1 '.$code.' '.$status[$code]);
844 header("Location: $url");
846 $xo = new XMLOutputter();
848 '-//W3C//DTD XHTML 1.0 Strict//EN',
849 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
850 $xo->element('a', array('href' => $url), $url);
855 function common_broadcast_notice($notice, $remote=false)
857 return common_enqueue_notice($notice);
860 // Stick the notice on the queue
862 function common_enqueue_notice($notice)
864 static $localTransports = array('omb',
868 static $allTransports = array('sms');
870 $transports = $allTransports;
872 $xmpp = common_config('xmpp', 'enabled');
875 $transports[] = 'jabber';
878 if ($notice->is_local == Notice::LOCAL_PUBLIC ||
879 $notice->is_local == Notice::LOCAL_NONPUBLIC) {
880 $transports = array_merge($transports, $localTransports);
882 $transports[] = 'public';
886 $qm = QueueManager::get();
888 foreach ($transports as $transport)
890 $qm->enqueue($notice, $transport);
896 function common_broadcast_profile($profile)
898 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
899 require_once(INSTALLDIR.'/lib/omb.php');
900 omb_broadcast_profile($profile);
901 // XXX: Other broadcasts...?
905 function common_profile_url($nickname)
907 return common_local_url('showstream', array('nickname' => $nickname));
910 // Should make up a reasonable root URL
912 function common_root_url($ssl=false)
914 return common_path('', $ssl);
917 // returns $bytes bytes of random data as a hexadecimal string
918 // "good" here is a goal and not a guarantee
920 function common_good_rand($bytes)
922 // XXX: use random.org...?
923 if (@file_exists('/dev/urandom')) {
924 return common_urandom($bytes);
925 } else { // FIXME: this is probably not good enough
926 return common_mtrand($bytes);
930 function common_urandom($bytes)
932 $h = fopen('/dev/urandom', 'rb');
934 $src = fread($h, $bytes);
937 for ($i = 0; $i < $bytes; $i++) {
938 $enc .= sprintf("%02x", (ord($src[$i])));
943 function common_mtrand($bytes)
946 for ($i = 0; $i < $bytes; $i++) {
947 $enc .= sprintf("%02x", mt_rand(0, 255));
952 function common_set_returnto($url)
954 common_ensure_session();
955 $_SESSION['returnto'] = $url;
958 function common_get_returnto()
960 common_ensure_session();
961 return $_SESSION['returnto'];
964 function common_timestamp()
966 return date('YmdHis');
969 function common_ensure_syslog()
971 static $initialized = false;
973 openlog(common_config('syslog', 'appname'), 0,
974 common_config('syslog', 'facility'));
979 function common_log_line($priority, $msg)
981 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
982 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
983 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
986 function common_log($priority, $msg, $filename=null)
988 $logfile = common_config('site', 'logfile');
990 $log = fopen($logfile, "a");
992 $output = common_log_line($priority, $msg);
993 fwrite($log, $output);
997 common_ensure_syslog();
998 syslog($priority, $msg);
1002 function common_debug($msg, $filename=null)
1005 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1007 common_log(LOG_DEBUG, $msg);
1011 function common_log_db_error(&$object, $verb, $filename=null)
1013 $objstr = common_log_objstring($object);
1014 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1015 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1018 function common_log_objstring(&$object)
1020 if (is_null($object)) {
1023 if (!($object instanceof DB_DataObject)) {
1026 $arr = $object->toArray();
1028 foreach ($arr as $k => $v) {
1029 $fields[] = "$k='$v'";
1031 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1035 function common_valid_http_url($url)
1037 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1040 function common_valid_tag($tag)
1042 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1043 return (Validate::email($matches[1]) ||
1044 preg_match('/^([\w-\.]+)$/', $matches[1]));
1049 /* Following functions are copied from MediaWiki GlobalFunctions.php
1050 * and written by Evan Prodromou. */
1052 function common_accept_to_prefs($accept, $def = '*/*')
1054 // No arg means accept anything (per HTTP spec)
1056 return array($def => 1);
1061 $parts = explode(',', $accept);
1063 foreach($parts as $part) {
1064 // FIXME: doesn't deal with params like 'text/html; level=1'
1065 @list($value, $qpart) = explode(';', trim($part));
1067 if(!isset($qpart)) {
1069 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1070 $prefs[$value] = $match[1];
1077 function common_mime_type_match($type, $avail)
1079 if(array_key_exists($type, $avail)) {
1082 $parts = explode('/', $type);
1083 if(array_key_exists($parts[0] . '/*', $avail)) {
1084 return $parts[0] . '/*';
1085 } elseif(array_key_exists('*/*', $avail)) {
1093 function common_negotiate_type($cprefs, $sprefs)
1097 foreach(array_keys($sprefs) as $type) {
1098 $parts = explode('/', $type);
1099 if($parts[1] != '*') {
1100 $ckey = common_mime_type_match($type, $cprefs);
1102 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1107 foreach(array_keys($cprefs) as $type) {
1108 $parts = explode('/', $type);
1109 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1110 $skey = common_mime_type_match($type, $sprefs);
1112 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1118 $besttype = 'text/html';
1120 foreach(array_keys($combine) as $type) {
1121 if($combine[$type] > $bestq) {
1123 $bestq = $combine[$type];
1127 if ('text/html' === $besttype) {
1128 return "text/html; charset=utf-8";
1133 function common_config($main, $sub)
1136 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1139 function common_copy_args($from)
1142 $strip = get_magic_quotes_gpc();
1143 foreach ($from as $k => $v) {
1144 $to[$k] = ($strip) ? stripslashes($v) : $v;
1149 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1150 // This is used before handing a request off to OAuthRequest::from_request.
1151 function common_remove_magic_from_request()
1153 if(get_magic_quotes_gpc()) {
1154 $_POST=array_map('stripslashes',$_POST);
1155 $_GET=array_map('stripslashes',$_GET);
1159 function common_user_uri(&$user)
1161 return common_local_url('userbyid', array('id' => $user->id));
1164 function common_notice_uri(&$notice)
1166 return common_local_url('shownotice',
1167 array('notice' => $notice->id));
1170 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1172 function common_confirmation_code($bits)
1174 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1175 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1176 $chars = ceil($bits/5);
1178 for ($i = 0; $i < $chars; $i++) {
1179 // XXX: convert to string and back
1180 $num = hexdec(common_good_rand(1));
1181 // XXX: randomness is too precious to throw away almost
1182 // 40% of the bits we get!
1183 $code .= $codechars[$num%32];
1188 // convert markup to HTML
1190 function common_markup_to_html($c)
1192 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1193 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1194 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1195 return Markdown($c);
1198 function common_profile_uri($profile)
1203 $user = User::staticGet($profile->id);
1208 $remote = Remote_profile::staticGet($profile->id);
1210 return $remote->uri;
1212 // XXX: this is a very bad profile!
1216 function common_canonical_sms($sms)
1219 preg_replace('/\D/', '', $sms);
1223 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1228 case E_COMPILE_ERROR:
1232 case E_RECOVERABLE_ERROR:
1233 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1238 case E_COMPILE_WARNING:
1239 case E_CORE_WARNING:
1240 case E_USER_WARNING:
1241 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1246 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1251 case E_USER_DEPRECATED:
1252 // XXX: config variable to log this stuff, too
1256 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1261 // FIXME: show error page if we're on the Web
1262 /* Don't execute PHP internal error handler */
1266 function common_session_token()
1268 common_ensure_session();
1269 if (!array_key_exists('token', $_SESSION)) {
1270 $_SESSION['token'] = common_good_rand(64);
1272 return $_SESSION['token'];
1275 function common_cache_key($extra)
1277 $base_key = common_config('memcached', 'base');
1279 if (empty($base_key)) {
1280 $base_key = common_keyize(common_config('site', 'name'));
1283 return 'laconica:' . $base_key . ':' . $extra;
1286 function common_keyize($str)
1288 $str = strtolower($str);
1289 $str = preg_replace('/\s/', '_', $str);
1293 function common_memcache()
1295 static $cache = null;
1296 if (!common_config('memcached', 'enabled')) {
1300 $cache = new Memcache();
1301 $servers = common_config('memcached', 'server');
1302 if (is_array($servers)) {
1303 foreach($servers as $server) {
1304 $cache->addServer($server);
1307 $cache->addServer($servers);
1314 function common_compatible_license($from, $to)
1316 // XXX: better compatibility check needed here!
1317 return ($from == $to);
1321 * returns a quoted table name, if required according to config
1323 function common_database_tablename($tablename)
1326 if(common_config('db','quote_identifiers')) {
1327 $tablename = '"'. $tablename .'"';
1329 //table prefixes could be added here later
1333 function common_shorten_url($long_url)
1335 $user = common_current_user();
1337 // common current user does not find a user when called from the XMPP daemon
1338 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1341 $svc = $user->urlshorteningservice;
1344 $curlh = curl_init();
1345 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1346 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
1347 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1351 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1352 $short_url_service = new LilUrl;
1353 $short_url = $short_url_service->shorten($long_url);
1357 $short_url_service = new TightUrl;
1358 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1359 $short_url = $short_url_service->shorten($long_url);
1363 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1364 $short_url_service = new PtitUrl;
1365 $short_url = $short_url_service->shorten($long_url);
1369 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1370 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1374 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1375 $short_url = curl_exec($curlh);
1378 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1379 $short_url = curl_exec($curlh);
1381 case 'metamark.net':
1382 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1383 $short_url = curl_exec($curlh);
1386 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1387 $short_url = curl_exec($curlh);
1398 function common_client_ip()
1400 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1404 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1405 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1406 $proxy = $_SERVER['HTTP_CLIENT_IP'];
1408 $proxy = $_SERVER['REMOTE_ADDR'];
1410 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1413 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1414 $ip = $_SERVER['HTTP_CLIENT_IP'];
1416 $ip = $_SERVER['REMOTE_ADDR'];
1420 return array($proxy, $ip);