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 $language = common_language();
62 $locale_set = common_init_locale($language);
63 setlocale(LC_CTYPE, 'C');
65 // So we don't have to make people install the gettext locales
66 $path = common_config('site','locale_path');
67 bindtextdomain("statusnet", $path);
68 bind_textdomain_codeset("statusnet", "UTF-8");
69 textdomain("statusnet");
72 common_log(LOG_INFO, 'Language requested:' . $language . ' - locale could not be set. Perhaps that system locale is not installed.', __FILE__);
76 function common_timezone()
78 if (common_logged_in()) {
79 $user = common_current_user();
80 if ($user->timezone) {
81 return $user->timezone;
85 return common_config('site', 'timezone');
88 function common_language()
91 // If there is a user logged in and they've set a language preference
92 // then return that one...
93 if (_have_config() && common_logged_in()) {
94 $user = common_current_user();
95 $user_language = $user->language;
97 return $user_language;
100 // Otherwise, find the best match for the languages requested by the
102 $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
103 if (!empty($httplang)) {
104 $language = client_prefered_language($httplang);
109 // Finally, if none of the above worked, use the site's default...
110 return common_config('site', 'language');
112 // salted, hashed passwords are stored in the DB
114 function common_munge_password($password, $id)
116 return md5($password . $id);
119 // check if a username exists and has matching password
120 function common_check_user($nickname, $password)
122 // NEVER allow blank passwords, even if they match the DB
123 if (mb_strlen($password) == 0) {
126 $user = User::staticGet('nickname', $nickname);
127 if (is_null($user) || $user === false) {
130 if (0 == strcmp(common_munge_password($password, $user->id),
139 // is the current user logged in?
140 function common_logged_in()
142 return (!is_null(common_current_user()));
145 function common_have_session()
147 return (0 != strcmp(session_id(), ''));
150 function common_ensure_session()
153 if (array_key_exists(session_name(), $_COOKIE)) {
154 $c = $_COOKIE[session_name()];
156 if (!common_have_session()) {
157 if (common_config('sessions', 'handle')) {
158 Session::setSaveHandler();
161 if (!isset($_SESSION['started'])) {
162 $_SESSION['started'] = time();
164 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
165 ' is set but started value is null');
171 // Three kinds of arguments:
176 // Initialize to false; set to null if none found
180 function common_set_user($user)
185 if (is_null($user) && common_have_session()) {
187 unset($_SESSION['userid']);
189 } else if (is_string($user)) {
191 $user = User::staticGet('nickname', $nickname);
192 } else if (!($user instanceof User)) {
197 common_ensure_session();
198 $_SESSION['userid'] = $user->id;
205 function common_set_cookie($key, $value, $expiration=0)
207 $path = common_config('site', 'path');
208 $server = common_config('site', 'server');
210 if ($path && ($path != '/')) {
211 $cookiepath = '/' . $path . '/';
215 return setcookie($key,
222 define('REMEMBERME', 'rememberme');
223 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
225 function common_rememberme($user=null)
228 $user = common_current_user();
230 common_debug('No current user to remember', __FILE__);
235 $rm = new Remember_me();
237 $rm->code = common_good_rand(16);
238 $rm->user_id = $user->id;
240 // Wrap the insert in some good ol' fashioned transaction code
244 $result = $rm->insert();
247 common_log_db_error($rm, 'INSERT', __FILE__);
248 common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
252 $rm->query('COMMIT');
254 common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
256 $cookieval = $rm->user_id . ':' . $rm->code;
258 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
260 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
265 function common_remembered_user()
270 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
276 list($id, $code) = explode(':', $packed);
278 if (!$id || !$code) {
279 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
284 $rm = Remember_me::staticGet($code);
287 common_log(LOG_WARNING, 'No such remember code: ' . $code);
292 if ($rm->user_id != $id) {
293 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
298 $user = User::staticGet($rm->user_id);
301 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
307 $result = $rm->delete();
310 common_log_db_error($rm, 'DELETE', __FILE__);
311 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
316 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
318 common_set_user($user);
319 common_real_login(false);
321 // We issue a new cookie, so they can log in
322 // automatically again after this session
324 common_rememberme($user);
329 // must be called with a valid user!
331 function common_forgetme()
333 common_set_cookie(REMEMBERME, '', 0);
336 // who is the current user?
337 function common_current_user()
341 if (!_have_config()) {
345 if ($_cur === false) {
347 if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
348 common_ensure_session();
349 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
351 $_cur = User::staticGet($id);
356 // that didn't work; try to remember; will init $_cur to null on failure
357 $_cur = common_remembered_user();
360 common_debug("Got User " . $_cur->nickname);
361 common_debug("Faking session on remembered user");
362 // XXX: Is this necessary?
363 $_SESSION['userid'] = $_cur->id;
370 // Logins that are 'remembered' aren't 'real' -- they're subject to
371 // cookie-stealing. So, we don't let them do certain things. New reg,
372 // OpenID, and password logins _are_ real.
374 function common_real_login($real=true)
376 common_ensure_session();
377 $_SESSION['real_login'] = $real;
380 function common_is_real_login()
382 return common_logged_in() && $_SESSION['real_login'];
385 // get canonical version of nickname for comparison
386 function common_canonical_nickname($nickname)
388 // XXX: UTF-8 canonicalization (like combining chars)
389 return strtolower($nickname);
392 // get canonical version of email for comparison
393 function common_canonical_email($email)
395 // XXX: canonicalize UTF-8
396 // XXX: lcase the domain part
400 function common_render_content($text, $notice)
402 $r = common_render_text($text);
403 $id = $notice->profile_id;
404 $r = preg_replace('/(^|\s+)@(['.NICKNAME_FMT.']{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
405 $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
406 $r = preg_replace('/(^|[\s\.\,\:\;]+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
407 $r = preg_replace('/(^|[\s\.\,\:\;]+)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
411 function common_render_text($text)
413 $r = htmlspecialchars($text);
415 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
416 $r = common_replace_urls_callback($r, 'common_linkify');
417 $r = preg_replace('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
422 function common_replace_urls_callback($text, $callback, $notice_id = null) {
423 // Start off with a regex
425 '(?:^|[\s\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
428 '(?:'. //Known protocols
430 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
432 '(?:(?:mailto|aim|tel|xmpp):)'.
434 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
437 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
439 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
443 '|(?:(?: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
445 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
447 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
448 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
449 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
450 '(?: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)'.
454 '(?:\:\d+)?'. //:port
455 '(?:/[\pN\pL$\[\]\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\"@]*)?'. // /path
456 '(?:\?[\pN\pL\$\[\]\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\"@\/]*)?'. // ?query string
457 '(?:\#[\pN\pL$\[\]\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\"\@/\?\#]*)?'. // #fragment
458 ')(?<![\?\.\,\#\,])'.
461 //preg_match_all($regex,$text,$matches);
463 return preg_replace_callback($regex, curry('callback_helper',$callback,$notice_id) ,$text);
466 function callback_helper($matches, $callback, $notice_id) {
468 $left = strpos($matches[0],$url);
469 $right = $left+strlen($url);
471 $groupSymbolSets=array(
485 $cannotEndWith=array('.','?',',','#');
489 foreach($groupSymbolSets as $groupSymbolSet){
490 if(substr($url,-1)==$groupSymbolSet['right']){
491 $group_left_count = substr_count($url,$groupSymbolSet['left']);
492 $group_right_count = substr_count($url,$groupSymbolSet['right']);
493 if($group_left_count<$group_right_count){
495 $url=substr($url,0,-1);
499 if(in_array(substr($url,-1),$cannotEndWith)){
501 $url=substr($url,0,-1);
503 }while($original_url!=$url);
505 if(empty($notice_id)){
506 $result = call_user_func_array($callback, array($url));
508 $result = call_user_func_array($callback, array(array($url,$notice_id)) );
510 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
513 function curry($fn) {
514 //TODO switch to a PHP 5.3 function closure based approach if PHP 5.3 is used
515 $args = func_get_args();
517 $id = uniqid('_partial');
518 $GLOBALS[$id] = array($fn, $args);
519 return create_function('',
520 '$args = func_get_args(); '.
521 'return call_user_func_array('.
522 '$GLOBALS["'.$id.'"][0],'.
525 '$GLOBALS["'.$id.'"][1]));');
528 function common_linkify($url) {
529 // It comes in special'd, so we unspecial it before passing to the stringifying
531 $url = htmlspecialchars_decode($url);
533 if(strpos($url, '@') !== false && strpos($url, ':') === false) {
534 //url is an email address without the mailto: protocol
535 $canon = "mailto:$url";
536 $longurl = "mailto:$url";
539 $canon = File_redirection::_canonUrl($url);
541 $longurl_data = File_redirection::where($canon);
542 if (is_array($longurl_data)) {
543 $longurl = $longurl_data['url'];
544 } elseif (is_string($longurl_data)) {
545 $longurl = $longurl_data;
547 throw new ServerException("Can't linkify url '$url'");
550 $attrs = array('href' => $canon, 'title' => $longurl, 'rel' => 'external');
552 $is_attachment = false;
553 $attachment_id = null;
556 // Check to see whether this is a known "attachment" URL.
558 $f = File::staticGet('url', $longurl);
561 // XXX: this writes to the database. :<
562 $f = File::processNew($longurl);
566 if ($f->isEnclosure()) {
567 $is_attachment = true;
568 $attachment_id = $f->id;
570 $foe = File_oembed::staticGet('file_id', $f->id);
572 // if it has OEmbed info, it's an attachment, too
573 $is_attachment = true;
574 $attachment_id = $f->id;
576 $thumb = File_thumbnail::staticGet('file_id', $f->id);
577 if (!empty($thumb)) {
585 if ($is_attachment) {
586 $attrs['class'] = 'attachment';
588 $attrs['class'] = 'attachment thumbnail';
590 $attrs['id'] = "attachment-{$attachment_id}";
593 return XMLStringer::estring('a', $attrs, $url);
596 function common_shorten_links($text)
598 $maxLength = Notice::maxContent();
599 if ($maxLength == 0 || mb_strlen($text) <= $maxLength) return $text;
600 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
603 function common_xml_safe_str($str)
605 // Neutralize control codes and surrogates
606 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
609 function common_tag_link($tag)
611 $canonical = common_canonical_tag($tag);
612 $url = common_local_url('tag', array('tag' => $canonical));
613 $xs = new XMLStringer();
614 $xs->elementStart('span', 'tag');
615 $xs->element('a', array('href' => $url,
618 $xs->elementEnd('span');
619 return $xs->getString();
622 function common_canonical_tag($tag)
624 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
625 return str_replace(array('-', '_', '.'), '', $tag);
628 function common_valid_profile_tag($str)
630 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
633 function common_at_link($sender_id, $nickname)
635 $sender = Profile::staticGet($sender_id);
636 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
638 $user = User::staticGet('id', $recipient->id);
640 $url = common_local_url('userbyid', array('id' => $user->id));
642 $url = $recipient->profileurl;
644 $xs = new XMLStringer(false);
645 $attrs = array('href' => $url,
647 if (!empty($recipient->fullname)) {
648 $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
650 $xs->elementStart('span', 'vcard');
651 $xs->elementStart('a', $attrs);
652 $xs->element('span', 'fn nickname', $nickname);
653 $xs->elementEnd('a');
654 $xs->elementEnd('span');
655 return $xs->getString();
661 function common_group_link($sender_id, $nickname)
663 $sender = Profile::staticGet($sender_id);
664 $group = User_group::getForNickname($nickname);
665 if ($group && $sender->isMember($group)) {
666 $attrs = array('href' => $group->permalink(),
668 if (!empty($group->fullname)) {
669 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
671 $xs = new XMLStringer();
672 $xs->elementStart('span', 'vcard');
673 $xs->elementStart('a', $attrs);
674 $xs->element('span', 'fn nickname', $nickname);
675 $xs->elementEnd('a');
676 $xs->elementEnd('span');
677 return $xs->getString();
683 function common_at_hash_link($sender_id, $tag)
685 $user = User::staticGet($sender_id);
689 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
691 $url = common_local_url('subscriptions',
692 array('nickname' => $user->nickname,
694 $xs = new XMLStringer();
695 $xs->elementStart('span', 'tag');
696 $xs->element('a', array('href' => $url,
699 $xs->elementEnd('span');
700 return $xs->getString();
706 function common_relative_profile($sender, $nickname, $dt=null)
708 // Try to find profiles this profile is subscribed to that have this nickname
709 $recipient = new Profile();
710 // XXX: use a join instead of a subquery
711 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
712 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
713 if ($recipient->find(true)) {
714 // XXX: should probably differentiate between profiles with
715 // the same name by date of most recent update
718 // Try to find profiles that listen to this profile and that have this nickname
719 $recipient = new Profile();
720 // XXX: use a join instead of a subquery
721 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
722 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
723 if ($recipient->find(true)) {
724 // XXX: should probably differentiate between profiles with
725 // the same name by date of most recent update
728 // If this is a local user, try to find a local user with that nickname.
729 $sender = User::staticGet($sender->id);
731 $recipient_user = User::staticGet('nickname', $nickname);
732 if ($recipient_user) {
733 return $recipient_user->getProfile();
736 // Otherwise, no links. @messages from local users to remote users,
737 // or from remote users to other remote users, are just
738 // outside our ability to make intelligent guesses about
742 function common_local_url($action, $args=null, $params=null, $fragment=null)
745 $path = $r->build($action, $args, $params, $fragment);
747 $ssl = common_is_sensitive($action);
749 if (common_config('site','fancy')) {
750 $url = common_path(mb_substr($path, 1), $ssl);
752 if (mb_strpos($path, '/index.php') === 0) {
753 $url = common_path(mb_substr($path, 1), $ssl);
755 $url = common_path('index.php'.$path, $ssl);
761 function common_is_sensitive($action)
763 static $sensitive = array('login', 'register', 'passwordsettings',
764 'twittersettings', 'api');
767 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
768 $ssl = in_array($action, $sensitive);
774 function common_path($relative, $ssl=false)
776 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
778 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
779 || common_config('site', 'ssl') === 'always') {
781 if (is_string(common_config('site', 'sslserver')) &&
782 mb_strlen(common_config('site', 'sslserver')) > 0) {
783 $serverpart = common_config('site', 'sslserver');
784 } else if (common_config('site', 'server')) {
785 $serverpart = common_config('site', 'server');
787 common_log(LOG_ERR, 'Site Sever not configured, unable to determine site name.');
791 if (common_config('site', 'server')) {
792 $serverpart = common_config('site', 'server');
794 common_log(LOG_ERR, 'Site Sever not configured, unable to determine site name.');
798 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
801 function common_date_string($dt)
803 // XXX: do some sexy date formatting
804 // return date(DATE_RFC822, $dt);
809 if ($now < $t) { // that shouldn't happen!
810 return common_exact_date($dt);
811 } else if ($diff < 60) {
812 return _('a few seconds ago');
813 } else if ($diff < 92) {
814 return _('about a minute ago');
815 } else if ($diff < 3300) {
816 return sprintf(_('about %d minutes ago'), round($diff/60));
817 } else if ($diff < 5400) {
818 return _('about an hour ago');
819 } else if ($diff < 22 * 3600) {
820 return sprintf(_('about %d hours ago'), round($diff/3600));
821 } else if ($diff < 37 * 3600) {
822 return _('about a day ago');
823 } else if ($diff < 24 * 24 * 3600) {
824 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
825 } else if ($diff < 46 * 24 * 3600) {
826 return _('about a month ago');
827 } else if ($diff < 330 * 24 * 3600) {
828 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
829 } else if ($diff < 480 * 24 * 3600) {
830 return _('about a year ago');
832 return common_exact_date($dt);
836 function common_exact_date($dt)
842 $_utc = new DateTimeZone('UTC');
843 $_siteTz = new DateTimeZone(common_timezone());
846 $dateStr = date('d F Y H:i:s', strtotime($dt));
847 $d = new DateTime($dateStr, $_utc);
848 $d->setTimezone($_siteTz);
849 return $d->format(DATE_RFC850);
852 function common_date_w3dtf($dt)
854 $dateStr = date('d F Y H:i:s', strtotime($dt));
855 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
856 $d->setTimezone(new DateTimeZone(common_timezone()));
857 return $d->format(DATE_W3C);
860 function common_date_rfc2822($dt)
862 $dateStr = date('d F Y H:i:s', strtotime($dt));
863 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
864 $d->setTimezone(new DateTimeZone(common_timezone()));
865 return $d->format('r');
868 function common_date_iso8601($dt)
870 $dateStr = date('d F Y H:i:s', strtotime($dt));
871 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
872 $d->setTimezone(new DateTimeZone(common_timezone()));
873 return $d->format('c');
876 function common_sql_now()
878 return common_sql_date(time());
881 function common_sql_date($datetime)
883 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
886 function common_redirect($url, $code=307)
888 static $status = array(301 => "Moved Permanently",
891 307 => "Temporary Redirect");
893 header('HTTP/1.1 '.$code.' '.$status[$code]);
894 header("Location: $url");
896 $xo = new XMLOutputter();
898 '-//W3C//DTD XHTML 1.0 Strict//EN',
899 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
900 $xo->element('a', array('href' => $url), $url);
905 function common_broadcast_notice($notice, $remote=false)
907 return common_enqueue_notice($notice);
910 // Stick the notice on the queue
912 function common_enqueue_notice($notice)
914 static $localTransports = array('omb',
917 static $allTransports = array('sms', 'plugin');
919 $transports = $allTransports;
921 $xmpp = common_config('xmpp', 'enabled');
924 $transports[] = 'jabber';
927 if ($notice->is_local == Notice::LOCAL_PUBLIC ||
928 $notice->is_local == Notice::LOCAL_NONPUBLIC) {
929 $transports = array_merge($transports, $localTransports);
931 $transports[] = 'public';
935 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
937 $qm = QueueManager::get();
939 foreach ($transports as $transport)
941 $qm->enqueue($notice, $transport);
944 Event::handle('EndEnqueueNotice', array($notice, $transports));
950 function common_broadcast_profile($profile)
952 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
953 require_once(INSTALLDIR.'/lib/omb.php');
954 omb_broadcast_profile($profile);
955 // XXX: Other broadcasts...?
959 function common_profile_url($nickname)
961 return common_local_url('showstream', array('nickname' => $nickname));
964 // Should make up a reasonable root URL
966 function common_root_url($ssl=false)
968 return common_path('', $ssl);
971 // returns $bytes bytes of random data as a hexadecimal string
972 // "good" here is a goal and not a guarantee
974 function common_good_rand($bytes)
976 // XXX: use random.org...?
977 if (@file_exists('/dev/urandom')) {
978 return common_urandom($bytes);
979 } else { // FIXME: this is probably not good enough
980 return common_mtrand($bytes);
984 function common_urandom($bytes)
986 $h = fopen('/dev/urandom', 'rb');
988 $src = fread($h, $bytes);
991 for ($i = 0; $i < $bytes; $i++) {
992 $enc .= sprintf("%02x", (ord($src[$i])));
997 function common_mtrand($bytes)
1000 for ($i = 0; $i < $bytes; $i++) {
1001 $enc .= sprintf("%02x", mt_rand(0, 255));
1006 function common_set_returnto($url)
1008 common_ensure_session();
1009 $_SESSION['returnto'] = $url;
1012 function common_get_returnto()
1014 common_ensure_session();
1015 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1018 function common_timestamp()
1020 return date('YmdHis');
1023 function common_ensure_syslog()
1025 static $initialized = false;
1026 if (!$initialized) {
1027 openlog(common_config('syslog', 'appname'), 0,
1028 common_config('syslog', 'facility'));
1029 $initialized = true;
1033 function common_log_line($priority, $msg)
1035 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1036 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1037 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1040 function common_log($priority, $msg, $filename=null)
1042 $logfile = common_config('site', 'logfile');
1044 $log = fopen($logfile, "a");
1046 $output = common_log_line($priority, $msg);
1047 fwrite($log, $output);
1051 common_ensure_syslog();
1052 syslog($priority, $msg);
1056 function common_debug($msg, $filename=null)
1059 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1061 common_log(LOG_DEBUG, $msg);
1065 function common_log_db_error(&$object, $verb, $filename=null)
1067 $objstr = common_log_objstring($object);
1068 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1069 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1072 function common_log_objstring(&$object)
1074 if (is_null($object)) {
1077 if (!($object instanceof DB_DataObject)) {
1080 $arr = $object->toArray();
1082 foreach ($arr as $k => $v) {
1083 $fields[] = "$k='$v'";
1085 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1089 function common_valid_http_url($url)
1091 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1094 function common_valid_tag($tag)
1096 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1097 return (Validate::email($matches[1]) ||
1098 preg_match('/^([\w-\.]+)$/', $matches[1]));
1103 /* Following functions are copied from MediaWiki GlobalFunctions.php
1104 * and written by Evan Prodromou. */
1106 function common_accept_to_prefs($accept, $def = '*/*')
1108 // No arg means accept anything (per HTTP spec)
1110 return array($def => 1);
1115 $parts = explode(',', $accept);
1117 foreach($parts as $part) {
1118 // FIXME: doesn't deal with params like 'text/html; level=1'
1119 @list($value, $qpart) = explode(';', trim($part));
1121 if(!isset($qpart)) {
1123 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1124 $prefs[$value] = $match[1];
1131 function common_mime_type_match($type, $avail)
1133 if(array_key_exists($type, $avail)) {
1136 $parts = explode('/', $type);
1137 if(array_key_exists($parts[0] . '/*', $avail)) {
1138 return $parts[0] . '/*';
1139 } elseif(array_key_exists('*/*', $avail)) {
1147 function common_negotiate_type($cprefs, $sprefs)
1151 foreach(array_keys($sprefs) as $type) {
1152 $parts = explode('/', $type);
1153 if($parts[1] != '*') {
1154 $ckey = common_mime_type_match($type, $cprefs);
1156 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1161 foreach(array_keys($cprefs) as $type) {
1162 $parts = explode('/', $type);
1163 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1164 $skey = common_mime_type_match($type, $sprefs);
1166 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1172 $besttype = 'text/html';
1174 foreach(array_keys($combine) as $type) {
1175 if($combine[$type] > $bestq) {
1177 $bestq = $combine[$type];
1181 if ('text/html' === $besttype) {
1182 return "text/html; charset=utf-8";
1187 function common_config($main, $sub)
1190 return (array_key_exists($main, $config) &&
1191 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1194 function common_copy_args($from)
1197 $strip = get_magic_quotes_gpc();
1198 foreach ($from as $k => $v) {
1199 $to[$k] = ($strip) ? stripslashes($v) : $v;
1204 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1205 // This is used before handing a request off to OAuthRequest::from_request.
1206 function common_remove_magic_from_request()
1208 if(get_magic_quotes_gpc()) {
1209 $_POST=array_map('stripslashes',$_POST);
1210 $_GET=array_map('stripslashes',$_GET);
1214 function common_user_uri(&$user)
1216 return common_local_url('userbyid', array('id' => $user->id));
1219 function common_notice_uri(&$notice)
1221 return common_local_url('shownotice',
1222 array('notice' => $notice->id));
1225 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1227 function common_confirmation_code($bits)
1229 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1230 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1231 $chars = ceil($bits/5);
1233 for ($i = 0; $i < $chars; $i++) {
1234 // XXX: convert to string and back
1235 $num = hexdec(common_good_rand(1));
1236 // XXX: randomness is too precious to throw away almost
1237 // 40% of the bits we get!
1238 $code .= $codechars[$num%32];
1243 // convert markup to HTML
1245 function common_markup_to_html($c)
1247 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1248 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1249 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1250 return Markdown($c);
1253 function common_profile_uri($profile)
1258 $user = User::staticGet($profile->id);
1263 $remote = Remote_profile::staticGet($profile->id);
1265 return $remote->uri;
1267 // XXX: this is a very bad profile!
1271 function common_canonical_sms($sms)
1274 preg_replace('/\D/', '', $sms);
1278 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1283 case E_COMPILE_ERROR:
1287 case E_RECOVERABLE_ERROR:
1288 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1293 case E_COMPILE_WARNING:
1294 case E_CORE_WARNING:
1295 case E_USER_WARNING:
1296 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1301 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1306 case E_USER_DEPRECATED:
1307 // XXX: config variable to log this stuff, too
1311 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1316 // FIXME: show error page if we're on the Web
1317 /* Don't execute PHP internal error handler */
1321 function common_session_token()
1323 common_ensure_session();
1324 if (!array_key_exists('token', $_SESSION)) {
1325 $_SESSION['token'] = common_good_rand(64);
1327 return $_SESSION['token'];
1330 function common_cache_key($extra)
1332 $base_key = common_config('memcached', 'base');
1334 if (empty($base_key)) {
1335 $base_key = common_keyize(common_config('site', 'name'));
1338 return 'statusnet:' . $base_key . ':' . $extra;
1341 function common_keyize($str)
1343 $str = strtolower($str);
1344 $str = preg_replace('/\s/', '_', $str);
1348 function common_memcache()
1350 static $cache = null;
1351 if (!common_config('memcached', 'enabled')) {
1355 $cache = new Memcache();
1356 $servers = common_config('memcached', 'server');
1357 if (is_array($servers)) {
1358 foreach($servers as $server) {
1359 $cache->addServer($server);
1362 $cache->addServer($servers);
1369 function common_compatible_license($from, $to)
1371 // XXX: better compatibility check needed here!
1372 return ($from == $to);
1376 * returns a quoted table name, if required according to config
1378 function common_database_tablename($tablename)
1381 if(common_config('db','quote_identifiers')) {
1382 $tablename = '"'. $tablename .'"';
1384 //table prefixes could be added here later
1388 function common_shorten_url($long_url)
1390 $user = common_current_user();
1392 // common current user does not find a user when called from the XMPP daemon
1393 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1396 $svc = $user->urlshorteningservice;
1398 global $_shorteners;
1399 if (!isset($_shorteners[$svc])) {
1400 //the user selected service doesn't exist, so default to ur1.ca
1403 if (!isset($_shorteners[$svc])) {
1404 // no shortener plugins installed.
1408 $reflectionObj = new ReflectionClass($_shorteners[$svc]['callInfo'][0]);
1409 $short_url_service = $reflectionObj->newInstanceArgs($_shorteners[$svc]['callInfo'][1]);
1410 $short_url = $short_url_service->shorten($long_url);
1415 function common_client_ip()
1417 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1421 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1422 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1423 $proxy = $_SERVER['HTTP_CLIENT_IP'];
1425 $proxy = $_SERVER['REMOTE_ADDR'];
1427 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1430 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1431 $ip = $_SERVER['HTTP_CLIENT_IP'];
1433 $ip = $_SERVER['REMOTE_ADDR'];
1437 return array($proxy, $ip);