3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008-2011, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 /* XXX: break up into separate modules (HTTP, user, files) */
23 * Show a server error.
25 function common_server_error($msg, $code=500)
27 $err = new ServerErrorAction($msg, $code);
34 function common_user_error($msg, $code=400)
36 $err = new ClientErrorAction($msg, $code);
41 * This should only be used at setup; processes switching languages
42 * to send text to other users should use common_switch_locale().
44 * @param string $language Locale language code (optional; empty uses
45 * current user's preference or site default)
46 * @return mixed success
48 function common_init_locale($language=null)
51 $language = common_language();
53 putenv('LANGUAGE='.$language);
54 putenv('LANG='.$language);
55 $ok = setlocale(LC_ALL, $language . ".utf8",
65 * Initialize locale and charset settings and gettext with our message catalog,
66 * using the current user's language preference or the site default.
68 * This should generally only be run at framework initialization; code switching
69 * languages at runtime should call common_switch_language().
73 function common_init_language()
75 mb_internal_encoding('UTF-8');
77 // Note that this setlocale() call may "fail" but this is harmless;
78 // gettext will still select the right language.
79 $language = common_language();
80 $locale_set = common_init_locale($language);
83 // The requested locale doesn't exist on the system.
85 // gettext seems very picky... We first need to setlocale()
86 // to a locale which _does_ exist on the system, and _then_
87 // we can set in another locale that may not be set up
88 // (say, ga_ES for Galego/Galician) it seems to take it.
90 // For some reason C and POSIX which are guaranteed to work
91 // don't do the job. en_US.UTF-8 should be there most of the
92 // time, but not guaranteed.
93 $ok = common_init_locale("en_US");
94 if (!$ok && strtolower(substr(PHP_OS, 0, 3)) != 'win') {
95 // Try to find a complete, working locale on Unix/Linux...
96 // @fixme shelling out feels awfully inefficient
97 // but I don't think there's a more standard way.
99 foreach (explode("\n", $all) as $locale) {
100 if (preg_match('/\.utf[-_]?8$/i', $locale)) {
101 $ok = setlocale(LC_ALL, $locale);
109 common_log(LOG_ERR, "Unable to find a UTF-8 locale on this system; UI translations may not work.");
111 $locale_set = common_init_locale($language);
114 common_init_gettext();
120 function common_init_gettext()
122 setlocale(LC_CTYPE, 'C');
123 // So we do not have to make people install the gettext locales
124 $path = common_config('site','locale_path');
125 bindtextdomain("statusnet", $path);
126 bind_textdomain_codeset("statusnet", "UTF-8");
127 textdomain("statusnet");
131 * Switch locale during runtime, and poke gettext until it cries uncle.
132 * Otherwise, sometimes it doesn't actually switch away from the old language.
134 * @param string $language code for locale ('en', 'fr', 'pt_BR' etc)
136 function common_switch_locale($language=null)
138 common_init_locale($language);
140 setlocale(LC_CTYPE, 'C');
141 // So we do not have to make people install the gettext locales
142 $path = common_config('site','locale_path');
143 bindtextdomain("statusnet", $path);
144 bind_textdomain_codeset("statusnet", "UTF-8");
145 textdomain("statusnet");
148 function common_timezone()
150 if (common_logged_in()) {
151 $user = common_current_user();
152 if ($user->timezone) {
153 return $user->timezone;
157 return common_config('site', 'timezone');
160 function common_valid_language($lang)
163 // Validate -- we don't want to end up with a bogus code
164 // left over from some old junk.
165 foreach (common_config('site', 'languages') as $code => $info) {
166 if ($info['lang'] == $lang) {
174 function common_language()
176 // Allow ?uselang=xx override, very useful for debugging
177 // and helping translators check usage and context.
178 if (isset($_GET['uselang'])) {
179 $uselang = strval($_GET['uselang']);
180 if (common_valid_language($uselang)) {
185 // If there is a user logged in and they've set a language preference
186 // then return that one...
187 if (_have_config() && common_logged_in()) {
188 $user = common_current_user();
190 if (common_valid_language($user->language)) {
191 return $user->language;
195 // Otherwise, find the best match for the languages requested by the
197 if (common_config('site', 'langdetect')) {
198 $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
199 if (!empty($httplang)) {
200 $language = client_prefered_language($httplang);
206 // Finally, if none of the above worked, use the site's default...
207 return common_config('site', 'language');
211 * Salted, hashed passwords are stored in the DB.
213 function common_munge_password($password, Profile $profile=null)
217 if (Event::handle('StartHashPassword', array(&$hashed, $password, $profile))) {
218 Event::handle('EndHashPassword', array(&$hashed, $password, $profile));
220 if (empty($hashed)) {
221 throw new PasswordHashException();
228 * Check if a username exists and has matching password.
230 function common_check_user($nickname, $password)
232 // empty nickname always unacceptable
233 if (empty($nickname)) {
237 $authenticatedUser = false;
239 if (Event::handle('StartCheckPassword', array($nickname, $password, &$authenticatedUser))) {
241 if (common_is_email($nickname)) {
242 $user = User::getKV('email', common_canonical_email($nickname));
244 $user = User::getKV('nickname', Nickname::normalize($nickname));
247 if ($user instanceof User && !empty($password)) {
248 if (0 == strcmp(common_munge_password($password, $user->getProfile()), $user->password)) {
249 //internal checking passed
250 $authenticatedUser = $user;
254 Event::handle('EndCheckPassword', array($nickname, $password, $authenticatedUser));
256 return $authenticatedUser;
260 * Is the current user logged in?
262 function common_logged_in()
264 return (!is_null(common_current_user()));
267 function common_local_referer()
269 return parse_url($_SERVER['HTTP_REFERER'], PHP_URL_HOST) === common_config('site', 'server');
272 function common_have_session()
274 return (0 != strcmp(session_id(), ''));
277 function common_ensure_session()
280 if (array_key_exists(session_name(), $_COOKIE)) {
281 $c = $_COOKIE[session_name()];
283 if (!common_have_session()) {
284 if (common_config('sessions', 'handle')) {
285 Session::setSaveHandler();
287 if (array_key_exists(session_name(), $_GET)) {
288 $id = $_GET[session_name()];
289 } else if (array_key_exists(session_name(), $_COOKIE)) {
290 $id = $_COOKIE[session_name()];
296 if (!isset($_SESSION['started'])) {
297 $_SESSION['started'] = time();
299 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
300 ' is set but started value is null');
306 // Three kinds of arguments:
311 // Initialize to false; set to null if none found
314 function common_set_user($user)
318 if (is_null($user) && common_have_session()) {
320 unset($_SESSION['userid']);
322 } else if (is_string($user)) {
324 $user = User::getKV('nickname', $nickname);
325 } else if (!$user instanceof User) {
330 if (Event::handle('StartSetUser', array(&$user))) {
332 if (!$user->hasRight(Right::WEBLOGIN)) {
333 // TRANS: Authorisation exception thrown when a user a not allowed to login.
334 throw new AuthorizationException(_('Not allowed to log in.'));
336 common_ensure_session();
337 $_SESSION['userid'] = $user->id;
339 Event::handle('EndSetUser', array($user));
347 function common_set_cookie($key, $value, $expiration=0)
349 $path = common_config('site', 'path');
350 $server = common_config('site', 'server');
352 if ($path && ($path != '/')) {
353 $cookiepath = '/' . $path . '/';
357 return setcookie($key,
362 GNUsocial::useHTTPS());
365 define('REMEMBERME', 'rememberme');
366 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
368 function common_rememberme($user=null)
371 $user = common_current_user();
377 $rm = new Remember_me();
379 $rm->code = common_random_hexstr(16);
380 $rm->user_id = $user->id;
382 // Wrap the insert in some good ol' fashioned transaction code
386 $result = $rm->insert();
389 common_log_db_error($rm, 'INSERT', __FILE__);
390 $rm->query('ROLLBACK');
394 $rm->query('COMMIT');
396 $cookieval = $rm->user_id . ':' . $rm->code;
398 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
400 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
405 function common_remembered_user()
409 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
415 list($id, $code) = explode(':', $packed);
417 if (!$id || !$code) {
418 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
423 $rm = Remember_me::getKV('code', $code);
426 common_log(LOG_WARNING, 'No such remember code: ' . $code);
431 if ($rm->user_id != $id) {
432 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
437 $user = User::getKV('id', $rm->user_id);
439 if (!$user instanceof User) {
440 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
446 $result = $rm->delete();
449 common_log_db_error($rm, 'DELETE', __FILE__);
450 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
455 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
457 common_set_user($user);
458 common_real_login(false);
460 // We issue a new cookie, so they can log in
461 // automatically again after this session
463 common_rememberme($user);
469 * must be called with a valid user!
471 function common_forgetme()
473 common_set_cookie(REMEMBERME, '', 0);
477 * Who is the current user?
479 function common_current_user()
483 if (!_have_config()) {
487 if ($_cur === false) {
489 if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
490 || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
491 common_ensure_session();
492 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
494 $user = User::getKV('id', $id);
495 if ($user instanceof User) {
502 // that didn't work; try to remember; will init $_cur to null on failure
503 $_cur = common_remembered_user();
506 // XXX: Is this necessary?
507 $_SESSION['userid'] = $_cur->id;
515 * Logins that are 'remembered' aren't 'real' -- they're subject to
516 * cookie-stealing. So, we don't let them do certain things. New reg,
517 * OpenID, and password logins _are_ real.
519 function common_real_login($real=true)
521 common_ensure_session();
522 $_SESSION['real_login'] = $real;
525 function common_is_real_login()
527 return common_logged_in() && $_SESSION['real_login'];
531 * Get a hash portion for HTTP caching Etags and such including
532 * info on the current user's session. If login/logout state changes,
533 * or we've changed accounts, or we've renamed the current user,
534 * we'll get a new hash value.
536 * This should not be considered secure information.
538 * @param User $user (optional; uses common_current_user() if left out)
541 function common_user_cache_hash($user=false)
543 if ($user === false) {
544 $user = common_current_user();
547 return crc32($user->id . ':' . $user->nickname);
554 * get canonical version of nickname for comparison
556 * @param string $nickname
559 * @throws NicknameException on invalid input
560 * @deprecated call Nickname::normalize() directly.
562 function common_canonical_nickname($nickname)
564 return Nickname::normalize($nickname);
568 * get canonical version of email for comparison
570 * @fixme actually normalize
571 * @fixme reject invalid input
573 * @param string $email
576 function common_canonical_email($email)
578 // XXX: canonicalize UTF-8
579 // XXX: lcase the domain part
583 function common_to_alphanumeric($str)
585 $filtered = preg_replace('/[^A-Za-z0-9]\s*/', '', $str);
586 if (strlen($filtered) < 1) {
587 throw new Exception('Filtered string was zero-length.');
592 function common_purify($html)
594 require_once INSTALLDIR.'/extlib/HTMLPurifier/HTMLPurifier.auto.php';
596 $cfg = HTMLPurifier_Config::createDefault();
597 $cfg->set('Attr.AllowedRel', ['bookmark', 'directory', 'enclosure', 'home', 'license', 'nofollow', 'payment', 'tag']); // http://microformats.org/wiki/rel
598 $cfg->set('HTML.ForbiddenAttributes', array('style')); // id, on* etc. are already filtered by default
599 $cfg->set('URI.AllowedSchemes', array_fill_keys(common_url_schemes(), true));
601 // Remove more elements than what the default filter removes, default in GNU social are remotely
602 // linked resources such as img, video, audio
603 $forbiddenElements = array();
604 foreach (common_config('htmlfilter') as $tag=>$filter) {
605 if ($filter === true) {
606 $forbiddenElements[] = $tag;
609 $cfg->set('HTML.ForbiddenElements', $forbiddenElements);
611 $html = common_remove_unicode_formatting($html);
613 $purifier = new HTMLPurifier($cfg);
614 $purified = $purifier->purify($html);
615 Event::handle('EndCommonPurify', array(&$purified, $html));
620 function common_remove_unicode_formatting($text)
622 // Strip Unicode text formatting/direction codes
623 // this is pretty dangerous for visualisation of text and can be used for mischief
624 return preg_replace('/[\\x{200b}-\\x{200f}\\x{202a}-\\x{202e}]/u', '', $text);
628 * Partial notice markup rendering step: build links to !group references.
630 * @param string $text partially rendered HTML
631 * @param Profile $author the Profile that is composing the current notice
632 * @param Notice $parent the Notice this is sent in reply to, if any
633 * @return string partially rendered HTML
635 function common_render_content($text, Profile $author, Notice $parent=null)
637 $text = common_render_text($text);
638 $text = common_linkify_mentions($text, $author, $parent);
643 * Finds @-mentions within the partially-rendered text section and
644 * turns them into live links.
646 * Should generally not be called except from common_render_content().
648 * @param string $text partially-rendered HTML
649 * @param Profile $author the Profile that is composing the current notice
650 * @param Notice $parent the Notice this is sent in reply to, if any
651 * @return string partially-rendered HTML
653 function common_linkify_mentions($text, Profile $author, Notice $parent=null)
655 $mentions = common_find_mentions($text, $author, $parent);
657 // We need to go through in reverse order by position,
658 // so our positions stay valid despite our fudging with the
663 foreach ($mentions as $mention)
665 $points[$mention['position']] = $mention;
670 foreach ($points as $position => $mention) {
672 $linkText = common_linkify_mention($mention);
674 $text = substr_replace($text, $linkText, $position, $mention['length']);
680 function common_linkify_mention(array $mention)
684 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
686 $xs = new XMLStringer(false);
688 $attrs = array('href' => $mention['url'],
689 'class' => 'h-card '.$mention['type']);
691 if (!empty($mention['title'])) {
692 $attrs['title'] = $mention['title'];
695 $xs->element('a', $attrs, $mention['text']);
697 $output = $xs->getString();
699 Event::handle('EndLinkifyMention', array($mention, &$output));
705 function common_get_attentions($text, Profile $sender, Notice $parent=null)
707 $mentions = common_find_mentions($text, $sender, $parent);
709 foreach ($mentions as $mention) {
710 foreach ($mention['mentioned'] as $mentioned) {
711 $atts[$mentioned->getUri()] = $mentioned->getObjectType();
714 if ($parent instanceof Notice) {
715 $parentAuthor = $parent->getProfile();
716 // afaik groups can't be authors
717 $atts[$parentAuthor->getUri()] = ActivityObject::PERSON;
723 * Find @-mentions in the given text, using the given notice object as context.
724 * References will be resolved with common_relative_profile() against the user
725 * who posted the notice.
727 * Note the return data format is internal, to be used for building links and
728 * such. Should not be used directly; rather, call common_linkify_mentions().
730 * @param string $text
731 * @param Profile $sender the Profile that is sending the current text
732 * @param Notice $parent the Notice this text is in reply to, if any
738 function common_find_mentions($text, Profile $sender, Notice $parent=null)
742 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
743 // Get the context of the original notice, if any
744 $origMentions = array();
745 // Does it have a parent notice for context?
746 if ($parent instanceof Notice) {
747 foreach ($parent->getAttentionProfiles() as $repliedTo) {
748 if (!$repliedTo->isPerson()) {
751 $origMentions[$repliedTo->id] = $repliedTo;
755 $matches = common_find_mentions_raw($text);
757 foreach ($matches as $match) {
759 $nickname = Nickname::normalize($match[0]);
760 } catch (NicknameException $e) {
761 // Bogus match? Drop it.
765 // primarily mention the profiles mentioned in the parent
766 $mention_found_in_origMentions = false;
767 foreach($origMentions as $origMentionsId=>$origMention) {
768 if($origMention->getNickname() == $nickname) {
769 $mention_found_in_origMentions = $origMention;
770 // don't mention same twice! the parent might have mentioned
771 // two users with same nickname on different instances
772 unset($origMentions[$origMentionsId]);
777 // Try to get a profile for this nickname.
778 // Start with parents mentions, then go to parents sender context
779 if ($mention_found_in_origMentions) {
780 $mentioned = $mention_found_in_origMentions;
781 } else if ($parent instanceof Notice && $parent->getProfile()->getNickname() === $nickname) {
782 $mentioned = $parent->getProfile();
784 // sets to null if no match
785 $mentioned = common_relative_profile($sender, $nickname);
788 if ($mentioned instanceof Profile) {
790 $url = $mentioned->getUri(); // prefer the URI as URL, if it is one.
791 if (!common_valid_http_url($url)) {
792 $url = $mentioned->getUrl();
794 } catch (InvalidUrlException $e) {
795 $url = common_local_url('userbyid', array('id' => $mentioned->getID()));
798 $mention = array('mentioned' => array($mentioned),
801 'position' => $match[1],
802 'length' => mb_strlen($match[0]),
803 'title' => $mentioned->getFullname(),
806 $mentions[] = $mention;
810 // @#tag => mention of all subscriptions tagged 'tag'
812 preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
813 $text, $hmatches, PREG_OFFSET_CAPTURE);
814 foreach ($hmatches[1] as $hmatch) {
815 $tag = common_canonical_tag($hmatch[0]);
816 $plist = Profile_list::getByTaggerAndTag($sender->getID(), $tag);
817 if (!$plist instanceof Profile_list || $plist->private) {
820 $tagged = $sender->getTaggedSubscribers($tag);
822 $url = common_local_url('showprofiletag',
823 array('nickname' => $sender->getNickname(),
826 $mentions[] = array('mentioned' => $tagged,
828 'text' => $hmatch[0],
829 'position' => $hmatch[1],
830 'length' => mb_strlen($hmatch[0]),
834 preg_match_all('/(?:^|[\s\.\,\:\;]+)!(' . Nickname::DISPLAY_FMT . ')/',
835 $text, $hmatches, PREG_OFFSET_CAPTURE);
836 foreach ($hmatches[1] as $hmatch) {
837 $nickname = Nickname::normalize($hmatch[0]);
838 $group = User_group::getForNickname($nickname, $sender);
840 if (!$group instanceof User_group || !$sender->isMember($group)) {
844 $profile = $group->getProfile();
846 $mentions[] = array('mentioned' => array($profile),
848 'text' => $hmatch[0],
849 'position' => $hmatch[1],
850 'length' => mb_strlen($hmatch[0]),
851 'url' => $group->permalink(),
852 'title' => $group->getFancyName());
855 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
862 * Does the actual regex pulls to find @-mentions in text.
863 * Should generally not be called directly; for use in common_find_mentions.
865 * @param string $text
866 * @return array of PCRE match arrays
868 function common_find_mentions_raw($text)
871 preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
874 PREG_OFFSET_CAPTURE);
876 $atmatches = array();
877 // the regexp's "(?!\@)" makes sure it doesn't matches the single "@remote" in "@remote@server.com"
878 preg_match_all('/(?:^|\s+)@(' . Nickname::DISPLAY_FMT . ')\b(?!\@)/',
881 PREG_OFFSET_CAPTURE);
883 $matches = array_merge($tmatches[1], $atmatches[1]);
887 function common_render_text($text)
889 $text = common_remove_unicode_formatting($text);
890 $text = nl2br(htmlspecialchars($text));
892 $text = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $text);
893 $text = common_replace_urls_callback($text, 'common_linkify');
894 $text = preg_replace_callback('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
895 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $text);
900 define('_URL_SCHEME_COLON_DOUBLE_SLASH', 1);
901 define('_URL_SCHEME_SINGLE_COLON', 2);
902 define('_URL_SCHEME_NO_DOMAIN', 4);
903 define('_URL_SCHEME_COLON_COORDINATES', 8);
905 function common_url_schemes($filter=null)
907 // TODO: move these to $config
909 'http' => _URL_SCHEME_COLON_DOUBLE_SLASH,
910 'https' => _URL_SCHEME_COLON_DOUBLE_SLASH,
911 'ftp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
912 'ftps' => _URL_SCHEME_COLON_DOUBLE_SLASH,
913 'mms' => _URL_SCHEME_COLON_DOUBLE_SLASH,
914 'rtsp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
915 'gopher' => _URL_SCHEME_COLON_DOUBLE_SLASH,
916 'news' => _URL_SCHEME_COLON_DOUBLE_SLASH,
917 'nntp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
918 'telnet' => _URL_SCHEME_COLON_DOUBLE_SLASH,
919 'wais' => _URL_SCHEME_COLON_DOUBLE_SLASH,
920 'file' => _URL_SCHEME_COLON_DOUBLE_SLASH,
921 'prospero' => _URL_SCHEME_COLON_DOUBLE_SLASH,
922 'webcal' => _URL_SCHEME_COLON_DOUBLE_SLASH,
923 'irc' => _URL_SCHEME_COLON_DOUBLE_SLASH,
924 'ircs' => _URL_SCHEME_COLON_DOUBLE_SLASH,
925 'aim' => _URL_SCHEME_SINGLE_COLON,
926 'bitcoin' => _URL_SCHEME_SINGLE_COLON,
927 'fax' => _URL_SCHEME_SINGLE_COLON,
928 'jabber' => _URL_SCHEME_SINGLE_COLON,
929 'mailto' => _URL_SCHEME_SINGLE_COLON,
930 'tel' => _URL_SCHEME_SINGLE_COLON,
931 'xmpp' => _URL_SCHEME_SINGLE_COLON,
932 'magnet' => _URL_SCHEME_NO_DOMAIN,
933 'geo' => _URL_SCHEME_COLON_COORDINATES,
937 array_filter($schemes,
938 function ($scheme) use ($filter) {
939 return is_null($filter) || ($scheme & $filter);
945 * Find links in the given text and pass them to the given callback function.
947 * @param string $text
948 * @param function($text, $arg) $callback: return replacement text
949 * @param mixed $arg: optional argument will be passed on to the callback
951 function common_replace_urls_callback($text, $callback, $arg = null) {
952 $geouri_labeltext_regex = '\pN\pL\-';
953 $geouri_mark_regex = '\-\_\.\!\~\*\\\'\(\)'; // the \\\' is really pretty
954 $geouri_unreserved_regex = '\pN\pL' . $geouri_mark_regex;
955 $geouri_punreserved_regex = '\[\]\:\&\+\$';
956 $geouri_pctencoded_regex = '(?:\%[0-9a-fA-F][0-9a-fA-F])';
957 $geouri_paramchar_regex = $geouri_unreserved_regex . $geouri_punreserved_regex; //FIXME: add $geouri_pctencoded_regex here so it works
959 // Start off with a regex
961 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
964 '(?:'. //Known protocols
966 '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_DOUBLE_SLASH)) . ')://)'.
968 '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_SINGLE_COLON)) . '):)'.
970 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
973 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
975 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
980 '(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_COORDINATES)) . '):'.
981 // There's an order that must be followed here too, if ;crs= is used, it must precede ;u=
982 // Also 'crsp' (;crs=$crsp) must match $geouri_labeltext_regex
983 // Also 'uval' (;u=$uval) must be a pnum: \-?[0-9]+
985 '(?:[0-9]+(?:\.[0-9]+)?(?:\,[0-9]+(?:\.[0-9]+)?){1,2})'. // 1(.23)?(,4(.56)){1,2}
986 '(?:\;(?:['.$geouri_labeltext_regex.']+)(?:\=['.$geouri_paramchar_regex.']+)*)*'.
989 // URLs without domain name, like magnet:?xt=...
990 '|(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_NO_DOMAIN)) . '):(?=\?))'. // zero-length lookahead requires ? after :
991 (common_config('linkify', 'bare_ipv4') // Convert IPv4 addresses to hyperlinks
992 ? '|(?:(?: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]?)'
994 (common_config('linkify', 'bare_ipv6') // Convert IPv6 addresses to hyperlinks
996 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
999 (common_config('linkify', 'bare_domains')
1001 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
1002 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
1003 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
1004 '(?: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|ZONE|ZW|local|loc|onion)'.
1006 : '') . // if common_config('linkify', 'bare_domains') is false, don't add anything here
1009 '(?:\:\d+)?'. //:port
1010 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
1011 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
1012 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
1013 ')(?<![\?\.\,\#\,])'.
1016 //preg_match_all($regex,$text,$matches);
1017 //print_r($matches);
1018 return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
1022 * Intermediate callback for common_replace_links(), helps resolve some
1023 * ambiguous link forms before passing on to the final callback.
1025 * @param array $matches
1026 * @param callable $callback
1027 * @param mixed $arg optional argument to pass on as second param to callback
1032 function callback_helper($matches, $callback, $arg=null) {
1034 $left = strpos($matches[0],$url);
1035 $right = $left+strlen($url);
1037 $groupSymbolSets=array(
1055 $cannotEndWith=array('.','?',',','#');
1059 foreach($groupSymbolSets as $groupSymbolSet){
1060 if(substr($url,-1)==$groupSymbolSet['right']){
1061 $group_left_count = substr_count($url,$groupSymbolSet['left']);
1062 $group_right_count = substr_count($url,$groupSymbolSet['right']);
1063 if($group_left_count<$group_right_count){
1065 $url=substr($url,0,-1);
1069 if(in_array(substr($url,-1),$cannotEndWith)){
1071 $url=substr($url,0,-1);
1073 }while($original_url!=$url);
1075 $result = call_user_func_array($callback, array($url, $arg));
1076 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
1079 require_once INSTALLDIR . "/lib/curry.php";
1081 function common_linkify($url) {
1082 // It comes in special'd, so we unspecial it before passing to the stringifying
1084 $url = htmlspecialchars_decode($url);
1086 if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
1087 //url is an email address without the mailto: protocol
1088 $canon = "mailto:$url";
1089 $longurl = "mailto:$url";
1091 $canon = File_redirection::_canonUrl($url);
1092 $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
1094 if(isset($longurl_data->redir_url)) {
1095 $longurl = $longurl_data->redir_url;
1098 $longurl = $longurl_data->url;
1102 $attrs = array('href' => $longurl, 'title' => $longurl);
1104 $is_attachment = false;
1105 $attachment_id = null;
1108 // Check to see whether this is a known "attachment" URL.
1111 $f = File::getByUrl($longurl);
1112 } catch (NoResultException $e) {
1113 if (common_config('attachments', 'process_links')) {
1114 // XXX: this writes to the database. :<
1116 $f = File::processNew($longurl);
1117 } catch (ServerException $e) {
1123 if ($f instanceof File) {
1125 $enclosure = $f->getEnclosure();
1126 $is_attachment = true;
1127 $attachment_id = $f->id;
1129 $thumb = File_thumbnail::getKV('file_id', $f->id);
1130 $has_thumb = ($thumb instanceof File_thumbnail);
1131 } catch (ServerException $e) {
1132 // There was not enough metadata available
1137 if ($is_attachment) {
1138 $attrs['class'] = 'attachment';
1140 $attrs['class'] = 'attachment thumbnail';
1142 $attrs['id'] = "attachment-{$attachment_id}";
1145 // Whether to nofollow
1147 $nf = common_config('nofollow', 'external');
1149 if ($nf == 'never') {
1150 $attrs['rel'] = 'external';
1152 $attrs['rel'] = 'nofollow external';
1155 return XMLStringer::estring('a', $attrs, $url);
1159 * Find and shorten links in a given chunk of text if it's longer than the
1160 * configured notice content limit (or unconditionally).
1162 * Side effects: may save file and file_redirection records for referenced URLs.
1164 * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1165 * user's options are used; otherwise the current web session user's setitngs
1166 * will be used or ur1.ca if there is no active web login.
1168 * @param string $text
1169 * @param boolean $always (optional)
1170 * @param User $user (optional)
1174 function common_shorten_links($text, $always = false, User $user=null)
1176 if ($user === null) {
1177 $user = common_current_user();
1180 $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1182 if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1183 return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1185 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1190 * Very basic stripping of invalid UTF-8 input text.
1192 * @param string $str
1193 * @return mixed string or null if invalid input
1195 * @todo ideally we should drop bad chars, and maybe do some of the checks
1196 * from common_xml_safe_str. But we can't strip newlines, etc.
1197 * @todo Unicode normalization might also be useful, but not needed now.
1199 function common_validate_utf8($str)
1201 // preg_replace will return NULL on invalid UTF-8 input.
1203 // Note: empty regex //u also caused NULL return on some
1204 // production machines, but none of our test machines.
1206 // This should be replaced with a more reliable check.
1207 return preg_replace('/\x00/u', '', $str);
1211 * Make sure an arbitrary string is safe for output in XML as a single line.
1213 * @param string $str
1216 function common_xml_safe_str($str)
1218 // Replace common eol and extra whitespace input chars
1223 "\0", // null byte eos
1224 "\x0B" // vertical tab
1227 $replacement = array(
1228 ' ', // single space
1235 $str = str_replace($unWelcome, $replacement, $str);
1237 // Neutralize any additional control codes and UTF-16 surrogates
1238 // (Twitter uses '*')
1239 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1242 function common_slugify($str)
1244 // php5-intl is highly recommended...
1245 if (!function_exists('transliterator_transliterate')) {
1246 $str = preg_replace('/[^\pL\pN]/u', '', $str);
1247 $str = mb_convert_case($str, MB_CASE_LOWER, 'UTF-8');
1248 $str = substr($str, 0, 64);
1251 $str = transliterator_transliterate(
1252 'Any-Latin;' . // any charset to latin compatible
1253 'NFD;' . // decompose
1254 '[:Nonspacing Mark:] Remove;' . // remove nonspacing marks (accents etc.)
1255 'NFC;' . // composite again
1256 '[:Punctuation:] Remove;' . // remove punctuation (.,¿? etc.)
1257 'Lower();' . // turn into lowercase
1258 'Latin-ASCII;', // get ASCII equivalents (ð to d for example)
1260 return preg_replace('/[^\pL\pN]/', '', $str);
1263 function common_tag_link($tag)
1265 $canonical = common_canonical_tag($tag);
1266 if (common_config('singleuser', 'enabled')) {
1267 // regular TagAction isn't set up in 1user mode
1268 $nickname = User::singleUserNickname();
1269 $url = common_local_url('showstream',
1270 array('nickname' => $nickname,
1271 'tag' => $canonical));
1273 $url = common_local_url('tag', array('tag' => $canonical));
1275 $xs = new XMLStringer();
1276 $xs->elementStart('span', 'tag');
1277 $xs->element('a', array('href' => $url,
1280 $xs->elementEnd('span');
1281 return $xs->getString();
1284 function common_canonical_tag($tag)
1286 $tag = common_slugify($tag);
1287 $tag = substr($tag, 0, 64);
1291 function common_valid_profile_tag($str)
1293 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1297 * Resolve an ambiguous profile nickname reference, checking in following order:
1298 * - profiles that $sender subscribes to
1299 * - profiles that subscribe to $sender
1300 * - local user profiles
1302 * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1303 * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1306 * @fixme validate input
1308 * @fixme fix or remove mystery third parameter
1309 * @fixme is $sender a User or Profile?
1311 * @param <type> $sender the user or profile in whose context we're looking
1312 * @param string $nickname validated nickname of
1313 * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1315 * @return Profile or null
1317 function common_relative_profile($sender, $nickname, $dt=null)
1319 // Will throw exception on invalid input.
1320 $nickname = Nickname::normalize($nickname);
1322 // Try to find profiles this profile is subscribed to that have this nickname
1323 $recipient = new Profile();
1324 // XXX: use a join instead of a subquery
1325 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1326 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1327 if ($recipient->find(true)) {
1328 // XXX: should probably differentiate between profiles with
1329 // the same name by date of most recent update
1332 // Try to find profiles that listen to this profile and that have this nickname
1333 $recipient = new Profile();
1334 // XXX: use a join instead of a subquery
1335 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1336 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1337 if ($recipient->find(true)) {
1338 // XXX: should probably differentiate between profiles with
1339 // the same name by date of most recent update
1342 // If this is a local user, try to find a local user with that nickname.
1343 $sender = User::getKV('id', $sender->id);
1344 if ($sender instanceof User) {
1345 $recipient_user = User::getKV('nickname', $nickname);
1346 if ($recipient_user instanceof User) {
1347 return $recipient_user->getProfile();
1350 // Otherwise, no links. @messages from local users to remote users,
1351 // or from remote users to other remote users, are just
1352 // outside our ability to make intelligent guesses about
1356 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1358 if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1360 $path = $r->build($action, $args, $params, $fragment);
1362 $ssl = GNUsocial::useHTTPS();
1364 if (common_config('site','fancy')) {
1365 $url = common_path($path, $ssl, $addSession);
1367 if (mb_strpos($path, '/index.php') === 0) {
1368 $url = common_path($path, $ssl, $addSession);
1370 $url = common_path('index.php/'.$path, $ssl, $addSession);
1373 Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1378 function common_path($relative, $ssl=false, $addSession=true)
1380 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1382 if ($ssl && GNUsocial::useHTTPS()) {
1384 if (is_string(common_config('site', 'sslserver')) &&
1385 mb_strlen(common_config('site', 'sslserver')) > 0) {
1386 $serverpart = common_config('site', 'sslserver');
1387 } else if (common_config('site', 'server')) {
1388 $serverpart = common_config('site', 'server');
1390 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1394 if (common_config('site', 'server')) {
1395 $serverpart = common_config('site', 'server');
1397 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1402 $relative = common_inject_session($relative, $serverpart);
1405 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1408 // FIXME: Maybe this should also be able to handle non-fancy URLs with index.php?p=...
1409 function common_fake_local_fancy_url($url)
1412 * This is a hacky fix to make URIs generated with "index.php/" match against
1413 * locally stored URIs without that. So for example if the remote site is looking
1414 * up the webfinger for some user and for some reason knows about https://some.example/user/1
1415 * but we locally store and report only https://some.example/index.php/user/1 then they would
1416 * dismiss the profile for not having an identified alias.
1418 * There are various live instances where these issues occur, for various reasons.
1419 * Most of them being users fiddling with configuration while already having
1420 * started federating (distributing the URI to other servers) or maybe manually
1421 * editing the local database.
1424 // [1] protocol part, we can only rewrite http/https anyway.
1427 // FIXME: Dunno how this acts if we're aliasing ourselves with a .onion domain etc.
1428 '('.preg_quote(common_config('site', 'server'), '/').')' .
1429 // [3] site path, or if that is empty just '/' (to retain the /)
1430 '('.preg_quote(common_config('site', 'path') ?: '/', '/').')' .
1431 // [4] + [5] extract index.php (+ possible leading double /) and the rest of the URL separately.
1432 '(\/?index\.php\/)(.*)$/', $url, $matches)) {
1433 // if preg_match failed to match
1434 throw new Exception('No known change could be made to the URL.');
1437 // now reconstruct the URL with everything except the "index.php/" part
1439 foreach ([1,2,3,5] as $idx) {
1440 $fancy_url .= $matches[$idx];
1445 // FIXME: Maybe this should also be able to handle non-fancy URLs with index.php?p=...
1446 function common_fake_local_nonfancy_url($url)
1449 * This is a hacky fix to make URIs NOT generated with "index.php/" match against
1450 * locally stored URIs WITH that. The reverse from the above.
1452 * It will also "repair" index.php URLs with multiple / prepended. Like https://some.example///index.php/user/1
1455 // [1] protocol part, we can only rewrite http/https anyway.
1458 // FIXME: Dunno how this acts if we're aliasing ourselves with a .onion domain etc.
1459 '('.preg_quote(common_config('site', 'server'), '/').')' .
1460 // [3] site path, or if that is empty just '/' (to retain the /)
1461 '('.preg_quote(common_config('site', 'path') ?: '/', '/').')' .
1462 // [4] should be empty (might contain one or more / and then maybe also index.php). Will be overwritten.
1463 // [5] will have the extracted actual URL part (besides site path)
1464 '((?!index.php\/)\/*(?:index.php\/)?)(.*)$/', $url, $matches)) {
1465 // if preg_match failed to match
1466 throw new Exception('No known change could be made to the URL.');
1469 $matches[4] = 'index.php/'; // inject the index.php/ rewritethingy
1471 // remove the first element, which is the full matching string
1472 array_shift($matches);
1473 return implode($matches);
1476 function common_inject_session($url, $serverpart = null)
1478 if (!common_have_session()) {
1482 if (empty($serverpart)) {
1483 $serverpart = parse_url($url, PHP_URL_HOST);
1486 $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1488 // Are we pointing to another server (like an SSL server?)
1490 if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1491 // Pass the session ID as a GET parameter
1492 $sesspart = session_name() . '=' . session_id();
1493 $i = strpos($url, '?');
1494 if ($i === false) { // no GET params, just append
1495 $url .= '?' . $sesspart;
1497 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1504 function common_date_string($dt)
1506 // XXX: do some sexy date formatting
1507 // return date(DATE_RFC822, $dt);
1508 $t = strtotime($dt);
1512 if ($now < $t) { // that shouldn't happen!
1513 return common_exact_date($dt);
1514 } else if ($diff < 60) {
1515 // TRANS: Used in notices to indicate when the notice was made compared to now.
1516 return _('a few seconds ago');
1517 } else if ($diff < 92) {
1518 // TRANS: Used in notices to indicate when the notice was made compared to now.
1519 return _('about a minute ago');
1520 } else if ($diff < 3300) {
1521 $minutes = round($diff/60);
1522 // TRANS: Used in notices to indicate when the notice was made compared to now.
1523 return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1524 } else if ($diff < 5400) {
1525 // TRANS: Used in notices to indicate when the notice was made compared to now.
1526 return _('about an hour ago');
1527 } else if ($diff < 22 * 3600) {
1528 $hours = round($diff/3600);
1529 // TRANS: Used in notices to indicate when the notice was made compared to now.
1530 return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1531 } else if ($diff < 37 * 3600) {
1532 // TRANS: Used in notices to indicate when the notice was made compared to now.
1533 return _('about a day ago');
1534 } else if ($diff < 24 * 24 * 3600) {
1535 $days = round($diff/(24*3600));
1536 // TRANS: Used in notices to indicate when the notice was made compared to now.
1537 return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1538 } else if ($diff < 46 * 24 * 3600) {
1539 // TRANS: Used in notices to indicate when the notice was made compared to now.
1540 return _('about a month ago');
1541 } else if ($diff < 330 * 24 * 3600) {
1542 $months = round($diff/(30*24*3600));
1543 // TRANS: Used in notices to indicate when the notice was made compared to now.
1544 return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1545 } else if ($diff < 480 * 24 * 3600) {
1546 // TRANS: Used in notices to indicate when the notice was made compared to now.
1547 return _('about a year ago');
1549 return common_exact_date($dt);
1553 function common_exact_date($dt)
1559 $_utc = new DateTimeZone('UTC');
1560 $_siteTz = new DateTimeZone(common_timezone());
1563 $dateStr = date('d F Y H:i:s', strtotime($dt));
1564 $d = new DateTime($dateStr, $_utc);
1565 $d->setTimezone($_siteTz);
1566 // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
1567 return $d->format(_('l, d-M-Y H:i:s T'));
1570 function common_date_w3dtf($dt)
1572 $dateStr = date('d F Y H:i:s', strtotime($dt));
1573 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1574 $d->setTimezone(new DateTimeZone(common_timezone()));
1575 return $d->format(DATE_W3C);
1578 function common_date_rfc2822($dt)
1580 $dateStr = date('d F Y H:i:s', strtotime($dt));
1581 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1582 $d->setTimezone(new DateTimeZone(common_timezone()));
1583 return $d->format('r');
1586 function common_date_iso8601($dt)
1588 $dateStr = date('d F Y H:i:s', strtotime($dt));
1589 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1590 $d->setTimezone(new DateTimeZone(common_timezone()));
1591 return $d->format('c');
1594 function common_sql_now()
1596 return common_sql_date(time());
1599 function common_sql_date($datetime)
1601 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1605 * Return an SQL fragment to calculate an age-based weight from a given
1606 * timestamp or datetime column.
1608 * @param string $column name of field we're comparing against current time
1609 * @param integer $dropoff divisor for age in seconds before exponentiation
1610 * @return string SQL fragment
1612 function common_sql_weight($column, $dropoff)
1614 if (common_config('db', 'type') == 'pgsql') {
1615 // PostgreSQL doesn't support timestampdiff function.
1616 // @fixme will this use the right time zone?
1617 // @fixme does this handle cross-year subtraction correctly?
1618 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1620 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1624 function common_redirect($url, $code=307)
1626 static $status = array(301 => "Moved Permanently",
1629 307 => "Temporary Redirect");
1631 header('HTTP/1.1 '.$code.' '.$status[$code]);
1632 header("Location: $url");
1633 header("Connection: close");
1635 $xo = new XMLOutputter();
1637 '-//W3C//DTD XHTML 1.0 Strict//EN',
1638 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1639 $xo->element('a', array('href' => $url), $url);
1644 // Stick the notice on the queue
1646 function common_enqueue_notice($notice)
1648 static $localTransports = array('ping');
1650 $transports = array();
1651 if (common_config('sms', 'enabled')) {
1652 $transports[] = 'sms';
1654 if (Event::hasHandler('HandleQueuedNotice')) {
1655 $transports[] = 'plugin';
1658 // We can skip these for gatewayed notices.
1659 if ($notice->isLocal()) {
1660 $transports = array_merge($transports, $localTransports);
1663 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1665 $qm = QueueManager::get();
1667 foreach ($transports as $transport)
1669 $qm->enqueue($notice, $transport);
1672 Event::handle('EndEnqueueNotice', array($notice, $transports));
1678 function common_profile_url($nickname)
1680 return common_local_url('showstream', array('nickname' => $nickname),
1685 * Should make up a reasonable root URL
1687 function common_root_url($ssl=false)
1689 $url = common_path('', $ssl, false);
1690 $i = strpos($url, '?');
1692 $url = substr($url, 0, $i);
1698 * returns $bytes bytes of raw random data
1700 function common_random_rawstr($bytes)
1702 $rawstr = @file_exists('/dev/urandom')
1703 ? common_urandom($bytes)
1704 : common_mtrand($bytes);
1710 * returns $bytes bytes of random data as a hexadecimal string
1712 function common_random_hexstr($bytes)
1714 $str = common_random_rawstr($bytes);
1717 for ($i = 0; $i < $bytes; $i++) {
1718 $hexstr .= sprintf("%02x", ord($str[$i]));
1723 function common_urandom($bytes)
1725 $h = fopen('/dev/urandom', 'rb');
1727 $src = fread($h, $bytes);
1732 function common_mtrand($bytes)
1735 for ($i = 0; $i < $bytes; $i++) {
1736 $str .= chr(mt_rand(0, 255));
1742 * Record the given URL as the return destination for a future
1743 * form submission, to be read by common_get_returnto().
1745 * @param string $url
1747 * @fixme as a session-global setting, this can allow multiple forms
1748 * to conflict and overwrite each others' returnto destinations if
1749 * the user has multiple tabs or windows open.
1751 * Should refactor to index with a token or otherwise only pass the
1752 * data along its intended path.
1754 function common_set_returnto($url)
1756 common_ensure_session();
1757 $_SESSION['returnto'] = $url;
1761 * Fetch a return-destination URL previously recorded by
1762 * common_set_returnto().
1764 * @return mixed URL string or null
1766 * @fixme as a session-global setting, this can allow multiple forms
1767 * to conflict and overwrite each others' returnto destinations if
1768 * the user has multiple tabs or windows open.
1770 * Should refactor to index with a token or otherwise only pass the
1771 * data along its intended path.
1773 function common_get_returnto()
1775 common_ensure_session();
1776 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1779 function common_timestamp()
1781 return date('YmdHis');
1784 function common_ensure_syslog()
1786 static $initialized = false;
1787 if (!$initialized) {
1788 openlog(common_config('syslog', 'appname'), 0,
1789 common_config('syslog', 'facility'));
1790 $initialized = true;
1794 function common_log_line($priority, $msg)
1796 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1797 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1798 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1801 function common_request_id()
1804 $server = common_config('site', 'server');
1805 if (php_sapi_name() == 'cli') {
1806 $script = basename($_SERVER['PHP_SELF']);
1807 return "$server:$script:$pid";
1809 static $req_id = null;
1810 if (!isset($req_id)) {
1811 $req_id = substr(md5(mt_rand()), 0, 8);
1813 if (isset($_SERVER['REQUEST_URI'])) {
1814 $url = $_SERVER['REQUEST_URI'];
1816 $method = $_SERVER['REQUEST_METHOD'];
1817 return "$server:$pid.$req_id $method $url";
1821 function common_log($priority, $msg, $filename=null)
1823 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1824 $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1825 $msg = '[' . common_request_id() . '] ' . $msg;
1826 $logfile = common_config('site', 'logfile');
1828 $log = fopen($logfile, "a");
1830 $output = common_log_line($priority, $msg);
1831 fwrite($log, $output);
1835 common_ensure_syslog();
1836 syslog($priority, $msg);
1838 Event::handle('EndLog', array($priority, $msg, $filename));
1842 function common_debug($msg, $filename=null)
1845 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1847 common_log(LOG_DEBUG, $msg);
1851 function common_log_db_error(&$object, $verb, $filename=null)
1855 $objstr = common_log_objstring($object);
1856 $last_error = &$_PEAR->getStaticProperty('DB_DataObject','lastError');
1857 if (is_object($last_error)) {
1858 $msg = $last_error->message;
1860 $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1862 common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1865 function common_log_objstring(&$object)
1867 if (is_null($object)) {
1870 if (!($object instanceof DB_DataObject)) {
1873 $arr = $object->toArray();
1875 foreach ($arr as $k => $v) {
1876 if (is_object($v)) {
1877 $fields[] = "$k='".get_class($v)."'";
1879 $fields[] = "$k='$v'";
1882 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1886 function common_valid_http_url($url, $secure=false)
1888 // If $secure is true, only allow https URLs to pass
1889 // (if false, we use '?' in 'https?' to say the 's' is optional)
1890 $regex = $secure ? '/^https$/' : '/^https?$/';
1891 return filter_var($url, FILTER_VALIDATE_URL)
1892 && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1895 function common_valid_tag($tag)
1897 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1898 return (Validate::email($matches[1]) ||
1899 preg_match('/^([\w-\.]+)$/', $matches[1]));
1905 * Determine if given domain or address literal is valid
1906 * eg for use in JIDs and URLs. Does not check if the domain
1909 * @param string $domain
1910 * @return boolean valid or not
1912 function common_valid_domain($domain)
1914 $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1915 $ipv4 = "(?:$octet(?:\.$octet){3})";
1916 if (preg_match("/^$ipv4$/u", $domain)) return true;
1918 $group = "(?:[0-9a-f]{1,4})";
1919 $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1921 if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1922 $before = explode(":", $matches[1]);
1923 $zeroes = $matches[2];
1924 $after = explode(":", $matches[3]);
1932 $explicit = count($before) + count($after);
1933 if ($explicit < $min || $explicit > $max) {
1940 require_once "Net/IDNA.php";
1941 $idn = Net_IDNA::getInstance();
1942 $domain = $idn->encode($domain);
1943 } catch (Exception $e) {
1947 $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1948 $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1950 return preg_match("/^$fqdn$/ui", $domain);
1953 /* Following functions are copied from MediaWiki GlobalFunctions.php
1954 * and written by Evan Prodromou. */
1956 function common_accept_to_prefs($accept, $def = '*/*')
1958 // No arg means accept anything (per HTTP spec)
1960 return array($def => 1);
1965 $parts = explode(',', $accept);
1967 foreach($parts as $part) {
1968 // FIXME: doesn't deal with params like 'text/html; level=1'
1969 @list($value, $qpart) = explode(';', trim($part));
1971 if(!isset($qpart)) {
1973 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1974 $prefs[$value] = $match[1];
1981 // Match by our supported file extensions
1982 function common_supported_ext_to_mime($fileext)
1984 // Accept a filename and take out the extension
1985 if (strpos($fileext, '.') !== false) {
1986 $fileext = substr(strrchr($fileext, '.'), 1);
1989 $supported = common_config('attachments', 'supported');
1990 if ($supported === true) {
1991 throw new ServerException('Supported extension but unknown mimetype relation.');
1993 foreach($supported as $type => $ext) {
1994 if ($ext === $fileext) {
1999 throw new ServerException('Unsupported file extension');
2002 // Match by our supported mime types
2003 function common_supported_mime_to_ext($mimetype)
2005 $supported = common_config('attachments', 'supported');
2006 if ($supported === true) {
2007 throw new ServerException('Supported mimetype but unknown extension relation.');
2009 foreach($supported as $type => $ext) {
2010 if ($mimetype === $type) {
2015 throw new ServerException('Unsupported MIME type');
2018 // The MIME "media" is the part before the slash (video in video/webm)
2019 function common_get_mime_media($type)
2021 $tmp = explode('/', $type);
2022 return strtolower($tmp[0]);
2025 // Get only the mimetype and not additional info (separated from bare mime with semi-colon)
2026 function common_bare_mime($mimetype)
2028 $mimetype = mb_strtolower($mimetype);
2029 if ($semicolon = mb_strpos($mimetype, ';')) {
2030 $mimetype = mb_substr($mimetype, 0, $semicolon);
2035 function common_mime_type_match($type, $avail)
2037 if(array_key_exists($type, $avail)) {
2040 $parts = explode('/', $type);
2041 if(array_key_exists($parts[0] . '/*', $avail)) {
2042 return $parts[0] . '/*';
2043 } elseif(array_key_exists('*/*', $avail)) {
2051 function common_negotiate_type($cprefs, $sprefs)
2055 foreach(array_keys($sprefs) as $type) {
2056 $parts = explode('/', $type);
2057 if($parts[1] != '*') {
2058 $ckey = common_mime_type_match($type, $cprefs);
2060 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2065 foreach(array_keys($cprefs) as $type) {
2066 $parts = explode('/', $type);
2067 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
2068 $skey = common_mime_type_match($type, $sprefs);
2070 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2076 $besttype = 'text/html';
2078 foreach(array_keys($combine) as $type) {
2079 if($combine[$type] > $bestq) {
2081 $bestq = $combine[$type];
2085 if ('text/html' === $besttype) {
2086 return "text/html; charset=utf-8";
2091 function common_config($main, $sub=null)
2094 if (is_null($sub)) {
2095 // Return the config category array
2096 return array_key_exists($main, $config) ? $config[$main] : array();
2098 // Return the config value
2099 return (array_key_exists($main, $config) &&
2100 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
2103 function common_config_set($main, $sub, $value)
2106 if (!array_key_exists($main, $config)) {
2107 $config[$main] = array();
2109 $config[$main][$sub] = $value;
2112 function common_config_append($main, $sub, $value)
2115 if (!array_key_exists($main, $config)) {
2116 $config[$main] = array();
2118 if (!array_key_exists($sub, $config[$main])) {
2119 $config[$main][$sub] = array();
2121 if (!is_array($config[$main][$sub])) {
2122 $config[$main][$sub] = array($config[$main][$sub]);
2124 array_push($config[$main][$sub], $value);
2128 * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
2129 * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
2131 * @param array $from
2134 function common_copy_args($from)
2137 $strip = get_magic_quotes_gpc();
2138 foreach ($from as $k => $v) {
2140 $to[$k] = common_copy_args($v);
2143 $v = stripslashes($v);
2145 $to[$k] = strval(common_validate_utf8($v));
2152 * Neutralise the evil effects of magic_quotes_gpc in the current request.
2153 * This is used before handing a request off to OAuthRequest::from_request.
2154 * @fixme Doesn't consider vars other than _POST and _GET?
2155 * @fixme Can't be undone and could corrupt data if run twice.
2157 function common_remove_magic_from_request()
2159 if(get_magic_quotes_gpc()) {
2160 $_POST=array_map('stripslashes',$_POST);
2161 $_GET=array_map('stripslashes',$_GET);
2165 function common_user_uri(&$user)
2167 return common_local_url('userbyid', array('id' => $user->id),
2171 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2173 function common_confirmation_code($bits)
2175 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2176 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
2177 $chars = ceil($bits/5);
2179 for ($i = 0; $i < $chars; $i++) {
2180 // XXX: convert to string and back
2181 $num = hexdec(common_random_hexstr(1));
2182 // XXX: randomness is too precious to throw away almost
2183 // 40% of the bits we get!
2184 $code .= $codechars[$num%32];
2189 // convert markup to HTML
2190 function common_markup_to_html($c, $args=null)
2196 if (is_null($args)) {
2200 // XXX: not very efficient
2202 foreach ($args as $name => $value) {
2203 $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
2206 $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
2207 $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
2208 $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
2209 $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
2211 return \Michelf\Markdown::defaultTransform($c);
2214 function common_user_property($property)
2216 $profile = Profile::current();
2218 if (empty($profile)) {
2222 switch ($property) {
2228 return $profile->$property;
2232 return $profile->getAvatar(AVATAR_STREAM_SIZE);
2233 } catch (Exception $e) {
2238 return $profile->getBestName();
2245 function common_profile_uri($profile)
2249 if (!empty($profile)) {
2250 if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2251 $user = User::getKV('id', $profile->id);
2252 if ($user instanceof User) {
2253 $uri = $user->getUri();
2255 Event::handle('EndCommonProfileURI', array($profile, &$uri));
2259 // XXX: this is a very bad profile!
2263 function common_canonical_sms($sms)
2266 preg_replace('/\D/', '', $sms);
2270 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2275 case E_COMPILE_ERROR:
2279 case E_RECOVERABLE_ERROR:
2280 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2285 case E_COMPILE_WARNING:
2286 case E_CORE_WARNING:
2287 case E_USER_WARNING:
2288 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2293 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2298 case E_USER_DEPRECATED:
2299 // XXX: config variable to log this stuff, too
2303 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2308 // FIXME: show error page if we're on the Web
2309 /* Don't execute PHP internal error handler */
2313 function common_session_token()
2315 common_ensure_session();
2316 if (!array_key_exists('token', $_SESSION)) {
2317 $_SESSION['token'] = common_random_hexstr(64);
2319 return $_SESSION['token'];
2322 function common_license_terms($uri)
2324 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2325 return explode('-',$matches[1]);
2330 function common_compatible_license($from, $to)
2332 $from_terms = common_license_terms($from);
2333 // public domain and cc-by are compatible with everything
2334 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2337 $to_terms = common_license_terms($to);
2338 // sa is compatible across versions. IANAL
2339 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2340 return count(array_diff($from_terms, $to_terms)) == 0;
2342 // XXX: better compatibility check needed here!
2343 // Should at least normalise URIs
2344 return ($from == $to);
2348 * returns a quoted table name, if required according to config
2350 function common_database_tablename($tablename)
2352 if(common_config('db','quote_identifiers')) {
2353 $tablename = '"'. $tablename .'"';
2355 //table prefixes could be added here later
2360 * Shorten a URL with the current user's configured shortening service,
2361 * or ur1.ca if configured, or not at all if no shortening is set up.
2363 * @param string $long_url original URL
2364 * @param User $user to specify a particular user's options
2365 * @param boolean $force Force shortening (used when notice is too long)
2366 * @return string may return the original URL if shortening failed
2368 * @fixme provide a way to specify a particular shortener
2370 function common_shorten_url($long_url, User $user=null, $force = false)
2372 $long_url = trim($long_url);
2374 $user = common_current_user();
2376 $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2378 // $force forces shortening even if it's not strictly needed
2379 // I doubt URL shortening is ever 'strictly' needed. - ESP
2381 if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2385 $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2387 if (Event::handle('StartShortenUrl',
2388 array($long_url, $shortenerName, &$shortenedUrl))) {
2389 if ($shortenerName == 'internal') {
2391 $f = File::processNew($long_url);
2392 $shortenedUrl = common_local_url('redirecturl', array('id' => $f->id));
2393 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2394 return $shortenedUrl;
2398 } catch (ServerException $e) {
2405 //URL was shortened, so return the result
2406 return trim($shortenedUrl);
2411 * @return mixed array($proxy, $ip) for web requests; proxy may be null
2412 * null if not a web request
2414 * @fixme X-Forwarded-For can be chained by multiple proxies;
2415 we should parse the list and provide a cleaner array
2416 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2417 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2418 * use function to get exact request headers from Apache if possible.
2420 function common_client_ip()
2422 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2426 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2427 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2428 $proxy = $_SERVER['HTTP_CLIENT_IP'];
2430 $proxy = $_SERVER['REMOTE_ADDR'];
2432 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2435 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2436 $ip = $_SERVER['HTTP_CLIENT_IP'];
2438 $ip = $_SERVER['REMOTE_ADDR'];
2442 return array($proxy, $ip);
2445 function common_url_to_nickname($url)
2447 static $bad = array('query', 'user', 'password', 'port', 'fragment');
2449 $parts = parse_url($url);
2451 // If any of these parts exist, this won't work
2453 foreach ($bad as $badpart) {
2454 if (array_key_exists($badpart, $parts)) {
2459 // We just have host and/or path
2461 // If it's just a host...
2462 if (array_key_exists('host', $parts) &&
2463 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2465 $hostparts = explode('.', $parts['host']);
2467 // Try to catch common idiom of nickname.service.tld
2469 if ((count($hostparts) > 2) &&
2470 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2471 (strcmp($hostparts[0], 'www') != 0))
2473 return common_nicknamize($hostparts[0]);
2475 // Do the whole hostname
2476 return common_nicknamize($parts['host']);
2479 if (array_key_exists('path', $parts)) {
2480 // Strip starting, ending slashes
2481 $path = preg_replace('@/$@', '', $parts['path']);
2482 $path = preg_replace('@^/@', '', $path);
2483 $path = basename($path);
2485 // Hack for MediaWiki user pages, in the form:
2486 // http://example.com/wiki/User:Myname
2487 // ('User' may be localized.)
2488 if (strpos($path, ':')) {
2489 $parts = array_filter(explode(':', $path));
2490 $path = $parts[count($parts) - 1];
2494 return common_nicknamize($path);
2502 function common_nicknamize($str)
2505 return Nickname::normalize($str);
2506 } catch (NicknameException $e) {
2511 function common_perf_counter($key, $val=null)
2513 global $_perfCounters;
2514 if (isset($_perfCounters)) {
2515 if (common_config('site', 'logperf')) {
2516 if (array_key_exists($key, $_perfCounters)) {
2517 $_perfCounters[$key][] = $val;
2519 $_perfCounters[$key] = array($val);
2521 if (common_config('site', 'logperf_detail')) {
2522 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2528 function common_log_perf_counters()
2530 if (common_config('site', 'logperf')) {
2531 global $_startTime, $_perfCounters;
2533 if (isset($_startTime)) {
2534 $endTime = microtime(true);
2535 $diff = round(($endTime - $_startTime) * 1000);
2536 common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2538 $counters = $_perfCounters;
2540 foreach ($counters as $key => $values) {
2541 $count = count($values);
2542 $unique = count(array_unique($values));
2543 common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2548 function common_is_email($str)
2550 return (strpos($str, '@') !== false);
2553 function common_init_stats()
2557 $_mem = memory_get_usage(true);
2558 $_ts = microtime(true);
2561 function common_log_delta($comment=null)
2568 $_mem = memory_get_usage(true);
2569 $_ts = microtime(true);
2571 $mtotal = $_mem - $mold;
2572 $ttotal = $_ts - $told;
2574 if (empty($comment)) {
2578 common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
2581 function common_strip_html($html, $trim=true, $save_whitespace=false)
2583 if (!$save_whitespace) {
2584 $html = preg_replace('/\s+/', ' ', $html);
2586 $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
2587 return $trim ? trim($text) : $text;
2590 function html_sprintf()
2592 $args = func_get_args();
2593 for ($i=1; $i<count($args); $i++) {
2594 $args[$i] = htmlspecialchars($args[$i]);
2596 return call_user_func_array('sprintf', $args);
2601 return var_export($var, true);