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;
254 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__);
389 $rm->query('COMMIT');
391 $cookieval = $rm->user_id . ':' . $rm->code;
393 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
395 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
400 function common_remembered_user()
404 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
410 list($id, $code) = explode(':', $packed);
412 if (!$id || !$code) {
413 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
418 $rm = Remember_me::getKV('code', $code);
421 common_log(LOG_WARNING, 'No such remember code: ' . $code);
426 if ($rm->user_id != $id) {
427 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
432 $user = User::getKV('id', $rm->user_id);
434 if (!$user instanceof User) {
435 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
441 $result = $rm->delete();
444 common_log_db_error($rm, 'DELETE', __FILE__);
445 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
450 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
452 common_set_user($user);
453 common_real_login(false);
455 // We issue a new cookie, so they can log in
456 // automatically again after this session
458 common_rememberme($user);
464 * must be called with a valid user!
466 function common_forgetme()
468 common_set_cookie(REMEMBERME, '', 0);
472 * Who is the current user?
474 function common_current_user()
478 if (!_have_config()) {
482 if ($_cur === false) {
484 if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
485 || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
486 common_ensure_session();
487 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
489 $user = User::getKV('id', $id);
490 if ($user instanceof User) {
497 // that didn't work; try to remember; will init $_cur to null on failure
498 $_cur = common_remembered_user();
501 // XXX: Is this necessary?
502 $_SESSION['userid'] = $_cur->id;
510 * Logins that are 'remembered' aren't 'real' -- they're subject to
511 * cookie-stealing. So, we don't let them do certain things. New reg,
512 * OpenID, and password logins _are_ real.
514 function common_real_login($real=true)
516 common_ensure_session();
517 $_SESSION['real_login'] = $real;
520 function common_is_real_login()
522 return common_logged_in() && $_SESSION['real_login'];
526 * Get a hash portion for HTTP caching Etags and such including
527 * info on the current user's session. If login/logout state changes,
528 * or we've changed accounts, or we've renamed the current user,
529 * we'll get a new hash value.
531 * This should not be considered secure information.
533 * @param User $user (optional; uses common_current_user() if left out)
536 function common_user_cache_hash($user=false)
538 if ($user === false) {
539 $user = common_current_user();
542 return crc32($user->id . ':' . $user->nickname);
549 * get canonical version of nickname for comparison
551 * @param string $nickname
554 * @throws NicknameException on invalid input
555 * @deprecated call Nickname::normalize() directly.
557 function common_canonical_nickname($nickname)
559 return Nickname::normalize($nickname);
563 * get canonical version of email for comparison
565 * @fixme actually normalize
566 * @fixme reject invalid input
568 * @param string $email
571 function common_canonical_email($email)
573 // XXX: canonicalize UTF-8
574 // XXX: lcase the domain part
579 * Partial notice markup rendering step: build links to !group references.
581 * @param string $text partially rendered HTML
582 * @param Notice $notice in whose context we're working
583 * @return string partially rendered HTML
585 function common_render_content($text, Notice $notice)
587 $r = common_render_text($text);
588 $r = common_linkify_mentions($r, $notice);
593 * Finds @-mentions within the partially-rendered text section and
594 * turns them into live links.
596 * Should generally not be called except from common_render_content().
598 * @param string $text partially-rendered HTML
599 * @param Notice $notice in-progress or complete Notice object for context
600 * @return string partially-rendered HTML
602 function common_linkify_mentions($text, $notice)
604 $mentions = common_find_mentions($text, $notice);
606 // We need to go through in reverse order by position,
607 // so our positions stay valid despite our fudging with the
612 foreach ($mentions as $mention)
614 $points[$mention['position']] = $mention;
619 foreach ($points as $position => $mention) {
621 $linkText = common_linkify_mention($mention);
623 $text = substr_replace($text, $linkText, $position, mb_strlen($mention['text']));
629 function common_linkify_mention($mention)
633 if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
635 $xs = new XMLStringer(false);
637 $attrs = array('href' => $mention['url'],
640 if (!empty($mention['title'])) {
641 $attrs['title'] = $mention['title'];
644 $xs->elementStart('span', 'vcard');
645 $xs->elementStart('a', $attrs);
646 $xs->element('span', 'fn nickname mention', $mention['text']);
647 $xs->elementEnd('a');
648 $xs->elementEnd('span');
650 $output = $xs->getString();
652 Event::handle('EndLinkifyMention', array($mention, &$output));
659 * Find @-mentions in the given text, using the given notice object as context.
660 * References will be resolved with common_relative_profile() against the user
661 * who posted the notice.
663 * Note the return data format is internal, to be used for building links and
664 * such. Should not be used directly; rather, call common_linkify_mentions().
666 * @param string $text
667 * @param Notice $notice notice in whose context we're building links
673 function common_find_mentions($text, $notice)
676 $sender = Profile::getKV('id', $notice->profile_id);
677 } catch (NoProfileException $e) {
683 if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
684 // Get the context of the original notice, if any
687 $origMentions = array();
691 if ($notice instanceof Notice) {
693 $origNotice = $notice->getParent();
694 $origAuthor = $origNotice->getProfile();
696 $ids = $origNotice->getReplies();
698 foreach ($ids as $id) {
699 $repliedTo = Profile::getKV('id', $id);
700 if ($repliedTo instanceof Profile) {
701 $origMentions[$repliedTo->nickname] = $repliedTo;
704 } catch (NoProfileException $e) {
705 common_log(LOG_WARNING, sprintf('Notice %d author profile id %d does not exist', $origNotice->id, $origNotice->profile_id));
706 } catch (ServerException $e) {
707 common_log(LOG_WARNING, __METHOD__ . ' got exception: ' . $e->getMessage());
708 } catch (Exception $e) {
709 // Probably just no parent. Should get a specific NoParentException
713 $matches = common_find_mentions_raw($text);
715 foreach ($matches as $match) {
717 $nickname = Nickname::normalize($match[0]);
718 } catch (NicknameException $e) {
719 // Bogus match? Drop it.
723 // Try to get a profile for this nickname.
724 // Start with conversation context, then go to
727 if ($origAuthor instanceof Profile && $origAuthor->nickname == $nickname) {
728 $mentioned = $origAuthor;
729 } else if (!empty($origMentions) &&
730 array_key_exists($nickname, $origMentions)) {
731 $mentioned = $origMentions[$nickname];
733 $mentioned = common_relative_profile($sender, $nickname);
736 if ($mentioned instanceof Profile) {
737 $user = User::getKV('id', $mentioned->id);
739 if ($user instanceof User) {
740 $url = common_local_url('userbyid', array('id' => $user->id));
742 $url = $mentioned->profileurl;
745 $mention = array('mentioned' => array($mentioned),
747 'position' => $match[1],
750 if (!empty($mentioned->fullname)) {
751 $mention['title'] = $mentioned->fullname;
754 $mentions[] = $mention;
758 // @#tag => mention of all subscriptions tagged 'tag'
760 preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
761 $text, $hmatches, PREG_OFFSET_CAPTURE);
762 foreach ($hmatches[1] as $hmatch) {
763 $tag = common_canonical_tag($hmatch[0]);
764 $plist = Profile_list::getByTaggerAndTag($sender->id, $tag);
765 if (!$plist instanceof Profile_list || $plist->private) {
768 $tagged = $sender->getTaggedSubscribers($tag);
770 $url = common_local_url('showprofiletag',
771 array('tagger' => $sender->nickname,
774 $mentions[] = array('mentioned' => $tagged,
775 'text' => $hmatch[0],
776 'position' => $hmatch[1],
780 preg_match_all('/(?:^|[\s\.\,\:\;]+)!(' . Nickname::DISPLAY_FMT . ')/',
781 $text, $hmatches, PREG_OFFSET_CAPTURE);
782 foreach ($hmatches[1] as $hmatch) {
783 $nickname = Nickname::normalize($hmatch[0]);
784 $group = User_group::getForNickname($nickname, $sender);
786 if (!$group instanceof User_group || !$sender->isMember($group)) {
790 $profile = $group->getProfile();
792 $mentions[] = array('mentioned' => array($profile),
793 'text' => $hmatch[0],
794 'position' => $hmatch[1],
795 'url' => $group->permalink(),
796 'title' => $group->getFancyName());
799 Event::handle('EndFindMentions', array($sender, $text, &$mentions));
806 * Does the actual regex pulls to find @-mentions in text.
807 * Should generally not be called directly; for use in common_find_mentions.
809 * @param string $text
810 * @return array of PCRE match arrays
812 function common_find_mentions_raw($text)
815 preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
818 PREG_OFFSET_CAPTURE);
820 $atmatches = array();
821 preg_match_all('/(?:^|\s+)@(' . Nickname::DISPLAY_FMT . ')\b/',
824 PREG_OFFSET_CAPTURE);
826 $matches = array_merge($tmatches[1], $atmatches[1]);
830 function common_render_text($text)
832 $r = htmlspecialchars($text);
834 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
835 $r = common_replace_urls_callback($r, 'common_linkify');
836 $r = preg_replace_callback('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
837 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $r);
843 * Find links in the given text and pass them to the given callback function.
845 * @param string $text
846 * @param function($text, $arg) $callback: return replacement text
847 * @param mixed $arg: optional argument will be passed on to the callback
849 function common_replace_urls_callback($text, $callback, $arg = null) {
850 // Start off with a regex
852 '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
855 '(?:'. //Known protocols
857 '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
859 '(?:(?:mailto|aim|tel|xmpp):)'.
861 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
864 '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
866 '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
870 '|(?:(?: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
872 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
874 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
875 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
876 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
877 '(?: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|ZW|local|loc|onion)'.
881 '(?:\:\d+)?'. //:port
882 '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
883 '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
884 '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
885 ')(?<![\?\.\,\#\,])'.
888 //preg_match_all($regex,$text,$matches);
890 return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
894 * Intermediate callback for common_replace_links(), helps resolve some
895 * ambiguous link forms before passing on to the final callback.
897 * @param array $matches
898 * @param callable $callback
899 * @param mixed $arg optional argument to pass on as second param to callback
904 function callback_helper($matches, $callback, $arg=null) {
906 $left = strpos($matches[0],$url);
907 $right = $left+strlen($url);
909 $groupSymbolSets=array(
927 $cannotEndWith=array('.','?',',','#');
931 foreach($groupSymbolSets as $groupSymbolSet){
932 if(substr($url,-1)==$groupSymbolSet['right']){
933 $group_left_count = substr_count($url,$groupSymbolSet['left']);
934 $group_right_count = substr_count($url,$groupSymbolSet['right']);
935 if($group_left_count<$group_right_count){
937 $url=substr($url,0,-1);
941 if(in_array(substr($url,-1),$cannotEndWith)){
943 $url=substr($url,0,-1);
945 }while($original_url!=$url);
947 $result = call_user_func_array($callback, array($url, $arg));
948 return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
951 if (version_compare(PHP_VERSION, '5.3.0', 'ge')) {
952 // lambda implementation in a separate file; PHP 5.2 won't parse it.
953 require_once INSTALLDIR . "/lib/curry.php";
955 function curry($fn) {
956 $args = func_get_args();
958 $id = uniqid('_partial');
959 $GLOBALS[$id] = array($fn, $args);
960 return create_function('',
961 '$args = func_get_args(); '.
962 'return call_user_func_array('.
963 '$GLOBALS["'.$id.'"][0],'.
966 '$GLOBALS["'.$id.'"][1]));');
970 function common_linkify($url) {
971 // It comes in special'd, so we unspecial it before passing to the stringifying
973 $url = htmlspecialchars_decode($url);
975 if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
976 //url is an email address without the mailto: protocol
977 $canon = "mailto:$url";
978 $longurl = "mailto:$url";
981 $canon = File_redirection::_canonUrl($url);
983 $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
984 if (is_array($longurl_data)) {
985 $longurl = $longurl_data['url'];
986 } elseif (is_string($longurl_data)) {
987 $longurl = $longurl_data;
989 // Unable to reach the server to verify contents, etc
990 // Just pass the link on through for now.
991 common_log(LOG_ERR, "Can't linkify url '$url'");
996 $attrs = array('href' => $canon, 'title' => $longurl);
998 $is_attachment = false;
999 $attachment_id = null;
1002 // Check to see whether this is a known "attachment" URL.
1004 $f = File::getKV('url', $longurl);
1007 if (common_config('attachments', 'process_links')) {
1008 // XXX: this writes to the database. :<
1009 $f = File::processNew($longurl);
1014 if ($f->getEnclosure()) {
1015 $is_attachment = true;
1016 $attachment_id = $f->id;
1018 $thumb = File_thumbnail::getKV('file_id', $f->id);
1019 if (!empty($thumb)) {
1026 if ($is_attachment) {
1027 $attrs['class'] = 'attachment';
1029 $attrs['class'] = 'attachment thumbnail';
1031 $attrs['id'] = "attachment-{$attachment_id}";
1034 // Whether to nofollow
1036 $nf = common_config('nofollow', 'external');
1038 if ($nf == 'never') {
1039 $attrs['rel'] = 'external';
1041 $attrs['rel'] = 'nofollow external';
1044 return XMLStringer::estring('a', $attrs, $url);
1048 * Find and shorten links in a given chunk of text if it's longer than the
1049 * configured notice content limit (or unconditionally).
1051 * Side effects: may save file and file_redirection records for referenced URLs.
1053 * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1054 * user's options are used; otherwise the current web session user's setitngs
1055 * will be used or ur1.ca if there is no active web login.
1057 * @param string $text
1058 * @param boolean $always (optional)
1059 * @param User $user (optional)
1063 function common_shorten_links($text, $always = false, User $user=null)
1065 if ($user === null) {
1066 $user = common_current_user();
1069 $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1071 if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1072 return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1074 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1079 * Very basic stripping of invalid UTF-8 input text.
1081 * @param string $str
1082 * @return mixed string or null if invalid input
1084 * @todo ideally we should drop bad chars, and maybe do some of the checks
1085 * from common_xml_safe_str. But we can't strip newlines, etc.
1086 * @todo Unicode normalization might also be useful, but not needed now.
1088 function common_validate_utf8($str)
1090 // preg_replace will return NULL on invalid UTF-8 input.
1092 // Note: empty regex //u also caused NULL return on some
1093 // production machines, but none of our test machines.
1095 // This should be replaced with a more reliable check.
1096 return preg_replace('/\x00/u', '', $str);
1100 * Make sure an arbitrary string is safe for output in XML as a single line.
1102 * @param string $str
1105 function common_xml_safe_str($str)
1107 // Replace common eol and extra whitespace input chars
1112 "\0", // null byte eos
1113 "\x0B" // vertical tab
1116 $replacement = array(
1117 ' ', // single space
1124 $str = str_replace($unWelcome, $replacement, $str);
1126 // Neutralize any additional control codes and UTF-16 surrogates
1127 // (Twitter uses '*')
1128 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1131 function common_tag_link($tag)
1133 $canonical = common_canonical_tag($tag);
1134 if (common_config('singleuser', 'enabled')) {
1135 // regular TagAction isn't set up in 1user mode
1136 $nickname = User::singleUserNickname();
1137 $url = common_local_url('showstream',
1138 array('nickname' => $nickname,
1139 'tag' => $canonical));
1141 $url = common_local_url('tag', array('tag' => $canonical));
1143 $xs = new XMLStringer();
1144 $xs->elementStart('span', 'tag');
1145 $xs->element('a', array('href' => $url,
1148 $xs->elementEnd('span');
1149 return $xs->getString();
1152 function common_canonical_tag($tag)
1155 $tag = preg_replace('/[^\pL\pN]/u', '', $tag);
1156 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
1157 $tag = substr($tag, 0, 64);
1161 function common_valid_profile_tag($str)
1163 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1167 * Resolve an ambiguous profile nickname reference, checking in following order:
1168 * - profiles that $sender subscribes to
1169 * - profiles that subscribe to $sender
1170 * - local user profiles
1172 * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1173 * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1176 * @fixme validate input
1178 * @fixme fix or remove mystery third parameter
1179 * @fixme is $sender a User or Profile?
1181 * @param <type> $sender the user or profile in whose context we're looking
1182 * @param string $nickname validated nickname of
1183 * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1185 * @return Profile or null
1187 function common_relative_profile($sender, $nickname, $dt=null)
1189 // Will throw exception on invalid input.
1190 $nickname = Nickname::normalize($nickname);
1192 // Try to find profiles this profile is subscribed to that have this nickname
1193 $recipient = new Profile();
1194 // XXX: use a join instead of a subquery
1195 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1196 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1197 if ($recipient->find(true)) {
1198 // XXX: should probably differentiate between profiles with
1199 // the same name by date of most recent update
1202 // Try to find profiles that listen to this profile and that have this nickname
1203 $recipient = new Profile();
1204 // XXX: use a join instead of a subquery
1205 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1206 $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1207 if ($recipient->find(true)) {
1208 // XXX: should probably differentiate between profiles with
1209 // the same name by date of most recent update
1212 // If this is a local user, try to find a local user with that nickname.
1213 $sender = User::getKV('id', $sender->id);
1214 if ($sender instanceof User) {
1215 $recipient_user = User::getKV('nickname', $nickname);
1216 if ($recipient_user instanceof User) {
1217 return $recipient_user->getProfile();
1220 // Otherwise, no links. @messages from local users to remote users,
1221 // or from remote users to other remote users, are just
1222 // outside our ability to make intelligent guesses about
1226 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1228 if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1230 $path = $r->build($action, $args, $params, $fragment);
1232 $ssl = common_config('site', 'ssl') === 'always'
1233 || StatusNet::isHTTPS()
1234 || common_is_sensitive($action);
1236 if (common_config('site','fancy')) {
1237 $url = common_path($path, $ssl, $addSession);
1239 if (mb_strpos($path, '/index.php') === 0) {
1240 $url = common_path($path, $ssl, $addSession);
1242 $url = common_path('index.php/'.$path, $ssl, $addSession);
1245 Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1250 function common_is_sensitive($action)
1252 static $sensitive = array(
1257 'ApiOAuthRequestToken',
1258 'ApiOAuthAccessToken',
1259 'ApiOAuthAuthorize',
1265 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1266 $ssl = in_array($action, $sensitive);
1272 function common_path($relative, $ssl=false, $addSession=true)
1274 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1276 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1277 || common_config('site', 'ssl') === 'always') {
1279 if (is_string(common_config('site', 'sslserver')) &&
1280 mb_strlen(common_config('site', 'sslserver')) > 0) {
1281 $serverpart = common_config('site', 'sslserver');
1282 } else if (common_config('site', 'server')) {
1283 $serverpart = common_config('site', 'server');
1285 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1289 if (common_config('site', 'server')) {
1290 $serverpart = common_config('site', 'server');
1292 common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1297 $relative = common_inject_session($relative, $serverpart);
1300 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1303 function common_inject_session($url, $serverpart = null)
1305 if (!common_have_session()) {
1309 if (empty($serverpart)) {
1310 $serverpart = parse_url($url, PHP_URL_HOST);
1313 $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1315 // Are we pointing to another server (like an SSL server?)
1317 if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1318 // Pass the session ID as a GET parameter
1319 $sesspart = session_name() . '=' . session_id();
1320 $i = strpos($url, '?');
1321 if ($i === false) { // no GET params, just append
1322 $url .= '?' . $sesspart;
1324 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1331 function common_date_string($dt)
1333 // XXX: do some sexy date formatting
1334 // return date(DATE_RFC822, $dt);
1335 $t = strtotime($dt);
1339 if ($now < $t) { // that shouldn't happen!
1340 return common_exact_date($dt);
1341 } else if ($diff < 60) {
1342 // TRANS: Used in notices to indicate when the notice was made compared to now.
1343 return _('a few seconds ago');
1344 } else if ($diff < 92) {
1345 // TRANS: Used in notices to indicate when the notice was made compared to now.
1346 return _('about a minute ago');
1347 } else if ($diff < 3300) {
1348 $minutes = round($diff/60);
1349 // TRANS: Used in notices to indicate when the notice was made compared to now.
1350 return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1351 } else if ($diff < 5400) {
1352 // TRANS: Used in notices to indicate when the notice was made compared to now.
1353 return _('about an hour ago');
1354 } else if ($diff < 22 * 3600) {
1355 $hours = round($diff/3600);
1356 // TRANS: Used in notices to indicate when the notice was made compared to now.
1357 return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1358 } else if ($diff < 37 * 3600) {
1359 // TRANS: Used in notices to indicate when the notice was made compared to now.
1360 return _('about a day ago');
1361 } else if ($diff < 24 * 24 * 3600) {
1362 $days = round($diff/(24*3600));
1363 // TRANS: Used in notices to indicate when the notice was made compared to now.
1364 return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1365 } else if ($diff < 46 * 24 * 3600) {
1366 // TRANS: Used in notices to indicate when the notice was made compared to now.
1367 return _('about a month ago');
1368 } else if ($diff < 330 * 24 * 3600) {
1369 $months = round($diff/(30*24*3600));
1370 // TRANS: Used in notices to indicate when the notice was made compared to now.
1371 return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1372 } else if ($diff < 480 * 24 * 3600) {
1373 // TRANS: Used in notices to indicate when the notice was made compared to now.
1374 return _('about a year ago');
1376 return common_exact_date($dt);
1380 function common_exact_date($dt)
1386 $_utc = new DateTimeZone('UTC');
1387 $_siteTz = new DateTimeZone(common_timezone());
1390 $dateStr = date('d F Y H:i:s', strtotime($dt));
1391 $d = new DateTime($dateStr, $_utc);
1392 $d->setTimezone($_siteTz);
1393 return $d->format(DATE_RFC850);
1396 function common_date_w3dtf($dt)
1398 $dateStr = date('d F Y H:i:s', strtotime($dt));
1399 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1400 $d->setTimezone(new DateTimeZone(common_timezone()));
1401 return $d->format(DATE_W3C);
1404 function common_date_rfc2822($dt)
1406 $dateStr = date('d F Y H:i:s', strtotime($dt));
1407 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1408 $d->setTimezone(new DateTimeZone(common_timezone()));
1409 return $d->format('r');
1412 function common_date_iso8601($dt)
1414 $dateStr = date('d F Y H:i:s', strtotime($dt));
1415 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1416 $d->setTimezone(new DateTimeZone(common_timezone()));
1417 return $d->format('c');
1420 function common_sql_now()
1422 return common_sql_date(time());
1425 function common_sql_date($datetime)
1427 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1431 * Return an SQL fragment to calculate an age-based weight from a given
1432 * timestamp or datetime column.
1434 * @param string $column name of field we're comparing against current time
1435 * @param integer $dropoff divisor for age in seconds before exponentiation
1436 * @return string SQL fragment
1438 function common_sql_weight($column, $dropoff)
1440 if (common_config('db', 'type') == 'pgsql') {
1441 // PostgreSQL doesn't support timestampdiff function.
1442 // @fixme will this use the right time zone?
1443 // @fixme does this handle cross-year subtraction correctly?
1444 return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1446 return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1450 function common_redirect($url, $code=307)
1452 static $status = array(301 => "Moved Permanently",
1455 307 => "Temporary Redirect");
1457 header('HTTP/1.1 '.$code.' '.$status[$code]);
1458 header("Location: $url");
1459 header("Connection: close");
1461 $xo = new XMLOutputter();
1463 '-//W3C//DTD XHTML 1.0 Strict//EN',
1464 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1465 $xo->element('a', array('href' => $url), $url);
1470 // Stick the notice on the queue
1472 function common_enqueue_notice($notice)
1474 static $localTransports = array('ping');
1476 $transports = array();
1477 if (common_config('sms', 'enabled')) {
1478 $transports[] = 'sms';
1480 if (Event::hasHandler('HandleQueuedNotice')) {
1481 $transports[] = 'plugin';
1484 // We can skip these for gatewayed notices.
1485 if ($notice->isLocal()) {
1486 $transports = array_merge($transports, $localTransports);
1489 if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1491 $qm = QueueManager::get();
1493 foreach ($transports as $transport)
1495 $qm->enqueue($notice, $transport);
1498 Event::handle('EndEnqueueNotice', array($notice, $transports));
1504 function common_profile_url($nickname)
1506 return common_local_url('showstream', array('nickname' => $nickname),
1511 * Should make up a reasonable root URL
1513 function common_root_url($ssl=false)
1515 $url = common_path('', $ssl, false);
1516 $i = strpos($url, '?');
1518 $url = substr($url, 0, $i);
1524 * returns $bytes bytes of random data as a hexadecimal string
1526 function common_random_hexstr($bytes)
1528 $str = @file_exists('/dev/urandom')
1529 ? common_urandom($bytes)
1530 : common_mtrand($bytes);
1533 for ($i = 0; $i < $bytes; $i++) {
1534 $hexstr .= sprintf("%02x", ord($str{$i}));
1539 function common_urandom($bytes)
1541 $h = fopen('/dev/urandom', 'rb');
1543 $src = fread($h, $bytes);
1548 function common_mtrand($bytes)
1551 for ($i = 0; $i < $bytes; $i++) {
1552 $str .= chr(mt_rand(0, 255));
1558 * Record the given URL as the return destination for a future
1559 * form submission, to be read by common_get_returnto().
1561 * @param string $url
1563 * @fixme as a session-global setting, this can allow multiple forms
1564 * to conflict and overwrite each others' returnto destinations if
1565 * the user has multiple tabs or windows open.
1567 * Should refactor to index with a token or otherwise only pass the
1568 * data along its intended path.
1570 function common_set_returnto($url)
1572 common_ensure_session();
1573 $_SESSION['returnto'] = $url;
1577 * Fetch a return-destination URL previously recorded by
1578 * common_set_returnto().
1580 * @return mixed URL string or null
1582 * @fixme as a session-global setting, this can allow multiple forms
1583 * to conflict and overwrite each others' returnto destinations if
1584 * the user has multiple tabs or windows open.
1586 * Should refactor to index with a token or otherwise only pass the
1587 * data along its intended path.
1589 function common_get_returnto()
1591 common_ensure_session();
1592 return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1595 function common_timestamp()
1597 return date('YmdHis');
1600 function common_ensure_syslog()
1602 static $initialized = false;
1603 if (!$initialized) {
1604 openlog(common_config('syslog', 'appname'), 0,
1605 common_config('syslog', 'facility'));
1606 $initialized = true;
1610 function common_log_line($priority, $msg)
1612 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1613 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1614 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1617 function common_request_id()
1620 $server = common_config('site', 'server');
1621 if (php_sapi_name() == 'cli') {
1622 $script = basename($_SERVER['PHP_SELF']);
1623 return "$server:$script:$pid";
1625 static $req_id = null;
1626 if (!isset($req_id)) {
1627 $req_id = substr(md5(mt_rand()), 0, 8);
1629 if (isset($_SERVER['REQUEST_URI'])) {
1630 $url = $_SERVER['REQUEST_URI'];
1632 $method = $_SERVER['REQUEST_METHOD'];
1633 return "$server:$pid.$req_id $method $url";
1637 function common_log($priority, $msg, $filename=null)
1639 if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1640 $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1641 $msg = '[' . common_request_id() . '] ' . $msg;
1642 $logfile = common_config('site', 'logfile');
1644 $log = fopen($logfile, "a");
1646 $output = common_log_line($priority, $msg);
1647 fwrite($log, $output);
1651 common_ensure_syslog();
1652 syslog($priority, $msg);
1654 Event::handle('EndLog', array($priority, $msg, $filename));
1658 function common_debug($msg, $filename=null)
1661 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1663 common_log(LOG_DEBUG, $msg);
1667 function common_log_db_error(&$object, $verb, $filename=null)
1671 $objstr = common_log_objstring($object);
1672 $last_error = &$_PEAR->getStaticProperty('DB_DataObject','lastError');
1673 if (is_object($last_error)) {
1674 $msg = $last_error->message;
1676 $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1678 common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1681 function common_log_objstring(&$object)
1683 if (is_null($object)) {
1686 if (!($object instanceof DB_DataObject)) {
1689 $arr = $object->toArray();
1691 foreach ($arr as $k => $v) {
1692 if (is_object($v)) {
1693 $fields[] = "$k='".get_class($v)."'";
1695 $fields[] = "$k='$v'";
1698 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1702 function common_valid_http_url($url, $secure=false)
1704 // If $secure is true, only allow https URLs to pass
1705 // (if false, we use '?' in 'https?' to say the 's' is optional)
1706 $regex = $secure ? '/^https$/' : '/^https?$/';
1707 return filter_var($url, FILTER_VALIDATE_URL)
1708 && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1711 function common_valid_tag($tag)
1713 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1714 return (Validate::email($matches[1]) ||
1715 preg_match('/^([\w-\.]+)$/', $matches[1]));
1721 * Determine if given domain or address literal is valid
1722 * eg for use in JIDs and URLs. Does not check if the domain
1725 * @param string $domain
1726 * @return boolean valid or not
1728 function common_valid_domain($domain)
1730 $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1731 $ipv4 = "(?:$octet(?:\.$octet){3})";
1732 if (preg_match("/^$ipv4$/u", $domain)) return true;
1734 $group = "(?:[0-9a-f]{1,4})";
1735 $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1737 if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1738 $before = explode(":", $matches[1]);
1739 $zeroes = $matches[2];
1740 $after = explode(":", $matches[3]);
1748 $explicit = count($before) + count($after);
1749 if ($explicit < $min || $explicit > $max) {
1756 require_once "Net/IDNA.php";
1757 $idn = Net_IDNA::getInstance();
1758 $domain = $idn->encode($domain);
1759 } catch (Exception $e) {
1763 $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1764 $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1766 return preg_match("/^$fqdn$/ui", $domain);
1769 /* Following functions are copied from MediaWiki GlobalFunctions.php
1770 * and written by Evan Prodromou. */
1772 function common_accept_to_prefs($accept, $def = '*/*')
1774 // No arg means accept anything (per HTTP spec)
1776 return array($def => 1);
1781 $parts = explode(',', $accept);
1783 foreach($parts as $part) {
1784 // FIXME: doesn't deal with params like 'text/html; level=1'
1785 @list($value, $qpart) = explode(';', trim($part));
1787 if(!isset($qpart)) {
1789 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1790 $prefs[$value] = $match[1];
1797 function common_mime_type_match($type, $avail)
1799 if(array_key_exists($type, $avail)) {
1802 $parts = explode('/', $type);
1803 if(array_key_exists($parts[0] . '/*', $avail)) {
1804 return $parts[0] . '/*';
1805 } elseif(array_key_exists('*/*', $avail)) {
1813 function common_negotiate_type($cprefs, $sprefs)
1817 foreach(array_keys($sprefs) as $type) {
1818 $parts = explode('/', $type);
1819 if($parts[1] != '*') {
1820 $ckey = common_mime_type_match($type, $cprefs);
1822 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1827 foreach(array_keys($cprefs) as $type) {
1828 $parts = explode('/', $type);
1829 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1830 $skey = common_mime_type_match($type, $sprefs);
1832 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1838 $besttype = 'text/html';
1840 foreach(array_keys($combine) as $type) {
1841 if($combine[$type] > $bestq) {
1843 $bestq = $combine[$type];
1847 if ('text/html' === $besttype) {
1848 return "text/html; charset=utf-8";
1853 function common_config($main, $sub)
1856 return (array_key_exists($main, $config) &&
1857 array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1860 function common_config_set($main, $sub, $value)
1863 if (!array_key_exists($main, $config)) {
1864 $config[$main] = array();
1866 $config[$main][$sub] = $value;
1869 function common_config_append($main, $sub, $value)
1872 if (!array_key_exists($main, $config)) {
1873 $config[$main] = array();
1875 if (!array_key_exists($sub, $config[$main])) {
1876 $config[$main][$sub] = array();
1878 if (!is_array($config[$main][$sub])) {
1879 $config[$main][$sub] = array($config[$main][$sub]);
1881 array_push($config[$main][$sub], $value);
1885 * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
1886 * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
1888 * @param array $from
1891 function common_copy_args($from)
1894 $strip = get_magic_quotes_gpc();
1895 foreach ($from as $k => $v) {
1897 $to[$k] = common_copy_args($v);
1900 $v = stripslashes($v);
1902 $to[$k] = strval(common_validate_utf8($v));
1909 * Neutralise the evil effects of magic_quotes_gpc in the current request.
1910 * This is used before handing a request off to OAuthRequest::from_request.
1911 * @fixme Doesn't consider vars other than _POST and _GET?
1912 * @fixme Can't be undone and could corrupt data if run twice.
1914 function common_remove_magic_from_request()
1916 if(get_magic_quotes_gpc()) {
1917 $_POST=array_map('stripslashes',$_POST);
1918 $_GET=array_map('stripslashes',$_GET);
1922 function common_user_uri(&$user)
1924 return common_local_url('userbyid', array('id' => $user->id),
1928 function common_notice_uri(&$notice)
1930 return common_local_url('shownotice',
1931 array('notice' => $notice->id),
1935 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1937 function common_confirmation_code($bits)
1939 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1940 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1941 $chars = ceil($bits/5);
1943 for ($i = 0; $i < $chars; $i++) {
1944 // XXX: convert to string and back
1945 $num = hexdec(common_random_hexstr(1));
1946 // XXX: randomness is too precious to throw away almost
1947 // 40% of the bits we get!
1948 $code .= $codechars[$num%32];
1953 // convert markup to HTML
1955 function common_markup_to_html($c, $args=null)
1961 if (is_null($args)) {
1965 // XXX: not very efficient
1967 foreach ($args as $name => $value) {
1968 $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
1971 $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
1972 $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
1973 $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
1974 $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
1975 return Markdown($c);
1978 function common_user_property($property)
1980 $profile = Profile::current();
1982 if (empty($profile)) {
1986 switch ($property) {
1992 return $profile->$property;
1996 return $profile->getAvatar(AVATAR_STREAM_SIZE);
1997 } catch (Exception $e) {
2002 return $profile->getBestName();
2009 function common_profile_uri($profile)
2013 if (!empty($profile)) {
2014 if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2015 $user = User::getKV('id', $profile->id);
2016 if ($user instanceof User) {
2019 Event::handle('EndCommonProfileURI', array($profile, &$uri));
2023 // XXX: this is a very bad profile!
2027 function common_canonical_sms($sms)
2030 preg_replace('/\D/', '', $sms);
2034 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2039 case E_COMPILE_ERROR:
2043 case E_RECOVERABLE_ERROR:
2044 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2049 case E_COMPILE_WARNING:
2050 case E_CORE_WARNING:
2051 case E_USER_WARNING:
2052 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2057 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2062 case E_USER_DEPRECATED:
2063 // XXX: config variable to log this stuff, too
2067 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2072 // FIXME: show error page if we're on the Web
2073 /* Don't execute PHP internal error handler */
2077 function common_session_token()
2079 common_ensure_session();
2080 if (!array_key_exists('token', $_SESSION)) {
2081 $_SESSION['token'] = common_random_hexstr(64);
2083 return $_SESSION['token'];
2086 function common_license_terms($uri)
2088 if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2089 return explode('-',$matches[1]);
2094 function common_compatible_license($from, $to)
2096 $from_terms = common_license_terms($from);
2097 // public domain and cc-by are compatible with everything
2098 if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2101 $to_terms = common_license_terms($to);
2102 // sa is compatible across versions. IANAL
2103 if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2104 return count(array_diff($from_terms, $to_terms)) == 0;
2106 // XXX: better compatibility check needed here!
2107 // Should at least normalise URIs
2108 return ($from == $to);
2112 * returns a quoted table name, if required according to config
2114 function common_database_tablename($tablename)
2116 if(common_config('db','quote_identifiers')) {
2117 $tablename = '"'. $tablename .'"';
2119 //table prefixes could be added here later
2124 * Shorten a URL with the current user's configured shortening service,
2125 * or ur1.ca if configured, or not at all if no shortening is set up.
2127 * @param string $long_url original URL
2128 * @param User $user to specify a particular user's options
2129 * @param boolean $force Force shortening (used when notice is too long)
2130 * @return string may return the original URL if shortening failed
2132 * @fixme provide a way to specify a particular shortener
2134 function common_shorten_url($long_url, User $user=null, $force = false)
2136 $long_url = trim($long_url);
2138 $user = common_current_user();
2140 $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2142 // $force forces shortening even if it's not strictly needed
2143 // I doubt URL shortening is ever 'strictly' needed. - ESP
2145 if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2149 $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2151 if (Event::handle('StartShortenUrl',
2152 array($long_url, $shortenerName, &$shortenedUrl))) {
2153 if ($shortenerName == 'internal') {
2154 $f = File::processNew($long_url);
2158 $shortenedUrl = common_local_url('redirecturl',
2159 array('id' => $f->id));
2160 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2161 return $shortenedUrl;
2170 //URL was shortened, so return the result
2171 return trim($shortenedUrl);
2176 * @return mixed array($proxy, $ip) for web requests; proxy may be null
2177 * null if not a web request
2179 * @fixme X-Forwarded-For can be chained by multiple proxies;
2180 we should parse the list and provide a cleaner array
2181 * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2182 * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2183 * use function to get exact request headers from Apache if possible.
2185 function common_client_ip()
2187 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2191 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2192 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2193 $proxy = $_SERVER['HTTP_CLIENT_IP'];
2195 $proxy = $_SERVER['REMOTE_ADDR'];
2197 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2200 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2201 $ip = $_SERVER['HTTP_CLIENT_IP'];
2203 $ip = $_SERVER['REMOTE_ADDR'];
2207 return array($proxy, $ip);
2210 function common_url_to_nickname($url)
2212 static $bad = array('query', 'user', 'password', 'port', 'fragment');
2214 $parts = parse_url($url);
2216 // If any of these parts exist, this won't work
2218 foreach ($bad as $badpart) {
2219 if (array_key_exists($badpart, $parts)) {
2224 // We just have host and/or path
2226 // If it's just a host...
2227 if (array_key_exists('host', $parts) &&
2228 (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2230 $hostparts = explode('.', $parts['host']);
2232 // Try to catch common idiom of nickname.service.tld
2234 if ((count($hostparts) > 2) &&
2235 (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2236 (strcmp($hostparts[0], 'www') != 0))
2238 return common_nicknamize($hostparts[0]);
2240 // Do the whole hostname
2241 return common_nicknamize($parts['host']);
2244 if (array_key_exists('path', $parts)) {
2245 // Strip starting, ending slashes
2246 $path = preg_replace('@/$@', '', $parts['path']);
2247 $path = preg_replace('@^/@', '', $path);
2248 $path = basename($path);
2250 // Hack for MediaWiki user pages, in the form:
2251 // http://example.com/wiki/User:Myname
2252 // ('User' may be localized.)
2253 if (strpos($path, ':')) {
2254 $parts = array_filter(explode(':', $path));
2255 $path = $parts[count($parts) - 1];
2259 return common_nicknamize($path);
2267 function common_nicknamize($str)
2270 return Nickname::normalize($str);
2271 } catch (NicknameException $e) {
2276 function common_perf_counter($key, $val=null)
2278 global $_perfCounters;
2279 if (isset($_perfCounters)) {
2280 if (common_config('site', 'logperf')) {
2281 if (array_key_exists($key, $_perfCounters)) {
2282 $_perfCounters[$key][] = $val;
2284 $_perfCounters[$key] = array($val);
2286 if (common_config('site', 'logperf_detail')) {
2287 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2293 function common_log_perf_counters()
2295 if (common_config('site', 'logperf')) {
2296 global $_startTime, $_perfCounters;
2298 if (isset($_startTime)) {
2299 $endTime = microtime(true);
2300 $diff = round(($endTime - $_startTime) * 1000);
2301 common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2303 $counters = $_perfCounters;
2305 foreach ($counters as $key => $values) {
2306 $count = count($values);
2307 $unique = count(array_unique($values));
2308 common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2313 function common_is_email($str)
2315 return (strpos($str, '@') !== false);
2318 function common_init_stats()
2322 $_mem = memory_get_usage(true);
2323 $_ts = microtime(true);
2326 function common_log_delta($comment=null)
2333 $_mem = memory_get_usage(true);
2334 $_ts = microtime(true);
2336 $mtotal = $_mem - $mold;
2337 $ttotal = $_ts - $told;
2339 if (empty($comment)) {
2343 common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));