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/htmLawed/htmLawed.php';
582 $config = array('safe' => 1, // means that elements=* means elements=*-applet-embed-iframe-object-script or so
584 'deny_attribute' => 'id,style,on*');
586 // Remove more elements than what the 'safe' filter gives (elements must be '*' before this)
587 // http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed/htmLawed_README.htm#s3.6
588 foreach (common_config('htmlfilter') as $tag=>$filter) {
589 if ($filter === true) {
590 $config['elements'] .= "-{$tag}";
594 $html = common_remove_unicode_formatting($html);
596 return htmLawed($html, $config);
599 function common_remove_unicode_formatting($text)
601 // Strip Unicode text formatting/direction codes
602 // this is pretty dangerous for visualisation of text and can be used for mischief
603 return preg_replace('/[\\x{200b}-\\x{200f}\\x{202a}-\\x{202e}]/u', '', $text);
607 * Partial notice markup rendering step: build links to !group references.
609 * @param string $text partially rendered HTML
610 * @param Profile $author the Profile that is composing the current notice
611 * @param Notice $parent the Notice this is sent in reply to, if any
612 * @return string partially rendered HTML
614 function common_render_content($text, Profile $author, Notice $parent=null)
616 $text = common_render_text($text);
617 $text = common_linkify_mentions($text, $author, $parent);
622 * Finds @-mentions within the partially-rendered text section and
623 * turns them into live links.
625 * Should generally not be called except from common_render_content().
627 * @param string $text partially-rendered HTML
628 * @param Profile $author the Profile that is composing the current notice
629 * @param Notice $parent the Notice this is sent in reply to, if any
630 * @return string partially-rendered HTML
632 function common_linkify_mentions($text, Profile $author, Notice $parent=null)
634 $mentions = common_find_mentions($text, $author, $parent);
636 // We need to go through in reverse order by position,
637 // so our positions stay valid despite our fudging with the
642 foreach ($mentions as $mention)
644 $points[$mention['position']] = $mention;
649 foreach ($points as $position => $mention) {
651 $linkText = common_linkify_mention($mention);
653 $text = substr_replace($text, $linkText, $position, $mention['length']);
659 function common_linkify_mention(array $mention)
663 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
665 $xs = new XMLStringer(false);
667 $attrs = array('href' => $mention['url'],
668 'class' => 'h-card '.$mention['type']);
670 if (!empty($mention['title'])) {
671 $attrs['title'] = $mention['title'];
674 $xs->element('a', $attrs, $mention['text']);
676 $output = $xs->getString();
678 Event::handle('EndLinkifyMention', array($mention, &$output));
685 * Find @-mentions in the given text, using the given notice object as context.
686 * References will be resolved with common_relative_profile() against the user
687 * who posted the notice.
689 * Note the return data format is internal, to be used for building links and
690 * such. Should not be used directly; rather, call common_linkify_mentions().
692 * @param string $text
693 * @param Profile $sender the Profile that is sending the current text
694 * @param Notice $parent the Notice this text is in reply to, if any
700 function common_find_mentions($text, Profile $sender, Notice $parent=null)
704 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
705 // Get the context of the original notice, if any
706 $origMentions = array();
708 // Does it have a parent notice for context?
709 if ($parent instanceof Notice) {
710 $ids = $parent->getReplies(); // replied-to _profile ids_
712 foreach ($ids as $id) {
714 $repliedTo = Profile::getByID($id);
715 $origMentions[$repliedTo->getNickname()] = $repliedTo;
716 } catch (NoResultException $e) {
722 $matches = common_find_mentions_raw($text);
724 foreach ($matches as $match) {
726 $nickname = Nickname::normalize($match[0]);
727 } catch (NicknameException $e) {
728 // Bogus match? Drop it.
732 // Try to get a profile for this nickname.
733 // Start with conversation context, then go to
736 if ($parent instanceof Notice && $parent->getProfile()->getNickname() === $nickname) {
737 $mentioned = $parent->getProfile();
738 } else if (!empty($origMentions) &&
739 array_key_exists($nickname, $origMentions)) {
740 $mentioned = $origMentions[$nickname];
742 // sets to null if no match
743 $mentioned = common_relative_profile($sender, $nickname);
746 if ($mentioned instanceof Profile) {
747 $user = User::getKV('id', $mentioned->id);
750 $url = $mentioned->getUrl();
751 } catch (InvalidUrlException $e) {
752 $url = common_local_url('userbyid', array('id' => $mentioned->getID()));
755 $mention = array('mentioned' => array($mentioned),
758 'position' => $match[1],
759 'length' => mb_strlen($match[0]),
760 'title' => $mentioned->getFullname(),
763 $mentions[] = $mention;
767 // @#tag => mention of all subscriptions tagged 'tag'
769 preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
770 $text, $hmatches, PREG_OFFSET_CAPTURE);
771 foreach ($hmatches[1] as $hmatch) {
772 $tag = common_canonical_tag($hmatch[0]);
773 $plist = Profile_list::getByTaggerAndTag($sender->getID(), $tag);
774 if (!$plist instanceof Profile_list || $plist->private) {
777 $tagged = $sender->getTaggedSubscribers($tag);
779 $url = common_local_url('showprofiletag',
780 array('nickname' => $sender->getNickname(),
783 $mentions[] = array('mentioned' => $tagged,
785 'text' => $hmatch[0],
786 'position' => $hmatch[1],
787 'length' => mb_strlen($hmatch[0]),
791 preg_match_all('/(?:^|[\s\.\,\:\;]+)!(' . Nickname::DISPLAY_FMT . ')/',
792 $text, $hmatches, PREG_OFFSET_CAPTURE);
793 foreach ($hmatches[1] as $hmatch) {
794 $nickname = Nickname::normalize($hmatch[0]);
795 $group = User_group::getForNickname($nickname, $sender);
797 if (!$group instanceof User_group || !$sender->isMember($group)) {
801 $profile = $group->getProfile();
803 $mentions[] = array('mentioned' => array($profile),
805 'text' => $hmatch[0],
806 'position' => $hmatch[1],
807 'length' => mb_strlen($hmatch[0]),
808 'url' => $group->permalink(),
809 'title' => $group->getFancyName());
812 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
819 * Does the actual regex pulls to find @-mentions in text.
820 * Should generally not be called directly; for use in common_find_mentions.
822 * @param string $text
823 * @return array of PCRE match arrays
825 function common_find_mentions_raw($text)
828 preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
831 PREG_OFFSET_CAPTURE);
833 $atmatches = array();
834 preg_match_all('/(?:^|\s+)@(' . Nickname::DISPLAY_FMT . ')\b/',
837 PREG_OFFSET_CAPTURE);
839 $matches = array_merge($tmatches[1], $atmatches[1]);
843 function common_render_text($text)
845 $text = common_remove_unicode_formatting($text);
846 $text = nl2br(htmlspecialchars($text));
848 $text = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $text);
849 $text = common_replace_urls_callback($text, 'common_linkify');
850 $text = preg_replace_callback('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
851 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $text);
857 * Find links in the given text and pass them to the given callback function.
859 * @param string $text
860 * @param function($text, $arg) $callback: return replacement text
861 * @param mixed $arg: optional argument will be passed on to the callback
863 function common_replace_urls_callback($text, $callback, $arg = null) {
864 // Start off with a regex
866 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
869 '(?:'. //Known protocols
871 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|ircs?)://)'.
873 '(?:(?:mailto|aim|tel|xmpp):)'.
875 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
878 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
880 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
884 '|(?:(?:magnet):)'. // URLs without domain name
885 '|(?:(?: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
887 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
889 (common_config('linkify', 'bare_domains')
891 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
892 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
893 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
894 '(?: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)'.
896 : '') . // if common_config('linkify', 'bare_domains') is false, don't add anything here
899 '(?:\:\d+)?'. //:port
900 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
901 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
902 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
903 ')(?<![\?\.\,\#\,])'.
906 //preg_match_all($regex,$text,$matches);
908 return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
912 * Intermediate callback for common_replace_links(), helps resolve some
913 * ambiguous link forms before passing on to the final callback.
915 * @param array $matches
916 * @param callable $callback
917 * @param mixed $arg optional argument to pass on as second param to callback
922 function callback_helper($matches, $callback, $arg=null) {
924 $left = strpos($matches[0],$url);
925 $right = $left+strlen($url);
927 $groupSymbolSets=array(
945 $cannotEndWith=array('.','?',',','#');
949 foreach($groupSymbolSets as $groupSymbolSet){
950 if(substr($url,-1)==$groupSymbolSet['right']){
951 $group_left_count = substr_count($url,$groupSymbolSet['left']);
952 $group_right_count = substr_count($url,$groupSymbolSet['right']);
953 if($group_left_count<$group_right_count){
955 $url=substr($url,0,-1);
959 if(in_array(substr($url,-1),$cannotEndWith)){
961 $url=substr($url,0,-1);
963 }while($original_url!=$url);
965 $result = call_user_func_array($callback, array($url, $arg));
966 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
969 require_once INSTALLDIR . "/lib/curry.php";
971 function common_linkify($url) {
972 // It comes in special'd, so we unspecial it before passing to the stringifying
974 $url = htmlspecialchars_decode($url);
976 if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
977 //url is an email address without the mailto: protocol
978 $canon = "mailto:$url";
979 $longurl = "mailto:$url";
981 $canon = File_redirection::_canonUrl($url);
982 $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
984 if(isset($longurl_data->redir_url)) {
985 $longurl = $longurl_data->redir_url;
988 $longurl = $longurl_data->url;
992 $attrs = array('href' => $longurl, 'title' => $longurl);
994 $is_attachment = false;
995 $attachment_id = null;
998 // Check to see whether this is a known "attachment" URL.
1000 $f = File::getKV('url', $longurl);
1002 if (!$f instanceof File) {
1003 if (common_config('attachments', 'process_links')) {
1004 // XXX: this writes to the database. :<
1006 $f = File::processNew($longurl);
1007 } catch (ServerException $e) {
1013 if ($f instanceof File) {
1015 $enclosure = $f->getEnclosure();
1016 $is_attachment = true;
1017 $attachment_id = $f->id;
1019 $thumb = File_thumbnail::getKV('file_id', $f->id);
1020 $has_thumb = ($thumb instanceof File_thumbnail);
1021 } catch (ServerException $e) {
1022 // There was not enough metadata available
1027 if ($is_attachment) {
1028 $attrs['class'] = 'attachment';
1030 $attrs['class'] = 'attachment thumbnail';
1032 $attrs['id'] = "attachment-{$attachment_id}";
1035 // Whether to nofollow
1037 $nf = common_config('nofollow', 'external');
1039 if ($nf == 'never') {
1040 $attrs['rel'] = 'external';
1042 $attrs['rel'] = 'nofollow external';
1045 return XMLStringer::estring('a', $attrs, $url);
1049 * Find and shorten links in a given chunk of text if it's longer than the
1050 * configured notice content limit (or unconditionally).
1052 * Side effects: may save file and file_redirection records for referenced URLs.
1054 * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1055 * user's options are used; otherwise the current web session user's setitngs
1056 * will be used or ur1.ca if there is no active web login.
1058 * @param string $text
1059 * @param boolean $always (optional)
1060 * @param User $user (optional)
1064 function common_shorten_links($text, $always = false, User $user=null)
1066 if ($user === null) {
1067 $user = common_current_user();
1070 $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1072 if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1073 return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1075 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1080 * Very basic stripping of invalid UTF-8 input text.
1082 * @param string $str
1083 * @return mixed string or null if invalid input
1085 * @todo ideally we should drop bad chars, and maybe do some of the checks
1086 * from common_xml_safe_str. But we can't strip newlines, etc.
1087 * @todo Unicode normalization might also be useful, but not needed now.
1089 function common_validate_utf8($str)
1091 // preg_replace will return NULL on invalid UTF-8 input.
1093 // Note: empty regex //u also caused NULL return on some
1094 // production machines, but none of our test machines.
1096 // This should be replaced with a more reliable check.
1097 return preg_replace('/\x00/u', '', $str);
1101 * Make sure an arbitrary string is safe for output in XML as a single line.
1103 * @param string $str
1106 function common_xml_safe_str($str)
1108 // Replace common eol and extra whitespace input chars
1113 "\0", // null byte eos
1114 "\x0B" // vertical tab
1117 $replacement = array(
1118 ' ', // single space
1125 $str = str_replace($unWelcome, $replacement, $str);
1127 // Neutralize any additional control codes and UTF-16 surrogates
1128 // (Twitter uses '*')
1129 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1132 function common_slugify($str)
1134 // php5-intl is highly recommended...
1135 if (!function_exists('transliterator_transliterate')) {
1136 $str = preg_replace('/[^\pL\pN]/u', '', $str);
1137 $str = mb_convert_case($str, MB_CASE_LOWER, 'UTF-8');
1138 $str = substr($str, 0, 64);
1141 $str = transliterator_transliterate(
1142 'Any-Latin;' . // any charset to latin compatible
1143 'NFD;' . // decompose
1144 '[:Nonspacing Mark:] Remove;' . // remove nonspacing marks (accents etc.)
1145 'NFC;' . // composite again
1146 '[:Punctuation:] Remove;' . // remove punctuation (.,¿? etc.)
1147 'Lower();' . // turn into lowercase
1148 'Latin-ASCII;', // get ASCII equivalents (ð to d for example)
1150 return preg_replace('/[^\pL\pN]/', '', $str);
1153 function common_tag_link($tag)
1155 $canonical = common_canonical_tag($tag);
1156 if (common_config('singleuser', 'enabled')) {
1157 // regular TagAction isn't set up in 1user mode
1158 $nickname = User::singleUserNickname();
1159 $url = common_local_url('showstream',
1160 array('nickname' => $nickname,
1161 'tag' => $canonical));
1163 $url = common_local_url('tag', array('tag' => $canonical));
1165 $xs = new XMLStringer();
1166 $xs->elementStart('span', 'tag');
1167 $xs->element('a', array('href' => $url,
1170 $xs->elementEnd('span');
1171 return $xs->getString();
1174 function common_canonical_tag($tag)
1176 $tag = common_slugify($tag);
1177 $tag = substr($tag, 0, 64);
1181 function common_valid_profile_tag($str)
1183 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1187 * Resolve an ambiguous profile nickname reference, checking in following order:
1188 * - profiles that $sender subscribes to
1189 * - profiles that subscribe to $sender
1190 * - local user profiles
1192 * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1193 * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1196 * @fixme validate input
1198 * @fixme fix or remove mystery third parameter
1199 * @fixme is $sender a User or Profile?
1201 * @param <type> $sender the user or profile in whose context we're looking
1202 * @param string $nickname validated nickname of
1203 * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1205 * @return Profile or null
1207 function common_relative_profile($sender, $nickname, $dt=null)
1209 // Will throw exception on invalid input.
1210 $nickname = Nickname::normalize($nickname);
1212 // Try to find profiles this profile is subscribed to that have this nickname
1213 $recipient = new Profile();
1214 // XXX: use a join instead of a subquery
1215 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1216 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1217 if ($recipient->find(true)) {
1218 // XXX: should probably differentiate between profiles with
1219 // the same name by date of most recent update
1222 // Try to find profiles that listen to this profile and that have this nickname
1223 $recipient = new Profile();
1224 // XXX: use a join instead of a subquery
1225 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1226 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1227 if ($recipient->find(true)) {
1228 // XXX: should probably differentiate between profiles with
1229 // the same name by date of most recent update
1232 // If this is a local user, try to find a local user with that nickname.
1233 $sender = User::getKV('id', $sender->id);
1234 if ($sender instanceof User) {
1235 $recipient_user = User::getKV('nickname', $nickname);
1236 if ($recipient_user instanceof User) {
1237 return $recipient_user->getProfile();
1240 // Otherwise, no links. @messages from local users to remote users,
1241 // or from remote users to other remote users, are just
1242 // outside our ability to make intelligent guesses about
1246 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1248 if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1250 $path = $r->build($action, $args, $params, $fragment);
1252 $ssl = common_config('site', 'ssl') === 'always'
1253 || GNUsocial::isHTTPS()
1254 || common_is_sensitive($action);
1256 if (common_config('site','fancy')) {
1257 $url = common_path($path, $ssl, $addSession);
1259 if (mb_strpos($path, '/index.php') === 0) {
1260 $url = common_path($path, $ssl, $addSession);
1262 $url = common_path('index.php/'.$path, $ssl, $addSession);
1265 Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1270 function common_is_sensitive($action)
1272 static $sensitive = array(
1277 'ApiOAuthRequestToken',
1278 'ApiOAuthAccessToken',
1279 'ApiOAuthAuthorize',
1285 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1286 $ssl = in_array($action, $sensitive);
1292 function common_path($relative, $ssl=false, $addSession=true)
1294 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1296 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1297 || GNUsocial::isHTTPS()
1298 || common_config('site', 'ssl') === 'always') {
1300 if (is_string(common_config('site', 'sslserver')) &&
1301 mb_strlen(common_config('site', 'sslserver')) > 0) {
1302 $serverpart = common_config('site', 'sslserver');
1303 } else if (common_config('site', 'server')) {
1304 $serverpart = common_config('site', 'server');
1306 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1310 if (common_config('site', 'server')) {
1311 $serverpart = common_config('site', 'server');
1313 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1318 $relative = common_inject_session($relative, $serverpart);
1321 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1324 function common_inject_session($url, $serverpart = null)
1326 if (!common_have_session()) {
1330 if (empty($serverpart)) {
1331 $serverpart = parse_url($url, PHP_URL_HOST);
1334 $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1336 // Are we pointing to another server (like an SSL server?)
1338 if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1339 // Pass the session ID as a GET parameter
1340 $sesspart = session_name() . '=' . session_id();
1341 $i = strpos($url, '?');
1342 if ($i === false) { // no GET params, just append
1343 $url .= '?' . $sesspart;
1345 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1352 function common_date_string($dt)
1354 // XXX: do some sexy date formatting
1355 // return date(DATE_RFC822, $dt);
1356 $t = strtotime($dt);
1360 if ($now < $t) { // that shouldn't happen!
1361 return common_exact_date($dt);
1362 } else if ($diff < 60) {
1363 // TRANS: Used in notices to indicate when the notice was made compared to now.
1364 return _('a few seconds ago');
1365 } else if ($diff < 92) {
1366 // TRANS: Used in notices to indicate when the notice was made compared to now.
1367 return _('about a minute ago');
1368 } else if ($diff < 3300) {
1369 $minutes = round($diff/60);
1370 // TRANS: Used in notices to indicate when the notice was made compared to now.
1371 return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1372 } else if ($diff < 5400) {
1373 // TRANS: Used in notices to indicate when the notice was made compared to now.
1374 return _('about an hour ago');
1375 } else if ($diff < 22 * 3600) {
1376 $hours = round($diff/3600);
1377 // TRANS: Used in notices to indicate when the notice was made compared to now.
1378 return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1379 } else if ($diff < 37 * 3600) {
1380 // TRANS: Used in notices to indicate when the notice was made compared to now.
1381 return _('about a day ago');
1382 } else if ($diff < 24 * 24 * 3600) {
1383 $days = round($diff/(24*3600));
1384 // TRANS: Used in notices to indicate when the notice was made compared to now.
1385 return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1386 } else if ($diff < 46 * 24 * 3600) {
1387 // TRANS: Used in notices to indicate when the notice was made compared to now.
1388 return _('about a month ago');
1389 } else if ($diff < 330 * 24 * 3600) {
1390 $months = round($diff/(30*24*3600));
1391 // TRANS: Used in notices to indicate when the notice was made compared to now.
1392 return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1393 } else if ($diff < 480 * 24 * 3600) {
1394 // TRANS: Used in notices to indicate when the notice was made compared to now.
1395 return _('about a year ago');
1397 return common_exact_date($dt);
1401 function common_exact_date($dt)
1407 $_utc = new DateTimeZone('UTC');
1408 $_siteTz = new DateTimeZone(common_timezone());
1411 $dateStr = date('d F Y H:i:s', strtotime($dt));
1412 $d = new DateTime($dateStr, $_utc);
1413 $d->setTimezone($_siteTz);
1414 // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
1415 return $d->format(_('l, d-M-Y H:i:s T'));
1418 function common_date_w3dtf($dt)
1420 $dateStr = date('d F Y H:i:s', strtotime($dt));
1421 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1422 $d->setTimezone(new DateTimeZone(common_timezone()));
1423 return $d->format(DATE_W3C);
1426 function common_date_rfc2822($dt)
1428 $dateStr = date('d F Y H:i:s', strtotime($dt));
1429 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1430 $d->setTimezone(new DateTimeZone(common_timezone()));
1431 return $d->format('r');
1434 function common_date_iso8601($dt)
1436 $dateStr = date('d F Y H:i:s', strtotime($dt));
1437 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1438 $d->setTimezone(new DateTimeZone(common_timezone()));
1439 return $d->format('c');
1442 function common_sql_now()
1444 return common_sql_date(time());
1447 function common_sql_date($datetime)
1449 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1453 * Return an SQL fragment to calculate an age-based weight from a given
1454 * timestamp or datetime column.
1456 * @param string $column name of field we're comparing against current time
1457 * @param integer $dropoff divisor for age in seconds before exponentiation
1458 * @return string SQL fragment
1460 function common_sql_weight($column, $dropoff)
1462 if (common_config('db', 'type') == 'pgsql') {
1463 // PostgreSQL doesn't support timestampdiff function.
1464 // @fixme will this use the right time zone?
1465 // @fixme does this handle cross-year subtraction correctly?
1466 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1468 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1472 function common_redirect($url, $code=307)
1474 static $status = array(301 => "Moved Permanently",
1477 307 => "Temporary Redirect");
1479 header('HTTP/1.1 '.$code.' '.$status[$code]);
1480 header("Location: $url");
1481 header("Connection: close");
1483 $xo = new XMLOutputter();
1485 '-//W3C//DTD XHTML 1.0 Strict//EN',
1486 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1487 $xo->element('a', array('href' => $url), $url);
1492 // Stick the notice on the queue
1494 function common_enqueue_notice($notice)
1496 static $localTransports = array('ping');
1498 $transports = array();
1499 if (common_config('sms', 'enabled')) {
1500 $transports[] = 'sms';
1502 if (Event::hasHandler('HandleQueuedNotice')) {
1503 $transports[] = 'plugin';
1506 // We can skip these for gatewayed notices.
1507 if ($notice->isLocal()) {
1508 $transports = array_merge($transports, $localTransports);
1511 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1513 $qm = QueueManager::get();
1515 foreach ($transports as $transport)
1517 $qm->enqueue($notice, $transport);
1520 Event::handle('EndEnqueueNotice', array($notice, $transports));
1526 function common_profile_url($nickname)
1528 return common_local_url('showstream', array('nickname' => $nickname),
1533 * Should make up a reasonable root URL
1535 function common_root_url($ssl=false)
1537 $url = common_path('', $ssl, false);
1538 $i = strpos($url, '?');
1540 $url = substr($url, 0, $i);
1546 * returns $bytes bytes of raw random data
1548 function common_random_rawstr($bytes)
1550 $rawstr = @file_exists('/dev/urandom')
1551 ? common_urandom($bytes)
1552 : common_mtrand($bytes);
1558 * returns $bytes bytes of random data as a hexadecimal string
1560 function common_random_hexstr($bytes)
1562 $str = common_random_rawstr($bytes);
1565 for ($i = 0; $i < $bytes; $i++) {
1566 $hexstr .= sprintf("%02x", ord($str[$i]));
1571 function common_urandom($bytes)
1573 $h = fopen('/dev/urandom', 'rb');
1575 $src = fread($h, $bytes);
1580 function common_mtrand($bytes)
1583 for ($i = 0; $i < $bytes; $i++) {
1584 $str .= chr(mt_rand(0, 255));
1590 * Record the given URL as the return destination for a future
1591 * form submission, to be read by common_get_returnto().
1593 * @param string $url
1595 * @fixme as a session-global setting, this can allow multiple forms
1596 * to conflict and overwrite each others' returnto destinations if
1597 * the user has multiple tabs or windows open.
1599 * Should refactor to index with a token or otherwise only pass the
1600 * data along its intended path.
1602 function common_set_returnto($url)
1604 common_ensure_session();
1605 $_SESSION['returnto'] = $url;
1609 * Fetch a return-destination URL previously recorded by
1610 * common_set_returnto().
1612 * @return mixed URL string or null
1614 * @fixme as a session-global setting, this can allow multiple forms
1615 * to conflict and overwrite each others' returnto destinations if
1616 * the user has multiple tabs or windows open.
1618 * Should refactor to index with a token or otherwise only pass the
1619 * data along its intended path.
1621 function common_get_returnto()
1623 common_ensure_session();
1624 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1627 function common_timestamp()
1629 return date('YmdHis');
1632 function common_ensure_syslog()
1634 static $initialized = false;
1635 if (!$initialized) {
1636 openlog(common_config('syslog', 'appname'), 0,
1637 common_config('syslog', 'facility'));
1638 $initialized = true;
1642 function common_log_line($priority, $msg)
1644 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1645 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1646 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1649 function common_request_id()
1652 $server = common_config('site', 'server');
1653 if (php_sapi_name() == 'cli') {
1654 $script = basename($_SERVER['PHP_SELF']);
1655 return "$server:$script:$pid";
1657 static $req_id = null;
1658 if (!isset($req_id)) {
1659 $req_id = substr(md5(mt_rand()), 0, 8);
1661 if (isset($_SERVER['REQUEST_URI'])) {
1662 $url = $_SERVER['REQUEST_URI'];
1664 $method = $_SERVER['REQUEST_METHOD'];
1665 return "$server:$pid.$req_id $method $url";
1669 function common_log($priority, $msg, $filename=null)
1671 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1672 $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1673 $msg = '[' . common_request_id() . '] ' . $msg;
1674 $logfile = common_config('site', 'logfile');
1676 $log = fopen($logfile, "a");
1678 $output = common_log_line($priority, $msg);
1679 fwrite($log, $output);
1683 common_ensure_syslog();
1684 syslog($priority, $msg);
1686 Event::handle('EndLog', array($priority, $msg, $filename));
1690 function common_debug($msg, $filename=null)
1693 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1695 common_log(LOG_DEBUG, $msg);
1699 function common_log_db_error(&$object, $verb, $filename=null)
1703 $objstr = common_log_objstring($object);
1704 $last_error = &$_PEAR->getStaticProperty('DB_DataObject','lastError');
1705 if (is_object($last_error)) {
1706 $msg = $last_error->message;
1708 $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1710 common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1713 function common_log_objstring(&$object)
1715 if (is_null($object)) {
1718 if (!($object instanceof DB_DataObject)) {
1721 $arr = $object->toArray();
1723 foreach ($arr as $k => $v) {
1724 if (is_object($v)) {
1725 $fields[] = "$k='".get_class($v)."'";
1727 $fields[] = "$k='$v'";
1730 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1734 function common_valid_http_url($url, $secure=false)
1736 // If $secure is true, only allow https URLs to pass
1737 // (if false, we use '?' in 'https?' to say the 's' is optional)
1738 $regex = $secure ? '/^https$/' : '/^https?$/';
1739 return filter_var($url, FILTER_VALIDATE_URL)
1740 && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1743 function common_valid_tag($tag)
1745 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1746 return (Validate::email($matches[1]) ||
1747 preg_match('/^([\w-\.]+)$/', $matches[1]));
1753 * Determine if given domain or address literal is valid
1754 * eg for use in JIDs and URLs. Does not check if the domain
1757 * @param string $domain
1758 * @return boolean valid or not
1760 function common_valid_domain($domain)
1762 $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1763 $ipv4 = "(?:$octet(?:\.$octet){3})";
1764 if (preg_match("/^$ipv4$/u", $domain)) return true;
1766 $group = "(?:[0-9a-f]{1,4})";
1767 $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1769 if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1770 $before = explode(":", $matches[1]);
1771 $zeroes = $matches[2];
1772 $after = explode(":", $matches[3]);
1780 $explicit = count($before) + count($after);
1781 if ($explicit < $min || $explicit > $max) {
1788 require_once "Net/IDNA.php";
1789 $idn = Net_IDNA::getInstance();
1790 $domain = $idn->encode($domain);
1791 } catch (Exception $e) {
1795 $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1796 $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1798 return preg_match("/^$fqdn$/ui", $domain);
1801 /* Following functions are copied from MediaWiki GlobalFunctions.php
1802 * and written by Evan Prodromou. */
1804 function common_accept_to_prefs($accept, $def = '*/*')
1806 // No arg means accept anything (per HTTP spec)
1808 return array($def => 1);
1813 $parts = explode(',', $accept);
1815 foreach($parts as $part) {
1816 // FIXME: doesn't deal with params like 'text/html; level=1'
1817 @list($value, $qpart) = explode(';', trim($part));
1819 if(!isset($qpart)) {
1821 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1822 $prefs[$value] = $match[1];
1829 // Match by our supported file extensions
1830 function common_supported_ext_to_mime($fileext)
1832 // Accept a filename and take out the extension
1833 if (strpos($fileext, '.') !== false) {
1834 $fileext = substr(strrchr($fileext, '.'), 1);
1837 $supported = common_config('attachments', 'supported');
1838 foreach($supported as $type => $ext) {
1839 if ($ext === $fileext) {
1844 throw new ServerException('Unsupported file extension');
1847 // Match by our supported mime types
1848 function common_supported_mime_to_ext($mimetype)
1850 $supported = common_config('attachments', 'supported');
1851 foreach($supported as $type => $ext) {
1852 if ($mimetype === $type) {
1857 throw new ServerException('Unsupported MIME type');
1860 // The MIME "media" is the part before the slash (video in video/webm)
1861 function common_get_mime_media($type)
1863 $tmp = explode('/', $type);
1864 return strtolower($tmp[0]);
1867 // Get only the mimetype and not additional info (separated from bare mime with semi-colon)
1868 function common_bare_mime($mimetype)
1870 $mimetype = mb_strtolower($mimetype);
1871 if ($semicolon = mb_strpos($mimetype, ';')) {
1872 $mimetype = mb_substr($mimetype, 0, $semicolon);
1877 function common_mime_type_match($type, $avail)
1879 if(array_key_exists($type, $avail)) {
1882 $parts = explode('/', $type);
1883 if(array_key_exists($parts[0] . '/*', $avail)) {
1884 return $parts[0] . '/*';
1885 } elseif(array_key_exists('*/*', $avail)) {
1893 function common_negotiate_type($cprefs, $sprefs)
1897 foreach(array_keys($sprefs) as $type) {
1898 $parts = explode('/', $type);
1899 if($parts[1] != '*') {
1900 $ckey = common_mime_type_match($type, $cprefs);
1902 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1907 foreach(array_keys($cprefs) as $type) {
1908 $parts = explode('/', $type);
1909 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1910 $skey = common_mime_type_match($type, $sprefs);
1912 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1918 $besttype = 'text/html';
1920 foreach(array_keys($combine) as $type) {
1921 if($combine[$type] > $bestq) {
1923 $bestq = $combine[$type];
1927 if ('text/html' === $besttype) {
1928 return "text/html; charset=utf-8";
1933 function common_config($main, $sub=null)
1936 if (is_null($sub)) {
1937 // Return the config category array
1938 return array_key_exists($main, $config) ? $config[$main] : array();
1940 // Return the config value
1941 return (array_key_exists($main, $config) &&
1942 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1945 function common_config_set($main, $sub, $value)
1948 if (!array_key_exists($main, $config)) {
1949 $config[$main] = array();
1951 $config[$main][$sub] = $value;
1954 function common_config_append($main, $sub, $value)
1957 if (!array_key_exists($main, $config)) {
1958 $config[$main] = array();
1960 if (!array_key_exists($sub, $config[$main])) {
1961 $config[$main][$sub] = array();
1963 if (!is_array($config[$main][$sub])) {
1964 $config[$main][$sub] = array($config[$main][$sub]);
1966 array_push($config[$main][$sub], $value);
1970 * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
1971 * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
1973 * @param array $from
1976 function common_copy_args($from)
1979 $strip = get_magic_quotes_gpc();
1980 foreach ($from as $k => $v) {
1982 $to[$k] = common_copy_args($v);
1985 $v = stripslashes($v);
1987 $to[$k] = strval(common_validate_utf8($v));
1994 * Neutralise the evil effects of magic_quotes_gpc in the current request.
1995 * This is used before handing a request off to OAuthRequest::from_request.
1996 * @fixme Doesn't consider vars other than _POST and _GET?
1997 * @fixme Can't be undone and could corrupt data if run twice.
1999 function common_remove_magic_from_request()
2001 if(get_magic_quotes_gpc()) {
2002 $_POST=array_map('stripslashes',$_POST);
2003 $_GET=array_map('stripslashes',$_GET);
2007 function common_user_uri(&$user)
2009 return common_local_url('userbyid', array('id' => $user->id),
2013 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2015 function common_confirmation_code($bits)
2017 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2018 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
2019 $chars = ceil($bits/5);
2021 for ($i = 0; $i < $chars; $i++) {
2022 // XXX: convert to string and back
2023 $num = hexdec(common_random_hexstr(1));
2024 // XXX: randomness is too precious to throw away almost
2025 // 40% of the bits we get!
2026 $code .= $codechars[$num%32];
2031 // convert markup to HTML
2032 function common_markup_to_html($c, $args=null)
2038 if (is_null($args)) {
2042 // XXX: not very efficient
2044 foreach ($args as $name => $value) {
2045 $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
2048 $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
2049 $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
2050 $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
2051 $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
2053 return \Michelf\Markdown::defaultTransform($c);
2056 function common_user_property($property)
2058 $profile = Profile::current();
2060 if (empty($profile)) {
2064 switch ($property) {
2070 return $profile->$property;
2074 return $profile->getAvatar(AVATAR_STREAM_SIZE);
2075 } catch (Exception $e) {
2080 return $profile->getBestName();
2087 function common_profile_uri($profile)
2091 if (!empty($profile)) {
2092 if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2093 $user = User::getKV('id', $profile->id);
2094 if ($user instanceof User) {
2095 $uri = $user->getUri();
2097 Event::handle('EndCommonProfileURI', array($profile, &$uri));
2101 // XXX: this is a very bad profile!
2105 function common_canonical_sms($sms)
2108 preg_replace('/\D/', '', $sms);
2112 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2117 case E_COMPILE_ERROR:
2121 case E_RECOVERABLE_ERROR:
2122 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2127 case E_COMPILE_WARNING:
2128 case E_CORE_WARNING:
2129 case E_USER_WARNING:
2130 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2135 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2140 case E_USER_DEPRECATED:
2141 // XXX: config variable to log this stuff, too
2145 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2150 // FIXME: show error page if we're on the Web
2151 /* Don't execute PHP internal error handler */
2155 function common_session_token()
2157 common_ensure_session();
2158 if (!array_key_exists('token', $_SESSION)) {
2159 $_SESSION['token'] = common_random_hexstr(64);
2161 return $_SESSION['token'];
2164 function common_license_terms($uri)
2166 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2167 return explode('-',$matches[1]);
2172 function common_compatible_license($from, $to)
2174 $from_terms = common_license_terms($from);
2175 // public domain and cc-by are compatible with everything
2176 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2179 $to_terms = common_license_terms($to);
2180 // sa is compatible across versions. IANAL
2181 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2182 return count(array_diff($from_terms, $to_terms)) == 0;
2184 // XXX: better compatibility check needed here!
2185 // Should at least normalise URIs
2186 return ($from == $to);
2190 * returns a quoted table name, if required according to config
2192 function common_database_tablename($tablename)
2194 if(common_config('db','quote_identifiers')) {
2195 $tablename = '"'. $tablename .'"';
2197 //table prefixes could be added here later
2202 * Shorten a URL with the current user's configured shortening service,
2203 * or ur1.ca if configured, or not at all if no shortening is set up.
2205 * @param string $long_url original URL
2206 * @param User $user to specify a particular user's options
2207 * @param boolean $force Force shortening (used when notice is too long)
2208 * @return string may return the original URL if shortening failed
2210 * @fixme provide a way to specify a particular shortener
2212 function common_shorten_url($long_url, User $user=null, $force = false)
2214 $long_url = trim($long_url);
2216 $user = common_current_user();
2218 $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2220 // $force forces shortening even if it's not strictly needed
2221 // I doubt URL shortening is ever 'strictly' needed. - ESP
2223 if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2227 $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2229 if (Event::handle('StartShortenUrl',
2230 array($long_url, $shortenerName, &$shortenedUrl))) {
2231 if ($shortenerName == 'internal') {
2233 $f = File::processNew($long_url);
2234 $shortenedUrl = common_local_url('redirecturl', array('id' => $f->id));
2235 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2236 return $shortenedUrl;
2240 } catch (ServerException $e) {
2247 //URL was shortened, so return the result
2248 return trim($shortenedUrl);
2253 * @return mixed array($proxy, $ip) for web requests; proxy may be null
2254 * null if not a web request
2256 * @fixme X-Forwarded-For can be chained by multiple proxies;
2257 we should parse the list and provide a cleaner array
2258 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2259 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2260 * use function to get exact request headers from Apache if possible.
2262 function common_client_ip()
2264 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2268 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2269 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2270 $proxy = $_SERVER['HTTP_CLIENT_IP'];
2272 $proxy = $_SERVER['REMOTE_ADDR'];
2274 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2277 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2278 $ip = $_SERVER['HTTP_CLIENT_IP'];
2280 $ip = $_SERVER['REMOTE_ADDR'];
2284 return array($proxy, $ip);
2287 function common_url_to_nickname($url)
2289 static $bad = array('query', 'user', 'password', 'port', 'fragment');
2291 $parts = parse_url($url);
2293 // If any of these parts exist, this won't work
2295 foreach ($bad as $badpart) {
2296 if (array_key_exists($badpart, $parts)) {
2301 // We just have host and/or path
2303 // If it's just a host...
2304 if (array_key_exists('host', $parts) &&
2305 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2307 $hostparts = explode('.', $parts['host']);
2309 // Try to catch common idiom of nickname.service.tld
2311 if ((count($hostparts) > 2) &&
2312 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2313 (strcmp($hostparts[0], 'www') != 0))
2315 return common_nicknamize($hostparts[0]);
2317 // Do the whole hostname
2318 return common_nicknamize($parts['host']);
2321 if (array_key_exists('path', $parts)) {
2322 // Strip starting, ending slashes
2323 $path = preg_replace('@/$@', '', $parts['path']);
2324 $path = preg_replace('@^/@', '', $path);
2325 $path = basename($path);
2327 // Hack for MediaWiki user pages, in the form:
2328 // http://example.com/wiki/User:Myname
2329 // ('User' may be localized.)
2330 if (strpos($path, ':')) {
2331 $parts = array_filter(explode(':', $path));
2332 $path = $parts[count($parts) - 1];
2336 return common_nicknamize($path);
2344 function common_nicknamize($str)
2347 return Nickname::normalize($str);
2348 } catch (NicknameException $e) {
2353 function common_perf_counter($key, $val=null)
2355 global $_perfCounters;
2356 if (isset($_perfCounters)) {
2357 if (common_config('site', 'logperf')) {
2358 if (array_key_exists($key, $_perfCounters)) {
2359 $_perfCounters[$key][] = $val;
2361 $_perfCounters[$key] = array($val);
2363 if (common_config('site', 'logperf_detail')) {
2364 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2370 function common_log_perf_counters()
2372 if (common_config('site', 'logperf')) {
2373 global $_startTime, $_perfCounters;
2375 if (isset($_startTime)) {
2376 $endTime = microtime(true);
2377 $diff = round(($endTime - $_startTime) * 1000);
2378 common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2380 $counters = $_perfCounters;
2382 foreach ($counters as $key => $values) {
2383 $count = count($values);
2384 $unique = count(array_unique($values));
2385 common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2390 function common_is_email($str)
2392 return (strpos($str, '@') !== false);
2395 function common_init_stats()
2399 $_mem = memory_get_usage(true);
2400 $_ts = microtime(true);
2403 function common_log_delta($comment=null)
2410 $_mem = memory_get_usage(true);
2411 $_ts = microtime(true);
2413 $mtotal = $_mem - $mold;
2414 $ttotal = $_ts - $told;
2416 if (empty($comment)) {
2420 common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
2423 function common_strip_html($html, $trim=true, $save_whitespace=false)
2425 if (!$save_whitespace) {
2426 $html = preg_replace('/\s+/', ' ', $html);
2428 $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
2429 return $trim ? trim($text) : $text;
2432 function html_sprintf()
2434 $args = func_get_args();
2435 for ($i=1; $i<count($args); $i++) {
2436 $args[$i] = htmlspecialchars($args[$i]);
2438 return call_user_func_array('sprintf', $args);