3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, 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("statusnet", common_config('site','locale_path'));
58 bind_textdomain_codeset("statusnet", "UTF-8");
59 textdomain("statusnet");
60 setlocale(LC_CTYPE, 'C');
62 common_log(LOG_INFO, 'Language requested:' . $language . ' - locale could not be set. Perhaps that system locale is not installed.', __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\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
418 '(?:'. //Known protocols
420 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
422 '(?:(?:mailto|aim|tel|xmpp):)'.
424 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
427 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
429 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
433 '|(?:(?: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
435 '\[?(?:(?:(?:[0-9A-Fa-f]{1,4}:){7}(?:(?:[0-9A-Fa-f]{1,4})|:))|(?:(?:[0-9A-Fa-f]{1,4}:){6}(?::|(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})|(?::[0-9A-Fa-f]{1,4})))|(?:(?:[0-9A-Fa-f]{1,4}:){5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){4}(?::[0-9A-Fa-f]{1,4}){0,1}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){3}(?::[0-9A-Fa-f]{1,4}){0,2}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){2}(?::[0-9A-Fa-f]{1,4}){0,3}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:)(?::[0-9A-Fa-f]{1,4}){0,4}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?::(?::[0-9A-Fa-f]{1,4}){0,5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})))\]?(?<!:)'.
437 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
438 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
439 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
440 '(?:AC|AD|AE|AERO|AF|AG|AI|AL|AM|AN|AO|AQ|AR|ARPA|AS|ASIA|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BIZ|BJ|BM|BN|BO|BR|BS|BT|BV|BW|BY|BZ|CA|CAT|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|COM|COOP|CR|CU|CV|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EDU|EE|EG|ER|ES|ET|EU|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GOV|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|INFO|INT|IO|IQ|IR|IS|IT|JE|JM|JO|JOBS|JP|KE|KG|KH|KI|KM|KN|KP|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|LY|MA|MC|MD|ME|MG|MH|MIL|MK|ML|MM|MN|MO|MOBI|MP|MQ|MR|MS|MT|MU|MUSEUM|MV|MW|MX|MY|MZ|NA|NAME|NC|NE|NET|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|ORG|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PRO|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|ST|SU|SV|SY|SZ|TC|TD|TEL|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|TR|TRAVEL|TT|TV|TW|TZ|UA|UG|UK|US|UY|UZ|VA|VC|VE|VG|VI|VN|VU|WF|WS|XN--0ZWM56D|测试|XN--11B5BS3A9AJ6G|परीक्षा|XN--80AKHBYKNJ4F|испытание|XN--9T4B11YI5A|테스트|XN--DEBA0AD|טעסט|XN--G6W251D|測試|XN--HGBK6AJ7F53BBA|آزمایشی|XN--HLCJ6AYA9ESC7A|பரிட்சை|XN--JXALPDLP|δοκιμή|XN--KGBECHTV|إختبار|XN--ZCKZAH|テスト|YE|YT|YU|ZA|ZM|ZW|local|loc|onion)'.
444 '(?:\:\d+)?'. //:port
445 '(?:/[\pN\pL$\[\]\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\"@]*)?'. // /path
446 '(?:\?[\pN\pL\$\[\]\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\"@\/]*)?'. // ?query string
447 '(?:\#[\pN\pL$\[\]\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\"\@/\?\#]*)?'. // #fragment
448 ')(?<![\?\.\,\#\,])'.
451 //preg_match_all($regex,$text,$matches);
453 return preg_replace_callback($regex, curry('callback_helper',$callback,$notice_id) ,$text);
456 function callback_helper($matches, $callback, $notice_id) {
458 $left = strpos($matches[0],$url);
459 $right = $left+strlen($url);
461 $groupSymbolSets=array(
475 $cannotEndWith=array('.','?',',','#');
479 foreach($groupSymbolSets as $groupSymbolSet){
480 if(substr($url,-1)==$groupSymbolSet['right']){
481 $group_left_count = substr_count($url,$groupSymbolSet['left']);
482 $group_right_count = substr_count($url,$groupSymbolSet['right']);
483 if($group_left_count<$group_right_count){
485 $url=substr($url,0,-1);
489 if(in_array(substr($url,-1),$cannotEndWith)){
491 $url=substr($url,0,-1);
493 }while($original_url!=$url);
495 if(empty($notice_id)){
496 $result = call_user_func_array($callback,$url);
498 $result = call_user_func_array($callback, array(array($url,$notice_id)) );
500 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
503 function curry($fn) {
504 //TODO switch to a PHP 5.3 function closure based approach if PHP 5.3 is used
505 $args = func_get_args();
507 $id = uniqid('_partial');
508 $GLOBALS[$id] = array($fn, $args);
509 return create_function('',
510 '$args = func_get_args(); '.
511 'return call_user_func_array('.
512 '$GLOBALS["'.$id.'"][0],'.
515 '$GLOBALS["'.$id.'"][1]));');
518 function common_linkify($url) {
519 // It comes in special'd, so we unspecial it before passing to the stringifying
521 $url = htmlspecialchars_decode($url);
523 if(strpos($url, '@') !== false && strpos($url, ':') === false) {
524 //url is an email address without the mailto: protocol
525 return XMLStringer::estring('a', array('href' => "mailto:$url", 'rel' => 'external'), $url);
528 $canon = File_redirection::_canonUrl($url);
530 $longurl_data = File_redirection::where($url);
531 if (is_array($longurl_data)) {
532 $longurl = $longurl_data['url'];
533 } elseif (is_string($longurl_data)) {
534 $longurl = $longurl_data;
536 throw new ServerException("Can't linkify url '$url'");
539 $attrs = array('href' => $canon, 'rel' => 'external');
541 $is_attachment = false;
542 $attachment_id = null;
545 // Check to see whether this is a known "attachment" URL.
547 $f = File::staticGet('url', $longurl);
550 // XXX: this writes to the database. :<
551 $f = File::processNew($longurl);
555 if ($f->isEnclosure()) {
556 $is_attachment = true;
557 $attachment_id = $f->id;
559 $foe = File_oembed::staticGet('file_id', $f->id);
561 // if it has OEmbed info, it's an attachment, too
562 $is_attachment = true;
563 $attachment_id = $f->id;
565 $thumb = File_thumbnail::staticGet('file_id', $f->id);
566 if (!empty($thumb)) {
574 if ($is_attachment) {
575 $attrs['class'] = 'attachment';
577 $attrs['class'] = 'attachment thumbnail';
579 $attrs['id'] = "attachment-{$attachment_id}";
582 return XMLStringer::estring('a', $attrs, $url);
585 function common_shorten_links($text)
587 if (mb_strlen($text) <= 140) return $text;
588 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
591 function common_xml_safe_str($str)
593 // Neutralize control codes and surrogates
594 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
597 function common_tag_link($tag)
599 $canonical = common_canonical_tag($tag);
600 $url = common_local_url('tag', array('tag' => $canonical));
601 $xs = new XMLStringer();
602 $xs->elementStart('span', 'tag');
603 $xs->element('a', array('href' => $url,
606 $xs->elementEnd('span');
607 return $xs->getString();
610 function common_canonical_tag($tag)
612 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
613 return str_replace(array('-', '_', '.'), '', $tag);
616 function common_valid_profile_tag($str)
618 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
621 function common_at_link($sender_id, $nickname)
623 $sender = Profile::staticGet($sender_id);
624 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
626 $user = User::staticGet('id', $recipient->id);
628 $url = common_local_url('userbyid', array('id' => $user->id));
630 $url = $recipient->profileurl;
632 $xs = new XMLStringer(false);
633 $attrs = array('href' => $url,
635 if (!empty($recipient->fullname)) {
636 $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
638 $xs->elementStart('span', 'vcard');
639 $xs->elementStart('a', $attrs);
640 $xs->element('span', 'fn nickname', $nickname);
641 $xs->elementEnd('a');
642 $xs->elementEnd('span');
643 return $xs->getString();
649 function common_group_link($sender_id, $nickname)
651 $sender = Profile::staticGet($sender_id);
652 $group = User_group::getForNickname($nickname);
653 if ($group && $sender->isMember($group)) {
654 $attrs = array('href' => $group->permalink(),
656 if (!empty($group->fullname)) {
657 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
659 $xs = new XMLStringer();
660 $xs->elementStart('span', 'vcard');
661 $xs->elementStart('a', $attrs);
662 $xs->element('span', 'fn nickname', $nickname);
663 $xs->elementEnd('a');
664 $xs->elementEnd('span');
665 return $xs->getString();
671 function common_at_hash_link($sender_id, $tag)
673 $user = User::staticGet($sender_id);
677 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
679 $url = common_local_url('subscriptions',
680 array('nickname' => $user->nickname,
682 $xs = new XMLStringer();
683 $xs->elementStart('span', 'tag');
684 $xs->element('a', array('href' => $url,
687 $xs->elementEnd('span');
688 return $xs->getString();
694 function common_relative_profile($sender, $nickname, $dt=null)
696 // Try to find profiles this profile is subscribed to that have this nickname
697 $recipient = new Profile();
698 // XXX: use a join instead of a subquery
699 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
700 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
701 if ($recipient->find(true)) {
702 // XXX: should probably differentiate between profiles with
703 // the same name by date of most recent update
706 // Try to find profiles that listen to this profile and that have this nickname
707 $recipient = new Profile();
708 // XXX: use a join instead of a subquery
709 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
710 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
711 if ($recipient->find(true)) {
712 // XXX: should probably differentiate between profiles with
713 // the same name by date of most recent update
716 // If this is a local user, try to find a local user with that nickname.
717 $sender = User::staticGet($sender->id);
719 $recipient_user = User::staticGet('nickname', $nickname);
720 if ($recipient_user) {
721 return $recipient_user->getProfile();
724 // Otherwise, no links. @messages from local users to remote users,
725 // or from remote users to other remote users, are just
726 // outside our ability to make intelligent guesses about
730 function common_local_url($action, $args=null, $params=null, $fragment=null)
732 static $sensitive = array('login', 'register', 'passwordsettings',
733 'twittersettings', 'finishopenidlogin',
734 'finishaddopenid', 'api');
737 $path = $r->build($action, $args, $params, $fragment);
739 $ssl = in_array($action, $sensitive);
741 if (common_config('site','fancy')) {
742 $url = common_path(mb_substr($path, 1), $ssl);
744 if (mb_strpos($path, '/index.php') === 0) {
745 $url = common_path(mb_substr($path, 1), $ssl);
747 $url = common_path('index.php'.$path, $ssl);
753 function common_path($relative, $ssl=false)
755 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
757 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
758 || common_config('site', 'ssl') === 'always') {
760 if (is_string(common_config('site', 'sslserver')) &&
761 mb_strlen(common_config('site', 'sslserver')) > 0) {
762 $serverpart = common_config('site', 'sslserver');
764 $serverpart = common_config('site', 'server');
768 $serverpart = common_config('site', 'server');
771 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
774 function common_date_string($dt)
776 // XXX: do some sexy date formatting
777 // return date(DATE_RFC822, $dt);
782 if ($now < $t) { // that shouldn't happen!
783 return common_exact_date($dt);
784 } else if ($diff < 60) {
785 return _('a few seconds ago');
786 } else if ($diff < 92) {
787 return _('about a minute ago');
788 } else if ($diff < 3300) {
789 return sprintf(_('about %d minutes ago'), round($diff/60));
790 } else if ($diff < 5400) {
791 return _('about an hour ago');
792 } else if ($diff < 22 * 3600) {
793 return sprintf(_('about %d hours ago'), round($diff/3600));
794 } else if ($diff < 37 * 3600) {
795 return _('about a day ago');
796 } else if ($diff < 24 * 24 * 3600) {
797 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
798 } else if ($diff < 46 * 24 * 3600) {
799 return _('about a month ago');
800 } else if ($diff < 330 * 24 * 3600) {
801 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
802 } else if ($diff < 480 * 24 * 3600) {
803 return _('about a year ago');
805 return common_exact_date($dt);
809 function common_exact_date($dt)
815 $_utc = new DateTimeZone('UTC');
816 $_siteTz = new DateTimeZone(common_timezone());
819 $dateStr = date('d F Y H:i:s', strtotime($dt));
820 $d = new DateTime($dateStr, $_utc);
821 $d->setTimezone($_siteTz);
822 return $d->format(DATE_RFC850);
825 function common_date_w3dtf($dt)
827 $dateStr = date('d F Y H:i:s', strtotime($dt));
828 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
829 $d->setTimezone(new DateTimeZone(common_timezone()));
830 return $d->format(DATE_W3C);
833 function common_date_rfc2822($dt)
835 $dateStr = date('d F Y H:i:s', strtotime($dt));
836 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
837 $d->setTimezone(new DateTimeZone(common_timezone()));
838 return $d->format('r');
841 function common_date_iso8601($dt)
843 $dateStr = date('d F Y H:i:s', strtotime($dt));
844 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
845 $d->setTimezone(new DateTimeZone(common_timezone()));
846 return $d->format('c');
849 function common_sql_now()
851 return common_sql_date(time());
854 function common_sql_date($datetime)
856 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
859 function common_redirect($url, $code=307)
861 static $status = array(301 => "Moved Permanently",
864 307 => "Temporary Redirect");
866 header('HTTP/1.1 '.$code.' '.$status[$code]);
867 header("Location: $url");
869 $xo = new XMLOutputter();
871 '-//W3C//DTD XHTML 1.0 Strict//EN',
872 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
873 $xo->element('a', array('href' => $url), $url);
878 function common_broadcast_notice($notice, $remote=false)
880 return common_enqueue_notice($notice);
883 // Stick the notice on the queue
885 function common_enqueue_notice($notice)
887 static $localTransports = array('omb',
891 static $allTransports = array('sms');
893 $transports = $allTransports;
895 $xmpp = common_config('xmpp', 'enabled');
898 $transports[] = 'jabber';
901 if ($notice->is_local == Notice::LOCAL_PUBLIC ||
902 $notice->is_local == Notice::LOCAL_NONPUBLIC) {
903 $transports = array_merge($transports, $localTransports);
905 $transports[] = 'public';
909 $qm = QueueManager::get();
911 foreach ($transports as $transport)
913 $qm->enqueue($notice, $transport);
919 function common_broadcast_profile($profile)
921 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
922 require_once(INSTALLDIR.'/lib/omb.php');
923 omb_broadcast_profile($profile);
924 // XXX: Other broadcasts...?
928 function common_profile_url($nickname)
930 return common_local_url('showstream', array('nickname' => $nickname));
933 // Should make up a reasonable root URL
935 function common_root_url($ssl=false)
937 return common_path('', $ssl);
940 // returns $bytes bytes of random data as a hexadecimal string
941 // "good" here is a goal and not a guarantee
943 function common_good_rand($bytes)
945 // XXX: use random.org...?
946 if (@file_exists('/dev/urandom')) {
947 return common_urandom($bytes);
948 } else { // FIXME: this is probably not good enough
949 return common_mtrand($bytes);
953 function common_urandom($bytes)
955 $h = fopen('/dev/urandom', 'rb');
957 $src = fread($h, $bytes);
960 for ($i = 0; $i < $bytes; $i++) {
961 $enc .= sprintf("%02x", (ord($src[$i])));
966 function common_mtrand($bytes)
969 for ($i = 0; $i < $bytes; $i++) {
970 $enc .= sprintf("%02x", mt_rand(0, 255));
975 function common_set_returnto($url)
977 common_ensure_session();
978 $_SESSION['returnto'] = $url;
981 function common_get_returnto()
983 common_ensure_session();
984 return $_SESSION['returnto'];
987 function common_timestamp()
989 return date('YmdHis');
992 function common_ensure_syslog()
994 static $initialized = false;
996 openlog(common_config('syslog', 'appname'), 0,
997 common_config('syslog', 'facility'));
1002 function common_log_line($priority, $msg)
1004 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1005 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1006 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1009 function common_log($priority, $msg, $filename=null)
1011 $logfile = common_config('site', 'logfile');
1013 $log = fopen($logfile, "a");
1015 $output = common_log_line($priority, $msg);
1016 fwrite($log, $output);
1020 common_ensure_syslog();
1021 syslog($priority, $msg);
1025 function common_debug($msg, $filename=null)
1028 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1030 common_log(LOG_DEBUG, $msg);
1034 function common_log_db_error(&$object, $verb, $filename=null)
1036 $objstr = common_log_objstring($object);
1037 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1038 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1041 function common_log_objstring(&$object)
1043 if (is_null($object)) {
1046 if (!($object instanceof DB_DataObject)) {
1049 $arr = $object->toArray();
1051 foreach ($arr as $k => $v) {
1052 $fields[] = "$k='$v'";
1054 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1058 function common_valid_http_url($url)
1060 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1063 function common_valid_tag($tag)
1065 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1066 return (Validate::email($matches[1]) ||
1067 preg_match('/^([\w-\.]+)$/', $matches[1]));
1072 /* Following functions are copied from MediaWiki GlobalFunctions.php
1073 * and written by Evan Prodromou. */
1075 function common_accept_to_prefs($accept, $def = '*/*')
1077 // No arg means accept anything (per HTTP spec)
1079 return array($def => 1);
1084 $parts = explode(',', $accept);
1086 foreach($parts as $part) {
1087 // FIXME: doesn't deal with params like 'text/html; level=1'
1088 @list($value, $qpart) = explode(';', trim($part));
1090 if(!isset($qpart)) {
1092 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1093 $prefs[$value] = $match[1];
1100 function common_mime_type_match($type, $avail)
1102 if(array_key_exists($type, $avail)) {
1105 $parts = explode('/', $type);
1106 if(array_key_exists($parts[0] . '/*', $avail)) {
1107 return $parts[0] . '/*';
1108 } elseif(array_key_exists('*/*', $avail)) {
1116 function common_negotiate_type($cprefs, $sprefs)
1120 foreach(array_keys($sprefs) as $type) {
1121 $parts = explode('/', $type);
1122 if($parts[1] != '*') {
1123 $ckey = common_mime_type_match($type, $cprefs);
1125 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1130 foreach(array_keys($cprefs) as $type) {
1131 $parts = explode('/', $type);
1132 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1133 $skey = common_mime_type_match($type, $sprefs);
1135 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1141 $besttype = 'text/html';
1143 foreach(array_keys($combine) as $type) {
1144 if($combine[$type] > $bestq) {
1146 $bestq = $combine[$type];
1150 if ('text/html' === $besttype) {
1151 return "text/html; charset=utf-8";
1156 function common_config($main, $sub)
1159 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1162 function common_copy_args($from)
1165 $strip = get_magic_quotes_gpc();
1166 foreach ($from as $k => $v) {
1167 $to[$k] = ($strip) ? stripslashes($v) : $v;
1172 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1173 // This is used before handing a request off to OAuthRequest::from_request.
1174 function common_remove_magic_from_request()
1176 if(get_magic_quotes_gpc()) {
1177 $_POST=array_map('stripslashes',$_POST);
1178 $_GET=array_map('stripslashes',$_GET);
1182 function common_user_uri(&$user)
1184 return common_local_url('userbyid', array('id' => $user->id));
1187 function common_notice_uri(&$notice)
1189 return common_local_url('shownotice',
1190 array('notice' => $notice->id));
1193 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1195 function common_confirmation_code($bits)
1197 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1198 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1199 $chars = ceil($bits/5);
1201 for ($i = 0; $i < $chars; $i++) {
1202 // XXX: convert to string and back
1203 $num = hexdec(common_good_rand(1));
1204 // XXX: randomness is too precious to throw away almost
1205 // 40% of the bits we get!
1206 $code .= $codechars[$num%32];
1211 // convert markup to HTML
1213 function common_markup_to_html($c)
1215 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1216 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1217 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1218 return Markdown($c);
1221 function common_profile_uri($profile)
1226 $user = User::staticGet($profile->id);
1231 $remote = Remote_profile::staticGet($profile->id);
1233 return $remote->uri;
1235 // XXX: this is a very bad profile!
1239 function common_canonical_sms($sms)
1242 preg_replace('/\D/', '', $sms);
1246 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1251 case E_COMPILE_ERROR:
1255 case E_RECOVERABLE_ERROR:
1256 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1261 case E_COMPILE_WARNING:
1262 case E_CORE_WARNING:
1263 case E_USER_WARNING:
1264 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1269 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1274 case E_USER_DEPRECATED:
1275 // XXX: config variable to log this stuff, too
1279 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1284 // FIXME: show error page if we're on the Web
1285 /* Don't execute PHP internal error handler */
1289 function common_session_token()
1291 common_ensure_session();
1292 if (!array_key_exists('token', $_SESSION)) {
1293 $_SESSION['token'] = common_good_rand(64);
1295 return $_SESSION['token'];
1298 function common_cache_key($extra)
1300 $base_key = common_config('memcached', 'base');
1302 if (empty($base_key)) {
1303 $base_key = common_keyize(common_config('site', 'name'));
1306 return 'statusnet:' . $base_key . ':' . $extra;
1309 function common_keyize($str)
1311 $str = strtolower($str);
1312 $str = preg_replace('/\s/', '_', $str);
1316 function common_memcache()
1318 static $cache = null;
1319 if (!common_config('memcached', 'enabled')) {
1323 $cache = new Memcache();
1324 $servers = common_config('memcached', 'server');
1325 if (is_array($servers)) {
1326 foreach($servers as $server) {
1327 $cache->addServer($server);
1330 $cache->addServer($servers);
1337 function common_compatible_license($from, $to)
1339 // XXX: better compatibility check needed here!
1340 return ($from == $to);
1344 * returns a quoted table name, if required according to config
1346 function common_database_tablename($tablename)
1349 if(common_config('db','quote_identifiers')) {
1350 $tablename = '"'. $tablename .'"';
1352 //table prefixes could be added here later
1356 function common_shorten_url($long_url)
1358 $user = common_current_user();
1360 // common current user does not find a user when called from the XMPP daemon
1361 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1364 $svc = $user->urlshorteningservice;
1367 $curlh = curl_init();
1368 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1369 curl_setopt($curlh, CURLOPT_USERAGENT, 'StatusNet');
1370 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1374 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1375 $short_url_service = new LilUrl;
1376 $short_url = $short_url_service->shorten($long_url);
1380 $short_url_service = new TightUrl;
1381 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1382 $short_url = $short_url_service->shorten($long_url);
1386 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1387 $short_url_service = new PtitUrl;
1388 $short_url = $short_url_service->shorten($long_url);
1392 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1393 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1397 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1398 $short_url = curl_exec($curlh);
1401 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1402 $short_url = curl_exec($curlh);
1404 case 'metamark.net':
1405 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1406 $short_url = curl_exec($curlh);
1409 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1410 $short_url = curl_exec($curlh);
1421 function common_client_ip()
1423 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1427 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1428 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1429 $proxy = $_SERVER['HTTP_CLIENT_IP'];
1431 $proxy = $_SERVER['REMOTE_ADDR'];
1433 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1436 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1437 $ip = $_SERVER['HTTP_CLIENT_IP'];
1439 $ip = $_SERVER['REMOTE_ADDR'];
1443 return array($proxy, $ip);