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');
55 // gettext seems very picky... We first need to setlocale()
56 // to a locale which _does_ exist on the system, and _then_
57 // we can set in another locale that may not be set up
58 // (say, ga_ES for Galego/Galician) it seems to take it.
59 common_init_locale("en_US");
61 // Note that this setlocale() call may "fail" but this is harmless;
62 // gettext will still select the right language.
63 $language = common_language();
64 $locale_set = common_init_locale($language);
66 setlocale(LC_CTYPE, 'C');
67 // So we do not have to make people install the gettext locales
68 $path = common_config('site','locale_path');
69 bindtextdomain("statusnet", $path);
70 bind_textdomain_codeset("statusnet", "UTF-8");
71 textdomain("statusnet");
74 function common_timezone()
76 if (common_logged_in()) {
77 $user = common_current_user();
78 if ($user->timezone) {
79 return $user->timezone;
83 return common_config('site', 'timezone');
86 function common_language()
89 // If there is a user logged in and they've set a language preference
90 // then return that one...
91 if (_have_config() && common_logged_in()) {
92 $user = common_current_user();
93 $user_language = $user->language;
95 if ($user->language) {
96 // Validate -- we don't want to end up with a bogus code
97 // left over from some old junk.
98 foreach (common_config('site', 'languages') as $code => $info) {
99 if ($info['lang'] == $user_language) {
100 return $user_language;
106 // Otherwise, find the best match for the languages requested by the
108 $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
109 if (!empty($httplang)) {
110 $language = client_prefered_language($httplang);
115 // Finally, if none of the above worked, use the site's default...
116 return common_config('site', 'language');
118 // salted, hashed passwords are stored in the DB
120 function common_munge_password($password, $id)
122 return md5($password . $id);
125 // check if a username exists and has matching password
127 function common_check_user($nickname, $password)
129 $authenticatedUser = false;
131 if (Event::handle('StartCheckPassword', array($nickname, $password, &$authenticatedUser))) {
132 $user = User::staticGet('nickname', $nickname);
134 if (!empty($password)) { // never allow login with blank password
135 if (0 == strcmp(common_munge_password($password, $user->id),
137 //internal checking passed
138 $authenticatedUser = $user;
142 Event::handle('EndCheckPassword', array($nickname, $password, $authenticatedUser));
145 return $authenticatedUser;
148 // is the current user logged in?
149 function common_logged_in()
151 return (!is_null(common_current_user()));
154 function common_have_session()
156 return (0 != strcmp(session_id(), ''));
159 function common_ensure_session()
162 if (array_key_exists(session_name(), $_COOKIE)) {
163 $c = $_COOKIE[session_name()];
165 if (!common_have_session()) {
166 if (common_config('sessions', 'handle')) {
167 Session::setSaveHandler();
169 if (array_key_exists(session_name(), $_GET)) {
170 $id = $_GET[session_name()];
171 common_log(LOG_INFO, 'Setting session from GET parameter: '.$id);
172 } else if (array_key_exists(session_name(), $_COOKIE)) {
173 $id = $_COOKIE[session_name()];
174 common_log(LOG_INFO, 'Setting session from COOKIE: '.$id);
178 setcookie(session_name(), $id);
181 if (!isset($_SESSION['started'])) {
182 $_SESSION['started'] = time();
184 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
185 ' is set but started value is null');
189 common_debug("Session ID = " . session_id());
192 // Three kinds of arguments:
197 // Initialize to false; set to null if none found
201 function common_set_user($user)
206 if (is_null($user) && common_have_session()) {
208 unset($_SESSION['userid']);
210 } else if (is_string($user)) {
212 $user = User::staticGet('nickname', $nickname);
213 } else if (!($user instanceof User)) {
218 if (Event::handle('StartSetUser', array(&$user))) {
220 common_ensure_session();
221 $_SESSION['userid'] = $user->id;
223 Event::handle('EndSetUser', array($user));
231 function common_set_cookie($key, $value, $expiration=0)
233 $path = common_config('site', 'path');
234 $server = common_config('site', 'server');
236 if ($path && ($path != '/')) {
237 $cookiepath = '/' . $path . '/';
241 return setcookie($key,
248 define('REMEMBERME', 'rememberme');
249 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
251 function common_rememberme($user=null)
254 $user = common_current_user();
256 common_debug('No current user to remember', __FILE__);
261 $rm = new Remember_me();
263 $rm->code = common_good_rand(16);
264 $rm->user_id = $user->id;
266 // Wrap the insert in some good ol' fashioned transaction code
270 $result = $rm->insert();
273 common_log_db_error($rm, 'INSERT', __FILE__);
274 common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
278 $rm->query('COMMIT');
280 common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
282 $cookieval = $rm->user_id . ':' . $rm->code;
284 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
286 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
291 function common_remembered_user()
296 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
302 list($id, $code) = explode(':', $packed);
304 if (!$id || !$code) {
305 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
310 $rm = Remember_me::staticGet($code);
313 common_log(LOG_WARNING, 'No such remember code: ' . $code);
318 if ($rm->user_id != $id) {
319 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
324 $user = User::staticGet($rm->user_id);
327 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
333 $result = $rm->delete();
336 common_log_db_error($rm, 'DELETE', __FILE__);
337 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
342 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
344 common_set_user($user);
345 common_real_login(false);
347 // We issue a new cookie, so they can log in
348 // automatically again after this session
350 common_rememberme($user);
355 // must be called with a valid user!
357 function common_forgetme()
359 common_set_cookie(REMEMBERME, '', 0);
362 // who is the current user?
363 function common_current_user()
367 if (!_have_config()) {
371 if ($_cur === false) {
373 if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
374 common_ensure_session();
375 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
377 $user = User::staticGet($id);
385 // that didn't work; try to remember; will init $_cur to null on failure
386 $_cur = common_remembered_user();
389 common_debug("Got User " . $_cur->nickname);
390 common_debug("Faking session on remembered user");
391 // XXX: Is this necessary?
392 $_SESSION['userid'] = $_cur->id;
399 // Logins that are 'remembered' aren't 'real' -- they're subject to
400 // cookie-stealing. So, we don't let them do certain things. New reg,
401 // OpenID, and password logins _are_ real.
403 function common_real_login($real=true)
405 common_ensure_session();
406 $_SESSION['real_login'] = $real;
409 function common_is_real_login()
411 return common_logged_in() && $_SESSION['real_login'];
414 // get canonical version of nickname for comparison
415 function common_canonical_nickname($nickname)
417 // XXX: UTF-8 canonicalization (like combining chars)
418 return strtolower($nickname);
421 // get canonical version of email for comparison
422 function common_canonical_email($email)
424 // XXX: canonicalize UTF-8
425 // XXX: lcase the domain part
429 function common_render_content($text, $notice)
431 $r = common_render_text($text);
432 $id = $notice->profile_id;
433 $r = preg_replace('/(^|\s+)@(['.NICKNAME_FMT.']{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
434 $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
435 $r = preg_replace('/(^|[\s\.\,\:\;]+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
436 $r = preg_replace('/(^|[\s\.\,\:\;]+)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
440 function common_render_text($text)
442 $r = htmlspecialchars($text);
444 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
445 $r = common_replace_urls_callback($r, 'common_linkify');
446 $r = preg_replace('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
451 function common_replace_urls_callback($text, $callback, $notice_id = null) {
452 // Start off with a regex
454 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
457 '(?:'. //Known protocols
459 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
461 '(?:(?:mailto|aim|tel|xmpp):)'.
463 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
466 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
468 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
472 '|(?:(?: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
474 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
476 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
477 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
478 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
479 '(?: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)'.
483 '(?:\:\d+)?'. //:port
484 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
485 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
486 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
487 ')(?<![\?\.\,\#\,])'.
490 //preg_match_all($regex,$text,$matches);
492 return preg_replace_callback($regex, curry('callback_helper',$callback,$notice_id) ,$text);
495 function callback_helper($matches, $callback, $notice_id) {
497 $left = strpos($matches[0],$url);
498 $right = $left+strlen($url);
500 $groupSymbolSets=array(
518 $cannotEndWith=array('.','?',',','#');
522 foreach($groupSymbolSets as $groupSymbolSet){
523 if(substr($url,-1)==$groupSymbolSet['right']){
524 $group_left_count = substr_count($url,$groupSymbolSet['left']);
525 $group_right_count = substr_count($url,$groupSymbolSet['right']);
526 if($group_left_count<$group_right_count){
528 $url=substr($url,0,-1);
532 if(in_array(substr($url,-1),$cannotEndWith)){
534 $url=substr($url,0,-1);
536 }while($original_url!=$url);
538 if(empty($notice_id)){
539 $result = call_user_func_array($callback, array($url));
541 $result = call_user_func_array($callback, array(array($url,$notice_id)) );
543 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
546 if (version_compare(PHP_VERSION, '5.3.0', 'ge')) {
547 // lambda implementation in a separate file; PHP 5.2 won't parse it.
548 require_once INSTALLDIR . "/lib/curry.php";
550 function curry($fn) {
551 $args = func_get_args();
553 $id = uniqid('_partial');
554 $GLOBALS[$id] = array($fn, $args);
555 return create_function('',
556 '$args = func_get_args(); '.
557 'return call_user_func_array('.
558 '$GLOBALS["'.$id.'"][0],'.
561 '$GLOBALS["'.$id.'"][1]));');
565 function common_linkify($url) {
566 // It comes in special'd, so we unspecial it before passing to the stringifying
568 $url = htmlspecialchars_decode($url);
570 if(strpos($url, '@') !== false && strpos($url, ':') === false) {
571 //url is an email address without the mailto: protocol
572 $canon = "mailto:$url";
573 $longurl = "mailto:$url";
576 $canon = File_redirection::_canonUrl($url);
578 $longurl_data = File_redirection::where($canon);
579 if (is_array($longurl_data)) {
580 $longurl = $longurl_data['url'];
581 } elseif (is_string($longurl_data)) {
582 $longurl = $longurl_data;
584 throw new ServerException("Can't linkify url '$url'");
587 $attrs = array('href' => $canon, 'title' => $longurl, 'rel' => 'external');
589 $is_attachment = false;
590 $attachment_id = null;
593 // Check to see whether this is a known "attachment" URL.
595 $f = File::staticGet('url', $longurl);
598 // XXX: this writes to the database. :<
599 $f = File::processNew($longurl);
603 if ($f->isEnclosure()) {
604 $is_attachment = true;
605 $attachment_id = $f->id;
607 $foe = File_oembed::staticGet('file_id', $f->id);
609 // if it has OEmbed info, it's an attachment, too
610 $is_attachment = true;
611 $attachment_id = $f->id;
613 $thumb = File_thumbnail::staticGet('file_id', $f->id);
614 if (!empty($thumb)) {
622 if ($is_attachment) {
623 $attrs['class'] = 'attachment';
625 $attrs['class'] = 'attachment thumbnail';
627 $attrs['id'] = "attachment-{$attachment_id}";
630 return XMLStringer::estring('a', $attrs, $url);
633 function common_shorten_links($text)
635 $maxLength = Notice::maxContent();
636 if ($maxLength == 0 || mb_strlen($text) <= $maxLength) return $text;
637 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
640 function common_xml_safe_str($str)
642 // Neutralize control codes and surrogates
643 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
646 function common_tag_link($tag)
648 $canonical = common_canonical_tag($tag);
649 $url = common_local_url('tag', array('tag' => $canonical));
650 $xs = new XMLStringer();
651 $xs->elementStart('span', 'tag');
652 $xs->element('a', array('href' => $url,
655 $xs->elementEnd('span');
656 return $xs->getString();
659 function common_canonical_tag($tag)
661 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
662 return str_replace(array('-', '_', '.'), '', $tag);
665 function common_valid_profile_tag($str)
667 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
670 function common_at_link($sender_id, $nickname)
672 $sender = Profile::staticGet($sender_id);
673 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
675 $user = User::staticGet('id', $recipient->id);
677 $url = common_local_url('userbyid', array('id' => $user->id));
679 $url = $recipient->profileurl;
681 $xs = new XMLStringer(false);
682 $attrs = array('href' => $url,
684 if (!empty($recipient->fullname)) {
685 $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
687 $xs->elementStart('span', 'vcard');
688 $xs->elementStart('a', $attrs);
689 $xs->element('span', 'fn nickname', $nickname);
690 $xs->elementEnd('a');
691 $xs->elementEnd('span');
692 return $xs->getString();
698 function common_group_link($sender_id, $nickname)
700 $sender = Profile::staticGet($sender_id);
701 $group = User_group::getForNickname($nickname);
702 if ($group && $sender->isMember($group)) {
703 $attrs = array('href' => $group->permalink(),
705 if (!empty($group->fullname)) {
706 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
708 $xs = new XMLStringer();
709 $xs->elementStart('span', 'vcard');
710 $xs->elementStart('a', $attrs);
711 $xs->element('span', 'fn nickname', $nickname);
712 $xs->elementEnd('a');
713 $xs->elementEnd('span');
714 return $xs->getString();
720 function common_at_hash_link($sender_id, $tag)
722 $user = User::staticGet($sender_id);
726 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
728 $url = common_local_url('subscriptions',
729 array('nickname' => $user->nickname,
731 $xs = new XMLStringer();
732 $xs->elementStart('span', 'tag');
733 $xs->element('a', array('href' => $url,
736 $xs->elementEnd('span');
737 return $xs->getString();
743 function common_relative_profile($sender, $nickname, $dt=null)
745 // Try to find profiles this profile is subscribed to that have this nickname
746 $recipient = new Profile();
747 // XXX: use a join instead of a subquery
748 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
749 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
750 if ($recipient->find(true)) {
751 // XXX: should probably differentiate between profiles with
752 // the same name by date of most recent update
755 // Try to find profiles that listen to this profile and that have this nickname
756 $recipient = new Profile();
757 // XXX: use a join instead of a subquery
758 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
759 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
760 if ($recipient->find(true)) {
761 // XXX: should probably differentiate between profiles with
762 // the same name by date of most recent update
765 // If this is a local user, try to find a local user with that nickname.
766 $sender = User::staticGet($sender->id);
768 $recipient_user = User::staticGet('nickname', $nickname);
769 if ($recipient_user) {
770 return $recipient_user->getProfile();
773 // Otherwise, no links. @messages from local users to remote users,
774 // or from remote users to other remote users, are just
775 // outside our ability to make intelligent guesses about
779 function common_local_url($action, $args=null, $params=null, $fragment=null)
782 $path = $r->build($action, $args, $params, $fragment);
784 $ssl = common_is_sensitive($action);
786 if (common_config('site','fancy')) {
787 $url = common_path(mb_substr($path, 1), $ssl);
789 if (mb_strpos($path, '/index.php') === 0) {
790 $url = common_path(mb_substr($path, 1), $ssl);
792 $url = common_path('index.php'.$path, $ssl);
798 function common_is_sensitive($action)
800 static $sensitive = array('login', 'register', 'passwordsettings',
801 'twittersettings', 'api');
804 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
805 $ssl = in_array($action, $sensitive);
811 function common_path($relative, $ssl=false)
813 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
815 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
816 || common_config('site', 'ssl') === 'always') {
818 if (is_string(common_config('site', 'sslserver')) &&
819 mb_strlen(common_config('site', 'sslserver')) > 0) {
820 $serverpart = common_config('site', 'sslserver');
821 } else if (common_config('site', 'server')) {
822 $serverpart = common_config('site', 'server');
824 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
828 if (common_config('site', 'server')) {
829 $serverpart = common_config('site', 'server');
831 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
835 $relative = common_inject_session($relative, $serverpart);
837 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
840 function common_inject_session($url, $serverpart = null)
842 if (common_have_session()) {
844 if (empty($serverpart)) {
845 $serverpart = parse_url($url, PHP_URL_HOST);
848 $currentServer = $_SERVER['HTTP_HOST'];
850 // Are we pointing to another server (like an SSL server?)
852 if (!empty($currentServer) &&
853 0 != strcasecmp($currentServer, $serverpart)) {
854 // Pass the session ID as a GET parameter
855 $sesspart = session_name() . '=' . session_id();
856 $i = strpos($url, '?');
857 if ($i === false) { // no GET params, just append
858 $url .= '?' . $sesspart;
860 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
868 function common_date_string($dt)
870 // XXX: do some sexy date formatting
871 // return date(DATE_RFC822, $dt);
876 if ($now < $t) { // that shouldn't happen!
877 return common_exact_date($dt);
878 } else if ($diff < 60) {
879 return _('a few seconds ago');
880 } else if ($diff < 92) {
881 return _('about a minute ago');
882 } else if ($diff < 3300) {
883 return sprintf(_('about %d minutes ago'), round($diff/60));
884 } else if ($diff < 5400) {
885 return _('about an hour ago');
886 } else if ($diff < 22 * 3600) {
887 return sprintf(_('about %d hours ago'), round($diff/3600));
888 } else if ($diff < 37 * 3600) {
889 return _('about a day ago');
890 } else if ($diff < 24 * 24 * 3600) {
891 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
892 } else if ($diff < 46 * 24 * 3600) {
893 return _('about a month ago');
894 } else if ($diff < 330 * 24 * 3600) {
895 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
896 } else if ($diff < 480 * 24 * 3600) {
897 return _('about a year ago');
899 return common_exact_date($dt);
903 function common_exact_date($dt)
909 $_utc = new DateTimeZone('UTC');
910 $_siteTz = new DateTimeZone(common_timezone());
913 $dateStr = date('d F Y H:i:s', strtotime($dt));
914 $d = new DateTime($dateStr, $_utc);
915 $d->setTimezone($_siteTz);
916 return $d->format(DATE_RFC850);
919 function common_date_w3dtf($dt)
921 $dateStr = date('d F Y H:i:s', strtotime($dt));
922 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
923 $d->setTimezone(new DateTimeZone(common_timezone()));
924 return $d->format(DATE_W3C);
927 function common_date_rfc2822($dt)
929 $dateStr = date('d F Y H:i:s', strtotime($dt));
930 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
931 $d->setTimezone(new DateTimeZone(common_timezone()));
932 return $d->format('r');
935 function common_date_iso8601($dt)
937 $dateStr = date('d F Y H:i:s', strtotime($dt));
938 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
939 $d->setTimezone(new DateTimeZone(common_timezone()));
940 return $d->format('c');
943 function common_sql_now()
945 return common_sql_date(time());
948 function common_sql_date($datetime)
950 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
954 * Return an SQL fragment to calculate an age-based weight from a given
955 * timestamp or datetime column.
957 * @param string $column name of field we're comparing against current time
958 * @param integer $dropoff divisor for age in seconds before exponentiation
959 * @return string SQL fragment
961 function common_sql_weight($column, $dropoff)
963 if (common_config('db', 'type') == 'pgsql') {
964 // PostgreSQL doesn't support timestampdiff function.
965 // @fixme will this use the right time zone?
966 // @fixme does this handle cross-year subtraction correctly?
967 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
969 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
973 function common_redirect($url, $code=307)
975 static $status = array(301 => "Moved Permanently",
978 307 => "Temporary Redirect");
980 header('HTTP/1.1 '.$code.' '.$status[$code]);
981 header("Location: $url");
983 $xo = new XMLOutputter();
985 '-//W3C//DTD XHTML 1.0 Strict//EN',
986 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
987 $xo->element('a', array('href' => $url), $url);
992 function common_broadcast_notice($notice, $remote=false)
994 return common_enqueue_notice($notice);
997 // Stick the notice on the queue
999 function common_enqueue_notice($notice)
1001 static $localTransports = array('omb',
1004 static $allTransports = array('sms', 'plugin');
1006 $transports = $allTransports;
1008 $xmpp = common_config('xmpp', 'enabled');
1011 $transports[] = 'jabber';
1014 if ($notice->is_local == Notice::LOCAL_PUBLIC ||
1015 $notice->is_local == Notice::LOCAL_NONPUBLIC) {
1016 $transports = array_merge($transports, $localTransports);
1018 $transports[] = 'public';
1022 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1024 $qm = QueueManager::get();
1026 foreach ($transports as $transport)
1028 $qm->enqueue($notice, $transport);
1031 Event::handle('EndEnqueueNotice', array($notice, $transports));
1037 function common_broadcast_profile($profile)
1039 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1040 require_once(INSTALLDIR.'/lib/omb.php');
1041 omb_broadcast_profile($profile);
1042 // XXX: Other broadcasts...?
1046 function common_profile_url($nickname)
1048 return common_local_url('showstream', array('nickname' => $nickname));
1051 // Should make up a reasonable root URL
1053 function common_root_url($ssl=false)
1055 $url = common_path('', $ssl);
1056 $i = strpos($url, '?');
1058 $url = substr($url, 0, $i);
1063 // returns $bytes bytes of random data as a hexadecimal string
1064 // "good" here is a goal and not a guarantee
1066 function common_good_rand($bytes)
1068 // XXX: use random.org...?
1069 if (@file_exists('/dev/urandom')) {
1070 return common_urandom($bytes);
1071 } else { // FIXME: this is probably not good enough
1072 return common_mtrand($bytes);
1076 function common_urandom($bytes)
1078 $h = fopen('/dev/urandom', 'rb');
1080 $src = fread($h, $bytes);
1083 for ($i = 0; $i < $bytes; $i++) {
1084 $enc .= sprintf("%02x", (ord($src[$i])));
1089 function common_mtrand($bytes)
1092 for ($i = 0; $i < $bytes; $i++) {
1093 $enc .= sprintf("%02x", mt_rand(0, 255));
1098 function common_set_returnto($url)
1100 common_ensure_session();
1101 $_SESSION['returnto'] = $url;
1104 function common_get_returnto()
1106 common_ensure_session();
1107 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1110 function common_timestamp()
1112 return date('YmdHis');
1115 function common_ensure_syslog()
1117 static $initialized = false;
1118 if (!$initialized) {
1119 openlog(common_config('syslog', 'appname'), 0,
1120 common_config('syslog', 'facility'));
1121 $initialized = true;
1125 function common_log_line($priority, $msg)
1127 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1128 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1129 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1132 function common_request_id()
1135 if (php_sapi_name() == 'cli') {
1138 static $req_id = null;
1139 if (!isset($req_id)) {
1140 $req_id = substr(md5(mt_rand()), 0, 8);
1142 if (isset($_SERVER['REQUEST_URI'])) {
1143 $url = $_SERVER['REQUEST_URI'];
1145 $method = $_SERVER['REQUEST_METHOD'];
1146 return "$pid.$req_id $method $url";
1150 function common_log($priority, $msg, $filename=null)
1152 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1153 $msg = '[' . common_request_id() . '] ' . $msg;
1154 $logfile = common_config('site', 'logfile');
1156 $log = fopen($logfile, "a");
1158 $output = common_log_line($priority, $msg);
1159 fwrite($log, $output);
1163 common_ensure_syslog();
1164 syslog($priority, $msg);
1166 Event::handle('EndLog', array($priority, $msg, $filename));
1170 function common_debug($msg, $filename=null)
1173 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1175 common_log(LOG_DEBUG, $msg);
1179 function common_log_db_error(&$object, $verb, $filename=null)
1181 $objstr = common_log_objstring($object);
1182 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1183 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1186 function common_log_objstring(&$object)
1188 if (is_null($object)) {
1191 if (!($object instanceof DB_DataObject)) {
1194 $arr = $object->toArray();
1196 foreach ($arr as $k => $v) {
1197 if (is_object($v)) {
1198 $fields[] = "$k='".get_class($v)."'";
1200 $fields[] = "$k='$v'";
1203 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1207 function common_valid_http_url($url)
1209 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1212 function common_valid_tag($tag)
1214 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1215 return (Validate::email($matches[1]) ||
1216 preg_match('/^([\w-\.]+)$/', $matches[1]));
1221 /* Following functions are copied from MediaWiki GlobalFunctions.php
1222 * and written by Evan Prodromou. */
1224 function common_accept_to_prefs($accept, $def = '*/*')
1226 // No arg means accept anything (per HTTP spec)
1228 return array($def => 1);
1233 $parts = explode(',', $accept);
1235 foreach($parts as $part) {
1236 // FIXME: doesn't deal with params like 'text/html; level=1'
1237 @list($value, $qpart) = explode(';', trim($part));
1239 if(!isset($qpart)) {
1241 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1242 $prefs[$value] = $match[1];
1249 function common_mime_type_match($type, $avail)
1251 if(array_key_exists($type, $avail)) {
1254 $parts = explode('/', $type);
1255 if(array_key_exists($parts[0] . '/*', $avail)) {
1256 return $parts[0] . '/*';
1257 } elseif(array_key_exists('*/*', $avail)) {
1265 function common_negotiate_type($cprefs, $sprefs)
1269 foreach(array_keys($sprefs) as $type) {
1270 $parts = explode('/', $type);
1271 if($parts[1] != '*') {
1272 $ckey = common_mime_type_match($type, $cprefs);
1274 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1279 foreach(array_keys($cprefs) as $type) {
1280 $parts = explode('/', $type);
1281 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1282 $skey = common_mime_type_match($type, $sprefs);
1284 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1290 $besttype = 'text/html';
1292 foreach(array_keys($combine) as $type) {
1293 if($combine[$type] > $bestq) {
1295 $bestq = $combine[$type];
1299 if ('text/html' === $besttype) {
1300 return "text/html; charset=utf-8";
1305 function common_config($main, $sub)
1308 return (array_key_exists($main, $config) &&
1309 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1312 function common_copy_args($from)
1315 $strip = get_magic_quotes_gpc();
1316 foreach ($from as $k => $v) {
1317 $to[$k] = ($strip) ? stripslashes($v) : $v;
1323 * Neutralise the evil effects of magic_quotes_gpc in the current request.
1324 * This is used before handing a request off to OAuthRequest::from_request.
1325 * @fixme Doesn't consider vars other than _POST and _GET?
1326 * @fixme Can't be undone and could corrupt data if run twice.
1328 function common_remove_magic_from_request()
1330 if(get_magic_quotes_gpc()) {
1331 $_POST=array_map('stripslashes',$_POST);
1332 $_GET=array_map('stripslashes',$_GET);
1336 function common_user_uri(&$user)
1338 return common_local_url('userbyid', array('id' => $user->id));
1341 function common_notice_uri(&$notice)
1343 return common_local_url('shownotice',
1344 array('notice' => $notice->id));
1347 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1349 function common_confirmation_code($bits)
1351 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1352 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1353 $chars = ceil($bits/5);
1355 for ($i = 0; $i < $chars; $i++) {
1356 // XXX: convert to string and back
1357 $num = hexdec(common_good_rand(1));
1358 // XXX: randomness is too precious to throw away almost
1359 // 40% of the bits we get!
1360 $code .= $codechars[$num%32];
1365 // convert markup to HTML
1367 function common_markup_to_html($c)
1369 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1370 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1371 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1372 return Markdown($c);
1375 function common_profile_uri($profile)
1380 $user = User::staticGet($profile->id);
1385 $remote = Remote_profile::staticGet($profile->id);
1387 return $remote->uri;
1389 // XXX: this is a very bad profile!
1393 function common_canonical_sms($sms)
1396 preg_replace('/\D/', '', $sms);
1400 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1405 case E_COMPILE_ERROR:
1409 case E_RECOVERABLE_ERROR:
1410 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1415 case E_COMPILE_WARNING:
1416 case E_CORE_WARNING:
1417 case E_USER_WARNING:
1418 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1423 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1428 case E_USER_DEPRECATED:
1429 // XXX: config variable to log this stuff, too
1433 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1438 // FIXME: show error page if we're on the Web
1439 /* Don't execute PHP internal error handler */
1443 function common_session_token()
1445 common_ensure_session();
1446 if (!array_key_exists('token', $_SESSION)) {
1447 $_SESSION['token'] = common_good_rand(64);
1449 return $_SESSION['token'];
1452 function common_cache_key($extra)
1454 return Cache::key($extra);
1457 function common_keyize($str)
1459 return Cache::keyize($str);
1462 function common_memcache()
1464 return Cache::instance();
1467 function common_license_terms($uri)
1469 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
1470 return explode('-',$matches[1]);
1475 function common_compatible_license($from, $to)
1477 $from_terms = common_license_terms($from);
1478 // public domain and cc-by are compatible with everything
1479 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
1482 $to_terms = common_license_terms($to);
1483 // sa is compatible across versions. IANAL
1484 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
1485 return count(array_diff($from_terms, $to_terms)) == 0;
1487 // XXX: better compatibility check needed here!
1488 // Should at least normalise URIs
1489 return ($from == $to);
1493 * returns a quoted table name, if required according to config
1495 function common_database_tablename($tablename)
1498 if(common_config('db','quote_identifiers')) {
1499 $tablename = '"'. $tablename .'"';
1501 //table prefixes could be added here later
1506 * Shorten a URL with the current user's configured shortening service,
1507 * or ur1.ca if configured, or not at all if no shortening is set up.
1508 * Length is not considered.
1510 * @param string $long_url
1511 * @return string may return the original URL if shortening failed
1513 * @fixme provide a way to specify a particular shortener
1514 * @fixme provide a way to specify to use a given user's shortening preferences
1516 function common_shorten_url($long_url)
1518 $user = common_current_user();
1520 // common current user does not find a user when called from the XMPP daemon
1521 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1522 $shortenerName = 'ur1.ca';
1524 $shortenerName = $user->urlshorteningservice;
1527 if(Event::handle('StartShortenUrl', array($long_url,$shortenerName,&$shortenedUrl))){
1528 //URL wasn't shortened, so return the long url
1531 //URL was shortened, so return the result
1532 return $shortenedUrl;
1537 * @return mixed array($proxy, $ip) for web requests; proxy may be null
1538 * null if not a web request
1540 * @fixme X-Forwarded-For can be chained by multiple proxies;
1541 we should parse the list and provide a cleaner array
1542 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
1543 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
1544 * use function to get exact request headers from Apache if possible.
1546 function common_client_ip()
1548 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1552 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1553 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1554 $proxy = $_SERVER['HTTP_CLIENT_IP'];
1556 $proxy = $_SERVER['REMOTE_ADDR'];
1558 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1561 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1562 $ip = $_SERVER['HTTP_CLIENT_IP'];
1564 $ip = $_SERVER['REMOTE_ADDR'];
1568 return array($proxy, $ip);