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) */
23 * Show a server error.
25 function common_server_error($msg, $code=500)
27 $err = new ServerErrorAction($msg, $code);
34 function common_user_error($msg, $code=400)
36 $err = new ClientErrorAction($msg, $code);
41 * This should only be used at setup; processes switching languages
42 * to send text to other users should use common_switch_locale().
44 * @param string $language Locale language code (optional; empty uses
45 * current user's preference or site default)
46 * @return mixed success
48 function common_init_locale($language=null)
51 $language = common_language();
53 putenv('LANGUAGE='.$language);
54 putenv('LANG='.$language);
55 $ok = setlocale(LC_ALL, $language . ".utf8",
65 * Initialize locale and charset settings and gettext with our message catalog,
66 * using the current user's language preference or the site default.
68 * This should generally only be run at framework initialization; code switching
69 * languages at runtime should call common_switch_language().
73 function common_init_language()
75 mb_internal_encoding('UTF-8');
77 // Note that this setlocale() call may "fail" but this is harmless;
78 // gettext will still select the right language.
79 $language = common_language();
80 $locale_set = common_init_locale($language);
83 // The requested locale doesn't exist on the system.
85 // gettext seems very picky... We first need to setlocale()
86 // to a locale which _does_ exist on the system, and _then_
87 // we can set in another locale that may not be set up
88 // (say, ga_ES for Galego/Galician) it seems to take it.
90 // For some reason C and POSIX which are guaranteed to work
91 // don't do the job. en_US.UTF-8 should be there most of the
92 // time, but not guaranteed.
93 $ok = common_init_locale("en_US");
94 if (!$ok && strtolower(substr(PHP_OS, 0, 3)) != 'win') {
95 // Try to find a complete, working locale on Unix/Linux...
96 // @fixme shelling out feels awfully inefficient
97 // but I don't think there's a more standard way.
99 foreach (explode("\n", $all) as $locale) {
100 if (preg_match('/\.utf[-_]?8$/i', $locale)) {
101 $ok = setlocale(LC_ALL, $locale);
109 common_log(LOG_ERR, "Unable to find a UTF-8 locale on this system; UI translations may not work.");
111 $locale_set = common_init_locale($language);
114 common_init_gettext();
120 function common_init_gettext()
122 setlocale(LC_CTYPE, 'C');
123 // So we do not have to make people install the gettext locales
124 $path = common_config('site','locale_path');
125 bindtextdomain("statusnet", $path);
126 bind_textdomain_codeset("statusnet", "UTF-8");
127 textdomain("statusnet");
131 * Switch locale during runtime, and poke gettext until it cries uncle.
132 * Otherwise, sometimes it doesn't actually switch away from the old language.
134 * @param string $language code for locale ('en', 'fr', 'pt_BR' etc)
136 function common_switch_locale($language=null)
138 common_init_locale($language);
140 setlocale(LC_CTYPE, 'C');
141 // So we do not have to make people install the gettext locales
142 $path = common_config('site','locale_path');
143 bindtextdomain("statusnet", $path);
144 bind_textdomain_codeset("statusnet", "UTF-8");
145 textdomain("statusnet");
149 function common_timezone()
151 if (common_logged_in()) {
152 $user = common_current_user();
153 if ($user->timezone) {
154 return $user->timezone;
158 return common_config('site', 'timezone');
161 function common_language()
163 // If there is a user logged in and they've set a language preference
164 // then return that one...
165 if (_have_config() && common_logged_in()) {
166 $user = common_current_user();
167 $user_language = $user->language;
169 if ($user->language) {
170 // Validate -- we don't want to end up with a bogus code
171 // left over from some old junk.
172 foreach (common_config('site', 'languages') as $code => $info) {
173 if ($info['lang'] == $user_language) {
174 return $user_language;
180 // Otherwise, find the best match for the languages requested by the
182 if (common_config('site', 'langdetect')) {
183 $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
184 if (!empty($httplang)) {
185 $language = client_prefered_language($httplang);
191 // Finally, if none of the above worked, use the site's default...
192 return common_config('site', 'language');
196 * Salted, hashed passwords are stored in the DB.
198 function common_munge_password($password, $id)
200 if (is_object($id) || is_object($password)) {
201 $e = new Exception();
202 common_log(LOG_ERR, __METHOD__ . ' object in param to common_munge_password ' .
203 str_replace("\n", " ", $e->getTraceAsString()));
205 return md5($password . $id);
209 * Check if a username exists and has matching password.
211 function common_check_user($nickname, $password)
213 // empty nickname always unacceptable
214 if (empty($nickname)) {
218 $authenticatedUser = false;
220 if (Event::handle('StartCheckPassword', array($nickname, $password, &$authenticatedUser))) {
221 $user = User::staticGet('nickname', common_canonical_nickname($nickname));
223 if (!empty($password)) { // never allow login with blank password
224 if (0 == strcmp(common_munge_password($password, $user->id),
226 //internal checking passed
227 $authenticatedUser = $user;
231 Event::handle('EndCheckPassword', array($nickname, $password, $authenticatedUser));
234 return $authenticatedUser;
238 * Is the current user logged in?
240 function common_logged_in()
242 return (!is_null(common_current_user()));
245 function common_have_session()
247 return (0 != strcmp(session_id(), ''));
250 function common_ensure_session()
253 if (array_key_exists(session_name(), $_COOKIE)) {
254 $c = $_COOKIE[session_name()];
256 if (!common_have_session()) {
257 if (common_config('sessions', 'handle')) {
258 Session::setSaveHandler();
260 if (array_key_exists(session_name(), $_GET)) {
261 $id = $_GET[session_name()];
262 } else if (array_key_exists(session_name(), $_COOKIE)) {
263 $id = $_COOKIE[session_name()];
269 if (!isset($_SESSION['started'])) {
270 $_SESSION['started'] = time();
272 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
273 ' is set but started value is null');
279 // Three kinds of arguments:
284 // Initialize to false; set to null if none found
287 function common_set_user($user)
291 if (is_null($user) && common_have_session()) {
293 unset($_SESSION['userid']);
295 } else if (is_string($user)) {
297 $user = User::staticGet('nickname', $nickname);
298 } else if (!($user instanceof User)) {
303 if (Event::handle('StartSetUser', array(&$user))) {
305 common_ensure_session();
306 $_SESSION['userid'] = $user->id;
308 Event::handle('EndSetUser', array($user));
316 function common_set_cookie($key, $value, $expiration=0)
318 $path = common_config('site', 'path');
319 $server = common_config('site', 'server');
321 if ($path && ($path != '/')) {
322 $cookiepath = '/' . $path . '/';
326 return setcookie($key,
333 define('REMEMBERME', 'rememberme');
334 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
336 function common_rememberme($user=null)
339 $user = common_current_user();
345 $rm = new Remember_me();
347 $rm->code = common_good_rand(16);
348 $rm->user_id = $user->id;
350 // Wrap the insert in some good ol' fashioned transaction code
354 $result = $rm->insert();
357 common_log_db_error($rm, 'INSERT', __FILE__);
361 $rm->query('COMMIT');
363 $cookieval = $rm->user_id . ':' . $rm->code;
365 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
367 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
372 function common_remembered_user()
376 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
382 list($id, $code) = explode(':', $packed);
384 if (!$id || !$code) {
385 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
390 $rm = Remember_me::staticGet($code);
393 common_log(LOG_WARNING, 'No such remember code: ' . $code);
398 if ($rm->user_id != $id) {
399 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
404 $user = User::staticGet($rm->user_id);
407 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
413 $result = $rm->delete();
416 common_log_db_error($rm, 'DELETE', __FILE__);
417 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
422 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
424 common_set_user($user);
425 common_real_login(false);
427 // We issue a new cookie, so they can log in
428 // automatically again after this session
430 common_rememberme($user);
436 * must be called with a valid user!
438 function common_forgetme()
440 common_set_cookie(REMEMBERME, '', 0);
444 * Who is the current user?
446 function common_current_user()
450 if (!_have_config()) {
454 if ($_cur === false) {
456 if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
457 || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
458 common_ensure_session();
459 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
461 $user = User::staticGet($id);
469 // that didn't work; try to remember; will init $_cur to null on failure
470 $_cur = common_remembered_user();
473 // XXX: Is this necessary?
474 $_SESSION['userid'] = $_cur->id;
482 * Logins that are 'remembered' aren't 'real' -- they're subject to
483 * cookie-stealing. So, we don't let them do certain things. New reg,
484 * OpenID, and password logins _are_ real.
486 function common_real_login($real=true)
488 common_ensure_session();
489 $_SESSION['real_login'] = $real;
492 function common_is_real_login()
494 return common_logged_in() && $_SESSION['real_login'];
497 // get canonical version of nickname for comparison
498 function common_canonical_nickname($nickname)
500 // XXX: UTF-8 canonicalization (like combining chars)
501 return strtolower($nickname);
504 // get canonical version of email for comparison
505 function common_canonical_email($email)
507 // XXX: canonicalize UTF-8
508 // XXX: lcase the domain part
512 function common_render_content($text, $notice)
514 $r = common_render_text($text);
515 $id = $notice->profile_id;
516 $r = common_linkify_mentions($r, $notice);
517 $r = preg_replace('/(^|[\s\.\,\:\;]+)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
521 function common_linkify_mentions($text, $notice)
523 $mentions = common_find_mentions($text, $notice);
525 // We need to go through in reverse order by position,
526 // so our positions stay valid despite our fudging with the
531 foreach ($mentions as $mention)
533 $points[$mention['position']] = $mention;
538 foreach ($points as $position => $mention) {
540 $linkText = common_linkify_mention($mention);
542 $text = substr_replace($text, $linkText, $position, mb_strlen($mention['text']));
548 function common_linkify_mention($mention)
552 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
554 $xs = new XMLStringer(false);
556 $attrs = array('href' => $mention['url'],
559 if (!empty($mention['title'])) {
560 $attrs['title'] = $mention['title'];
563 $xs->elementStart('span', 'vcard');
564 $xs->elementStart('a', $attrs);
565 $xs->element('span', 'fn nickname', $mention['text']);
566 $xs->elementEnd('a');
567 $xs->elementEnd('span');
569 $output = $xs->getString();
571 Event::handle('EndLinkifyMention', array($mention, &$output));
577 function common_find_mentions($text, $notice)
581 $sender = Profile::staticGet('id', $notice->profile_id);
583 if (empty($sender)) {
587 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
588 // Get the context of the original notice, if any
589 $originalAuthor = null;
590 $originalNotice = null;
591 $originalMentions = array();
595 if (!empty($notice) && !empty($notice->reply_to)) {
596 $originalNotice = Notice::staticGet('id', $notice->reply_to);
597 if (!empty($originalNotice)) {
598 $originalAuthor = Profile::staticGet('id', $originalNotice->profile_id);
600 $ids = $originalNotice->getReplies();
602 foreach ($ids as $id) {
603 $repliedTo = Profile::staticGet('id', $id);
604 if (!empty($repliedTo)) {
605 $originalMentions[$repliedTo->nickname] = $repliedTo;
611 preg_match_all('/^T ([A-Z0-9]{1,64}) /',
614 PREG_OFFSET_CAPTURE);
616 preg_match_all('/(?:^|\s+)@(['.NICKNAME_FMT.']{1,64})/',
619 PREG_OFFSET_CAPTURE);
621 $matches = array_merge($tmatches[1], $atmatches[1]);
623 foreach ($matches as $match) {
624 $nickname = common_canonical_nickname($match[0]);
626 // Try to get a profile for this nickname.
627 // Start with conversation context, then go to
630 if (!empty($originalAuthor) && $originalAuthor->nickname == $nickname) {
631 $mentioned = $originalAuthor;
632 } else if (!empty($originalMentions) &&
633 array_key_exists($nickname, $originalMentions)) {
634 $mentioned = $originalMentions[$nickname];
636 $mentioned = common_relative_profile($sender, $nickname);
639 if (!empty($mentioned)) {
640 $user = User::staticGet('id', $mentioned->id);
643 $url = common_local_url('userbyid', array('id' => $user->id));
645 $url = $mentioned->profileurl;
648 $mention = array('mentioned' => array($mentioned),
650 'position' => $match[1],
653 if (!empty($mentioned->fullname)) {
654 $mention['title'] = $mentioned->fullname;
657 $mentions[] = $mention;
661 // @#tag => mention of all subscriptions tagged 'tag'
663 preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
666 PREG_OFFSET_CAPTURE);
668 foreach ($hmatches[1] as $hmatch) {
670 $tag = common_canonical_tag($hmatch[0]);
672 $tagged = Profile_tag::getTagged($sender->id, $tag);
674 $url = common_local_url('subscriptions',
675 array('nickname' => $sender->nickname,
678 $mentions[] = array('mentioned' => $tagged,
679 'text' => $hmatch[0],
680 'position' => $hmatch[1],
684 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
690 function common_render_text($text)
692 $r = htmlspecialchars($text);
694 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
695 $r = common_replace_urls_callback($r, 'common_linkify');
696 $r = preg_replace('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
701 function common_replace_urls_callback($text, $callback, $notice_id = null) {
702 // Start off with a regex
704 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
707 '(?:'. //Known protocols
709 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
711 '(?:(?:mailto|aim|tel|xmpp):)'.
713 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
716 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
718 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
722 '|(?:(?: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
724 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
726 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
727 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
728 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
729 '(?: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)'.
733 '(?:\:\d+)?'. //:port
734 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
735 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
736 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
737 ')(?<![\?\.\,\#\,])'.
740 //preg_match_all($regex,$text,$matches);
742 return preg_replace_callback($regex, curry('callback_helper',$callback,$notice_id) ,$text);
745 function callback_helper($matches, $callback, $notice_id) {
747 $left = strpos($matches[0],$url);
748 $right = $left+strlen($url);
750 $groupSymbolSets=array(
768 $cannotEndWith=array('.','?',',','#');
772 foreach($groupSymbolSets as $groupSymbolSet){
773 if(substr($url,-1)==$groupSymbolSet['right']){
774 $group_left_count = substr_count($url,$groupSymbolSet['left']);
775 $group_right_count = substr_count($url,$groupSymbolSet['right']);
776 if($group_left_count<$group_right_count){
778 $url=substr($url,0,-1);
782 if(in_array(substr($url,-1),$cannotEndWith)){
784 $url=substr($url,0,-1);
786 }while($original_url!=$url);
788 if(empty($notice_id)){
789 $result = call_user_func_array($callback, array($url));
791 $result = call_user_func_array($callback, array(array($url,$notice_id)) );
793 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
796 if (version_compare(PHP_VERSION, '5.3.0', 'ge')) {
797 // lambda implementation in a separate file; PHP 5.2 won't parse it.
798 require_once INSTALLDIR . "/lib/curry.php";
800 function curry($fn) {
801 $args = func_get_args();
803 $id = uniqid('_partial');
804 $GLOBALS[$id] = array($fn, $args);
805 return create_function('',
806 '$args = func_get_args(); '.
807 'return call_user_func_array('.
808 '$GLOBALS["'.$id.'"][0],'.
811 '$GLOBALS["'.$id.'"][1]));');
815 function common_linkify($url) {
816 // It comes in special'd, so we unspecial it before passing to the stringifying
818 $url = htmlspecialchars_decode($url);
820 if(strpos($url, '@') !== false && strpos($url, ':') === false) {
821 //url is an email address without the mailto: protocol
822 $canon = "mailto:$url";
823 $longurl = "mailto:$url";
826 $canon = File_redirection::_canonUrl($url);
828 $longurl_data = File_redirection::where($canon);
829 if (is_array($longurl_data)) {
830 $longurl = $longurl_data['url'];
831 } elseif (is_string($longurl_data)) {
832 $longurl = $longurl_data;
834 // Unable to reach the server to verify contents, etc
835 // Just pass the link on through for now.
836 common_log(LOG_ERR, "Can't linkify url '$url'");
840 $attrs = array('href' => $canon, 'title' => $longurl, 'rel' => 'external');
842 $is_attachment = false;
843 $attachment_id = null;
846 // Check to see whether this is a known "attachment" URL.
848 $f = File::staticGet('url', $longurl);
851 // XXX: this writes to the database. :<
852 $f = File::processNew($longurl);
856 if ($f->getEnclosure() || File_oembed::staticGet('file_id',$f->id)) {
857 $is_attachment = true;
858 $attachment_id = $f->id;
860 $thumb = File_thumbnail::staticGet('file_id', $f->id);
861 if (!empty($thumb)) {
868 if ($is_attachment) {
869 $attrs['class'] = 'attachment';
871 $attrs['class'] = 'attachment thumbnail';
873 $attrs['id'] = "attachment-{$attachment_id}";
876 return XMLStringer::estring('a', $attrs, $url);
879 function common_shorten_links($text, $always = false)
881 $maxLength = Notice::maxContent();
882 if (!$always && ($maxLength == 0 || mb_strlen($text) <= $maxLength)) return $text;
883 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
886 function common_xml_safe_str($str)
888 // Replace common eol and extra whitespace input chars
893 "\0", // null byte eos
894 "\x0B" // vertical tab
897 $replacement = array(
905 $str = str_replace($unWelcome, $replacement, $str);
907 // Neutralize any additional control codes and UTF-16 surrogates
908 // (Twitter uses '*')
909 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
912 function common_tag_link($tag)
914 $canonical = common_canonical_tag($tag);
915 if (common_config('singleuser', 'enabled')) {
916 // regular TagAction isn't set up in 1user mode
917 $url = common_local_url('showstream',
918 array('nickname' => common_config('singleuser', 'nickname'),
919 'tag' => $canonical));
921 $url = common_local_url('tag', array('tag' => $canonical));
923 $xs = new XMLStringer();
924 $xs->elementStart('span', 'tag');
925 $xs->element('a', array('href' => $url,
928 $xs->elementEnd('span');
929 return $xs->getString();
932 function common_canonical_tag($tag)
934 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
935 return str_replace(array('-', '_', '.'), '', $tag);
938 function common_valid_profile_tag($str)
940 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
943 function common_group_link($sender_id, $nickname)
945 $sender = Profile::staticGet($sender_id);
946 $group = User_group::getForNickname($nickname, $sender);
947 if ($sender && $group && $sender->isMember($group)) {
948 $attrs = array('href' => $group->permalink(),
950 if (!empty($group->fullname)) {
951 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
953 $xs = new XMLStringer();
954 $xs->elementStart('span', 'vcard');
955 $xs->elementStart('a', $attrs);
956 $xs->element('span', 'fn nickname', $nickname);
957 $xs->elementEnd('a');
958 $xs->elementEnd('span');
959 return $xs->getString();
965 function common_relative_profile($sender, $nickname, $dt=null)
967 // Try to find profiles this profile is subscribed to that have this nickname
968 $recipient = new Profile();
969 // XXX: use a join instead of a subquery
970 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
971 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
972 if ($recipient->find(true)) {
973 // XXX: should probably differentiate between profiles with
974 // the same name by date of most recent update
977 // Try to find profiles that listen to this profile and that have this nickname
978 $recipient = new Profile();
979 // XXX: use a join instead of a subquery
980 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
981 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
982 if ($recipient->find(true)) {
983 // XXX: should probably differentiate between profiles with
984 // the same name by date of most recent update
987 // If this is a local user, try to find a local user with that nickname.
988 $sender = User::staticGet($sender->id);
990 $recipient_user = User::staticGet('nickname', $nickname);
991 if ($recipient_user) {
992 return $recipient_user->getProfile();
995 // Otherwise, no links. @messages from local users to remote users,
996 // or from remote users to other remote users, are just
997 // outside our ability to make intelligent guesses about
1001 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1004 $path = $r->build($action, $args, $params, $fragment);
1006 $ssl = common_is_sensitive($action);
1008 if (common_config('site','fancy')) {
1009 $url = common_path(mb_substr($path, 1), $ssl, $addSession);
1011 if (mb_strpos($path, '/index.php') === 0) {
1012 $url = common_path(mb_substr($path, 1), $ssl, $addSession);
1014 $url = common_path('index.php'.$path, $ssl, $addSession);
1020 function common_is_sensitive($action)
1022 static $sensitive = array('login', 'register', 'passwordsettings', 'api');
1025 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1026 $ssl = in_array($action, $sensitive);
1032 function common_path($relative, $ssl=false, $addSession=true)
1034 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1036 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1037 || common_config('site', 'ssl') === 'always') {
1039 if (is_string(common_config('site', 'sslserver')) &&
1040 mb_strlen(common_config('site', 'sslserver')) > 0) {
1041 $serverpart = common_config('site', 'sslserver');
1042 } else if (common_config('site', 'server')) {
1043 $serverpart = common_config('site', 'server');
1045 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1049 if (common_config('site', 'server')) {
1050 $serverpart = common_config('site', 'server');
1052 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1057 $relative = common_inject_session($relative, $serverpart);
1060 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1063 function common_inject_session($url, $serverpart = null)
1065 if (common_have_session()) {
1067 if (empty($serverpart)) {
1068 $serverpart = parse_url($url, PHP_URL_HOST);
1071 $currentServer = $_SERVER['HTTP_HOST'];
1073 // Are we pointing to another server (like an SSL server?)
1075 if (!empty($currentServer) &&
1076 0 != strcasecmp($currentServer, $serverpart)) {
1077 // Pass the session ID as a GET parameter
1078 $sesspart = session_name() . '=' . session_id();
1079 $i = strpos($url, '?');
1080 if ($i === false) { // no GET params, just append
1081 $url .= '?' . $sesspart;
1083 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1091 function common_date_string($dt)
1093 // XXX: do some sexy date formatting
1094 // return date(DATE_RFC822, $dt);
1095 $t = strtotime($dt);
1099 if ($now < $t) { // that shouldn't happen!
1100 return common_exact_date($dt);
1101 } else if ($diff < 60) {
1102 // TRANS: Used in notices to indicate when the notice was made compared to now.
1103 return _('a few seconds ago');
1104 } else if ($diff < 92) {
1105 // TRANS: Used in notices to indicate when the notice was made compared to now.
1106 return _('about a minute ago');
1107 } else if ($diff < 3300) {
1108 // TRANS: Used in notices to indicate when the notice was made compared to now.
1109 return sprintf( ngettext('about one minute ago', 'about %d minutes ago'), round($diff/60));
1110 } else if ($diff < 5400) {
1111 // TRANS: Used in notices to indicate when the notice was made compared to now.
1112 return _('about an hour ago');
1113 } else if ($diff < 22 * 3600) {
1114 // TRANS: Used in notices to indicate when the notice was made compared to now.
1115 return sprintf( ngettext('about one hour ago', 'about %d hours ago'), round($diff/3600));
1116 } else if ($diff < 37 * 3600) {
1117 // TRANS: Used in notices to indicate when the notice was made compared to now.
1118 return _('about a day ago');
1119 } else if ($diff < 24 * 24 * 3600) {
1120 // TRANS: Used in notices to indicate when the notice was made compared to now.
1121 return sprintf( ngettext('about one day ago', 'about %d days ago'), round($diff/(24*3600)));
1122 } else if ($diff < 46 * 24 * 3600) {
1123 // TRANS: Used in notices to indicate when the notice was made compared to now.
1124 return _('about a month ago');
1125 } else if ($diff < 330 * 24 * 3600) {
1126 // TRANS: Used in notices to indicate when the notice was made compared to now.
1127 return sprintf( ngettext('about one month ago', 'about %d months ago'), round($diff/(30*24*3600)));
1128 } else if ($diff < 480 * 24 * 3600) {
1129 // TRANS: Used in notices to indicate when the notice was made compared to now.
1130 return _('about a year ago');
1132 return common_exact_date($dt);
1136 function common_exact_date($dt)
1142 $_utc = new DateTimeZone('UTC');
1143 $_siteTz = new DateTimeZone(common_timezone());
1146 $dateStr = date('d F Y H:i:s', strtotime($dt));
1147 $d = new DateTime($dateStr, $_utc);
1148 $d->setTimezone($_siteTz);
1149 return $d->format(DATE_RFC850);
1152 function common_date_w3dtf($dt)
1154 $dateStr = date('d F Y H:i:s', strtotime($dt));
1155 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1156 $d->setTimezone(new DateTimeZone(common_timezone()));
1157 return $d->format(DATE_W3C);
1160 function common_date_rfc2822($dt)
1162 $dateStr = date('d F Y H:i:s', strtotime($dt));
1163 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1164 $d->setTimezone(new DateTimeZone(common_timezone()));
1165 return $d->format('r');
1168 function common_date_iso8601($dt)
1170 $dateStr = date('d F Y H:i:s', strtotime($dt));
1171 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1172 $d->setTimezone(new DateTimeZone(common_timezone()));
1173 return $d->format('c');
1176 function common_sql_now()
1178 return common_sql_date(time());
1181 function common_sql_date($datetime)
1183 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1187 * Return an SQL fragment to calculate an age-based weight from a given
1188 * timestamp or datetime column.
1190 * @param string $column name of field we're comparing against current time
1191 * @param integer $dropoff divisor for age in seconds before exponentiation
1192 * @return string SQL fragment
1194 function common_sql_weight($column, $dropoff)
1196 if (common_config('db', 'type') == 'pgsql') {
1197 // PostgreSQL doesn't support timestampdiff function.
1198 // @fixme will this use the right time zone?
1199 // @fixme does this handle cross-year subtraction correctly?
1200 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1202 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1206 function common_redirect($url, $code=307)
1208 static $status = array(301 => "Moved Permanently",
1211 307 => "Temporary Redirect");
1213 header('HTTP/1.1 '.$code.' '.$status[$code]);
1214 header("Location: $url");
1216 $xo = new XMLOutputter();
1218 '-//W3C//DTD XHTML 1.0 Strict//EN',
1219 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1220 $xo->element('a', array('href' => $url), $url);
1225 function common_broadcast_notice($notice, $remote=false)
1231 * Stick the notice on the queue.
1233 function common_enqueue_notice($notice)
1235 static $localTransports = array('omb',
1238 $transports = array();
1239 if (common_config('sms', 'enabled')) {
1240 $transports[] = 'sms';
1242 if (Event::hasHandler('HandleQueuedNotice')) {
1243 $transports[] = 'plugin';
1246 $xmpp = common_config('xmpp', 'enabled');
1249 $transports[] = 'jabber';
1252 // We can skip these for gatewayed notices.
1253 if ($notice->isLocal()) {
1254 $transports = array_merge($transports, $localTransports);
1256 $transports[] = 'public';
1260 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1262 $qm = QueueManager::get();
1264 foreach ($transports as $transport)
1266 $qm->enqueue($notice, $transport);
1269 Event::handle('EndEnqueueNotice', array($notice, $transports));
1276 * Broadcast profile updates to OMB and other remote subscribers.
1278 * Since this may be slow with a lot of subscribers or bad remote sites,
1279 * this is run through the background queues if possible.
1281 function common_broadcast_profile(Profile $profile)
1283 $qm = QueueManager::get();
1284 $qm->enqueue($profile, "profile");
1288 function common_profile_url($nickname)
1290 return common_local_url('showstream', array('nickname' => $nickname),
1295 * Should make up a reasonable root URL
1297 function common_root_url($ssl=false)
1299 $url = common_path('', $ssl, false);
1300 $i = strpos($url, '?');
1302 $url = substr($url, 0, $i);
1308 * returns $bytes bytes of random data as a hexadecimal string
1309 * "good" here is a goal and not a guarantee
1311 function common_good_rand($bytes)
1313 // XXX: use random.org...?
1314 if (@file_exists('/dev/urandom')) {
1315 return common_urandom($bytes);
1316 } else { // FIXME: this is probably not good enough
1317 return common_mtrand($bytes);
1321 function common_urandom($bytes)
1323 $h = fopen('/dev/urandom', 'rb');
1325 $src = fread($h, $bytes);
1328 for ($i = 0; $i < $bytes; $i++) {
1329 $enc .= sprintf("%02x", (ord($src[$i])));
1334 function common_mtrand($bytes)
1337 for ($i = 0; $i < $bytes; $i++) {
1338 $enc .= sprintf("%02x", mt_rand(0, 255));
1344 * Record the given URL as the return destination for a future
1345 * form submission, to be read by common_get_returnto().
1347 * @param string $url
1349 * @fixme as a session-global setting, this can allow multiple forms
1350 * to conflict and overwrite each others' returnto destinations if
1351 * the user has multiple tabs or windows open.
1353 * Should refactor to index with a token or otherwise only pass the
1354 * data along its intended path.
1356 function common_set_returnto($url)
1358 common_ensure_session();
1359 $_SESSION['returnto'] = $url;
1363 * Fetch a return-destination URL previously recorded by
1364 * common_set_returnto().
1366 * @return mixed URL string or null
1368 * @fixme as a session-global setting, this can allow multiple forms
1369 * to conflict and overwrite each others' returnto destinations if
1370 * the user has multiple tabs or windows open.
1372 * Should refactor to index with a token or otherwise only pass the
1373 * data along its intended path.
1375 function common_get_returnto()
1377 common_ensure_session();
1378 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1381 function common_timestamp()
1383 return date('YmdHis');
1386 function common_ensure_syslog()
1388 static $initialized = false;
1389 if (!$initialized) {
1390 openlog(common_config('syslog', 'appname'), 0,
1391 common_config('syslog', 'facility'));
1392 $initialized = true;
1396 function common_log_line($priority, $msg)
1398 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1399 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1400 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1403 function common_request_id()
1406 $server = common_config('site', 'server');
1407 if (php_sapi_name() == 'cli') {
1408 $script = basename($_SERVER['PHP_SELF']);
1409 return "$server:$script:$pid";
1411 static $req_id = null;
1412 if (!isset($req_id)) {
1413 $req_id = substr(md5(mt_rand()), 0, 8);
1415 if (isset($_SERVER['REQUEST_URI'])) {
1416 $url = $_SERVER['REQUEST_URI'];
1418 $method = $_SERVER['REQUEST_METHOD'];
1419 return "$server:$pid.$req_id $method $url";
1423 function common_log($priority, $msg, $filename=null)
1425 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1426 $msg = '[' . common_request_id() . '] ' . $msg;
1427 $logfile = common_config('site', 'logfile');
1429 $log = fopen($logfile, "a");
1431 $output = common_log_line($priority, $msg);
1432 fwrite($log, $output);
1436 common_ensure_syslog();
1437 syslog($priority, $msg);
1439 Event::handle('EndLog', array($priority, $msg, $filename));
1443 function common_debug($msg, $filename=null)
1446 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1448 common_log(LOG_DEBUG, $msg);
1452 function common_log_db_error(&$object, $verb, $filename=null)
1454 $objstr = common_log_objstring($object);
1455 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1456 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1459 function common_log_objstring(&$object)
1461 if (is_null($object)) {
1464 if (!($object instanceof DB_DataObject)) {
1467 $arr = $object->toArray();
1469 foreach ($arr as $k => $v) {
1470 if (is_object($v)) {
1471 $fields[] = "$k='".get_class($v)."'";
1473 $fields[] = "$k='$v'";
1476 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1480 function common_valid_http_url($url)
1482 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1485 function common_valid_tag($tag)
1487 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1488 return (Validate::email($matches[1]) ||
1489 preg_match('/^([\w-\.]+)$/', $matches[1]));
1495 * Determine if given domain or address literal is valid
1496 * eg for use in JIDs and URLs. Does not check if the domain
1499 * @param string $domain
1500 * @return boolean valid or not
1502 function common_valid_domain($domain)
1504 $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1505 $ipv4 = "(?:$octet(?:\.$octet){3})";
1506 if (preg_match("/^$ipv4$/u", $domain)) return true;
1508 $group = "(?:[0-9a-f]{1,4})";
1509 $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1511 if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1512 $before = explode(":", $matches[1]);
1513 $zeroes = $matches[2];
1514 $after = explode(":", $matches[3]);
1522 $explicit = count($before) + count($after);
1523 if ($explicit < $min || $explicit > $max) {
1530 require_once "Net/IDNA.php";
1531 $idn = Net_IDNA::getInstance();
1532 $domain = $idn->encode($domain);
1533 } catch (Exception $e) {
1537 $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1538 $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1540 return preg_match("/^$fqdn$/ui", $domain);
1543 /* Following functions are copied from MediaWiki GlobalFunctions.php
1544 * and written by Evan Prodromou. */
1546 function common_accept_to_prefs($accept, $def = '*/*')
1548 // No arg means accept anything (per HTTP spec)
1550 return array($def => 1);
1555 $parts = explode(',', $accept);
1557 foreach($parts as $part) {
1558 // FIXME: doesn't deal with params like 'text/html; level=1'
1559 @list($value, $qpart) = explode(';', trim($part));
1561 if(!isset($qpart)) {
1563 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1564 $prefs[$value] = $match[1];
1571 function common_mime_type_match($type, $avail)
1573 if(array_key_exists($type, $avail)) {
1576 $parts = explode('/', $type);
1577 if(array_key_exists($parts[0] . '/*', $avail)) {
1578 return $parts[0] . '/*';
1579 } elseif(array_key_exists('*/*', $avail)) {
1587 function common_negotiate_type($cprefs, $sprefs)
1591 foreach(array_keys($sprefs) as $type) {
1592 $parts = explode('/', $type);
1593 if($parts[1] != '*') {
1594 $ckey = common_mime_type_match($type, $cprefs);
1596 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1601 foreach(array_keys($cprefs) as $type) {
1602 $parts = explode('/', $type);
1603 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1604 $skey = common_mime_type_match($type, $sprefs);
1606 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1612 $besttype = 'text/html';
1614 foreach(array_keys($combine) as $type) {
1615 if($combine[$type] > $bestq) {
1617 $bestq = $combine[$type];
1621 if ('text/html' === $besttype) {
1622 return "text/html; charset=utf-8";
1627 function common_config($main, $sub)
1630 return (array_key_exists($main, $config) &&
1631 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1634 function common_copy_args($from)
1637 $strip = get_magic_quotes_gpc();
1638 foreach ($from as $k => $v) {
1641 $to[$k] = common_copy_args($v);
1643 $to[$k] = stripslashes($v);
1653 * Neutralise the evil effects of magic_quotes_gpc in the current request.
1654 * This is used before handing a request off to OAuthRequest::from_request.
1655 * @fixme Doesn't consider vars other than _POST and _GET?
1656 * @fixme Can't be undone and could corrupt data if run twice.
1658 function common_remove_magic_from_request()
1660 if(get_magic_quotes_gpc()) {
1661 $_POST=array_map('stripslashes',$_POST);
1662 $_GET=array_map('stripslashes',$_GET);
1666 function common_user_uri(&$user)
1668 return common_local_url('userbyid', array('id' => $user->id),
1672 function common_notice_uri(&$notice)
1674 return common_local_url('shownotice',
1675 array('notice' => $notice->id),
1679 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1681 function common_confirmation_code($bits)
1683 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1684 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1685 $chars = ceil($bits/5);
1687 for ($i = 0; $i < $chars; $i++) {
1688 // XXX: convert to string and back
1689 $num = hexdec(common_good_rand(1));
1690 // XXX: randomness is too precious to throw away almost
1691 // 40% of the bits we get!
1692 $code .= $codechars[$num%32];
1697 // convert markup to HTML
1699 function common_markup_to_html($c)
1701 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1702 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1703 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1704 return Markdown($c);
1707 function common_profile_uri($profile)
1712 $user = User::staticGet($profile->id);
1717 $remote = Remote_profile::staticGet($profile->id);
1719 return $remote->uri;
1721 // XXX: this is a very bad profile!
1725 function common_canonical_sms($sms)
1728 preg_replace('/\D/', '', $sms);
1732 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1737 case E_COMPILE_ERROR:
1741 case E_RECOVERABLE_ERROR:
1742 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1747 case E_COMPILE_WARNING:
1748 case E_CORE_WARNING:
1749 case E_USER_WARNING:
1750 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1755 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1760 case E_USER_DEPRECATED:
1761 // XXX: config variable to log this stuff, too
1765 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1770 // FIXME: show error page if we're on the Web
1771 /* Don't execute PHP internal error handler */
1775 function common_session_token()
1777 common_ensure_session();
1778 if (!array_key_exists('token', $_SESSION)) {
1779 $_SESSION['token'] = common_good_rand(64);
1781 return $_SESSION['token'];
1784 function common_cache_key($extra)
1786 return Cache::key($extra);
1789 function common_keyize($str)
1791 return Cache::keyize($str);
1794 function common_memcache()
1796 return Cache::instance();
1799 function common_license_terms($uri)
1801 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
1802 return explode('-',$matches[1]);
1807 function common_compatible_license($from, $to)
1809 $from_terms = common_license_terms($from);
1810 // public domain and cc-by are compatible with everything
1811 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
1814 $to_terms = common_license_terms($to);
1815 // sa is compatible across versions. IANAL
1816 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
1817 return count(array_diff($from_terms, $to_terms)) == 0;
1819 // XXX: better compatibility check needed here!
1820 // Should at least normalise URIs
1821 return ($from == $to);
1825 * returns a quoted table name, if required according to config
1827 function common_database_tablename($tablename)
1829 if(common_config('db','quote_identifiers')) {
1830 $tablename = '"'. $tablename .'"';
1832 //table prefixes could be added here later
1837 * Shorten a URL with the current user's configured shortening service,
1838 * or ur1.ca if configured, or not at all if no shortening is set up.
1839 * Length is not considered.
1841 * @param string $long_url
1842 * @return string may return the original URL if shortening failed
1844 * @fixme provide a way to specify a particular shortener
1845 * @fixme provide a way to specify to use a given user's shortening preferences
1847 function common_shorten_url($long_url)
1849 $long_url = trim($long_url);
1850 $user = common_current_user();
1852 // common current user does not find a user when called from the XMPP daemon
1853 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1854 $shortenerName = 'ur1.ca';
1856 $shortenerName = $user->urlshorteningservice;
1859 if(Event::handle('StartShortenUrl', array($long_url,$shortenerName,&$shortenedUrl))){
1860 //URL wasn't shortened, so return the long url
1863 //URL was shortened, so return the result
1864 return trim($shortenedUrl);
1869 * @return mixed array($proxy, $ip) for web requests; proxy may be null
1870 * null if not a web request
1872 * @fixme X-Forwarded-For can be chained by multiple proxies;
1873 we should parse the list and provide a cleaner array
1874 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
1875 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
1876 * use function to get exact request headers from Apache if possible.
1878 function common_client_ip()
1880 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1884 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1885 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1886 $proxy = $_SERVER['HTTP_CLIENT_IP'];
1888 $proxy = $_SERVER['REMOTE_ADDR'];
1890 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1893 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1894 $ip = $_SERVER['HTTP_CLIENT_IP'];
1896 $ip = $_SERVER['REMOTE_ADDR'];
1900 return array($proxy, $ip);
1903 function common_url_to_nickname($url)
1905 static $bad = array('query', 'user', 'password', 'port', 'fragment');
1907 $parts = parse_url($url);
1909 # If any of these parts exist, this won't work
1911 foreach ($bad as $badpart) {
1912 if (array_key_exists($badpart, $parts)) {
1917 # We just have host and/or path
1919 # If it's just a host...
1920 if (array_key_exists('host', $parts) &&
1921 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
1923 $hostparts = explode('.', $parts['host']);
1925 # Try to catch common idiom of nickname.service.tld
1927 if ((count($hostparts) > 2) &&
1928 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
1929 (strcmp($hostparts[0], 'www') != 0))
1931 return common_nicknamize($hostparts[0]);
1933 # Do the whole hostname
1934 return common_nicknamize($parts['host']);
1937 if (array_key_exists('path', $parts)) {
1938 # Strip starting, ending slashes
1939 $path = preg_replace('@/$@', '', $parts['path']);
1940 $path = preg_replace('@^/@', '', $path);
1941 $path = basename($path);
1943 // Hack for MediaWiki user pages, in the form:
1944 // http://example.com/wiki/User:Myname
1945 // ('User' may be localized.)
1946 if (strpos($path, ':')) {
1947 $parts = array_filter(explode(':', $path));
1948 $path = $parts[count($parts) - 1];
1952 return common_nicknamize($path);
1960 function common_nicknamize($str)
1962 $str = preg_replace('/\W/', '', $str);
1963 return strtolower($str);