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, // means that elements=* means elements=*-applet-embed-iframe-object-script or so
585 'deny_attribute' => 'id,style,on*');
587 // Remove more elements than what the 'safe' filter gives (elements must be '*' before this)
588 // http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed/htmLawed_README.htm#s3.6
589 foreach (common_config('htmlfilter') as $tag=>$filter) {
590 if ($filter === true) {
591 $config['elements'] .= "-{$tag}";
595 $html = common_remove_unicode_formatting($html);
597 return htmLawed($html, $config);
600 function common_remove_unicode_formatting($text)
602 // Strip Unicode text formatting/direction codes
603 // this is pretty dangerous for visualisation of text and can be used for mischief
604 return preg_replace('/[\\x{200b}-\\x{200f}\\x{202a}-\\x{202e}]/u', '', $text);
608 * Partial notice markup rendering step: build links to !group references.
610 * @param string $text partially rendered HTML
611 * @param Notice $notice in whose context we're working
612 * @return string partially rendered HTML
614 function common_render_content($text, Notice $notice)
616 $text = common_render_text($text);
617 $text = common_linkify_mentions($text, $notice);
622 * Finds @-mentions within the partially-rendered text section and
623 * turns them into live links.
625 * Should generally not be called except from common_render_content().
627 * @param string $text partially-rendered HTML
628 * @param Notice $notice in-progress or complete Notice object for context
629 * @return string partially-rendered HTML
631 function common_linkify_mentions($text, Notice $notice)
633 $mentions = common_find_mentions($text, $notice);
635 // We need to go through in reverse order by position,
636 // so our positions stay valid despite our fudging with the
641 foreach ($mentions as $mention)
643 $points[$mention['position']] = $mention;
648 foreach ($points as $position => $mention) {
650 $linkText = common_linkify_mention($mention);
652 $text = substr_replace($text, $linkText, $position, mb_strlen($mention['text']));
658 function common_linkify_mention(array $mention)
662 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
664 $xs = new XMLStringer(false);
666 $attrs = array('href' => $mention['url'],
667 'class' => 'h-card '.$mention['type']);
669 if (!empty($mention['title'])) {
670 $attrs['title'] = $mention['title'];
673 $xs->element('a', $attrs, $mention['text']);
675 $output = $xs->getString();
677 Event::handle('EndLinkifyMention', array($mention, &$output));
684 * Find @-mentions in the given text, using the given notice object as context.
685 * References will be resolved with common_relative_profile() against the user
686 * who posted the notice.
688 * Note the return data format is internal, to be used for building links and
689 * such. Should not be used directly; rather, call common_linkify_mentions().
691 * @param string $text
692 * @param Notice $notice notice in whose context we're building links
698 function common_find_mentions($text, Notice $notice)
700 // The getProfile call throws NoProfileException on failure
701 $sender = $notice->getProfile();
705 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
706 // Get the context of the original notice, if any
709 $origMentions = array();
714 $origNotice = $notice->getParent();
715 $origAuthor = $origNotice->getProfile();
717 $ids = $origNotice->getReplies();
719 foreach ($ids as $id) {
721 $repliedTo = Profile::getByID($id);
722 $origMentions[$repliedTo->getNickname()] = $repliedTo;
723 } catch (NoResultException $e) {
727 } catch (NoParentNoticeException $e) {
728 // It wasn't a reply to anything, so we can't harvest nickname-relations.
731 $matches = common_find_mentions_raw($text);
733 foreach ($matches as $match) {
735 $nickname = Nickname::normalize($match[0]);
736 } catch (NicknameException $e) {
737 // Bogus match? Drop it.
741 // Try to get a profile for this nickname.
742 // Start with conversation context, then go to
745 if ($origAuthor instanceof Profile && $origAuthor->nickname == $nickname) {
746 $mentioned = $origAuthor;
747 } else if (!empty($origMentions) &&
748 array_key_exists($nickname, $origMentions)) {
749 $mentioned = $origMentions[$nickname];
751 $mentioned = common_relative_profile($sender, $nickname);
754 if ($mentioned instanceof Profile) {
755 $user = User::getKV('id', $mentioned->id);
757 if ($user instanceof User) {
758 $url = common_local_url('userbyid', array('id' => $user->id));
760 $url = $mentioned->profileurl;
763 $mention = array('mentioned' => array($mentioned),
766 'position' => $match[1],
769 if (!empty($mentioned->fullname)) {
770 $mention['title'] = $mentioned->fullname;
773 $mentions[] = $mention;
777 // @#tag => mention of all subscriptions tagged 'tag'
779 preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
780 $text, $hmatches, PREG_OFFSET_CAPTURE);
781 foreach ($hmatches[1] as $hmatch) {
782 $tag = common_canonical_tag($hmatch[0]);
783 $plist = Profile_list::getByTaggerAndTag($sender->id, $tag);
784 if (!$plist instanceof Profile_list || $plist->private) {
787 $tagged = $sender->getTaggedSubscribers($tag);
789 $url = common_local_url('showprofiletag',
790 array('tagger' => $sender->nickname,
793 $mentions[] = array('mentioned' => $tagged,
795 'text' => $hmatch[0],
796 'position' => $hmatch[1],
800 preg_match_all('/(?:^|[\s\.\,\:\;]+)!(' . Nickname::DISPLAY_FMT . ')/',
801 $text, $hmatches, PREG_OFFSET_CAPTURE);
802 foreach ($hmatches[1] as $hmatch) {
803 $nickname = Nickname::normalize($hmatch[0]);
804 $group = User_group::getForNickname($nickname, $sender);
806 if (!$group instanceof User_group || !$sender->isMember($group)) {
810 $profile = $group->getProfile();
812 $mentions[] = array('mentioned' => array($profile),
814 'text' => $hmatch[0],
815 'position' => $hmatch[1],
816 'url' => $group->permalink(),
817 'title' => $group->getFancyName());
820 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
827 * Does the actual regex pulls to find @-mentions in text.
828 * Should generally not be called directly; for use in common_find_mentions.
830 * @param string $text
831 * @return array of PCRE match arrays
833 function common_find_mentions_raw($text)
836 preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
839 PREG_OFFSET_CAPTURE);
841 $atmatches = array();
842 preg_match_all('/(?:^|\s+)@(' . Nickname::DISPLAY_FMT . ')\b/',
845 PREG_OFFSET_CAPTURE);
847 $matches = array_merge($tmatches[1], $atmatches[1]);
851 function common_render_text($text)
853 $text = common_remove_unicode_formatting($text);
854 $text = nl2br(htmlspecialchars($text));
856 $text = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $text);
857 $text = common_replace_urls_callback($text, 'common_linkify');
858 $text = preg_replace_callback('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
859 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $text);
865 * Find links in the given text and pass them to the given callback function.
867 * @param string $text
868 * @param function($text, $arg) $callback: return replacement text
869 * @param mixed $arg: optional argument will be passed on to the callback
871 function common_replace_urls_callback($text, $callback, $arg = null) {
872 // Start off with a regex
874 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
877 '(?:'. //Known protocols
879 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
881 '(?:(?:mailto|aim|tel|xmpp):)'.
883 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
886 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
888 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
892 '|(?:(?:magnet):)'. // URLs without domain name
893 '|(?:(?: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
895 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
897 (common_config('linkify', 'bare_domains')
899 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
900 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
901 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
902 '(?: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)'.
904 : '') . // if common_config('linkify', 'bare_domains') is false, don't add anything here
907 '(?:\:\d+)?'. //:port
908 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
909 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
910 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
911 ')(?<![\?\.\,\#\,])'.
914 //preg_match_all($regex,$text,$matches);
916 return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
920 * Intermediate callback for common_replace_links(), helps resolve some
921 * ambiguous link forms before passing on to the final callback.
923 * @param array $matches
924 * @param callable $callback
925 * @param mixed $arg optional argument to pass on as second param to callback
930 function callback_helper($matches, $callback, $arg=null) {
932 $left = strpos($matches[0],$url);
933 $right = $left+strlen($url);
935 $groupSymbolSets=array(
953 $cannotEndWith=array('.','?',',','#');
957 foreach($groupSymbolSets as $groupSymbolSet){
958 if(substr($url,-1)==$groupSymbolSet['right']){
959 $group_left_count = substr_count($url,$groupSymbolSet['left']);
960 $group_right_count = substr_count($url,$groupSymbolSet['right']);
961 if($group_left_count<$group_right_count){
963 $url=substr($url,0,-1);
967 if(in_array(substr($url,-1),$cannotEndWith)){
969 $url=substr($url,0,-1);
971 }while($original_url!=$url);
973 $result = call_user_func_array($callback, array($url, $arg));
974 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
977 require_once INSTALLDIR . "/lib/curry.php";
979 function common_linkify($url) {
980 // It comes in special'd, so we unspecial it before passing to the stringifying
982 $url = htmlspecialchars_decode($url);
984 if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
985 //url is an email address without the mailto: protocol
986 $canon = "mailto:$url";
987 $longurl = "mailto:$url";
990 $canon = File_redirection::_canonUrl($url);
992 $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
993 if (is_array($longurl_data)) {
994 $longurl = $longurl_data['url'];
995 } elseif (is_string($longurl_data)) {
996 $longurl = $longurl_data;
998 // Unable to reach the server to verify contents, etc
999 // Just pass the link on through for now.
1000 common_log(LOG_ERR, "Can't linkify url '$url'");
1005 $attrs = array('href' => $canon, 'title' => $longurl);
1007 $is_attachment = false;
1008 $attachment_id = null;
1011 // Check to see whether this is a known "attachment" URL.
1013 $f = File::getKV('url', $longurl);
1015 if (!$f instanceof File) {
1016 if (common_config('attachments', 'process_links')) {
1017 // XXX: this writes to the database. :<
1019 $f = File::processNew($longurl);
1020 } catch (ServerException $e) {
1026 if ($f instanceof File) {
1028 $enclosure = $f->getEnclosure();
1029 $is_attachment = true;
1030 $attachment_id = $f->id;
1032 $thumb = File_thumbnail::getKV('file_id', $f->id);
1033 $has_thumb = ($thumb instanceof File_thumbnail);
1034 } catch (ServerException $e) {
1035 // There was not enough metadata available
1040 if ($is_attachment) {
1041 $attrs['class'] = 'attachment';
1043 $attrs['class'] = 'attachment thumbnail';
1045 $attrs['id'] = "attachment-{$attachment_id}";
1048 // Whether to nofollow
1050 $nf = common_config('nofollow', 'external');
1052 if ($nf == 'never') {
1053 $attrs['rel'] = 'external';
1055 $attrs['rel'] = 'nofollow external';
1058 return XMLStringer::estring('a', $attrs, $url);
1062 * Find and shorten links in a given chunk of text if it's longer than the
1063 * configured notice content limit (or unconditionally).
1065 * Side effects: may save file and file_redirection records for referenced URLs.
1067 * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1068 * user's options are used; otherwise the current web session user's setitngs
1069 * will be used or ur1.ca if there is no active web login.
1071 * @param string $text
1072 * @param boolean $always (optional)
1073 * @param User $user (optional)
1077 function common_shorten_links($text, $always = false, User $user=null)
1079 if ($user === null) {
1080 $user = common_current_user();
1083 $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1085 if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1086 return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1088 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1093 * Very basic stripping of invalid UTF-8 input text.
1095 * @param string $str
1096 * @return mixed string or null if invalid input
1098 * @todo ideally we should drop bad chars, and maybe do some of the checks
1099 * from common_xml_safe_str. But we can't strip newlines, etc.
1100 * @todo Unicode normalization might also be useful, but not needed now.
1102 function common_validate_utf8($str)
1104 // preg_replace will return NULL on invalid UTF-8 input.
1106 // Note: empty regex //u also caused NULL return on some
1107 // production machines, but none of our test machines.
1109 // This should be replaced with a more reliable check.
1110 return preg_replace('/\x00/u', '', $str);
1114 * Make sure an arbitrary string is safe for output in XML as a single line.
1116 * @param string $str
1119 function common_xml_safe_str($str)
1121 // Replace common eol and extra whitespace input chars
1126 "\0", // null byte eos
1127 "\x0B" // vertical tab
1130 $replacement = array(
1131 ' ', // single space
1138 $str = str_replace($unWelcome, $replacement, $str);
1140 // Neutralize any additional control codes and UTF-16 surrogates
1141 // (Twitter uses '*')
1142 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1145 function common_slugify($str)
1147 // php5-intl is highly recommended...
1148 if (!function_exists('transliterator_transliterate')) {
1149 $str = preg_replace('/[^\pL\pN]/u', '', $str);
1150 $str = mb_convert_case($str, MB_CASE_LOWER, 'UTF-8');
1151 $str = substr($str, 0, 64);
1154 $str = transliterator_transliterate(
1155 'Any-Latin;' . // any charset to latin compatible
1156 'NFD;' . // decompose
1157 '[:Nonspacing Mark:] Remove;' . // remove nonspacing marks (accents etc.)
1158 'NFC;' . // composite again
1159 '[:Punctuation:] Remove;' . // remove punctuation (.,¿? etc.)
1160 'Lower();' . // turn into lowercase
1161 'Latin-ASCII;', // get ASCII equivalents (ð to d for example)
1163 return preg_replace('/[^\pL\pN]/', '', $str);
1166 function common_tag_link($tag)
1168 $canonical = common_canonical_tag($tag);
1169 if (common_config('singleuser', 'enabled')) {
1170 // regular TagAction isn't set up in 1user mode
1171 $nickname = User::singleUserNickname();
1172 $url = common_local_url('showstream',
1173 array('nickname' => $nickname,
1174 'tag' => $canonical));
1176 $url = common_local_url('tag', array('tag' => $canonical));
1178 $xs = new XMLStringer();
1179 $xs->elementStart('span', 'tag');
1180 $xs->element('a', array('href' => $url,
1183 $xs->elementEnd('span');
1184 return $xs->getString();
1187 function common_canonical_tag($tag)
1189 $tag = common_slugify($tag);
1190 $tag = substr($tag, 0, 64);
1194 function common_valid_profile_tag($str)
1196 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1200 * Resolve an ambiguous profile nickname reference, checking in following order:
1201 * - profiles that $sender subscribes to
1202 * - profiles that subscribe to $sender
1203 * - local user profiles
1205 * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1206 * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1209 * @fixme validate input
1211 * @fixme fix or remove mystery third parameter
1212 * @fixme is $sender a User or Profile?
1214 * @param <type> $sender the user or profile in whose context we're looking
1215 * @param string $nickname validated nickname of
1216 * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1218 * @return Profile or null
1220 function common_relative_profile($sender, $nickname, $dt=null)
1222 // Will throw exception on invalid input.
1223 $nickname = Nickname::normalize($nickname);
1225 // Try to find profiles this profile is subscribed to that have this nickname
1226 $recipient = new Profile();
1227 // XXX: use a join instead of a subquery
1228 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1229 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1230 if ($recipient->find(true)) {
1231 // XXX: should probably differentiate between profiles with
1232 // the same name by date of most recent update
1235 // Try to find profiles that listen to this profile and that have this nickname
1236 $recipient = new Profile();
1237 // XXX: use a join instead of a subquery
1238 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1239 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1240 if ($recipient->find(true)) {
1241 // XXX: should probably differentiate between profiles with
1242 // the same name by date of most recent update
1245 // If this is a local user, try to find a local user with that nickname.
1246 $sender = User::getKV('id', $sender->id);
1247 if ($sender instanceof User) {
1248 $recipient_user = User::getKV('nickname', $nickname);
1249 if ($recipient_user instanceof User) {
1250 return $recipient_user->getProfile();
1253 // Otherwise, no links. @messages from local users to remote users,
1254 // or from remote users to other remote users, are just
1255 // outside our ability to make intelligent guesses about
1259 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1261 if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1263 $path = $r->build($action, $args, $params, $fragment);
1265 $ssl = common_config('site', 'ssl') === 'always'
1266 || GNUsocial::isHTTPS()
1267 || common_is_sensitive($action);
1269 if (common_config('site','fancy')) {
1270 $url = common_path($path, $ssl, $addSession);
1272 if (mb_strpos($path, '/index.php') === 0) {
1273 $url = common_path($path, $ssl, $addSession);
1275 $url = common_path('index.php/'.$path, $ssl, $addSession);
1278 Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1283 function common_is_sensitive($action)
1285 static $sensitive = array(
1290 'ApiOAuthRequestToken',
1291 'ApiOAuthAccessToken',
1292 'ApiOAuthAuthorize',
1298 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1299 $ssl = in_array($action, $sensitive);
1305 function common_path($relative, $ssl=false, $addSession=true)
1307 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1309 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1310 || GNUsocial::isHTTPS()
1311 || common_config('site', 'ssl') === 'always') {
1313 if (is_string(common_config('site', 'sslserver')) &&
1314 mb_strlen(common_config('site', 'sslserver')) > 0) {
1315 $serverpart = common_config('site', 'sslserver');
1316 } else 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.');
1323 if (common_config('site', 'server')) {
1324 $serverpart = common_config('site', 'server');
1326 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1331 $relative = common_inject_session($relative, $serverpart);
1334 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1337 function common_inject_session($url, $serverpart = null)
1339 if (!common_have_session()) {
1343 if (empty($serverpart)) {
1344 $serverpart = parse_url($url, PHP_URL_HOST);
1347 $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1349 // Are we pointing to another server (like an SSL server?)
1351 if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1352 // Pass the session ID as a GET parameter
1353 $sesspart = session_name() . '=' . session_id();
1354 $i = strpos($url, '?');
1355 if ($i === false) { // no GET params, just append
1356 $url .= '?' . $sesspart;
1358 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1365 function common_date_string($dt)
1367 // XXX: do some sexy date formatting
1368 // return date(DATE_RFC822, $dt);
1369 $t = strtotime($dt);
1373 if ($now < $t) { // that shouldn't happen!
1374 return common_exact_date($dt);
1375 } else if ($diff < 60) {
1376 // TRANS: Used in notices to indicate when the notice was made compared to now.
1377 return _('a few seconds ago');
1378 } else if ($diff < 92) {
1379 // TRANS: Used in notices to indicate when the notice was made compared to now.
1380 return _('about a minute ago');
1381 } else if ($diff < 3300) {
1382 $minutes = round($diff/60);
1383 // TRANS: Used in notices to indicate when the notice was made compared to now.
1384 return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1385 } else if ($diff < 5400) {
1386 // TRANS: Used in notices to indicate when the notice was made compared to now.
1387 return _('about an hour ago');
1388 } else if ($diff < 22 * 3600) {
1389 $hours = round($diff/3600);
1390 // TRANS: Used in notices to indicate when the notice was made compared to now.
1391 return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1392 } else if ($diff < 37 * 3600) {
1393 // TRANS: Used in notices to indicate when the notice was made compared to now.
1394 return _('about a day ago');
1395 } else if ($diff < 24 * 24 * 3600) {
1396 $days = round($diff/(24*3600));
1397 // TRANS: Used in notices to indicate when the notice was made compared to now.
1398 return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1399 } else if ($diff < 46 * 24 * 3600) {
1400 // TRANS: Used in notices to indicate when the notice was made compared to now.
1401 return _('about a month ago');
1402 } else if ($diff < 330 * 24 * 3600) {
1403 $months = round($diff/(30*24*3600));
1404 // TRANS: Used in notices to indicate when the notice was made compared to now.
1405 return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1406 } else if ($diff < 480 * 24 * 3600) {
1407 // TRANS: Used in notices to indicate when the notice was made compared to now.
1408 return _('about a year ago');
1410 return common_exact_date($dt);
1414 function common_exact_date($dt)
1420 $_utc = new DateTimeZone('UTC');
1421 $_siteTz = new DateTimeZone(common_timezone());
1424 $dateStr = date('d F Y H:i:s', strtotime($dt));
1425 $d = new DateTime($dateStr, $_utc);
1426 $d->setTimezone($_siteTz);
1427 // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
1428 return $d->format(_('l, d-M-Y H:i:s T'));
1431 function common_date_w3dtf($dt)
1433 $dateStr = date('d F Y H:i:s', strtotime($dt));
1434 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1435 $d->setTimezone(new DateTimeZone(common_timezone()));
1436 return $d->format(DATE_W3C);
1439 function common_date_rfc2822($dt)
1441 $dateStr = date('d F Y H:i:s', strtotime($dt));
1442 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1443 $d->setTimezone(new DateTimeZone(common_timezone()));
1444 return $d->format('r');
1447 function common_date_iso8601($dt)
1449 $dateStr = date('d F Y H:i:s', strtotime($dt));
1450 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1451 $d->setTimezone(new DateTimeZone(common_timezone()));
1452 return $d->format('c');
1455 function common_sql_now()
1457 return common_sql_date(time());
1460 function common_sql_date($datetime)
1462 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1466 * Return an SQL fragment to calculate an age-based weight from a given
1467 * timestamp or datetime column.
1469 * @param string $column name of field we're comparing against current time
1470 * @param integer $dropoff divisor for age in seconds before exponentiation
1471 * @return string SQL fragment
1473 function common_sql_weight($column, $dropoff)
1475 if (common_config('db', 'type') == 'pgsql') {
1476 // PostgreSQL doesn't support timestampdiff function.
1477 // @fixme will this use the right time zone?
1478 // @fixme does this handle cross-year subtraction correctly?
1479 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1481 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1485 function common_redirect($url, $code=307)
1487 static $status = array(301 => "Moved Permanently",
1490 307 => "Temporary Redirect");
1492 header('HTTP/1.1 '.$code.' '.$status[$code]);
1493 header("Location: $url");
1494 header("Connection: close");
1496 $xo = new XMLOutputter();
1498 '-//W3C//DTD XHTML 1.0 Strict//EN',
1499 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1500 $xo->element('a', array('href' => $url), $url);
1505 // Stick the notice on the queue
1507 function common_enqueue_notice($notice)
1509 static $localTransports = array('ping');
1511 $transports = array();
1512 if (common_config('sms', 'enabled')) {
1513 $transports[] = 'sms';
1515 if (Event::hasHandler('HandleQueuedNotice')) {
1516 $transports[] = 'plugin';
1519 // We can skip these for gatewayed notices.
1520 if ($notice->isLocal()) {
1521 $transports = array_merge($transports, $localTransports);
1524 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1526 $qm = QueueManager::get();
1528 foreach ($transports as $transport)
1530 $qm->enqueue($notice, $transport);
1533 Event::handle('EndEnqueueNotice', array($notice, $transports));
1539 function common_profile_url($nickname)
1541 return common_local_url('showstream', array('nickname' => $nickname),
1546 * Should make up a reasonable root URL
1548 function common_root_url($ssl=false)
1550 $url = common_path('', $ssl, false);
1551 $i = strpos($url, '?');
1553 $url = substr($url, 0, $i);
1559 * returns $bytes bytes of random data as a hexadecimal string
1561 function common_random_hexstr($bytes)
1563 $str = @file_exists('/dev/urandom')
1564 ? common_urandom($bytes)
1565 : common_mtrand($bytes);
1568 for ($i = 0; $i < $bytes; $i++) {
1569 $hexstr .= sprintf("%02x", ord($str[$i]));
1574 function common_urandom($bytes)
1576 $h = fopen('/dev/urandom', 'rb');
1578 $src = fread($h, $bytes);
1583 function common_mtrand($bytes)
1586 for ($i = 0; $i < $bytes; $i++) {
1587 $str .= chr(mt_rand(0, 255));
1593 * Record the given URL as the return destination for a future
1594 * form submission, to be read by common_get_returnto().
1596 * @param string $url
1598 * @fixme as a session-global setting, this can allow multiple forms
1599 * to conflict and overwrite each others' returnto destinations if
1600 * the user has multiple tabs or windows open.
1602 * Should refactor to index with a token or otherwise only pass the
1603 * data along its intended path.
1605 function common_set_returnto($url)
1607 common_ensure_session();
1608 $_SESSION['returnto'] = $url;
1612 * Fetch a return-destination URL previously recorded by
1613 * common_set_returnto().
1615 * @return mixed URL string or null
1617 * @fixme as a session-global setting, this can allow multiple forms
1618 * to conflict and overwrite each others' returnto destinations if
1619 * the user has multiple tabs or windows open.
1621 * Should refactor to index with a token or otherwise only pass the
1622 * data along its intended path.
1624 function common_get_returnto()
1626 common_ensure_session();
1627 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1630 function common_timestamp()
1632 return date('YmdHis');
1635 function common_ensure_syslog()
1637 static $initialized = false;
1638 if (!$initialized) {
1639 openlog(common_config('syslog', 'appname'), 0,
1640 common_config('syslog', 'facility'));
1641 $initialized = true;
1645 function common_log_line($priority, $msg)
1647 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1648 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1649 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1652 function common_request_id()
1655 $server = common_config('site', 'server');
1656 if (php_sapi_name() == 'cli') {
1657 $script = basename($_SERVER['PHP_SELF']);
1658 return "$server:$script:$pid";
1660 static $req_id = null;
1661 if (!isset($req_id)) {
1662 $req_id = substr(md5(mt_rand()), 0, 8);
1664 if (isset($_SERVER['REQUEST_URI'])) {
1665 $url = $_SERVER['REQUEST_URI'];
1667 $method = $_SERVER['REQUEST_METHOD'];
1668 return "$server:$pid.$req_id $method $url";
1672 function common_log($priority, $msg, $filename=null)
1674 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1675 $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1676 $msg = '[' . common_request_id() . '] ' . $msg;
1677 $logfile = common_config('site', 'logfile');
1679 $log = fopen($logfile, "a");
1681 $output = common_log_line($priority, $msg);
1682 fwrite($log, $output);
1686 common_ensure_syslog();
1687 syslog($priority, $msg);
1689 Event::handle('EndLog', array($priority, $msg, $filename));
1693 function common_debug($msg, $filename=null)
1696 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1698 common_log(LOG_DEBUG, $msg);
1702 function common_log_db_error(&$object, $verb, $filename=null)
1706 $objstr = common_log_objstring($object);
1707 $last_error = &$_PEAR->getStaticProperty('DB_DataObject','lastError');
1708 if (is_object($last_error)) {
1709 $msg = $last_error->message;
1711 $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1713 common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1716 function common_log_objstring(&$object)
1718 if (is_null($object)) {
1721 if (!($object instanceof DB_DataObject)) {
1724 $arr = $object->toArray();
1726 foreach ($arr as $k => $v) {
1727 if (is_object($v)) {
1728 $fields[] = "$k='".get_class($v)."'";
1730 $fields[] = "$k='$v'";
1733 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1737 function common_valid_http_url($url, $secure=false)
1739 // If $secure is true, only allow https URLs to pass
1740 // (if false, we use '?' in 'https?' to say the 's' is optional)
1741 $regex = $secure ? '/^https$/' : '/^https?$/';
1742 return filter_var($url, FILTER_VALIDATE_URL)
1743 && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1746 function common_valid_tag($tag)
1748 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1749 return (Validate::email($matches[1]) ||
1750 preg_match('/^([\w-\.]+)$/', $matches[1]));
1756 * Determine if given domain or address literal is valid
1757 * eg for use in JIDs and URLs. Does not check if the domain
1760 * @param string $domain
1761 * @return boolean valid or not
1763 function common_valid_domain($domain)
1765 $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1766 $ipv4 = "(?:$octet(?:\.$octet){3})";
1767 if (preg_match("/^$ipv4$/u", $domain)) return true;
1769 $group = "(?:[0-9a-f]{1,4})";
1770 $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1772 if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1773 $before = explode(":", $matches[1]);
1774 $zeroes = $matches[2];
1775 $after = explode(":", $matches[3]);
1783 $explicit = count($before) + count($after);
1784 if ($explicit < $min || $explicit > $max) {
1791 require_once "Net/IDNA.php";
1792 $idn = Net_IDNA::getInstance();
1793 $domain = $idn->encode($domain);
1794 } catch (Exception $e) {
1798 $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1799 $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1801 return preg_match("/^$fqdn$/ui", $domain);
1804 /* Following functions are copied from MediaWiki GlobalFunctions.php
1805 * and written by Evan Prodromou. */
1807 function common_accept_to_prefs($accept, $def = '*/*')
1809 // No arg means accept anything (per HTTP spec)
1811 return array($def => 1);
1816 $parts = explode(',', $accept);
1818 foreach($parts as $part) {
1819 // FIXME: doesn't deal with params like 'text/html; level=1'
1820 @list($value, $qpart) = explode(';', trim($part));
1822 if(!isset($qpart)) {
1824 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1825 $prefs[$value] = $match[1];
1832 // Match by our supported file extensions
1833 function common_supported_ext_to_mime($fileext)
1835 // Accept a filename and take out the extension
1836 if (strpos($fileext, '.') !== false) {
1837 $fileext = substr(strrchr($fileext, '.'), 1);
1840 $supported = common_config('attachments', 'supported');
1841 foreach($supported as $type => $ext) {
1842 if ($ext === $fileext) {
1847 throw new ServerException('Unsupported file extension');
1850 // Match by our supported mime types
1851 function common_supported_mime_to_ext($mimetype)
1853 $supported = common_config('attachments', 'supported');
1854 foreach($supported as $type => $ext) {
1855 if ($mimetype === $type) {
1860 throw new ServerException('Unsupported MIME type');
1863 // The MIME "media" is the part before the slash (video in video/webm)
1864 function common_get_mime_media($type)
1866 $tmp = explode('/', $type);
1867 return strtolower($tmp[0]);
1870 function common_bare_mime($mimetype)
1872 $mimetype = mb_strtolower($mimetype);
1873 if ($semicolon = mb_strpos($mimetype, ';')) {
1874 $mimetype = mb_substr($mimetype, 0, $semicolon);
1879 function common_mime_type_match($type, $avail)
1881 if(array_key_exists($type, $avail)) {
1884 $parts = explode('/', $type);
1885 if(array_key_exists($parts[0] . '/*', $avail)) {
1886 return $parts[0] . '/*';
1887 } elseif(array_key_exists('*/*', $avail)) {
1895 function common_negotiate_type($cprefs, $sprefs)
1899 foreach(array_keys($sprefs) as $type) {
1900 $parts = explode('/', $type);
1901 if($parts[1] != '*') {
1902 $ckey = common_mime_type_match($type, $cprefs);
1904 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1909 foreach(array_keys($cprefs) as $type) {
1910 $parts = explode('/', $type);
1911 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1912 $skey = common_mime_type_match($type, $sprefs);
1914 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1920 $besttype = 'text/html';
1922 foreach(array_keys($combine) as $type) {
1923 if($combine[$type] > $bestq) {
1925 $bestq = $combine[$type];
1929 if ('text/html' === $besttype) {
1930 return "text/html; charset=utf-8";
1935 function common_config($main, $sub=null)
1938 if (is_null($sub)) {
1939 // Return the config category array
1940 return array_key_exists($main, $config) ? $config[$main] : array();
1942 // Return the config value
1943 return (array_key_exists($main, $config) &&
1944 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1947 function common_config_set($main, $sub, $value)
1950 if (!array_key_exists($main, $config)) {
1951 $config[$main] = array();
1953 $config[$main][$sub] = $value;
1956 function common_config_append($main, $sub, $value)
1959 if (!array_key_exists($main, $config)) {
1960 $config[$main] = array();
1962 if (!array_key_exists($sub, $config[$main])) {
1963 $config[$main][$sub] = array();
1965 if (!is_array($config[$main][$sub])) {
1966 $config[$main][$sub] = array($config[$main][$sub]);
1968 array_push($config[$main][$sub], $value);
1972 * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
1973 * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
1975 * @param array $from
1978 function common_copy_args($from)
1981 $strip = get_magic_quotes_gpc();
1982 foreach ($from as $k => $v) {
1984 $to[$k] = common_copy_args($v);
1987 $v = stripslashes($v);
1989 $to[$k] = strval(common_validate_utf8($v));
1996 * Neutralise the evil effects of magic_quotes_gpc in the current request.
1997 * This is used before handing a request off to OAuthRequest::from_request.
1998 * @fixme Doesn't consider vars other than _POST and _GET?
1999 * @fixme Can't be undone and could corrupt data if run twice.
2001 function common_remove_magic_from_request()
2003 if(get_magic_quotes_gpc()) {
2004 $_POST=array_map('stripslashes',$_POST);
2005 $_GET=array_map('stripslashes',$_GET);
2009 function common_user_uri(&$user)
2011 return common_local_url('userbyid', array('id' => $user->id),
2015 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2017 function common_confirmation_code($bits)
2019 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2020 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
2021 $chars = ceil($bits/5);
2023 for ($i = 0; $i < $chars; $i++) {
2024 // XXX: convert to string and back
2025 $num = hexdec(common_random_hexstr(1));
2026 // XXX: randomness is too precious to throw away almost
2027 // 40% of the bits we get!
2028 $code .= $codechars[$num%32];
2033 // convert markup to HTML
2034 function common_markup_to_html($c, $args=null)
2040 if (is_null($args)) {
2044 // XXX: not very efficient
2046 foreach ($args as $name => $value) {
2047 $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
2050 $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
2051 $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
2052 $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
2053 $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
2055 return \Michelf\Markdown::defaultTransform($c);
2058 function common_user_property($property)
2060 $profile = Profile::current();
2062 if (empty($profile)) {
2066 switch ($property) {
2072 return $profile->$property;
2076 return $profile->getAvatar(AVATAR_STREAM_SIZE);
2077 } catch (Exception $e) {
2082 return $profile->getBestName();
2089 function common_profile_uri($profile)
2093 if (!empty($profile)) {
2094 if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2095 $user = User::getKV('id', $profile->id);
2096 if ($user instanceof User) {
2097 $uri = $user->getUri();
2099 Event::handle('EndCommonProfileURI', array($profile, &$uri));
2103 // XXX: this is a very bad profile!
2107 function common_canonical_sms($sms)
2110 preg_replace('/\D/', '', $sms);
2114 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2119 case E_COMPILE_ERROR:
2123 case E_RECOVERABLE_ERROR:
2124 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2129 case E_COMPILE_WARNING:
2130 case E_CORE_WARNING:
2131 case E_USER_WARNING:
2132 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2137 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2142 case E_USER_DEPRECATED:
2143 // XXX: config variable to log this stuff, too
2147 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2152 // FIXME: show error page if we're on the Web
2153 /* Don't execute PHP internal error handler */
2157 function common_session_token()
2159 common_ensure_session();
2160 if (!array_key_exists('token', $_SESSION)) {
2161 $_SESSION['token'] = common_random_hexstr(64);
2163 return $_SESSION['token'];
2166 function common_license_terms($uri)
2168 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2169 return explode('-',$matches[1]);
2174 function common_compatible_license($from, $to)
2176 $from_terms = common_license_terms($from);
2177 // public domain and cc-by are compatible with everything
2178 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2181 $to_terms = common_license_terms($to);
2182 // sa is compatible across versions. IANAL
2183 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2184 return count(array_diff($from_terms, $to_terms)) == 0;
2186 // XXX: better compatibility check needed here!
2187 // Should at least normalise URIs
2188 return ($from == $to);
2192 * returns a quoted table name, if required according to config
2194 function common_database_tablename($tablename)
2196 if(common_config('db','quote_identifiers')) {
2197 $tablename = '"'. $tablename .'"';
2199 //table prefixes could be added here later
2204 * Shorten a URL with the current user's configured shortening service,
2205 * or ur1.ca if configured, or not at all if no shortening is set up.
2207 * @param string $long_url original URL
2208 * @param User $user to specify a particular user's options
2209 * @param boolean $force Force shortening (used when notice is too long)
2210 * @return string may return the original URL if shortening failed
2212 * @fixme provide a way to specify a particular shortener
2214 function common_shorten_url($long_url, User $user=null, $force = false)
2216 $long_url = trim($long_url);
2218 $user = common_current_user();
2220 $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2222 // $force forces shortening even if it's not strictly needed
2223 // I doubt URL shortening is ever 'strictly' needed. - ESP
2225 if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2229 $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2231 if (Event::handle('StartShortenUrl',
2232 array($long_url, $shortenerName, &$shortenedUrl))) {
2233 if ($shortenerName == 'internal') {
2235 $f = File::processNew($long_url);
2236 $shortenedUrl = common_local_url('redirecturl', array('id' => $f->id));
2237 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2238 return $shortenedUrl;
2242 } catch (ServerException $e) {
2249 //URL was shortened, so return the result
2250 return trim($shortenedUrl);
2255 * @return mixed array($proxy, $ip) for web requests; proxy may be null
2256 * null if not a web request
2258 * @fixme X-Forwarded-For can be chained by multiple proxies;
2259 we should parse the list and provide a cleaner array
2260 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2261 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2262 * use function to get exact request headers from Apache if possible.
2264 function common_client_ip()
2266 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2270 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2271 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2272 $proxy = $_SERVER['HTTP_CLIENT_IP'];
2274 $proxy = $_SERVER['REMOTE_ADDR'];
2276 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2279 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2280 $ip = $_SERVER['HTTP_CLIENT_IP'];
2282 $ip = $_SERVER['REMOTE_ADDR'];
2286 return array($proxy, $ip);
2289 function common_url_to_nickname($url)
2291 static $bad = array('query', 'user', 'password', 'port', 'fragment');
2293 $parts = parse_url($url);
2295 // If any of these parts exist, this won't work
2297 foreach ($bad as $badpart) {
2298 if (array_key_exists($badpart, $parts)) {
2303 // We just have host and/or path
2305 // If it's just a host...
2306 if (array_key_exists('host', $parts) &&
2307 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2309 $hostparts = explode('.', $parts['host']);
2311 // Try to catch common idiom of nickname.service.tld
2313 if ((count($hostparts) > 2) &&
2314 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2315 (strcmp($hostparts[0], 'www') != 0))
2317 return common_nicknamize($hostparts[0]);
2319 // Do the whole hostname
2320 return common_nicknamize($parts['host']);
2323 if (array_key_exists('path', $parts)) {
2324 // Strip starting, ending slashes
2325 $path = preg_replace('@/$@', '', $parts['path']);
2326 $path = preg_replace('@^/@', '', $path);
2327 $path = basename($path);
2329 // Hack for MediaWiki user pages, in the form:
2330 // http://example.com/wiki/User:Myname
2331 // ('User' may be localized.)
2332 if (strpos($path, ':')) {
2333 $parts = array_filter(explode(':', $path));
2334 $path = $parts[count($parts) - 1];
2338 return common_nicknamize($path);
2346 function common_nicknamize($str)
2349 return Nickname::normalize($str);
2350 } catch (NicknameException $e) {
2355 function common_perf_counter($key, $val=null)
2357 global $_perfCounters;
2358 if (isset($_perfCounters)) {
2359 if (common_config('site', 'logperf')) {
2360 if (array_key_exists($key, $_perfCounters)) {
2361 $_perfCounters[$key][] = $val;
2363 $_perfCounters[$key] = array($val);
2365 if (common_config('site', 'logperf_detail')) {
2366 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2372 function common_log_perf_counters()
2374 if (common_config('site', 'logperf')) {
2375 global $_startTime, $_perfCounters;
2377 if (isset($_startTime)) {
2378 $endTime = microtime(true);
2379 $diff = round(($endTime - $_startTime) * 1000);
2380 common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2382 $counters = $_perfCounters;
2384 foreach ($counters as $key => $values) {
2385 $count = count($values);
2386 $unique = count(array_unique($values));
2387 common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2392 function common_is_email($str)
2394 return (strpos($str, '@') !== false);
2397 function common_init_stats()
2401 $_mem = memory_get_usage(true);
2402 $_ts = microtime(true);
2405 function common_log_delta($comment=null)
2412 $_mem = memory_get_usage(true);
2413 $_ts = microtime(true);
2415 $mtotal = $_mem - $mold;
2416 $ttotal = $_ts - $told;
2418 if (empty($comment)) {
2422 common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
2425 function common_strip_html($html, $trim=true, $save_whitespace=false)
2427 if (!$save_whitespace) {
2428 $html = preg_replace('/\s+/', ' ', $html);
2430 $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
2431 return $trim ? trim($text) : $text;