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, $id, 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->id),
250 //internal checking passed
251 $authenticatedUser = $user;
255 Event::handle('EndCheckPassword', array($nickname, $password, $authenticatedUser));
257 return $authenticatedUser;
261 * Is the current user logged in?
263 function common_logged_in()
265 return (!is_null(common_current_user()));
268 function common_have_session()
270 return (0 != strcmp(session_id(), ''));
273 function common_ensure_session()
276 if (array_key_exists(session_name(), $_COOKIE)) {
277 $c = $_COOKIE[session_name()];
279 if (!common_have_session()) {
280 if (common_config('sessions', 'handle')) {
281 Session::setSaveHandler();
283 if (array_key_exists(session_name(), $_GET)) {
284 $id = $_GET[session_name()];
285 } else if (array_key_exists(session_name(), $_COOKIE)) {
286 $id = $_COOKIE[session_name()];
292 if (!isset($_SESSION['started'])) {
293 $_SESSION['started'] = time();
295 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
296 ' is set but started value is null');
302 // Three kinds of arguments:
307 // Initialize to false; set to null if none found
310 function common_set_user($user)
314 if (is_null($user) && common_have_session()) {
316 unset($_SESSION['userid']);
318 } else if (is_string($user)) {
320 $user = User::getKV('nickname', $nickname);
321 } else if (!$user instanceof User) {
326 if (Event::handle('StartSetUser', array(&$user))) {
328 if (!$user->hasRight(Right::WEBLOGIN)) {
329 // TRANS: Authorisation exception thrown when a user a not allowed to login.
330 throw new AuthorizationException(_('Not allowed to log in.'));
332 common_ensure_session();
333 $_SESSION['userid'] = $user->id;
335 Event::handle('EndSetUser', array($user));
343 function common_set_cookie($key, $value, $expiration=0)
345 $path = common_config('site', 'path');
346 $server = common_config('site', 'server');
348 if ($path && ($path != '/')) {
349 $cookiepath = '/' . $path . '/';
353 return setcookie($key,
358 common_config('site', 'ssl')=='always');
361 define('REMEMBERME', 'rememberme');
362 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
364 function common_rememberme($user=null)
367 $user = common_current_user();
373 $rm = new Remember_me();
375 $rm->code = common_random_hexstr(16);
376 $rm->user_id = $user->id;
378 // Wrap the insert in some good ol' fashioned transaction code
382 $result = $rm->insert();
385 common_log_db_error($rm, 'INSERT', __FILE__);
386 $rm->query('ROLLBACK');
390 $rm->query('COMMIT');
392 $cookieval = $rm->user_id . ':' . $rm->code;
394 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
396 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
401 function common_remembered_user()
405 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
411 list($id, $code) = explode(':', $packed);
413 if (!$id || !$code) {
414 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
419 $rm = Remember_me::getKV('code', $code);
422 common_log(LOG_WARNING, 'No such remember code: ' . $code);
427 if ($rm->user_id != $id) {
428 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
433 $user = User::getKV('id', $rm->user_id);
435 if (!$user instanceof User) {
436 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
442 $result = $rm->delete();
445 common_log_db_error($rm, 'DELETE', __FILE__);
446 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
451 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
453 common_set_user($user);
454 common_real_login(false);
456 // We issue a new cookie, so they can log in
457 // automatically again after this session
459 common_rememberme($user);
465 * must be called with a valid user!
467 function common_forgetme()
469 common_set_cookie(REMEMBERME, '', 0);
473 * Who is the current user?
475 function common_current_user()
479 if (!_have_config()) {
483 if ($_cur === false) {
485 if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
486 || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
487 common_ensure_session();
488 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
490 $user = User::getKV('id', $id);
491 if ($user instanceof User) {
498 // that didn't work; try to remember; will init $_cur to null on failure
499 $_cur = common_remembered_user();
502 // XXX: Is this necessary?
503 $_SESSION['userid'] = $_cur->id;
511 * Logins that are 'remembered' aren't 'real' -- they're subject to
512 * cookie-stealing. So, we don't let them do certain things. New reg,
513 * OpenID, and password logins _are_ real.
515 function common_real_login($real=true)
517 common_ensure_session();
518 $_SESSION['real_login'] = $real;
521 function common_is_real_login()
523 return common_logged_in() && $_SESSION['real_login'];
527 * Get a hash portion for HTTP caching Etags and such including
528 * info on the current user's session. If login/logout state changes,
529 * or we've changed accounts, or we've renamed the current user,
530 * we'll get a new hash value.
532 * This should not be considered secure information.
534 * @param User $user (optional; uses common_current_user() if left out)
537 function common_user_cache_hash($user=false)
539 if ($user === false) {
540 $user = common_current_user();
543 return crc32($user->id . ':' . $user->nickname);
550 * get canonical version of nickname for comparison
552 * @param string $nickname
555 * @throws NicknameException on invalid input
556 * @deprecated call Nickname::normalize() directly.
558 function common_canonical_nickname($nickname)
560 return Nickname::normalize($nickname);
564 * get canonical version of email for comparison
566 * @fixme actually normalize
567 * @fixme reject invalid input
569 * @param string $email
572 function common_canonical_email($email)
574 // XXX: canonicalize UTF-8
575 // XXX: lcase the domain part
579 function common_purify($html)
581 require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
583 $config = array('safe' => 1,
584 'deny_attribute' => 'id,style,on*');
586 $html = common_remove_unicode_formatting($html);
588 return htmLawed($html, $config);
591 function common_remove_unicode_formatting($text)
593 // Strip Unicode text formatting/direction codes
594 // this is pretty dangerous for visualisation of text and can be used for mischief
595 return preg_replace('/[\\x{200b}-\\x{200f}\\x{202a}-\\x{202e}]/u', '', $text);
599 * Partial notice markup rendering step: build links to !group references.
601 * @param string $text partially rendered HTML
602 * @param Notice $notice in whose context we're working
603 * @return string partially rendered HTML
605 function common_render_content($text, Notice $notice)
607 $text = common_render_text($text);
608 $text = common_linkify_mentions($text, $notice);
613 * Finds @-mentions within the partially-rendered text section and
614 * turns them into live links.
616 * Should generally not be called except from common_render_content().
618 * @param string $text partially-rendered HTML
619 * @param Notice $notice in-progress or complete Notice object for context
620 * @return string partially-rendered HTML
622 function common_linkify_mentions($text, $notice)
624 $mentions = common_find_mentions($text, $notice);
626 // We need to go through in reverse order by position,
627 // so our positions stay valid despite our fudging with the
632 foreach ($mentions as $mention)
634 $points[$mention['position']] = $mention;
639 foreach ($points as $position => $mention) {
641 $linkText = common_linkify_mention($mention);
643 $text = substr_replace($text, $linkText, $position, mb_strlen($mention['text']));
649 function common_linkify_mention($mention)
653 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
655 $xs = new XMLStringer(false);
657 $attrs = array('href' => $mention['url'],
658 'class' => 'h-card '.$mention['type']);
660 if (!empty($mention['title'])) {
661 $attrs['title'] = $mention['title'];
664 $xs->element('a', $attrs, $mention['text']);
666 $output = $xs->getString();
668 Event::handle('EndLinkifyMention', array($mention, &$output));
675 * Find @-mentions in the given text, using the given notice object as context.
676 * References will be resolved with common_relative_profile() against the user
677 * who posted the notice.
679 * Note the return data format is internal, to be used for building links and
680 * such. Should not be used directly; rather, call common_linkify_mentions().
682 * @param string $text
683 * @param Notice $notice notice in whose context we're building links
689 function common_find_mentions($text, $notice)
692 $sender = Profile::getKV('id', $notice->profile_id);
693 } catch (NoProfileException $e) {
699 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
700 // Get the context of the original notice, if any
703 $origMentions = array();
707 if ($notice instanceof Notice) {
709 $origNotice = $notice->getParent();
710 $origAuthor = $origNotice->getProfile();
712 $ids = $origNotice->getReplies();
714 foreach ($ids as $id) {
715 $repliedTo = Profile::getKV('id', $id);
716 if ($repliedTo instanceof Profile) {
717 $origMentions[$repliedTo->nickname] = $repliedTo;
720 } catch (NoProfileException $e) {
721 common_log(LOG_WARNING, sprintf('Notice %d author profile id %d does not exist', $origNotice->id, $origNotice->profile_id));
722 } catch (ServerException $e) {
723 // Probably just no parent. Should get a specific NoParentException
724 } catch (Exception $e) {
725 common_log(LOG_WARNING, __METHOD__ . ' got exception ' . get_class($e) . ' : ' . $e->getMessage());
729 $matches = common_find_mentions_raw($text);
731 foreach ($matches as $match) {
733 $nickname = Nickname::normalize($match[0]);
734 } catch (NicknameException $e) {
735 // Bogus match? Drop it.
739 // Try to get a profile for this nickname.
740 // Start with conversation context, then go to
743 if ($origAuthor instanceof Profile && $origAuthor->nickname == $nickname) {
744 $mentioned = $origAuthor;
745 } else if (!empty($origMentions) &&
746 array_key_exists($nickname, $origMentions)) {
747 $mentioned = $origMentions[$nickname];
749 $mentioned = common_relative_profile($sender, $nickname);
752 if ($mentioned instanceof Profile) {
753 $user = User::getKV('id', $mentioned->id);
755 if ($user instanceof User) {
756 $url = common_local_url('userbyid', array('id' => $user->id));
758 $url = $mentioned->profileurl;
761 $mention = array('mentioned' => array($mentioned),
764 'position' => $match[1],
767 if (!empty($mentioned->fullname)) {
768 $mention['title'] = $mentioned->fullname;
771 $mentions[] = $mention;
775 // @#tag => mention of all subscriptions tagged 'tag'
777 preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
778 $text, $hmatches, PREG_OFFSET_CAPTURE);
779 foreach ($hmatches[1] as $hmatch) {
780 $tag = common_canonical_tag($hmatch[0]);
781 $plist = Profile_list::getByTaggerAndTag($sender->id, $tag);
782 if (!$plist instanceof Profile_list || $plist->private) {
785 $tagged = $sender->getTaggedSubscribers($tag);
787 $url = common_local_url('showprofiletag',
788 array('tagger' => $sender->nickname,
791 $mentions[] = array('mentioned' => $tagged,
793 'text' => $hmatch[0],
794 'position' => $hmatch[1],
798 preg_match_all('/(?:^|[\s\.\,\:\;]+)!(' . Nickname::DISPLAY_FMT . ')/',
799 $text, $hmatches, PREG_OFFSET_CAPTURE);
800 foreach ($hmatches[1] as $hmatch) {
801 $nickname = Nickname::normalize($hmatch[0]);
802 $group = User_group::getForNickname($nickname, $sender);
804 if (!$group instanceof User_group || !$sender->isMember($group)) {
808 $profile = $group->getProfile();
810 $mentions[] = array('mentioned' => array($profile),
812 'text' => $hmatch[0],
813 'position' => $hmatch[1],
814 'url' => $group->permalink(),
815 'title' => $group->getFancyName());
818 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
825 * Does the actual regex pulls to find @-mentions in text.
826 * Should generally not be called directly; for use in common_find_mentions.
828 * @param string $text
829 * @return array of PCRE match arrays
831 function common_find_mentions_raw($text)
834 preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
837 PREG_OFFSET_CAPTURE);
839 $atmatches = array();
840 preg_match_all('/(?:^|\s+)@(' . Nickname::DISPLAY_FMT . ')\b/',
843 PREG_OFFSET_CAPTURE);
845 $matches = array_merge($tmatches[1], $atmatches[1]);
849 function common_render_text($text)
851 $text = common_remove_unicode_formatting($text);
852 $text = nl2br(htmlspecialchars($text));
854 $text = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $text);
855 $text = common_replace_urls_callback($text, 'common_linkify');
856 $text = preg_replace_callback('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
857 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $text);
863 * Find links in the given text and pass them to the given callback function.
865 * @param string $text
866 * @param function($text, $arg) $callback: return replacement text
867 * @param mixed $arg: optional argument will be passed on to the callback
869 function common_replace_urls_callback($text, $callback, $arg = null) {
870 // Start off with a regex
872 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
875 '(?:'. //Known protocols
877 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
879 '(?:(?:mailto|aim|tel|xmpp):)'.
881 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
884 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
886 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
890 '|(?:(?: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
892 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
894 (common_config('linkify', 'bare_domains')
896 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
897 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
898 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
899 '(?: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)'.
901 : '') . // if common_config('linkify', 'bare_domains') is false, don't add anything here
904 '(?:\:\d+)?'. //:port
905 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
906 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
907 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
908 ')(?<![\?\.\,\#\,])'.
911 //preg_match_all($regex,$text,$matches);
913 return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
917 * Intermediate callback for common_replace_links(), helps resolve some
918 * ambiguous link forms before passing on to the final callback.
920 * @param array $matches
921 * @param callable $callback
922 * @param mixed $arg optional argument to pass on as second param to callback
927 function callback_helper($matches, $callback, $arg=null) {
929 $left = strpos($matches[0],$url);
930 $right = $left+strlen($url);
932 $groupSymbolSets=array(
950 $cannotEndWith=array('.','?',',','#');
954 foreach($groupSymbolSets as $groupSymbolSet){
955 if(substr($url,-1)==$groupSymbolSet['right']){
956 $group_left_count = substr_count($url,$groupSymbolSet['left']);
957 $group_right_count = substr_count($url,$groupSymbolSet['right']);
958 if($group_left_count<$group_right_count){
960 $url=substr($url,0,-1);
964 if(in_array(substr($url,-1),$cannotEndWith)){
966 $url=substr($url,0,-1);
968 }while($original_url!=$url);
970 $result = call_user_func_array($callback, array($url, $arg));
971 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
974 require_once INSTALLDIR . "/lib/curry.php";
976 function common_linkify($url) {
977 // It comes in special'd, so we unspecial it before passing to the stringifying
979 $url = htmlspecialchars_decode($url);
981 if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
982 //url is an email address without the mailto: protocol
983 $canon = "mailto:$url";
984 $longurl = "mailto:$url";
987 $canon = File_redirection::_canonUrl($url);
989 $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
990 if (is_array($longurl_data)) {
991 $longurl = $longurl_data['url'];
992 } elseif (is_string($longurl_data)) {
993 $longurl = $longurl_data;
995 // Unable to reach the server to verify contents, etc
996 // Just pass the link on through for now.
997 common_log(LOG_ERR, "Can't linkify url '$url'");
1002 $attrs = array('href' => $canon, 'title' => $longurl);
1004 $is_attachment = false;
1005 $attachment_id = null;
1008 // Check to see whether this is a known "attachment" URL.
1010 $f = File::getKV('url', $longurl);
1012 if (!$f instanceof File) {
1013 if (common_config('attachments', 'process_links')) {
1014 // XXX: this writes to the database. :<
1016 $f = File::processNew($longurl);
1017 } catch (ServerException $e) {
1023 if ($f instanceof File) {
1025 $enclosure = $f->getEnclosure();
1026 $is_attachment = true;
1027 $attachment_id = $f->id;
1029 $thumb = File_thumbnail::getKV('file_id', $f->id);
1030 $has_thumb = ($thumb instanceof File_thumbnail);
1031 } catch (ServerException $e) {
1032 // There was not enough metadata available
1037 if ($is_attachment) {
1038 $attrs['class'] = 'attachment';
1040 $attrs['class'] = 'attachment thumbnail';
1042 $attrs['id'] = "attachment-{$attachment_id}";
1045 // Whether to nofollow
1047 $nf = common_config('nofollow', 'external');
1049 if ($nf == 'never') {
1050 $attrs['rel'] = 'external';
1052 $attrs['rel'] = 'nofollow external';
1055 return XMLStringer::estring('a', $attrs, $url);
1059 * Find and shorten links in a given chunk of text if it's longer than the
1060 * configured notice content limit (or unconditionally).
1062 * Side effects: may save file and file_redirection records for referenced URLs.
1064 * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1065 * user's options are used; otherwise the current web session user's setitngs
1066 * will be used or ur1.ca if there is no active web login.
1068 * @param string $text
1069 * @param boolean $always (optional)
1070 * @param User $user (optional)
1074 function common_shorten_links($text, $always = false, User $user=null)
1076 if ($user === null) {
1077 $user = common_current_user();
1080 $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1082 if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1083 return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1085 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1090 * Very basic stripping of invalid UTF-8 input text.
1092 * @param string $str
1093 * @return mixed string or null if invalid input
1095 * @todo ideally we should drop bad chars, and maybe do some of the checks
1096 * from common_xml_safe_str. But we can't strip newlines, etc.
1097 * @todo Unicode normalization might also be useful, but not needed now.
1099 function common_validate_utf8($str)
1101 // preg_replace will return NULL on invalid UTF-8 input.
1103 // Note: empty regex //u also caused NULL return on some
1104 // production machines, but none of our test machines.
1106 // This should be replaced with a more reliable check.
1107 return preg_replace('/\x00/u', '', $str);
1111 * Make sure an arbitrary string is safe for output in XML as a single line.
1113 * @param string $str
1116 function common_xml_safe_str($str)
1118 // Replace common eol and extra whitespace input chars
1123 "\0", // null byte eos
1124 "\x0B" // vertical tab
1127 $replacement = array(
1128 ' ', // single space
1135 $str = str_replace($unWelcome, $replacement, $str);
1137 // Neutralize any additional control codes and UTF-16 surrogates
1138 // (Twitter uses '*')
1139 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1142 function common_slugify($str)
1144 // php5-intl is highly recommended...
1145 if (!function_exists('transliterator_transliterate')) {
1146 $str = preg_replace('/[^\pL\pN]/u', '', $str);
1147 $str = mb_convert_case($str, MB_CASE_LOWER, 'UTF-8');
1148 $str = substr($str, 0, 64);
1151 $str = transliterator_transliterate(
1152 'Any-Latin;' . // any charset to latin compatible
1153 'NFD;' . // decompose
1154 '[:Nonspacing Mark:] Remove;' . // remove nonspacing marks (accents etc.)
1155 'NFC;' . // composite again
1156 '[:Punctuation:] Remove;' . // remove punctuation (.,¿? etc.)
1157 'Lower();' . // turn into lowercase
1158 'Latin-ASCII;', // get ASCII equivalents (ð to d for example)
1160 return preg_replace('/[^\pL\pN]/', '', $str);
1163 function common_tag_link($tag)
1165 $canonical = common_canonical_tag($tag);
1166 if (common_config('singleuser', 'enabled')) {
1167 // regular TagAction isn't set up in 1user mode
1168 $nickname = User::singleUserNickname();
1169 $url = common_local_url('showstream',
1170 array('nickname' => $nickname,
1171 'tag' => $canonical));
1173 $url = common_local_url('tag', array('tag' => $canonical));
1175 $xs = new XMLStringer();
1176 $xs->elementStart('span', 'tag');
1177 $xs->element('a', array('href' => $url,
1180 $xs->elementEnd('span');
1181 return $xs->getString();
1184 function common_canonical_tag($tag)
1186 $tag = common_slugify($tag);
1187 $tag = substr($tag, 0, 64);
1191 function common_valid_profile_tag($str)
1193 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1197 * Resolve an ambiguous profile nickname reference, checking in following order:
1198 * - profiles that $sender subscribes to
1199 * - profiles that subscribe to $sender
1200 * - local user profiles
1202 * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1203 * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1206 * @fixme validate input
1208 * @fixme fix or remove mystery third parameter
1209 * @fixme is $sender a User or Profile?
1211 * @param <type> $sender the user or profile in whose context we're looking
1212 * @param string $nickname validated nickname of
1213 * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1215 * @return Profile or null
1217 function common_relative_profile($sender, $nickname, $dt=null)
1219 // Will throw exception on invalid input.
1220 $nickname = Nickname::normalize($nickname);
1222 // Try to find profiles this profile is subscribed to that have this nickname
1223 $recipient = new Profile();
1224 // XXX: use a join instead of a subquery
1225 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = 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 // Try to find profiles that listen to this profile and that have this nickname
1233 $recipient = new Profile();
1234 // XXX: use a join instead of a subquery
1235 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1236 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1237 if ($recipient->find(true)) {
1238 // XXX: should probably differentiate between profiles with
1239 // the same name by date of most recent update
1242 // If this is a local user, try to find a local user with that nickname.
1243 $sender = User::getKV('id', $sender->id);
1244 if ($sender instanceof User) {
1245 $recipient_user = User::getKV('nickname', $nickname);
1246 if ($recipient_user instanceof User) {
1247 return $recipient_user->getProfile();
1250 // Otherwise, no links. @messages from local users to remote users,
1251 // or from remote users to other remote users, are just
1252 // outside our ability to make intelligent guesses about
1256 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1258 if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1260 $path = $r->build($action, $args, $params, $fragment);
1262 $ssl = common_config('site', 'ssl') === 'always'
1263 || StatusNet::isHTTPS()
1264 || common_is_sensitive($action);
1266 if (common_config('site','fancy')) {
1267 $url = common_path($path, $ssl, $addSession);
1269 if (mb_strpos($path, '/index.php') === 0) {
1270 $url = common_path($path, $ssl, $addSession);
1272 $url = common_path('index.php/'.$path, $ssl, $addSession);
1275 Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1280 function common_is_sensitive($action)
1282 static $sensitive = array(
1287 'ApiOAuthRequestToken',
1288 'ApiOAuthAccessToken',
1289 'ApiOAuthAuthorize',
1295 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1296 $ssl = in_array($action, $sensitive);
1302 function common_path($relative, $ssl=false, $addSession=true)
1304 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1306 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1307 || StatusNet::isHTTPS()
1308 || common_config('site', 'ssl') === 'always') {
1310 if (is_string(common_config('site', 'sslserver')) &&
1311 mb_strlen(common_config('site', 'sslserver')) > 0) {
1312 $serverpart = common_config('site', 'sslserver');
1313 } else if (common_config('site', 'server')) {
1314 $serverpart = common_config('site', 'server');
1316 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1320 if (common_config('site', 'server')) {
1321 $serverpart = common_config('site', 'server');
1323 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1328 $relative = common_inject_session($relative, $serverpart);
1331 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1334 function common_inject_session($url, $serverpart = null)
1336 if (!common_have_session()) {
1340 if (empty($serverpart)) {
1341 $serverpart = parse_url($url, PHP_URL_HOST);
1344 $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1346 // Are we pointing to another server (like an SSL server?)
1348 if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1349 // Pass the session ID as a GET parameter
1350 $sesspart = session_name() . '=' . session_id();
1351 $i = strpos($url, '?');
1352 if ($i === false) { // no GET params, just append
1353 $url .= '?' . $sesspart;
1355 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1362 function common_date_string($dt)
1364 // XXX: do some sexy date formatting
1365 // return date(DATE_RFC822, $dt);
1366 $t = strtotime($dt);
1370 if ($now < $t) { // that shouldn't happen!
1371 return common_exact_date($dt);
1372 } else if ($diff < 60) {
1373 // TRANS: Used in notices to indicate when the notice was made compared to now.
1374 return _('a few seconds ago');
1375 } else if ($diff < 92) {
1376 // TRANS: Used in notices to indicate when the notice was made compared to now.
1377 return _('about a minute ago');
1378 } else if ($diff < 3300) {
1379 $minutes = round($diff/60);
1380 // TRANS: Used in notices to indicate when the notice was made compared to now.
1381 return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1382 } else if ($diff < 5400) {
1383 // TRANS: Used in notices to indicate when the notice was made compared to now.
1384 return _('about an hour ago');
1385 } else if ($diff < 22 * 3600) {
1386 $hours = round($diff/3600);
1387 // TRANS: Used in notices to indicate when the notice was made compared to now.
1388 return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1389 } else if ($diff < 37 * 3600) {
1390 // TRANS: Used in notices to indicate when the notice was made compared to now.
1391 return _('about a day ago');
1392 } else if ($diff < 24 * 24 * 3600) {
1393 $days = round($diff/(24*3600));
1394 // TRANS: Used in notices to indicate when the notice was made compared to now.
1395 return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1396 } else if ($diff < 46 * 24 * 3600) {
1397 // TRANS: Used in notices to indicate when the notice was made compared to now.
1398 return _('about a month ago');
1399 } else if ($diff < 330 * 24 * 3600) {
1400 $months = round($diff/(30*24*3600));
1401 // TRANS: Used in notices to indicate when the notice was made compared to now.
1402 return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1403 } else if ($diff < 480 * 24 * 3600) {
1404 // TRANS: Used in notices to indicate when the notice was made compared to now.
1405 return _('about a year ago');
1407 return common_exact_date($dt);
1411 function common_exact_date($dt)
1417 $_utc = new DateTimeZone('UTC');
1418 $_siteTz = new DateTimeZone(common_timezone());
1421 $dateStr = date('d F Y H:i:s', strtotime($dt));
1422 $d = new DateTime($dateStr, $_utc);
1423 $d->setTimezone($_siteTz);
1424 // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
1425 return $d->format(_('l, d-M-Y H:i:s T'));
1428 function common_date_w3dtf($dt)
1430 $dateStr = date('d F Y H:i:s', strtotime($dt));
1431 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1432 $d->setTimezone(new DateTimeZone(common_timezone()));
1433 return $d->format(DATE_W3C);
1436 function common_date_rfc2822($dt)
1438 $dateStr = date('d F Y H:i:s', strtotime($dt));
1439 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1440 $d->setTimezone(new DateTimeZone(common_timezone()));
1441 return $d->format('r');
1444 function common_date_iso8601($dt)
1446 $dateStr = date('d F Y H:i:s', strtotime($dt));
1447 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1448 $d->setTimezone(new DateTimeZone(common_timezone()));
1449 return $d->format('c');
1452 function common_sql_now()
1454 return common_sql_date(time());
1457 function common_sql_date($datetime)
1459 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1463 * Return an SQL fragment to calculate an age-based weight from a given
1464 * timestamp or datetime column.
1466 * @param string $column name of field we're comparing against current time
1467 * @param integer $dropoff divisor for age in seconds before exponentiation
1468 * @return string SQL fragment
1470 function common_sql_weight($column, $dropoff)
1472 if (common_config('db', 'type') == 'pgsql') {
1473 // PostgreSQL doesn't support timestampdiff function.
1474 // @fixme will this use the right time zone?
1475 // @fixme does this handle cross-year subtraction correctly?
1476 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1478 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1482 function common_redirect($url, $code=307)
1484 static $status = array(301 => "Moved Permanently",
1487 307 => "Temporary Redirect");
1489 header('HTTP/1.1 '.$code.' '.$status[$code]);
1490 header("Location: $url");
1491 header("Connection: close");
1493 $xo = new XMLOutputter();
1495 '-//W3C//DTD XHTML 1.0 Strict//EN',
1496 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1497 $xo->element('a', array('href' => $url), $url);
1502 // Stick the notice on the queue
1504 function common_enqueue_notice($notice)
1506 static $localTransports = array('ping');
1508 $transports = array();
1509 if (common_config('sms', 'enabled')) {
1510 $transports[] = 'sms';
1512 if (Event::hasHandler('HandleQueuedNotice')) {
1513 $transports[] = 'plugin';
1516 // We can skip these for gatewayed notices.
1517 if ($notice->isLocal()) {
1518 $transports = array_merge($transports, $localTransports);
1521 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1523 $qm = QueueManager::get();
1525 foreach ($transports as $transport)
1527 $qm->enqueue($notice, $transport);
1530 Event::handle('EndEnqueueNotice', array($notice, $transports));
1536 function common_profile_url($nickname)
1538 return common_local_url('showstream', array('nickname' => $nickname),
1543 * Should make up a reasonable root URL
1545 function common_root_url($ssl=false)
1547 $url = common_path('', $ssl, false);
1548 $i = strpos($url, '?');
1550 $url = substr($url, 0, $i);
1556 * returns $bytes bytes of random data as a hexadecimal string
1558 function common_random_hexstr($bytes)
1560 $str = @file_exists('/dev/urandom')
1561 ? common_urandom($bytes)
1562 : common_mtrand($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 function common_bare_mime($mimetype)
1869 $mimetype = mb_strtolower($mimetype);
1870 if ($semicolon = mb_strpos($mimetype, ';')) {
1871 $mimetype = mb_substr($mimetype, 0, $semicolon);
1876 function common_mime_type_match($type, $avail)
1878 if(array_key_exists($type, $avail)) {
1881 $parts = explode('/', $type);
1882 if(array_key_exists($parts[0] . '/*', $avail)) {
1883 return $parts[0] . '/*';
1884 } elseif(array_key_exists('*/*', $avail)) {
1892 function common_negotiate_type($cprefs, $sprefs)
1896 foreach(array_keys($sprefs) as $type) {
1897 $parts = explode('/', $type);
1898 if($parts[1] != '*') {
1899 $ckey = common_mime_type_match($type, $cprefs);
1901 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1906 foreach(array_keys($cprefs) as $type) {
1907 $parts = explode('/', $type);
1908 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1909 $skey = common_mime_type_match($type, $sprefs);
1911 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1917 $besttype = 'text/html';
1919 foreach(array_keys($combine) as $type) {
1920 if($combine[$type] > $bestq) {
1922 $bestq = $combine[$type];
1926 if ('text/html' === $besttype) {
1927 return "text/html; charset=utf-8";
1932 function common_config($main, $sub)
1935 return (array_key_exists($main, $config) &&
1936 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1939 function common_config_set($main, $sub, $value)
1942 if (!array_key_exists($main, $config)) {
1943 $config[$main] = array();
1945 $config[$main][$sub] = $value;
1948 function common_config_append($main, $sub, $value)
1951 if (!array_key_exists($main, $config)) {
1952 $config[$main] = array();
1954 if (!array_key_exists($sub, $config[$main])) {
1955 $config[$main][$sub] = array();
1957 if (!is_array($config[$main][$sub])) {
1958 $config[$main][$sub] = array($config[$main][$sub]);
1960 array_push($config[$main][$sub], $value);
1964 * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
1965 * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
1967 * @param array $from
1970 function common_copy_args($from)
1973 $strip = get_magic_quotes_gpc();
1974 foreach ($from as $k => $v) {
1976 $to[$k] = common_copy_args($v);
1979 $v = stripslashes($v);
1981 $to[$k] = strval(common_validate_utf8($v));
1988 * Neutralise the evil effects of magic_quotes_gpc in the current request.
1989 * This is used before handing a request off to OAuthRequest::from_request.
1990 * @fixme Doesn't consider vars other than _POST and _GET?
1991 * @fixme Can't be undone and could corrupt data if run twice.
1993 function common_remove_magic_from_request()
1995 if(get_magic_quotes_gpc()) {
1996 $_POST=array_map('stripslashes',$_POST);
1997 $_GET=array_map('stripslashes',$_GET);
2001 function common_user_uri(&$user)
2003 return common_local_url('userbyid', array('id' => $user->id),
2007 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2009 function common_confirmation_code($bits)
2011 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2012 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
2013 $chars = ceil($bits/5);
2015 for ($i = 0; $i < $chars; $i++) {
2016 // XXX: convert to string and back
2017 $num = hexdec(common_random_hexstr(1));
2018 // XXX: randomness is too precious to throw away almost
2019 // 40% of the bits we get!
2020 $code .= $codechars[$num%32];
2025 // convert markup to HTML
2026 function common_markup_to_html($c, $args=null)
2032 if (is_null($args)) {
2036 // XXX: not very efficient
2038 foreach ($args as $name => $value) {
2039 $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
2042 $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
2043 $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
2044 $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
2045 $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
2047 return \Michelf\Markdown::defaultTransform($c);
2050 function common_user_property($property)
2052 $profile = Profile::current();
2054 if (empty($profile)) {
2058 switch ($property) {
2064 return $profile->$property;
2068 return $profile->getAvatar(AVATAR_STREAM_SIZE);
2069 } catch (Exception $e) {
2074 return $profile->getBestName();
2081 function common_profile_uri($profile)
2085 if (!empty($profile)) {
2086 if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2087 $user = User::getKV('id', $profile->id);
2088 if ($user instanceof User) {
2089 $uri = $user->getUri();
2091 Event::handle('EndCommonProfileURI', array($profile, &$uri));
2095 // XXX: this is a very bad profile!
2099 function common_canonical_sms($sms)
2102 preg_replace('/\D/', '', $sms);
2106 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2111 case E_COMPILE_ERROR:
2115 case E_RECOVERABLE_ERROR:
2116 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2121 case E_COMPILE_WARNING:
2122 case E_CORE_WARNING:
2123 case E_USER_WARNING:
2124 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2129 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2134 case E_USER_DEPRECATED:
2135 // XXX: config variable to log this stuff, too
2139 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2144 // FIXME: show error page if we're on the Web
2145 /* Don't execute PHP internal error handler */
2149 function common_session_token()
2151 common_ensure_session();
2152 if (!array_key_exists('token', $_SESSION)) {
2153 $_SESSION['token'] = common_random_hexstr(64);
2155 return $_SESSION['token'];
2158 function common_license_terms($uri)
2160 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2161 return explode('-',$matches[1]);
2166 function common_compatible_license($from, $to)
2168 $from_terms = common_license_terms($from);
2169 // public domain and cc-by are compatible with everything
2170 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2173 $to_terms = common_license_terms($to);
2174 // sa is compatible across versions. IANAL
2175 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2176 return count(array_diff($from_terms, $to_terms)) == 0;
2178 // XXX: better compatibility check needed here!
2179 // Should at least normalise URIs
2180 return ($from == $to);
2184 * returns a quoted table name, if required according to config
2186 function common_database_tablename($tablename)
2188 if(common_config('db','quote_identifiers')) {
2189 $tablename = '"'. $tablename .'"';
2191 //table prefixes could be added here later
2196 * Shorten a URL with the current user's configured shortening service,
2197 * or ur1.ca if configured, or not at all if no shortening is set up.
2199 * @param string $long_url original URL
2200 * @param User $user to specify a particular user's options
2201 * @param boolean $force Force shortening (used when notice is too long)
2202 * @return string may return the original URL if shortening failed
2204 * @fixme provide a way to specify a particular shortener
2206 function common_shorten_url($long_url, User $user=null, $force = false)
2208 $long_url = trim($long_url);
2210 $user = common_current_user();
2212 $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2214 // $force forces shortening even if it's not strictly needed
2215 // I doubt URL shortening is ever 'strictly' needed. - ESP
2217 if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2221 $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2223 if (Event::handle('StartShortenUrl',
2224 array($long_url, $shortenerName, &$shortenedUrl))) {
2225 if ($shortenerName == 'internal') {
2227 $f = File::processNew($long_url);
2228 $shortenedUrl = common_local_url('redirecturl', array('id' => $f->id));
2229 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2230 return $shortenedUrl;
2234 } catch (ServerException $e) {
2241 //URL was shortened, so return the result
2242 return trim($shortenedUrl);
2247 * @return mixed array($proxy, $ip) for web requests; proxy may be null
2248 * null if not a web request
2250 * @fixme X-Forwarded-For can be chained by multiple proxies;
2251 we should parse the list and provide a cleaner array
2252 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2253 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2254 * use function to get exact request headers from Apache if possible.
2256 function common_client_ip()
2258 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2262 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2263 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2264 $proxy = $_SERVER['HTTP_CLIENT_IP'];
2266 $proxy = $_SERVER['REMOTE_ADDR'];
2268 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2271 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2272 $ip = $_SERVER['HTTP_CLIENT_IP'];
2274 $ip = $_SERVER['REMOTE_ADDR'];
2278 return array($proxy, $ip);
2281 function common_url_to_nickname($url)
2283 static $bad = array('query', 'user', 'password', 'port', 'fragment');
2285 $parts = parse_url($url);
2287 // If any of these parts exist, this won't work
2289 foreach ($bad as $badpart) {
2290 if (array_key_exists($badpart, $parts)) {
2295 // We just have host and/or path
2297 // If it's just a host...
2298 if (array_key_exists('host', $parts) &&
2299 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2301 $hostparts = explode('.', $parts['host']);
2303 // Try to catch common idiom of nickname.service.tld
2305 if ((count($hostparts) > 2) &&
2306 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2307 (strcmp($hostparts[0], 'www') != 0))
2309 return common_nicknamize($hostparts[0]);
2311 // Do the whole hostname
2312 return common_nicknamize($parts['host']);
2315 if (array_key_exists('path', $parts)) {
2316 // Strip starting, ending slashes
2317 $path = preg_replace('@/$@', '', $parts['path']);
2318 $path = preg_replace('@^/@', '', $path);
2319 $path = basename($path);
2321 // Hack for MediaWiki user pages, in the form:
2322 // http://example.com/wiki/User:Myname
2323 // ('User' may be localized.)
2324 if (strpos($path, ':')) {
2325 $parts = array_filter(explode(':', $path));
2326 $path = $parts[count($parts) - 1];
2330 return common_nicknamize($path);
2338 function common_nicknamize($str)
2341 return Nickname::normalize($str);
2342 } catch (NicknameException $e) {
2347 function common_perf_counter($key, $val=null)
2349 global $_perfCounters;
2350 if (isset($_perfCounters)) {
2351 if (common_config('site', 'logperf')) {
2352 if (array_key_exists($key, $_perfCounters)) {
2353 $_perfCounters[$key][] = $val;
2355 $_perfCounters[$key] = array($val);
2357 if (common_config('site', 'logperf_detail')) {
2358 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2364 function common_log_perf_counters()
2366 if (common_config('site', 'logperf')) {
2367 global $_startTime, $_perfCounters;
2369 if (isset($_startTime)) {
2370 $endTime = microtime(true);
2371 $diff = round(($endTime - $_startTime) * 1000);
2372 common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2374 $counters = $_perfCounters;
2376 foreach ($counters as $key => $values) {
2377 $count = count($values);
2378 $unique = count(array_unique($values));
2379 common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2384 function common_is_email($str)
2386 return (strpos($str, '@') !== false);
2389 function common_init_stats()
2393 $_mem = memory_get_usage(true);
2394 $_ts = microtime(true);
2397 function common_log_delta($comment=null)
2404 $_mem = memory_get_usage(true);
2405 $_ts = microtime(true);
2407 $mtotal = $_mem - $mold;
2408 $ttotal = $_ts - $told;
2410 if (empty($comment)) {
2414 common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
2417 function common_strip_html($html, $trim=true, $save_whitespace=false)
2419 if (!$save_whitespace) {
2420 $html = preg_replace('/\s+/', ' ', $html);
2422 $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
2423 return $trim ? trim($text) : $text;