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_preferred_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(), ''));
279 * Make sure session is started and handled by
280 * the correct handler.
282 function common_ensure_session()
284 if (!common_have_session()) {
285 if (common_config('sessions', 'handle')) {
286 session_set_save_handler(new InternalSessionHandler(), true);
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 if (common_config('cache', 'dir')) {
614 $cfg->set('Cache.SerializerPath', common_config('cache', 'dir'));
616 // if you don't want to use the default cache dir for htmlpurifier, set it specifically as $config['htmlpurifier']['Cache.SerializerPath'] = '/tmp'; or something.
617 foreach (common_config('htmlpurifier') as $key=>$val) {
618 $cfg->set($key, $val);
621 // Remove more elements than what the default filter removes, default in GNU social are remotely
622 // linked resources such as img, video, audio
623 $forbiddenElements = array();
624 foreach (common_config('htmlfilter') as $tag=>$filter) {
625 if ($filter === true) {
626 $forbiddenElements[] = $tag;
629 $cfg->set('HTML.ForbiddenElements', $forbiddenElements);
631 $html = common_remove_unicode_formatting($html);
633 $purifier = new HTMLPurifier($cfg);
634 $purified = $purifier->purify($html);
635 Event::handle('EndCommonPurify', array(&$purified, $html));
640 function common_remove_unicode_formatting($text)
642 // Strip Unicode text formatting/direction codes
643 // this is pretty dangerous for visualisation of text and can be used for mischief
644 return preg_replace('/[\\x{200b}-\\x{200f}\\x{202a}-\\x{202e}]/u', '', $text);
648 * Partial notice markup rendering step: build links to !group references.
650 * @param string $text partially rendered HTML
651 * @param Profile $author the Profile that is composing the current notice
652 * @param Notice $parent the Notice this is sent in reply to, if any
653 * @return string partially rendered HTML
655 function common_render_content($text, Profile $author, Notice $parent=null)
657 $text = common_render_text($text);
658 $text = common_linkify_mentions($text, $author, $parent);
663 * Finds @-mentions within the partially-rendered text section and
664 * turns them into live links.
666 * Should generally not be called except from common_render_content().
668 * @param string $text partially-rendered HTML
669 * @param Profile $author the Profile that is composing the current notice
670 * @param Notice $parent the Notice this is sent in reply to, if any
671 * @return string partially-rendered HTML
673 function common_linkify_mentions($text, Profile $author, Notice $parent=null)
675 $mentions = common_find_mentions($text, $author, $parent);
677 // We need to go through in reverse order by position,
678 // so our positions stay valid despite our fudging with the
683 foreach ($mentions as $mention)
685 $points[$mention['position']] = $mention;
690 foreach ($points as $position => $mention) {
692 $linkText = common_linkify_mention($mention);
694 $text = substr_replace($text, $linkText, $position, $mention['length']);
700 function common_linkify_mention(array $mention)
704 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
706 $xs = new XMLStringer(false);
708 $attrs = array('href' => $mention['url'],
709 'class' => 'h-card u-url p-nickname '.$mention['type']);
711 if (!empty($mention['title'])) {
712 $attrs['title'] = $mention['title'];
715 $xs->element('a', $attrs, $mention['text']);
717 $output = $xs->getString();
719 Event::handle('EndLinkifyMention', array($mention, &$output));
725 function common_get_attentions($text, Profile $sender, Notice $parent=null)
727 $mentions = common_find_mentions($text, $sender, $parent);
729 foreach ($mentions as $mention) {
730 foreach ($mention['mentioned'] as $mentioned) {
731 $atts[$mentioned->getUri()] = $mentioned->getObjectType();
734 if ($parent instanceof Notice) {
735 $parentAuthor = $parent->getProfile();
736 // afaik groups can't be authors
737 $atts[$parentAuthor->getUri()] = ActivityObject::PERSON;
743 * Find @-mentions in the given text, using the given notice object as context.
744 * References will be resolved with common_relative_profile() against the user
745 * who posted the notice.
747 * Note the return data format is internal, to be used for building links and
748 * such. Should not be used directly; rather, call common_linkify_mentions().
750 * @param string $text
751 * @param Profile $sender the Profile that is sending the current text
752 * @param Notice $parent the Notice this text is in reply to, if any
758 function common_find_mentions($text, Profile $sender, Notice $parent=null)
762 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
763 // Get the context of the original notice, if any
764 $origMentions = array();
765 // Does it have a parent notice for context?
766 if ($parent instanceof Notice) {
767 foreach ($parent->getAttentionProfiles() as $repliedTo) {
768 if (!$repliedTo->isPerson()) {
771 $origMentions[$repliedTo->id] = $repliedTo;
775 $matches = common_find_mentions_raw($text, '@');
777 foreach ($matches as $match) {
779 $nickname = Nickname::normalize($match[0]);
780 } catch (NicknameException $e) {
781 // Bogus match? Drop it.
785 // primarily mention the profiles mentioned in the parent
786 $mention_found_in_origMentions = false;
787 foreach($origMentions as $origMentionsId=>$origMention) {
788 if($origMention->getNickname() == $nickname) {
789 $mention_found_in_origMentions = $origMention;
790 // don't mention same twice! the parent might have mentioned
791 // two users with same nickname on different instances
792 unset($origMentions[$origMentionsId]);
797 // Try to get a profile for this nickname.
798 // Start with parents mentions, then go to parents sender context
799 if ($mention_found_in_origMentions) {
800 $mentioned = $mention_found_in_origMentions;
801 } else if ($parent instanceof Notice && $parent->getProfile()->getNickname() === $nickname) {
802 $mentioned = $parent->getProfile();
804 // sets to null if no match
805 $mentioned = common_relative_profile($sender, $nickname);
808 if ($mentioned instanceof Profile) {
810 $url = $mentioned->getUri(); // prefer the URI as URL, if it is one.
811 if (!common_valid_http_url($url)) {
812 $url = $mentioned->getUrl();
814 } catch (InvalidUrlException $e) {
815 $url = common_local_url('userbyid', array('id' => $mentioned->getID()));
818 $mention = array('mentioned' => array($mentioned),
821 'position' => $match[1],
822 'length' => mb_strlen($match[0]),
823 'title' => $mentioned->getFullname(),
826 $mentions[] = $mention;
830 // @#tag => mention of all subscriptions tagged 'tag'
832 preg_match_all('/'.Nickname::BEFORE_MENTIONS.'@#([\pL\pN_\-\.]{1,64})/',
833 $text, $hmatches, PREG_OFFSET_CAPTURE);
834 foreach ($hmatches[1] as $hmatch) {
835 $tag = common_canonical_tag($hmatch[0]);
836 $plist = Profile_list::getByTaggerAndTag($sender->getID(), $tag);
837 if (!$plist instanceof Profile_list || $plist->private) {
840 $tagged = $sender->getTaggedSubscribers($tag);
842 $url = common_local_url('showprofiletag',
843 array('nickname' => $sender->getNickname(),
846 $mentions[] = array('mentioned' => $tagged,
848 'text' => $hmatch[0],
849 'position' => $hmatch[1],
850 'length' => mb_strlen($hmatch[0]),
854 $hmatches = common_find_mentions_raw($text, '!');
855 foreach ($hmatches as $hmatch) {
856 $nickname = Nickname::normalize($hmatch[0]);
857 $group = User_group::getForNickname($nickname, $sender);
859 if (!$group instanceof User_group || !$sender->isMember($group)) {
863 $profile = $group->getProfile();
865 $mentions[] = array('mentioned' => array($profile),
867 'text' => $hmatch[0],
868 'position' => $hmatch[1],
869 'length' => mb_strlen($hmatch[0]),
870 'url' => $group->permalink(),
871 'title' => $group->getFancyName());
874 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
881 * Does the actual regex pulls to find @-mentions in text.
882 * Should generally not be called directly; for use in common_find_mentions.
884 * @param string $text
885 * @param string $preMention Character(s) that signals a mention ('@', '!'...)
886 * @return array of PCRE match arrays
888 function common_find_mentions_raw($text, $preMention='@')
891 preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
894 PREG_OFFSET_CAPTURE);
896 $atmatches = array();
897 // the regexp's "(?!\@)" makes sure it doesn't matches the single "@remote" in "@remote@server.com"
898 preg_match_all('/'.Nickname::BEFORE_MENTIONS.preg_quote($preMention, '/').'(' . Nickname::DISPLAY_FMT . ')\b(?!\@)/',
901 PREG_OFFSET_CAPTURE);
903 $matches = array_merge($tmatches[1], $atmatches[1]);
907 function common_render_text($text)
909 $text = common_remove_unicode_formatting($text);
910 $text = nl2br(htmlspecialchars($text));
912 $text = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $text);
913 $text = common_replace_urls_callback($text, 'common_linkify');
914 $text = preg_replace_callback('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
915 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $text);
920 define('_URL_SCHEME_COLON_DOUBLE_SLASH', 1);
921 define('_URL_SCHEME_SINGLE_COLON', 2);
922 define('_URL_SCHEME_NO_DOMAIN', 4);
923 define('_URL_SCHEME_COLON_COORDINATES', 8);
925 function common_url_schemes($filter=null)
927 // TODO: move these to $config
929 'http' => _URL_SCHEME_COLON_DOUBLE_SLASH,
930 'https' => _URL_SCHEME_COLON_DOUBLE_SLASH,
931 'ftp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
932 'ftps' => _URL_SCHEME_COLON_DOUBLE_SLASH,
933 'mms' => _URL_SCHEME_COLON_DOUBLE_SLASH,
934 'rtsp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
935 'gopher' => _URL_SCHEME_COLON_DOUBLE_SLASH,
936 'news' => _URL_SCHEME_COLON_DOUBLE_SLASH,
937 'nntp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
938 'telnet' => _URL_SCHEME_COLON_DOUBLE_SLASH,
939 'wais' => _URL_SCHEME_COLON_DOUBLE_SLASH,
940 'file' => _URL_SCHEME_COLON_DOUBLE_SLASH,
941 'prospero' => _URL_SCHEME_COLON_DOUBLE_SLASH,
942 'webcal' => _URL_SCHEME_COLON_DOUBLE_SLASH,
943 'irc' => _URL_SCHEME_COLON_DOUBLE_SLASH,
944 'ircs' => _URL_SCHEME_COLON_DOUBLE_SLASH,
945 'aim' => _URL_SCHEME_SINGLE_COLON,
946 'bitcoin' => _URL_SCHEME_SINGLE_COLON,
947 'fax' => _URL_SCHEME_SINGLE_COLON,
948 'jabber' => _URL_SCHEME_SINGLE_COLON,
949 'mailto' => _URL_SCHEME_SINGLE_COLON,
950 'tel' => _URL_SCHEME_SINGLE_COLON,
951 'xmpp' => _URL_SCHEME_SINGLE_COLON,
952 'magnet' => _URL_SCHEME_NO_DOMAIN,
953 'geo' => _URL_SCHEME_COLON_COORDINATES,
957 array_filter($schemes,
958 function ($scheme) use ($filter) {
959 return is_null($filter) || ($scheme & $filter);
965 * Find links in the given text and pass them to the given callback function.
967 * @param string $text
968 * @param function($text, $arg) $callback: return replacement text
969 * @param mixed $arg: optional argument will be passed on to the callback
971 function common_replace_urls_callback($text, $callback, $arg = null) {
972 $geouri_labeltext_regex = '\pN\pL\-';
973 $geouri_mark_regex = '\-\_\.\!\~\*\\\'\(\)'; // the \\\' is really pretty
974 $geouri_unreserved_regex = '\pN\pL' . $geouri_mark_regex;
975 $geouri_punreserved_regex = '\[\]\:\&\+\$';
976 $geouri_pctencoded_regex = '(?:\%[0-9a-fA-F][0-9a-fA-F])';
977 $geouri_paramchar_regex = $geouri_unreserved_regex . $geouri_punreserved_regex; //FIXME: add $geouri_pctencoded_regex here so it works
979 // Start off with a regex
981 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
984 '(?:'. //Known protocols
986 '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_DOUBLE_SLASH)) . ')://)'.
988 '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_SINGLE_COLON)) . '):)'.
990 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
993 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
995 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
1000 '(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_COORDINATES)) . '):'.
1001 // There's an order that must be followed here too, if ;crs= is used, it must precede ;u=
1002 // Also 'crsp' (;crs=$crsp) must match $geouri_labeltext_regex
1003 // Also 'uval' (;u=$uval) must be a pnum: \-?[0-9]+
1005 '(?:[0-9]+(?:\.[0-9]+)?(?:\,[0-9]+(?:\.[0-9]+)?){1,2})'. // 1(.23)?(,4(.56)){1,2}
1006 '(?:\;(?:['.$geouri_labeltext_regex.']+)(?:\=['.$geouri_paramchar_regex.']+)*)*'.
1009 // URLs without domain name, like magnet:?xt=...
1010 '|(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_NO_DOMAIN)) . '):(?=\?))'. // zero-length lookahead requires ? after :
1011 (common_config('linkify', 'bare_ipv4') // Convert IPv4 addresses to hyperlinks
1012 ? '|(?:(?: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]?)'
1014 (common_config('linkify', 'bare_ipv6') // Convert IPv6 addresses to hyperlinks
1016 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
1019 (common_config('linkify', 'bare_domains')
1021 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
1022 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
1023 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
1024 '(?: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)'.
1026 : '') . // if common_config('linkify', 'bare_domains') is false, don't add anything here
1029 '(?:\:\d+)?'. //:port
1030 '(?:/[' . URL_REGEX_VALID_PATH_CHARS . ']*)?'. // path
1031 '(?:\?[' . URL_REGEX_VALID_QSTRING_CHARS . ']*)?'. // ?query string
1032 '(?:\#[' . URL_REGEX_VALID_FRAGMENT_CHARS . ']*)?'. // #fragment
1033 ')(?<!['. URL_REGEX_EXCLUDED_END_CHARS .'])'.
1036 //preg_match_all($regex,$text,$matches);
1037 //print_r($matches);
1038 return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
1042 * Intermediate callback for common_replace_links(), helps resolve some
1043 * ambiguous link forms before passing on to the final callback.
1045 * @param array $matches
1046 * @param callable $callback
1047 * @param mixed $arg optional argument to pass on as second param to callback
1052 function callback_helper($matches, $callback, $arg=null) {
1054 $left = strpos($matches[0],$url);
1055 $right = $left+strlen($url);
1057 $groupSymbolSets=array(
1075 $cannotEndWith=array('.','?',',','#');
1079 foreach($groupSymbolSets as $groupSymbolSet){
1080 if(substr($url,-1)==$groupSymbolSet['right']){
1081 $group_left_count = substr_count($url,$groupSymbolSet['left']);
1082 $group_right_count = substr_count($url,$groupSymbolSet['right']);
1083 if($group_left_count<$group_right_count){
1085 $url=substr($url,0,-1);
1089 if(in_array(substr($url,-1),$cannotEndWith)){
1091 $url=substr($url,0,-1);
1093 }while($original_url!=$url);
1095 $result = call_user_func_array($callback, array($url, $arg));
1096 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
1099 require_once INSTALLDIR . "/lib/curry.php";
1101 function common_linkify($url) {
1102 // It comes in special'd, so we unspecial it before passing to the stringifying
1104 $url = htmlspecialchars_decode($url);
1106 if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
1107 //url is an email address without the mailto: protocol
1108 $canon = "mailto:$url";
1109 $longurl = "mailto:$url";
1111 $canon = File_redirection::_canonUrl($url);
1112 $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
1114 if(isset($longurl_data->redir_url)) {
1115 $longurl = $longurl_data->redir_url;
1118 $longurl = $longurl_data->url;
1122 $attrs = array('href' => $longurl, 'title' => $longurl);
1124 $is_attachment = false;
1125 $attachment_id = null;
1128 // Check to see whether this is a known "attachment" URL.
1131 $f = File::getByUrl($longurl);
1132 } catch (NoResultException $e) {
1133 if (common_config('attachments', 'process_links')) {
1134 // XXX: this writes to the database. :<
1136 $f = File::processNew($longurl);
1137 } catch (ServerException $e) {
1143 if ($f instanceof File) {
1145 $enclosure = $f->getEnclosure();
1146 $is_attachment = true;
1147 $attachment_id = $f->id;
1149 $thumb = File_thumbnail::getKV('file_id', $f->id);
1150 $has_thumb = ($thumb instanceof File_thumbnail);
1151 } catch (ServerException $e) {
1152 // There was not enough metadata available
1156 // Whether to nofollow
1157 $nf = common_config('nofollow', 'external');
1159 if ($nf == 'never') {
1160 $attrs['rel'] = 'external';
1162 $attrs['rel'] = 'nofollow external';
1166 if ($is_attachment) {
1167 $attrs['class'] = 'attachment';
1169 $attrs['class'] = 'attachment thumbnail';
1171 $attrs['id'] = "attachment-{$attachment_id}";
1172 $attrs['rel'] .= ' noreferrer';
1175 return XMLStringer::estring('a', $attrs, $url);
1179 * Find and shorten links in a given chunk of text if it's longer than the
1180 * configured notice content limit (or unconditionally).
1182 * Side effects: may save file and file_redirection records for referenced URLs.
1184 * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1185 * user's options are used; otherwise the current web session user's setitngs
1186 * will be used or ur1.ca if there is no active web login.
1188 * @param string $text
1189 * @param boolean $always (optional)
1190 * @param User $user (optional)
1194 function common_shorten_links($text, $always = false, User $user=null)
1196 if ($user === null) {
1197 $user = common_current_user();
1200 $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1202 if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1203 return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1205 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1210 * Very basic stripping of invalid UTF-8 input text.
1212 * @param string $str
1213 * @return mixed string or null if invalid input
1215 * @todo ideally we should drop bad chars, and maybe do some of the checks
1216 * from common_xml_safe_str. But we can't strip newlines, etc.
1217 * @todo Unicode normalization might also be useful, but not needed now.
1219 function common_validate_utf8($str)
1221 // preg_replace will return NULL on invalid UTF-8 input.
1223 // Note: empty regex //u also caused NULL return on some
1224 // production machines, but none of our test machines.
1226 // This should be replaced with a more reliable check.
1227 return preg_replace('/\x00/u', '', $str);
1231 * Make sure an arbitrary string is safe for output in XML as a single line.
1233 * @param string $str
1236 function common_xml_safe_str($str)
1238 // Replace common eol and extra whitespace input chars
1243 "\0", // null byte eos
1244 "\x0B" // vertical tab
1247 $replacement = array(
1248 ' ', // single space
1255 $str = str_replace($unWelcome, $replacement, $str);
1257 // Neutralize any additional control codes and UTF-16 surrogates
1258 // (Twitter uses '*')
1259 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1262 function common_slugify($str)
1264 // php5-intl is highly recommended...
1265 if (!function_exists('transliterator_transliterate')) {
1266 $str = preg_replace('/[^\pL\pN]/u', '', $str);
1267 $str = mb_convert_case($str, MB_CASE_LOWER, 'UTF-8');
1268 $str = substr($str, 0, 64);
1271 $str = transliterator_transliterate(
1272 'Any-Latin;' . // any charset to latin compatible
1273 'NFD;' . // decompose
1274 '[:Nonspacing Mark:] Remove;' . // remove nonspacing marks (accents etc.)
1275 'NFC;' . // composite again
1276 '[:Punctuation:] Remove;' . // remove punctuation (.,¿? etc.)
1277 'Lower();' . // turn into lowercase
1278 'Latin-ASCII;', // get ASCII equivalents (ð to d for example)
1280 return preg_replace('/[^\pL\pN]/', '', $str);
1283 function common_tag_link($tag)
1285 $canonical = common_canonical_tag($tag);
1286 if (common_config('singleuser', 'enabled')) {
1287 // regular TagAction isn't set up in 1user mode
1288 $nickname = User::singleUserNickname();
1289 $url = common_local_url('showstream',
1290 array('nickname' => $nickname,
1291 'tag' => $canonical));
1293 $url = common_local_url('tag', array('tag' => $canonical));
1295 $xs = new XMLStringer();
1296 $xs->elementStart('span', 'tag');
1297 $xs->element('a', array('href' => $url,
1300 $xs->elementEnd('span');
1301 return $xs->getString();
1304 function common_canonical_tag($tag)
1306 $tag = common_slugify($tag);
1307 $tag = substr($tag, 0, 64);
1311 function common_valid_profile_tag($str)
1313 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1317 * Resolve an ambiguous profile nickname reference, checking in following order:
1318 * - profiles that $sender subscribes to
1319 * - profiles that subscribe to $sender
1320 * - local user profiles
1322 * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1323 * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1326 * @fixme validate input
1328 * @fixme fix or remove mystery third parameter
1329 * @fixme is $sender a User or Profile?
1331 * @param <type> $sender the user or profile in whose context we're looking
1332 * @param string $nickname validated nickname of
1333 * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1335 * @return Profile or null
1337 function common_relative_profile($sender, $nickname, $dt=null)
1339 // Will throw exception on invalid input.
1340 $nickname = Nickname::normalize($nickname);
1342 // Try to find profiles this profile is subscribed to that have this nickname
1343 $recipient = new Profile();
1344 // XXX: use a join instead of a subquery
1345 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1346 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1347 if ($recipient->find(true)) {
1348 // XXX: should probably differentiate between profiles with
1349 // the same name by date of most recent update
1352 // Try to find profiles that listen to this profile and that have this nickname
1353 $recipient = new Profile();
1354 // XXX: use a join instead of a subquery
1355 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1356 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1357 if ($recipient->find(true)) {
1358 // XXX: should probably differentiate between profiles with
1359 // the same name by date of most recent update
1362 // If this is a local user, try to find a local user with that nickname.
1363 $sender = User::getKV('id', $sender->id);
1364 if ($sender instanceof User) {
1365 $recipient_user = User::getKV('nickname', $nickname);
1366 if ($recipient_user instanceof User) {
1367 return $recipient_user->getProfile();
1370 // Otherwise, no links. @messages from local users to remote users,
1371 // or from remote users to other remote users, are just
1372 // outside our ability to make intelligent guesses about
1376 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1378 if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1380 $path = $r->build($action, $args, $params, $fragment);
1382 $ssl = GNUsocial::useHTTPS();
1384 if (common_config('site','fancy')) {
1385 $url = common_path($path, $ssl, $addSession);
1387 if (mb_strpos($path, '/index.php') === 0) {
1388 $url = common_path($path, $ssl, $addSession);
1390 $url = common_path('index.php/'.$path, $ssl, $addSession);
1393 Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1398 function common_path($relative, $ssl=false, $addSession=true)
1400 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1402 if ($ssl && GNUsocial::useHTTPS()) {
1404 if (is_string(common_config('site', 'sslserver')) &&
1405 mb_strlen(common_config('site', 'sslserver')) > 0) {
1406 $serverpart = common_config('site', 'sslserver');
1407 } else if (common_config('site', 'server')) {
1408 $serverpart = common_config('site', 'server');
1410 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1414 if (common_config('site', 'server')) {
1415 $serverpart = common_config('site', 'server');
1417 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1422 $relative = common_inject_session($relative, $serverpart);
1425 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1428 // FIXME: Maybe this should also be able to handle non-fancy URLs with index.php?p=...
1429 function common_fake_local_fancy_url($url)
1432 * This is a hacky fix to make URIs generated with "index.php/" match against
1433 * locally stored URIs without that. So for example if the remote site is looking
1434 * up the webfinger for some user and for some reason knows about https://some.example/user/1
1435 * but we locally store and report only https://some.example/index.php/user/1 then they would
1436 * dismiss the profile for not having an identified alias.
1438 * There are various live instances where these issues occur, for various reasons.
1439 * Most of them being users fiddling with configuration while already having
1440 * started federating (distributing the URI to other servers) or maybe manually
1441 * editing the local database.
1444 // [1] protocol part, we can only rewrite http/https anyway.
1447 // FIXME: Dunno how this acts if we're aliasing ourselves with a .onion domain etc.
1448 '('.preg_quote(common_config('site', 'server'), '/').')' .
1449 // [3] site path, or if that is empty just '/' (to retain the /)
1450 '('.preg_quote(common_config('site', 'path') ?: '/', '/').')' .
1451 // [4] + [5] extract index.php (+ possible leading double /) and the rest of the URL separately.
1452 '(\/?index\.php\/)(.*)$/', $url, $matches)) {
1453 // if preg_match failed to match
1454 throw new Exception('No known change could be made to the URL.');
1457 // now reconstruct the URL with everything except the "index.php/" part
1459 foreach ([1,2,3,5] as $idx) {
1460 $fancy_url .= $matches[$idx];
1465 // FIXME: Maybe this should also be able to handle non-fancy URLs with index.php?p=...
1466 function common_fake_local_nonfancy_url($url)
1469 * This is a hacky fix to make URIs NOT generated with "index.php/" match against
1470 * locally stored URIs WITH that. The reverse from the above.
1472 * It will also "repair" index.php URLs with multiple / prepended. Like https://some.example///index.php/user/1
1475 // [1] protocol part, we can only rewrite http/https anyway.
1478 // FIXME: Dunno how this acts if we're aliasing ourselves with a .onion domain etc.
1479 '('.preg_quote(common_config('site', 'server'), '/').')' .
1480 // [3] site path, or if that is empty just '/' (to retain the /)
1481 '('.preg_quote(common_config('site', 'path') ?: '/', '/').')' .
1482 // [4] should be empty (might contain one or more / and then maybe also index.php). Will be overwritten.
1483 // [5] will have the extracted actual URL part (besides site path)
1484 '((?!index.php\/)\/*(?:index.php\/)?)(.*)$/', $url, $matches)) {
1485 // if preg_match failed to match
1486 throw new Exception('No known change could be made to the URL.');
1489 $matches[4] = 'index.php/'; // inject the index.php/ rewritethingy
1491 // remove the first element, which is the full matching string
1492 array_shift($matches);
1493 return implode($matches);
1496 function common_inject_session($url, $serverpart = null)
1498 if (!common_have_session()) {
1502 if (empty($serverpart)) {
1503 $serverpart = parse_url($url, PHP_URL_HOST);
1506 $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1508 // Are we pointing to another server (like an SSL server?)
1510 if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1511 // Pass the session ID as a GET parameter
1512 $sesspart = session_name() . '=' . session_id();
1513 $i = strpos($url, '?');
1514 if ($i === false) { // no GET params, just append
1515 $url .= '?' . $sesspart;
1517 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1524 function common_date_string($dt)
1526 // XXX: do some sexy date formatting
1527 // return date(DATE_RFC822, $dt);
1528 $t = strtotime($dt);
1532 if ($now < $t) { // that shouldn't happen!
1533 return common_exact_date($dt);
1534 } else if ($diff < 60) {
1535 // TRANS: Used in notices to indicate when the notice was made compared to now.
1536 return _('a few seconds ago');
1537 } else if ($diff < 92) {
1538 // TRANS: Used in notices to indicate when the notice was made compared to now.
1539 return _('about a minute ago');
1540 } else if ($diff < 3300) {
1541 $minutes = round($diff/60);
1542 // TRANS: Used in notices to indicate when the notice was made compared to now.
1543 return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1544 } else if ($diff < 5400) {
1545 // TRANS: Used in notices to indicate when the notice was made compared to now.
1546 return _('about an hour ago');
1547 } else if ($diff < 22 * 3600) {
1548 $hours = round($diff/3600);
1549 // TRANS: Used in notices to indicate when the notice was made compared to now.
1550 return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1551 } else if ($diff < 37 * 3600) {
1552 // TRANS: Used in notices to indicate when the notice was made compared to now.
1553 return _('about a day ago');
1554 } else if ($diff < 24 * 24 * 3600) {
1555 $days = round($diff/(24*3600));
1556 // TRANS: Used in notices to indicate when the notice was made compared to now.
1557 return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1558 } else if ($diff < 46 * 24 * 3600) {
1559 // TRANS: Used in notices to indicate when the notice was made compared to now.
1560 return _('about a month ago');
1561 } else if ($diff < 330 * 24 * 3600) {
1562 $months = round($diff/(30*24*3600));
1563 // TRANS: Used in notices to indicate when the notice was made compared to now.
1564 return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1565 } else if ($diff < 480 * 24 * 3600) {
1566 // TRANS: Used in notices to indicate when the notice was made compared to now.
1567 return _('about a year ago');
1569 return common_exact_date($dt);
1573 function common_exact_date($dt)
1579 $_utc = new DateTimeZone('UTC');
1580 $_siteTz = new DateTimeZone(common_timezone());
1583 $dateStr = date('d F Y H:i:s', strtotime($dt));
1584 $d = new DateTime($dateStr, $_utc);
1585 $d->setTimezone($_siteTz);
1586 // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
1587 return $d->format(_('l, d-M-Y H:i:s T'));
1590 function common_date_w3dtf($dt)
1592 $dateStr = date('d F Y H:i:s', strtotime($dt));
1593 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1594 $d->setTimezone(new DateTimeZone(common_timezone()));
1595 return $d->format(DATE_W3C);
1598 function common_date_rfc2822($dt)
1600 $dateStr = date('d F Y H:i:s', strtotime($dt));
1601 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1602 $d->setTimezone(new DateTimeZone(common_timezone()));
1603 return $d->format('r');
1606 function common_date_iso8601($dt)
1608 $dateStr = date('d F Y H:i:s', strtotime($dt));
1609 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1610 $d->setTimezone(new DateTimeZone(common_timezone()));
1611 return $d->format('c');
1614 function common_sql_now()
1616 return common_sql_date(time());
1619 function common_sql_date($datetime)
1621 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1625 * Return an SQL fragment to calculate an age-based weight from a given
1626 * timestamp or datetime column.
1628 * @param string $column name of field we're comparing against current time
1629 * @param integer $dropoff divisor for age in seconds before exponentiation
1630 * @return string SQL fragment
1632 function common_sql_weight($column, $dropoff)
1634 if (common_config('db', 'type') == 'pgsql') {
1635 // PostgreSQL doesn't support timestampdiff function.
1636 // @fixme will this use the right time zone?
1637 // @fixme does this handle cross-year subtraction correctly?
1638 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1640 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1644 function common_redirect($url, $code=307)
1646 static $status = array(301 => "Moved Permanently",
1649 307 => "Temporary Redirect");
1651 header('HTTP/1.1 '.$code.' '.$status[$code]);
1652 header("Location: $url");
1653 header("Connection: close");
1655 $xo = new XMLOutputter();
1657 '-//W3C//DTD XHTML 1.0 Strict//EN',
1658 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1659 $xo->element('a', array('href' => $url), $url);
1664 // Stick the notice on the queue
1666 function common_enqueue_notice($notice)
1668 static $localTransports = array('ping');
1670 $transports = array();
1671 if (common_config('sms', 'enabled')) {
1672 $transports[] = 'sms';
1674 if (Event::hasHandler('HandleQueuedNotice')) {
1675 $transports[] = 'plugin';
1678 // We can skip these for gatewayed notices.
1679 if ($notice->isLocal()) {
1680 $transports = array_merge($transports, $localTransports);
1683 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1685 $qm = QueueManager::get();
1687 foreach ($transports as $transport)
1689 $qm->enqueue($notice, $transport);
1692 Event::handle('EndEnqueueNotice', array($notice, $transports));
1698 function common_profile_url($nickname)
1700 return common_local_url('showstream', array('nickname' => $nickname),
1705 * Should make up a reasonable root URL
1707 * @param bool $tls true or false to force TLS scheme, null to use server configuration
1709 function common_root_url($tls=null)
1711 if (is_null($tls)) {
1712 $tls = GNUsocial::useHTTPS();
1714 $url = common_path('', $tls, false);
1715 $i = strpos($url, '?');
1717 $url = substr($url, 0, $i);
1723 * returns $bytes bytes of raw random data
1725 function common_random_rawstr($bytes)
1727 $rawstr = @file_exists('/dev/urandom')
1728 ? common_urandom($bytes)
1729 : common_mtrand($bytes);
1735 * returns $bytes bytes of random data as a hexadecimal string
1737 function common_random_hexstr($bytes)
1739 $str = common_random_rawstr($bytes);
1742 for ($i = 0; $i < $bytes; $i++) {
1743 $hexstr .= sprintf("%02x", ord($str[$i]));
1748 function common_urandom($bytes)
1750 $h = fopen('/dev/urandom', 'rb');
1752 $src = fread($h, $bytes);
1757 function common_mtrand($bytes)
1760 for ($i = 0; $i < $bytes; $i++) {
1761 $str .= chr(mt_rand(0, 255));
1767 * Record the given URL as the return destination for a future
1768 * form submission, to be read by common_get_returnto().
1770 * @param string $url
1772 * @fixme as a session-global setting, this can allow multiple forms
1773 * to conflict and overwrite each others' returnto destinations if
1774 * the user has multiple tabs or windows open.
1776 * Should refactor to index with a token or otherwise only pass the
1777 * data along its intended path.
1779 function common_set_returnto($url)
1781 common_ensure_session();
1782 $_SESSION['returnto'] = $url;
1786 * Fetch a return-destination URL previously recorded by
1787 * common_set_returnto().
1789 * @return mixed URL string or null
1791 * @fixme as a session-global setting, this can allow multiple forms
1792 * to conflict and overwrite each others' returnto destinations if
1793 * the user has multiple tabs or windows open.
1795 * Should refactor to index with a token or otherwise only pass the
1796 * data along its intended path.
1798 function common_get_returnto()
1800 common_ensure_session();
1801 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1804 function common_timestamp()
1806 return date('YmdHis');
1809 function common_ensure_syslog()
1811 static $initialized = false;
1812 if (!$initialized) {
1813 openlog(common_config('syslog', 'appname'), 0,
1814 common_config('syslog', 'facility'));
1815 $initialized = true;
1819 function common_log_line($priority, $msg)
1821 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1822 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1823 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1826 function common_request_id()
1829 $server = common_config('site', 'server');
1830 if (php_sapi_name() == 'cli') {
1831 $script = basename($_SERVER['PHP_SELF']);
1832 return "$server:$script:$pid";
1834 static $req_id = null;
1835 if (!isset($req_id)) {
1836 $req_id = substr(md5(mt_rand()), 0, 8);
1838 if (isset($_SERVER['REQUEST_URI'])) {
1839 $url = $_SERVER['REQUEST_URI'];
1841 $method = $_SERVER['REQUEST_METHOD'];
1842 return "$server:$pid.$req_id $method $url";
1846 function common_log($priority, $msg, $filename=null)
1848 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1849 $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1850 $msg = '[' . common_request_id() . '] ' . $msg;
1851 $logfile = common_config('site', 'logfile');
1853 $log = fopen($logfile, "a");
1855 $output = common_log_line($priority, $msg);
1856 fwrite($log, $output);
1860 common_ensure_syslog();
1861 syslog($priority, $msg);
1863 Event::handle('EndLog', array($priority, $msg, $filename));
1867 function common_debug($msg, $filename=null)
1870 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1872 common_log(LOG_DEBUG, $msg);
1876 function common_log_db_error(&$object, $verb, $filename=null)
1880 $objstr = common_log_objstring($object);
1881 $last_error = &$_PEAR->getStaticProperty('DB_DataObject','lastError');
1882 if (is_object($last_error)) {
1883 $msg = $last_error->message;
1885 $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1887 common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1890 function common_log_objstring(&$object)
1892 if (is_null($object)) {
1895 if (!($object instanceof DB_DataObject)) {
1898 $arr = $object->toArray();
1900 foreach ($arr as $k => $v) {
1901 if (is_object($v)) {
1902 $fields[] = "$k='".get_class($v)."'";
1904 $fields[] = "$k='$v'";
1907 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1911 function common_valid_http_url($url, $secure=false)
1917 // If $secure is true, only allow https URLs to pass
1918 // (if false, we use '?' in 'https?' to say the 's' is optional)
1919 $regex = $secure ? '/^https$/' : '/^https?$/';
1920 return filter_var($url, FILTER_VALIDATE_URL)
1921 && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1924 function common_valid_tag($tag)
1926 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1927 return (Validate::email($matches[1]) ||
1928 preg_match('/^([\w-\.]+)$/', $matches[1]));
1934 * Determine if given domain or address literal is valid
1935 * eg for use in JIDs and URLs. Does not check if the domain
1938 * @param string $domain
1939 * @return boolean valid or not
1941 function common_valid_domain($domain)
1943 $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1944 $ipv4 = "(?:$octet(?:\.$octet){3})";
1945 if (preg_match("/^$ipv4$/u", $domain)) return true;
1947 $group = "(?:[0-9a-f]{1,4})";
1948 $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1950 if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1951 $before = explode(":", $matches[1]);
1952 $zeroes = $matches[2];
1953 $after = explode(":", $matches[3]);
1961 $explicit = count($before) + count($after);
1962 if ($explicit < $min || $explicit > $max) {
1969 require_once "Net/IDNA.php";
1970 $idn = Net_IDNA::getInstance();
1971 $domain = $idn->encode($domain);
1972 } catch (Exception $e) {
1976 $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1977 $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1979 return preg_match("/^$fqdn$/ui", $domain);
1982 /* Following functions are copied from MediaWiki GlobalFunctions.php
1983 * and written by Evan Prodromou. */
1985 function common_accept_to_prefs($accept, $def = '*/*')
1987 // No arg means accept anything (per HTTP spec)
1989 return array($def => 1);
1994 $parts = explode(',', $accept);
1996 foreach($parts as $part) {
1997 // FIXME: doesn't deal with params like 'text/html; level=1'
1998 @list($value, $qpart) = explode(';', trim($part));
2000 if(!isset($qpart)) {
2002 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
2003 $prefs[$value] = $match[1];
2010 // Match by our supported file extensions
2011 function common_supported_filename_to_mime($filename)
2013 // Accept a filename and take out the extension
2014 if (strpos($filename, '.') === false) {
2015 throw new ServerException(sprintf('No extension on filename: %1$s', _ve($filename)));
2018 $fileext = substr(strrchr($filename, '.'), 1);
2019 return common_supported_ext_to_mime($fileext);
2022 function common_supported_ext_to_mime($fileext)
2024 $supported = common_config('attachments', 'supported');
2025 if ($supported === true) {
2026 // FIXME: Should we just accept the extension straight off when supported === true?
2027 throw new UnknownExtensionMimeException($fileext);
2029 foreach($supported as $type => $ext) {
2030 if ($ext === $fileext) {
2035 throw new ServerException('Unsupported file extension');
2038 // Match by our supported mime types
2039 function common_supported_mime_to_ext($mimetype)
2041 $supported = common_config('attachments', 'supported');
2042 if (is_array($supported)) {
2043 foreach($supported as $type => $ext) {
2044 if ($mimetype === $type) {
2050 throw new UnknownMimeExtensionException($mimetype);
2053 // The MIME "media" is the part before the slash (video in video/webm)
2054 function common_get_mime_media($type)
2056 $tmp = explode('/', $type);
2057 return strtolower($tmp[0]);
2060 // Get only the mimetype and not additional info (separated from bare mime with semi-colon)
2061 function common_bare_mime($mimetype)
2063 $mimetype = mb_strtolower($mimetype);
2064 if ($semicolon = mb_strpos($mimetype, ';')) {
2065 $mimetype = mb_substr($mimetype, 0, $semicolon);
2067 return trim($mimetype);
2070 function common_mime_type_match($type, $avail)
2072 if(array_key_exists($type, $avail)) {
2075 $parts = explode('/', $type);
2076 if(array_key_exists($parts[0] . '/*', $avail)) {
2077 return $parts[0] . '/*';
2078 } elseif(array_key_exists('*/*', $avail)) {
2086 function common_negotiate_type($cprefs, $sprefs)
2090 foreach(array_keys($sprefs) as $type) {
2091 $parts = explode('/', $type);
2092 if($parts[1] != '*') {
2093 $ckey = common_mime_type_match($type, $cprefs);
2095 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
2100 foreach(array_keys($cprefs) as $type) {
2101 $parts = explode('/', $type);
2102 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
2103 $skey = common_mime_type_match($type, $sprefs);
2105 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2111 $besttype = 'text/html';
2113 foreach(array_keys($combine) as $type) {
2114 if($combine[$type] > $bestq) {
2116 $bestq = $combine[$type];
2120 if ('text/html' === $besttype) {
2121 return "text/html; charset=utf-8";
2126 function common_config($main, $sub=null)
2129 if (is_null($sub)) {
2130 // Return the config category array
2131 return array_key_exists($main, $config) ? $config[$main] : array();
2133 // Return the config value
2134 return (array_key_exists($main, $config) &&
2135 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
2138 function common_config_set($main, $sub, $value)
2141 if (!array_key_exists($main, $config)) {
2142 $config[$main] = array();
2144 $config[$main][$sub] = $value;
2147 function common_config_append($main, $sub, $value)
2150 if (!array_key_exists($main, $config)) {
2151 $config[$main] = array();
2153 if (!array_key_exists($sub, $config[$main])) {
2154 $config[$main][$sub] = array();
2156 if (!is_array($config[$main][$sub])) {
2157 $config[$main][$sub] = array($config[$main][$sub]);
2159 array_push($config[$main][$sub], $value);
2163 * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
2164 * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
2166 * @param array $from
2169 function common_copy_args($from)
2172 $strip = get_magic_quotes_gpc();
2173 foreach ($from as $k => $v) {
2175 $to[$k] = common_copy_args($v);
2178 $v = stripslashes($v);
2180 $to[$k] = strval(common_validate_utf8($v));
2187 * Neutralise the evil effects of magic_quotes_gpc in the current request.
2188 * This is used before handing a request off to OAuthRequest::from_request.
2189 * @fixme Doesn't consider vars other than _POST and _GET?
2190 * @fixme Can't be undone and could corrupt data if run twice.
2192 function common_remove_magic_from_request()
2194 if(get_magic_quotes_gpc()) {
2195 $_POST=array_map('stripslashes',$_POST);
2196 $_GET=array_map('stripslashes',$_GET);
2200 function common_user_uri(&$user)
2202 return common_local_url('userbyid', array('id' => $user->id),
2206 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2208 function common_confirmation_code($bits)
2210 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2211 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
2212 $chars = ceil($bits/5);
2214 for ($i = 0; $i < $chars; $i++) {
2215 // XXX: convert to string and back
2216 $num = hexdec(common_random_hexstr(1));
2217 // XXX: randomness is too precious to throw away almost
2218 // 40% of the bits we get!
2219 $code .= $codechars[$num%32];
2224 // convert markup to HTML
2225 function common_markup_to_html($c, $args=null)
2231 if (is_null($args)) {
2235 // XXX: not very efficient
2237 foreach ($args as $name => $value) {
2238 $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
2241 $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
2242 $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
2243 $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
2244 $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
2246 return \Michelf\Markdown::defaultTransform($c);
2249 function common_user_property($property)
2251 $profile = Profile::current();
2253 if (empty($profile)) {
2257 switch ($property) {
2263 return $profile->$property;
2267 return $profile->getAvatar(AVATAR_STREAM_SIZE);
2268 } catch (Exception $e) {
2273 return $profile->getBestName();
2280 function common_profile_uri($profile)
2284 if (!empty($profile)) {
2285 if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2286 $user = User::getKV('id', $profile->id);
2287 if ($user instanceof User) {
2288 $uri = $user->getUri();
2290 Event::handle('EndCommonProfileURI', array($profile, &$uri));
2294 // XXX: this is a very bad profile!
2298 function common_canonical_sms($sms)
2301 preg_replace('/\D/', '', $sms);
2305 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2310 case E_COMPILE_ERROR:
2314 case E_RECOVERABLE_ERROR:
2315 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2320 case E_COMPILE_WARNING:
2321 case E_CORE_WARNING:
2322 case E_USER_WARNING:
2323 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2328 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2333 case E_USER_DEPRECATED:
2334 // XXX: config variable to log this stuff, too
2338 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2343 // FIXME: show error page if we're on the Web
2344 /* Don't execute PHP internal error handler */
2348 function common_session_token()
2350 common_ensure_session();
2351 if (!array_key_exists('token', $_SESSION)) {
2352 $_SESSION['token'] = common_random_hexstr(64);
2354 return $_SESSION['token'];
2357 function common_license_terms($uri)
2359 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2360 return explode('-',$matches[1]);
2365 function common_compatible_license($from, $to)
2367 $from_terms = common_license_terms($from);
2368 // public domain and cc-by are compatible with everything
2369 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2372 $to_terms = common_license_terms($to);
2373 // sa is compatible across versions. IANAL
2374 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2375 return count(array_diff($from_terms, $to_terms)) == 0;
2377 // XXX: better compatibility check needed here!
2378 // Should at least normalise URIs
2379 return ($from == $to);
2383 * returns a quoted table name, if required according to config
2385 function common_database_tablename($tablename)
2387 if(common_config('db','quote_identifiers')) {
2388 $tablename = '"'. $tablename .'"';
2390 //table prefixes could be added here later
2395 * Shorten a URL with the current user's configured shortening service,
2396 * or ur1.ca if configured, or not at all if no shortening is set up.
2398 * @param string $long_url original URL
2399 * @param User $user to specify a particular user's options
2400 * @param boolean $force Force shortening (used when notice is too long)
2401 * @return string may return the original URL if shortening failed
2403 * @fixme provide a way to specify a particular shortener
2405 function common_shorten_url($long_url, User $user=null, $force = false)
2407 $long_url = trim($long_url);
2409 $user = common_current_user();
2411 $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2413 // $force forces shortening even if it's not strictly needed
2414 // I doubt URL shortening is ever 'strictly' needed. - ESP
2416 if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2420 $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2422 if (Event::handle('StartShortenUrl',
2423 array($long_url, $shortenerName, &$shortenedUrl))) {
2424 if ($shortenerName == 'internal') {
2426 $f = File::processNew($long_url);
2427 $shortenedUrl = common_local_url('redirecturl', array('id' => $f->id));
2428 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2429 return $shortenedUrl;
2433 } catch (ServerException $e) {
2440 //URL was shortened, so return the result
2441 return trim($shortenedUrl);
2446 * @return mixed array($proxy, $ip) for web requests; proxy may be null
2447 * null if not a web request
2449 * @fixme X-Forwarded-For can be chained by multiple proxies;
2450 we should parse the list and provide a cleaner array
2451 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2452 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2453 * use function to get exact request headers from Apache if possible.
2455 function common_client_ip()
2457 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2461 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2462 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2463 $proxy = $_SERVER['HTTP_CLIENT_IP'];
2465 $proxy = $_SERVER['REMOTE_ADDR'];
2467 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2470 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2471 $ip = $_SERVER['HTTP_CLIENT_IP'];
2473 $ip = $_SERVER['REMOTE_ADDR'];
2477 return array($proxy, $ip);
2480 function common_url_to_nickname($url)
2482 static $bad = array('query', 'user', 'password', 'port', 'fragment');
2484 $parts = parse_url($url);
2486 // If any of these parts exist, this won't work
2488 foreach ($bad as $badpart) {
2489 if (array_key_exists($badpart, $parts)) {
2494 // We just have host and/or path
2496 // If it's just a host...
2497 if (array_key_exists('host', $parts) &&
2498 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2500 $hostparts = explode('.', $parts['host']);
2502 // Try to catch common idiom of nickname.service.tld
2504 if ((count($hostparts) > 2) &&
2505 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2506 (strcmp($hostparts[0], 'www') != 0))
2508 return common_nicknamize($hostparts[0]);
2510 // Do the whole hostname
2511 return common_nicknamize($parts['host']);
2514 if (array_key_exists('path', $parts)) {
2515 // Strip starting, ending slashes
2516 $path = preg_replace('@/$@', '', $parts['path']);
2517 $path = preg_replace('@^/@', '', $path);
2518 $path = basename($path);
2520 // Hack for MediaWiki user pages, in the form:
2521 // http://example.com/wiki/User:Myname
2522 // ('User' may be localized.)
2523 if (strpos($path, ':')) {
2524 $parts = array_filter(explode(':', $path));
2525 $path = $parts[count($parts) - 1];
2529 return common_nicknamize($path);
2537 function common_nicknamize($str)
2540 return Nickname::normalize($str);
2541 } catch (NicknameException $e) {
2546 function common_perf_counter($key, $val=null)
2548 global $_perfCounters;
2549 if (isset($_perfCounters)) {
2550 if (common_config('site', 'logperf')) {
2551 if (array_key_exists($key, $_perfCounters)) {
2552 $_perfCounters[$key][] = $val;
2554 $_perfCounters[$key] = array($val);
2556 if (common_config('site', 'logperf_detail')) {
2557 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2563 function common_log_perf_counters()
2565 if (common_config('site', 'logperf')) {
2566 global $_startTime, $_perfCounters;
2568 if (isset($_startTime)) {
2569 $endTime = microtime(true);
2570 $diff = round(($endTime - $_startTime) * 1000);
2571 common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2573 $counters = $_perfCounters;
2575 foreach ($counters as $key => $values) {
2576 $count = count($values);
2577 $unique = count(array_unique($values));
2578 common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2583 function common_is_email($str)
2585 return (strpos($str, '@') !== false);
2588 function common_init_stats()
2592 $_mem = memory_get_usage(true);
2593 $_ts = microtime(true);
2596 function common_log_delta($comment=null)
2603 $_mem = memory_get_usage(true);
2604 $_ts = microtime(true);
2606 $mtotal = $_mem - $mold;
2607 $ttotal = $_ts - $told;
2609 if (empty($comment)) {
2613 common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
2616 function common_strip_html($html, $trim=true, $save_whitespace=false)
2618 // first replace <br /> with \n
2619 $html = preg_replace('/\<(\s*)?br(\s*)?\/?(\s*)?\>/i', "\n", $html);
2620 // then, unless explicitly avoided, remove excessive whitespace
2621 if (!$save_whitespace) {
2622 $html = preg_replace('/\s+/', ' ', $html);
2624 $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
2625 return $trim ? trim($text) : $text;
2628 function html_sprintf()
2630 $args = func_get_args();
2631 for ($i=1; $i<count($args); $i++) {
2632 $args[$i] = htmlspecialchars($args[$i]);
2634 return call_user_func_array('sprintf', $args);
2639 return var_export($var, true);