3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 /* XXX: break up into separate modules (HTTP, user, files) */
23 * Show a server error.
25 function common_server_error($msg, $code=500)
27 $err = new ServerErrorAction($msg, $code);
34 function common_user_error($msg, $code=400)
36 $err = new ClientErrorAction($msg, $code);
41 * This should only be used at setup; processes switching languages
42 * to send text to other users should use common_switch_locale().
44 * @param string $language Locale language code (optional; empty uses
45 * current user's preference or site default)
46 * @return mixed success
48 function common_init_locale($language=null)
51 $language = common_language();
53 putenv('LANGUAGE='.$language);
54 putenv('LANG='.$language);
55 $ok = setlocale(LC_ALL, $language . ".utf8",
65 * Initialize locale and charset settings and gettext with our message catalog,
66 * using the current user's language preference or the site default.
68 * This should generally only be run at framework initialization; code switching
69 * languages at runtime should call common_switch_language().
73 function common_init_language()
75 mb_internal_encoding('UTF-8');
77 // Note that this setlocale() call may "fail" but this is harmless;
78 // gettext will still select the right language.
79 $language = common_language();
80 $locale_set = common_init_locale($language);
83 // The requested locale doesn't exist on the system.
85 // gettext seems very picky... We first need to setlocale()
86 // to a locale which _does_ exist on the system, and _then_
87 // we can set in another locale that may not be set up
88 // (say, ga_ES for Galego/Galician) it seems to take it.
90 // For some reason C and POSIX which are guaranteed to work
91 // don't do the job. en_US.UTF-8 should be there most of the
92 // time, but not guaranteed.
93 $ok = common_init_locale("en_US");
94 if (!$ok && strtolower(substr(PHP_OS, 0, 3)) != 'win') {
95 // Try to find a complete, working locale on Unix/Linux...
96 // @fixme shelling out feels awfully inefficient
97 // but I don't think there's a more standard way.
99 foreach (explode("\n", $all) as $locale) {
100 if (preg_match('/\.utf[-_]?8$/i', $locale)) {
101 $ok = setlocale(LC_ALL, $locale);
109 common_log(LOG_ERR, "Unable to find a UTF-8 locale on this system; UI translations may not work.");
111 $locale_set = common_init_locale($language);
114 common_init_gettext();
120 function common_init_gettext()
122 setlocale(LC_CTYPE, 'C');
123 // So we do not have to make people install the gettext locales
124 $path = common_config('site','locale_path');
125 bindtextdomain("statusnet", $path);
126 bind_textdomain_codeset("statusnet", "UTF-8");
127 textdomain("statusnet");
131 * Switch locale during runtime, and poke gettext until it cries uncle.
132 * Otherwise, sometimes it doesn't actually switch away from the old language.
134 * @param string $language code for locale ('en', 'fr', 'pt_BR' etc)
136 function common_switch_locale($language=null)
138 common_init_locale($language);
140 setlocale(LC_CTYPE, 'C');
141 // So we do not have to make people install the gettext locales
142 $path = common_config('site','locale_path');
143 bindtextdomain("statusnet", $path);
144 bind_textdomain_codeset("statusnet", "UTF-8");
145 textdomain("statusnet");
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)
215 if (is_object($id) || is_object($password)) {
216 $e = new Exception();
217 common_log(LOG_ERR, __METHOD__ . ' object in param to common_munge_password ' .
218 str_replace("\n", " ", $e->getTraceAsString()));
220 return md5($password . $id);
224 * Check if a username exists and has matching password.
226 function common_check_user($nickname, $password)
228 // empty nickname always unacceptable
229 if (empty($nickname)) {
233 $authenticatedUser = false;
235 if (Event::handle('StartCheckPassword', array($nickname, $password, &$authenticatedUser))) {
236 $user = User::staticGet('nickname', common_canonical_nickname($nickname));
238 if (!empty($password)) { // never allow login with blank password
239 if (0 == strcmp(common_munge_password($password, $user->id),
241 //internal checking passed
242 $authenticatedUser = $user;
246 Event::handle('EndCheckPassword', array($nickname, $password, $authenticatedUser));
249 return $authenticatedUser;
253 * Is the current user logged in?
255 function common_logged_in()
257 return (!is_null(common_current_user()));
260 function common_have_session()
262 return (0 != strcmp(session_id(), ''));
265 function common_ensure_session()
268 if (array_key_exists(session_name(), $_COOKIE)) {
269 $c = $_COOKIE[session_name()];
271 if (!common_have_session()) {
272 if (common_config('sessions', 'handle')) {
273 Session::setSaveHandler();
275 if (array_key_exists(session_name(), $_GET)) {
276 $id = $_GET[session_name()];
277 } else if (array_key_exists(session_name(), $_COOKIE)) {
278 $id = $_COOKIE[session_name()];
284 if (!isset($_SESSION['started'])) {
285 $_SESSION['started'] = time();
287 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
288 ' is set but started value is null');
294 // Three kinds of arguments:
299 // Initialize to false; set to null if none found
302 function common_set_user($user)
306 if (is_null($user) && common_have_session()) {
308 unset($_SESSION['userid']);
310 } else if (is_string($user)) {
312 $user = User::staticGet('nickname', $nickname);
313 } else if (!($user instanceof User)) {
318 if (Event::handle('StartSetUser', array(&$user))) {
320 if (!$user->hasRight(Right::WEBLOGIN)) {
321 throw new AuthorizationException(_('Not allowed to log in.'));
323 common_ensure_session();
324 $_SESSION['userid'] = $user->id;
326 Event::handle('EndSetUser', array($user));
334 function common_set_cookie($key, $value, $expiration=0)
336 $path = common_config('site', 'path');
337 $server = common_config('site', 'server');
339 if ($path && ($path != '/')) {
340 $cookiepath = '/' . $path . '/';
344 return setcookie($key,
349 common_config('site', 'ssl')=='always');
352 define('REMEMBERME', 'rememberme');
353 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
355 function common_rememberme($user=null)
358 $user = common_current_user();
364 $rm = new Remember_me();
366 $rm->code = common_good_rand(16);
367 $rm->user_id = $user->id;
369 // Wrap the insert in some good ol' fashioned transaction code
373 $result = $rm->insert();
376 common_log_db_error($rm, 'INSERT', __FILE__);
380 $rm->query('COMMIT');
382 $cookieval = $rm->user_id . ':' . $rm->code;
384 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
386 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
391 function common_remembered_user()
395 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
401 list($id, $code) = explode(':', $packed);
403 if (!$id || !$code) {
404 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
409 $rm = Remember_me::staticGet($code);
412 common_log(LOG_WARNING, 'No such remember code: ' . $code);
417 if ($rm->user_id != $id) {
418 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
423 $user = User::staticGet($rm->user_id);
426 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
432 $result = $rm->delete();
435 common_log_db_error($rm, 'DELETE', __FILE__);
436 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
441 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
443 common_set_user($user);
444 common_real_login(false);
446 // We issue a new cookie, so they can log in
447 // automatically again after this session
449 common_rememberme($user);
455 * must be called with a valid user!
457 function common_forgetme()
459 common_set_cookie(REMEMBERME, '', 0);
463 * Who is the current user?
465 function common_current_user()
469 if (!_have_config()) {
473 if ($_cur === false) {
475 if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
476 || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
477 common_ensure_session();
478 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
480 $user = User::staticGet($id);
488 // that didn't work; try to remember; will init $_cur to null on failure
489 $_cur = common_remembered_user();
492 // XXX: Is this necessary?
493 $_SESSION['userid'] = $_cur->id;
501 * Logins that are 'remembered' aren't 'real' -- they're subject to
502 * cookie-stealing. So, we don't let them do certain things. New reg,
503 * OpenID, and password logins _are_ real.
505 function common_real_login($real=true)
507 common_ensure_session();
508 $_SESSION['real_login'] = $real;
511 function common_is_real_login()
513 return common_logged_in() && $_SESSION['real_login'];
517 * Get a hash portion for HTTP caching Etags and such including
518 * info on the current user's session. If login/logout state changes,
519 * or we've changed accounts, or we've renamed the current user,
520 * we'll get a new hash value.
522 * This should not be considered secure information.
524 * @param User $user (optional; uses common_current_user() if left out)
527 function common_user_cache_hash($user=false)
529 if ($user === false) {
530 $user = common_current_user();
533 return crc32($user->id . ':' . $user->nickname);
540 * get canonical version of nickname for comparison
542 * @param string $nickname
545 * @throws NicknameException on invalid input
546 * @deprecated call Nickname::normalize() directly.
548 function common_canonical_nickname($nickname)
550 return Nickname::normalize($nickname);
554 * get canonical version of email for comparison
556 * @fixme actually normalize
557 * @fixme reject invalid input
559 * @param string $email
562 function common_canonical_email($email)
564 // XXX: canonicalize UTF-8
565 // XXX: lcase the domain part
570 * Partial notice markup rendering step: build links to !group references.
572 * @param string $text partially rendered HTML
573 * @param Notice $notice in whose context we're working
574 * @return string partially rendered HTML
576 function common_render_content($text, $notice)
578 $r = common_render_text($text);
579 $id = $notice->profile_id;
580 $r = common_linkify_mentions($r, $notice);
581 $r = preg_replace('/(^|[\s\.\,\:\;]+)!(' . Nickname::DISPLAY_FMT . ')/e',
582 "'\\1!'.common_group_link($id, '\\2')", $r);
587 * Finds @-mentions within the partially-rendered text section and
588 * turns them into live links.
590 * Should generally not be called except from common_render_content().
592 * @param string $text partially-rendered HTML
593 * @param Notice $notice in-progress or complete Notice object for context
594 * @return string partially-rendered HTML
596 function common_linkify_mentions($text, $notice)
598 $mentions = common_find_mentions($text, $notice);
600 // We need to go through in reverse order by position,
601 // so our positions stay valid despite our fudging with the
606 foreach ($mentions as $mention)
608 $points[$mention['position']] = $mention;
613 foreach ($points as $position => $mention) {
615 $linkText = common_linkify_mention($mention);
617 $text = substr_replace($text, $linkText, $position, mb_strlen($mention['text']));
623 function common_linkify_mention($mention)
627 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
629 $xs = new XMLStringer(false);
631 $attrs = array('href' => $mention['url'],
634 if (!empty($mention['title'])) {
635 $attrs['title'] = $mention['title'];
638 $xs->elementStart('span', 'vcard');
639 $xs->elementStart('a', $attrs);
640 $xs->element('span', 'fn nickname', $mention['text']);
641 $xs->elementEnd('a');
642 $xs->elementEnd('span');
644 $output = $xs->getString();
646 Event::handle('EndLinkifyMention', array($mention, &$output));
653 * Find @-mentions in the given text, using the given notice object as context.
654 * References will be resolved with common_relative_profile() against the user
655 * who posted the notice.
657 * Note the return data format is internal, to be used for building links and
658 * such. Should not be used directly; rather, call common_linkify_mentions().
660 * @param string $text
661 * @param Notice $notice notice in whose context we're building links
667 function common_find_mentions($text, $notice)
671 $sender = Profile::staticGet('id', $notice->profile_id);
673 if (empty($sender)) {
677 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
678 // Get the context of the original notice, if any
679 $originalAuthor = null;
680 $originalNotice = null;
681 $originalMentions = array();
685 if (!empty($notice) && !empty($notice->reply_to)) {
686 $originalNotice = Notice::staticGet('id', $notice->reply_to);
687 if (!empty($originalNotice)) {
688 $originalAuthor = Profile::staticGet('id', $originalNotice->profile_id);
690 $ids = $originalNotice->getReplies();
692 foreach ($ids as $id) {
693 $repliedTo = Profile::staticGet('id', $id);
694 if (!empty($repliedTo)) {
695 $originalMentions[$repliedTo->nickname] = $repliedTo;
701 $matches = common_find_mentions_raw($text);
703 foreach ($matches as $match) {
705 $nickname = Nickname::normalize($match[0]);
706 } catch (NicknameException $e) {
707 // Bogus match? Drop it.
711 // Try to get a profile for this nickname.
712 // Start with conversation context, then go to
715 if (!empty($originalAuthor) && $originalAuthor->nickname == $nickname) {
716 $mentioned = $originalAuthor;
717 } else if (!empty($originalMentions) &&
718 array_key_exists($nickname, $originalMentions)) {
719 $mentioned = $originalMentions[$nickname];
721 $mentioned = common_relative_profile($sender, $nickname);
724 if (!empty($mentioned)) {
725 $user = User::staticGet('id', $mentioned->id);
728 $url = common_local_url('userbyid', array('id' => $user->id));
730 $url = $mentioned->profileurl;
733 $mention = array('mentioned' => array($mentioned),
735 'position' => $match[1],
738 if (!empty($mentioned->fullname)) {
739 $mention['title'] = $mentioned->fullname;
742 $mentions[] = $mention;
746 // @#tag => mention of all subscriptions tagged 'tag'
748 preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
751 PREG_OFFSET_CAPTURE);
753 foreach ($hmatches[1] as $hmatch) {
755 $tag = common_canonical_tag($hmatch[0]);
756 $plist = Profile_list::getByTaggerAndTag($sender->id, $tag);
757 if (!empty($plist) && !$plist->private) {
758 $tagged = $sender->getTaggedSubscribers($tag);
760 $url = common_local_url('showprofiletag',
761 array('tagger' => $sender->nickname,
764 $mentions[] = array('mentioned' => $tagged,
765 'text' => $hmatch[0],
766 'position' => $hmatch[1],
771 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
778 * Does the actual regex pulls to find @-mentions in text.
779 * Should generally not be called directly; for use in common_find_mentions.
781 * @param string $text
782 * @return array of PCRE match arrays
784 function common_find_mentions_raw($text)
787 preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
790 PREG_OFFSET_CAPTURE);
792 $atmatches = array();
793 preg_match_all('/(?:^|\s+)@(' . Nickname::DISPLAY_FMT . ')\b/',
796 PREG_OFFSET_CAPTURE);
798 $matches = array_merge($tmatches[1], $atmatches[1]);
802 function common_render_text($text)
804 $r = htmlspecialchars($text);
806 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
807 $r = common_replace_urls_callback($r, 'common_linkify');
808 $r = preg_replace('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/ue', "'\\1#'.common_tag_link('\\2')", $r);
814 * Find links in the given text and pass them to the given callback function.
816 * @param string $text
817 * @param function($text, $arg) $callback: return replacement text
818 * @param mixed $arg: optional argument will be passed on to the callback
820 function common_replace_urls_callback($text, $callback, $arg = null) {
821 // Start off with a regex
823 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
826 '(?:'. //Known protocols
828 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
830 '(?:(?:mailto|aim|tel|xmpp):)'.
832 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
835 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
837 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
841 '|(?:(?: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
843 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
845 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
846 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
847 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
848 '(?: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)'.
852 '(?:\:\d+)?'. //:port
853 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
854 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
855 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
856 ')(?<![\?\.\,\#\,])'.
859 //preg_match_all($regex,$text,$matches);
861 return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
865 * Intermediate callback for common_replace_links(), helps resolve some
866 * ambiguous link forms before passing on to the final callback.
868 * @param array $matches
869 * @param callable $callback
870 * @param mixed $arg optional argument to pass on as second param to callback
875 function callback_helper($matches, $callback, $arg=null) {
877 $left = strpos($matches[0],$url);
878 $right = $left+strlen($url);
880 $groupSymbolSets=array(
898 $cannotEndWith=array('.','?',',','#');
902 foreach($groupSymbolSets as $groupSymbolSet){
903 if(substr($url,-1)==$groupSymbolSet['right']){
904 $group_left_count = substr_count($url,$groupSymbolSet['left']);
905 $group_right_count = substr_count($url,$groupSymbolSet['right']);
906 if($group_left_count<$group_right_count){
908 $url=substr($url,0,-1);
912 if(in_array(substr($url,-1),$cannotEndWith)){
914 $url=substr($url,0,-1);
916 }while($original_url!=$url);
918 $result = call_user_func_array($callback, array($url, $arg));
919 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
922 if (version_compare(PHP_VERSION, '5.3.0', 'ge')) {
923 // lambda implementation in a separate file; PHP 5.2 won't parse it.
924 require_once INSTALLDIR . "/lib/curry.php";
926 function curry($fn) {
927 $args = func_get_args();
929 $id = uniqid('_partial');
930 $GLOBALS[$id] = array($fn, $args);
931 return create_function('',
932 '$args = func_get_args(); '.
933 'return call_user_func_array('.
934 '$GLOBALS["'.$id.'"][0],'.
937 '$GLOBALS["'.$id.'"][1]));');
941 function common_linkify($url) {
942 // It comes in special'd, so we unspecial it before passing to the stringifying
944 $url = htmlspecialchars_decode($url);
946 if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
947 //url is an email address without the mailto: protocol
948 $canon = "mailto:$url";
949 $longurl = "mailto:$url";
952 $canon = File_redirection::_canonUrl($url);
954 $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
955 if (is_array($longurl_data)) {
956 $longurl = $longurl_data['url'];
957 } elseif (is_string($longurl_data)) {
958 $longurl = $longurl_data;
960 // Unable to reach the server to verify contents, etc
961 // Just pass the link on through for now.
962 common_log(LOG_ERR, "Can't linkify url '$url'");
967 $attrs = array('href' => $canon, 'title' => $longurl);
969 $is_attachment = false;
970 $attachment_id = null;
973 // Check to see whether this is a known "attachment" URL.
975 $f = File::staticGet('url', $longurl);
978 if (common_config('attachments', 'process_links')) {
979 // XXX: this writes to the database. :<
980 $f = File::processNew($longurl);
985 if ($f->getEnclosure()) {
986 $is_attachment = true;
987 $attachment_id = $f->id;
989 $thumb = File_thumbnail::staticGet('file_id', $f->id);
990 if (!empty($thumb)) {
997 if ($is_attachment) {
998 $attrs['class'] = 'attachment';
1000 $attrs['class'] = 'attachment thumbnail';
1002 $attrs['id'] = "attachment-{$attachment_id}";
1005 // Whether to nofollow
1007 $nf = common_config('nofollow', 'external');
1009 if ($nf == 'never') {
1010 $attrs['rel'] = 'external';
1012 $attrs['rel'] = 'nofollow external';
1015 return XMLStringer::estring('a', $attrs, $url);
1019 * Find and shorten links in a given chunk of text if it's longer than the
1020 * configured notice content limit (or unconditionally).
1022 * Side effects: may save file and file_redirection records for referenced URLs.
1024 * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1025 * user's options are used; otherwise the current web session user's setitngs
1026 * will be used or ur1.ca if there is no active web login.
1028 * @param string $text
1029 * @param boolean $always (optional)
1030 * @param User $user (optional)
1034 function common_shorten_links($text, $always = false, User $user=null)
1036 common_debug("common_shorten_links() called");
1038 $user = common_current_user();
1040 $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1042 common_debug("maxLength = $maxLength");
1044 if ($always || mb_strlen($text) > $maxLength) {
1045 common_debug("Forcing shortening");
1046 return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1048 common_debug("Not forcing shortening");
1049 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1054 * Very basic stripping of invalid UTF-8 input text.
1056 * @param string $str
1057 * @return mixed string or null if invalid input
1059 * @todo ideally we should drop bad chars, and maybe do some of the checks
1060 * from common_xml_safe_str. But we can't strip newlines, etc.
1061 * @todo Unicode normalization might also be useful, but not needed now.
1063 function common_validate_utf8($str)
1065 // preg_replace will return NULL on invalid UTF-8 input.
1067 // Note: empty regex //u also caused NULL return on some
1068 // production machines, but none of our test machines.
1070 // This should be replaced with a more reliable check.
1071 return preg_replace('/\x00/u', '', $str);
1075 * Make sure an arbitrary string is safe for output in XML as a single line.
1077 * @param string $str
1080 function common_xml_safe_str($str)
1082 // Replace common eol and extra whitespace input chars
1087 "\0", // null byte eos
1088 "\x0B" // vertical tab
1091 $replacement = array(
1092 ' ', // single space
1099 $str = str_replace($unWelcome, $replacement, $str);
1101 // Neutralize any additional control codes and UTF-16 surrogates
1102 // (Twitter uses '*')
1103 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1106 function common_tag_link($tag)
1108 $canonical = common_canonical_tag($tag);
1109 if (common_config('singleuser', 'enabled')) {
1110 // regular TagAction isn't set up in 1user mode
1111 $nickname = User::singleUserNickname();
1112 $url = common_local_url('showstream',
1113 array('nickname' => $nickname,
1114 'tag' => $canonical));
1116 $url = common_local_url('tag', array('tag' => $canonical));
1118 $xs = new XMLStringer();
1119 $xs->elementStart('span', 'tag');
1120 $xs->element('a', array('href' => $url,
1123 $xs->elementEnd('span');
1124 return $xs->getString();
1127 function common_canonical_tag($tag)
1129 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
1130 return str_replace(array('-', '_', '.'), '', $tag);
1133 function common_valid_profile_tag($str)
1135 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1140 * @param <type> $sender_id
1141 * @param <type> $nickname
1145 function common_group_link($sender_id, $nickname)
1147 $sender = Profile::staticGet($sender_id);
1148 $group = User_group::getForNickname($nickname, $sender);
1149 if ($sender && $group && $sender->isMember($group)) {
1150 $attrs = array('href' => $group->permalink(),
1152 if (!empty($group->fullname)) {
1153 $attrs['title'] = $group->getFancyName();
1155 $xs = new XMLStringer();
1156 $xs->elementStart('span', 'vcard');
1157 $xs->elementStart('a', $attrs);
1158 $xs->element('span', 'fn nickname', $nickname);
1159 $xs->elementEnd('a');
1160 $xs->elementEnd('span');
1161 return $xs->getString();
1168 * Resolve an ambiguous profile nickname reference, checking in following order:
1169 * - profiles that $sender subscribes to
1170 * - profiles that subscribe to $sender
1171 * - local user profiles
1173 * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1174 * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1177 * @fixme validate input
1179 * @fixme fix or remove mystery third parameter
1180 * @fixme is $sender a User or Profile?
1182 * @param <type> $sender the user or profile in whose context we're looking
1183 * @param string $nickname validated nickname of
1184 * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1186 * @return Profile or null
1188 function common_relative_profile($sender, $nickname, $dt=null)
1190 // Will throw exception on invalid input.
1191 $nickname = Nickname::normalize($nickname);
1193 // Try to find profiles this profile is subscribed to that have this nickname
1194 $recipient = new Profile();
1195 // XXX: use a join instead of a subquery
1196 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1197 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1198 if ($recipient->find(true)) {
1199 // XXX: should probably differentiate between profiles with
1200 // the same name by date of most recent update
1203 // Try to find profiles that listen to this profile and that have this nickname
1204 $recipient = new Profile();
1205 // XXX: use a join instead of a subquery
1206 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1207 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1208 if ($recipient->find(true)) {
1209 // XXX: should probably differentiate between profiles with
1210 // the same name by date of most recent update
1213 // If this is a local user, try to find a local user with that nickname.
1214 $sender = User::staticGet($sender->id);
1216 $recipient_user = User::staticGet('nickname', $nickname);
1217 if ($recipient_user) {
1218 return $recipient_user->getProfile();
1221 // Otherwise, no links. @messages from local users to remote users,
1222 // or from remote users to other remote users, are just
1223 // outside our ability to make intelligent guesses about
1227 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1230 $path = $r->build($action, $args, $params, $fragment);
1232 $ssl = common_is_sensitive($action);
1234 if (common_config('site','fancy')) {
1235 $url = common_path(mb_substr($path, 1), $ssl, $addSession);
1237 if (mb_strpos($path, '/index.php') === 0) {
1238 $url = common_path(mb_substr($path, 1), $ssl, $addSession);
1240 $url = common_path('index.php'.$path, $ssl, $addSession);
1246 function common_is_sensitive($action)
1248 static $sensitive = array(
1253 'ApiOauthRequestToken',
1254 'ApiOauthAccessToken',
1255 'ApiOauthAuthorize',
1261 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1262 $ssl = in_array($action, $sensitive);
1268 function common_path($relative, $ssl=false, $addSession=true)
1270 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1272 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1273 || common_config('site', 'ssl') === 'always') {
1275 if (is_string(common_config('site', 'sslserver')) &&
1276 mb_strlen(common_config('site', 'sslserver')) > 0) {
1277 $serverpart = common_config('site', 'sslserver');
1278 } else if (common_config('site', 'server')) {
1279 $serverpart = common_config('site', 'server');
1281 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1285 if (common_config('site', 'server')) {
1286 $serverpart = common_config('site', 'server');
1288 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1293 $relative = common_inject_session($relative, $serverpart);
1296 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1299 function common_inject_session($url, $serverpart = null)
1301 if (common_have_session()) {
1303 if (empty($serverpart)) {
1304 $serverpart = parse_url($url, PHP_URL_HOST);
1307 $currentServer = $_SERVER['HTTP_HOST'];
1309 // Are we pointing to another server (like an SSL server?)
1311 if (!empty($currentServer) &&
1312 0 != strcasecmp($currentServer, $serverpart)) {
1313 // Pass the session ID as a GET parameter
1314 $sesspart = session_name() . '=' . session_id();
1315 $i = strpos($url, '?');
1316 if ($i === false) { // no GET params, just append
1317 $url .= '?' . $sesspart;
1319 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1327 function common_date_string($dt)
1329 // XXX: do some sexy date formatting
1330 // return date(DATE_RFC822, $dt);
1331 $t = strtotime($dt);
1335 if ($now < $t) { // that shouldn't happen!
1336 return common_exact_date($dt);
1337 } else if ($diff < 60) {
1338 // TRANS: Used in notices to indicate when the notice was made compared to now.
1339 return _('a few seconds ago');
1340 } else if ($diff < 92) {
1341 // TRANS: Used in notices to indicate when the notice was made compared to now.
1342 return _('about a minute ago');
1343 } else if ($diff < 3300) {
1344 $minutes = round($diff/60);
1345 // TRANS: Used in notices to indicate when the notice was made compared to now.
1346 return sprintf( ngettext('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1347 } else if ($diff < 5400) {
1348 // TRANS: Used in notices to indicate when the notice was made compared to now.
1349 return _('about an hour ago');
1350 } else if ($diff < 22 * 3600) {
1351 $hours = round($diff/3600);
1352 // TRANS: Used in notices to indicate when the notice was made compared to now.
1353 return sprintf( ngettext('about one hour ago', 'about %d hours ago', $hours), $hours);
1354 } else if ($diff < 37 * 3600) {
1355 // TRANS: Used in notices to indicate when the notice was made compared to now.
1356 return _('about a day ago');
1357 } else if ($diff < 24 * 24 * 3600) {
1358 $days = round($diff/(24*3600));
1359 // TRANS: Used in notices to indicate when the notice was made compared to now.
1360 return sprintf( ngettext('about one day ago', 'about %d days ago', $days), $days);
1361 } else if ($diff < 46 * 24 * 3600) {
1362 // TRANS: Used in notices to indicate when the notice was made compared to now.
1363 return _('about a month ago');
1364 } else if ($diff < 330 * 24 * 3600) {
1365 $months = round($diff/(30*24*3600));
1366 // TRANS: Used in notices to indicate when the notice was made compared to now.
1367 return sprintf( ngettext('about one month ago', 'about %d months ago',$months), $months);
1368 } else if ($diff < 480 * 24 * 3600) {
1369 // TRANS: Used in notices to indicate when the notice was made compared to now.
1370 return _('about a year ago');
1372 return common_exact_date($dt);
1376 function common_exact_date($dt)
1382 $_utc = new DateTimeZone('UTC');
1383 $_siteTz = new DateTimeZone(common_timezone());
1386 $dateStr = date('d F Y H:i:s', strtotime($dt));
1387 $d = new DateTime($dateStr, $_utc);
1388 $d->setTimezone($_siteTz);
1389 return $d->format(DATE_RFC850);
1392 function common_date_w3dtf($dt)
1394 $dateStr = date('d F Y H:i:s', strtotime($dt));
1395 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1396 $d->setTimezone(new DateTimeZone(common_timezone()));
1397 return $d->format(DATE_W3C);
1400 function common_date_rfc2822($dt)
1402 $dateStr = date('d F Y H:i:s', strtotime($dt));
1403 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1404 $d->setTimezone(new DateTimeZone(common_timezone()));
1405 return $d->format('r');
1408 function common_date_iso8601($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('c');
1416 function common_sql_now()
1418 return common_sql_date(time());
1421 function common_sql_date($datetime)
1423 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1427 * Return an SQL fragment to calculate an age-based weight from a given
1428 * timestamp or datetime column.
1430 * @param string $column name of field we're comparing against current time
1431 * @param integer $dropoff divisor for age in seconds before exponentiation
1432 * @return string SQL fragment
1434 function common_sql_weight($column, $dropoff)
1436 if (common_config('db', 'type') == 'pgsql') {
1437 // PostgreSQL doesn't support timestampdiff function.
1438 // @fixme will this use the right time zone?
1439 // @fixme does this handle cross-year subtraction correctly?
1440 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1442 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1446 function common_redirect($url, $code=307)
1448 static $status = array(301 => "Moved Permanently",
1451 307 => "Temporary Redirect");
1453 header('HTTP/1.1 '.$code.' '.$status[$code]);
1454 header("Location: $url");
1456 $xo = new XMLOutputter();
1458 '-//W3C//DTD XHTML 1.0 Strict//EN',
1459 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1460 $xo->element('a', array('href' => $url), $url);
1465 // Stick the notice on the queue
1467 function common_enqueue_notice($notice)
1469 static $localTransports = array('omb',
1472 $transports = array();
1473 if (common_config('sms', 'enabled')) {
1474 $transports[] = 'sms';
1476 if (Event::hasHandler('HandleQueuedNotice')) {
1477 $transports[] = 'plugin';
1480 // We can skip these for gatewayed notices.
1481 if ($notice->isLocal()) {
1482 $transports = array_merge($transports, $localTransports);
1485 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1487 $qm = QueueManager::get();
1489 foreach ($transports as $transport)
1491 $qm->enqueue($notice, $transport);
1494 Event::handle('EndEnqueueNotice', array($notice, $transports));
1501 * Broadcast profile updates to OMB and other remote subscribers.
1503 * Since this may be slow with a lot of subscribers or bad remote sites,
1504 * this is run through the background queues if possible.
1506 function common_broadcast_profile(Profile $profile)
1508 $qm = QueueManager::get();
1509 $qm->enqueue($profile, "profile");
1513 function common_profile_url($nickname)
1515 return common_local_url('showstream', array('nickname' => $nickname),
1520 * Should make up a reasonable root URL
1522 function common_root_url($ssl=false)
1524 $url = common_path('', $ssl, false);
1525 $i = strpos($url, '?');
1527 $url = substr($url, 0, $i);
1533 * returns $bytes bytes of random data as a hexadecimal string
1534 * "good" here is a goal and not a guarantee
1536 function common_good_rand($bytes)
1538 // XXX: use random.org...?
1539 if (@file_exists('/dev/urandom')) {
1540 return common_urandom($bytes);
1541 } else { // FIXME: this is probably not good enough
1542 return common_mtrand($bytes);
1546 function common_urandom($bytes)
1548 $h = fopen('/dev/urandom', 'rb');
1550 $src = fread($h, $bytes);
1553 for ($i = 0; $i < $bytes; $i++) {
1554 $enc .= sprintf("%02x", (ord($src[$i])));
1559 function common_mtrand($bytes)
1562 for ($i = 0; $i < $bytes; $i++) {
1563 $enc .= sprintf("%02x", mt_rand(0, 255));
1569 * Record the given URL as the return destination for a future
1570 * form submission, to be read by common_get_returnto().
1572 * @param string $url
1574 * @fixme as a session-global setting, this can allow multiple forms
1575 * to conflict and overwrite each others' returnto destinations if
1576 * the user has multiple tabs or windows open.
1578 * Should refactor to index with a token or otherwise only pass the
1579 * data along its intended path.
1581 function common_set_returnto($url)
1583 common_ensure_session();
1584 $_SESSION['returnto'] = $url;
1588 * Fetch a return-destination URL previously recorded by
1589 * common_set_returnto().
1591 * @return mixed URL string or null
1593 * @fixme as a session-global setting, this can allow multiple forms
1594 * to conflict and overwrite each others' returnto destinations if
1595 * the user has multiple tabs or windows open.
1597 * Should refactor to index with a token or otherwise only pass the
1598 * data along its intended path.
1600 function common_get_returnto()
1602 common_ensure_session();
1603 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1606 function common_timestamp()
1608 return date('YmdHis');
1611 function common_ensure_syslog()
1613 static $initialized = false;
1614 if (!$initialized) {
1615 openlog(common_config('syslog', 'appname'), 0,
1616 common_config('syslog', 'facility'));
1617 $initialized = true;
1621 function common_log_line($priority, $msg)
1623 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1624 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1625 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1628 function common_request_id()
1631 $server = common_config('site', 'server');
1632 if (php_sapi_name() == 'cli') {
1633 $script = basename($_SERVER['PHP_SELF']);
1634 return "$server:$script:$pid";
1636 static $req_id = null;
1637 if (!isset($req_id)) {
1638 $req_id = substr(md5(mt_rand()), 0, 8);
1640 if (isset($_SERVER['REQUEST_URI'])) {
1641 $url = $_SERVER['REQUEST_URI'];
1643 $method = $_SERVER['REQUEST_METHOD'];
1644 return "$server:$pid.$req_id $method $url";
1648 function common_log($priority, $msg, $filename=null)
1650 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1651 $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1652 $msg = '[' . common_request_id() . '] ' . $msg;
1653 $logfile = common_config('site', 'logfile');
1655 $log = fopen($logfile, "a");
1657 $output = common_log_line($priority, $msg);
1658 fwrite($log, $output);
1662 common_ensure_syslog();
1663 syslog($priority, $msg);
1665 Event::handle('EndLog', array($priority, $msg, $filename));
1669 function common_debug($msg, $filename=null)
1672 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1674 common_log(LOG_DEBUG, $msg);
1678 function common_log_db_error(&$object, $verb, $filename=null)
1680 $objstr = common_log_objstring($object);
1681 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1682 if (is_object($last_error)) {
1683 $msg = $last_error->message;
1685 $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1687 common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1690 function common_log_objstring(&$object)
1692 if (is_null($object)) {
1695 if (!($object instanceof DB_DataObject)) {
1698 $arr = $object->toArray();
1700 foreach ($arr as $k => $v) {
1701 if (is_object($v)) {
1702 $fields[] = "$k='".get_class($v)."'";
1704 $fields[] = "$k='$v'";
1707 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1711 function common_valid_http_url($url)
1713 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1716 function common_valid_tag($tag)
1718 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1719 return (Validate::email($matches[1]) ||
1720 preg_match('/^([\w-\.]+)$/', $matches[1]));
1726 * Determine if given domain or address literal is valid
1727 * eg for use in JIDs and URLs. Does not check if the domain
1730 * @param string $domain
1731 * @return boolean valid or not
1733 function common_valid_domain($domain)
1735 $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1736 $ipv4 = "(?:$octet(?:\.$octet){3})";
1737 if (preg_match("/^$ipv4$/u", $domain)) return true;
1739 $group = "(?:[0-9a-f]{1,4})";
1740 $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1742 if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1743 $before = explode(":", $matches[1]);
1744 $zeroes = $matches[2];
1745 $after = explode(":", $matches[3]);
1753 $explicit = count($before) + count($after);
1754 if ($explicit < $min || $explicit > $max) {
1761 require_once "Net/IDNA.php";
1762 $idn = Net_IDNA::getInstance();
1763 $domain = $idn->encode($domain);
1764 } catch (Exception $e) {
1768 $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1769 $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1771 return preg_match("/^$fqdn$/ui", $domain);
1774 /* Following functions are copied from MediaWiki GlobalFunctions.php
1775 * and written by Evan Prodromou. */
1777 function common_accept_to_prefs($accept, $def = '*/*')
1779 // No arg means accept anything (per HTTP spec)
1781 return array($def => 1);
1786 $parts = explode(',', $accept);
1788 foreach($parts as $part) {
1789 // FIXME: doesn't deal with params like 'text/html; level=1'
1790 @list($value, $qpart) = explode(';', trim($part));
1792 if(!isset($qpart)) {
1794 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1795 $prefs[$value] = $match[1];
1802 function common_mime_type_match($type, $avail)
1804 if(array_key_exists($type, $avail)) {
1807 $parts = explode('/', $type);
1808 if(array_key_exists($parts[0] . '/*', $avail)) {
1809 return $parts[0] . '/*';
1810 } elseif(array_key_exists('*/*', $avail)) {
1818 function common_negotiate_type($cprefs, $sprefs)
1822 foreach(array_keys($sprefs) as $type) {
1823 $parts = explode('/', $type);
1824 if($parts[1] != '*') {
1825 $ckey = common_mime_type_match($type, $cprefs);
1827 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1832 foreach(array_keys($cprefs) as $type) {
1833 $parts = explode('/', $type);
1834 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1835 $skey = common_mime_type_match($type, $sprefs);
1837 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1843 $besttype = 'text/html';
1845 foreach(array_keys($combine) as $type) {
1846 if($combine[$type] > $bestq) {
1848 $bestq = $combine[$type];
1852 if ('text/html' === $besttype) {
1853 return "text/html; charset=utf-8";
1858 function common_config($main, $sub)
1861 return (array_key_exists($main, $config) &&
1862 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1866 * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
1867 * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
1869 * @param array $from
1872 function common_copy_args($from)
1875 $strip = get_magic_quotes_gpc();
1876 foreach ($from as $k => $v) {
1878 $to[$k] = common_copy_args($v);
1881 $v = stripslashes($v);
1883 $to[$k] = strval(common_validate_utf8($v));
1890 * Neutralise the evil effects of magic_quotes_gpc in the current request.
1891 * This is used before handing a request off to OAuthRequest::from_request.
1892 * @fixme Doesn't consider vars other than _POST and _GET?
1893 * @fixme Can't be undone and could corrupt data if run twice.
1895 function common_remove_magic_from_request()
1897 if(get_magic_quotes_gpc()) {
1898 $_POST=array_map('stripslashes',$_POST);
1899 $_GET=array_map('stripslashes',$_GET);
1903 function common_user_uri(&$user)
1905 return common_local_url('userbyid', array('id' => $user->id),
1909 function common_notice_uri(&$notice)
1911 return common_local_url('shownotice',
1912 array('notice' => $notice->id),
1916 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1918 function common_confirmation_code($bits)
1920 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1921 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1922 $chars = ceil($bits/5);
1924 for ($i = 0; $i < $chars; $i++) {
1925 // XXX: convert to string and back
1926 $num = hexdec(common_good_rand(1));
1927 // XXX: randomness is too precious to throw away almost
1928 // 40% of the bits we get!
1929 $code .= $codechars[$num%32];
1934 // convert markup to HTML
1936 function common_markup_to_html($c)
1938 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1939 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1940 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1941 return Markdown($c);
1944 function common_profile_uri($profile)
1949 $user = User::staticGet($profile->id);
1954 $remote = Remote_profile::staticGet($profile->id);
1956 return $remote->uri;
1958 // XXX: this is a very bad profile!
1962 function common_canonical_sms($sms)
1965 preg_replace('/\D/', '', $sms);
1969 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1974 case E_COMPILE_ERROR:
1978 case E_RECOVERABLE_ERROR:
1979 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1984 case E_COMPILE_WARNING:
1985 case E_CORE_WARNING:
1986 case E_USER_WARNING:
1987 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1992 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1997 case E_USER_DEPRECATED:
1998 // XXX: config variable to log this stuff, too
2002 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2007 // FIXME: show error page if we're on the Web
2008 /* Don't execute PHP internal error handler */
2012 function common_session_token()
2014 common_ensure_session();
2015 if (!array_key_exists('token', $_SESSION)) {
2016 $_SESSION['token'] = common_good_rand(64);
2018 return $_SESSION['token'];
2021 function common_license_terms($uri)
2023 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2024 return explode('-',$matches[1]);
2029 function common_compatible_license($from, $to)
2031 $from_terms = common_license_terms($from);
2032 // public domain and cc-by are compatible with everything
2033 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2036 $to_terms = common_license_terms($to);
2037 // sa is compatible across versions. IANAL
2038 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2039 return count(array_diff($from_terms, $to_terms)) == 0;
2041 // XXX: better compatibility check needed here!
2042 // Should at least normalise URIs
2043 return ($from == $to);
2047 * returns a quoted table name, if required according to config
2049 function common_database_tablename($tablename)
2051 if(common_config('db','quote_identifiers')) {
2052 $tablename = '"'. $tablename .'"';
2054 //table prefixes could be added here later
2059 * Shorten a URL with the current user's configured shortening service,
2060 * or ur1.ca if configured, or not at all if no shortening is set up.
2062 * @param string $long_url original URL
2063 * @param User $user to specify a particular user's options
2064 * @param boolean $force Force shortening (used when notice is too long)
2065 * @return string may return the original URL if shortening failed
2067 * @fixme provide a way to specify a particular shortener
2069 function common_shorten_url($long_url, User $user=null, $force = false)
2071 common_debug("Shortening URL '$long_url' (force = $force)");
2073 $long_url = trim($long_url);
2075 $user = common_current_user();
2077 $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2078 common_debug("maxUrlLength = $maxUrlLength");
2080 // $force forces shortening even if it's not strictly needed
2081 // I doubt URL shortening is ever 'strictly' needed. - ESP
2083 if (mb_strlen($long_url) < $maxUrlLength && !$force) {
2084 common_debug("Skipped shortening URL.");
2088 $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2090 common_debug("Shortener name = '$shortenerName'");
2092 if (Event::handle('StartShortenUrl',
2093 array($long_url, $shortenerName, &$shortenedUrl))) {
2094 if ($shortenerName == 'internal') {
2095 $f = File::processNew($long_url);
2099 $shortenedUrl = common_local_url('redirecturl',
2100 array('id' => $f->id));
2101 return $shortenedUrl;
2107 //URL was shortened, so return the result
2108 return trim($shortenedUrl);
2113 * @return mixed array($proxy, $ip) for web requests; proxy may be null
2114 * null if not a web request
2116 * @fixme X-Forwarded-For can be chained by multiple proxies;
2117 we should parse the list and provide a cleaner array
2118 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2119 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2120 * use function to get exact request headers from Apache if possible.
2122 function common_client_ip()
2124 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2128 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2129 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2130 $proxy = $_SERVER['HTTP_CLIENT_IP'];
2132 $proxy = $_SERVER['REMOTE_ADDR'];
2134 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2137 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2138 $ip = $_SERVER['HTTP_CLIENT_IP'];
2140 $ip = $_SERVER['REMOTE_ADDR'];
2144 return array($proxy, $ip);
2147 function common_url_to_nickname($url)
2149 static $bad = array('query', 'user', 'password', 'port', 'fragment');
2151 $parts = parse_url($url);
2153 # If any of these parts exist, this won't work
2155 foreach ($bad as $badpart) {
2156 if (array_key_exists($badpart, $parts)) {
2161 # We just have host and/or path
2163 # If it's just a host...
2164 if (array_key_exists('host', $parts) &&
2165 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2167 $hostparts = explode('.', $parts['host']);
2169 # Try to catch common idiom of nickname.service.tld
2171 if ((count($hostparts) > 2) &&
2172 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2173 (strcmp($hostparts[0], 'www') != 0))
2175 return common_nicknamize($hostparts[0]);
2177 # Do the whole hostname
2178 return common_nicknamize($parts['host']);
2181 if (array_key_exists('path', $parts)) {
2182 # Strip starting, ending slashes
2183 $path = preg_replace('@/$@', '', $parts['path']);
2184 $path = preg_replace('@^/@', '', $path);
2185 $path = basename($path);
2187 // Hack for MediaWiki user pages, in the form:
2188 // http://example.com/wiki/User:Myname
2189 // ('User' may be localized.)
2190 if (strpos($path, ':')) {
2191 $parts = array_filter(explode(':', $path));
2192 $path = $parts[count($parts) - 1];
2196 return common_nicknamize($path);
2204 function common_nicknamize($str)
2206 $str = preg_replace('/\W/', '', $str);
2207 return strtolower($str);
2210 function common_perf_counter($key, $val=null)
2212 global $_perfCounters;
2213 if (isset($_perfCounters)) {
2214 if (common_config('site', 'logperf')) {
2215 if (array_key_exists($key, $_perfCounters)) {
2216 $_perfCounters[$key][] = $val;
2218 $_perfCounters[$key] = array($val);
2220 if (common_config('site', 'logperf_detail')) {
2221 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2227 function common_log_perf_counters()
2229 if (common_config('site', 'logperf')) {
2230 global $_startTime, $_perfCounters;
2232 if (isset($_startTime)) {
2233 $endTime = microtime(true);
2234 $diff = round(($endTime - $_startTime) * 1000);
2235 common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2237 $counters = $_perfCounters;
2239 foreach ($counters as $key => $values) {
2240 $count = count($values);
2241 $unique = count(array_unique($values));
2242 common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");