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 isset($_SERVER['HTTP_REFERER'])
270 && parse_url($_SERVER['HTTP_REFERER'], PHP_URL_HOST) === common_config('site', 'server');
273 function common_have_session()
275 return (0 != strcmp(session_id(), ''));
278 function common_ensure_session()
281 if (array_key_exists(session_name(), $_COOKIE)) {
282 $c = $_COOKIE[session_name()];
284 if (!common_have_session()) {
285 if (common_config('sessions', 'handle')) {
286 Session::setSaveHandler();
288 if (array_key_exists(session_name(), $_GET)) {
289 $id = $_GET[session_name()];
290 } else if (array_key_exists(session_name(), $_COOKIE)) {
291 $id = $_COOKIE[session_name()];
297 if (!isset($_SESSION['started'])) {
298 $_SESSION['started'] = time();
300 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
301 ' is set but started value is null');
307 // Three kinds of arguments:
312 // Initialize to false; set to null if none found
315 function common_set_user($user)
319 if (is_null($user) && common_have_session()) {
321 unset($_SESSION['userid']);
323 } else if (is_string($user)) {
325 $user = User::getKV('nickname', $nickname);
326 } else if (!$user instanceof User) {
331 if (Event::handle('StartSetUser', array(&$user))) {
333 if (!$user->hasRight(Right::WEBLOGIN)) {
334 // TRANS: Authorisation exception thrown when a user a not allowed to login.
335 throw new AuthorizationException(_('Not allowed to log in.'));
337 common_ensure_session();
338 $_SESSION['userid'] = $user->id;
340 Event::handle('EndSetUser', array($user));
348 function common_set_cookie($key, $value, $expiration=0)
350 $path = common_config('site', 'path');
351 $server = common_config('site', 'server');
353 if ($path && ($path != '/')) {
354 $cookiepath = '/' . $path . '/';
358 return setcookie($key,
363 GNUsocial::useHTTPS());
366 define('REMEMBERME', 'rememberme');
367 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
369 function common_rememberme($user=null)
372 $user = common_current_user();
378 $rm = new Remember_me();
380 $rm->code = common_random_hexstr(16);
381 $rm->user_id = $user->id;
383 // Wrap the insert in some good ol' fashioned transaction code
387 $result = $rm->insert();
390 common_log_db_error($rm, 'INSERT', __FILE__);
391 $rm->query('ROLLBACK');
395 $rm->query('COMMIT');
397 $cookieval = $rm->user_id . ':' . $rm->code;
399 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
401 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
406 function common_remembered_user()
410 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
416 list($id, $code) = explode(':', $packed);
418 if (!$id || !$code) {
419 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
424 $rm = Remember_me::getKV('code', $code);
427 common_log(LOG_WARNING, 'No such remember code: ' . $code);
432 if ($rm->user_id != $id) {
433 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
438 $user = User::getKV('id', $rm->user_id);
440 if (!$user instanceof User) {
441 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
447 $result = $rm->delete();
450 common_log_db_error($rm, 'DELETE', __FILE__);
451 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
456 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
458 common_set_user($user);
459 common_real_login(false);
461 // We issue a new cookie, so they can log in
462 // automatically again after this session
464 common_rememberme($user);
470 * must be called with a valid user!
472 function common_forgetme()
474 common_set_cookie(REMEMBERME, '', 0);
478 * Who is the current user?
480 function common_current_user()
484 if (!_have_config()) {
488 if ($_cur === false) {
490 if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
491 || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
492 common_ensure_session();
493 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
495 $user = User::getKV('id', $id);
496 if ($user instanceof User) {
503 // that didn't work; try to remember; will init $_cur to null on failure
504 $_cur = common_remembered_user();
507 // XXX: Is this necessary?
508 $_SESSION['userid'] = $_cur->id;
516 * Logins that are 'remembered' aren't 'real' -- they're subject to
517 * cookie-stealing. So, we don't let them do certain things. New reg,
518 * OpenID, and password logins _are_ real.
520 function common_real_login($real=true)
522 common_ensure_session();
523 $_SESSION['real_login'] = $real;
526 function common_is_real_login()
528 return common_logged_in() && $_SESSION['real_login'];
532 * Get a hash portion for HTTP caching Etags and such including
533 * info on the current user's session. If login/logout state changes,
534 * or we've changed accounts, or we've renamed the current user,
535 * we'll get a new hash value.
537 * This should not be considered secure information.
539 * @param User $user (optional; uses common_current_user() if left out)
542 function common_user_cache_hash($user=false)
544 if ($user === false) {
545 $user = common_current_user();
548 return crc32($user->id . ':' . $user->nickname);
555 * get canonical version of nickname for comparison
557 * @param string $nickname
560 * @throws NicknameException on invalid input
561 * @deprecated call Nickname::normalize() directly.
563 function common_canonical_nickname($nickname)
565 return Nickname::normalize($nickname);
569 * get canonical version of email for comparison
571 * @fixme actually normalize
572 * @fixme reject invalid input
574 * @param string $email
577 function common_canonical_email($email)
579 // XXX: canonicalize UTF-8
580 // XXX: lcase the domain part
584 function common_to_alphanumeric($str)
586 $filtered = preg_replace('/[^A-Za-z0-9]\s*/', '', $str);
587 if (strlen($filtered) < 1) {
588 throw new Exception('Filtered string was zero-length.');
593 function common_purify($html, array $args=array())
595 require_once INSTALLDIR.'/extlib/HTMLPurifier/HTMLPurifier.auto.php';
597 $cfg = HTMLPurifier_Config::createDefault();
599 * rel values that should be avoided since they can be used to infer
600 * information about the _current_ page, not the h-entry:
602 * directory, home, license, payment
604 * Source: http://microformats.org/wiki/rel
606 $cfg->set('Attr.AllowedRel', ['bookmark', 'enclosure', 'nofollow', 'tag', 'noreferrer']);
607 $cfg->set('HTML.ForbiddenAttributes', array('style')); // id, on* etc. are already filtered by default
608 $cfg->set('URI.AllowedSchemes', array_fill_keys(common_url_schemes(), true));
609 if (isset($args['URI.Base'])) {
610 $cfg->set('URI.Base', $args['URI.Base']); // if null this is like unsetting it I presume
611 $cfg->set('URI.MakeAbsolute', !is_null($args['URI.Base'])); // if we have a URI base, convert relative URLs to absolute ones.
613 foreach (common_config('htmlpurifier') as $key=>$val) {
614 $cfg->set($key, $val);
617 // Remove more elements than what the default filter removes, default in GNU social are remotely
618 // linked resources such as img, video, audio
619 $forbiddenElements = array();
620 foreach (common_config('htmlfilter') as $tag=>$filter) {
621 if ($filter === true) {
622 $forbiddenElements[] = $tag;
625 $cfg->set('HTML.ForbiddenElements', $forbiddenElements);
627 $html = common_remove_unicode_formatting($html);
629 $purifier = new HTMLPurifier($cfg);
630 $purified = $purifier->purify($html);
631 Event::handle('EndCommonPurify', array(&$purified, $html));
636 function common_remove_unicode_formatting($text)
638 // Strip Unicode text formatting/direction codes
639 // this is pretty dangerous for visualisation of text and can be used for mischief
640 return preg_replace('/[\\x{200b}-\\x{200f}\\x{202a}-\\x{202e}]/u', '', $text);
644 * Partial notice markup rendering step: build links to !group references.
646 * @param string $text partially rendered HTML
647 * @param Profile $author the Profile that is composing the current notice
648 * @param Notice $parent the Notice this is sent in reply to, if any
649 * @return string partially rendered HTML
651 function common_render_content($text, Profile $author, Notice $parent=null)
653 $text = common_render_text($text);
654 $text = common_linkify_mentions($text, $author, $parent);
659 * Finds @-mentions within the partially-rendered text section and
660 * turns them into live links.
662 * Should generally not be called except from common_render_content().
664 * @param string $text partially-rendered HTML
665 * @param Profile $author the Profile that is composing the current notice
666 * @param Notice $parent the Notice this is sent in reply to, if any
667 * @return string partially-rendered HTML
669 function common_linkify_mentions($text, Profile $author, Notice $parent=null)
671 $mentions = common_find_mentions($text, $author, $parent);
673 // We need to go through in reverse order by position,
674 // so our positions stay valid despite our fudging with the
679 foreach ($mentions as $mention)
681 $points[$mention['position']] = $mention;
686 foreach ($points as $position => $mention) {
688 $linkText = common_linkify_mention($mention);
690 $text = substr_replace($text, $linkText, $position, $mention['length']);
696 function common_linkify_mention(array $mention)
700 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
702 $xs = new XMLStringer(false);
704 $attrs = array('href' => $mention['url'],
705 'class' => 'h-card u-url p-nickname '.$mention['type']);
707 if (!empty($mention['title'])) {
708 $attrs['title'] = $mention['title'];
711 $xs->element('a', $attrs, $mention['text']);
713 $output = $xs->getString();
715 Event::handle('EndLinkifyMention', array($mention, &$output));
721 function common_get_attentions($text, Profile $sender, Notice $parent=null)
723 $mentions = common_find_mentions($text, $sender, $parent);
725 foreach ($mentions as $mention) {
726 foreach ($mention['mentioned'] as $mentioned) {
727 $atts[$mentioned->getUri()] = $mentioned->getObjectType();
730 if ($parent instanceof Notice) {
731 $parentAuthor = $parent->getProfile();
732 // afaik groups can't be authors
733 $atts[$parentAuthor->getUri()] = ActivityObject::PERSON;
739 * Find @-mentions in the given text, using the given notice object as context.
740 * References will be resolved with common_relative_profile() against the user
741 * who posted the notice.
743 * Note the return data format is internal, to be used for building links and
744 * such. Should not be used directly; rather, call common_linkify_mentions().
746 * @param string $text
747 * @param Profile $sender the Profile that is sending the current text
748 * @param Notice $parent the Notice this text is in reply to, if any
754 function common_find_mentions($text, Profile $sender, Notice $parent=null)
758 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
759 // Get the context of the original notice, if any
760 $origMentions = array();
761 // Does it have a parent notice for context?
762 if ($parent instanceof Notice) {
763 foreach ($parent->getAttentionProfiles() as $repliedTo) {
764 if (!$repliedTo->isPerson()) {
767 $origMentions[$repliedTo->id] = $repliedTo;
771 $matches = common_find_mentions_raw($text, '@');
773 foreach ($matches as $match) {
775 $nickname = Nickname::normalize($match[0]);
776 } catch (NicknameException $e) {
777 // Bogus match? Drop it.
781 // primarily mention the profiles mentioned in the parent
782 $mention_found_in_origMentions = false;
783 foreach($origMentions as $origMentionsId=>$origMention) {
784 if($origMention->getNickname() == $nickname) {
785 $mention_found_in_origMentions = $origMention;
786 // don't mention same twice! the parent might have mentioned
787 // two users with same nickname on different instances
788 unset($origMentions[$origMentionsId]);
793 // Try to get a profile for this nickname.
794 // Start with parents mentions, then go to parents sender context
795 if ($mention_found_in_origMentions) {
796 $mentioned = $mention_found_in_origMentions;
797 } else if ($parent instanceof Notice && $parent->getProfile()->getNickname() === $nickname) {
798 $mentioned = $parent->getProfile();
800 // sets to null if no match
801 $mentioned = common_relative_profile($sender, $nickname);
804 if ($mentioned instanceof Profile) {
806 $url = $mentioned->getUri(); // prefer the URI as URL, if it is one.
807 if (!common_valid_http_url($url)) {
808 $url = $mentioned->getUrl();
810 } catch (InvalidUrlException $e) {
811 $url = common_local_url('userbyid', array('id' => $mentioned->getID()));
814 $mention = array('mentioned' => array($mentioned),
817 'position' => $match[1],
818 'length' => mb_strlen($match[0]),
819 'title' => $mentioned->getFullname(),
822 $mentions[] = $mention;
826 // @#tag => mention of all subscriptions tagged 'tag'
828 preg_match_all('/'.Nickname::BEFORE_MENTIONS.'@#([\pL\pN_\-\.]{1,64})/',
829 $text, $hmatches, PREG_OFFSET_CAPTURE);
830 foreach ($hmatches[1] as $hmatch) {
831 $tag = common_canonical_tag($hmatch[0]);
832 $plist = Profile_list::getByTaggerAndTag($sender->getID(), $tag);
833 if (!$plist instanceof Profile_list || $plist->private) {
836 $tagged = $sender->getTaggedSubscribers($tag);
838 $url = common_local_url('showprofiletag',
839 array('nickname' => $sender->getNickname(),
842 $mentions[] = array('mentioned' => $tagged,
844 'text' => $hmatch[0],
845 'position' => $hmatch[1],
846 'length' => mb_strlen($hmatch[0]),
850 preg_match_all('/'.Nickname::BEFORE_MENTIONS.'!(' . Nickname::DISPLAY_FMT . ')/',
851 $text, $hmatches, PREG_OFFSET_CAPTURE);
852 foreach ($hmatches[1] as $hmatch) {
853 $nickname = Nickname::normalize($hmatch[0]);
854 $group = User_group::getForNickname($nickname, $sender);
856 if (!$group instanceof User_group || !$sender->isMember($group)) {
860 $profile = $group->getProfile();
862 $mentions[] = array('mentioned' => array($profile),
864 'text' => $hmatch[0],
865 'position' => $hmatch[1],
866 'length' => mb_strlen($hmatch[0]),
867 'url' => $group->permalink(),
868 'title' => $group->getFancyName());
871 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
878 * Does the actual regex pulls to find @-mentions in text.
879 * Should generally not be called directly; for use in common_find_mentions.
881 * @param string $text
882 * @param string $preMention Character(s) that signals a mention ('@', '!'...)
883 * @return array of PCRE match arrays
885 function common_find_mentions_raw($text, $preMention='@')
888 preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
891 PREG_OFFSET_CAPTURE);
893 $atmatches = array();
894 // the regexp's "(?!\@)" makes sure it doesn't matches the single "@remote" in "@remote@server.com"
895 preg_match_all('/'.Nickname::BEFORE_MENTIONS.preg_quote($preMention, '/').'(' . Nickname::DISPLAY_FMT . ')\b(?!\@)/',
898 PREG_OFFSET_CAPTURE);
900 $matches = array_merge($tmatches[1], $atmatches[1]);
904 function common_render_text($text)
906 $text = common_remove_unicode_formatting($text);
907 $text = nl2br(htmlspecialchars($text));
909 $text = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $text);
910 $text = common_replace_urls_callback($text, 'common_linkify');
911 $text = preg_replace_callback('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
912 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $text);
917 define('_URL_SCHEME_COLON_DOUBLE_SLASH', 1);
918 define('_URL_SCHEME_SINGLE_COLON', 2);
919 define('_URL_SCHEME_NO_DOMAIN', 4);
920 define('_URL_SCHEME_COLON_COORDINATES', 8);
922 function common_url_schemes($filter=null)
924 // TODO: move these to $config
926 'http' => _URL_SCHEME_COLON_DOUBLE_SLASH,
927 'https' => _URL_SCHEME_COLON_DOUBLE_SLASH,
928 'ftp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
929 'ftps' => _URL_SCHEME_COLON_DOUBLE_SLASH,
930 'mms' => _URL_SCHEME_COLON_DOUBLE_SLASH,
931 'rtsp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
932 'gopher' => _URL_SCHEME_COLON_DOUBLE_SLASH,
933 'news' => _URL_SCHEME_COLON_DOUBLE_SLASH,
934 'nntp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
935 'telnet' => _URL_SCHEME_COLON_DOUBLE_SLASH,
936 'wais' => _URL_SCHEME_COLON_DOUBLE_SLASH,
937 'file' => _URL_SCHEME_COLON_DOUBLE_SLASH,
938 'prospero' => _URL_SCHEME_COLON_DOUBLE_SLASH,
939 'webcal' => _URL_SCHEME_COLON_DOUBLE_SLASH,
940 'irc' => _URL_SCHEME_COLON_DOUBLE_SLASH,
941 'ircs' => _URL_SCHEME_COLON_DOUBLE_SLASH,
942 'aim' => _URL_SCHEME_SINGLE_COLON,
943 'bitcoin' => _URL_SCHEME_SINGLE_COLON,
944 'fax' => _URL_SCHEME_SINGLE_COLON,
945 'jabber' => _URL_SCHEME_SINGLE_COLON,
946 'mailto' => _URL_SCHEME_SINGLE_COLON,
947 'tel' => _URL_SCHEME_SINGLE_COLON,
948 'xmpp' => _URL_SCHEME_SINGLE_COLON,
949 'magnet' => _URL_SCHEME_NO_DOMAIN,
950 'geo' => _URL_SCHEME_COLON_COORDINATES,
954 array_filter($schemes,
955 function ($scheme) use ($filter) {
956 return is_null($filter) || ($scheme & $filter);
962 * Find links in the given text and pass them to the given callback function.
964 * @param string $text
965 * @param function($text, $arg) $callback: return replacement text
966 * @param mixed $arg: optional argument will be passed on to the callback
968 function common_replace_urls_callback($text, $callback, $arg = null) {
969 $geouri_labeltext_regex = '\pN\pL\-';
970 $geouri_mark_regex = '\-\_\.\!\~\*\\\'\(\)'; // the \\\' is really pretty
971 $geouri_unreserved_regex = '\pN\pL' . $geouri_mark_regex;
972 $geouri_punreserved_regex = '\[\]\:\&\+\$';
973 $geouri_pctencoded_regex = '(?:\%[0-9a-fA-F][0-9a-fA-F])';
974 $geouri_paramchar_regex = $geouri_unreserved_regex . $geouri_punreserved_regex; //FIXME: add $geouri_pctencoded_regex here so it works
976 // Start off with a regex
978 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
981 '(?:'. //Known protocols
983 '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_DOUBLE_SLASH)) . ')://)'.
985 '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_SINGLE_COLON)) . '):)'.
987 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
990 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
992 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
997 '(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_COORDINATES)) . '):'.
998 // There's an order that must be followed here too, if ;crs= is used, it must precede ;u=
999 // Also 'crsp' (;crs=$crsp) must match $geouri_labeltext_regex
1000 // Also 'uval' (;u=$uval) must be a pnum: \-?[0-9]+
1002 '(?:[0-9]+(?:\.[0-9]+)?(?:\,[0-9]+(?:\.[0-9]+)?){1,2})'. // 1(.23)?(,4(.56)){1,2}
1003 '(?:\;(?:['.$geouri_labeltext_regex.']+)(?:\=['.$geouri_paramchar_regex.']+)*)*'.
1006 // URLs without domain name, like magnet:?xt=...
1007 '|(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_NO_DOMAIN)) . '):(?=\?))'. // zero-length lookahead requires ? after :
1008 (common_config('linkify', 'bare_ipv4') // Convert IPv4 addresses to hyperlinks
1009 ? '|(?:(?: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]?)'
1011 (common_config('linkify', 'bare_ipv6') // Convert IPv6 addresses to hyperlinks
1013 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
1016 (common_config('linkify', 'bare_domains')
1018 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
1019 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
1020 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
1021 '(?: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)'.
1023 : '') . // if common_config('linkify', 'bare_domains') is false, don't add anything here
1026 '(?:\:\d+)?'. //:port
1027 '(?:/[' . URL_REGEX_VALID_PATH_CHARS . ']*)?'. // path
1028 '(?:\?[' . URL_REGEX_VALID_QSTRING_CHARS . ']*)?'. // ?query string
1029 '(?:\#[' . URL_REGEX_VALID_FRAGMENT_CHARS . ']*)?'. // #fragment
1030 ')(?<!['. URL_REGEX_EXCLUDED_END_CHARS .'])'.
1033 //preg_match_all($regex,$text,$matches);
1034 //print_r($matches);
1035 return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
1039 * Intermediate callback for common_replace_links(), helps resolve some
1040 * ambiguous link forms before passing on to the final callback.
1042 * @param array $matches
1043 * @param callable $callback
1044 * @param mixed $arg optional argument to pass on as second param to callback
1049 function callback_helper($matches, $callback, $arg=null) {
1051 $left = strpos($matches[0],$url);
1052 $right = $left+strlen($url);
1054 $groupSymbolSets=array(
1072 $cannotEndWith=array('.','?',',','#');
1076 foreach($groupSymbolSets as $groupSymbolSet){
1077 if(substr($url,-1)==$groupSymbolSet['right']){
1078 $group_left_count = substr_count($url,$groupSymbolSet['left']);
1079 $group_right_count = substr_count($url,$groupSymbolSet['right']);
1080 if($group_left_count<$group_right_count){
1082 $url=substr($url,0,-1);
1086 if(in_array(substr($url,-1),$cannotEndWith)){
1088 $url=substr($url,0,-1);
1090 }while($original_url!=$url);
1092 $result = call_user_func_array($callback, array($url, $arg));
1093 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
1096 require_once INSTALLDIR . "/lib/curry.php";
1098 function common_linkify($url) {
1099 // It comes in special'd, so we unspecial it before passing to the stringifying
1101 $url = htmlspecialchars_decode($url);
1103 if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
1104 //url is an email address without the mailto: protocol
1105 $canon = "mailto:$url";
1106 $longurl = "mailto:$url";
1108 $canon = File_redirection::_canonUrl($url);
1109 $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
1111 if(isset($longurl_data->redir_url)) {
1112 $longurl = $longurl_data->redir_url;
1115 $longurl = $longurl_data->url;
1119 $attrs = array('href' => $longurl, 'title' => $longurl);
1121 $is_attachment = false;
1122 $attachment_id = null;
1125 // Check to see whether this is a known "attachment" URL.
1128 $f = File::getByUrl($longurl);
1129 } catch (NoResultException $e) {
1130 if (common_config('attachments', 'process_links')) {
1131 // XXX: this writes to the database. :<
1133 $f = File::processNew($longurl);
1134 } catch (ServerException $e) {
1140 if ($f instanceof File) {
1142 $enclosure = $f->getEnclosure();
1143 $is_attachment = true;
1144 $attachment_id = $f->id;
1146 $thumb = File_thumbnail::getKV('file_id', $f->id);
1147 $has_thumb = ($thumb instanceof File_thumbnail);
1148 } catch (ServerException $e) {
1149 // There was not enough metadata available
1153 // Whether to nofollow
1154 $nf = common_config('nofollow', 'external');
1156 if ($nf == 'never') {
1157 $attrs['rel'] = 'external';
1159 $attrs['rel'] = 'nofollow external';
1163 if ($is_attachment) {
1164 $attrs['class'] = 'attachment';
1166 $attrs['class'] = 'attachment thumbnail';
1168 $attrs['id'] = "attachment-{$attachment_id}";
1169 $attrs['rel'] .= ' noreferrer';
1172 return XMLStringer::estring('a', $attrs, $url);
1176 * Find and shorten links in a given chunk of text if it's longer than the
1177 * configured notice content limit (or unconditionally).
1179 * Side effects: may save file and file_redirection records for referenced URLs.
1181 * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1182 * user's options are used; otherwise the current web session user's setitngs
1183 * will be used or ur1.ca if there is no active web login.
1185 * @param string $text
1186 * @param boolean $always (optional)
1187 * @param User $user (optional)
1191 function common_shorten_links($text, $always = false, User $user=null)
1193 if ($user === null) {
1194 $user = common_current_user();
1197 $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1199 if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1200 return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1202 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1207 * Very basic stripping of invalid UTF-8 input text.
1209 * @param string $str
1210 * @return mixed string or null if invalid input
1212 * @todo ideally we should drop bad chars, and maybe do some of the checks
1213 * from common_xml_safe_str. But we can't strip newlines, etc.
1214 * @todo Unicode normalization might also be useful, but not needed now.
1216 function common_validate_utf8($str)
1218 // preg_replace will return NULL on invalid UTF-8 input.
1220 // Note: empty regex //u also caused NULL return on some
1221 // production machines, but none of our test machines.
1223 // This should be replaced with a more reliable check.
1224 return preg_replace('/\x00/u', '', $str);
1228 * Make sure an arbitrary string is safe for output in XML as a single line.
1230 * @param string $str
1233 function common_xml_safe_str($str)
1235 // Replace common eol and extra whitespace input chars
1240 "\0", // null byte eos
1241 "\x0B" // vertical tab
1244 $replacement = array(
1245 ' ', // single space
1252 $str = str_replace($unWelcome, $replacement, $str);
1254 // Neutralize any additional control codes and UTF-16 surrogates
1255 // (Twitter uses '*')
1256 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1259 function common_slugify($str)
1261 // php5-intl is highly recommended...
1262 if (!function_exists('transliterator_transliterate')) {
1263 $str = preg_replace('/[^\pL\pN]/u', '', $str);
1264 $str = mb_convert_case($str, MB_CASE_LOWER, 'UTF-8');
1265 $str = substr($str, 0, 64);
1268 $str = transliterator_transliterate(
1269 'Any-Latin;' . // any charset to latin compatible
1270 'NFD;' . // decompose
1271 '[:Nonspacing Mark:] Remove;' . // remove nonspacing marks (accents etc.)
1272 'NFC;' . // composite again
1273 '[:Punctuation:] Remove;' . // remove punctuation (.,¿? etc.)
1274 'Lower();' . // turn into lowercase
1275 'Latin-ASCII;', // get ASCII equivalents (ð to d for example)
1277 return preg_replace('/[^\pL\pN]/', '', $str);
1280 function common_tag_link($tag)
1282 $canonical = common_canonical_tag($tag);
1283 if (common_config('singleuser', 'enabled')) {
1284 // regular TagAction isn't set up in 1user mode
1285 $nickname = User::singleUserNickname();
1286 $url = common_local_url('showstream',
1287 array('nickname' => $nickname,
1288 'tag' => $canonical));
1290 $url = common_local_url('tag', array('tag' => $canonical));
1292 $xs = new XMLStringer();
1293 $xs->elementStart('span', 'tag');
1294 $xs->element('a', array('href' => $url,
1297 $xs->elementEnd('span');
1298 return $xs->getString();
1301 function common_canonical_tag($tag)
1303 $tag = common_slugify($tag);
1304 $tag = substr($tag, 0, 64);
1308 function common_valid_profile_tag($str)
1310 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1314 * Resolve an ambiguous profile nickname reference, checking in following order:
1315 * - profiles that $sender subscribes to
1316 * - profiles that subscribe to $sender
1317 * - local user profiles
1319 * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1320 * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1323 * @fixme validate input
1325 * @fixme fix or remove mystery third parameter
1326 * @fixme is $sender a User or Profile?
1328 * @param <type> $sender the user or profile in whose context we're looking
1329 * @param string $nickname validated nickname of
1330 * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1332 * @return Profile or null
1334 function common_relative_profile($sender, $nickname, $dt=null)
1336 // Will throw exception on invalid input.
1337 $nickname = Nickname::normalize($nickname);
1339 // Try to find profiles this profile is subscribed to that have this nickname
1340 $recipient = new Profile();
1341 // XXX: use a join instead of a subquery
1342 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1343 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1344 if ($recipient->find(true)) {
1345 // XXX: should probably differentiate between profiles with
1346 // the same name by date of most recent update
1349 // Try to find profiles that listen to this profile and that have this nickname
1350 $recipient = new Profile();
1351 // XXX: use a join instead of a subquery
1352 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1353 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1354 if ($recipient->find(true)) {
1355 // XXX: should probably differentiate between profiles with
1356 // the same name by date of most recent update
1359 // If this is a local user, try to find a local user with that nickname.
1360 $sender = User::getKV('id', $sender->id);
1361 if ($sender instanceof User) {
1362 $recipient_user = User::getKV('nickname', $nickname);
1363 if ($recipient_user instanceof User) {
1364 return $recipient_user->getProfile();
1367 // Otherwise, no links. @messages from local users to remote users,
1368 // or from remote users to other remote users, are just
1369 // outside our ability to make intelligent guesses about
1373 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1375 if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1377 $path = $r->build($action, $args, $params, $fragment);
1379 $ssl = GNUsocial::useHTTPS();
1381 if (common_config('site','fancy')) {
1382 $url = common_path($path, $ssl, $addSession);
1384 if (mb_strpos($path, '/index.php') === 0) {
1385 $url = common_path($path, $ssl, $addSession);
1387 $url = common_path('index.php/'.$path, $ssl, $addSession);
1390 Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1395 function common_path($relative, $ssl=false, $addSession=true)
1397 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1399 if ($ssl && GNUsocial::useHTTPS()) {
1401 if (is_string(common_config('site', 'sslserver')) &&
1402 mb_strlen(common_config('site', 'sslserver')) > 0) {
1403 $serverpart = common_config('site', 'sslserver');
1404 } else if (common_config('site', 'server')) {
1405 $serverpart = common_config('site', 'server');
1407 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1411 if (common_config('site', 'server')) {
1412 $serverpart = common_config('site', 'server');
1414 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1419 $relative = common_inject_session($relative, $serverpart);
1422 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1425 // FIXME: Maybe this should also be able to handle non-fancy URLs with index.php?p=...
1426 function common_fake_local_fancy_url($url)
1429 * This is a hacky fix to make URIs generated with "index.php/" match against
1430 * locally stored URIs without that. So for example if the remote site is looking
1431 * up the webfinger for some user and for some reason knows about https://some.example/user/1
1432 * but we locally store and report only https://some.example/index.php/user/1 then they would
1433 * dismiss the profile for not having an identified alias.
1435 * There are various live instances where these issues occur, for various reasons.
1436 * Most of them being users fiddling with configuration while already having
1437 * started federating (distributing the URI to other servers) or maybe manually
1438 * editing the local database.
1441 // [1] protocol part, we can only rewrite http/https anyway.
1444 // FIXME: Dunno how this acts if we're aliasing ourselves with a .onion domain etc.
1445 '('.preg_quote(common_config('site', 'server'), '/').')' .
1446 // [3] site path, or if that is empty just '/' (to retain the /)
1447 '('.preg_quote(common_config('site', 'path') ?: '/', '/').')' .
1448 // [4] + [5] extract index.php (+ possible leading double /) and the rest of the URL separately.
1449 '(\/?index\.php\/)(.*)$/', $url, $matches)) {
1450 // if preg_match failed to match
1451 throw new Exception('No known change could be made to the URL.');
1454 // now reconstruct the URL with everything except the "index.php/" part
1456 foreach ([1,2,3,5] as $idx) {
1457 $fancy_url .= $matches[$idx];
1462 // FIXME: Maybe this should also be able to handle non-fancy URLs with index.php?p=...
1463 function common_fake_local_nonfancy_url($url)
1466 * This is a hacky fix to make URIs NOT generated with "index.php/" match against
1467 * locally stored URIs WITH that. The reverse from the above.
1469 * It will also "repair" index.php URLs with multiple / prepended. Like https://some.example///index.php/user/1
1472 // [1] protocol part, we can only rewrite http/https anyway.
1475 // FIXME: Dunno how this acts if we're aliasing ourselves with a .onion domain etc.
1476 '('.preg_quote(common_config('site', 'server'), '/').')' .
1477 // [3] site path, or if that is empty just '/' (to retain the /)
1478 '('.preg_quote(common_config('site', 'path') ?: '/', '/').')' .
1479 // [4] should be empty (might contain one or more / and then maybe also index.php). Will be overwritten.
1480 // [5] will have the extracted actual URL part (besides site path)
1481 '((?!index.php\/)\/*(?:index.php\/)?)(.*)$/', $url, $matches)) {
1482 // if preg_match failed to match
1483 throw new Exception('No known change could be made to the URL.');
1486 $matches[4] = 'index.php/'; // inject the index.php/ rewritethingy
1488 // remove the first element, which is the full matching string
1489 array_shift($matches);
1490 return implode($matches);
1493 function common_inject_session($url, $serverpart = null)
1495 if (!common_have_session()) {
1499 if (empty($serverpart)) {
1500 $serverpart = parse_url($url, PHP_URL_HOST);
1503 $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1505 // Are we pointing to another server (like an SSL server?)
1507 if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1508 // Pass the session ID as a GET parameter
1509 $sesspart = session_name() . '=' . session_id();
1510 $i = strpos($url, '?');
1511 if ($i === false) { // no GET params, just append
1512 $url .= '?' . $sesspart;
1514 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1521 function common_date_string($dt)
1523 // XXX: do some sexy date formatting
1524 // return date(DATE_RFC822, $dt);
1525 $t = strtotime($dt);
1529 if ($now < $t) { // that shouldn't happen!
1530 return common_exact_date($dt);
1531 } else if ($diff < 60) {
1532 // TRANS: Used in notices to indicate when the notice was made compared to now.
1533 return _('a few seconds ago');
1534 } else if ($diff < 92) {
1535 // TRANS: Used in notices to indicate when the notice was made compared to now.
1536 return _('about a minute ago');
1537 } else if ($diff < 3300) {
1538 $minutes = round($diff/60);
1539 // TRANS: Used in notices to indicate when the notice was made compared to now.
1540 return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1541 } else if ($diff < 5400) {
1542 // TRANS: Used in notices to indicate when the notice was made compared to now.
1543 return _('about an hour ago');
1544 } else if ($diff < 22 * 3600) {
1545 $hours = round($diff/3600);
1546 // TRANS: Used in notices to indicate when the notice was made compared to now.
1547 return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1548 } else if ($diff < 37 * 3600) {
1549 // TRANS: Used in notices to indicate when the notice was made compared to now.
1550 return _('about a day ago');
1551 } else if ($diff < 24 * 24 * 3600) {
1552 $days = round($diff/(24*3600));
1553 // TRANS: Used in notices to indicate when the notice was made compared to now.
1554 return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1555 } else if ($diff < 46 * 24 * 3600) {
1556 // TRANS: Used in notices to indicate when the notice was made compared to now.
1557 return _('about a month ago');
1558 } else if ($diff < 330 * 24 * 3600) {
1559 $months = round($diff/(30*24*3600));
1560 // TRANS: Used in notices to indicate when the notice was made compared to now.
1561 return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1562 } else if ($diff < 480 * 24 * 3600) {
1563 // TRANS: Used in notices to indicate when the notice was made compared to now.
1564 return _('about a year ago');
1566 return common_exact_date($dt);
1570 function common_exact_date($dt)
1576 $_utc = new DateTimeZone('UTC');
1577 $_siteTz = new DateTimeZone(common_timezone());
1580 $dateStr = date('d F Y H:i:s', strtotime($dt));
1581 $d = new DateTime($dateStr, $_utc);
1582 $d->setTimezone($_siteTz);
1583 // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
1584 return $d->format(_('l, d-M-Y H:i:s T'));
1587 function common_date_w3dtf($dt)
1589 $dateStr = date('d F Y H:i:s', strtotime($dt));
1590 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1591 $d->setTimezone(new DateTimeZone(common_timezone()));
1592 return $d->format(DATE_W3C);
1595 function common_date_rfc2822($dt)
1597 $dateStr = date('d F Y H:i:s', strtotime($dt));
1598 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1599 $d->setTimezone(new DateTimeZone(common_timezone()));
1600 return $d->format('r');
1603 function common_date_iso8601($dt)
1605 $dateStr = date('d F Y H:i:s', strtotime($dt));
1606 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1607 $d->setTimezone(new DateTimeZone(common_timezone()));
1608 return $d->format('c');
1611 function common_sql_now()
1613 return common_sql_date(time());
1616 function common_sql_date($datetime)
1618 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1622 * Return an SQL fragment to calculate an age-based weight from a given
1623 * timestamp or datetime column.
1625 * @param string $column name of field we're comparing against current time
1626 * @param integer $dropoff divisor for age in seconds before exponentiation
1627 * @return string SQL fragment
1629 function common_sql_weight($column, $dropoff)
1631 if (common_config('db', 'type') == 'pgsql') {
1632 // PostgreSQL doesn't support timestampdiff function.
1633 // @fixme will this use the right time zone?
1634 // @fixme does this handle cross-year subtraction correctly?
1635 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1637 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1641 function common_redirect($url, $code=307)
1643 static $status = array(301 => "Moved Permanently",
1646 307 => "Temporary Redirect");
1648 header('HTTP/1.1 '.$code.' '.$status[$code]);
1649 header("Location: $url");
1650 header("Connection: close");
1652 $xo = new XMLOutputter();
1654 '-//W3C//DTD XHTML 1.0 Strict//EN',
1655 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1656 $xo->element('a', array('href' => $url), $url);
1661 // Stick the notice on the queue
1663 function common_enqueue_notice($notice)
1665 static $localTransports = array('ping');
1667 $transports = array();
1668 if (common_config('sms', 'enabled')) {
1669 $transports[] = 'sms';
1671 if (Event::hasHandler('HandleQueuedNotice')) {
1672 $transports[] = 'plugin';
1675 // We can skip these for gatewayed notices.
1676 if ($notice->isLocal()) {
1677 $transports = array_merge($transports, $localTransports);
1680 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1682 $qm = QueueManager::get();
1684 foreach ($transports as $transport)
1686 $qm->enqueue($notice, $transport);
1689 Event::handle('EndEnqueueNotice', array($notice, $transports));
1695 function common_profile_url($nickname)
1697 return common_local_url('showstream', array('nickname' => $nickname),
1702 * Should make up a reasonable root URL
1704 * @param bool $tls true or false to force TLS scheme, null to use server configuration
1706 function common_root_url($tls=null)
1708 if (is_null($tls)) {
1709 $tls = GNUsocial::useHTTPS();
1711 $url = common_path('', $tls, false);
1712 $i = strpos($url, '?');
1714 $url = substr($url, 0, $i);
1720 * returns $bytes bytes of raw random data
1722 function common_random_rawstr($bytes)
1724 $rawstr = @file_exists('/dev/urandom')
1725 ? common_urandom($bytes)
1726 : common_mtrand($bytes);
1732 * returns $bytes bytes of random data as a hexadecimal string
1734 function common_random_hexstr($bytes)
1736 $str = common_random_rawstr($bytes);
1739 for ($i = 0; $i < $bytes; $i++) {
1740 $hexstr .= sprintf("%02x", ord($str[$i]));
1745 function common_urandom($bytes)
1747 $h = fopen('/dev/urandom', 'rb');
1749 $src = fread($h, $bytes);
1754 function common_mtrand($bytes)
1757 for ($i = 0; $i < $bytes; $i++) {
1758 $str .= chr(mt_rand(0, 255));
1764 * Record the given URL as the return destination for a future
1765 * form submission, to be read by common_get_returnto().
1767 * @param string $url
1769 * @fixme as a session-global setting, this can allow multiple forms
1770 * to conflict and overwrite each others' returnto destinations if
1771 * the user has multiple tabs or windows open.
1773 * Should refactor to index with a token or otherwise only pass the
1774 * data along its intended path.
1776 function common_set_returnto($url)
1778 common_ensure_session();
1779 $_SESSION['returnto'] = $url;
1783 * Fetch a return-destination URL previously recorded by
1784 * common_set_returnto().
1786 * @return mixed URL string or null
1788 * @fixme as a session-global setting, this can allow multiple forms
1789 * to conflict and overwrite each others' returnto destinations if
1790 * the user has multiple tabs or windows open.
1792 * Should refactor to index with a token or otherwise only pass the
1793 * data along its intended path.
1795 function common_get_returnto()
1797 common_ensure_session();
1798 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1801 function common_timestamp()
1803 return date('YmdHis');
1806 function common_ensure_syslog()
1808 static $initialized = false;
1809 if (!$initialized) {
1810 openlog(common_config('syslog', 'appname'), 0,
1811 common_config('syslog', 'facility'));
1812 $initialized = true;
1816 function common_log_line($priority, $msg)
1818 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1819 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1820 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1823 function common_request_id()
1826 $server = common_config('site', 'server');
1827 if (php_sapi_name() == 'cli') {
1828 $script = basename($_SERVER['PHP_SELF']);
1829 return "$server:$script:$pid";
1831 static $req_id = null;
1832 if (!isset($req_id)) {
1833 $req_id = substr(md5(mt_rand()), 0, 8);
1835 if (isset($_SERVER['REQUEST_URI'])) {
1836 $url = $_SERVER['REQUEST_URI'];
1838 $method = $_SERVER['REQUEST_METHOD'];
1839 return "$server:$pid.$req_id $method $url";
1843 function common_log($priority, $msg, $filename=null)
1845 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1846 $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1847 $msg = '[' . common_request_id() . '] ' . $msg;
1848 $logfile = common_config('site', 'logfile');
1850 $log = fopen($logfile, "a");
1852 $output = common_log_line($priority, $msg);
1853 fwrite($log, $output);
1857 common_ensure_syslog();
1858 syslog($priority, $msg);
1860 Event::handle('EndLog', array($priority, $msg, $filename));
1864 function common_debug($msg, $filename=null)
1867 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1869 common_log(LOG_DEBUG, $msg);
1873 function common_log_db_error(&$object, $verb, $filename=null)
1877 $objstr = common_log_objstring($object);
1878 $last_error = &$_PEAR->getStaticProperty('DB_DataObject','lastError');
1879 if (is_object($last_error)) {
1880 $msg = $last_error->message;
1882 $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1884 common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1887 function common_log_objstring(&$object)
1889 if (is_null($object)) {
1892 if (!($object instanceof DB_DataObject)) {
1895 $arr = $object->toArray();
1897 foreach ($arr as $k => $v) {
1898 if (is_object($v)) {
1899 $fields[] = "$k='".get_class($v)."'";
1901 $fields[] = "$k='$v'";
1904 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1908 function common_valid_http_url($url, $secure=false)
1914 // If $secure is true, only allow https URLs to pass
1915 // (if false, we use '?' in 'https?' to say the 's' is optional)
1916 $regex = $secure ? '/^https$/' : '/^https?$/';
1917 return filter_var($url, FILTER_VALIDATE_URL)
1918 && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1921 function common_valid_tag($tag)
1923 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1924 return (Validate::email($matches[1]) ||
1925 preg_match('/^([\w-\.]+)$/', $matches[1]));
1931 * Determine if given domain or address literal is valid
1932 * eg for use in JIDs and URLs. Does not check if the domain
1935 * @param string $domain
1936 * @return boolean valid or not
1938 function common_valid_domain($domain)
1940 $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1941 $ipv4 = "(?:$octet(?:\.$octet){3})";
1942 if (preg_match("/^$ipv4$/u", $domain)) return true;
1944 $group = "(?:[0-9a-f]{1,4})";
1945 $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1947 if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1948 $before = explode(":", $matches[1]);
1949 $zeroes = $matches[2];
1950 $after = explode(":", $matches[3]);
1958 $explicit = count($before) + count($after);
1959 if ($explicit < $min || $explicit > $max) {
1966 require_once "Net/IDNA.php";
1967 $idn = Net_IDNA::getInstance();
1968 $domain = $idn->encode($domain);
1969 } catch (Exception $e) {
1973 $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1974 $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1976 return preg_match("/^$fqdn$/ui", $domain);
1979 /* Following functions are copied from MediaWiki GlobalFunctions.php
1980 * and written by Evan Prodromou. */
1982 function common_accept_to_prefs($accept, $def = '*/*')
1984 // No arg means accept anything (per HTTP spec)
1986 return array($def => 1);
1991 $parts = explode(',', $accept);
1993 foreach($parts as $part) {
1994 // FIXME: doesn't deal with params like 'text/html; level=1'
1995 @list($value, $qpart) = explode(';', trim($part));
1997 if(!isset($qpart)) {
1999 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
2000 $prefs[$value] = $match[1];
2007 // Match by our supported file extensions
2008 function common_supported_filename_to_mime($filename)
2010 // Accept a filename and take out the extension
2011 if (strpos($filename, '.') === false) {
2012 throw new ServerException(sprintf('No extension on filename: %1$s', _ve($filename)));
2015 $fileext = substr(strrchr($filename, '.'), 1);
2016 return common_supported_ext_to_mime($fileext);
2019 function common_supported_ext_to_mime($fileext)
2021 $supported = common_config('attachments', 'supported');
2022 if ($supported === true) {
2023 // FIXME: Should we just accept the extension straight off when supported === true?
2024 throw new UnknownExtensionMimeException($fileext);
2026 foreach($supported as $type => $ext) {
2027 if ($ext === $fileext) {
2032 throw new ServerException('Unsupported file extension');
2035 // Match by our supported mime types
2036 function common_supported_mime_to_ext($mimetype)
2038 $supported = common_config('attachments', 'supported');
2039 if (is_array($supported)) {
2040 foreach($supported as $type => $ext) {
2041 if ($mimetype === $type) {
2047 throw new UnknownMimeExtensionException($mimetype);
2050 // The MIME "media" is the part before the slash (video in video/webm)
2051 function common_get_mime_media($type)
2053 $tmp = explode('/', $type);
2054 return strtolower($tmp[0]);
2057 // Get only the mimetype and not additional info (separated from bare mime with semi-colon)
2058 function common_bare_mime($mimetype)
2060 $mimetype = mb_strtolower($mimetype);
2061 if ($semicolon = mb_strpos($mimetype, ';')) {
2062 $mimetype = mb_substr($mimetype, 0, $semicolon);
2064 return trim($mimetype);
2067 function common_mime_type_match($type, $avail)
2069 if(array_key_exists($type, $avail)) {
2072 $parts = explode('/', $type);
2073 if(array_key_exists($parts[0] . '/*', $avail)) {
2074 return $parts[0] . '/*';
2075 } elseif(array_key_exists('*/*', $avail)) {
2083 function common_negotiate_type($cprefs, $sprefs)
2087 foreach(array_keys($sprefs) as $type) {
2088 $parts = explode('/', $type);
2089 if($parts[1] != '*') {
2090 $ckey = common_mime_type_match($type, $cprefs);
2092 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2097 foreach(array_keys($cprefs) as $type) {
2098 $parts = explode('/', $type);
2099 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
2100 $skey = common_mime_type_match($type, $sprefs);
2102 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2108 $besttype = 'text/html';
2110 foreach(array_keys($combine) as $type) {
2111 if($combine[$type] > $bestq) {
2113 $bestq = $combine[$type];
2117 if ('text/html' === $besttype) {
2118 return "text/html; charset=utf-8";
2123 function common_config($main, $sub=null)
2126 if (is_null($sub)) {
2127 // Return the config category array
2128 return array_key_exists($main, $config) ? $config[$main] : array();
2130 // Return the config value
2131 return (array_key_exists($main, $config) &&
2132 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
2135 function common_config_set($main, $sub, $value)
2138 if (!array_key_exists($main, $config)) {
2139 $config[$main] = array();
2141 $config[$main][$sub] = $value;
2144 function common_config_append($main, $sub, $value)
2147 if (!array_key_exists($main, $config)) {
2148 $config[$main] = array();
2150 if (!array_key_exists($sub, $config[$main])) {
2151 $config[$main][$sub] = array();
2153 if (!is_array($config[$main][$sub])) {
2154 $config[$main][$sub] = array($config[$main][$sub]);
2156 array_push($config[$main][$sub], $value);
2160 * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
2161 * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
2163 * @param array $from
2166 function common_copy_args($from)
2169 $strip = get_magic_quotes_gpc();
2170 foreach ($from as $k => $v) {
2172 $to[$k] = common_copy_args($v);
2175 $v = stripslashes($v);
2177 $to[$k] = strval(common_validate_utf8($v));
2184 * Neutralise the evil effects of magic_quotes_gpc in the current request.
2185 * This is used before handing a request off to OAuthRequest::from_request.
2186 * @fixme Doesn't consider vars other than _POST and _GET?
2187 * @fixme Can't be undone and could corrupt data if run twice.
2189 function common_remove_magic_from_request()
2191 if(get_magic_quotes_gpc()) {
2192 $_POST=array_map('stripslashes',$_POST);
2193 $_GET=array_map('stripslashes',$_GET);
2197 function common_user_uri(&$user)
2199 return common_local_url('userbyid', array('id' => $user->id),
2203 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2205 function common_confirmation_code($bits)
2207 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2208 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
2209 $chars = ceil($bits/5);
2211 for ($i = 0; $i < $chars; $i++) {
2212 // XXX: convert to string and back
2213 $num = hexdec(common_random_hexstr(1));
2214 // XXX: randomness is too precious to throw away almost
2215 // 40% of the bits we get!
2216 $code .= $codechars[$num%32];
2221 // convert markup to HTML
2222 function common_markup_to_html($c, $args=null)
2228 if (is_null($args)) {
2232 // XXX: not very efficient
2234 foreach ($args as $name => $value) {
2235 $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
2238 $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
2239 $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
2240 $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
2241 $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
2243 return \Michelf\Markdown::defaultTransform($c);
2246 function common_user_property($property)
2248 $profile = Profile::current();
2250 if (empty($profile)) {
2254 switch ($property) {
2260 return $profile->$property;
2264 return $profile->getAvatar(AVATAR_STREAM_SIZE);
2265 } catch (Exception $e) {
2270 return $profile->getBestName();
2277 function common_profile_uri($profile)
2281 if (!empty($profile)) {
2282 if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2283 $user = User::getKV('id', $profile->id);
2284 if ($user instanceof User) {
2285 $uri = $user->getUri();
2287 Event::handle('EndCommonProfileURI', array($profile, &$uri));
2291 // XXX: this is a very bad profile!
2295 function common_canonical_sms($sms)
2298 preg_replace('/\D/', '', $sms);
2302 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2307 case E_COMPILE_ERROR:
2311 case E_RECOVERABLE_ERROR:
2312 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2317 case E_COMPILE_WARNING:
2318 case E_CORE_WARNING:
2319 case E_USER_WARNING:
2320 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2325 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2330 case E_USER_DEPRECATED:
2331 // XXX: config variable to log this stuff, too
2335 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2340 // FIXME: show error page if we're on the Web
2341 /* Don't execute PHP internal error handler */
2345 function common_session_token()
2347 common_ensure_session();
2348 if (!array_key_exists('token', $_SESSION)) {
2349 $_SESSION['token'] = common_random_hexstr(64);
2351 return $_SESSION['token'];
2354 function common_license_terms($uri)
2356 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2357 return explode('-',$matches[1]);
2362 function common_compatible_license($from, $to)
2364 $from_terms = common_license_terms($from);
2365 // public domain and cc-by are compatible with everything
2366 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2369 $to_terms = common_license_terms($to);
2370 // sa is compatible across versions. IANAL
2371 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2372 return count(array_diff($from_terms, $to_terms)) == 0;
2374 // XXX: better compatibility check needed here!
2375 // Should at least normalise URIs
2376 return ($from == $to);
2380 * returns a quoted table name, if required according to config
2382 function common_database_tablename($tablename)
2384 if(common_config('db','quote_identifiers')) {
2385 $tablename = '"'. $tablename .'"';
2387 //table prefixes could be added here later
2392 * Shorten a URL with the current user's configured shortening service,
2393 * or ur1.ca if configured, or not at all if no shortening is set up.
2395 * @param string $long_url original URL
2396 * @param User $user to specify a particular user's options
2397 * @param boolean $force Force shortening (used when notice is too long)
2398 * @return string may return the original URL if shortening failed
2400 * @fixme provide a way to specify a particular shortener
2402 function common_shorten_url($long_url, User $user=null, $force = false)
2404 $long_url = trim($long_url);
2406 $user = common_current_user();
2408 $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2410 // $force forces shortening even if it's not strictly needed
2411 // I doubt URL shortening is ever 'strictly' needed. - ESP
2413 if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2417 $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2419 if (Event::handle('StartShortenUrl',
2420 array($long_url, $shortenerName, &$shortenedUrl))) {
2421 if ($shortenerName == 'internal') {
2423 $f = File::processNew($long_url);
2424 $shortenedUrl = common_local_url('redirecturl', array('id' => $f->id));
2425 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2426 return $shortenedUrl;
2430 } catch (ServerException $e) {
2437 //URL was shortened, so return the result
2438 return trim($shortenedUrl);
2443 * @return mixed array($proxy, $ip) for web requests; proxy may be null
2444 * null if not a web request
2446 * @fixme X-Forwarded-For can be chained by multiple proxies;
2447 we should parse the list and provide a cleaner array
2448 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2449 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2450 * use function to get exact request headers from Apache if possible.
2452 function common_client_ip()
2454 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2458 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2459 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2460 $proxy = $_SERVER['HTTP_CLIENT_IP'];
2462 $proxy = $_SERVER['REMOTE_ADDR'];
2464 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2467 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2468 $ip = $_SERVER['HTTP_CLIENT_IP'];
2470 $ip = $_SERVER['REMOTE_ADDR'];
2474 return array($proxy, $ip);
2477 function common_url_to_nickname($url)
2479 static $bad = array('query', 'user', 'password', 'port', 'fragment');
2481 $parts = parse_url($url);
2483 // If any of these parts exist, this won't work
2485 foreach ($bad as $badpart) {
2486 if (array_key_exists($badpart, $parts)) {
2491 // We just have host and/or path
2493 // If it's just a host...
2494 if (array_key_exists('host', $parts) &&
2495 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2497 $hostparts = explode('.', $parts['host']);
2499 // Try to catch common idiom of nickname.service.tld
2501 if ((count($hostparts) > 2) &&
2502 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2503 (strcmp($hostparts[0], 'www') != 0))
2505 return common_nicknamize($hostparts[0]);
2507 // Do the whole hostname
2508 return common_nicknamize($parts['host']);
2511 if (array_key_exists('path', $parts)) {
2512 // Strip starting, ending slashes
2513 $path = preg_replace('@/$@', '', $parts['path']);
2514 $path = preg_replace('@^/@', '', $path);
2515 $path = basename($path);
2517 // Hack for MediaWiki user pages, in the form:
2518 // http://example.com/wiki/User:Myname
2519 // ('User' may be localized.)
2520 if (strpos($path, ':')) {
2521 $parts = array_filter(explode(':', $path));
2522 $path = $parts[count($parts) - 1];
2526 return common_nicknamize($path);
2534 function common_nicknamize($str)
2537 return Nickname::normalize($str);
2538 } catch (NicknameException $e) {
2543 function common_perf_counter($key, $val=null)
2545 global $_perfCounters;
2546 if (isset($_perfCounters)) {
2547 if (common_config('site', 'logperf')) {
2548 if (array_key_exists($key, $_perfCounters)) {
2549 $_perfCounters[$key][] = $val;
2551 $_perfCounters[$key] = array($val);
2553 if (common_config('site', 'logperf_detail')) {
2554 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2560 function common_log_perf_counters()
2562 if (common_config('site', 'logperf')) {
2563 global $_startTime, $_perfCounters;
2565 if (isset($_startTime)) {
2566 $endTime = microtime(true);
2567 $diff = round(($endTime - $_startTime) * 1000);
2568 common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2570 $counters = $_perfCounters;
2572 foreach ($counters as $key => $values) {
2573 $count = count($values);
2574 $unique = count(array_unique($values));
2575 common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2580 function common_is_email($str)
2582 return (strpos($str, '@') !== false);
2585 function common_init_stats()
2589 $_mem = memory_get_usage(true);
2590 $_ts = microtime(true);
2593 function common_log_delta($comment=null)
2600 $_mem = memory_get_usage(true);
2601 $_ts = microtime(true);
2603 $mtotal = $_mem - $mold;
2604 $ttotal = $_ts - $told;
2606 if (empty($comment)) {
2610 common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
2613 function common_strip_html($html, $trim=true, $save_whitespace=false)
2615 // first replace <br /> with \n
2616 $html = preg_replace('/\<(\s*)?br(\s*)?\/?(\s*)?\>/i', "\n", $html);
2617 // then, unless explicitly avoided, remove excessive whitespace
2618 if (!$save_whitespace) {
2619 $html = preg_replace('/\s+/', ' ', $html);
2621 $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
2622 return $trim ? trim($text) : $text;
2625 function html_sprintf()
2627 $args = func_get_args();
2628 for ($i=1; $i<count($args); $i++) {
2629 $args[$i] = htmlspecialchars($args[$i]);
2631 return call_user_func_array('sprintf', $args);
2636 return var_export($var, true);