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_have_session()
269 return (0 != strcmp(session_id(), ''));
272 function common_ensure_session()
275 if (array_key_exists(session_name(), $_COOKIE)) {
276 $c = $_COOKIE[session_name()];
278 if (!common_have_session()) {
279 if (common_config('sessions', 'handle')) {
280 Session::setSaveHandler();
282 if (array_key_exists(session_name(), $_GET)) {
283 $id = $_GET[session_name()];
284 } else if (array_key_exists(session_name(), $_COOKIE)) {
285 $id = $_COOKIE[session_name()];
291 if (!isset($_SESSION['started'])) {
292 $_SESSION['started'] = time();
294 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
295 ' is set but started value is null');
301 // Three kinds of arguments:
306 // Initialize to false; set to null if none found
309 function common_set_user($user)
313 if (is_null($user) && common_have_session()) {
315 unset($_SESSION['userid']);
317 } else if (is_string($user)) {
319 $user = User::getKV('nickname', $nickname);
320 } else if (!$user instanceof User) {
325 if (Event::handle('StartSetUser', array(&$user))) {
327 if (!$user->hasRight(Right::WEBLOGIN)) {
328 // TRANS: Authorisation exception thrown when a user a not allowed to login.
329 throw new AuthorizationException(_('Not allowed to log in.'));
331 common_ensure_session();
332 $_SESSION['userid'] = $user->id;
334 Event::handle('EndSetUser', array($user));
342 function common_set_cookie($key, $value, $expiration=0)
344 $path = common_config('site', 'path');
345 $server = common_config('site', 'server');
347 if ($path && ($path != '/')) {
348 $cookiepath = '/' . $path . '/';
352 return setcookie($key,
357 common_config('site', 'ssl')=='always');
360 define('REMEMBERME', 'rememberme');
361 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
363 function common_rememberme($user=null)
366 $user = common_current_user();
372 $rm = new Remember_me();
374 $rm->code = common_random_hexstr(16);
375 $rm->user_id = $user->id;
377 // Wrap the insert in some good ol' fashioned transaction code
381 $result = $rm->insert();
384 common_log_db_error($rm, 'INSERT', __FILE__);
385 $rm->query('ROLLBACK');
389 $rm->query('COMMIT');
391 $cookieval = $rm->user_id . ':' . $rm->code;
393 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
395 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
400 function common_remembered_user()
404 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
410 list($id, $code) = explode(':', $packed);
412 if (!$id || !$code) {
413 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
418 $rm = Remember_me::getKV('code', $code);
421 common_log(LOG_WARNING, 'No such remember code: ' . $code);
426 if ($rm->user_id != $id) {
427 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
432 $user = User::getKV('id', $rm->user_id);
434 if (!$user instanceof User) {
435 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
441 $result = $rm->delete();
444 common_log_db_error($rm, 'DELETE', __FILE__);
445 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
450 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
452 common_set_user($user);
453 common_real_login(false);
455 // We issue a new cookie, so they can log in
456 // automatically again after this session
458 common_rememberme($user);
464 * must be called with a valid user!
466 function common_forgetme()
468 common_set_cookie(REMEMBERME, '', 0);
472 * Who is the current user?
474 function common_current_user()
478 if (!_have_config()) {
482 if ($_cur === false) {
484 if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
485 || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
486 common_ensure_session();
487 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
489 $user = User::getKV('id', $id);
490 if ($user instanceof User) {
497 // that didn't work; try to remember; will init $_cur to null on failure
498 $_cur = common_remembered_user();
501 // XXX: Is this necessary?
502 $_SESSION['userid'] = $_cur->id;
510 * Logins that are 'remembered' aren't 'real' -- they're subject to
511 * cookie-stealing. So, we don't let them do certain things. New reg,
512 * OpenID, and password logins _are_ real.
514 function common_real_login($real=true)
516 common_ensure_session();
517 $_SESSION['real_login'] = $real;
520 function common_is_real_login()
522 return common_logged_in() && $_SESSION['real_login'];
526 * Get a hash portion for HTTP caching Etags and such including
527 * info on the current user's session. If login/logout state changes,
528 * or we've changed accounts, or we've renamed the current user,
529 * we'll get a new hash value.
531 * This should not be considered secure information.
533 * @param User $user (optional; uses common_current_user() if left out)
536 function common_user_cache_hash($user=false)
538 if ($user === false) {
539 $user = common_current_user();
542 return crc32($user->id . ':' . $user->nickname);
549 * get canonical version of nickname for comparison
551 * @param string $nickname
554 * @throws NicknameException on invalid input
555 * @deprecated call Nickname::normalize() directly.
557 function common_canonical_nickname($nickname)
559 return Nickname::normalize($nickname);
563 * get canonical version of email for comparison
565 * @fixme actually normalize
566 * @fixme reject invalid input
568 * @param string $email
571 function common_canonical_email($email)
573 // XXX: canonicalize UTF-8
574 // XXX: lcase the domain part
578 function common_purify($html)
580 require_once INSTALLDIR.'/extlib/HTMLPurifier/HTMLPurifier.auto.php';
582 $cfg = HTMLPurifier_Config::createDefault();
583 $cfg->set('HTML.ForbiddenAttributes', array('style')); // id, on* etc. are already filtered by default
585 // Remove more elements than what the default filter removes, default in GNU social are remotely
586 // linked resources such as img, video, audio
587 $forbiddenElements = array();
588 foreach (common_config('htmlfilter') as $tag=>$filter) {
589 if ($filter === true) {
590 $forbiddenElements[] = $tag;
593 $cfg->set('HTML.ForbiddenElements', $forbiddenElements);
595 $html = common_remove_unicode_formatting($html);
597 $purifier = new HTMLPurifier($cfg);
598 $purified = $purifier->purify($html);
599 Event::handle('EndCommonPurify', array(&$purified, $html));
604 function common_remove_unicode_formatting($text)
606 // Strip Unicode text formatting/direction codes
607 // this is pretty dangerous for visualisation of text and can be used for mischief
608 return preg_replace('/[\\x{200b}-\\x{200f}\\x{202a}-\\x{202e}]/u', '', $text);
612 * Partial notice markup rendering step: build links to !group references.
614 * @param string $text partially rendered HTML
615 * @param Profile $author the Profile that is composing the current notice
616 * @param Notice $parent the Notice this is sent in reply to, if any
617 * @return string partially rendered HTML
619 function common_render_content($text, Profile $author, Notice $parent=null)
621 $text = common_render_text($text);
622 $text = common_linkify_mentions($text, $author, $parent);
627 * Finds @-mentions within the partially-rendered text section and
628 * turns them into live links.
630 * Should generally not be called except from common_render_content().
632 * @param string $text partially-rendered HTML
633 * @param Profile $author the Profile that is composing the current notice
634 * @param Notice $parent the Notice this is sent in reply to, if any
635 * @return string partially-rendered HTML
637 function common_linkify_mentions($text, Profile $author, Notice $parent=null)
639 $mentions = common_find_mentions($text, $author, $parent);
641 // We need to go through in reverse order by position,
642 // so our positions stay valid despite our fudging with the
647 foreach ($mentions as $mention)
649 $points[$mention['position']] = $mention;
654 foreach ($points as $position => $mention) {
656 $linkText = common_linkify_mention($mention);
658 $text = substr_replace($text, $linkText, $position, $mention['length']);
664 function common_linkify_mention(array $mention)
668 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
670 $xs = new XMLStringer(false);
672 $attrs = array('href' => $mention['url'],
673 'class' => 'h-card '.$mention['type']);
675 if (!empty($mention['title'])) {
676 $attrs['title'] = $mention['title'];
679 $xs->element('a', $attrs, $mention['text']);
681 $output = $xs->getString();
683 Event::handle('EndLinkifyMention', array($mention, &$output));
689 function common_get_attentions($text, Profile $sender, Notice $parent=null)
691 $mentions = common_find_mentions($text, $sender, $parent);
693 foreach ($mentions as $mention) {
694 foreach ($mention['mentioned'] as $mentioned) {
695 $atts[$mentioned->getUri()] = $mentioned->getObjectType();
698 if ($parent instanceof Notice) {
699 $parentAuthor = $parent->getProfile();
700 // afaik groups can't be authors
701 $atts[$parentAuthor->getUri()] = ActivityObject::PERSON;
707 * Find @-mentions in the given text, using the given notice object as context.
708 * References will be resolved with common_relative_profile() against the user
709 * who posted the notice.
711 * Note the return data format is internal, to be used for building links and
712 * such. Should not be used directly; rather, call common_linkify_mentions().
714 * @param string $text
715 * @param Profile $sender the Profile that is sending the current text
716 * @param Notice $parent the Notice this text is in reply to, if any
722 function common_find_mentions($text, Profile $sender, Notice $parent=null)
726 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
727 // Get the context of the original notice, if any
728 $origMentions = array();
729 // Does it have a parent notice for context?
730 if ($parent instanceof Notice) {
731 foreach ($parent->getAttentionProfiles() as $repliedTo) {
732 if (!$repliedTo->isPerson()) {
735 $origMentions[$repliedTo->id] = $repliedTo;
739 $matches = common_find_mentions_raw($text);
741 foreach ($matches as $match) {
743 $nickname = Nickname::normalize($match[0]);
744 } catch (NicknameException $e) {
745 // Bogus match? Drop it.
749 // primarily mention the profiles mentioned in the parent
750 $mention_found_in_origMentions = false;
751 foreach($origMentions as $origMentionsId=>$origMention) {
752 if($origMention->getNickname() == $nickname) {
753 $mention_found_in_origMentions = $origMention;
754 // don't mention same twice! the parent might have mentioned
755 // two users with same nickname on different instances
756 unset($origMentions[$origMentionsId]);
761 // Try to get a profile for this nickname.
762 // Start with parents mentions, then go to parents sender context
763 if ($mention_found_in_origMentions) {
764 $mentioned = $mention_found_in_origMentions;
765 } else if ($parent instanceof Notice && $parent->getProfile()->getNickname() === $nickname) {
766 $mentioned = $parent->getProfile();
768 // sets to null if no match
769 $mentioned = common_relative_profile($sender, $nickname);
772 if ($mentioned instanceof Profile) {
774 $url = $mentioned->getUri(); // prefer the URI as URL, if it is one.
775 if (!common_valid_http_url($url)) {
776 $url = $mentioned->getUrl();
778 } catch (InvalidUrlException $e) {
779 $url = common_local_url('userbyid', array('id' => $mentioned->getID()));
782 $mention = array('mentioned' => array($mentioned),
785 'position' => $match[1],
786 'length' => mb_strlen($match[0]),
787 'title' => $mentioned->getFullname(),
790 $mentions[] = $mention;
794 // @#tag => mention of all subscriptions tagged 'tag'
796 preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
797 $text, $hmatches, PREG_OFFSET_CAPTURE);
798 foreach ($hmatches[1] as $hmatch) {
799 $tag = common_canonical_tag($hmatch[0]);
800 $plist = Profile_list::getByTaggerAndTag($sender->getID(), $tag);
801 if (!$plist instanceof Profile_list || $plist->private) {
804 $tagged = $sender->getTaggedSubscribers($tag);
806 $url = common_local_url('showprofiletag',
807 array('nickname' => $sender->getNickname(),
810 $mentions[] = array('mentioned' => $tagged,
812 'text' => $hmatch[0],
813 'position' => $hmatch[1],
814 'length' => mb_strlen($hmatch[0]),
818 preg_match_all('/(?:^|[\s\.\,\:\;]+)!(' . Nickname::DISPLAY_FMT . ')/',
819 $text, $hmatches, PREG_OFFSET_CAPTURE);
820 foreach ($hmatches[1] as $hmatch) {
821 $nickname = Nickname::normalize($hmatch[0]);
822 $group = User_group::getForNickname($nickname, $sender);
824 if (!$group instanceof User_group || !$sender->isMember($group)) {
828 $profile = $group->getProfile();
830 $mentions[] = array('mentioned' => array($profile),
832 'text' => $hmatch[0],
833 'position' => $hmatch[1],
834 'length' => mb_strlen($hmatch[0]),
835 'url' => $group->permalink(),
836 'title' => $group->getFancyName());
839 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
846 * Does the actual regex pulls to find @-mentions in text.
847 * Should generally not be called directly; for use in common_find_mentions.
849 * @param string $text
850 * @return array of PCRE match arrays
852 function common_find_mentions_raw($text)
855 preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
858 PREG_OFFSET_CAPTURE);
860 $atmatches = array();
861 // the regexp's "(?!\@)" makes sure it doesn't matches the single "@remote" in "@remote@server.com"
862 preg_match_all('/(?:^|\s+)@(' . Nickname::DISPLAY_FMT . ')\b(?!\@)/',
865 PREG_OFFSET_CAPTURE);
867 $matches = array_merge($tmatches[1], $atmatches[1]);
871 function common_render_text($text)
873 $text = common_remove_unicode_formatting($text);
874 $text = nl2br(htmlspecialchars($text));
876 $text = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $text);
877 $text = common_replace_urls_callback($text, 'common_linkify');
878 $text = preg_replace_callback('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
879 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $text);
884 define('_URL_SCHEME_COLON_DOUBLE_SLASH', 1);
885 define('_URL_SCHEME_SINGLE_COLON', 2);
886 define('_URL_SCHEME_NO_DOMAIN', 4);
888 function common_url_schemes($filter=null)
890 // TODO: move these to $config
892 'http' => _URL_SCHEME_COLON_DOUBLE_SLASH,
893 'https' => _URL_SCHEME_COLON_DOUBLE_SLASH,
894 'ftp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
895 'ftps' => _URL_SCHEME_COLON_DOUBLE_SLASH,
896 'mms' => _URL_SCHEME_COLON_DOUBLE_SLASH,
897 'rtsp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
898 'gopher' => _URL_SCHEME_COLON_DOUBLE_SLASH,
899 'news' => _URL_SCHEME_COLON_DOUBLE_SLASH,
900 'nntp' => _URL_SCHEME_COLON_DOUBLE_SLASH,
901 'telnet' => _URL_SCHEME_COLON_DOUBLE_SLASH,
902 'wais' => _URL_SCHEME_COLON_DOUBLE_SLASH,
903 'file' => _URL_SCHEME_COLON_DOUBLE_SLASH,
904 'prospero' => _URL_SCHEME_COLON_DOUBLE_SLASH,
905 'webcal' => _URL_SCHEME_COLON_DOUBLE_SLASH,
906 'irc' => _URL_SCHEME_COLON_DOUBLE_SLASH,
907 'ircs' => _URL_SCHEME_COLON_DOUBLE_SLASH,
908 'aim' => _URL_SCHEME_SINGLE_COLON,
909 'bitcoin' => _URL_SCHEME_SINGLE_COLON,
910 'fax' => _URL_SCHEME_SINGLE_COLON,
911 'jabber' => _URL_SCHEME_SINGLE_COLON,
912 'mailto' => _URL_SCHEME_SINGLE_COLON,
913 'tel' => _URL_SCHEME_SINGLE_COLON,
914 'xmpp' => _URL_SCHEME_SINGLE_COLON,
915 'magnet' => _URL_SCHEME_NO_DOMAIN,
919 array_filter($schemes,
920 function ($scheme) use ($filter) {
921 return is_null($filter) || ($scheme & $filter);
927 * Find links in the given text and pass them to the given callback function.
929 * @param string $text
930 * @param function($text, $arg) $callback: return replacement text
931 * @param mixed $arg: optional argument will be passed on to the callback
933 function common_replace_urls_callback($text, $callback, $arg = null) {
934 // Start off with a regex
936 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
939 '(?:'. //Known protocols
941 '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_COLON_DOUBLE_SLASH)) . ')://)'.
943 '(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_SINGLE_COLON)) . '):)'.
945 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
948 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
950 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
954 // URLs without domain name, like magnet:?xt=...
955 '|(?:(?:' . implode('|', common_url_schemes(_URL_SCHEME_NO_DOMAIN)) . '):)'.
956 '|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)'. //IPv4
958 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
960 (common_config('linkify', 'bare_domains')
962 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
963 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
964 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
965 '(?: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)'.
967 : '') . // if common_config('linkify', 'bare_domains') is false, don't add anything here
970 '(?:\:\d+)?'. //:port
971 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
972 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
973 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
974 ')(?<![\?\.\,\#\,])'.
977 //preg_match_all($regex,$text,$matches);
979 return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
983 * Intermediate callback for common_replace_links(), helps resolve some
984 * ambiguous link forms before passing on to the final callback.
986 * @param array $matches
987 * @param callable $callback
988 * @param mixed $arg optional argument to pass on as second param to callback
993 function callback_helper($matches, $callback, $arg=null) {
995 $left = strpos($matches[0],$url);
996 $right = $left+strlen($url);
998 $groupSymbolSets=array(
1016 $cannotEndWith=array('.','?',',','#');
1020 foreach($groupSymbolSets as $groupSymbolSet){
1021 if(substr($url,-1)==$groupSymbolSet['right']){
1022 $group_left_count = substr_count($url,$groupSymbolSet['left']);
1023 $group_right_count = substr_count($url,$groupSymbolSet['right']);
1024 if($group_left_count<$group_right_count){
1026 $url=substr($url,0,-1);
1030 if(in_array(substr($url,-1),$cannotEndWith)){
1032 $url=substr($url,0,-1);
1034 }while($original_url!=$url);
1036 $result = call_user_func_array($callback, array($url, $arg));
1037 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
1040 require_once INSTALLDIR . "/lib/curry.php";
1042 function common_linkify($url) {
1043 // It comes in special'd, so we unspecial it before passing to the stringifying
1045 $url = htmlspecialchars_decode($url);
1047 if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
1048 //url is an email address without the mailto: protocol
1049 $canon = "mailto:$url";
1050 $longurl = "mailto:$url";
1052 $canon = File_redirection::_canonUrl($url);
1053 $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
1055 if(isset($longurl_data->redir_url)) {
1056 $longurl = $longurl_data->redir_url;
1059 $longurl = $longurl_data->url;
1063 $attrs = array('href' => $longurl, 'title' => $longurl);
1065 $is_attachment = false;
1066 $attachment_id = null;
1069 // Check to see whether this is a known "attachment" URL.
1072 $f = File::getByUrl($longurl);
1073 } catch (NoResultException $e) {
1074 if (common_config('attachments', 'process_links')) {
1075 // XXX: this writes to the database. :<
1077 $f = File::processNew($longurl);
1078 } catch (ServerException $e) {
1084 if ($f instanceof File) {
1086 $enclosure = $f->getEnclosure();
1087 $is_attachment = true;
1088 $attachment_id = $f->id;
1090 $thumb = File_thumbnail::getKV('file_id', $f->id);
1091 $has_thumb = ($thumb instanceof File_thumbnail);
1092 } catch (ServerException $e) {
1093 // There was not enough metadata available
1098 if ($is_attachment) {
1099 $attrs['class'] = 'attachment';
1101 $attrs['class'] = 'attachment thumbnail';
1103 $attrs['id'] = "attachment-{$attachment_id}";
1106 // Whether to nofollow
1108 $nf = common_config('nofollow', 'external');
1110 if ($nf == 'never') {
1111 $attrs['rel'] = 'external';
1113 $attrs['rel'] = 'nofollow external';
1116 return XMLStringer::estring('a', $attrs, $url);
1120 * Find and shorten links in a given chunk of text if it's longer than the
1121 * configured notice content limit (or unconditionally).
1123 * Side effects: may save file and file_redirection records for referenced URLs.
1125 * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1126 * user's options are used; otherwise the current web session user's setitngs
1127 * will be used or ur1.ca if there is no active web login.
1129 * @param string $text
1130 * @param boolean $always (optional)
1131 * @param User $user (optional)
1135 function common_shorten_links($text, $always = false, User $user=null)
1137 if ($user === null) {
1138 $user = common_current_user();
1141 $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1143 if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1144 return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1146 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1151 * Very basic stripping of invalid UTF-8 input text.
1153 * @param string $str
1154 * @return mixed string or null if invalid input
1156 * @todo ideally we should drop bad chars, and maybe do some of the checks
1157 * from common_xml_safe_str. But we can't strip newlines, etc.
1158 * @todo Unicode normalization might also be useful, but not needed now.
1160 function common_validate_utf8($str)
1162 // preg_replace will return NULL on invalid UTF-8 input.
1164 // Note: empty regex //u also caused NULL return on some
1165 // production machines, but none of our test machines.
1167 // This should be replaced with a more reliable check.
1168 return preg_replace('/\x00/u', '', $str);
1172 * Make sure an arbitrary string is safe for output in XML as a single line.
1174 * @param string $str
1177 function common_xml_safe_str($str)
1179 // Replace common eol and extra whitespace input chars
1184 "\0", // null byte eos
1185 "\x0B" // vertical tab
1188 $replacement = array(
1189 ' ', // single space
1196 $str = str_replace($unWelcome, $replacement, $str);
1198 // Neutralize any additional control codes and UTF-16 surrogates
1199 // (Twitter uses '*')
1200 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1203 function common_slugify($str)
1205 // php5-intl is highly recommended...
1206 if (!function_exists('transliterator_transliterate')) {
1207 $str = preg_replace('/[^\pL\pN]/u', '', $str);
1208 $str = mb_convert_case($str, MB_CASE_LOWER, 'UTF-8');
1209 $str = substr($str, 0, 64);
1212 $str = transliterator_transliterate(
1213 'Any-Latin;' . // any charset to latin compatible
1214 'NFD;' . // decompose
1215 '[:Nonspacing Mark:] Remove;' . // remove nonspacing marks (accents etc.)
1216 'NFC;' . // composite again
1217 '[:Punctuation:] Remove;' . // remove punctuation (.,¿? etc.)
1218 'Lower();' . // turn into lowercase
1219 'Latin-ASCII;', // get ASCII equivalents (ð to d for example)
1221 return preg_replace('/[^\pL\pN]/', '', $str);
1224 function common_tag_link($tag)
1226 $canonical = common_canonical_tag($tag);
1227 if (common_config('singleuser', 'enabled')) {
1228 // regular TagAction isn't set up in 1user mode
1229 $nickname = User::singleUserNickname();
1230 $url = common_local_url('showstream',
1231 array('nickname' => $nickname,
1232 'tag' => $canonical));
1234 $url = common_local_url('tag', array('tag' => $canonical));
1236 $xs = new XMLStringer();
1237 $xs->elementStart('span', 'tag');
1238 $xs->element('a', array('href' => $url,
1241 $xs->elementEnd('span');
1242 return $xs->getString();
1245 function common_canonical_tag($tag)
1247 $tag = common_slugify($tag);
1248 $tag = substr($tag, 0, 64);
1252 function common_valid_profile_tag($str)
1254 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1258 * Resolve an ambiguous profile nickname reference, checking in following order:
1259 * - profiles that $sender subscribes to
1260 * - profiles that subscribe to $sender
1261 * - local user profiles
1263 * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1264 * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1267 * @fixme validate input
1269 * @fixme fix or remove mystery third parameter
1270 * @fixme is $sender a User or Profile?
1272 * @param <type> $sender the user or profile in whose context we're looking
1273 * @param string $nickname validated nickname of
1274 * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1276 * @return Profile or null
1278 function common_relative_profile($sender, $nickname, $dt=null)
1280 // Will throw exception on invalid input.
1281 $nickname = Nickname::normalize($nickname);
1283 // Try to find profiles this profile is subscribed to that have this nickname
1284 $recipient = new Profile();
1285 // XXX: use a join instead of a subquery
1286 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1287 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1288 if ($recipient->find(true)) {
1289 // XXX: should probably differentiate between profiles with
1290 // the same name by date of most recent update
1293 // Try to find profiles that listen to this profile and that have this nickname
1294 $recipient = new Profile();
1295 // XXX: use a join instead of a subquery
1296 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1297 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1298 if ($recipient->find(true)) {
1299 // XXX: should probably differentiate between profiles with
1300 // the same name by date of most recent update
1303 // If this is a local user, try to find a local user with that nickname.
1304 $sender = User::getKV('id', $sender->id);
1305 if ($sender instanceof User) {
1306 $recipient_user = User::getKV('nickname', $nickname);
1307 if ($recipient_user instanceof User) {
1308 return $recipient_user->getProfile();
1311 // Otherwise, no links. @messages from local users to remote users,
1312 // or from remote users to other remote users, are just
1313 // outside our ability to make intelligent guesses about
1317 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1319 if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1321 $path = $r->build($action, $args, $params, $fragment);
1323 $ssl = common_config('site', 'ssl') === 'always'
1324 || GNUsocial::isHTTPS()
1325 || common_is_sensitive($action);
1327 if (common_config('site','fancy')) {
1328 $url = common_path($path, $ssl, $addSession);
1330 if (mb_strpos($path, '/index.php') === 0) {
1331 $url = common_path($path, $ssl, $addSession);
1333 $url = common_path('index.php/'.$path, $ssl, $addSession);
1336 Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1341 function common_is_sensitive($action)
1343 static $sensitive = array(
1348 'ApiOAuthRequestToken',
1349 'ApiOAuthAccessToken',
1350 'ApiOAuthAuthorize',
1356 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1357 $ssl = in_array($action, $sensitive);
1363 function common_path($relative, $ssl=false, $addSession=true)
1365 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1367 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1368 || GNUsocial::isHTTPS()
1369 || common_config('site', 'ssl') === 'always') {
1371 if (is_string(common_config('site', 'sslserver')) &&
1372 mb_strlen(common_config('site', 'sslserver')) > 0) {
1373 $serverpart = common_config('site', 'sslserver');
1374 } else if (common_config('site', 'server')) {
1375 $serverpart = common_config('site', 'server');
1377 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1381 if (common_config('site', 'server')) {
1382 $serverpart = common_config('site', 'server');
1384 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1389 $relative = common_inject_session($relative, $serverpart);
1392 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1395 function common_inject_session($url, $serverpart = null)
1397 if (!common_have_session()) {
1401 if (empty($serverpart)) {
1402 $serverpart = parse_url($url, PHP_URL_HOST);
1405 $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1407 // Are we pointing to another server (like an SSL server?)
1409 if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1410 // Pass the session ID as a GET parameter
1411 $sesspart = session_name() . '=' . session_id();
1412 $i = strpos($url, '?');
1413 if ($i === false) { // no GET params, just append
1414 $url .= '?' . $sesspart;
1416 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1423 function common_date_string($dt)
1425 // XXX: do some sexy date formatting
1426 // return date(DATE_RFC822, $dt);
1427 $t = strtotime($dt);
1431 if ($now < $t) { // that shouldn't happen!
1432 return common_exact_date($dt);
1433 } else if ($diff < 60) {
1434 // TRANS: Used in notices to indicate when the notice was made compared to now.
1435 return _('a few seconds ago');
1436 } else if ($diff < 92) {
1437 // TRANS: Used in notices to indicate when the notice was made compared to now.
1438 return _('about a minute ago');
1439 } else if ($diff < 3300) {
1440 $minutes = round($diff/60);
1441 // TRANS: Used in notices to indicate when the notice was made compared to now.
1442 return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1443 } else if ($diff < 5400) {
1444 // TRANS: Used in notices to indicate when the notice was made compared to now.
1445 return _('about an hour ago');
1446 } else if ($diff < 22 * 3600) {
1447 $hours = round($diff/3600);
1448 // TRANS: Used in notices to indicate when the notice was made compared to now.
1449 return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1450 } else if ($diff < 37 * 3600) {
1451 // TRANS: Used in notices to indicate when the notice was made compared to now.
1452 return _('about a day ago');
1453 } else if ($diff < 24 * 24 * 3600) {
1454 $days = round($diff/(24*3600));
1455 // TRANS: Used in notices to indicate when the notice was made compared to now.
1456 return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1457 } else if ($diff < 46 * 24 * 3600) {
1458 // TRANS: Used in notices to indicate when the notice was made compared to now.
1459 return _('about a month ago');
1460 } else if ($diff < 330 * 24 * 3600) {
1461 $months = round($diff/(30*24*3600));
1462 // TRANS: Used in notices to indicate when the notice was made compared to now.
1463 return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1464 } else if ($diff < 480 * 24 * 3600) {
1465 // TRANS: Used in notices to indicate when the notice was made compared to now.
1466 return _('about a year ago');
1468 return common_exact_date($dt);
1472 function common_exact_date($dt)
1478 $_utc = new DateTimeZone('UTC');
1479 $_siteTz = new DateTimeZone(common_timezone());
1482 $dateStr = date('d F Y H:i:s', strtotime($dt));
1483 $d = new DateTime($dateStr, $_utc);
1484 $d->setTimezone($_siteTz);
1485 // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
1486 return $d->format(_('l, d-M-Y H:i:s T'));
1489 function common_date_w3dtf($dt)
1491 $dateStr = date('d F Y H:i:s', strtotime($dt));
1492 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1493 $d->setTimezone(new DateTimeZone(common_timezone()));
1494 return $d->format(DATE_W3C);
1497 function common_date_rfc2822($dt)
1499 $dateStr = date('d F Y H:i:s', strtotime($dt));
1500 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1501 $d->setTimezone(new DateTimeZone(common_timezone()));
1502 return $d->format('r');
1505 function common_date_iso8601($dt)
1507 $dateStr = date('d F Y H:i:s', strtotime($dt));
1508 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1509 $d->setTimezone(new DateTimeZone(common_timezone()));
1510 return $d->format('c');
1513 function common_sql_now()
1515 return common_sql_date(time());
1518 function common_sql_date($datetime)
1520 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1524 * Return an SQL fragment to calculate an age-based weight from a given
1525 * timestamp or datetime column.
1527 * @param string $column name of field we're comparing against current time
1528 * @param integer $dropoff divisor for age in seconds before exponentiation
1529 * @return string SQL fragment
1531 function common_sql_weight($column, $dropoff)
1533 if (common_config('db', 'type') == 'pgsql') {
1534 // PostgreSQL doesn't support timestampdiff function.
1535 // @fixme will this use the right time zone?
1536 // @fixme does this handle cross-year subtraction correctly?
1537 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1539 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1543 function common_redirect($url, $code=307)
1545 static $status = array(301 => "Moved Permanently",
1548 307 => "Temporary Redirect");
1550 header('HTTP/1.1 '.$code.' '.$status[$code]);
1551 header("Location: $url");
1552 header("Connection: close");
1554 $xo = new XMLOutputter();
1556 '-//W3C//DTD XHTML 1.0 Strict//EN',
1557 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1558 $xo->element('a', array('href' => $url), $url);
1563 // Stick the notice on the queue
1565 function common_enqueue_notice($notice)
1567 static $localTransports = array('ping');
1569 $transports = array();
1570 if (common_config('sms', 'enabled')) {
1571 $transports[] = 'sms';
1573 if (Event::hasHandler('HandleQueuedNotice')) {
1574 $transports[] = 'plugin';
1577 // We can skip these for gatewayed notices.
1578 if ($notice->isLocal()) {
1579 $transports = array_merge($transports, $localTransports);
1582 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1584 $qm = QueueManager::get();
1586 foreach ($transports as $transport)
1588 $qm->enqueue($notice, $transport);
1591 Event::handle('EndEnqueueNotice', array($notice, $transports));
1597 function common_profile_url($nickname)
1599 return common_local_url('showstream', array('nickname' => $nickname),
1604 * Should make up a reasonable root URL
1606 function common_root_url($ssl=false)
1608 $url = common_path('', $ssl, false);
1609 $i = strpos($url, '?');
1611 $url = substr($url, 0, $i);
1617 * returns $bytes bytes of raw random data
1619 function common_random_rawstr($bytes)
1621 $rawstr = @file_exists('/dev/urandom')
1622 ? common_urandom($bytes)
1623 : common_mtrand($bytes);
1629 * returns $bytes bytes of random data as a hexadecimal string
1631 function common_random_hexstr($bytes)
1633 $str = common_random_rawstr($bytes);
1636 for ($i = 0; $i < $bytes; $i++) {
1637 $hexstr .= sprintf("%02x", ord($str[$i]));
1642 function common_urandom($bytes)
1644 $h = fopen('/dev/urandom', 'rb');
1646 $src = fread($h, $bytes);
1651 function common_mtrand($bytes)
1654 for ($i = 0; $i < $bytes; $i++) {
1655 $str .= chr(mt_rand(0, 255));
1661 * Record the given URL as the return destination for a future
1662 * form submission, to be read by common_get_returnto().
1664 * @param string $url
1666 * @fixme as a session-global setting, this can allow multiple forms
1667 * to conflict and overwrite each others' returnto destinations if
1668 * the user has multiple tabs or windows open.
1670 * Should refactor to index with a token or otherwise only pass the
1671 * data along its intended path.
1673 function common_set_returnto($url)
1675 common_ensure_session();
1676 $_SESSION['returnto'] = $url;
1680 * Fetch a return-destination URL previously recorded by
1681 * common_set_returnto().
1683 * @return mixed URL string or null
1685 * @fixme as a session-global setting, this can allow multiple forms
1686 * to conflict and overwrite each others' returnto destinations if
1687 * the user has multiple tabs or windows open.
1689 * Should refactor to index with a token or otherwise only pass the
1690 * data along its intended path.
1692 function common_get_returnto()
1694 common_ensure_session();
1695 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1698 function common_timestamp()
1700 return date('YmdHis');
1703 function common_ensure_syslog()
1705 static $initialized = false;
1706 if (!$initialized) {
1707 openlog(common_config('syslog', 'appname'), 0,
1708 common_config('syslog', 'facility'));
1709 $initialized = true;
1713 function common_log_line($priority, $msg)
1715 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1716 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1717 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1720 function common_request_id()
1723 $server = common_config('site', 'server');
1724 if (php_sapi_name() == 'cli') {
1725 $script = basename($_SERVER['PHP_SELF']);
1726 return "$server:$script:$pid";
1728 static $req_id = null;
1729 if (!isset($req_id)) {
1730 $req_id = substr(md5(mt_rand()), 0, 8);
1732 if (isset($_SERVER['REQUEST_URI'])) {
1733 $url = $_SERVER['REQUEST_URI'];
1735 $method = $_SERVER['REQUEST_METHOD'];
1736 return "$server:$pid.$req_id $method $url";
1740 function common_log($priority, $msg, $filename=null)
1742 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1743 $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1744 $msg = '[' . common_request_id() . '] ' . $msg;
1745 $logfile = common_config('site', 'logfile');
1747 $log = fopen($logfile, "a");
1749 $output = common_log_line($priority, $msg);
1750 fwrite($log, $output);
1754 common_ensure_syslog();
1755 syslog($priority, $msg);
1757 Event::handle('EndLog', array($priority, $msg, $filename));
1761 function common_debug($msg, $filename=null)
1764 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1766 common_log(LOG_DEBUG, $msg);
1770 function common_log_db_error(&$object, $verb, $filename=null)
1774 $objstr = common_log_objstring($object);
1775 $last_error = &$_PEAR->getStaticProperty('DB_DataObject','lastError');
1776 if (is_object($last_error)) {
1777 $msg = $last_error->message;
1779 $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1781 common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1784 function common_log_objstring(&$object)
1786 if (is_null($object)) {
1789 if (!($object instanceof DB_DataObject)) {
1792 $arr = $object->toArray();
1794 foreach ($arr as $k => $v) {
1795 if (is_object($v)) {
1796 $fields[] = "$k='".get_class($v)."'";
1798 $fields[] = "$k='$v'";
1801 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1805 function common_valid_http_url($url, $secure=false)
1807 // If $secure is true, only allow https URLs to pass
1808 // (if false, we use '?' in 'https?' to say the 's' is optional)
1809 $regex = $secure ? '/^https$/' : '/^https?$/';
1810 return filter_var($url, FILTER_VALIDATE_URL)
1811 && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1814 function common_valid_tag($tag)
1816 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1817 return (Validate::email($matches[1]) ||
1818 preg_match('/^([\w-\.]+)$/', $matches[1]));
1824 * Determine if given domain or address literal is valid
1825 * eg for use in JIDs and URLs. Does not check if the domain
1828 * @param string $domain
1829 * @return boolean valid or not
1831 function common_valid_domain($domain)
1833 $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1834 $ipv4 = "(?:$octet(?:\.$octet){3})";
1835 if (preg_match("/^$ipv4$/u", $domain)) return true;
1837 $group = "(?:[0-9a-f]{1,4})";
1838 $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1840 if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1841 $before = explode(":", $matches[1]);
1842 $zeroes = $matches[2];
1843 $after = explode(":", $matches[3]);
1851 $explicit = count($before) + count($after);
1852 if ($explicit < $min || $explicit > $max) {
1859 require_once "Net/IDNA.php";
1860 $idn = Net_IDNA::getInstance();
1861 $domain = $idn->encode($domain);
1862 } catch (Exception $e) {
1866 $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1867 $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1869 return preg_match("/^$fqdn$/ui", $domain);
1872 /* Following functions are copied from MediaWiki GlobalFunctions.php
1873 * and written by Evan Prodromou. */
1875 function common_accept_to_prefs($accept, $def = '*/*')
1877 // No arg means accept anything (per HTTP spec)
1879 return array($def => 1);
1884 $parts = explode(',', $accept);
1886 foreach($parts as $part) {
1887 // FIXME: doesn't deal with params like 'text/html; level=1'
1888 @list($value, $qpart) = explode(';', trim($part));
1890 if(!isset($qpart)) {
1892 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1893 $prefs[$value] = $match[1];
1900 // Match by our supported file extensions
1901 function common_supported_ext_to_mime($fileext)
1903 // Accept a filename and take out the extension
1904 if (strpos($fileext, '.') !== false) {
1905 $fileext = substr(strrchr($fileext, '.'), 1);
1908 $supported = common_config('attachments', 'supported');
1909 if ($supported === true) {
1910 throw new ServerException('Supported extension but unknown mimetype relation.');
1912 foreach($supported as $type => $ext) {
1913 if ($ext === $fileext) {
1918 throw new ServerException('Unsupported file extension');
1921 // Match by our supported mime types
1922 function common_supported_mime_to_ext($mimetype)
1924 $supported = common_config('attachments', 'supported');
1925 if ($supported === true) {
1926 throw new ServerException('Supported mimetype but unknown extension relation.');
1928 foreach($supported as $type => $ext) {
1929 if ($mimetype === $type) {
1934 throw new ServerException('Unsupported MIME type');
1937 // The MIME "media" is the part before the slash (video in video/webm)
1938 function common_get_mime_media($type)
1940 $tmp = explode('/', $type);
1941 return strtolower($tmp[0]);
1944 // Get only the mimetype and not additional info (separated from bare mime with semi-colon)
1945 function common_bare_mime($mimetype)
1947 $mimetype = mb_strtolower($mimetype);
1948 if ($semicolon = mb_strpos($mimetype, ';')) {
1949 $mimetype = mb_substr($mimetype, 0, $semicolon);
1954 function common_mime_type_match($type, $avail)
1956 if(array_key_exists($type, $avail)) {
1959 $parts = explode('/', $type);
1960 if(array_key_exists($parts[0] . '/*', $avail)) {
1961 return $parts[0] . '/*';
1962 } elseif(array_key_exists('*/*', $avail)) {
1970 function common_negotiate_type($cprefs, $sprefs)
1974 foreach(array_keys($sprefs) as $type) {
1975 $parts = explode('/', $type);
1976 if($parts[1] != '*') {
1977 $ckey = common_mime_type_match($type, $cprefs);
1979 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1984 foreach(array_keys($cprefs) as $type) {
1985 $parts = explode('/', $type);
1986 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1987 $skey = common_mime_type_match($type, $sprefs);
1989 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1995 $besttype = 'text/html';
1997 foreach(array_keys($combine) as $type) {
1998 if($combine[$type] > $bestq) {
2000 $bestq = $combine[$type];
2004 if ('text/html' === $besttype) {
2005 return "text/html; charset=utf-8";
2010 function common_config($main, $sub=null)
2013 if (is_null($sub)) {
2014 // Return the config category array
2015 return array_key_exists($main, $config) ? $config[$main] : array();
2017 // Return the config value
2018 return (array_key_exists($main, $config) &&
2019 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
2022 function common_config_set($main, $sub, $value)
2025 if (!array_key_exists($main, $config)) {
2026 $config[$main] = array();
2028 $config[$main][$sub] = $value;
2031 function common_config_append($main, $sub, $value)
2034 if (!array_key_exists($main, $config)) {
2035 $config[$main] = array();
2037 if (!array_key_exists($sub, $config[$main])) {
2038 $config[$main][$sub] = array();
2040 if (!is_array($config[$main][$sub])) {
2041 $config[$main][$sub] = array($config[$main][$sub]);
2043 array_push($config[$main][$sub], $value);
2047 * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
2048 * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
2050 * @param array $from
2053 function common_copy_args($from)
2056 $strip = get_magic_quotes_gpc();
2057 foreach ($from as $k => $v) {
2059 $to[$k] = common_copy_args($v);
2062 $v = stripslashes($v);
2064 $to[$k] = strval(common_validate_utf8($v));
2071 * Neutralise the evil effects of magic_quotes_gpc in the current request.
2072 * This is used before handing a request off to OAuthRequest::from_request.
2073 * @fixme Doesn't consider vars other than _POST and _GET?
2074 * @fixme Can't be undone and could corrupt data if run twice.
2076 function common_remove_magic_from_request()
2078 if(get_magic_quotes_gpc()) {
2079 $_POST=array_map('stripslashes',$_POST);
2080 $_GET=array_map('stripslashes',$_GET);
2084 function common_user_uri(&$user)
2086 return common_local_url('userbyid', array('id' => $user->id),
2090 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2092 function common_confirmation_code($bits)
2094 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2095 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
2096 $chars = ceil($bits/5);
2098 for ($i = 0; $i < $chars; $i++) {
2099 // XXX: convert to string and back
2100 $num = hexdec(common_random_hexstr(1));
2101 // XXX: randomness is too precious to throw away almost
2102 // 40% of the bits we get!
2103 $code .= $codechars[$num%32];
2108 // convert markup to HTML
2109 function common_markup_to_html($c, $args=null)
2115 if (is_null($args)) {
2119 // XXX: not very efficient
2121 foreach ($args as $name => $value) {
2122 $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
2125 $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
2126 $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
2127 $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
2128 $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
2130 return \Michelf\Markdown::defaultTransform($c);
2133 function common_user_property($property)
2135 $profile = Profile::current();
2137 if (empty($profile)) {
2141 switch ($property) {
2147 return $profile->$property;
2151 return $profile->getAvatar(AVATAR_STREAM_SIZE);
2152 } catch (Exception $e) {
2157 return $profile->getBestName();
2164 function common_profile_uri($profile)
2168 if (!empty($profile)) {
2169 if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2170 $user = User::getKV('id', $profile->id);
2171 if ($user instanceof User) {
2172 $uri = $user->getUri();
2174 Event::handle('EndCommonProfileURI', array($profile, &$uri));
2178 // XXX: this is a very bad profile!
2182 function common_canonical_sms($sms)
2185 preg_replace('/\D/', '', $sms);
2189 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2194 case E_COMPILE_ERROR:
2198 case E_RECOVERABLE_ERROR:
2199 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2204 case E_COMPILE_WARNING:
2205 case E_CORE_WARNING:
2206 case E_USER_WARNING:
2207 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2212 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2217 case E_USER_DEPRECATED:
2218 // XXX: config variable to log this stuff, too
2222 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2227 // FIXME: show error page if we're on the Web
2228 /* Don't execute PHP internal error handler */
2232 function common_session_token()
2234 common_ensure_session();
2235 if (!array_key_exists('token', $_SESSION)) {
2236 $_SESSION['token'] = common_random_hexstr(64);
2238 return $_SESSION['token'];
2241 function common_license_terms($uri)
2243 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2244 return explode('-',$matches[1]);
2249 function common_compatible_license($from, $to)
2251 $from_terms = common_license_terms($from);
2252 // public domain and cc-by are compatible with everything
2253 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2256 $to_terms = common_license_terms($to);
2257 // sa is compatible across versions. IANAL
2258 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2259 return count(array_diff($from_terms, $to_terms)) == 0;
2261 // XXX: better compatibility check needed here!
2262 // Should at least normalise URIs
2263 return ($from == $to);
2267 * returns a quoted table name, if required according to config
2269 function common_database_tablename($tablename)
2271 if(common_config('db','quote_identifiers')) {
2272 $tablename = '"'. $tablename .'"';
2274 //table prefixes could be added here later
2279 * Shorten a URL with the current user's configured shortening service,
2280 * or ur1.ca if configured, or not at all if no shortening is set up.
2282 * @param string $long_url original URL
2283 * @param User $user to specify a particular user's options
2284 * @param boolean $force Force shortening (used when notice is too long)
2285 * @return string may return the original URL if shortening failed
2287 * @fixme provide a way to specify a particular shortener
2289 function common_shorten_url($long_url, User $user=null, $force = false)
2291 $long_url = trim($long_url);
2293 $user = common_current_user();
2295 $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2297 // $force forces shortening even if it's not strictly needed
2298 // I doubt URL shortening is ever 'strictly' needed. - ESP
2300 if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2304 $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2306 if (Event::handle('StartShortenUrl',
2307 array($long_url, $shortenerName, &$shortenedUrl))) {
2308 if ($shortenerName == 'internal') {
2310 $f = File::processNew($long_url);
2311 $shortenedUrl = common_local_url('redirecturl', array('id' => $f->id));
2312 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2313 return $shortenedUrl;
2317 } catch (ServerException $e) {
2324 //URL was shortened, so return the result
2325 return trim($shortenedUrl);
2330 * @return mixed array($proxy, $ip) for web requests; proxy may be null
2331 * null if not a web request
2333 * @fixme X-Forwarded-For can be chained by multiple proxies;
2334 we should parse the list and provide a cleaner array
2335 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2336 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2337 * use function to get exact request headers from Apache if possible.
2339 function common_client_ip()
2341 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2345 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2346 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2347 $proxy = $_SERVER['HTTP_CLIENT_IP'];
2349 $proxy = $_SERVER['REMOTE_ADDR'];
2351 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2354 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2355 $ip = $_SERVER['HTTP_CLIENT_IP'];
2357 $ip = $_SERVER['REMOTE_ADDR'];
2361 return array($proxy, $ip);
2364 function common_url_to_nickname($url)
2366 static $bad = array('query', 'user', 'password', 'port', 'fragment');
2368 $parts = parse_url($url);
2370 // If any of these parts exist, this won't work
2372 foreach ($bad as $badpart) {
2373 if (array_key_exists($badpart, $parts)) {
2378 // We just have host and/or path
2380 // If it's just a host...
2381 if (array_key_exists('host', $parts) &&
2382 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2384 $hostparts = explode('.', $parts['host']);
2386 // Try to catch common idiom of nickname.service.tld
2388 if ((count($hostparts) > 2) &&
2389 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2390 (strcmp($hostparts[0], 'www') != 0))
2392 return common_nicknamize($hostparts[0]);
2394 // Do the whole hostname
2395 return common_nicknamize($parts['host']);
2398 if (array_key_exists('path', $parts)) {
2399 // Strip starting, ending slashes
2400 $path = preg_replace('@/$@', '', $parts['path']);
2401 $path = preg_replace('@^/@', '', $path);
2402 $path = basename($path);
2404 // Hack for MediaWiki user pages, in the form:
2405 // http://example.com/wiki/User:Myname
2406 // ('User' may be localized.)
2407 if (strpos($path, ':')) {
2408 $parts = array_filter(explode(':', $path));
2409 $path = $parts[count($parts) - 1];
2413 return common_nicknamize($path);
2421 function common_nicknamize($str)
2424 return Nickname::normalize($str);
2425 } catch (NicknameException $e) {
2430 function common_perf_counter($key, $val=null)
2432 global $_perfCounters;
2433 if (isset($_perfCounters)) {
2434 if (common_config('site', 'logperf')) {
2435 if (array_key_exists($key, $_perfCounters)) {
2436 $_perfCounters[$key][] = $val;
2438 $_perfCounters[$key] = array($val);
2440 if (common_config('site', 'logperf_detail')) {
2441 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2447 function common_log_perf_counters()
2449 if (common_config('site', 'logperf')) {
2450 global $_startTime, $_perfCounters;
2452 if (isset($_startTime)) {
2453 $endTime = microtime(true);
2454 $diff = round(($endTime - $_startTime) * 1000);
2455 common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2457 $counters = $_perfCounters;
2459 foreach ($counters as $key => $values) {
2460 $count = count($values);
2461 $unique = count(array_unique($values));
2462 common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2467 function common_is_email($str)
2469 return (strpos($str, '@') !== false);
2472 function common_init_stats()
2476 $_mem = memory_get_usage(true);
2477 $_ts = microtime(true);
2480 function common_log_delta($comment=null)
2487 $_mem = memory_get_usage(true);
2488 $_ts = microtime(true);
2490 $mtotal = $_mem - $mold;
2491 $ttotal = $_ts - $told;
2493 if (empty($comment)) {
2497 common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
2500 function common_strip_html($html, $trim=true, $save_whitespace=false)
2502 if (!$save_whitespace) {
2503 $html = preg_replace('/\s+/', ' ', $html);
2505 $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
2506 return $trim ? trim($text) : $text;
2509 function html_sprintf()
2511 $args = func_get_args();
2512 for ($i=1; $i<count($args); $i++) {
2513 $args[$i] = htmlspecialchars($args[$i]);
2515 return call_user_func_array('sprintf', $args);
2520 return var_export($var, true);