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 Notice $notice in whose context we're working
611 * @return string partially rendered HTML
613 function common_render_content($text, Notice $notice)
615 $text = common_render_text($text);
616 $text = common_linkify_mentions($text, $notice);
621 * Finds @-mentions within the partially-rendered text section and
622 * turns them into live links.
624 * Should generally not be called except from common_render_content().
626 * @param string $text partially-rendered HTML
627 * @param Notice $notice in-progress or complete Notice object for context
628 * @return string partially-rendered HTML
630 function common_linkify_mentions($text, Notice $notice)
632 $mentions = common_find_mentions($text, $notice);
634 // We need to go through in reverse order by position,
635 // so our positions stay valid despite our fudging with the
640 foreach ($mentions as $mention)
642 $points[$mention['position']] = $mention;
647 foreach ($points as $position => $mention) {
649 $linkText = common_linkify_mention($mention);
651 $text = substr_replace($text, $linkText, $position, $mention['length']);
657 function common_linkify_mention(array $mention)
661 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
663 $xs = new XMLStringer(false);
665 $attrs = array('href' => $mention['url'],
666 'class' => 'h-card '.$mention['type']);
668 if (!empty($mention['title'])) {
669 $attrs['title'] = $mention['title'];
672 $xs->element('a', $attrs, $mention['text']);
674 $output = $xs->getString();
676 Event::handle('EndLinkifyMention', array($mention, &$output));
683 * Find @-mentions in the given text, using the given notice object as context.
684 * References will be resolved with common_relative_profile() against the user
685 * who posted the notice.
687 * Note the return data format is internal, to be used for building links and
688 * such. Should not be used directly; rather, call common_linkify_mentions().
690 * @param string $text
691 * @param Notice $notice notice in whose context we're building links
697 function common_find_mentions($text, Notice $notice)
699 // The getProfile call throws NoProfileException on failure
700 $sender = $notice->getProfile();
704 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
705 // Get the context of the original notice, if any
708 $origMentions = array();
713 $origNotice = $notice->getParent();
714 $origAuthor = $origNotice->getProfile();
716 $ids = $origNotice->getReplies();
718 foreach ($ids as $id) {
720 $repliedTo = Profile::getByID($id);
721 $origMentions[$repliedTo->getNickname()] = $repliedTo;
722 } catch (NoResultException $e) {
726 } catch (NoParentNoticeException $e) {
727 // It wasn't a reply to anything, so we can't harvest nickname-relations.
728 } catch (NoResultException $e) {
729 // The parent notice was deleted.
732 $matches = common_find_mentions_raw($text);
734 foreach ($matches as $match) {
736 $nickname = Nickname::normalize($match[0]);
737 } catch (NicknameException $e) {
738 // Bogus match? Drop it.
742 // Try to get a profile for this nickname.
743 // Start with conversation context, then go to
746 if ($origAuthor instanceof Profile && $origAuthor->nickname == $nickname) {
747 $mentioned = $origAuthor;
748 } else if (!empty($origMentions) &&
749 array_key_exists($nickname, $origMentions)) {
750 $mentioned = $origMentions[$nickname];
752 $mentioned = common_relative_profile($sender, $nickname);
755 if ($mentioned instanceof Profile) {
756 $user = User::getKV('id', $mentioned->id);
758 if ($user instanceof User) {
759 $url = common_local_url('userbyid', array('id' => $user->id));
761 $url = $mentioned->profileurl;
764 $mention = array('mentioned' => array($mentioned),
767 'position' => $match[1],
768 'length' => mb_strlen($match[0]),
771 if (!empty($mentioned->fullname)) {
772 $mention['title'] = $mentioned->fullname;
775 $mentions[] = $mention;
779 // @#tag => mention of all subscriptions tagged 'tag'
781 preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
782 $text, $hmatches, PREG_OFFSET_CAPTURE);
783 foreach ($hmatches[1] as $hmatch) {
784 $tag = common_canonical_tag($hmatch[0]);
785 $plist = Profile_list::getByTaggerAndTag($sender->id, $tag);
786 if (!$plist instanceof Profile_list || $plist->private) {
789 $tagged = $sender->getTaggedSubscribers($tag);
791 $url = common_local_url('showprofiletag',
792 array('nickname' => $sender->getNickname(),
795 $mentions[] = array('mentioned' => $tagged,
797 'text' => $hmatch[0],
798 'position' => $hmatch[1],
799 'length' => mb_strlen($hmatch[0]),
803 preg_match_all('/(?:^|[\s\.\,\:\;]+)!(' . Nickname::DISPLAY_FMT . ')/',
804 $text, $hmatches, PREG_OFFSET_CAPTURE);
805 foreach ($hmatches[1] as $hmatch) {
806 $nickname = Nickname::normalize($hmatch[0]);
807 $group = User_group::getForNickname($nickname, $sender);
809 if (!$group instanceof User_group || !$sender->isMember($group)) {
813 $profile = $group->getProfile();
815 $mentions[] = array('mentioned' => array($profile),
817 'text' => $hmatch[0],
818 'position' => $hmatch[1],
819 'length' => mb_strlen($hmatch[0]),
820 'url' => $group->permalink(),
821 'title' => $group->getFancyName());
824 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
831 * Does the actual regex pulls to find @-mentions in text.
832 * Should generally not be called directly; for use in common_find_mentions.
834 * @param string $text
835 * @return array of PCRE match arrays
837 function common_find_mentions_raw($text)
840 preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
843 PREG_OFFSET_CAPTURE);
845 $atmatches = array();
846 preg_match_all('/(?:^|\s+)@(' . Nickname::DISPLAY_FMT . ')\b/',
849 PREG_OFFSET_CAPTURE);
851 $matches = array_merge($tmatches[1], $atmatches[1]);
855 function common_render_text($text)
857 $text = common_remove_unicode_formatting($text);
858 $text = nl2br(htmlspecialchars($text));
860 $text = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $text);
861 $text = common_replace_urls_callback($text, 'common_linkify');
862 $text = preg_replace_callback('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
863 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $text);
869 * Find links in the given text and pass them to the given callback function.
871 * @param string $text
872 * @param function($text, $arg) $callback: return replacement text
873 * @param mixed $arg: optional argument will be passed on to the callback
875 function common_replace_urls_callback($text, $callback, $arg = null) {
876 // Start off with a regex
878 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
881 '(?:'. //Known protocols
883 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|ircs?)://)'.
885 '(?:(?:mailto|aim|tel|xmpp):)'.
887 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
890 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
892 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
896 '|(?:(?:magnet):)'. // URLs without domain name
897 '|(?:(?: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
899 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
901 (common_config('linkify', 'bare_domains')
903 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
904 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
905 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
906 '(?: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)'.
908 : '') . // if common_config('linkify', 'bare_domains') is false, don't add anything here
911 '(?:\:\d+)?'. //:port
912 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
913 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
914 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
915 ')(?<![\?\.\,\#\,])'.
918 //preg_match_all($regex,$text,$matches);
920 return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
924 * Intermediate callback for common_replace_links(), helps resolve some
925 * ambiguous link forms before passing on to the final callback.
927 * @param array $matches
928 * @param callable $callback
929 * @param mixed $arg optional argument to pass on as second param to callback
934 function callback_helper($matches, $callback, $arg=null) {
936 $left = strpos($matches[0],$url);
937 $right = $left+strlen($url);
939 $groupSymbolSets=array(
957 $cannotEndWith=array('.','?',',','#');
961 foreach($groupSymbolSets as $groupSymbolSet){
962 if(substr($url,-1)==$groupSymbolSet['right']){
963 $group_left_count = substr_count($url,$groupSymbolSet['left']);
964 $group_right_count = substr_count($url,$groupSymbolSet['right']);
965 if($group_left_count<$group_right_count){
967 $url=substr($url,0,-1);
971 if(in_array(substr($url,-1),$cannotEndWith)){
973 $url=substr($url,0,-1);
975 }while($original_url!=$url);
977 $result = call_user_func_array($callback, array($url, $arg));
978 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
981 require_once INSTALLDIR . "/lib/curry.php";
983 function common_linkify($url) {
984 // It comes in special'd, so we unspecial it before passing to the stringifying
986 $url = htmlspecialchars_decode($url);
988 if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
989 //url is an email address without the mailto: protocol
990 $canon = "mailto:$url";
991 $longurl = "mailto:$url";
993 $canon = File_redirection::_canonUrl($url);
994 $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
995 $longurl = $longurl_data->url;
998 $attrs = array('href' => $canon, 'title' => $longurl);
1000 $is_attachment = false;
1001 $attachment_id = null;
1004 // Check to see whether this is a known "attachment" URL.
1006 $f = File::getKV('url', $longurl);
1008 if (!$f instanceof File) {
1009 if (common_config('attachments', 'process_links')) {
1010 // XXX: this writes to the database. :<
1012 $f = File::processNew($longurl);
1013 } catch (ServerException $e) {
1019 if ($f instanceof File) {
1021 $enclosure = $f->getEnclosure();
1022 $is_attachment = true;
1023 $attachment_id = $f->id;
1025 $thumb = File_thumbnail::getKV('file_id', $f->id);
1026 $has_thumb = ($thumb instanceof File_thumbnail);
1027 } catch (ServerException $e) {
1028 // There was not enough metadata available
1033 if ($is_attachment) {
1034 $attrs['class'] = 'attachment';
1036 $attrs['class'] = 'attachment thumbnail';
1038 $attrs['id'] = "attachment-{$attachment_id}";
1041 // Whether to nofollow
1043 $nf = common_config('nofollow', 'external');
1045 if ($nf == 'never') {
1046 $attrs['rel'] = 'external';
1048 $attrs['rel'] = 'nofollow external';
1051 return XMLStringer::estring('a', $attrs, $url);
1055 * Find and shorten links in a given chunk of text if it's longer than the
1056 * configured notice content limit (or unconditionally).
1058 * Side effects: may save file and file_redirection records for referenced URLs.
1060 * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1061 * user's options are used; otherwise the current web session user's setitngs
1062 * will be used or ur1.ca if there is no active web login.
1064 * @param string $text
1065 * @param boolean $always (optional)
1066 * @param User $user (optional)
1070 function common_shorten_links($text, $always = false, User $user=null)
1072 if ($user === null) {
1073 $user = common_current_user();
1076 $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1078 if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1079 return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1081 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1086 * Very basic stripping of invalid UTF-8 input text.
1088 * @param string $str
1089 * @return mixed string or null if invalid input
1091 * @todo ideally we should drop bad chars, and maybe do some of the checks
1092 * from common_xml_safe_str. But we can't strip newlines, etc.
1093 * @todo Unicode normalization might also be useful, but not needed now.
1095 function common_validate_utf8($str)
1097 // preg_replace will return NULL on invalid UTF-8 input.
1099 // Note: empty regex //u also caused NULL return on some
1100 // production machines, but none of our test machines.
1102 // This should be replaced with a more reliable check.
1103 return preg_replace('/\x00/u', '', $str);
1107 * Make sure an arbitrary string is safe for output in XML as a single line.
1109 * @param string $str
1112 function common_xml_safe_str($str)
1114 // Replace common eol and extra whitespace input chars
1119 "\0", // null byte eos
1120 "\x0B" // vertical tab
1123 $replacement = array(
1124 ' ', // single space
1131 $str = str_replace($unWelcome, $replacement, $str);
1133 // Neutralize any additional control codes and UTF-16 surrogates
1134 // (Twitter uses '*')
1135 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1138 function common_slugify($str)
1140 // php5-intl is highly recommended...
1141 if (!function_exists('transliterator_transliterate')) {
1142 $str = preg_replace('/[^\pL\pN]/u', '', $str);
1143 $str = mb_convert_case($str, MB_CASE_LOWER, 'UTF-8');
1144 $str = substr($str, 0, 64);
1147 $str = transliterator_transliterate(
1148 'Any-Latin;' . // any charset to latin compatible
1149 'NFD;' . // decompose
1150 '[:Nonspacing Mark:] Remove;' . // remove nonspacing marks (accents etc.)
1151 'NFC;' . // composite again
1152 '[:Punctuation:] Remove;' . // remove punctuation (.,¿? etc.)
1153 'Lower();' . // turn into lowercase
1154 'Latin-ASCII;', // get ASCII equivalents (ð to d for example)
1156 return preg_replace('/[^\pL\pN]/', '', $str);
1159 function common_tag_link($tag)
1161 $canonical = common_canonical_tag($tag);
1162 if (common_config('singleuser', 'enabled')) {
1163 // regular TagAction isn't set up in 1user mode
1164 $nickname = User::singleUserNickname();
1165 $url = common_local_url('showstream',
1166 array('nickname' => $nickname,
1167 'tag' => $canonical));
1169 $url = common_local_url('tag', array('tag' => $canonical));
1171 $xs = new XMLStringer();
1172 $xs->elementStart('span', 'tag');
1173 $xs->element('a', array('href' => $url,
1176 $xs->elementEnd('span');
1177 return $xs->getString();
1180 function common_canonical_tag($tag)
1182 $tag = common_slugify($tag);
1183 $tag = substr($tag, 0, 64);
1187 function common_valid_profile_tag($str)
1189 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1193 * Resolve an ambiguous profile nickname reference, checking in following order:
1194 * - profiles that $sender subscribes to
1195 * - profiles that subscribe to $sender
1196 * - local user profiles
1198 * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1199 * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1202 * @fixme validate input
1204 * @fixme fix or remove mystery third parameter
1205 * @fixme is $sender a User or Profile?
1207 * @param <type> $sender the user or profile in whose context we're looking
1208 * @param string $nickname validated nickname of
1209 * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1211 * @return Profile or null
1213 function common_relative_profile($sender, $nickname, $dt=null)
1215 // Will throw exception on invalid input.
1216 $nickname = Nickname::normalize($nickname);
1218 // Try to find profiles this profile is subscribed to that have this nickname
1219 $recipient = new Profile();
1220 // XXX: use a join instead of a subquery
1221 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1222 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1223 if ($recipient->find(true)) {
1224 // XXX: should probably differentiate between profiles with
1225 // the same name by date of most recent update
1228 // Try to find profiles that listen to this profile and that have this nickname
1229 $recipient = new Profile();
1230 // XXX: use a join instead of a subquery
1231 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1232 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1233 if ($recipient->find(true)) {
1234 // XXX: should probably differentiate between profiles with
1235 // the same name by date of most recent update
1238 // If this is a local user, try to find a local user with that nickname.
1239 $sender = User::getKV('id', $sender->id);
1240 if ($sender instanceof User) {
1241 $recipient_user = User::getKV('nickname', $nickname);
1242 if ($recipient_user instanceof User) {
1243 return $recipient_user->getProfile();
1246 // Otherwise, no links. @messages from local users to remote users,
1247 // or from remote users to other remote users, are just
1248 // outside our ability to make intelligent guesses about
1252 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1254 if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1256 $path = $r->build($action, $args, $params, $fragment);
1258 $ssl = common_config('site', 'ssl') === 'always'
1259 || GNUsocial::isHTTPS()
1260 || common_is_sensitive($action);
1262 if (common_config('site','fancy')) {
1263 $url = common_path($path, $ssl, $addSession);
1265 if (mb_strpos($path, '/index.php') === 0) {
1266 $url = common_path($path, $ssl, $addSession);
1268 $url = common_path('index.php/'.$path, $ssl, $addSession);
1271 Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1276 function common_is_sensitive($action)
1278 static $sensitive = array(
1283 'ApiOAuthRequestToken',
1284 'ApiOAuthAccessToken',
1285 'ApiOAuthAuthorize',
1291 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1292 $ssl = in_array($action, $sensitive);
1298 function common_path($relative, $ssl=false, $addSession=true)
1300 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1302 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1303 || GNUsocial::isHTTPS()
1304 || common_config('site', 'ssl') === 'always') {
1306 if (is_string(common_config('site', 'sslserver')) &&
1307 mb_strlen(common_config('site', 'sslserver')) > 0) {
1308 $serverpart = common_config('site', 'sslserver');
1309 } else if (common_config('site', 'server')) {
1310 $serverpart = common_config('site', 'server');
1312 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1316 if (common_config('site', 'server')) {
1317 $serverpart = common_config('site', 'server');
1319 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1324 $relative = common_inject_session($relative, $serverpart);
1327 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1330 function common_inject_session($url, $serverpart = null)
1332 if (!common_have_session()) {
1336 if (empty($serverpart)) {
1337 $serverpart = parse_url($url, PHP_URL_HOST);
1340 $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1342 // Are we pointing to another server (like an SSL server?)
1344 if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1345 // Pass the session ID as a GET parameter
1346 $sesspart = session_name() . '=' . session_id();
1347 $i = strpos($url, '?');
1348 if ($i === false) { // no GET params, just append
1349 $url .= '?' . $sesspart;
1351 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1358 function common_date_string($dt)
1360 // XXX: do some sexy date formatting
1361 // return date(DATE_RFC822, $dt);
1362 $t = strtotime($dt);
1366 if ($now < $t) { // that shouldn't happen!
1367 return common_exact_date($dt);
1368 } else if ($diff < 60) {
1369 // TRANS: Used in notices to indicate when the notice was made compared to now.
1370 return _('a few seconds ago');
1371 } else if ($diff < 92) {
1372 // TRANS: Used in notices to indicate when the notice was made compared to now.
1373 return _('about a minute ago');
1374 } else if ($diff < 3300) {
1375 $minutes = round($diff/60);
1376 // TRANS: Used in notices to indicate when the notice was made compared to now.
1377 return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1378 } else if ($diff < 5400) {
1379 // TRANS: Used in notices to indicate when the notice was made compared to now.
1380 return _('about an hour ago');
1381 } else if ($diff < 22 * 3600) {
1382 $hours = round($diff/3600);
1383 // TRANS: Used in notices to indicate when the notice was made compared to now.
1384 return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1385 } else if ($diff < 37 * 3600) {
1386 // TRANS: Used in notices to indicate when the notice was made compared to now.
1387 return _('about a day ago');
1388 } else if ($diff < 24 * 24 * 3600) {
1389 $days = round($diff/(24*3600));
1390 // TRANS: Used in notices to indicate when the notice was made compared to now.
1391 return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1392 } else if ($diff < 46 * 24 * 3600) {
1393 // TRANS: Used in notices to indicate when the notice was made compared to now.
1394 return _('about a month ago');
1395 } else if ($diff < 330 * 24 * 3600) {
1396 $months = round($diff/(30*24*3600));
1397 // TRANS: Used in notices to indicate when the notice was made compared to now.
1398 return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1399 } else if ($diff < 480 * 24 * 3600) {
1400 // TRANS: Used in notices to indicate when the notice was made compared to now.
1401 return _('about a year ago');
1403 return common_exact_date($dt);
1407 function common_exact_date($dt)
1413 $_utc = new DateTimeZone('UTC');
1414 $_siteTz = new DateTimeZone(common_timezone());
1417 $dateStr = date('d F Y H:i:s', strtotime($dt));
1418 $d = new DateTime($dateStr, $_utc);
1419 $d->setTimezone($_siteTz);
1420 // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
1421 return $d->format(_('l, d-M-Y H:i:s T'));
1424 function common_date_w3dtf($dt)
1426 $dateStr = date('d F Y H:i:s', strtotime($dt));
1427 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1428 $d->setTimezone(new DateTimeZone(common_timezone()));
1429 return $d->format(DATE_W3C);
1432 function common_date_rfc2822($dt)
1434 $dateStr = date('d F Y H:i:s', strtotime($dt));
1435 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1436 $d->setTimezone(new DateTimeZone(common_timezone()));
1437 return $d->format('r');
1440 function common_date_iso8601($dt)
1442 $dateStr = date('d F Y H:i:s', strtotime($dt));
1443 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1444 $d->setTimezone(new DateTimeZone(common_timezone()));
1445 return $d->format('c');
1448 function common_sql_now()
1450 return common_sql_date(time());
1453 function common_sql_date($datetime)
1455 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1459 * Return an SQL fragment to calculate an age-based weight from a given
1460 * timestamp or datetime column.
1462 * @param string $column name of field we're comparing against current time
1463 * @param integer $dropoff divisor for age in seconds before exponentiation
1464 * @return string SQL fragment
1466 function common_sql_weight($column, $dropoff)
1468 if (common_config('db', 'type') == 'pgsql') {
1469 // PostgreSQL doesn't support timestampdiff function.
1470 // @fixme will this use the right time zone?
1471 // @fixme does this handle cross-year subtraction correctly?
1472 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1474 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1478 function common_redirect($url, $code=307)
1480 static $status = array(301 => "Moved Permanently",
1483 307 => "Temporary Redirect");
1485 header('HTTP/1.1 '.$code.' '.$status[$code]);
1486 header("Location: $url");
1487 header("Connection: close");
1489 $xo = new XMLOutputter();
1491 '-//W3C//DTD XHTML 1.0 Strict//EN',
1492 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1493 $xo->element('a', array('href' => $url), $url);
1498 // Stick the notice on the queue
1500 function common_enqueue_notice($notice)
1502 static $localTransports = array('ping');
1504 $transports = array();
1505 if (common_config('sms', 'enabled')) {
1506 $transports[] = 'sms';
1508 if (Event::hasHandler('HandleQueuedNotice')) {
1509 $transports[] = 'plugin';
1512 // We can skip these for gatewayed notices.
1513 if ($notice->isLocal()) {
1514 $transports = array_merge($transports, $localTransports);
1517 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1519 $qm = QueueManager::get();
1521 foreach ($transports as $transport)
1523 $qm->enqueue($notice, $transport);
1526 Event::handle('EndEnqueueNotice', array($notice, $transports));
1532 function common_profile_url($nickname)
1534 return common_local_url('showstream', array('nickname' => $nickname),
1539 * Should make up a reasonable root URL
1541 function common_root_url($ssl=false)
1543 $url = common_path('', $ssl, false);
1544 $i = strpos($url, '?');
1546 $url = substr($url, 0, $i);
1552 * returns $bytes bytes of raw random data
1554 function common_random_rawstr($bytes)
1556 $rawstr = @file_exists('/dev/urandom')
1557 ? common_urandom($bytes)
1558 : common_mtrand($bytes);
1564 * returns $bytes bytes of random data as a hexadecimal string
1566 function common_random_hexstr($bytes)
1568 $str = common_random_rawstr($bytes);
1571 for ($i = 0; $i < $bytes; $i++) {
1572 $hexstr .= sprintf("%02x", ord($str[$i]));
1577 function common_urandom($bytes)
1579 $h = fopen('/dev/urandom', 'rb');
1581 $src = fread($h, $bytes);
1586 function common_mtrand($bytes)
1589 for ($i = 0; $i < $bytes; $i++) {
1590 $str .= chr(mt_rand(0, 255));
1596 * Record the given URL as the return destination for a future
1597 * form submission, to be read by common_get_returnto().
1599 * @param string $url
1601 * @fixme as a session-global setting, this can allow multiple forms
1602 * to conflict and overwrite each others' returnto destinations if
1603 * the user has multiple tabs or windows open.
1605 * Should refactor to index with a token or otherwise only pass the
1606 * data along its intended path.
1608 function common_set_returnto($url)
1610 common_ensure_session();
1611 $_SESSION['returnto'] = $url;
1615 * Fetch a return-destination URL previously recorded by
1616 * common_set_returnto().
1618 * @return mixed URL string or null
1620 * @fixme as a session-global setting, this can allow multiple forms
1621 * to conflict and overwrite each others' returnto destinations if
1622 * the user has multiple tabs or windows open.
1624 * Should refactor to index with a token or otherwise only pass the
1625 * data along its intended path.
1627 function common_get_returnto()
1629 common_ensure_session();
1630 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1633 function common_timestamp()
1635 return date('YmdHis');
1638 function common_ensure_syslog()
1640 static $initialized = false;
1641 if (!$initialized) {
1642 openlog(common_config('syslog', 'appname'), 0,
1643 common_config('syslog', 'facility'));
1644 $initialized = true;
1648 function common_log_line($priority, $msg)
1650 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1651 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1652 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1655 function common_request_id()
1658 $server = common_config('site', 'server');
1659 if (php_sapi_name() == 'cli') {
1660 $script = basename($_SERVER['PHP_SELF']);
1661 return "$server:$script:$pid";
1663 static $req_id = null;
1664 if (!isset($req_id)) {
1665 $req_id = substr(md5(mt_rand()), 0, 8);
1667 if (isset($_SERVER['REQUEST_URI'])) {
1668 $url = $_SERVER['REQUEST_URI'];
1670 $method = $_SERVER['REQUEST_METHOD'];
1671 return "$server:$pid.$req_id $method $url";
1675 function common_log($priority, $msg, $filename=null)
1677 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1678 $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1679 $msg = '[' . common_request_id() . '] ' . $msg;
1680 $logfile = common_config('site', 'logfile');
1682 $log = fopen($logfile, "a");
1684 $output = common_log_line($priority, $msg);
1685 fwrite($log, $output);
1689 common_ensure_syslog();
1690 syslog($priority, $msg);
1692 Event::handle('EndLog', array($priority, $msg, $filename));
1696 function common_debug($msg, $filename=null)
1699 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1701 common_log(LOG_DEBUG, $msg);
1705 function common_log_db_error(&$object, $verb, $filename=null)
1709 $objstr = common_log_objstring($object);
1710 $last_error = &$_PEAR->getStaticProperty('DB_DataObject','lastError');
1711 if (is_object($last_error)) {
1712 $msg = $last_error->message;
1714 $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1716 common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1719 function common_log_objstring(&$object)
1721 if (is_null($object)) {
1724 if (!($object instanceof DB_DataObject)) {
1727 $arr = $object->toArray();
1729 foreach ($arr as $k => $v) {
1730 if (is_object($v)) {
1731 $fields[] = "$k='".get_class($v)."'";
1733 $fields[] = "$k='$v'";
1736 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1740 function common_valid_http_url($url, $secure=false)
1742 // If $secure is true, only allow https URLs to pass
1743 // (if false, we use '?' in 'https?' to say the 's' is optional)
1744 $regex = $secure ? '/^https$/' : '/^https?$/';
1745 return filter_var($url, FILTER_VALIDATE_URL)
1746 && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1749 function common_valid_tag($tag)
1751 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1752 return (Validate::email($matches[1]) ||
1753 preg_match('/^([\w-\.]+)$/', $matches[1]));
1759 * Determine if given domain or address literal is valid
1760 * eg for use in JIDs and URLs. Does not check if the domain
1763 * @param string $domain
1764 * @return boolean valid or not
1766 function common_valid_domain($domain)
1768 $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1769 $ipv4 = "(?:$octet(?:\.$octet){3})";
1770 if (preg_match("/^$ipv4$/u", $domain)) return true;
1772 $group = "(?:[0-9a-f]{1,4})";
1773 $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1775 if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1776 $before = explode(":", $matches[1]);
1777 $zeroes = $matches[2];
1778 $after = explode(":", $matches[3]);
1786 $explicit = count($before) + count($after);
1787 if ($explicit < $min || $explicit > $max) {
1794 require_once "Net/IDNA.php";
1795 $idn = Net_IDNA::getInstance();
1796 $domain = $idn->encode($domain);
1797 } catch (Exception $e) {
1801 $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1802 $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1804 return preg_match("/^$fqdn$/ui", $domain);
1807 /* Following functions are copied from MediaWiki GlobalFunctions.php
1808 * and written by Evan Prodromou. */
1810 function common_accept_to_prefs($accept, $def = '*/*')
1812 // No arg means accept anything (per HTTP spec)
1814 return array($def => 1);
1819 $parts = explode(',', $accept);
1821 foreach($parts as $part) {
1822 // FIXME: doesn't deal with params like 'text/html; level=1'
1823 @list($value, $qpart) = explode(';', trim($part));
1825 if(!isset($qpart)) {
1827 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1828 $prefs[$value] = $match[1];
1835 // Match by our supported file extensions
1836 function common_supported_ext_to_mime($fileext)
1838 // Accept a filename and take out the extension
1839 if (strpos($fileext, '.') !== false) {
1840 $fileext = substr(strrchr($fileext, '.'), 1);
1843 $supported = common_config('attachments', 'supported');
1844 foreach($supported as $type => $ext) {
1845 if ($ext === $fileext) {
1850 throw new ServerException('Unsupported file extension');
1853 // Match by our supported mime types
1854 function common_supported_mime_to_ext($mimetype)
1856 $supported = common_config('attachments', 'supported');
1857 foreach($supported as $type => $ext) {
1858 if ($mimetype === $type) {
1863 throw new ServerException('Unsupported MIME type');
1866 // The MIME "media" is the part before the slash (video in video/webm)
1867 function common_get_mime_media($type)
1869 $tmp = explode('/', $type);
1870 return strtolower($tmp[0]);
1873 // Get only the mimetype and not additional info (separated from bare mime with semi-colon)
1874 function common_bare_mime($mimetype)
1876 $mimetype = mb_strtolower($mimetype);
1877 if ($semicolon = mb_strpos($mimetype, ';')) {
1878 $mimetype = mb_substr($mimetype, 0, $semicolon);
1883 function common_mime_type_match($type, $avail)
1885 if(array_key_exists($type, $avail)) {
1888 $parts = explode('/', $type);
1889 if(array_key_exists($parts[0] . '/*', $avail)) {
1890 return $parts[0] . '/*';
1891 } elseif(array_key_exists('*/*', $avail)) {
1899 function common_negotiate_type($cprefs, $sprefs)
1903 foreach(array_keys($sprefs) as $type) {
1904 $parts = explode('/', $type);
1905 if($parts[1] != '*') {
1906 $ckey = common_mime_type_match($type, $cprefs);
1908 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1913 foreach(array_keys($cprefs) as $type) {
1914 $parts = explode('/', $type);
1915 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1916 $skey = common_mime_type_match($type, $sprefs);
1918 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1924 $besttype = 'text/html';
1926 foreach(array_keys($combine) as $type) {
1927 if($combine[$type] > $bestq) {
1929 $bestq = $combine[$type];
1933 if ('text/html' === $besttype) {
1934 return "text/html; charset=utf-8";
1939 function common_config($main, $sub=null)
1942 if (is_null($sub)) {
1943 // Return the config category array
1944 return array_key_exists($main, $config) ? $config[$main] : array();
1946 // Return the config value
1947 return (array_key_exists($main, $config) &&
1948 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1951 function common_config_set($main, $sub, $value)
1954 if (!array_key_exists($main, $config)) {
1955 $config[$main] = array();
1957 $config[$main][$sub] = $value;
1960 function common_config_append($main, $sub, $value)
1963 if (!array_key_exists($main, $config)) {
1964 $config[$main] = array();
1966 if (!array_key_exists($sub, $config[$main])) {
1967 $config[$main][$sub] = array();
1969 if (!is_array($config[$main][$sub])) {
1970 $config[$main][$sub] = array($config[$main][$sub]);
1972 array_push($config[$main][$sub], $value);
1976 * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
1977 * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
1979 * @param array $from
1982 function common_copy_args($from)
1985 $strip = get_magic_quotes_gpc();
1986 foreach ($from as $k => $v) {
1988 $to[$k] = common_copy_args($v);
1991 $v = stripslashes($v);
1993 $to[$k] = strval(common_validate_utf8($v));
2000 * Neutralise the evil effects of magic_quotes_gpc in the current request.
2001 * This is used before handing a request off to OAuthRequest::from_request.
2002 * @fixme Doesn't consider vars other than _POST and _GET?
2003 * @fixme Can't be undone and could corrupt data if run twice.
2005 function common_remove_magic_from_request()
2007 if(get_magic_quotes_gpc()) {
2008 $_POST=array_map('stripslashes',$_POST);
2009 $_GET=array_map('stripslashes',$_GET);
2013 function common_user_uri(&$user)
2015 return common_local_url('userbyid', array('id' => $user->id),
2019 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2021 function common_confirmation_code($bits)
2023 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2024 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
2025 $chars = ceil($bits/5);
2027 for ($i = 0; $i < $chars; $i++) {
2028 // XXX: convert to string and back
2029 $num = hexdec(common_random_hexstr(1));
2030 // XXX: randomness is too precious to throw away almost
2031 // 40% of the bits we get!
2032 $code .= $codechars[$num%32];
2037 // convert markup to HTML
2038 function common_markup_to_html($c, $args=null)
2044 if (is_null($args)) {
2048 // XXX: not very efficient
2050 foreach ($args as $name => $value) {
2051 $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
2054 $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
2055 $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
2056 $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
2057 $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
2059 return \Michelf\Markdown::defaultTransform($c);
2062 function common_user_property($property)
2064 $profile = Profile::current();
2066 if (empty($profile)) {
2070 switch ($property) {
2076 return $profile->$property;
2080 return $profile->getAvatar(AVATAR_STREAM_SIZE);
2081 } catch (Exception $e) {
2086 return $profile->getBestName();
2093 function common_profile_uri($profile)
2097 if (!empty($profile)) {
2098 if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2099 $user = User::getKV('id', $profile->id);
2100 if ($user instanceof User) {
2101 $uri = $user->getUri();
2103 Event::handle('EndCommonProfileURI', array($profile, &$uri));
2107 // XXX: this is a very bad profile!
2111 function common_canonical_sms($sms)
2114 preg_replace('/\D/', '', $sms);
2118 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2123 case E_COMPILE_ERROR:
2127 case E_RECOVERABLE_ERROR:
2128 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2133 case E_COMPILE_WARNING:
2134 case E_CORE_WARNING:
2135 case E_USER_WARNING:
2136 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2141 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2146 case E_USER_DEPRECATED:
2147 // XXX: config variable to log this stuff, too
2151 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2156 // FIXME: show error page if we're on the Web
2157 /* Don't execute PHP internal error handler */
2161 function common_session_token()
2163 common_ensure_session();
2164 if (!array_key_exists('token', $_SESSION)) {
2165 $_SESSION['token'] = common_random_hexstr(64);
2167 return $_SESSION['token'];
2170 function common_license_terms($uri)
2172 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2173 return explode('-',$matches[1]);
2178 function common_compatible_license($from, $to)
2180 $from_terms = common_license_terms($from);
2181 // public domain and cc-by are compatible with everything
2182 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2185 $to_terms = common_license_terms($to);
2186 // sa is compatible across versions. IANAL
2187 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2188 return count(array_diff($from_terms, $to_terms)) == 0;
2190 // XXX: better compatibility check needed here!
2191 // Should at least normalise URIs
2192 return ($from == $to);
2196 * returns a quoted table name, if required according to config
2198 function common_database_tablename($tablename)
2200 if(common_config('db','quote_identifiers')) {
2201 $tablename = '"'. $tablename .'"';
2203 //table prefixes could be added here later
2208 * Shorten a URL with the current user's configured shortening service,
2209 * or ur1.ca if configured, or not at all if no shortening is set up.
2211 * @param string $long_url original URL
2212 * @param User $user to specify a particular user's options
2213 * @param boolean $force Force shortening (used when notice is too long)
2214 * @return string may return the original URL if shortening failed
2216 * @fixme provide a way to specify a particular shortener
2218 function common_shorten_url($long_url, User $user=null, $force = false)
2220 $long_url = trim($long_url);
2222 $user = common_current_user();
2224 $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2226 // $force forces shortening even if it's not strictly needed
2227 // I doubt URL shortening is ever 'strictly' needed. - ESP
2229 if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2233 $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2235 if (Event::handle('StartShortenUrl',
2236 array($long_url, $shortenerName, &$shortenedUrl))) {
2237 if ($shortenerName == 'internal') {
2239 $f = File::processNew($long_url);
2240 $shortenedUrl = common_local_url('redirecturl', array('id' => $f->id));
2241 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2242 return $shortenedUrl;
2246 } catch (ServerException $e) {
2253 //URL was shortened, so return the result
2254 return trim($shortenedUrl);
2259 * @return mixed array($proxy, $ip) for web requests; proxy may be null
2260 * null if not a web request
2262 * @fixme X-Forwarded-For can be chained by multiple proxies;
2263 we should parse the list and provide a cleaner array
2264 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2265 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2266 * use function to get exact request headers from Apache if possible.
2268 function common_client_ip()
2270 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2274 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2275 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2276 $proxy = $_SERVER['HTTP_CLIENT_IP'];
2278 $proxy = $_SERVER['REMOTE_ADDR'];
2280 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2283 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2284 $ip = $_SERVER['HTTP_CLIENT_IP'];
2286 $ip = $_SERVER['REMOTE_ADDR'];
2290 return array($proxy, $ip);
2293 function common_url_to_nickname($url)
2295 static $bad = array('query', 'user', 'password', 'port', 'fragment');
2297 $parts = parse_url($url);
2299 // If any of these parts exist, this won't work
2301 foreach ($bad as $badpart) {
2302 if (array_key_exists($badpart, $parts)) {
2307 // We just have host and/or path
2309 // If it's just a host...
2310 if (array_key_exists('host', $parts) &&
2311 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2313 $hostparts = explode('.', $parts['host']);
2315 // Try to catch common idiom of nickname.service.tld
2317 if ((count($hostparts) > 2) &&
2318 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2319 (strcmp($hostparts[0], 'www') != 0))
2321 return common_nicknamize($hostparts[0]);
2323 // Do the whole hostname
2324 return common_nicknamize($parts['host']);
2327 if (array_key_exists('path', $parts)) {
2328 // Strip starting, ending slashes
2329 $path = preg_replace('@/$@', '', $parts['path']);
2330 $path = preg_replace('@^/@', '', $path);
2331 $path = basename($path);
2333 // Hack for MediaWiki user pages, in the form:
2334 // http://example.com/wiki/User:Myname
2335 // ('User' may be localized.)
2336 if (strpos($path, ':')) {
2337 $parts = array_filter(explode(':', $path));
2338 $path = $parts[count($parts) - 1];
2342 return common_nicknamize($path);
2350 function common_nicknamize($str)
2353 return Nickname::normalize($str);
2354 } catch (NicknameException $e) {
2359 function common_perf_counter($key, $val=null)
2361 global $_perfCounters;
2362 if (isset($_perfCounters)) {
2363 if (common_config('site', 'logperf')) {
2364 if (array_key_exists($key, $_perfCounters)) {
2365 $_perfCounters[$key][] = $val;
2367 $_perfCounters[$key] = array($val);
2369 if (common_config('site', 'logperf_detail')) {
2370 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2376 function common_log_perf_counters()
2378 if (common_config('site', 'logperf')) {
2379 global $_startTime, $_perfCounters;
2381 if (isset($_startTime)) {
2382 $endTime = microtime(true);
2383 $diff = round(($endTime - $_startTime) * 1000);
2384 common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2386 $counters = $_perfCounters;
2388 foreach ($counters as $key => $values) {
2389 $count = count($values);
2390 $unique = count(array_unique($values));
2391 common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2396 function common_is_email($str)
2398 return (strpos($str, '@') !== false);
2401 function common_init_stats()
2405 $_mem = memory_get_usage(true);
2406 $_ts = microtime(true);
2409 function common_log_delta($comment=null)
2416 $_mem = memory_get_usage(true);
2417 $_ts = microtime(true);
2419 $mtotal = $_mem - $mold;
2420 $ttotal = $_ts - $told;
2422 if (empty($comment)) {
2426 common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
2429 function common_strip_html($html, $trim=true, $save_whitespace=false)
2431 if (!$save_whitespace) {
2432 $html = preg_replace('/\s+/', ' ', $html);
2434 $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
2435 return $trim ? trim($text) : $text;
2438 function html_sprintf()
2440 $args = func_get_args();
2441 for ($i=1; $i<count($args); $i++) {
2442 $args[$i] = htmlspecialchars($args[$i]);
2444 return call_user_func_array('sprintf', $args);