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 // TRANS: Authorisation exception thrown when a user a not allowed to login.
322 throw new AuthorizationException(_('Not allowed to log in.'));
324 common_ensure_session();
325 $_SESSION['userid'] = $user->id;
327 Event::handle('EndSetUser', array($user));
335 function common_set_cookie($key, $value, $expiration=0)
337 $path = common_config('site', 'path');
338 $server = common_config('site', 'server');
340 if ($path && ($path != '/')) {
341 $cookiepath = '/' . $path . '/';
345 return setcookie($key,
350 common_config('site', 'ssl')=='always');
353 define('REMEMBERME', 'rememberme');
354 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
356 function common_rememberme($user=null)
359 $user = common_current_user();
365 $rm = new Remember_me();
367 $rm->code = common_good_rand(16);
368 $rm->user_id = $user->id;
370 // Wrap the insert in some good ol' fashioned transaction code
374 $result = $rm->insert();
377 common_log_db_error($rm, 'INSERT', __FILE__);
381 $rm->query('COMMIT');
383 $cookieval = $rm->user_id . ':' . $rm->code;
385 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
387 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
392 function common_remembered_user()
396 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
402 list($id, $code) = explode(':', $packed);
404 if (!$id || !$code) {
405 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
410 $rm = Remember_me::staticGet($code);
413 common_log(LOG_WARNING, 'No such remember code: ' . $code);
418 if ($rm->user_id != $id) {
419 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
424 $user = User::staticGet($rm->user_id);
427 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
433 $result = $rm->delete();
436 common_log_db_error($rm, 'DELETE', __FILE__);
437 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
442 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
444 common_set_user($user);
445 common_real_login(false);
447 // We issue a new cookie, so they can log in
448 // automatically again after this session
450 common_rememberme($user);
456 * must be called with a valid user!
458 function common_forgetme()
460 common_set_cookie(REMEMBERME, '', 0);
464 * Who is the current user?
466 function common_current_user()
470 if (!_have_config()) {
474 if ($_cur === false) {
476 if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
477 || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
478 common_ensure_session();
479 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
481 $user = User::staticGet($id);
489 // that didn't work; try to remember; will init $_cur to null on failure
490 $_cur = common_remembered_user();
493 // XXX: Is this necessary?
494 $_SESSION['userid'] = $_cur->id;
502 * Logins that are 'remembered' aren't 'real' -- they're subject to
503 * cookie-stealing. So, we don't let them do certain things. New reg,
504 * OpenID, and password logins _are_ real.
506 function common_real_login($real=true)
508 common_ensure_session();
509 $_SESSION['real_login'] = $real;
512 function common_is_real_login()
514 return common_logged_in() && $_SESSION['real_login'];
518 * Get a hash portion for HTTP caching Etags and such including
519 * info on the current user's session. If login/logout state changes,
520 * or we've changed accounts, or we've renamed the current user,
521 * we'll get a new hash value.
523 * This should not be considered secure information.
525 * @param User $user (optional; uses common_current_user() if left out)
528 function common_user_cache_hash($user=false)
530 if ($user === false) {
531 $user = common_current_user();
534 return crc32($user->id . ':' . $user->nickname);
541 * get canonical version of nickname for comparison
543 * @param string $nickname
546 * @throws NicknameException on invalid input
547 * @deprecated call Nickname::normalize() directly.
549 function common_canonical_nickname($nickname)
551 return Nickname::normalize($nickname);
555 * get canonical version of email for comparison
557 * @fixme actually normalize
558 * @fixme reject invalid input
560 * @param string $email
563 function common_canonical_email($email)
565 // XXX: canonicalize UTF-8
566 // XXX: lcase the domain part
571 * Partial notice markup rendering step: build links to !group references.
573 * @param string $text partially rendered HTML
574 * @param Notice $notice in whose context we're working
575 * @return string partially rendered HTML
577 function common_render_content($text, $notice)
579 $r = common_render_text($text);
580 $id = $notice->profile_id;
581 $r = common_linkify_mentions($r, $notice);
582 $r = preg_replace('/(^|[\s\.\,\:\;]+)!(' . Nickname::DISPLAY_FMT . ')/e',
583 "'\\1!'.common_group_link($id, '\\2')", $r);
588 * Finds @-mentions within the partially-rendered text section and
589 * turns them into live links.
591 * Should generally not be called except from common_render_content().
593 * @param string $text partially-rendered HTML
594 * @param Notice $notice in-progress or complete Notice object for context
595 * @return string partially-rendered HTML
597 function common_linkify_mentions($text, $notice)
599 $mentions = common_find_mentions($text, $notice);
601 // We need to go through in reverse order by position,
602 // so our positions stay valid despite our fudging with the
607 foreach ($mentions as $mention)
609 $points[$mention['position']] = $mention;
614 foreach ($points as $position => $mention) {
616 $linkText = common_linkify_mention($mention);
618 $text = substr_replace($text, $linkText, $position, mb_strlen($mention['text']));
624 function common_linkify_mention($mention)
628 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
630 $xs = new XMLStringer(false);
632 $attrs = array('href' => $mention['url'],
635 if (!empty($mention['title'])) {
636 $attrs['title'] = $mention['title'];
639 $xs->elementStart('span', 'vcard');
640 $xs->elementStart('a', $attrs);
641 $xs->element('span', 'fn nickname mention', $mention['text']);
642 $xs->elementEnd('a');
643 $xs->elementEnd('span');
645 $output = $xs->getString();
647 Event::handle('EndLinkifyMention', array($mention, &$output));
654 * Find @-mentions in the given text, using the given notice object as context.
655 * References will be resolved with common_relative_profile() against the user
656 * who posted the notice.
658 * Note the return data format is internal, to be used for building links and
659 * such. Should not be used directly; rather, call common_linkify_mentions().
661 * @param string $text
662 * @param Notice $notice notice in whose context we're building links
668 function common_find_mentions($text, $notice)
672 $sender = Profile::staticGet('id', $notice->profile_id);
674 if (empty($sender)) {
678 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
679 // Get the context of the original notice, if any
680 $originalAuthor = null;
681 $originalNotice = null;
682 $originalMentions = array();
686 if (!empty($notice) && !empty($notice->reply_to)) {
687 $originalNotice = Notice::staticGet('id', $notice->reply_to);
688 if (!empty($originalNotice)) {
689 $originalAuthor = Profile::staticGet('id', $originalNotice->profile_id);
691 $ids = $originalNotice->getReplies();
693 foreach ($ids as $id) {
694 $repliedTo = Profile::staticGet('id', $id);
695 if (!empty($repliedTo)) {
696 $originalMentions[$repliedTo->nickname] = $repliedTo;
702 $matches = common_find_mentions_raw($text);
704 foreach ($matches as $match) {
706 $nickname = Nickname::normalize($match[0]);
707 } catch (NicknameException $e) {
708 // Bogus match? Drop it.
712 // Try to get a profile for this nickname.
713 // Start with conversation context, then go to
716 if (!empty($originalAuthor) && $originalAuthor->nickname == $nickname) {
717 $mentioned = $originalAuthor;
718 } else if (!empty($originalMentions) &&
719 array_key_exists($nickname, $originalMentions)) {
720 $mentioned = $originalMentions[$nickname];
722 $mentioned = common_relative_profile($sender, $nickname);
725 if (!empty($mentioned)) {
726 $user = User::staticGet('id', $mentioned->id);
729 $url = common_local_url('userbyid', array('id' => $user->id));
731 $url = $mentioned->profileurl;
734 $mention = array('mentioned' => array($mentioned),
736 'position' => $match[1],
739 if (!empty($mentioned->fullname)) {
740 $mention['title'] = $mentioned->fullname;
743 $mentions[] = $mention;
747 // @#tag => mention of all subscriptions tagged 'tag'
749 preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
752 PREG_OFFSET_CAPTURE);
754 foreach ($hmatches[1] as $hmatch) {
756 $tag = common_canonical_tag($hmatch[0]);
757 $plist = Profile_list::getByTaggerAndTag($sender->id, $tag);
758 if (!empty($plist) && !$plist->private) {
759 $tagged = $sender->getTaggedSubscribers($tag);
761 $url = common_local_url('showprofiletag',
762 array('tagger' => $sender->nickname,
765 $mentions[] = array('mentioned' => $tagged,
766 'text' => $hmatch[0],
767 'position' => $hmatch[1],
772 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
779 * Does the actual regex pulls to find @-mentions in text.
780 * Should generally not be called directly; for use in common_find_mentions.
782 * @param string $text
783 * @return array of PCRE match arrays
785 function common_find_mentions_raw($text)
788 preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
791 PREG_OFFSET_CAPTURE);
793 $atmatches = array();
794 preg_match_all('/(?:^|\s+)@(' . Nickname::DISPLAY_FMT . ')\b/',
797 PREG_OFFSET_CAPTURE);
799 $matches = array_merge($tmatches[1], $atmatches[1]);
803 function common_render_text($text)
805 $r = htmlspecialchars($text);
807 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
808 $r = common_replace_urls_callback($r, 'common_linkify');
809 $r = preg_replace('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/ue', "'\\1#'.common_tag_link('\\2')", $r);
815 * Find links in the given text and pass them to the given callback function.
817 * @param string $text
818 * @param function($text, $arg) $callback: return replacement text
819 * @param mixed $arg: optional argument will be passed on to the callback
821 function common_replace_urls_callback($text, $callback, $arg = null) {
822 // Start off with a regex
824 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
827 '(?:'. //Known protocols
829 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
831 '(?:(?:mailto|aim|tel|xmpp):)'.
833 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
836 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
838 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
842 '|(?:(?: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
844 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
846 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
847 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
848 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
849 '(?: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)'.
853 '(?:\:\d+)?'. //:port
854 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
855 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
856 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
857 ')(?<![\?\.\,\#\,])'.
860 //preg_match_all($regex,$text,$matches);
862 return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
866 * Intermediate callback for common_replace_links(), helps resolve some
867 * ambiguous link forms before passing on to the final callback.
869 * @param array $matches
870 * @param callable $callback
871 * @param mixed $arg optional argument to pass on as second param to callback
876 function callback_helper($matches, $callback, $arg=null) {
878 $left = strpos($matches[0],$url);
879 $right = $left+strlen($url);
881 $groupSymbolSets=array(
899 $cannotEndWith=array('.','?',',','#');
903 foreach($groupSymbolSets as $groupSymbolSet){
904 if(substr($url,-1)==$groupSymbolSet['right']){
905 $group_left_count = substr_count($url,$groupSymbolSet['left']);
906 $group_right_count = substr_count($url,$groupSymbolSet['right']);
907 if($group_left_count<$group_right_count){
909 $url=substr($url,0,-1);
913 if(in_array(substr($url,-1),$cannotEndWith)){
915 $url=substr($url,0,-1);
917 }while($original_url!=$url);
919 $result = call_user_func_array($callback, array($url, $arg));
920 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
923 if (version_compare(PHP_VERSION, '5.3.0', 'ge')) {
924 // lambda implementation in a separate file; PHP 5.2 won't parse it.
925 require_once INSTALLDIR . "/lib/curry.php";
927 function curry($fn) {
928 $args = func_get_args();
930 $id = uniqid('_partial');
931 $GLOBALS[$id] = array($fn, $args);
932 return create_function('',
933 '$args = func_get_args(); '.
934 'return call_user_func_array('.
935 '$GLOBALS["'.$id.'"][0],'.
938 '$GLOBALS["'.$id.'"][1]));');
942 function common_linkify($url) {
943 // It comes in special'd, so we unspecial it before passing to the stringifying
945 $url = htmlspecialchars_decode($url);
947 if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
948 //url is an email address without the mailto: protocol
949 $canon = "mailto:$url";
950 $longurl = "mailto:$url";
953 $canon = File_redirection::_canonUrl($url);
955 $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
956 if (is_array($longurl_data)) {
957 $longurl = $longurl_data['url'];
958 } elseif (is_string($longurl_data)) {
959 $longurl = $longurl_data;
961 // Unable to reach the server to verify contents, etc
962 // Just pass the link on through for now.
963 common_log(LOG_ERR, "Can't linkify url '$url'");
968 $attrs = array('href' => $canon, 'title' => $longurl);
970 $is_attachment = false;
971 $attachment_id = null;
974 // Check to see whether this is a known "attachment" URL.
976 $f = File::staticGet('url', $longurl);
979 if (common_config('attachments', 'process_links')) {
980 // XXX: this writes to the database. :<
981 $f = File::processNew($longurl);
986 if ($f->getEnclosure()) {
987 $is_attachment = true;
988 $attachment_id = $f->id;
990 $thumb = File_thumbnail::staticGet('file_id', $f->id);
991 if (!empty($thumb)) {
998 if ($is_attachment) {
999 $attrs['class'] = 'attachment';
1001 $attrs['class'] = 'attachment thumbnail';
1003 $attrs['id'] = "attachment-{$attachment_id}";
1006 // Whether to nofollow
1008 $nf = common_config('nofollow', 'external');
1010 if ($nf == 'never') {
1011 $attrs['rel'] = 'external';
1013 $attrs['rel'] = 'nofollow external';
1016 return XMLStringer::estring('a', $attrs, $url);
1020 * Find and shorten links in a given chunk of text if it's longer than the
1021 * configured notice content limit (or unconditionally).
1023 * Side effects: may save file and file_redirection records for referenced URLs.
1025 * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1026 * user's options are used; otherwise the current web session user's setitngs
1027 * will be used or ur1.ca if there is no active web login.
1029 * @param string $text
1030 * @param boolean $always (optional)
1031 * @param User $user (optional)
1035 function common_shorten_links($text, $always = false, User $user=null)
1037 $user = common_current_user();
1039 $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1041 if ($always || mb_strlen($text) > $maxLength) {
1042 return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1044 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1049 * Very basic stripping of invalid UTF-8 input text.
1051 * @param string $str
1052 * @return mixed string or null if invalid input
1054 * @todo ideally we should drop bad chars, and maybe do some of the checks
1055 * from common_xml_safe_str. But we can't strip newlines, etc.
1056 * @todo Unicode normalization might also be useful, but not needed now.
1058 function common_validate_utf8($str)
1060 // preg_replace will return NULL on invalid UTF-8 input.
1062 // Note: empty regex //u also caused NULL return on some
1063 // production machines, but none of our test machines.
1065 // This should be replaced with a more reliable check.
1066 return preg_replace('/\x00/u', '', $str);
1070 * Make sure an arbitrary string is safe for output in XML as a single line.
1072 * @param string $str
1075 function common_xml_safe_str($str)
1077 // Replace common eol and extra whitespace input chars
1082 "\0", // null byte eos
1083 "\x0B" // vertical tab
1086 $replacement = array(
1087 ' ', // single space
1094 $str = str_replace($unWelcome, $replacement, $str);
1096 // Neutralize any additional control codes and UTF-16 surrogates
1097 // (Twitter uses '*')
1098 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1101 function common_tag_link($tag)
1103 $canonical = common_canonical_tag($tag);
1104 if (common_config('singleuser', 'enabled')) {
1105 // regular TagAction isn't set up in 1user mode
1106 $nickname = User::singleUserNickname();
1107 $url = common_local_url('showstream',
1108 array('nickname' => $nickname,
1109 'tag' => $canonical));
1111 $url = common_local_url('tag', array('tag' => $canonical));
1113 $xs = new XMLStringer();
1114 $xs->elementStart('span', 'tag');
1115 $xs->element('a', array('href' => $url,
1118 $xs->elementEnd('span');
1119 return $xs->getString();
1122 function common_canonical_tag($tag)
1124 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
1125 return str_replace(array('-', '_', '.'), '', $tag);
1128 function common_valid_profile_tag($str)
1130 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1135 * @param <type> $sender_id
1136 * @param <type> $nickname
1140 function common_group_link($sender_id, $nickname)
1142 $sender = Profile::staticGet($sender_id);
1143 $group = User_group::getForNickname($nickname, $sender);
1144 if ($sender && $group && $sender->isMember($group)) {
1145 $attrs = array('href' => $group->permalink(),
1147 if (!empty($group->fullname)) {
1148 $attrs['title'] = $group->getFancyName();
1150 $xs = new XMLStringer();
1151 $xs->elementStart('span', 'vcard');
1152 $xs->elementStart('a', $attrs);
1153 $xs->element('span', 'fn nickname group', $nickname);
1154 $xs->elementEnd('a');
1155 $xs->elementEnd('span');
1156 return $xs->getString();
1163 * Resolve an ambiguous profile nickname reference, checking in following order:
1164 * - profiles that $sender subscribes to
1165 * - profiles that subscribe to $sender
1166 * - local user profiles
1168 * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1169 * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1172 * @fixme validate input
1174 * @fixme fix or remove mystery third parameter
1175 * @fixme is $sender a User or Profile?
1177 * @param <type> $sender the user or profile in whose context we're looking
1178 * @param string $nickname validated nickname of
1179 * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1181 * @return Profile or null
1183 function common_relative_profile($sender, $nickname, $dt=null)
1185 // Will throw exception on invalid input.
1186 $nickname = Nickname::normalize($nickname);
1188 // Try to find profiles this profile is subscribed to that have this nickname
1189 $recipient = new Profile();
1190 // XXX: use a join instead of a subquery
1191 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1192 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1193 if ($recipient->find(true)) {
1194 // XXX: should probably differentiate between profiles with
1195 // the same name by date of most recent update
1198 // Try to find profiles that listen to this profile and that have this nickname
1199 $recipient = new Profile();
1200 // XXX: use a join instead of a subquery
1201 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1202 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1203 if ($recipient->find(true)) {
1204 // XXX: should probably differentiate between profiles with
1205 // the same name by date of most recent update
1208 // If this is a local user, try to find a local user with that nickname.
1209 $sender = User::staticGet($sender->id);
1211 $recipient_user = User::staticGet('nickname', $nickname);
1212 if ($recipient_user) {
1213 return $recipient_user->getProfile();
1216 // Otherwise, no links. @messages from local users to remote users,
1217 // or from remote users to other remote users, are just
1218 // outside our ability to make intelligent guesses about
1222 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1224 if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1226 $path = $r->build($action, $args, $params, $fragment);
1228 $ssl = common_is_sensitive($action);
1230 if (common_config('site','fancy')) {
1231 $url = common_path(mb_substr($path, 1), $ssl, $addSession);
1233 if (mb_strpos($path, '/index.php') === 0) {
1234 $url = common_path(mb_substr($path, 1), $ssl, $addSession);
1236 $url = common_path('index.php'.$path, $ssl, $addSession);
1239 Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1244 function common_is_sensitive($action)
1246 static $sensitive = array(
1251 'ApiOauthRequestToken',
1252 'ApiOauthAccessToken',
1253 'ApiOauthAuthorize',
1259 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1260 $ssl = in_array($action, $sensitive);
1266 function common_path($relative, $ssl=false, $addSession=true)
1268 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1270 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1271 || common_config('site', 'ssl') === 'always') {
1273 if (is_string(common_config('site', 'sslserver')) &&
1274 mb_strlen(common_config('site', 'sslserver')) > 0) {
1275 $serverpart = common_config('site', 'sslserver');
1276 } else if (common_config('site', 'server')) {
1277 $serverpart = common_config('site', 'server');
1279 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1283 if (common_config('site', 'server')) {
1284 $serverpart = common_config('site', 'server');
1286 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1291 $relative = common_inject_session($relative, $serverpart);
1294 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1297 function common_inject_session($url, $serverpart = null)
1299 if (common_have_session()) {
1301 if (empty($serverpart)) {
1302 $serverpart = parse_url($url, PHP_URL_HOST);
1305 $currentServer = $_SERVER['HTTP_HOST'];
1307 // Are we pointing to another server (like an SSL server?)
1309 if (!empty($currentServer) &&
1310 0 != strcasecmp($currentServer, $serverpart)) {
1311 // Pass the session ID as a GET parameter
1312 $sesspart = session_name() . '=' . session_id();
1313 $i = strpos($url, '?');
1314 if ($i === false) { // no GET params, just append
1315 $url .= '?' . $sesspart;
1317 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1325 function common_date_string($dt)
1327 // XXX: do some sexy date formatting
1328 // return date(DATE_RFC822, $dt);
1329 $t = strtotime($dt);
1333 if ($now < $t) { // that shouldn't happen!
1334 return common_exact_date($dt);
1335 } else if ($diff < 60) {
1336 // TRANS: Used in notices to indicate when the notice was made compared to now.
1337 return _('a few seconds ago');
1338 } else if ($diff < 92) {
1339 // TRANS: Used in notices to indicate when the notice was made compared to now.
1340 return _('about a minute ago');
1341 } else if ($diff < 3300) {
1342 $minutes = round($diff/60);
1343 // TRANS: Used in notices to indicate when the notice was made compared to now.
1344 return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1345 } else if ($diff < 5400) {
1346 // TRANS: Used in notices to indicate when the notice was made compared to now.
1347 return _('about an hour ago');
1348 } else if ($diff < 22 * 3600) {
1349 $hours = round($diff/3600);
1350 // TRANS: Used in notices to indicate when the notice was made compared to now.
1351 return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1352 } else if ($diff < 37 * 3600) {
1353 // TRANS: Used in notices to indicate when the notice was made compared to now.
1354 return _('about a day ago');
1355 } else if ($diff < 24 * 24 * 3600) {
1356 $days = round($diff/(24*3600));
1357 // TRANS: Used in notices to indicate when the notice was made compared to now.
1358 return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1359 } else if ($diff < 46 * 24 * 3600) {
1360 // TRANS: Used in notices to indicate when the notice was made compared to now.
1361 return _('about a month ago');
1362 } else if ($diff < 330 * 24 * 3600) {
1363 $months = round($diff/(30*24*3600));
1364 // TRANS: Used in notices to indicate when the notice was made compared to now.
1365 return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1366 } else if ($diff < 480 * 24 * 3600) {
1367 // TRANS: Used in notices to indicate when the notice was made compared to now.
1368 return _('about a year ago');
1370 return common_exact_date($dt);
1374 function common_exact_date($dt)
1380 $_utc = new DateTimeZone('UTC');
1381 $_siteTz = new DateTimeZone(common_timezone());
1384 $dateStr = date('d F Y H:i:s', strtotime($dt));
1385 $d = new DateTime($dateStr, $_utc);
1386 $d->setTimezone($_siteTz);
1387 return $d->format(DATE_RFC850);
1390 function common_date_w3dtf($dt)
1392 $dateStr = date('d F Y H:i:s', strtotime($dt));
1393 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1394 $d->setTimezone(new DateTimeZone(common_timezone()));
1395 return $d->format(DATE_W3C);
1398 function common_date_rfc2822($dt)
1400 $dateStr = date('d F Y H:i:s', strtotime($dt));
1401 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1402 $d->setTimezone(new DateTimeZone(common_timezone()));
1403 return $d->format('r');
1406 function common_date_iso8601($dt)
1408 $dateStr = date('d F Y H:i:s', strtotime($dt));
1409 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1410 $d->setTimezone(new DateTimeZone(common_timezone()));
1411 return $d->format('c');
1414 function common_sql_now()
1416 return common_sql_date(time());
1419 function common_sql_date($datetime)
1421 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1425 * Return an SQL fragment to calculate an age-based weight from a given
1426 * timestamp or datetime column.
1428 * @param string $column name of field we're comparing against current time
1429 * @param integer $dropoff divisor for age in seconds before exponentiation
1430 * @return string SQL fragment
1432 function common_sql_weight($column, $dropoff)
1434 if (common_config('db', 'type') == 'pgsql') {
1435 // PostgreSQL doesn't support timestampdiff function.
1436 // @fixme will this use the right time zone?
1437 // @fixme does this handle cross-year subtraction correctly?
1438 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1440 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1444 function common_redirect($url, $code=307)
1446 static $status = array(301 => "Moved Permanently",
1449 307 => "Temporary Redirect");
1451 header('HTTP/1.1 '.$code.' '.$status[$code]);
1452 header("Location: $url");
1454 $xo = new XMLOutputter();
1456 '-//W3C//DTD XHTML 1.0 Strict//EN',
1457 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1458 $xo->element('a', array('href' => $url), $url);
1463 // Stick the notice on the queue
1465 function common_enqueue_notice($notice)
1467 static $localTransports = array('omb',
1470 $transports = array();
1471 if (common_config('sms', 'enabled')) {
1472 $transports[] = 'sms';
1474 if (Event::hasHandler('HandleQueuedNotice')) {
1475 $transports[] = 'plugin';
1478 // We can skip these for gatewayed notices.
1479 if ($notice->isLocal()) {
1480 $transports = array_merge($transports, $localTransports);
1483 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1485 $qm = QueueManager::get();
1487 foreach ($transports as $transport)
1489 $qm->enqueue($notice, $transport);
1492 Event::handle('EndEnqueueNotice', array($notice, $transports));
1499 * Broadcast profile updates to OMB and other remote subscribers.
1501 * Since this may be slow with a lot of subscribers or bad remote sites,
1502 * this is run through the background queues if possible.
1504 function common_broadcast_profile(Profile $profile)
1506 $qm = QueueManager::get();
1507 $qm->enqueue($profile, "profile");
1511 function common_profile_url($nickname)
1513 return common_local_url('showstream', array('nickname' => $nickname),
1518 * Should make up a reasonable root URL
1520 function common_root_url($ssl=false)
1522 $url = common_path('', $ssl, false);
1523 $i = strpos($url, '?');
1525 $url = substr($url, 0, $i);
1531 * returns $bytes bytes of random data as a hexadecimal string
1532 * "good" here is a goal and not a guarantee
1534 function common_good_rand($bytes)
1536 // XXX: use random.org...?
1537 if (@file_exists('/dev/urandom')) {
1538 return common_urandom($bytes);
1539 } else { // FIXME: this is probably not good enough
1540 return common_mtrand($bytes);
1544 function common_urandom($bytes)
1546 $h = fopen('/dev/urandom', 'rb');
1548 $src = fread($h, $bytes);
1551 for ($i = 0; $i < $bytes; $i++) {
1552 $enc .= sprintf("%02x", (ord($src[$i])));
1557 function common_mtrand($bytes)
1560 for ($i = 0; $i < $bytes; $i++) {
1561 $enc .= sprintf("%02x", mt_rand(0, 255));
1567 * Record the given URL as the return destination for a future
1568 * form submission, to be read by common_get_returnto().
1570 * @param string $url
1572 * @fixme as a session-global setting, this can allow multiple forms
1573 * to conflict and overwrite each others' returnto destinations if
1574 * the user has multiple tabs or windows open.
1576 * Should refactor to index with a token or otherwise only pass the
1577 * data along its intended path.
1579 function common_set_returnto($url)
1581 common_ensure_session();
1582 $_SESSION['returnto'] = $url;
1586 * Fetch a return-destination URL previously recorded by
1587 * common_set_returnto().
1589 * @return mixed URL string or null
1591 * @fixme as a session-global setting, this can allow multiple forms
1592 * to conflict and overwrite each others' returnto destinations if
1593 * the user has multiple tabs or windows open.
1595 * Should refactor to index with a token or otherwise only pass the
1596 * data along its intended path.
1598 function common_get_returnto()
1600 common_ensure_session();
1601 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1604 function common_timestamp()
1606 return date('YmdHis');
1609 function common_ensure_syslog()
1611 static $initialized = false;
1612 if (!$initialized) {
1613 openlog(common_config('syslog', 'appname'), 0,
1614 common_config('syslog', 'facility'));
1615 $initialized = true;
1619 function common_log_line($priority, $msg)
1621 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1622 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1623 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1626 function common_request_id()
1629 $server = common_config('site', 'server');
1630 if (php_sapi_name() == 'cli') {
1631 $script = basename($_SERVER['PHP_SELF']);
1632 return "$server:$script:$pid";
1634 static $req_id = null;
1635 if (!isset($req_id)) {
1636 $req_id = substr(md5(mt_rand()), 0, 8);
1638 if (isset($_SERVER['REQUEST_URI'])) {
1639 $url = $_SERVER['REQUEST_URI'];
1641 $method = $_SERVER['REQUEST_METHOD'];
1642 return "$server:$pid.$req_id $method $url";
1646 function common_log($priority, $msg, $filename=null)
1648 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1649 $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1650 $msg = '[' . common_request_id() . '] ' . $msg;
1651 $logfile = common_config('site', 'logfile');
1653 $log = fopen($logfile, "a");
1655 $output = common_log_line($priority, $msg);
1656 fwrite($log, $output);
1660 common_ensure_syslog();
1661 syslog($priority, $msg);
1663 Event::handle('EndLog', array($priority, $msg, $filename));
1667 function common_debug($msg, $filename=null)
1670 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1672 common_log(LOG_DEBUG, $msg);
1676 function common_log_db_error(&$object, $verb, $filename=null)
1678 $objstr = common_log_objstring($object);
1679 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1680 if (is_object($last_error)) {
1681 $msg = $last_error->message;
1683 $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1685 common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1688 function common_log_objstring(&$object)
1690 if (is_null($object)) {
1693 if (!($object instanceof DB_DataObject)) {
1696 $arr = $object->toArray();
1698 foreach ($arr as $k => $v) {
1699 if (is_object($v)) {
1700 $fields[] = "$k='".get_class($v)."'";
1702 $fields[] = "$k='$v'";
1705 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1709 function common_valid_http_url($url)
1711 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1714 function common_valid_tag($tag)
1716 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1717 return (Validate::email($matches[1]) ||
1718 preg_match('/^([\w-\.]+)$/', $matches[1]));
1724 * Determine if given domain or address literal is valid
1725 * eg for use in JIDs and URLs. Does not check if the domain
1728 * @param string $domain
1729 * @return boolean valid or not
1731 function common_valid_domain($domain)
1733 $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1734 $ipv4 = "(?:$octet(?:\.$octet){3})";
1735 if (preg_match("/^$ipv4$/u", $domain)) return true;
1737 $group = "(?:[0-9a-f]{1,4})";
1738 $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1740 if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1741 $before = explode(":", $matches[1]);
1742 $zeroes = $matches[2];
1743 $after = explode(":", $matches[3]);
1751 $explicit = count($before) + count($after);
1752 if ($explicit < $min || $explicit > $max) {
1759 require_once "Net/IDNA.php";
1760 $idn = Net_IDNA::getInstance();
1761 $domain = $idn->encode($domain);
1762 } catch (Exception $e) {
1766 $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1767 $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1769 return preg_match("/^$fqdn$/ui", $domain);
1772 /* Following functions are copied from MediaWiki GlobalFunctions.php
1773 * and written by Evan Prodromou. */
1775 function common_accept_to_prefs($accept, $def = '*/*')
1777 // No arg means accept anything (per HTTP spec)
1779 return array($def => 1);
1784 $parts = explode(',', $accept);
1786 foreach($parts as $part) {
1787 // FIXME: doesn't deal with params like 'text/html; level=1'
1788 @list($value, $qpart) = explode(';', trim($part));
1790 if(!isset($qpart)) {
1792 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1793 $prefs[$value] = $match[1];
1800 function common_mime_type_match($type, $avail)
1802 if(array_key_exists($type, $avail)) {
1805 $parts = explode('/', $type);
1806 if(array_key_exists($parts[0] . '/*', $avail)) {
1807 return $parts[0] . '/*';
1808 } elseif(array_key_exists('*/*', $avail)) {
1816 function common_negotiate_type($cprefs, $sprefs)
1820 foreach(array_keys($sprefs) as $type) {
1821 $parts = explode('/', $type);
1822 if($parts[1] != '*') {
1823 $ckey = common_mime_type_match($type, $cprefs);
1825 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1830 foreach(array_keys($cprefs) as $type) {
1831 $parts = explode('/', $type);
1832 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1833 $skey = common_mime_type_match($type, $sprefs);
1835 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1841 $besttype = 'text/html';
1843 foreach(array_keys($combine) as $type) {
1844 if($combine[$type] > $bestq) {
1846 $bestq = $combine[$type];
1850 if ('text/html' === $besttype) {
1851 return "text/html; charset=utf-8";
1856 function common_config($main, $sub)
1859 return (array_key_exists($main, $config) &&
1860 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1864 * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
1865 * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
1867 * @param array $from
1870 function common_copy_args($from)
1873 $strip = get_magic_quotes_gpc();
1874 foreach ($from as $k => $v) {
1876 $to[$k] = common_copy_args($v);
1879 $v = stripslashes($v);
1881 $to[$k] = strval(common_validate_utf8($v));
1888 * Neutralise the evil effects of magic_quotes_gpc in the current request.
1889 * This is used before handing a request off to OAuthRequest::from_request.
1890 * @fixme Doesn't consider vars other than _POST and _GET?
1891 * @fixme Can't be undone and could corrupt data if run twice.
1893 function common_remove_magic_from_request()
1895 if(get_magic_quotes_gpc()) {
1896 $_POST=array_map('stripslashes',$_POST);
1897 $_GET=array_map('stripslashes',$_GET);
1901 function common_user_uri(&$user)
1903 return common_local_url('userbyid', array('id' => $user->id),
1907 function common_notice_uri(&$notice)
1909 return common_local_url('shownotice',
1910 array('notice' => $notice->id),
1914 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1916 function common_confirmation_code($bits)
1918 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1919 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1920 $chars = ceil($bits/5);
1922 for ($i = 0; $i < $chars; $i++) {
1923 // XXX: convert to string and back
1924 $num = hexdec(common_good_rand(1));
1925 // XXX: randomness is too precious to throw away almost
1926 // 40% of the bits we get!
1927 $code .= $codechars[$num%32];
1932 // convert markup to HTML
1934 function common_markup_to_html($c)
1936 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1937 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1938 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1939 return Markdown($c);
1942 function common_profile_uri($profile)
1947 $user = User::staticGet($profile->id);
1952 $remote = Remote_profile::staticGet($profile->id);
1954 return $remote->uri;
1956 // XXX: this is a very bad profile!
1960 function common_canonical_sms($sms)
1963 preg_replace('/\D/', '', $sms);
1967 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1972 case E_COMPILE_ERROR:
1976 case E_RECOVERABLE_ERROR:
1977 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1982 case E_COMPILE_WARNING:
1983 case E_CORE_WARNING:
1984 case E_USER_WARNING:
1985 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1990 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1995 case E_USER_DEPRECATED:
1996 // XXX: config variable to log this stuff, too
2000 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2005 // FIXME: show error page if we're on the Web
2006 /* Don't execute PHP internal error handler */
2010 function common_session_token()
2012 common_ensure_session();
2013 if (!array_key_exists('token', $_SESSION)) {
2014 $_SESSION['token'] = common_good_rand(64);
2016 return $_SESSION['token'];
2019 function common_license_terms($uri)
2021 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2022 return explode('-',$matches[1]);
2027 function common_compatible_license($from, $to)
2029 $from_terms = common_license_terms($from);
2030 // public domain and cc-by are compatible with everything
2031 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2034 $to_terms = common_license_terms($to);
2035 // sa is compatible across versions. IANAL
2036 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2037 return count(array_diff($from_terms, $to_terms)) == 0;
2039 // XXX: better compatibility check needed here!
2040 // Should at least normalise URIs
2041 return ($from == $to);
2045 * returns a quoted table name, if required according to config
2047 function common_database_tablename($tablename)
2049 if(common_config('db','quote_identifiers')) {
2050 $tablename = '"'. $tablename .'"';
2052 //table prefixes could be added here later
2057 * Shorten a URL with the current user's configured shortening service,
2058 * or ur1.ca if configured, or not at all if no shortening is set up.
2060 * @param string $long_url original URL
2061 * @param User $user to specify a particular user's options
2062 * @param boolean $force Force shortening (used when notice is too long)
2063 * @return string may return the original URL if shortening failed
2065 * @fixme provide a way to specify a particular shortener
2067 function common_shorten_url($long_url, User $user=null, $force = false)
2069 $long_url = trim($long_url);
2071 $user = common_current_user();
2073 $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2075 // $force forces shortening even if it's not strictly needed
2076 // I doubt URL shortening is ever 'strictly' needed. - ESP
2078 if (mb_strlen($long_url) < $maxUrlLength && !$force) {
2082 $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2084 if (Event::handle('StartShortenUrl',
2085 array($long_url, $shortenerName, &$shortenedUrl))) {
2086 if ($shortenerName == 'internal') {
2087 $f = File::processNew($long_url);
2091 $shortenedUrl = common_local_url('redirecturl',
2092 array('id' => $f->id));
2093 return $shortenedUrl;
2099 //URL was shortened, so return the result
2100 return trim($shortenedUrl);
2105 * @return mixed array($proxy, $ip) for web requests; proxy may be null
2106 * null if not a web request
2108 * @fixme X-Forwarded-For can be chained by multiple proxies;
2109 we should parse the list and provide a cleaner array
2110 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2111 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2112 * use function to get exact request headers from Apache if possible.
2114 function common_client_ip()
2116 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2120 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2121 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2122 $proxy = $_SERVER['HTTP_CLIENT_IP'];
2124 $proxy = $_SERVER['REMOTE_ADDR'];
2126 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2129 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2130 $ip = $_SERVER['HTTP_CLIENT_IP'];
2132 $ip = $_SERVER['REMOTE_ADDR'];
2136 return array($proxy, $ip);
2139 function common_url_to_nickname($url)
2141 static $bad = array('query', 'user', 'password', 'port', 'fragment');
2143 $parts = parse_url($url);
2145 // If any of these parts exist, this won't work
2147 foreach ($bad as $badpart) {
2148 if (array_key_exists($badpart, $parts)) {
2153 // We just have host and/or path
2155 // If it's just a host...
2156 if (array_key_exists('host', $parts) &&
2157 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2159 $hostparts = explode('.', $parts['host']);
2161 // Try to catch common idiom of nickname.service.tld
2163 if ((count($hostparts) > 2) &&
2164 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2165 (strcmp($hostparts[0], 'www') != 0))
2167 return common_nicknamize($hostparts[0]);
2169 // Do the whole hostname
2170 return common_nicknamize($parts['host']);
2173 if (array_key_exists('path', $parts)) {
2174 // Strip starting, ending slashes
2175 $path = preg_replace('@/$@', '', $parts['path']);
2176 $path = preg_replace('@^/@', '', $path);
2177 $path = basename($path);
2179 // Hack for MediaWiki user pages, in the form:
2180 // http://example.com/wiki/User:Myname
2181 // ('User' may be localized.)
2182 if (strpos($path, ':')) {
2183 $parts = array_filter(explode(':', $path));
2184 $path = $parts[count($parts) - 1];
2188 return common_nicknamize($path);
2196 function common_nicknamize($str)
2198 $str = preg_replace('/\W/', '', $str);
2199 return strtolower($str);
2202 function common_perf_counter($key, $val=null)
2204 global $_perfCounters;
2205 if (isset($_perfCounters)) {
2206 if (common_config('site', 'logperf')) {
2207 if (array_key_exists($key, $_perfCounters)) {
2208 $_perfCounters[$key][] = $val;
2210 $_perfCounters[$key] = array($val);
2212 if (common_config('site', 'logperf_detail')) {
2213 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2219 function common_log_perf_counters()
2221 if (common_config('site', 'logperf')) {
2222 global $_startTime, $_perfCounters;
2224 if (isset($_startTime)) {
2225 $endTime = microtime(true);
2226 $diff = round(($endTime - $_startTime) * 1000);
2227 common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2229 $counters = $_perfCounters;
2231 foreach ($counters as $key => $values) {
2232 $count = count($values);
2233 $unique = count(array_unique($values));
2234 common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");