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 if (is_object($id) || is_object($password)) {
123 $e = new Exception();
124 common_log(LOG_ERR, __METHOD__ . ' object in param to common_munge_password ' .
125 str_replace("\n", " ", $e->getTraceAsString()));
127 return md5($password . $id);
130 // check if a username exists and has matching password
132 function common_check_user($nickname, $password)
134 $authenticatedUser = false;
136 if (Event::handle('StartCheckPassword', array($nickname, $password, &$authenticatedUser))) {
137 $user = User::staticGet('nickname', $nickname);
139 if (!empty($password)) { // never allow login with blank password
140 if (0 == strcmp(common_munge_password($password, $user->id),
142 //internal checking passed
143 $authenticatedUser = $user;
147 Event::handle('EndCheckPassword', array($nickname, $password, $authenticatedUser));
150 return $authenticatedUser;
153 // is the current user logged in?
154 function common_logged_in()
156 return (!is_null(common_current_user()));
159 function common_have_session()
161 return (0 != strcmp(session_id(), ''));
164 function common_ensure_session()
167 if (array_key_exists(session_name(), $_COOKIE)) {
168 $c = $_COOKIE[session_name()];
170 if (!common_have_session()) {
171 if (common_config('sessions', 'handle')) {
172 Session::setSaveHandler();
174 if (array_key_exists(session_name(), $_GET)) {
175 $id = $_GET[session_name()];
176 } else if (array_key_exists(session_name(), $_COOKIE)) {
177 $id = $_COOKIE[session_name()];
183 if (!isset($_SESSION['started'])) {
184 $_SESSION['started'] = time();
186 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
187 ' is set but started value is null');
193 // Three kinds of arguments:
198 // Initialize to false; set to null if none found
202 function common_set_user($user)
207 if (is_null($user) && common_have_session()) {
209 unset($_SESSION['userid']);
211 } else if (is_string($user)) {
213 $user = User::staticGet('nickname', $nickname);
214 } else if (!($user instanceof User)) {
219 if (Event::handle('StartSetUser', array(&$user))) {
221 common_ensure_session();
222 $_SESSION['userid'] = $user->id;
224 Event::handle('EndSetUser', array($user));
232 function common_set_cookie($key, $value, $expiration=0)
234 $path = common_config('site', 'path');
235 $server = common_config('site', 'server');
237 if ($path && ($path != '/')) {
238 $cookiepath = '/' . $path . '/';
242 return setcookie($key,
249 define('REMEMBERME', 'rememberme');
250 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
252 function common_rememberme($user=null)
255 $user = common_current_user();
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__);
277 $rm->query('COMMIT');
279 $cookieval = $rm->user_id . ':' . $rm->code;
281 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
283 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
288 function common_remembered_user()
293 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
299 list($id, $code) = explode(':', $packed);
301 if (!$id || !$code) {
302 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
307 $rm = Remember_me::staticGet($code);
310 common_log(LOG_WARNING, 'No such remember code: ' . $code);
315 if ($rm->user_id != $id) {
316 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
321 $user = User::staticGet($rm->user_id);
324 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
330 $result = $rm->delete();
333 common_log_db_error($rm, 'DELETE', __FILE__);
334 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
339 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
341 common_set_user($user);
342 common_real_login(false);
344 // We issue a new cookie, so they can log in
345 // automatically again after this session
347 common_rememberme($user);
352 // must be called with a valid user!
354 function common_forgetme()
356 common_set_cookie(REMEMBERME, '', 0);
359 // who is the current user?
360 function common_current_user()
364 if (!_have_config()) {
368 if ($_cur === false) {
370 if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
371 || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
372 common_ensure_session();
373 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
375 $user = User::staticGet($id);
383 // that didn't work; try to remember; will init $_cur to null on failure
384 $_cur = common_remembered_user();
387 // XXX: Is this necessary?
388 $_SESSION['userid'] = $_cur->id;
395 // Logins that are 'remembered' aren't 'real' -- they're subject to
396 // cookie-stealing. So, we don't let them do certain things. New reg,
397 // OpenID, and password logins _are_ real.
399 function common_real_login($real=true)
401 common_ensure_session();
402 $_SESSION['real_login'] = $real;
405 function common_is_real_login()
407 return common_logged_in() && $_SESSION['real_login'];
410 // get canonical version of nickname for comparison
411 function common_canonical_nickname($nickname)
413 // XXX: UTF-8 canonicalization (like combining chars)
414 return strtolower($nickname);
417 // get canonical version of email for comparison
418 function common_canonical_email($email)
420 // XXX: canonicalize UTF-8
421 // XXX: lcase the domain part
425 function common_render_content($text, $notice)
427 $r = common_render_text($text);
428 $id = $notice->profile_id;
429 $r = common_linkify_mentions($id, $r);
430 $r = preg_replace('/(^|[\s\.\,\:\;]+)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
434 function common_linkify_mentions($profile_id, $text)
436 $mentions = common_find_mentions($profile_id, $text);
438 // We need to go through in reverse order by position,
439 // so our positions stay valid despite our fudging with the
444 foreach ($mentions as $mention)
446 $points[$mention['position']] = $mention;
451 foreach ($points as $position => $mention) {
453 $linkText = common_linkify_mention($mention);
455 $text = substr_replace($text, $linkText, $position, mb_strlen($mention['text']));
461 function common_linkify_mention($mention)
465 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
467 $xs = new XMLStringer(false);
469 $attrs = array('href' => $mention['url'],
472 if (!empty($mention['title'])) {
473 $attrs['title'] = $mention['title'];
476 $xs->elementStart('span', 'vcard');
477 $xs->elementStart('a', $attrs);
478 $xs->element('span', 'fn nickname', $mention['text']);
479 $xs->elementEnd('a');
480 $xs->elementEnd('span');
482 $output = $xs->getString();
484 Event::handle('EndLinkifyMention', array($mention, &$output));
490 function common_find_mentions($profile_id, $text)
494 $sender = Profile::staticGet('id', $profile_id);
496 if (empty($sender)) {
500 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
502 preg_match_all('/^T ([A-Z0-9]{1,64}) /',
505 PREG_OFFSET_CAPTURE);
507 preg_match_all('/(?:^|\s+)@(['.NICKNAME_FMT.']{1,64})/',
510 PREG_OFFSET_CAPTURE);
512 $matches = array_merge($tmatches[1], $atmatches[1]);
514 foreach ($matches as $match) {
516 $nickname = common_canonical_nickname($match[0]);
517 $mentioned = common_relative_profile($sender, $nickname);
519 if (!empty($mentioned)) {
521 $user = User::staticGet('id', $mentioned->id);
524 $url = common_local_url('userbyid', array('id' => $user->id));
526 $url = $mentioned->profileurl;
529 $mention = array('mentioned' => array($mentioned),
531 'position' => $match[1],
534 if (!empty($mentioned->fullname)) {
535 $mention['title'] = $mentioned->fullname;
538 $mentions[] = $mention;
542 // @#tag => mention of all subscriptions tagged 'tag'
544 preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
547 PREG_OFFSET_CAPTURE);
549 foreach ($hmatches[1] as $hmatch) {
551 $tag = common_canonical_tag($hmatch[0]);
553 $tagged = Profile_tag::getTagged($sender->id, $tag);
555 $url = common_local_url('subscriptions',
556 array('nickname' => $sender->nickname,
559 $mentions[] = array('mentioned' => $tagged,
560 'text' => $hmatch[0],
561 'position' => $hmatch[1],
565 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
571 function common_render_text($text)
573 $r = htmlspecialchars($text);
575 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
576 $r = common_replace_urls_callback($r, 'common_linkify');
577 $r = preg_replace('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
582 function common_replace_urls_callback($text, $callback, $notice_id = null) {
583 // Start off with a regex
585 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
588 '(?:'. //Known protocols
590 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
592 '(?:(?:mailto|aim|tel|xmpp):)'.
594 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
597 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
599 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
603 '|(?:(?: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
605 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
607 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
608 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
609 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
610 '(?: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)'.
614 '(?:\:\d+)?'. //:port
615 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
616 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
617 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
618 ')(?<![\?\.\,\#\,])'.
621 //preg_match_all($regex,$text,$matches);
623 return preg_replace_callback($regex, curry('callback_helper',$callback,$notice_id) ,$text);
626 function callback_helper($matches, $callback, $notice_id) {
628 $left = strpos($matches[0],$url);
629 $right = $left+strlen($url);
631 $groupSymbolSets=array(
649 $cannotEndWith=array('.','?',',','#');
653 foreach($groupSymbolSets as $groupSymbolSet){
654 if(substr($url,-1)==$groupSymbolSet['right']){
655 $group_left_count = substr_count($url,$groupSymbolSet['left']);
656 $group_right_count = substr_count($url,$groupSymbolSet['right']);
657 if($group_left_count<$group_right_count){
659 $url=substr($url,0,-1);
663 if(in_array(substr($url,-1),$cannotEndWith)){
665 $url=substr($url,0,-1);
667 }while($original_url!=$url);
669 if(empty($notice_id)){
670 $result = call_user_func_array($callback, array($url));
672 $result = call_user_func_array($callback, array(array($url,$notice_id)) );
674 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
677 if (version_compare(PHP_VERSION, '5.3.0', 'ge')) {
678 // lambda implementation in a separate file; PHP 5.2 won't parse it.
679 require_once INSTALLDIR . "/lib/curry.php";
681 function curry($fn) {
682 $args = func_get_args();
684 $id = uniqid('_partial');
685 $GLOBALS[$id] = array($fn, $args);
686 return create_function('',
687 '$args = func_get_args(); '.
688 'return call_user_func_array('.
689 '$GLOBALS["'.$id.'"][0],'.
692 '$GLOBALS["'.$id.'"][1]));');
696 function common_linkify($url) {
697 // It comes in special'd, so we unspecial it before passing to the stringifying
699 $url = htmlspecialchars_decode($url);
701 if(strpos($url, '@') !== false && strpos($url, ':') === false) {
702 //url is an email address without the mailto: protocol
703 $canon = "mailto:$url";
704 $longurl = "mailto:$url";
707 $canon = File_redirection::_canonUrl($url);
709 $longurl_data = File_redirection::where($canon);
710 if (is_array($longurl_data)) {
711 $longurl = $longurl_data['url'];
712 } elseif (is_string($longurl_data)) {
713 $longurl = $longurl_data;
715 throw new ServerException("Can't linkify url '$url'");
718 $attrs = array('href' => $canon, 'title' => $longurl, 'rel' => 'external');
720 $is_attachment = false;
721 $attachment_id = null;
724 // Check to see whether this is a known "attachment" URL.
726 $f = File::staticGet('url', $longurl);
729 // XXX: this writes to the database. :<
730 $f = File::processNew($longurl);
734 if ($f->getEnclosure()) {
735 $is_attachment = true;
736 $attachment_id = $f->id;
738 $thumb = File_thumbnail::staticGet('file_id', $f->id);
739 if (!empty($thumb)) {
746 if ($is_attachment) {
747 $attrs['class'] = 'attachment';
749 $attrs['class'] = 'attachment thumbnail';
751 $attrs['id'] = "attachment-{$attachment_id}";
754 return XMLStringer::estring('a', $attrs, $url);
757 function common_shorten_links($text)
759 $maxLength = Notice::maxContent();
760 if ($maxLength == 0 || mb_strlen($text) <= $maxLength) return $text;
761 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
764 function common_xml_safe_str($str)
766 // Neutralize control codes and surrogates
767 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
770 function common_tag_link($tag)
772 $canonical = common_canonical_tag($tag);
773 $url = common_local_url('tag', array('tag' => $canonical));
774 $xs = new XMLStringer();
775 $xs->elementStart('span', 'tag');
776 $xs->element('a', array('href' => $url,
779 $xs->elementEnd('span');
780 return $xs->getString();
783 function common_canonical_tag($tag)
785 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
786 return str_replace(array('-', '_', '.'), '', $tag);
789 function common_valid_profile_tag($str)
791 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
794 function common_group_link($sender_id, $nickname)
796 $sender = Profile::staticGet($sender_id);
797 $group = User_group::getForNickname($nickname);
798 if ($sender && $group && $sender->isMember($group)) {
799 $attrs = array('href' => $group->permalink(),
801 if (!empty($group->fullname)) {
802 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
804 $xs = new XMLStringer();
805 $xs->elementStart('span', 'vcard');
806 $xs->elementStart('a', $attrs);
807 $xs->element('span', 'fn nickname', $nickname);
808 $xs->elementEnd('a');
809 $xs->elementEnd('span');
810 return $xs->getString();
816 function common_relative_profile($sender, $nickname, $dt=null)
818 // Try to find profiles this profile is subscribed to that have this nickname
819 $recipient = new Profile();
820 // XXX: use a join instead of a subquery
821 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
822 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
823 if ($recipient->find(true)) {
824 // XXX: should probably differentiate between profiles with
825 // the same name by date of most recent update
828 // Try to find profiles that listen to this profile and that have this nickname
829 $recipient = new Profile();
830 // XXX: use a join instead of a subquery
831 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
832 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
833 if ($recipient->find(true)) {
834 // XXX: should probably differentiate between profiles with
835 // the same name by date of most recent update
838 // If this is a local user, try to find a local user with that nickname.
839 $sender = User::staticGet($sender->id);
841 $recipient_user = User::staticGet('nickname', $nickname);
842 if ($recipient_user) {
843 return $recipient_user->getProfile();
846 // Otherwise, no links. @messages from local users to remote users,
847 // or from remote users to other remote users, are just
848 // outside our ability to make intelligent guesses about
852 function common_local_url($action, $args=null, $params=null, $fragment=null)
855 $path = $r->build($action, $args, $params, $fragment);
857 $ssl = common_is_sensitive($action);
859 if (common_config('site','fancy')) {
860 $url = common_path(mb_substr($path, 1), $ssl);
862 if (mb_strpos($path, '/index.php') === 0) {
863 $url = common_path(mb_substr($path, 1), $ssl);
865 $url = common_path('index.php'.$path, $ssl);
871 function common_is_sensitive($action)
873 static $sensitive = array('login', 'register', 'passwordsettings',
874 'twittersettings', 'api');
877 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
878 $ssl = in_array($action, $sensitive);
884 function common_path($relative, $ssl=false)
886 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
888 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
889 || common_config('site', 'ssl') === 'always') {
891 if (is_string(common_config('site', 'sslserver')) &&
892 mb_strlen(common_config('site', 'sslserver')) > 0) {
893 $serverpart = common_config('site', 'sslserver');
894 } else if (common_config('site', 'server')) {
895 $serverpart = common_config('site', 'server');
897 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
901 if (common_config('site', 'server')) {
902 $serverpart = common_config('site', 'server');
904 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
908 $relative = common_inject_session($relative, $serverpart);
910 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
913 function common_inject_session($url, $serverpart = null)
915 if (common_have_session()) {
917 if (empty($serverpart)) {
918 $serverpart = parse_url($url, PHP_URL_HOST);
921 $currentServer = $_SERVER['HTTP_HOST'];
923 // Are we pointing to another server (like an SSL server?)
925 if (!empty($currentServer) &&
926 0 != strcasecmp($currentServer, $serverpart)) {
927 // Pass the session ID as a GET parameter
928 $sesspart = session_name() . '=' . session_id();
929 $i = strpos($url, '?');
930 if ($i === false) { // no GET params, just append
931 $url .= '?' . $sesspart;
933 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
941 function common_date_string($dt)
943 // XXX: do some sexy date formatting
944 // return date(DATE_RFC822, $dt);
949 if ($now < $t) { // that shouldn't happen!
950 return common_exact_date($dt);
951 } else if ($diff < 60) {
952 return _('a few seconds ago');
953 } else if ($diff < 92) {
954 return _('about a minute ago');
955 } else if ($diff < 3300) {
956 return sprintf(_('about %d minutes ago'), round($diff/60));
957 } else if ($diff < 5400) {
958 return _('about an hour ago');
959 } else if ($diff < 22 * 3600) {
960 return sprintf(_('about %d hours ago'), round($diff/3600));
961 } else if ($diff < 37 * 3600) {
962 return _('about a day ago');
963 } else if ($diff < 24 * 24 * 3600) {
964 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
965 } else if ($diff < 46 * 24 * 3600) {
966 return _('about a month ago');
967 } else if ($diff < 330 * 24 * 3600) {
968 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
969 } else if ($diff < 480 * 24 * 3600) {
970 return _('about a year ago');
972 return common_exact_date($dt);
976 function common_exact_date($dt)
982 $_utc = new DateTimeZone('UTC');
983 $_siteTz = new DateTimeZone(common_timezone());
986 $dateStr = date('d F Y H:i:s', strtotime($dt));
987 $d = new DateTime($dateStr, $_utc);
988 $d->setTimezone($_siteTz);
989 return $d->format(DATE_RFC850);
992 function common_date_w3dtf($dt)
994 $dateStr = date('d F Y H:i:s', strtotime($dt));
995 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
996 $d->setTimezone(new DateTimeZone(common_timezone()));
997 return $d->format(DATE_W3C);
1000 function common_date_rfc2822($dt)
1002 $dateStr = date('d F Y H:i:s', strtotime($dt));
1003 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1004 $d->setTimezone(new DateTimeZone(common_timezone()));
1005 return $d->format('r');
1008 function common_date_iso8601($dt)
1010 $dateStr = date('d F Y H:i:s', strtotime($dt));
1011 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1012 $d->setTimezone(new DateTimeZone(common_timezone()));
1013 return $d->format('c');
1016 function common_sql_now()
1018 return common_sql_date(time());
1021 function common_sql_date($datetime)
1023 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1027 * Return an SQL fragment to calculate an age-based weight from a given
1028 * timestamp or datetime column.
1030 * @param string $column name of field we're comparing against current time
1031 * @param integer $dropoff divisor for age in seconds before exponentiation
1032 * @return string SQL fragment
1034 function common_sql_weight($column, $dropoff)
1036 if (common_config('db', 'type') == 'pgsql') {
1037 // PostgreSQL doesn't support timestampdiff function.
1038 // @fixme will this use the right time zone?
1039 // @fixme does this handle cross-year subtraction correctly?
1040 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1042 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1046 function common_redirect($url, $code=307)
1048 static $status = array(301 => "Moved Permanently",
1051 307 => "Temporary Redirect");
1053 header('HTTP/1.1 '.$code.' '.$status[$code]);
1054 header("Location: $url");
1056 $xo = new XMLOutputter();
1058 '-//W3C//DTD XHTML 1.0 Strict//EN',
1059 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1060 $xo->element('a', array('href' => $url), $url);
1065 function common_broadcast_notice($notice, $remote=false)
1070 // Stick the notice on the queue
1072 function common_enqueue_notice($notice)
1074 static $localTransports = array('omb',
1077 $transports = array();
1078 if (common_config('sms', 'enabled')) {
1079 $transports[] = 'sms';
1081 if (Event::hasHandler('HandleQueuedNotice')) {
1082 $transports[] = 'plugin';
1085 $xmpp = common_config('xmpp', 'enabled');
1088 $transports[] = 'jabber';
1091 // @fixme move these checks into QueueManager and/or individual handlers
1092 if ($notice->is_local == Notice::LOCAL_PUBLIC ||
1093 $notice->is_local == Notice::LOCAL_NONPUBLIC) {
1094 $transports = array_merge($transports, $localTransports);
1096 $transports[] = 'public';
1100 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1102 $qm = QueueManager::get();
1104 foreach ($transports as $transport)
1106 $qm->enqueue($notice, $transport);
1109 Event::handle('EndEnqueueNotice', array($notice, $transports));
1116 * Broadcast profile updates to OMB and other remote subscribers.
1118 * Since this may be slow with a lot of subscribers or bad remote sites,
1119 * this is run through the background queues if possible.
1121 function common_broadcast_profile(Profile $profile)
1123 $qm = QueueManager::get();
1124 $qm->enqueue($profile, "profile");
1128 function common_profile_url($nickname)
1130 return common_local_url('showstream', array('nickname' => $nickname));
1133 // Should make up a reasonable root URL
1135 function common_root_url($ssl=false)
1137 $url = common_path('', $ssl);
1138 $i = strpos($url, '?');
1140 $url = substr($url, 0, $i);
1145 // returns $bytes bytes of random data as a hexadecimal string
1146 // "good" here is a goal and not a guarantee
1148 function common_good_rand($bytes)
1150 // XXX: use random.org...?
1151 if (@file_exists('/dev/urandom')) {
1152 return common_urandom($bytes);
1153 } else { // FIXME: this is probably not good enough
1154 return common_mtrand($bytes);
1158 function common_urandom($bytes)
1160 $h = fopen('/dev/urandom', 'rb');
1162 $src = fread($h, $bytes);
1165 for ($i = 0; $i < $bytes; $i++) {
1166 $enc .= sprintf("%02x", (ord($src[$i])));
1171 function common_mtrand($bytes)
1174 for ($i = 0; $i < $bytes; $i++) {
1175 $enc .= sprintf("%02x", mt_rand(0, 255));
1180 function common_set_returnto($url)
1182 common_ensure_session();
1183 $_SESSION['returnto'] = $url;
1186 function common_get_returnto()
1188 common_ensure_session();
1189 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1192 function common_timestamp()
1194 return date('YmdHis');
1197 function common_ensure_syslog()
1199 static $initialized = false;
1200 if (!$initialized) {
1201 openlog(common_config('syslog', 'appname'), 0,
1202 common_config('syslog', 'facility'));
1203 $initialized = true;
1207 function common_log_line($priority, $msg)
1209 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1210 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1211 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1214 function common_request_id()
1217 $server = common_config('site', 'server');
1218 if (php_sapi_name() == 'cli') {
1219 $script = basename($_SERVER['PHP_SELF']);
1220 return "$server:$script:$pid";
1222 static $req_id = null;
1223 if (!isset($req_id)) {
1224 $req_id = substr(md5(mt_rand()), 0, 8);
1226 if (isset($_SERVER['REQUEST_URI'])) {
1227 $url = $_SERVER['REQUEST_URI'];
1229 $method = $_SERVER['REQUEST_METHOD'];
1230 return "$server:$pid.$req_id $method $url";
1234 function common_log($priority, $msg, $filename=null)
1236 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1237 $msg = '[' . common_request_id() . '] ' . $msg;
1238 $logfile = common_config('site', 'logfile');
1240 $log = fopen($logfile, "a");
1242 $output = common_log_line($priority, $msg);
1243 fwrite($log, $output);
1247 common_ensure_syslog();
1248 syslog($priority, $msg);
1250 Event::handle('EndLog', array($priority, $msg, $filename));
1254 function common_debug($msg, $filename=null)
1257 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1259 common_log(LOG_DEBUG, $msg);
1263 function common_log_db_error(&$object, $verb, $filename=null)
1265 $objstr = common_log_objstring($object);
1266 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1267 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1270 function common_log_objstring(&$object)
1272 if (is_null($object)) {
1275 if (!($object instanceof DB_DataObject)) {
1278 $arr = $object->toArray();
1280 foreach ($arr as $k => $v) {
1281 if (is_object($v)) {
1282 $fields[] = "$k='".get_class($v)."'";
1284 $fields[] = "$k='$v'";
1287 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1291 function common_valid_http_url($url)
1293 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1296 function common_valid_tag($tag)
1298 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1299 return (Validate::email($matches[1]) ||
1300 preg_match('/^([\w-\.]+)$/', $matches[1]));
1305 /* Following functions are copied from MediaWiki GlobalFunctions.php
1306 * and written by Evan Prodromou. */
1308 function common_accept_to_prefs($accept, $def = '*/*')
1310 // No arg means accept anything (per HTTP spec)
1312 return array($def => 1);
1317 $parts = explode(',', $accept);
1319 foreach($parts as $part) {
1320 // FIXME: doesn't deal with params like 'text/html; level=1'
1321 @list($value, $qpart) = explode(';', trim($part));
1323 if(!isset($qpart)) {
1325 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1326 $prefs[$value] = $match[1];
1333 function common_mime_type_match($type, $avail)
1335 if(array_key_exists($type, $avail)) {
1338 $parts = explode('/', $type);
1339 if(array_key_exists($parts[0] . '/*', $avail)) {
1340 return $parts[0] . '/*';
1341 } elseif(array_key_exists('*/*', $avail)) {
1349 function common_negotiate_type($cprefs, $sprefs)
1353 foreach(array_keys($sprefs) as $type) {
1354 $parts = explode('/', $type);
1355 if($parts[1] != '*') {
1356 $ckey = common_mime_type_match($type, $cprefs);
1358 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1363 foreach(array_keys($cprefs) as $type) {
1364 $parts = explode('/', $type);
1365 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1366 $skey = common_mime_type_match($type, $sprefs);
1368 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1374 $besttype = 'text/html';
1376 foreach(array_keys($combine) as $type) {
1377 if($combine[$type] > $bestq) {
1379 $bestq = $combine[$type];
1383 if ('text/html' === $besttype) {
1384 return "text/html; charset=utf-8";
1389 function common_config($main, $sub)
1392 return (array_key_exists($main, $config) &&
1393 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1396 function common_copy_args($from)
1399 $strip = get_magic_quotes_gpc();
1400 foreach ($from as $k => $v) {
1401 $to[$k] = ($strip) ? stripslashes($v) : $v;
1407 * Neutralise the evil effects of magic_quotes_gpc in the current request.
1408 * This is used before handing a request off to OAuthRequest::from_request.
1409 * @fixme Doesn't consider vars other than _POST and _GET?
1410 * @fixme Can't be undone and could corrupt data if run twice.
1412 function common_remove_magic_from_request()
1414 if(get_magic_quotes_gpc()) {
1415 $_POST=array_map('stripslashes',$_POST);
1416 $_GET=array_map('stripslashes',$_GET);
1420 function common_user_uri(&$user)
1422 return common_local_url('userbyid', array('id' => $user->id));
1425 function common_notice_uri(&$notice)
1427 return common_local_url('shownotice',
1428 array('notice' => $notice->id));
1431 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1433 function common_confirmation_code($bits)
1435 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1436 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1437 $chars = ceil($bits/5);
1439 for ($i = 0; $i < $chars; $i++) {
1440 // XXX: convert to string and back
1441 $num = hexdec(common_good_rand(1));
1442 // XXX: randomness is too precious to throw away almost
1443 // 40% of the bits we get!
1444 $code .= $codechars[$num%32];
1449 // convert markup to HTML
1451 function common_markup_to_html($c)
1453 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1454 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1455 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1456 return Markdown($c);
1459 function common_profile_uri($profile)
1464 $user = User::staticGet($profile->id);
1469 $remote = Remote_profile::staticGet($profile->id);
1471 return $remote->uri;
1473 // XXX: this is a very bad profile!
1477 function common_canonical_sms($sms)
1480 preg_replace('/\D/', '', $sms);
1484 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1489 case E_COMPILE_ERROR:
1493 case E_RECOVERABLE_ERROR:
1494 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1499 case E_COMPILE_WARNING:
1500 case E_CORE_WARNING:
1501 case E_USER_WARNING:
1502 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1507 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1512 case E_USER_DEPRECATED:
1513 // XXX: config variable to log this stuff, too
1517 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1522 // FIXME: show error page if we're on the Web
1523 /* Don't execute PHP internal error handler */
1527 function common_session_token()
1529 common_ensure_session();
1530 if (!array_key_exists('token', $_SESSION)) {
1531 $_SESSION['token'] = common_good_rand(64);
1533 return $_SESSION['token'];
1536 function common_cache_key($extra)
1538 return Cache::key($extra);
1541 function common_keyize($str)
1543 return Cache::keyize($str);
1546 function common_memcache()
1548 return Cache::instance();
1551 function common_license_terms($uri)
1553 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
1554 return explode('-',$matches[1]);
1559 function common_compatible_license($from, $to)
1561 $from_terms = common_license_terms($from);
1562 // public domain and cc-by are compatible with everything
1563 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
1566 $to_terms = common_license_terms($to);
1567 // sa is compatible across versions. IANAL
1568 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
1569 return count(array_diff($from_terms, $to_terms)) == 0;
1571 // XXX: better compatibility check needed here!
1572 // Should at least normalise URIs
1573 return ($from == $to);
1577 * returns a quoted table name, if required according to config
1579 function common_database_tablename($tablename)
1582 if(common_config('db','quote_identifiers')) {
1583 $tablename = '"'. $tablename .'"';
1585 //table prefixes could be added here later
1590 * Shorten a URL with the current user's configured shortening service,
1591 * or ur1.ca if configured, or not at all if no shortening is set up.
1592 * Length is not considered.
1594 * @param string $long_url
1595 * @return string may return the original URL if shortening failed
1597 * @fixme provide a way to specify a particular shortener
1598 * @fixme provide a way to specify to use a given user's shortening preferences
1600 function common_shorten_url($long_url)
1602 $user = common_current_user();
1604 // common current user does not find a user when called from the XMPP daemon
1605 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1606 $shortenerName = 'ur1.ca';
1608 $shortenerName = $user->urlshorteningservice;
1611 if(Event::handle('StartShortenUrl', array($long_url,$shortenerName,&$shortenedUrl))){
1612 //URL wasn't shortened, so return the long url
1615 //URL was shortened, so return the result
1616 return $shortenedUrl;
1621 * @return mixed array($proxy, $ip) for web requests; proxy may be null
1622 * null if not a web request
1624 * @fixme X-Forwarded-For can be chained by multiple proxies;
1625 we should parse the list and provide a cleaner array
1626 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
1627 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
1628 * use function to get exact request headers from Apache if possible.
1630 function common_client_ip()
1632 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1636 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1637 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1638 $proxy = $_SERVER['HTTP_CLIENT_IP'];
1640 $proxy = $_SERVER['REMOTE_ADDR'];
1642 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1645 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1646 $ip = $_SERVER['HTTP_CLIENT_IP'];
1648 $ip = $_SERVER['REMOTE_ADDR'];
1652 return array($proxy, $ip);
1655 function common_url_to_nickname($url)
1657 static $bad = array('query', 'user', 'password', 'port', 'fragment');
1659 $parts = parse_url($url);
1661 # If any of these parts exist, this won't work
1663 foreach ($bad as $badpart) {
1664 if (array_key_exists($badpart, $parts)) {
1669 # We just have host and/or path
1671 # If it's just a host...
1672 if (array_key_exists('host', $parts) &&
1673 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
1675 $hostparts = explode('.', $parts['host']);
1677 # Try to catch common idiom of nickname.service.tld
1679 if ((count($hostparts) > 2) &&
1680 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
1681 (strcmp($hostparts[0], 'www') != 0))
1683 return common_nicknamize($hostparts[0]);
1685 # Do the whole hostname
1686 return common_nicknamize($parts['host']);
1689 if (array_key_exists('path', $parts)) {
1690 # Strip starting, ending slashes
1691 $path = preg_replace('@/$@', '', $parts['path']);
1692 $path = preg_replace('@^/@', '', $path);
1693 if (strpos($path, '/') === false) {
1694 return common_nicknamize($path);
1702 function common_nicknamize($str)
1704 $str = preg_replace('/\W/', '', $str);
1705 return strtolower($str);