3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008-2011, 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");
148 function common_timezone()
150 if (common_logged_in()) {
151 $user = common_current_user();
152 if ($user->timezone) {
153 return $user->timezone;
157 return common_config('site', 'timezone');
160 function common_valid_language($lang)
163 // Validate -- we don't want to end up with a bogus code
164 // left over from some old junk.
165 foreach (common_config('site', 'languages') as $code => $info) {
166 if ($info['lang'] == $lang) {
174 function common_language()
176 // Allow ?uselang=xx override, very useful for debugging
177 // and helping translators check usage and context.
178 if (isset($_GET['uselang'])) {
179 $uselang = strval($_GET['uselang']);
180 if (common_valid_language($uselang)) {
185 // If there is a user logged in and they've set a language preference
186 // then return that one...
187 if (_have_config() && common_logged_in()) {
188 $user = common_current_user();
190 if (common_valid_language($user->language)) {
191 return $user->language;
195 // Otherwise, find the best match for the languages requested by the
197 if (common_config('site', 'langdetect')) {
198 $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
199 if (!empty($httplang)) {
200 $language = client_prefered_language($httplang);
206 // Finally, if none of the above worked, use the site's default...
207 return common_config('site', 'language');
211 * Salted, hashed passwords are stored in the DB.
213 function common_munge_password($password, $id, Profile $profile=null)
217 if (Event::handle('StartHashPassword', array(&$hashed, $password, $profile))) {
218 Event::handle('EndHashPassword', array(&$hashed, $password, $profile));
220 if (empty($hashed)) {
221 throw new PasswordHashException();
228 * Check if a username exists and has matching password.
230 function common_check_user($nickname, $password)
232 // empty nickname always unacceptable
233 if (empty($nickname)) {
237 $authenticatedUser = false;
239 if (Event::handle('StartCheckPassword', array($nickname, $password, &$authenticatedUser))) {
241 if (common_is_email($nickname)) {
242 $user = User::getKV('email', common_canonical_email($nickname));
244 $user = User::getKV('nickname', Nickname::normalize($nickname));
248 if (!empty($password)) { // never allow login with blank password
249 if (0 == strcmp(common_munge_password($password, $user->id),
251 //internal checking passed
252 $authenticatedUser = $user;
256 Event::handle('EndCheckPassword', array($nickname, $password, $authenticatedUser));
259 return $authenticatedUser;
263 * Is the current user logged in?
265 function common_logged_in()
267 return (!is_null(common_current_user()));
270 function common_have_session()
272 return (0 != strcmp(session_id(), ''));
275 function common_ensure_session()
278 if (array_key_exists(session_name(), $_COOKIE)) {
279 $c = $_COOKIE[session_name()];
281 if (!common_have_session()) {
282 if (common_config('sessions', 'handle')) {
283 Session::setSaveHandler();
285 if (array_key_exists(session_name(), $_GET)) {
286 $id = $_GET[session_name()];
287 } else if (array_key_exists(session_name(), $_COOKIE)) {
288 $id = $_COOKIE[session_name()];
294 if (!isset($_SESSION['started'])) {
295 $_SESSION['started'] = time();
297 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
298 ' is set but started value is null');
304 // Three kinds of arguments:
309 // Initialize to false; set to null if none found
312 function common_set_user($user)
316 if (is_null($user) && common_have_session()) {
318 unset($_SESSION['userid']);
320 } else if (is_string($user)) {
322 $user = User::getKV('nickname', $nickname);
323 } else if (!($user instanceof User)) {
328 if (Event::handle('StartSetUser', array(&$user))) {
330 if (!$user->hasRight(Right::WEBLOGIN)) {
331 // TRANS: Authorisation exception thrown when a user a not allowed to login.
332 throw new AuthorizationException(_('Not allowed to log in.'));
334 common_ensure_session();
335 $_SESSION['userid'] = $user->id;
337 Event::handle('EndSetUser', array($user));
345 function common_set_cookie($key, $value, $expiration=0)
347 $path = common_config('site', 'path');
348 $server = common_config('site', 'server');
350 if ($path && ($path != '/')) {
351 $cookiepath = '/' . $path . '/';
355 return setcookie($key,
360 common_config('site', 'ssl')=='always');
363 define('REMEMBERME', 'rememberme');
364 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
366 function common_rememberme($user=null)
369 $user = common_current_user();
375 $rm = new Remember_me();
377 $rm->code = common_random_hexstr(16);
378 $rm->user_id = $user->id;
380 // Wrap the insert in some good ol' fashioned transaction code
384 $result = $rm->insert();
387 common_log_db_error($rm, 'INSERT', __FILE__);
391 $rm->query('COMMIT');
393 $cookieval = $rm->user_id . ':' . $rm->code;
395 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
397 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
402 function common_remembered_user()
406 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
412 list($id, $code) = explode(':', $packed);
414 if (!$id || !$code) {
415 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
420 $rm = Remember_me::getKV('code', $code);
423 common_log(LOG_WARNING, 'No such remember code: ' . $code);
428 if ($rm->user_id != $id) {
429 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
434 $user = User::getKV('id', $rm->user_id);
437 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
443 $result = $rm->delete();
446 common_log_db_error($rm, 'DELETE', __FILE__);
447 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
452 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
454 common_set_user($user);
455 common_real_login(false);
457 // We issue a new cookie, so they can log in
458 // automatically again after this session
460 common_rememberme($user);
466 * must be called with a valid user!
468 function common_forgetme()
470 common_set_cookie(REMEMBERME, '', 0);
474 * Who is the current user?
476 function common_current_user()
480 if (!_have_config()) {
484 if ($_cur === false) {
486 if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
487 || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
488 common_ensure_session();
489 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
491 $user = User::getKV($id);
499 // that didn't work; try to remember; will init $_cur to null on failure
500 $_cur = common_remembered_user();
503 // XXX: Is this necessary?
504 $_SESSION['userid'] = $_cur->id;
512 * Logins that are 'remembered' aren't 'real' -- they're subject to
513 * cookie-stealing. So, we don't let them do certain things. New reg,
514 * OpenID, and password logins _are_ real.
516 function common_real_login($real=true)
518 common_ensure_session();
519 $_SESSION['real_login'] = $real;
522 function common_is_real_login()
524 return common_logged_in() && $_SESSION['real_login'];
528 * Get a hash portion for HTTP caching Etags and such including
529 * info on the current user's session. If login/logout state changes,
530 * or we've changed accounts, or we've renamed the current user,
531 * we'll get a new hash value.
533 * This should not be considered secure information.
535 * @param User $user (optional; uses common_current_user() if left out)
538 function common_user_cache_hash($user=false)
540 if ($user === false) {
541 $user = common_current_user();
544 return crc32($user->id . ':' . $user->nickname);
551 * get canonical version of nickname for comparison
553 * @param string $nickname
556 * @throws NicknameException on invalid input
557 * @deprecated call Nickname::normalize() directly.
559 function common_canonical_nickname($nickname)
561 return Nickname::normalize($nickname);
565 * get canonical version of email for comparison
567 * @fixme actually normalize
568 * @fixme reject invalid input
570 * @param string $email
573 function common_canonical_email($email)
575 // XXX: canonicalize UTF-8
576 // XXX: lcase the domain part
581 * Partial notice markup rendering step: build links to !group references.
583 * @param string $text partially rendered HTML
584 * @param Notice $notice in whose context we're working
585 * @return string partially rendered HTML
587 function common_render_content($text, $notice)
589 $r = common_render_text($text);
590 $id = $notice->profile_id;
591 $r = common_linkify_mentions($r, $notice);
592 $r = preg_replace_callback('/(^|[\s\.\,\:\;]+)!(' . Nickname::DISPLAY_FMT . ')/',
593 function ($m) { return "{$m[1]}!".common_group_link($id, $m[2]); }, $r);
598 * Finds @-mentions within the partially-rendered text section and
599 * turns them into live links.
601 * Should generally not be called except from common_render_content().
603 * @param string $text partially-rendered HTML
604 * @param Notice $notice in-progress or complete Notice object for context
605 * @return string partially-rendered HTML
607 function common_linkify_mentions($text, $notice)
609 $mentions = common_find_mentions($text, $notice);
611 // We need to go through in reverse order by position,
612 // so our positions stay valid despite our fudging with the
617 foreach ($mentions as $mention)
619 $points[$mention['position']] = $mention;
624 foreach ($points as $position => $mention) {
626 $linkText = common_linkify_mention($mention);
628 $text = substr_replace($text, $linkText, $position, mb_strlen($mention['text']));
634 function common_linkify_mention($mention)
638 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
640 $xs = new XMLStringer(false);
642 $attrs = array('href' => $mention['url'],
645 if (!empty($mention['title'])) {
646 $attrs['title'] = $mention['title'];
649 $xs->elementStart('span', 'vcard');
650 $xs->elementStart('a', $attrs);
651 $xs->element('span', 'fn nickname mention', $mention['text']);
652 $xs->elementEnd('a');
653 $xs->elementEnd('span');
655 $output = $xs->getString();
657 Event::handle('EndLinkifyMention', array($mention, &$output));
664 * Find @-mentions in the given text, using the given notice object as context.
665 * References will be resolved with common_relative_profile() against the user
666 * who posted the notice.
668 * Note the return data format is internal, to be used for building links and
669 * such. Should not be used directly; rather, call common_linkify_mentions().
671 * @param string $text
672 * @param Notice $notice notice in whose context we're building links
678 function common_find_mentions($text, $notice)
682 $sender = Profile::getKV('id', $notice->profile_id);
684 if (empty($sender)) {
688 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
689 // Get the context of the original notice, if any
690 $originalAuthor = null;
691 $originalNotice = null;
692 $originalMentions = array();
696 if (!empty($notice) && !empty($notice->reply_to)) {
697 $originalNotice = Notice::getKV('id', $notice->reply_to);
698 if (!empty($originalNotice)) {
699 $originalAuthor = Profile::getKV('id', $originalNotice->profile_id);
701 $ids = $originalNotice->getReplies();
703 foreach ($ids as $id) {
704 $repliedTo = Profile::getKV('id', $id);
705 if (!empty($repliedTo)) {
706 $originalMentions[$repliedTo->nickname] = $repliedTo;
712 $matches = common_find_mentions_raw($text);
714 foreach ($matches as $match) {
716 $nickname = Nickname::normalize($match[0]);
717 } catch (NicknameException $e) {
718 // Bogus match? Drop it.
722 // Try to get a profile for this nickname.
723 // Start with conversation context, then go to
726 if (!empty($originalAuthor) && $originalAuthor->nickname == $nickname) {
727 $mentioned = $originalAuthor;
728 } else if (!empty($originalMentions) &&
729 array_key_exists($nickname, $originalMentions)) {
730 $mentioned = $originalMentions[$nickname];
732 $mentioned = common_relative_profile($sender, $nickname);
735 if (!empty($mentioned)) {
736 $user = User::getKV('id', $mentioned->id);
739 $url = common_local_url('userbyid', array('id' => $user->id));
741 $url = $mentioned->profileurl;
744 $mention = array('mentioned' => array($mentioned),
746 'position' => $match[1],
749 if (!empty($mentioned->fullname)) {
750 $mention['title'] = $mentioned->fullname;
753 $mentions[] = $mention;
757 // @#tag => mention of all subscriptions tagged 'tag'
759 preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
762 PREG_OFFSET_CAPTURE);
764 foreach ($hmatches[1] as $hmatch) {
766 $tag = common_canonical_tag($hmatch[0]);
767 $plist = Profile_list::getByTaggerAndTag($sender->id, $tag);
768 if (!empty($plist) && !$plist->private) {
769 $tagged = $sender->getTaggedSubscribers($tag);
771 $url = common_local_url('showprofiletag',
772 array('tagger' => $sender->nickname,
775 $mentions[] = array('mentioned' => $tagged,
776 'text' => $hmatch[0],
777 'position' => $hmatch[1],
782 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
789 * Does the actual regex pulls to find @-mentions in text.
790 * Should generally not be called directly; for use in common_find_mentions.
792 * @param string $text
793 * @return array of PCRE match arrays
795 function common_find_mentions_raw($text)
798 preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
801 PREG_OFFSET_CAPTURE);
803 $atmatches = array();
804 preg_match_all('/(?:^|\s+)@(' . Nickname::DISPLAY_FMT . ')\b/',
807 PREG_OFFSET_CAPTURE);
809 $matches = array_merge($tmatches[1], $atmatches[1]);
813 function common_render_text($text)
815 $r = htmlspecialchars($text);
817 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
818 $r = common_replace_urls_callback($r, 'common_linkify');
819 $r = preg_replace_callback('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
820 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $r);
826 * Find links in the given text and pass them to the given callback function.
828 * @param string $text
829 * @param function($text, $arg) $callback: return replacement text
830 * @param mixed $arg: optional argument will be passed on to the callback
832 function common_replace_urls_callback($text, $callback, $arg = null) {
833 // Start off with a regex
835 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
838 '(?:'. //Known protocols
840 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
842 '(?:(?:mailto|aim|tel|xmpp):)'.
844 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
847 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
849 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
853 '|(?:(?: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
855 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
857 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
858 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
859 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
860 '(?: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)'.
864 '(?:\:\d+)?'. //:port
865 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
866 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
867 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
868 ')(?<![\?\.\,\#\,])'.
871 //preg_match_all($regex,$text,$matches);
873 return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
877 * Intermediate callback for common_replace_links(), helps resolve some
878 * ambiguous link forms before passing on to the final callback.
880 * @param array $matches
881 * @param callable $callback
882 * @param mixed $arg optional argument to pass on as second param to callback
887 function callback_helper($matches, $callback, $arg=null) {
889 $left = strpos($matches[0],$url);
890 $right = $left+strlen($url);
892 $groupSymbolSets=array(
910 $cannotEndWith=array('.','?',',','#');
914 foreach($groupSymbolSets as $groupSymbolSet){
915 if(substr($url,-1)==$groupSymbolSet['right']){
916 $group_left_count = substr_count($url,$groupSymbolSet['left']);
917 $group_right_count = substr_count($url,$groupSymbolSet['right']);
918 if($group_left_count<$group_right_count){
920 $url=substr($url,0,-1);
924 if(in_array(substr($url,-1),$cannotEndWith)){
926 $url=substr($url,0,-1);
928 }while($original_url!=$url);
930 $result = call_user_func_array($callback, array($url, $arg));
931 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
934 if (version_compare(PHP_VERSION, '5.3.0', 'ge')) {
935 // lambda implementation in a separate file; PHP 5.2 won't parse it.
936 require_once INSTALLDIR . "/lib/curry.php";
938 function curry($fn) {
939 $args = func_get_args();
941 $id = uniqid('_partial');
942 $GLOBALS[$id] = array($fn, $args);
943 return create_function('',
944 '$args = func_get_args(); '.
945 'return call_user_func_array('.
946 '$GLOBALS["'.$id.'"][0],'.
949 '$GLOBALS["'.$id.'"][1]));');
953 function common_linkify($url) {
954 // It comes in special'd, so we unspecial it before passing to the stringifying
956 $url = htmlspecialchars_decode($url);
958 if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
959 //url is an email address without the mailto: protocol
960 $canon = "mailto:$url";
961 $longurl = "mailto:$url";
964 $canon = File_redirection::_canonUrl($url);
966 $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
967 if (is_array($longurl_data)) {
968 $longurl = $longurl_data['url'];
969 } elseif (is_string($longurl_data)) {
970 $longurl = $longurl_data;
972 // Unable to reach the server to verify contents, etc
973 // Just pass the link on through for now.
974 common_log(LOG_ERR, "Can't linkify url '$url'");
979 $attrs = array('href' => $canon, 'title' => $longurl);
981 $is_attachment = false;
982 $attachment_id = null;
985 // Check to see whether this is a known "attachment" URL.
987 $f = File::getKV('url', $longurl);
990 if (common_config('attachments', 'process_links')) {
991 // XXX: this writes to the database. :<
992 $f = File::processNew($longurl);
997 if ($f->getEnclosure()) {
998 $is_attachment = true;
999 $attachment_id = $f->id;
1001 $thumb = File_thumbnail::getKV('file_id', $f->id);
1002 if (!empty($thumb)) {
1009 if ($is_attachment) {
1010 $attrs['class'] = 'attachment';
1012 $attrs['class'] = 'attachment thumbnail';
1014 $attrs['id'] = "attachment-{$attachment_id}";
1017 // Whether to nofollow
1019 $nf = common_config('nofollow', 'external');
1021 if ($nf == 'never') {
1022 $attrs['rel'] = 'external';
1024 $attrs['rel'] = 'nofollow external';
1027 return XMLStringer::estring('a', $attrs, $url);
1031 * Find and shorten links in a given chunk of text if it's longer than the
1032 * configured notice content limit (or unconditionally).
1034 * Side effects: may save file and file_redirection records for referenced URLs.
1036 * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1037 * user's options are used; otherwise the current web session user's setitngs
1038 * will be used or ur1.ca if there is no active web login.
1040 * @param string $text
1041 * @param boolean $always (optional)
1042 * @param User $user (optional)
1046 function common_shorten_links($text, $always = false, User $user=null)
1048 if ($user === null) {
1049 $user = common_current_user();
1052 $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1054 if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1055 return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1057 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1062 * Very basic stripping of invalid UTF-8 input text.
1064 * @param string $str
1065 * @return mixed string or null if invalid input
1067 * @todo ideally we should drop bad chars, and maybe do some of the checks
1068 * from common_xml_safe_str. But we can't strip newlines, etc.
1069 * @todo Unicode normalization might also be useful, but not needed now.
1071 function common_validate_utf8($str)
1073 // preg_replace will return NULL on invalid UTF-8 input.
1075 // Note: empty regex //u also caused NULL return on some
1076 // production machines, but none of our test machines.
1078 // This should be replaced with a more reliable check.
1079 return preg_replace('/\x00/u', '', $str);
1083 * Make sure an arbitrary string is safe for output in XML as a single line.
1085 * @param string $str
1088 function common_xml_safe_str($str)
1090 // Replace common eol and extra whitespace input chars
1095 "\0", // null byte eos
1096 "\x0B" // vertical tab
1099 $replacement = array(
1100 ' ', // single space
1107 $str = str_replace($unWelcome, $replacement, $str);
1109 // Neutralize any additional control codes and UTF-16 surrogates
1110 // (Twitter uses '*')
1111 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1114 function common_tag_link($tag)
1116 $canonical = common_canonical_tag($tag);
1117 if (common_config('singleuser', 'enabled')) {
1118 // regular TagAction isn't set up in 1user mode
1119 $nickname = User::singleUserNickname();
1120 $url = common_local_url('showstream',
1121 array('nickname' => $nickname,
1122 'tag' => $canonical));
1124 $url = common_local_url('tag', array('tag' => $canonical));
1126 $xs = new XMLStringer();
1127 $xs->elementStart('span', 'tag');
1128 $xs->element('a', array('href' => $url,
1131 $xs->elementEnd('span');
1132 return $xs->getString();
1135 function common_canonical_tag($tag)
1138 $tag = preg_replace('/[^\pL\pN]/u', '', $tag);
1139 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
1140 $tag = substr($tag, 0, 64);
1144 function common_valid_profile_tag($str)
1146 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1151 * @param <type> $sender_id
1152 * @param <type> $nickname
1156 function common_group_link($sender_id, $nickname)
1158 $sender = Profile::getKV($sender_id);
1159 $group = User_group::getForNickname($nickname, $sender);
1160 if ($sender && $group && $sender->isMember($group)) {
1161 $attrs = array('href' => $group->permalink(),
1163 if (!empty($group->fullname)) {
1164 $attrs['title'] = $group->getFancyName();
1166 $xs = new XMLStringer();
1167 $xs->elementStart('span', 'vcard');
1168 $xs->elementStart('a', $attrs);
1169 $xs->element('span', 'fn nickname group', $nickname);
1170 $xs->elementEnd('a');
1171 $xs->elementEnd('span');
1172 return $xs->getString();
1179 * Resolve an ambiguous profile nickname reference, checking in following order:
1180 * - profiles that $sender subscribes to
1181 * - profiles that subscribe to $sender
1182 * - local user profiles
1184 * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1185 * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1188 * @fixme validate input
1190 * @fixme fix or remove mystery third parameter
1191 * @fixme is $sender a User or Profile?
1193 * @param <type> $sender the user or profile in whose context we're looking
1194 * @param string $nickname validated nickname of
1195 * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1197 * @return Profile or null
1199 function common_relative_profile($sender, $nickname, $dt=null)
1201 // Will throw exception on invalid input.
1202 $nickname = Nickname::normalize($nickname);
1204 // Try to find profiles this profile is subscribed to that have this nickname
1205 $recipient = new Profile();
1206 // XXX: use a join instead of a subquery
1207 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1208 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1209 if ($recipient->find(true)) {
1210 // XXX: should probably differentiate between profiles with
1211 // the same name by date of most recent update
1214 // Try to find profiles that listen to this profile and that have this nickname
1215 $recipient = new Profile();
1216 // XXX: use a join instead of a subquery
1217 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1218 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1219 if ($recipient->find(true)) {
1220 // XXX: should probably differentiate between profiles with
1221 // the same name by date of most recent update
1224 // If this is a local user, try to find a local user with that nickname.
1225 $sender = User::getKV($sender->id);
1227 $recipient_user = User::getKV('nickname', $nickname);
1228 if ($recipient_user) {
1229 return $recipient_user->getProfile();
1232 // Otherwise, no links. @messages from local users to remote users,
1233 // or from remote users to other remote users, are just
1234 // outside our ability to make intelligent guesses about
1238 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1240 if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1242 $path = $r->build($action, $args, $params, $fragment);
1244 $ssl = common_config('site', 'ssl') === 'always'
1245 || StatusNet::isHTTPS()
1246 || common_is_sensitive($action);
1248 if (common_config('site','fancy')) {
1249 $url = common_path($path, $ssl, $addSession);
1251 if (mb_strpos($path, '/index.php') === 0) {
1252 $url = common_path($path, $ssl, $addSession);
1254 $url = common_path('index.php/'.$path, $ssl, $addSession);
1257 Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1262 function common_is_sensitive($action)
1264 static $sensitive = array(
1269 'ApiOAuthRequestToken',
1270 'ApiOAuthAccessToken',
1271 'ApiOAuthAuthorize',
1277 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1278 $ssl = in_array($action, $sensitive);
1284 function common_path($relative, $ssl=false, $addSession=true)
1286 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1288 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1289 || common_config('site', 'ssl') === 'always') {
1291 if (is_string(common_config('site', 'sslserver')) &&
1292 mb_strlen(common_config('site', 'sslserver')) > 0) {
1293 $serverpart = common_config('site', 'sslserver');
1294 } else if (common_config('site', 'server')) {
1295 $serverpart = common_config('site', 'server');
1297 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1301 if (common_config('site', 'server')) {
1302 $serverpart = common_config('site', 'server');
1304 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1309 $relative = common_inject_session($relative, $serverpart);
1312 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1315 function common_inject_session($url, $serverpart = null)
1317 if (common_have_session()) {
1319 if (empty($serverpart)) {
1320 $serverpart = parse_url($url, PHP_URL_HOST);
1323 $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1325 // Are we pointing to another server (like an SSL server?)
1327 if (!empty($currentServer) &&
1328 0 != strcasecmp($currentServer, $serverpart)) {
1329 // Pass the session ID as a GET parameter
1330 $sesspart = session_name() . '=' . session_id();
1331 $i = strpos($url, '?');
1332 if ($i === false) { // no GET params, just append
1333 $url .= '?' . $sesspart;
1335 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1343 function common_date_string($dt)
1345 // XXX: do some sexy date formatting
1346 // return date(DATE_RFC822, $dt);
1347 $t = strtotime($dt);
1351 if ($now < $t) { // that shouldn't happen!
1352 return common_exact_date($dt);
1353 } else if ($diff < 60) {
1354 // TRANS: Used in notices to indicate when the notice was made compared to now.
1355 return _('a few seconds ago');
1356 } else if ($diff < 92) {
1357 // TRANS: Used in notices to indicate when the notice was made compared to now.
1358 return _('about a minute ago');
1359 } else if ($diff < 3300) {
1360 $minutes = round($diff/60);
1361 // TRANS: Used in notices to indicate when the notice was made compared to now.
1362 return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1363 } else if ($diff < 5400) {
1364 // TRANS: Used in notices to indicate when the notice was made compared to now.
1365 return _('about an hour ago');
1366 } else if ($diff < 22 * 3600) {
1367 $hours = round($diff/3600);
1368 // TRANS: Used in notices to indicate when the notice was made compared to now.
1369 return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1370 } else if ($diff < 37 * 3600) {
1371 // TRANS: Used in notices to indicate when the notice was made compared to now.
1372 return _('about a day ago');
1373 } else if ($diff < 24 * 24 * 3600) {
1374 $days = round($diff/(24*3600));
1375 // TRANS: Used in notices to indicate when the notice was made compared to now.
1376 return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1377 } else if ($diff < 46 * 24 * 3600) {
1378 // TRANS: Used in notices to indicate when the notice was made compared to now.
1379 return _('about a month ago');
1380 } else if ($diff < 330 * 24 * 3600) {
1381 $months = round($diff/(30*24*3600));
1382 // TRANS: Used in notices to indicate when the notice was made compared to now.
1383 return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1384 } else if ($diff < 480 * 24 * 3600) {
1385 // TRANS: Used in notices to indicate when the notice was made compared to now.
1386 return _('about a year ago');
1388 return common_exact_date($dt);
1392 function common_exact_date($dt)
1398 $_utc = new DateTimeZone('UTC');
1399 $_siteTz = new DateTimeZone(common_timezone());
1402 $dateStr = date('d F Y H:i:s', strtotime($dt));
1403 $d = new DateTime($dateStr, $_utc);
1404 $d->setTimezone($_siteTz);
1405 return $d->format(DATE_RFC850);
1408 function common_date_w3dtf($dt)
1410 $dateStr = date('d F Y H:i:s', strtotime($dt));
1411 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1412 $d->setTimezone(new DateTimeZone(common_timezone()));
1413 return $d->format(DATE_W3C);
1416 function common_date_rfc2822($dt)
1418 $dateStr = date('d F Y H:i:s', strtotime($dt));
1419 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1420 $d->setTimezone(new DateTimeZone(common_timezone()));
1421 return $d->format('r');
1424 function common_date_iso8601($dt)
1426 $dateStr = date('d F Y H:i:s', strtotime($dt));
1427 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1428 $d->setTimezone(new DateTimeZone(common_timezone()));
1429 return $d->format('c');
1432 function common_sql_now()
1434 return common_sql_date(time());
1437 function common_sql_date($datetime)
1439 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1443 * Return an SQL fragment to calculate an age-based weight from a given
1444 * timestamp or datetime column.
1446 * @param string $column name of field we're comparing against current time
1447 * @param integer $dropoff divisor for age in seconds before exponentiation
1448 * @return string SQL fragment
1450 function common_sql_weight($column, $dropoff)
1452 if (common_config('db', 'type') == 'pgsql') {
1453 // PostgreSQL doesn't support timestampdiff function.
1454 // @fixme will this use the right time zone?
1455 // @fixme does this handle cross-year subtraction correctly?
1456 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1458 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1462 function common_redirect($url, $code=307)
1464 static $status = array(301 => "Moved Permanently",
1467 307 => "Temporary Redirect");
1469 header('HTTP/1.1 '.$code.' '.$status[$code]);
1470 header("Location: $url");
1471 header("Connection: close");
1473 $xo = new XMLOutputter();
1475 '-//W3C//DTD XHTML 1.0 Strict//EN',
1476 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1477 $xo->element('a', array('href' => $url), $url);
1482 // Stick the notice on the queue
1484 function common_enqueue_notice($notice)
1486 static $localTransports = array('ping');
1488 $transports = array();
1489 if (common_config('sms', 'enabled')) {
1490 $transports[] = 'sms';
1492 if (Event::hasHandler('HandleQueuedNotice')) {
1493 $transports[] = 'plugin';
1496 // We can skip these for gatewayed notices.
1497 if ($notice->isLocal()) {
1498 $transports = array_merge($transports, $localTransports);
1501 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1503 $qm = QueueManager::get();
1505 foreach ($transports as $transport)
1507 $qm->enqueue($notice, $transport);
1510 Event::handle('EndEnqueueNotice', array($notice, $transports));
1517 * Legacy function to broadcast profile updates to OMB remote subscribers.
1519 * XXX: This probably needs killing, but there are several bits of code
1520 * that broadcast profile changes that need to be dealt with. AFAIK
1521 * this function is only used for OMB. -z
1523 * Since this may be slow with a lot of subscribers or bad remote sites,
1524 * this is run through the background queues if possible.
1526 function common_broadcast_profile(Profile $profile)
1528 Event::handle('BroadcastProfile', array($profile));
1531 function common_profile_url($nickname)
1533 return common_local_url('showstream', array('nickname' => $nickname),
1538 * Should make up a reasonable root URL
1540 function common_root_url($ssl=false)
1542 $url = common_path('', $ssl, false);
1543 $i = strpos($url, '?');
1545 $url = substr($url, 0, $i);
1551 * returns $bytes bytes of random data as a hexadecimal string
1553 function common_random_hexstr($bytes)
1555 $str = @file_exists('/dev/urandom')
1556 ? common_urandom($bytes)
1557 : common_mtrand($bytes);
1560 for ($i = 0; $i < $bytes; $i++) {
1561 $hexstr .= sprintf("%02x", ord($str{$i}));
1566 function common_urandom($bytes)
1568 $h = fopen('/dev/urandom', 'rb');
1570 $src = fread($h, $bytes);
1575 function common_mtrand($bytes)
1578 for ($i = 0; $i < $bytes; $i++) {
1579 $str .= chr(mt_rand(0, 255));
1585 * Record the given URL as the return destination for a future
1586 * form submission, to be read by common_get_returnto().
1588 * @param string $url
1590 * @fixme as a session-global setting, this can allow multiple forms
1591 * to conflict and overwrite each others' returnto destinations if
1592 * the user has multiple tabs or windows open.
1594 * Should refactor to index with a token or otherwise only pass the
1595 * data along its intended path.
1597 function common_set_returnto($url)
1599 common_ensure_session();
1600 $_SESSION['returnto'] = $url;
1604 * Fetch a return-destination URL previously recorded by
1605 * common_set_returnto().
1607 * @return mixed URL string or null
1609 * @fixme as a session-global setting, this can allow multiple forms
1610 * to conflict and overwrite each others' returnto destinations if
1611 * the user has multiple tabs or windows open.
1613 * Should refactor to index with a token or otherwise only pass the
1614 * data along its intended path.
1616 function common_get_returnto()
1618 common_ensure_session();
1619 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1622 function common_timestamp()
1624 return date('YmdHis');
1627 function common_ensure_syslog()
1629 static $initialized = false;
1630 if (!$initialized) {
1631 openlog(common_config('syslog', 'appname'), 0,
1632 common_config('syslog', 'facility'));
1633 $initialized = true;
1637 function common_log_line($priority, $msg)
1639 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1640 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1641 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1644 function common_request_id()
1647 $server = common_config('site', 'server');
1648 if (php_sapi_name() == 'cli') {
1649 $script = basename($_SERVER['PHP_SELF']);
1650 return "$server:$script:$pid";
1652 static $req_id = null;
1653 if (!isset($req_id)) {
1654 $req_id = substr(md5(mt_rand()), 0, 8);
1656 if (isset($_SERVER['REQUEST_URI'])) {
1657 $url = $_SERVER['REQUEST_URI'];
1659 $method = $_SERVER['REQUEST_METHOD'];
1660 return "$server:$pid.$req_id $method $url";
1664 function common_log($priority, $msg, $filename=null)
1666 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1667 $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1668 $msg = '[' . common_request_id() . '] ' . $msg;
1669 $logfile = common_config('site', 'logfile');
1671 $log = fopen($logfile, "a");
1673 $output = common_log_line($priority, $msg);
1674 fwrite($log, $output);
1678 common_ensure_syslog();
1679 syslog($priority, $msg);
1681 Event::handle('EndLog', array($priority, $msg, $filename));
1685 function common_debug($msg, $filename=null)
1688 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1690 common_log(LOG_DEBUG, $msg);
1694 function common_log_db_error(&$object, $verb, $filename=null)
1696 $objstr = common_log_objstring($object);
1697 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1698 if (is_object($last_error)) {
1699 $msg = $last_error->message;
1701 $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1703 common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1706 function common_log_objstring(&$object)
1708 if (is_null($object)) {
1711 if (!($object instanceof DB_DataObject)) {
1714 $arr = $object->toArray();
1716 foreach ($arr as $k => $v) {
1717 if (is_object($v)) {
1718 $fields[] = "$k='".get_class($v)."'";
1720 $fields[] = "$k='$v'";
1723 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1727 function common_valid_http_url($url, $secure=false)
1729 // If $secure is true, only allow https URLs to pass
1730 // (if false, we use '?' in 'https?' to say the 's' is optional)
1731 $regex = $secure ? '/^https$/' : '/^https?$/';
1732 return filter_var($url, FILTER_VALIDATE_URL)
1733 && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1736 function common_valid_tag($tag)
1738 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1739 return (Validate::email($matches[1]) ||
1740 preg_match('/^([\w-\.]+)$/', $matches[1]));
1746 * Determine if given domain or address literal is valid
1747 * eg for use in JIDs and URLs. Does not check if the domain
1750 * @param string $domain
1751 * @return boolean valid or not
1753 function common_valid_domain($domain)
1755 $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1756 $ipv4 = "(?:$octet(?:\.$octet){3})";
1757 if (preg_match("/^$ipv4$/u", $domain)) return true;
1759 $group = "(?:[0-9a-f]{1,4})";
1760 $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1762 if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1763 $before = explode(":", $matches[1]);
1764 $zeroes = $matches[2];
1765 $after = explode(":", $matches[3]);
1773 $explicit = count($before) + count($after);
1774 if ($explicit < $min || $explicit > $max) {
1781 require_once "Net/IDNA.php";
1782 $idn = Net_IDNA::getInstance();
1783 $domain = $idn->encode($domain);
1784 } catch (Exception $e) {
1788 $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1789 $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1791 return preg_match("/^$fqdn$/ui", $domain);
1794 /* Following functions are copied from MediaWiki GlobalFunctions.php
1795 * and written by Evan Prodromou. */
1797 function common_accept_to_prefs($accept, $def = '*/*')
1799 // No arg means accept anything (per HTTP spec)
1801 return array($def => 1);
1806 $parts = explode(',', $accept);
1808 foreach($parts as $part) {
1809 // FIXME: doesn't deal with params like 'text/html; level=1'
1810 @list($value, $qpart) = explode(';', trim($part));
1812 if(!isset($qpart)) {
1814 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1815 $prefs[$value] = $match[1];
1822 function common_mime_type_match($type, $avail)
1824 if(array_key_exists($type, $avail)) {
1827 $parts = explode('/', $type);
1828 if(array_key_exists($parts[0] . '/*', $avail)) {
1829 return $parts[0] . '/*';
1830 } elseif(array_key_exists('*/*', $avail)) {
1838 function common_negotiate_type($cprefs, $sprefs)
1842 foreach(array_keys($sprefs) as $type) {
1843 $parts = explode('/', $type);
1844 if($parts[1] != '*') {
1845 $ckey = common_mime_type_match($type, $cprefs);
1847 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1852 foreach(array_keys($cprefs) as $type) {
1853 $parts = explode('/', $type);
1854 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1855 $skey = common_mime_type_match($type, $sprefs);
1857 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1863 $besttype = 'text/html';
1865 foreach(array_keys($combine) as $type) {
1866 if($combine[$type] > $bestq) {
1868 $bestq = $combine[$type];
1872 if ('text/html' === $besttype) {
1873 return "text/html; charset=utf-8";
1878 function common_config($main, $sub)
1881 return (array_key_exists($main, $config) &&
1882 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1885 function common_config_set($main, $sub, $value)
1888 if (!array_key_exists($main, $config)) {
1889 $config[$main] = array();
1891 $config[$main][$sub] = $value;
1894 function common_config_append($main, $sub, $value)
1897 if (!array_key_exists($main, $config)) {
1898 $config[$main] = array();
1900 if (!array_key_exists($sub, $config[$main])) {
1901 $config[$main][$sub] = array();
1903 if (!is_array($config[$main][$sub])) {
1904 $config[$main][$sub] = array($config[$main][$sub]);
1906 array_push($config[$main][$sub], $value);
1910 * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
1911 * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
1913 * @param array $from
1916 function common_copy_args($from)
1919 $strip = get_magic_quotes_gpc();
1920 foreach ($from as $k => $v) {
1922 $to[$k] = common_copy_args($v);
1925 $v = stripslashes($v);
1927 $to[$k] = strval(common_validate_utf8($v));
1934 * Neutralise the evil effects of magic_quotes_gpc in the current request.
1935 * This is used before handing a request off to OAuthRequest::from_request.
1936 * @fixme Doesn't consider vars other than _POST and _GET?
1937 * @fixme Can't be undone and could corrupt data if run twice.
1939 function common_remove_magic_from_request()
1941 if(get_magic_quotes_gpc()) {
1942 $_POST=array_map('stripslashes',$_POST);
1943 $_GET=array_map('stripslashes',$_GET);
1947 function common_user_uri(&$user)
1949 return common_local_url('userbyid', array('id' => $user->id),
1953 function common_notice_uri(&$notice)
1955 return common_local_url('shownotice',
1956 array('notice' => $notice->id),
1960 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1962 function common_confirmation_code($bits)
1964 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1965 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1966 $chars = ceil($bits/5);
1968 for ($i = 0; $i < $chars; $i++) {
1969 // XXX: convert to string and back
1970 $num = hexdec(common_random_hexstr(1));
1971 // XXX: randomness is too precious to throw away almost
1972 // 40% of the bits we get!
1973 $code .= $codechars[$num%32];
1978 // convert markup to HTML
1980 function common_markup_to_html($c, $args=null)
1982 if (is_null($args)) {
1986 // XXX: not very efficient
1988 foreach ($args as $name => $value) {
1989 $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
1992 $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
1993 $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
1994 $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
1995 $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
1996 return Markdown($c);
1999 function common_user_property($property)
2001 $profile = Profile::current();
2003 if (empty($profile)) {
2007 switch ($property) {
2013 return $profile->$property;
2017 return $profile->getAvatar(AVATAR_STREAM_SIZE);
2018 } catch (Exception $e) {
2023 return $profile->getBestName();
2030 function common_profile_uri($profile)
2034 if (!empty($profile)) {
2035 if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2036 $user = User::getKV($profile->id);
2037 if (!empty($user)) {
2040 Event::handle('EndCommonProfileURI', array($profile, &$uri));
2044 // XXX: this is a very bad profile!
2048 function common_canonical_sms($sms)
2051 preg_replace('/\D/', '', $sms);
2055 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2060 case E_COMPILE_ERROR:
2064 case E_RECOVERABLE_ERROR:
2065 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2070 case E_COMPILE_WARNING:
2071 case E_CORE_WARNING:
2072 case E_USER_WARNING:
2073 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2078 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2083 case E_USER_DEPRECATED:
2084 // XXX: config variable to log this stuff, too
2088 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2093 // FIXME: show error page if we're on the Web
2094 /* Don't execute PHP internal error handler */
2098 function common_session_token()
2100 common_ensure_session();
2101 if (!array_key_exists('token', $_SESSION)) {
2102 $_SESSION['token'] = common_random_hexstr(64);
2104 return $_SESSION['token'];
2107 function common_license_terms($uri)
2109 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2110 return explode('-',$matches[1]);
2115 function common_compatible_license($from, $to)
2117 $from_terms = common_license_terms($from);
2118 // public domain and cc-by are compatible with everything
2119 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2122 $to_terms = common_license_terms($to);
2123 // sa is compatible across versions. IANAL
2124 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2125 return count(array_diff($from_terms, $to_terms)) == 0;
2127 // XXX: better compatibility check needed here!
2128 // Should at least normalise URIs
2129 return ($from == $to);
2133 * returns a quoted table name, if required according to config
2135 function common_database_tablename($tablename)
2137 if(common_config('db','quote_identifiers')) {
2138 $tablename = '"'. $tablename .'"';
2140 //table prefixes could be added here later
2145 * Shorten a URL with the current user's configured shortening service,
2146 * or ur1.ca if configured, or not at all if no shortening is set up.
2148 * @param string $long_url original URL
2149 * @param User $user to specify a particular user's options
2150 * @param boolean $force Force shortening (used when notice is too long)
2151 * @return string may return the original URL if shortening failed
2153 * @fixme provide a way to specify a particular shortener
2155 function common_shorten_url($long_url, User $user=null, $force = false)
2157 $long_url = trim($long_url);
2159 $user = common_current_user();
2161 $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2163 // $force forces shortening even if it's not strictly needed
2164 // I doubt URL shortening is ever 'strictly' needed. - ESP
2166 if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2170 $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2172 if (Event::handle('StartShortenUrl',
2173 array($long_url, $shortenerName, &$shortenedUrl))) {
2174 if ($shortenerName == 'internal') {
2175 $f = File::processNew($long_url);
2179 $shortenedUrl = common_local_url('redirecturl',
2180 array('id' => $f->id));
2181 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2182 return $shortenedUrl;
2191 //URL was shortened, so return the result
2192 return trim($shortenedUrl);
2197 * @return mixed array($proxy, $ip) for web requests; proxy may be null
2198 * null if not a web request
2200 * @fixme X-Forwarded-For can be chained by multiple proxies;
2201 we should parse the list and provide a cleaner array
2202 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2203 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2204 * use function to get exact request headers from Apache if possible.
2206 function common_client_ip()
2208 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2212 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2213 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2214 $proxy = $_SERVER['HTTP_CLIENT_IP'];
2216 $proxy = $_SERVER['REMOTE_ADDR'];
2218 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2221 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2222 $ip = $_SERVER['HTTP_CLIENT_IP'];
2224 $ip = $_SERVER['REMOTE_ADDR'];
2228 return array($proxy, $ip);
2231 function common_url_to_nickname($url)
2233 static $bad = array('query', 'user', 'password', 'port', 'fragment');
2235 $parts = parse_url($url);
2237 // If any of these parts exist, this won't work
2239 foreach ($bad as $badpart) {
2240 if (array_key_exists($badpart, $parts)) {
2245 // We just have host and/or path
2247 // If it's just a host...
2248 if (array_key_exists('host', $parts) &&
2249 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2251 $hostparts = explode('.', $parts['host']);
2253 // Try to catch common idiom of nickname.service.tld
2255 if ((count($hostparts) > 2) &&
2256 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2257 (strcmp($hostparts[0], 'www') != 0))
2259 return common_nicknamize($hostparts[0]);
2261 // Do the whole hostname
2262 return common_nicknamize($parts['host']);
2265 if (array_key_exists('path', $parts)) {
2266 // Strip starting, ending slashes
2267 $path = preg_replace('@/$@', '', $parts['path']);
2268 $path = preg_replace('@^/@', '', $path);
2269 $path = basename($path);
2271 // Hack for MediaWiki user pages, in the form:
2272 // http://example.com/wiki/User:Myname
2273 // ('User' may be localized.)
2274 if (strpos($path, ':')) {
2275 $parts = array_filter(explode(':', $path));
2276 $path = $parts[count($parts) - 1];
2280 return common_nicknamize($path);
2288 function common_nicknamize($str)
2291 return Nickname::normalize($str);
2292 } catch (NicknameException $e) {
2297 function common_perf_counter($key, $val=null)
2299 global $_perfCounters;
2300 if (isset($_perfCounters)) {
2301 if (common_config('site', 'logperf')) {
2302 if (array_key_exists($key, $_perfCounters)) {
2303 $_perfCounters[$key][] = $val;
2305 $_perfCounters[$key] = array($val);
2307 if (common_config('site', 'logperf_detail')) {
2308 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2314 function common_log_perf_counters()
2316 if (common_config('site', 'logperf')) {
2317 global $_startTime, $_perfCounters;
2319 if (isset($_startTime)) {
2320 $endTime = microtime(true);
2321 $diff = round(($endTime - $_startTime) * 1000);
2322 common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2324 $counters = $_perfCounters;
2326 foreach ($counters as $key => $values) {
2327 $count = count($values);
2328 $unique = count(array_unique($values));
2329 common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2334 function common_is_email($str)
2336 return (strpos($str, '@') !== false);
2339 function common_init_stats()
2343 $_mem = memory_get_usage(true);
2344 $_ts = microtime(true);
2347 function common_log_delta($comment=null)
2354 $_mem = memory_get_usage(true);
2355 $_ts = microtime(true);
2357 $mtotal = $_mem - $mold;
2358 $ttotal = $_ts - $told;
2360 if (empty($comment)) {
2364 common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));