Translator documentation added/updated.
[statusnet:mainline.git] / lib / util.php
1 <?php
2 /*
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2008, 2009, StatusNet, Inc.
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 /* XXX: break up into separate modules (HTTP, user, files) */
21
22 /**
23  * Show a server error.
24  */
25 function common_server_error($msg, $code=500)
26 {
27     $err = new ServerErrorAction($msg, $code);
28     $err->showPage();
29 }
30
31 /**
32  * Show a user error.
33  */
34 function common_user_error($msg, $code=400)
35 {
36     $err = new ClientErrorAction($msg, $code);
37     $err->showPage();
38 }
39
40 /**
41  * This should only be used at setup; processes switching languages
42  * to send text to other users should use common_switch_locale().
43  *
44  * @param string $language Locale language code (optional; empty uses
45  *                         current user's preference or site default)
46  * @return mixed success
47  */
48 function common_init_locale($language=null)
49 {
50     if(!$language) {
51         $language = common_language();
52     }
53     putenv('LANGUAGE='.$language);
54     putenv('LANG='.$language);
55     $ok =  setlocale(LC_ALL, $language . ".utf8",
56                      $language . ".UTF8",
57                      $language . ".utf-8",
58                      $language . ".UTF-8",
59                      $language);
60
61     return $ok;
62 }
63
64 /**
65  * Initialize locale and charset settings and gettext with our message catalog,
66  * using the current user's language preference or the site default.
67  *
68  * This should generally only be run at framework initialization; code switching
69  * languages at runtime should call common_switch_language().
70  *
71  * @access private
72  */
73 function common_init_language()
74 {
75     mb_internal_encoding('UTF-8');
76
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);
81
82     if (!$locale_set) {
83         // The requested locale doesn't exist on the system.
84         //
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.
89         //
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.
98             $all = `locale -a`;
99             foreach (explode("\n", $all) as $locale) {
100                 if (preg_match('/\.utf[-_]?8$/i', $locale)) {
101                     $ok = setlocale(LC_ALL, $locale);
102                     if ($ok) {
103                         break;
104                     }
105                 }
106             }
107         }
108         if (!$ok) {
109             common_log(LOG_ERR, "Unable to find a UTF-8 locale on this system; UI translations may not work.");
110         }
111         $locale_set = common_init_locale($language);
112     }
113
114     common_init_gettext();
115 }
116
117 /**
118  * @access private
119  */
120 function common_init_gettext()
121 {
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");
128 }
129
130 /**
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.
133  *
134  * @param string $language code for locale ('en', 'fr', 'pt_BR' etc)
135  */
136 function common_switch_locale($language=null)
137 {
138     common_init_locale($language);
139
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");
146 }
147
148 function common_timezone()
149 {
150     if (common_logged_in()) {
151         $user = common_current_user();
152         if ($user->timezone) {
153             return $user->timezone;
154         }
155     }
156
157     return common_config('site', 'timezone');
158 }
159
160 function common_valid_language($lang)
161 {
162     if ($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) {
167                 return true;
168             }
169         }
170     }
171     return false;
172 }
173
174 function common_language()
175 {
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)) {
181             return $uselang;
182         }
183     }
184
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();
189
190         if (common_valid_language($user->language)) {
191             return $user->language;
192         }
193     }
194
195     // Otherwise, find the best match for the languages requested by the
196     // user's browser...
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);
201             if ($language)
202               return $language;
203         }
204     }
205
206     // Finally, if none of the above worked, use the site's default...
207     return common_config('site', 'language');
208 }
209
210 /**
211  * Salted, hashed passwords are stored in the DB.
212  */
213 function common_munge_password($password, $id)
214 {
215     if (is_object($id) || is_object($password)) {
216         $e = new Exception();
217         common_log(LOG_ERR, __METHOD__ . ' object in param to common_munge_password ' .
218                    str_replace("\n", " ", $e->getTraceAsString()));
219     }
220     return md5($password . $id);
221 }
222
223 /**
224  * Check if a username exists and has matching password.
225  */
226 function common_check_user($nickname, $password)
227 {
228     // empty nickname always unacceptable
229     if (empty($nickname)) {
230         return false;
231     }
232
233     $authenticatedUser = false;
234
235     if (Event::handle('StartCheckPassword', array($nickname, $password, &$authenticatedUser))) {
236         $user = User::staticGet('nickname', common_canonical_nickname($nickname));
237         if (!empty($user)) {
238             if (!empty($password)) { // never allow login with blank password
239                 if (0 == strcmp(common_munge_password($password, $user->id),
240                                 $user->password)) {
241                     //internal checking passed
242                     $authenticatedUser = $user;
243                 }
244             }
245         }
246         Event::handle('EndCheckPassword', array($nickname, $password, $authenticatedUser));
247     }
248
249     return $authenticatedUser;
250 }
251
252 /**
253  * Is the current user logged in?
254  */
255 function common_logged_in()
256 {
257     return (!is_null(common_current_user()));
258 }
259
260 function common_have_session()
261 {
262     return (0 != strcmp(session_id(), ''));
263 }
264
265 function common_ensure_session()
266 {
267     $c = null;
268     if (array_key_exists(session_name(), $_COOKIE)) {
269         $c = $_COOKIE[session_name()];
270     }
271     if (!common_have_session()) {
272         if (common_config('sessions', 'handle')) {
273             Session::setSaveHandler();
274         }
275         if (array_key_exists(session_name(), $_GET)) {
276             $id = $_GET[session_name()];
277         } else if (array_key_exists(session_name(), $_COOKIE)) {
278             $id = $_COOKIE[session_name()];
279         }
280         if (isset($id)) {
281             session_id($id);
282         }
283         @session_start();
284         if (!isset($_SESSION['started'])) {
285             $_SESSION['started'] = time();
286             if (!empty($id)) {
287                 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
288                            ' is set but started value is null');
289             }
290         }
291     }
292 }
293
294 // Three kinds of arguments:
295 // 1) a user object
296 // 2) a nickname
297 // 3) null to clear
298
299 // Initialize to false; set to null if none found
300 $_cur = false;
301
302 function common_set_user($user)
303 {
304     global $_cur;
305
306     if (is_null($user) && common_have_session()) {
307         $_cur = null;
308         unset($_SESSION['userid']);
309         return true;
310     } else if (is_string($user)) {
311         $nickname = $user;
312         $user = User::staticGet('nickname', $nickname);
313     } else if (!($user instanceof User)) {
314         return false;
315     }
316
317     if ($user) {
318         if (Event::handle('StartSetUser', array(&$user))) {
319             if (!empty($user)) {
320                 if (!$user->hasRight(Right::WEBLOGIN)) {
321                     // TRANS: Authorisation exception thrown when a user a not allowed to login.
322                     throw new AuthorizationException(_('Not allowed to log in.'));
323                 }
324                 common_ensure_session();
325                 $_SESSION['userid'] = $user->id;
326                 $_cur = $user;
327                 Event::handle('EndSetUser', array($user));
328                 return $_cur;
329             }
330         }
331     }
332     return false;
333 }
334
335 function common_set_cookie($key, $value, $expiration=0)
336 {
337     $path = common_config('site', 'path');
338     $server = common_config('site', 'server');
339
340     if ($path && ($path != '/')) {
341         $cookiepath = '/' . $path . '/';
342     } else {
343         $cookiepath = '/';
344     }
345     return setcookie($key,
346                      $value,
347                      $expiration,
348                      $cookiepath,
349                      $server,
350                      common_config('site', 'ssl')=='always');
351 }
352
353 define('REMEMBERME', 'rememberme');
354 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
355
356 function common_rememberme($user=null)
357 {
358     if (!$user) {
359         $user = common_current_user();
360         if (!$user) {
361             return false;
362         }
363     }
364
365     $rm = new Remember_me();
366
367     $rm->code = common_good_rand(16);
368     $rm->user_id = $user->id;
369
370     // Wrap the insert in some good ol' fashioned transaction code
371
372     $rm->query('BEGIN');
373
374     $result = $rm->insert();
375
376     if (!$result) {
377         common_log_db_error($rm, 'INSERT', __FILE__);
378         return false;
379     }
380
381     $rm->query('COMMIT');
382
383     $cookieval = $rm->user_id . ':' . $rm->code;
384
385     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
386
387     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
388
389     return true;
390 }
391
392 function common_remembered_user()
393 {
394     $user = null;
395
396     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
397
398     if (!$packed) {
399         return null;
400     }
401
402     list($id, $code) = explode(':', $packed);
403
404     if (!$id || !$code) {
405         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
406         common_forgetme();
407         return null;
408     }
409
410     $rm = Remember_me::staticGet($code);
411
412     if (!$rm) {
413         common_log(LOG_WARNING, 'No such remember code: ' . $code);
414         common_forgetme();
415         return null;
416     }
417
418     if ($rm->user_id != $id) {
419         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
420         common_forgetme();
421         return null;
422     }
423
424     $user = User::staticGet($rm->user_id);
425
426     if (!$user) {
427         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
428         common_forgetme();
429         return null;
430     }
431
432     // successful!
433     $result = $rm->delete();
434
435     if (!$result) {
436         common_log_db_error($rm, 'DELETE', __FILE__);
437         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
438         common_forgetme();
439         return null;
440     }
441
442     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
443
444     common_set_user($user);
445     common_real_login(false);
446
447     // We issue a new cookie, so they can log in
448     // automatically again after this session
449
450     common_rememberme($user);
451
452     return $user;
453 }
454
455 /**
456  * must be called with a valid user!
457  */
458 function common_forgetme()
459 {
460     common_set_cookie(REMEMBERME, '', 0);
461 }
462
463 /**
464  * Who is the current user?
465  */
466 function common_current_user()
467 {
468     global $_cur;
469
470     if (!_have_config()) {
471         return null;
472     }
473
474     if ($_cur === false) {
475
476         if (isset($_COOKIE[session_name()]) || isset($_GET[session_name()])
477             || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
478             common_ensure_session();
479             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
480             if ($id) {
481                 $user = User::staticGet($id);
482                 if ($user) {
483                         $_cur = $user;
484                         return $_cur;
485                 }
486             }
487         }
488
489         // that didn't work; try to remember; will init $_cur to null on failure
490         $_cur = common_remembered_user();
491
492         if ($_cur) {
493             // XXX: Is this necessary?
494             $_SESSION['userid'] = $_cur->id;
495         }
496     }
497
498     return $_cur;
499 }
500
501 /**
502  * Logins that are 'remembered' aren't 'real' -- they're subject to
503  * cookie-stealing. So, we don't let them do certain things. New reg,
504  * OpenID, and password logins _are_ real.
505  */
506 function common_real_login($real=true)
507 {
508     common_ensure_session();
509     $_SESSION['real_login'] = $real;
510 }
511
512 function common_is_real_login()
513 {
514     return common_logged_in() && $_SESSION['real_login'];
515 }
516
517 /**
518  * Get a hash portion for HTTP caching Etags and such including
519  * info on the current user's session. If login/logout state changes,
520  * or we've changed accounts, or we've renamed the current user,
521  * we'll get a new hash value.
522  *
523  * This should not be considered secure information.
524  *
525  * @param User $user (optional; uses common_current_user() if left out)
526  * @return string
527  */
528 function common_user_cache_hash($user=false)
529 {
530     if ($user === false) {
531         $user = common_current_user();
532     }
533     if ($user) {
534         return crc32($user->id . ':' . $user->nickname);
535     } else {
536         return '0';
537     }
538 }
539
540 /**
541  * get canonical version of nickname for comparison
542  *
543  * @param string $nickname
544  * @return string
545  *
546  * @throws NicknameException on invalid input
547  * @deprecated call Nickname::normalize() directly.
548  */
549 function common_canonical_nickname($nickname)
550 {
551     return Nickname::normalize($nickname);
552 }
553
554 /**
555  * get canonical version of email for comparison
556  *
557  * @fixme actually normalize
558  * @fixme reject invalid input
559  *
560  * @param string $email
561  * @return string
562  */
563 function common_canonical_email($email)
564 {
565     // XXX: canonicalize UTF-8
566     // XXX: lcase the domain part
567     return $email;
568 }
569
570 /**
571  * Partial notice markup rendering step: build links to !group references.
572  *
573  * @param string $text partially rendered HTML
574  * @param Notice $notice in whose context we're working
575  * @return string partially rendered HTML
576  */
577 function common_render_content($text, $notice)
578 {
579     $r = common_render_text($text);
580     $id = $notice->profile_id;
581     $r = common_linkify_mentions($r, $notice);
582     $r = preg_replace('/(^|[\s\.\,\:\;]+)!(' . Nickname::DISPLAY_FMT . ')/e',
583                       "'\\1!'.common_group_link($id, '\\2')", $r);
584     return $r;
585 }
586
587 /**
588  * Finds @-mentions within the partially-rendered text section and
589  * turns them into live links.
590  *
591  * Should generally not be called except from common_render_content().
592  *
593  * @param string $text partially-rendered HTML
594  * @param Notice $notice in-progress or complete Notice object for context
595  * @return string partially-rendered HTML
596  */
597 function common_linkify_mentions($text, $notice)
598 {
599     $mentions = common_find_mentions($text, $notice);
600
601     // We need to go through in reverse order by position,
602     // so our positions stay valid despite our fudging with the
603     // string!
604
605     $points = array();
606
607     foreach ($mentions as $mention)
608     {
609         $points[$mention['position']] = $mention;
610     }
611
612     krsort($points);
613
614     foreach ($points as $position => $mention) {
615
616         $linkText = common_linkify_mention($mention);
617
618         $text = substr_replace($text, $linkText, $position, mb_strlen($mention['text']));
619     }
620
621     return $text;
622 }
623
624 function common_linkify_mention($mention)
625 {
626     $output = null;
627
628     if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
629
630         $xs = new XMLStringer(false);
631
632         $attrs = array('href' => $mention['url'],
633                        'class' => 'url');
634
635         if (!empty($mention['title'])) {
636             $attrs['title'] = $mention['title'];
637         }
638
639         $xs->elementStart('span', 'vcard');
640         $xs->elementStart('a', $attrs);
641         $xs->element('span', 'fn nickname', $mention['text']);
642         $xs->elementEnd('a');
643         $xs->elementEnd('span');
644
645         $output = $xs->getString();
646
647         Event::handle('EndLinkifyMention', array($mention, &$output));
648     }
649
650     return $output;
651 }
652
653 /**
654  * Find @-mentions in the given text, using the given notice object as context.
655  * References will be resolved with common_relative_profile() against the user
656  * who posted the notice.
657  *
658  * Note the return data format is internal, to be used for building links and
659  * such. Should not be used directly; rather, call common_linkify_mentions().
660  *
661  * @param string $text
662  * @param Notice $notice notice in whose context we're building links
663  *
664  * @return array
665  *
666  * @access private
667  */
668 function common_find_mentions($text, $notice)
669 {
670     $mentions = array();
671
672     $sender = Profile::staticGet('id', $notice->profile_id);
673
674     if (empty($sender)) {
675         return $mentions;
676     }
677
678     if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
679         // Get the context of the original notice, if any
680         $originalAuthor   = null;
681         $originalNotice   = null;
682         $originalMentions = array();
683
684         // Is it a reply?
685
686         if (!empty($notice) && !empty($notice->reply_to)) {
687             $originalNotice = Notice::staticGet('id', $notice->reply_to);
688             if (!empty($originalNotice)) {
689                 $originalAuthor = Profile::staticGet('id', $originalNotice->profile_id);
690
691                 $ids = $originalNotice->getReplies();
692
693                 foreach ($ids as $id) {
694                     $repliedTo = Profile::staticGet('id', $id);
695                     if (!empty($repliedTo)) {
696                         $originalMentions[$repliedTo->nickname] = $repliedTo;
697                     }
698                 }
699             }
700         }
701
702         $matches = common_find_mentions_raw($text);
703
704         foreach ($matches as $match) {
705             try {
706                 $nickname = Nickname::normalize($match[0]);
707             } catch (NicknameException $e) {
708                 // Bogus match? Drop it.
709                 continue;
710             }
711
712             // Try to get a profile for this nickname.
713             // Start with conversation context, then go to
714             // sender context.
715
716             if (!empty($originalAuthor) && $originalAuthor->nickname == $nickname) {
717                 $mentioned = $originalAuthor;
718             } else if (!empty($originalMentions) &&
719                        array_key_exists($nickname, $originalMentions)) {
720                 $mentioned = $originalMentions[$nickname];
721             } else {
722                 $mentioned = common_relative_profile($sender, $nickname);
723             }
724
725             if (!empty($mentioned)) {
726                 $user = User::staticGet('id', $mentioned->id);
727
728                 if ($user) {
729                     $url = common_local_url('userbyid', array('id' => $user->id));
730                 } else {
731                     $url = $mentioned->profileurl;
732                 }
733
734                 $mention = array('mentioned' => array($mentioned),
735                                  'text' => $match[0],
736                                  'position' => $match[1],
737                                  'url' => $url);
738
739                 if (!empty($mentioned->fullname)) {
740                     $mention['title'] = $mentioned->fullname;
741                 }
742
743                 $mentions[] = $mention;
744             }
745         }
746
747         // @#tag => mention of all subscriptions tagged 'tag'
748
749         preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
750                        $text,
751                        $hmatches,
752                        PREG_OFFSET_CAPTURE);
753
754         foreach ($hmatches[1] as $hmatch) {
755
756             $tag = common_canonical_tag($hmatch[0]);
757
758             $tagged = Profile_tag::getTagged($sender->id, $tag);
759
760             $url = common_local_url('subscriptions',
761                                     array('nickname' => $sender->nickname,
762                                           'tag' => $tag));
763
764             $mentions[] = array('mentioned' => $tagged,
765                                 'text' => $hmatch[0],
766                                 'position' => $hmatch[1],
767                                 'url' => $url);
768         }
769
770         Event::handle('EndFindMentions', array($sender, $text, &$mentions));
771     }
772
773     return $mentions;
774 }
775
776 /**
777  * Does the actual regex pulls to find @-mentions in text.
778  * Should generally not be called directly; for use in common_find_mentions.
779  *
780  * @param string $text
781  * @return array of PCRE match arrays
782  */
783 function common_find_mentions_raw($text)
784 {
785     $tmatches = array();
786     preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
787                    $text,
788                    $tmatches,
789                    PREG_OFFSET_CAPTURE);
790
791     $atmatches = array();
792     preg_match_all('/(?:^|\s+)@(' . Nickname::DISPLAY_FMT . ')\b/',
793                    $text,
794                    $atmatches,
795                    PREG_OFFSET_CAPTURE);
796
797     $matches = array_merge($tmatches[1], $atmatches[1]);
798     return $matches;
799 }
800
801 function common_render_text($text)
802 {
803     $r = htmlspecialchars($text);
804
805     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
806     $r = common_replace_urls_callback($r, 'common_linkify');
807     $r = preg_replace('/(^|\&quot\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/ue', "'\\1#'.common_tag_link('\\2')", $r);
808     // XXX: machine tags
809     return $r;
810 }
811
812 /**
813  * Find links in the given text and pass them to the given callback function.
814  *
815  * @param string $text
816  * @param function($text, $arg) $callback: return replacement text
817  * @param mixed $arg: optional argument will be passed on to the callback
818  */
819 function common_replace_urls_callback($text, $callback, $arg = null) {
820     // Start off with a regex
821     $regex = '#'.
822     '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
823     '('.
824         '(?:'.
825             '(?:'. //Known protocols
826                 '(?:'.
827                     '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
828                     '|'.
829                     '(?:(?:mailto|aim|tel|xmpp):)'.
830                 ')'.
831                 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
832                 '(?:'.
833                     '(?:'.
834                         '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
835                     ')|(?:'.
836                         '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
837                     ')'.
838                 ')'.
839             ')'.
840             '|(?:(?: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
841             '|(?:'. //IPv6
842                 '\[?(?:(?:(?:[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})))\]?(?<!:)'.
843             ')|(?:'. //DNS
844                 '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
845                 '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
846                 //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
847                 '(?: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)'.
848             ')(?![\pN\pL\-\_])'.
849         ')'.
850         '(?:'.
851             '(?:\:\d+)?'. //:port
852             '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
853             '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
854             '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
855         ')(?<![\?\.\,\#\,])'.
856     ')'.
857     '#ixu';
858     //preg_match_all($regex,$text,$matches);
859     //print_r($matches);
860     return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
861 }
862
863 /**
864  * Intermediate callback for common_replace_links(), helps resolve some
865  * ambiguous link forms before passing on to the final callback.
866  *
867  * @param array $matches
868  * @param callable $callback
869  * @param mixed $arg optional argument to pass on as second param to callback
870  * @return string
871  *
872  * @access private
873  */
874 function callback_helper($matches, $callback, $arg=null) {
875     $url=$matches[1];
876     $left = strpos($matches[0],$url);
877     $right = $left+strlen($url);
878
879     $groupSymbolSets=array(
880         array(
881             'left'=>'(',
882             'right'=>')'
883         ),
884         array(
885             'left'=>'[',
886             'right'=>']'
887         ),
888         array(
889             'left'=>'{',
890             'right'=>'}'
891         ),
892         array(
893             'left'=>'<',
894             'right'=>'>'
895         )
896     );
897     $cannotEndWith=array('.','?',',','#');
898     $original_url=$url;
899     do{
900         $original_url=$url;
901         foreach($groupSymbolSets as $groupSymbolSet){
902             if(substr($url,-1)==$groupSymbolSet['right']){
903                 $group_left_count = substr_count($url,$groupSymbolSet['left']);
904                 $group_right_count = substr_count($url,$groupSymbolSet['right']);
905                 if($group_left_count<$group_right_count){
906                     $right-=1;
907                     $url=substr($url,0,-1);
908                 }
909             }
910         }
911         if(in_array(substr($url,-1),$cannotEndWith)){
912             $right-=1;
913             $url=substr($url,0,-1);
914         }
915     }while($original_url!=$url);
916
917     $result = call_user_func_array($callback, array($url, $arg));
918     return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
919 }
920
921 if (version_compare(PHP_VERSION, '5.3.0', 'ge')) {
922     // lambda implementation in a separate file; PHP 5.2 won't parse it.
923     require_once INSTALLDIR . "/lib/curry.php";
924 } else {
925     function curry($fn) {
926         $args = func_get_args();
927         array_shift($args);
928         $id = uniqid('_partial');
929         $GLOBALS[$id] = array($fn, $args);
930         return create_function('',
931                                '$args = func_get_args(); '.
932                                'return call_user_func_array('.
933                                '$GLOBALS["'.$id.'"][0],'.
934                                'array_merge('.
935                                '$args,'.
936                                '$GLOBALS["'.$id.'"][1]));');
937     }
938 }
939
940 function common_linkify($url) {
941     // It comes in special'd, so we unspecial it before passing to the stringifying
942     // functions
943     $url = htmlspecialchars_decode($url);
944
945     if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
946         //url is an email address without the mailto: protocol
947         $canon = "mailto:$url";
948         $longurl = "mailto:$url";
949     } else {
950
951         $canon = File_redirection::_canonUrl($url);
952
953         $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
954         if (is_array($longurl_data)) {
955             $longurl = $longurl_data['url'];
956         } elseif (is_string($longurl_data)) {
957             $longurl = $longurl_data;
958         } else {
959             // Unable to reach the server to verify contents, etc
960             // Just pass the link on through for now.
961             common_log(LOG_ERR, "Can't linkify url '$url'");
962             $longurl = $url;
963         }
964     }
965
966     $attrs = array('href' => $canon, 'title' => $longurl);
967
968     $is_attachment = false;
969     $attachment_id = null;
970     $has_thumb = false;
971
972     // Check to see whether this is a known "attachment" URL.
973
974     $f = File::staticGet('url', $longurl);
975
976     if (empty($f)) {
977         if (common_config('attachments', 'process_links')) {
978             // XXX: this writes to the database. :<
979             $f = File::processNew($longurl);
980         }
981     }
982
983     if (!empty($f)) {
984         if ($f->getEnclosure()) {
985             $is_attachment = true;
986             $attachment_id = $f->id;
987
988             $thumb = File_thumbnail::staticGet('file_id', $f->id);
989             if (!empty($thumb)) {
990                 $has_thumb = true;
991             }
992         }
993     }
994
995     // Add clippy
996     if ($is_attachment) {
997         $attrs['class'] = 'attachment';
998         if ($has_thumb) {
999             $attrs['class'] = 'attachment thumbnail';
1000         }
1001         $attrs['id'] = "attachment-{$attachment_id}";
1002     }
1003
1004     // Whether to nofollow
1005
1006     $nf = common_config('nofollow', 'external');
1007
1008     if ($nf == 'never') {
1009         $attrs['rel'] = 'external';
1010     } else {
1011         $attrs['rel'] = 'nofollow external';
1012     }
1013
1014     return XMLStringer::estring('a', $attrs, $url);
1015 }
1016
1017 /**
1018  * Find and shorten links in a given chunk of text if it's longer than the
1019  * configured notice content limit (or unconditionally).
1020  *
1021  * Side effects: may save file and file_redirection records for referenced URLs.
1022  *
1023  * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1024  * user's options are used; otherwise the current web session user's setitngs
1025  * will be used or ur1.ca if there is no active web login.
1026  *
1027  * @param string $text
1028  * @param boolean $always (optional)
1029  * @param User $user (optional)
1030  *
1031  * @return string
1032  */
1033 function common_shorten_links($text, $always = false, User $user=null)
1034 {
1035     $user = common_current_user();
1036
1037     $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1038
1039     if ($always || mb_strlen($text) > $maxLength) {
1040         return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1041     } else {
1042         return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1043     }
1044 }
1045
1046 /**
1047  * Very basic stripping of invalid UTF-8 input text.
1048  *
1049  * @param string $str
1050  * @return mixed string or null if invalid input
1051  *
1052  * @todo ideally we should drop bad chars, and maybe do some of the checks
1053  *       from common_xml_safe_str. But we can't strip newlines, etc.
1054  * @todo Unicode normalization might also be useful, but not needed now.
1055  */
1056 function common_validate_utf8($str)
1057 {
1058     // preg_replace will return NULL on invalid UTF-8 input.
1059     //
1060     // Note: empty regex //u also caused NULL return on some
1061     // production machines, but none of our test machines.
1062     //
1063     // This should be replaced with a more reliable check.
1064     return preg_replace('/\x00/u', '', $str);
1065 }
1066
1067 /**
1068  * Make sure an arbitrary string is safe for output in XML as a single line.
1069  *
1070  * @param string $str
1071  * @return string
1072  */
1073 function common_xml_safe_str($str)
1074 {
1075     // Replace common eol and extra whitespace input chars
1076     $unWelcome = array(
1077         "\t",  // tab
1078         "\n",  // newline
1079         "\r",  // cr
1080         "\0",  // null byte eos
1081         "\x0B" // vertical tab
1082     );
1083
1084     $replacement = array(
1085         ' ', // single space
1086         ' ',
1087         '',  // nothing
1088         '',
1089         ' '
1090     );
1091
1092     $str = str_replace($unWelcome, $replacement, $str);
1093
1094     // Neutralize any additional control codes and UTF-16 surrogates
1095     // (Twitter uses '*')
1096     return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1097 }
1098
1099 function common_tag_link($tag)
1100 {
1101     $canonical = common_canonical_tag($tag);
1102     if (common_config('singleuser', 'enabled')) {
1103         // regular TagAction isn't set up in 1user mode
1104         $nickname = User::singleUserNickname();
1105         $url = common_local_url('showstream',
1106                                 array('nickname' => $nickname,
1107                                       'tag' => $canonical));
1108     } else {
1109         $url = common_local_url('tag', array('tag' => $canonical));
1110     }
1111     $xs = new XMLStringer();
1112     $xs->elementStart('span', 'tag');
1113     $xs->element('a', array('href' => $url,
1114                             'rel' => 'tag'),
1115                  $tag);
1116     $xs->elementEnd('span');
1117     return $xs->getString();
1118 }
1119
1120 function common_canonical_tag($tag)
1121 {
1122   $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
1123   return str_replace(array('-', '_', '.'), '', $tag);
1124 }
1125
1126 function common_valid_profile_tag($str)
1127 {
1128     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1129 }
1130
1131 /**
1132  *
1133  * @param <type> $sender_id
1134  * @param <type> $nickname
1135  * @return <type>
1136  * @access private
1137  */
1138 function common_group_link($sender_id, $nickname)
1139 {
1140     $sender = Profile::staticGet($sender_id);
1141     $group = User_group::getForNickname($nickname, $sender);
1142     if ($sender && $group && $sender->isMember($group)) {
1143         $attrs = array('href' => $group->permalink(),
1144                        'class' => 'url');
1145         if (!empty($group->fullname)) {
1146             $attrs['title'] = $group->getFancyName();
1147         }
1148         $xs = new XMLStringer();
1149         $xs->elementStart('span', 'vcard');
1150         $xs->elementStart('a', $attrs);
1151         $xs->element('span', 'fn nickname', $nickname);
1152         $xs->elementEnd('a');
1153         $xs->elementEnd('span');
1154         return $xs->getString();
1155     } else {
1156         return $nickname;
1157     }
1158 }
1159
1160 /**
1161  * Resolve an ambiguous profile nickname reference, checking in following order:
1162  * - profiles that $sender subscribes to
1163  * - profiles that subscribe to $sender
1164  * - local user profiles
1165  *
1166  * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1167  * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1168  * ESCAPE SQL.
1169  *
1170  * @fixme validate input
1171  * @fixme escape SQL
1172  * @fixme fix or remove mystery third parameter
1173  * @fixme is $sender a User or Profile?
1174  *
1175  * @param <type> $sender the user or profile in whose context we're looking
1176  * @param string $nickname validated nickname of
1177  * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1178  *
1179  * @return Profile or null
1180  */
1181 function common_relative_profile($sender, $nickname, $dt=null)
1182 {
1183     // Will throw exception on invalid input.
1184     $nickname = Nickname::normalize($nickname);
1185
1186     // Try to find profiles this profile is subscribed to that have this nickname
1187     $recipient = new Profile();
1188     // XXX: use a join instead of a subquery
1189     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1190     $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1191     if ($recipient->find(true)) {
1192         // XXX: should probably differentiate between profiles with
1193         // the same name by date of most recent update
1194         return $recipient;
1195     }
1196     // Try to find profiles that listen to this profile and that have this nickname
1197     $recipient = new Profile();
1198     // XXX: use a join instead of a subquery
1199     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1200     $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1201     if ($recipient->find(true)) {
1202         // XXX: should probably differentiate between profiles with
1203         // the same name by date of most recent update
1204         return $recipient;
1205     }
1206     // If this is a local user, try to find a local user with that nickname.
1207     $sender = User::staticGet($sender->id);
1208     if ($sender) {
1209         $recipient_user = User::staticGet('nickname', $nickname);
1210         if ($recipient_user) {
1211             return $recipient_user->getProfile();
1212         }
1213     }
1214     // Otherwise, no links. @messages from local users to remote users,
1215     // or from remote users to other remote users, are just
1216     // outside our ability to make intelligent guesses about
1217     return null;
1218 }
1219
1220 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1221 {
1222     $r = Router::get();
1223     $path = $r->build($action, $args, $params, $fragment);
1224
1225     $ssl = common_is_sensitive($action);
1226
1227     if (common_config('site','fancy')) {
1228         $url = common_path(mb_substr($path, 1), $ssl, $addSession);
1229     } else {
1230         if (mb_strpos($path, '/index.php') === 0) {
1231             $url = common_path(mb_substr($path, 1), $ssl, $addSession);
1232         } else {
1233             $url = common_path('index.php'.$path, $ssl, $addSession);
1234         }
1235     }
1236     return $url;
1237 }
1238
1239 function common_is_sensitive($action)
1240 {
1241     static $sensitive = array(
1242         'login',
1243         'register',
1244         'passwordsettings',
1245         'api',
1246         'ApiOauthRequestToken',
1247         'ApiOauthAccessToken',
1248         'ApiOauthAuthorize',
1249         'ApiOauthPin',
1250         'showapplication'
1251     );
1252     $ssl = null;
1253
1254     if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1255         $ssl = in_array($action, $sensitive);
1256     }
1257
1258     return $ssl;
1259 }
1260
1261 function common_path($relative, $ssl=false, $addSession=true)
1262 {
1263     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1264
1265     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1266         || common_config('site', 'ssl') === 'always') {
1267         $proto = 'https';
1268         if (is_string(common_config('site', 'sslserver')) &&
1269             mb_strlen(common_config('site', 'sslserver')) > 0) {
1270             $serverpart = common_config('site', 'sslserver');
1271         } else if (common_config('site', 'server')) {
1272             $serverpart = common_config('site', 'server');
1273         } else {
1274             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1275         }
1276     } else {
1277         $proto = 'http';
1278         if (common_config('site', 'server')) {
1279             $serverpart = common_config('site', 'server');
1280         } else {
1281             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1282         }
1283     }
1284
1285     if ($addSession) {
1286         $relative = common_inject_session($relative, $serverpart);
1287     }
1288
1289     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1290 }
1291
1292 function common_inject_session($url, $serverpart = null)
1293 {
1294     if (common_have_session()) {
1295
1296         if (empty($serverpart)) {
1297             $serverpart = parse_url($url, PHP_URL_HOST);
1298         }
1299
1300         $currentServer = $_SERVER['HTTP_HOST'];
1301
1302         // Are we pointing to another server (like an SSL server?)
1303
1304         if (!empty($currentServer) &&
1305             0 != strcasecmp($currentServer, $serverpart)) {
1306             // Pass the session ID as a GET parameter
1307             $sesspart = session_name() . '=' . session_id();
1308             $i = strpos($url, '?');
1309             if ($i === false) { // no GET params, just append
1310                 $url .= '?' . $sesspart;
1311             } else {
1312                 $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1313             }
1314         }
1315     }
1316
1317     return $url;
1318 }
1319
1320 function common_date_string($dt)
1321 {
1322     // XXX: do some sexy date formatting
1323     // return date(DATE_RFC822, $dt);
1324     $t = strtotime($dt);
1325     $now = time();
1326     $diff = $now - $t;
1327
1328     if ($now < $t) { // that shouldn't happen!
1329         return common_exact_date($dt);
1330     } else if ($diff < 60) {
1331         // TRANS: Used in notices to indicate when the notice was made compared to now.
1332         return _('a few seconds ago');
1333     } else if ($diff < 92) {
1334         // TRANS: Used in notices to indicate when the notice was made compared to now.
1335         return _('about a minute ago');
1336     } else if ($diff < 3300) {
1337         $minutes = round($diff/60);
1338         // TRANS: Used in notices to indicate when the notice was made compared to now.
1339         return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1340     } else if ($diff < 5400) {
1341         // TRANS: Used in notices to indicate when the notice was made compared to now.
1342         return _('about an hour ago');
1343     } else if ($diff < 22 * 3600) {
1344         $hours = round($diff/3600);
1345         // TRANS: Used in notices to indicate when the notice was made compared to now.
1346         return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1347     } else if ($diff < 37 * 3600) {
1348         // TRANS: Used in notices to indicate when the notice was made compared to now.
1349         return _('about a day ago');
1350     } else if ($diff < 24 * 24 * 3600) {
1351         $days = round($diff/(24*3600));
1352         // TRANS: Used in notices to indicate when the notice was made compared to now.
1353         return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1354     } else if ($diff < 46 * 24 * 3600) {
1355         // TRANS: Used in notices to indicate when the notice was made compared to now.
1356         return _('about a month ago');
1357     } else if ($diff < 330 * 24 * 3600) {
1358         $months = round($diff/(30*24*3600));
1359         // TRANS: Used in notices to indicate when the notice was made compared to now.
1360         return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1361     } else if ($diff < 480 * 24 * 3600) {
1362         // TRANS: Used in notices to indicate when the notice was made compared to now.
1363         return _('about a year ago');
1364     } else {
1365         return common_exact_date($dt);
1366     }
1367 }
1368
1369 function common_exact_date($dt)
1370 {
1371     static $_utc;
1372     static $_siteTz;
1373
1374     if (!$_utc) {
1375         $_utc = new DateTimeZone('UTC');
1376         $_siteTz = new DateTimeZone(common_timezone());
1377     }
1378
1379     $dateStr = date('d F Y H:i:s', strtotime($dt));
1380     $d = new DateTime($dateStr, $_utc);
1381     $d->setTimezone($_siteTz);
1382     return $d->format(DATE_RFC850);
1383 }
1384
1385 function common_date_w3dtf($dt)
1386 {
1387     $dateStr = date('d F Y H:i:s', strtotime($dt));
1388     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1389     $d->setTimezone(new DateTimeZone(common_timezone()));
1390     return $d->format(DATE_W3C);
1391 }
1392
1393 function common_date_rfc2822($dt)
1394 {
1395     $dateStr = date('d F Y H:i:s', strtotime($dt));
1396     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1397     $d->setTimezone(new DateTimeZone(common_timezone()));
1398     return $d->format('r');
1399 }
1400
1401 function common_date_iso8601($dt)
1402 {
1403     $dateStr = date('d F Y H:i:s', strtotime($dt));
1404     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1405     $d->setTimezone(new DateTimeZone(common_timezone()));
1406     return $d->format('c');
1407 }
1408
1409 function common_sql_now()
1410 {
1411     return common_sql_date(time());
1412 }
1413
1414 function common_sql_date($datetime)
1415 {
1416     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1417 }
1418
1419 /**
1420  * Return an SQL fragment to calculate an age-based weight from a given
1421  * timestamp or datetime column.
1422  *
1423  * @param string $column name of field we're comparing against current time
1424  * @param integer $dropoff divisor for age in seconds before exponentiation
1425  * @return string SQL fragment
1426  */
1427 function common_sql_weight($column, $dropoff)
1428 {
1429     if (common_config('db', 'type') == 'pgsql') {
1430         // PostgreSQL doesn't support timestampdiff function.
1431         // @fixme will this use the right time zone?
1432         // @fixme does this handle cross-year subtraction correctly?
1433         return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1434     } else {
1435         return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1436     }
1437 }
1438
1439 function common_redirect($url, $code=307)
1440 {
1441     static $status = array(301 => "Moved Permanently",
1442                            302 => "Found",
1443                            303 => "See Other",
1444                            307 => "Temporary Redirect");
1445
1446     header('HTTP/1.1 '.$code.' '.$status[$code]);
1447     header("Location: $url");
1448
1449     $xo = new XMLOutputter();
1450     $xo->startXML('a',
1451                   '-//W3C//DTD XHTML 1.0 Strict//EN',
1452                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1453     $xo->element('a', array('href' => $url), $url);
1454     $xo->endXML();
1455     exit;
1456 }
1457
1458 // Stick the notice on the queue
1459
1460 function common_enqueue_notice($notice)
1461 {
1462     static $localTransports = array('omb',
1463                                     'ping');
1464
1465     $transports = array();
1466     if (common_config('sms', 'enabled')) {
1467         $transports[] = 'sms';
1468     }
1469     if (Event::hasHandler('HandleQueuedNotice')) {
1470         $transports[] = 'plugin';
1471     }
1472
1473     // We can skip these for gatewayed notices.
1474     if ($notice->isLocal()) {
1475         $transports = array_merge($transports, $localTransports);
1476     }
1477
1478     if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1479
1480         $qm = QueueManager::get();
1481
1482         foreach ($transports as $transport)
1483         {
1484             $qm->enqueue($notice, $transport);
1485         }
1486
1487         Event::handle('EndEnqueueNotice', array($notice, $transports));
1488     }
1489
1490     return true;
1491 }
1492
1493 /**
1494  * Broadcast profile updates to OMB and other remote subscribers.
1495  *
1496  * Since this may be slow with a lot of subscribers or bad remote sites,
1497  * this is run through the background queues if possible.
1498  */
1499 function common_broadcast_profile(Profile $profile)
1500 {
1501     $qm = QueueManager::get();
1502     $qm->enqueue($profile, "profile");
1503     return true;
1504 }
1505
1506 function common_profile_url($nickname)
1507 {
1508     return common_local_url('showstream', array('nickname' => $nickname),
1509                             null, null, false);
1510 }
1511
1512 /**
1513  * Should make up a reasonable root URL
1514  */
1515 function common_root_url($ssl=false)
1516 {
1517     $url = common_path('', $ssl, false);
1518     $i = strpos($url, '?');
1519     if ($i !== false) {
1520         $url = substr($url, 0, $i);
1521     }
1522     return $url;
1523 }
1524
1525 /**
1526  * returns $bytes bytes of random data as a hexadecimal string
1527  * "good" here is a goal and not a guarantee
1528  */
1529 function common_good_rand($bytes)
1530 {
1531     // XXX: use random.org...?
1532     if (@file_exists('/dev/urandom')) {
1533         return common_urandom($bytes);
1534     } else { // FIXME: this is probably not good enough
1535         return common_mtrand($bytes);
1536     }
1537 }
1538
1539 function common_urandom($bytes)
1540 {
1541     $h = fopen('/dev/urandom', 'rb');
1542     // should not block
1543     $src = fread($h, $bytes);
1544     fclose($h);
1545     $enc = '';
1546     for ($i = 0; $i < $bytes; $i++) {
1547         $enc .= sprintf("%02x", (ord($src[$i])));
1548     }
1549     return $enc;
1550 }
1551
1552 function common_mtrand($bytes)
1553 {
1554     $enc = '';
1555     for ($i = 0; $i < $bytes; $i++) {
1556         $enc .= sprintf("%02x", mt_rand(0, 255));
1557     }
1558     return $enc;
1559 }
1560
1561 /**
1562  * Record the given URL as the return destination for a future
1563  * form submission, to be read by common_get_returnto().
1564  *
1565  * @param string $url
1566  *
1567  * @fixme as a session-global setting, this can allow multiple forms
1568  * to conflict and overwrite each others' returnto destinations if
1569  * the user has multiple tabs or windows open.
1570  *
1571  * Should refactor to index with a token or otherwise only pass the
1572  * data along its intended path.
1573  */
1574 function common_set_returnto($url)
1575 {
1576     common_ensure_session();
1577     $_SESSION['returnto'] = $url;
1578 }
1579
1580 /**
1581  * Fetch a return-destination URL previously recorded by
1582  * common_set_returnto().
1583  *
1584  * @return mixed URL string or null
1585  *
1586  * @fixme as a session-global setting, this can allow multiple forms
1587  * to conflict and overwrite each others' returnto destinations if
1588  * the user has multiple tabs or windows open.
1589  *
1590  * Should refactor to index with a token or otherwise only pass the
1591  * data along its intended path.
1592  */
1593 function common_get_returnto()
1594 {
1595     common_ensure_session();
1596     return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1597 }
1598
1599 function common_timestamp()
1600 {
1601     return date('YmdHis');
1602 }
1603
1604 function common_ensure_syslog()
1605 {
1606     static $initialized = false;
1607     if (!$initialized) {
1608         openlog(common_config('syslog', 'appname'), 0,
1609             common_config('syslog', 'facility'));
1610         $initialized = true;
1611     }
1612 }
1613
1614 function common_log_line($priority, $msg)
1615 {
1616     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1617                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1618     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1619 }
1620
1621 function common_request_id()
1622 {
1623     $pid = getmypid();
1624     $server = common_config('site', 'server');
1625     if (php_sapi_name() == 'cli') {
1626         $script = basename($_SERVER['PHP_SELF']);
1627         return "$server:$script:$pid";
1628     } else {
1629         static $req_id = null;
1630         if (!isset($req_id)) {
1631             $req_id = substr(md5(mt_rand()), 0, 8);
1632         }
1633         if (isset($_SERVER['REQUEST_URI'])) {
1634             $url = $_SERVER['REQUEST_URI'];
1635         }
1636         $method = $_SERVER['REQUEST_METHOD'];
1637         return "$server:$pid.$req_id $method $url";
1638     }
1639 }
1640
1641 function common_log($priority, $msg, $filename=null)
1642 {
1643     if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1644         $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1645         $msg = '[' . common_request_id() . '] ' . $msg;
1646         $logfile = common_config('site', 'logfile');
1647         if ($logfile) {
1648             $log = fopen($logfile, "a");
1649             if ($log) {
1650                 $output = common_log_line($priority, $msg);
1651                 fwrite($log, $output);
1652                 fclose($log);
1653             }
1654         } else {
1655             common_ensure_syslog();
1656             syslog($priority, $msg);
1657         }
1658         Event::handle('EndLog', array($priority, $msg, $filename));
1659     }
1660 }
1661
1662 function common_debug($msg, $filename=null)
1663 {
1664     if ($filename) {
1665         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1666     } else {
1667         common_log(LOG_DEBUG, $msg);
1668     }
1669 }
1670
1671 function common_log_db_error(&$object, $verb, $filename=null)
1672 {
1673     $objstr = common_log_objstring($object);
1674     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1675     if (is_object($last_error)) {
1676         $msg = $last_error->message;
1677     } else {
1678         $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1679     }
1680     common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1681 }
1682
1683 function common_log_objstring(&$object)
1684 {
1685     if (is_null($object)) {
1686         return "null";
1687     }
1688     if (!($object instanceof DB_DataObject)) {
1689         return "(unknown)";
1690     }
1691     $arr = $object->toArray();
1692     $fields = array();
1693     foreach ($arr as $k => $v) {
1694         if (is_object($v)) {
1695             $fields[] = "$k='".get_class($v)."'";
1696         } else {
1697             $fields[] = "$k='$v'";
1698         }
1699     }
1700     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1701     return $objstring;
1702 }
1703
1704 function common_valid_http_url($url)
1705 {
1706     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1707 }
1708
1709 function common_valid_tag($tag)
1710 {
1711     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1712         return (Validate::email($matches[1]) ||
1713                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1714     }
1715     return false;
1716 }
1717
1718 /**
1719  * Determine if given domain or address literal is valid
1720  * eg for use in JIDs and URLs. Does not check if the domain
1721  * exists!
1722  *
1723  * @param string $domain
1724  * @return boolean valid or not
1725  */
1726 function common_valid_domain($domain)
1727 {
1728     $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1729     $ipv4 = "(?:$octet(?:\.$octet){3})";
1730     if (preg_match("/^$ipv4$/u", $domain)) return true;
1731
1732     $group = "(?:[0-9a-f]{1,4})";
1733     $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1734
1735     if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1736         $before = explode(":", $matches[1]);
1737         $zeroes = $matches[2];
1738         $after = explode(":", $matches[3]);
1739         if ($zeroes) {
1740             $min = 0;
1741             $max = 7;
1742         } else {
1743             $min = 1;
1744             $max = 8;
1745         }
1746         $explicit = count($before) + count($after);
1747         if ($explicit < $min || $explicit > $max) {
1748             return false;
1749         }
1750         return true;
1751     }
1752
1753     try {
1754         require_once "Net/IDNA.php";
1755         $idn = Net_IDNA::getInstance();
1756         $domain = $idn->encode($domain);
1757     } catch (Exception $e) {
1758         return false;
1759     }
1760
1761     $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1762     $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1763
1764     return preg_match("/^$fqdn$/ui", $domain);
1765 }
1766
1767 /* Following functions are copied from MediaWiki GlobalFunctions.php
1768  * and written by Evan Prodromou. */
1769
1770 function common_accept_to_prefs($accept, $def = '*/*')
1771 {
1772     // No arg means accept anything (per HTTP spec)
1773     if(!$accept) {
1774         return array($def => 1);
1775     }
1776
1777     $prefs = array();
1778
1779     $parts = explode(',', $accept);
1780
1781     foreach($parts as $part) {
1782         // FIXME: doesn't deal with params like 'text/html; level=1'
1783         @list($value, $qpart) = explode(';', trim($part));
1784         $match = array();
1785         if(!isset($qpart)) {
1786             $prefs[$value] = 1;
1787         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1788             $prefs[$value] = $match[1];
1789         }
1790     }
1791
1792     return $prefs;
1793 }
1794
1795 function common_mime_type_match($type, $avail)
1796 {
1797     if(array_key_exists($type, $avail)) {
1798         return $type;
1799     } else {
1800         $parts = explode('/', $type);
1801         if(array_key_exists($parts[0] . '/*', $avail)) {
1802             return $parts[0] . '/*';
1803         } elseif(array_key_exists('*/*', $avail)) {
1804             return '*/*';
1805         } else {
1806             return null;
1807         }
1808     }
1809 }
1810
1811 function common_negotiate_type($cprefs, $sprefs)
1812 {
1813     $combine = array();
1814
1815     foreach(array_keys($sprefs) as $type) {
1816         $parts = explode('/', $type);
1817         if($parts[1] != '*') {
1818             $ckey = common_mime_type_match($type, $cprefs);
1819             if($ckey) {
1820                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1821             }
1822         }
1823     }
1824
1825     foreach(array_keys($cprefs) as $type) {
1826         $parts = explode('/', $type);
1827         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1828             $skey = common_mime_type_match($type, $sprefs);
1829             if($skey) {
1830                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1831             }
1832         }
1833     }
1834
1835     $bestq = 0;
1836     $besttype = 'text/html';
1837
1838     foreach(array_keys($combine) as $type) {
1839         if($combine[$type] > $bestq) {
1840             $besttype = $type;
1841             $bestq = $combine[$type];
1842         }
1843     }
1844
1845     if ('text/html' === $besttype) {
1846         return "text/html; charset=utf-8";
1847     }
1848     return $besttype;
1849 }
1850
1851 function common_config($main, $sub)
1852 {
1853     global $config;
1854     return (array_key_exists($main, $config) &&
1855             array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1856 }
1857
1858 /**
1859  * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
1860  * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
1861  *
1862  * @param array $from
1863  * @return array
1864  */
1865 function common_copy_args($from)
1866 {
1867     $to = array();
1868     $strip = get_magic_quotes_gpc();
1869     foreach ($from as $k => $v) {
1870         if(is_array($v)) {
1871             $to[$k] = common_copy_args($v);
1872         } else {
1873             if ($strip) {
1874                 $v = stripslashes($v);
1875             }
1876             $to[$k] = strval(common_validate_utf8($v));
1877         }
1878     }
1879     return $to;
1880 }
1881
1882 /**
1883  * Neutralise the evil effects of magic_quotes_gpc in the current request.
1884  * This is used before handing a request off to OAuthRequest::from_request.
1885  * @fixme Doesn't consider vars other than _POST and _GET?
1886  * @fixme Can't be undone and could corrupt data if run twice.
1887  */
1888 function common_remove_magic_from_request()
1889 {
1890     if(get_magic_quotes_gpc()) {
1891         $_POST=array_map('stripslashes',$_POST);
1892         $_GET=array_map('stripslashes',$_GET);
1893     }
1894 }
1895
1896 function common_user_uri(&$user)
1897 {
1898     return common_local_url('userbyid', array('id' => $user->id),
1899                             null, null, false);
1900 }
1901
1902 function common_notice_uri(&$notice)
1903 {
1904     return common_local_url('shownotice',
1905                             array('notice' => $notice->id),
1906                             null, null, false);
1907 }
1908
1909 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1910
1911 function common_confirmation_code($bits)
1912 {
1913     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1914     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1915     $chars = ceil($bits/5);
1916     $code = '';
1917     for ($i = 0; $i < $chars; $i++) {
1918         // XXX: convert to string and back
1919         $num = hexdec(common_good_rand(1));
1920         // XXX: randomness is too precious to throw away almost
1921         // 40% of the bits we get!
1922         $code .= $codechars[$num%32];
1923     }
1924     return $code;
1925 }
1926
1927 // convert markup to HTML
1928
1929 function common_markup_to_html($c)
1930 {
1931     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1932     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1933     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1934     return Markdown($c);
1935 }
1936
1937 function common_profile_uri($profile)
1938 {
1939     if (!$profile) {
1940         return null;
1941     }
1942     $user = User::staticGet($profile->id);
1943     if ($user) {
1944         return $user->uri;
1945     }
1946
1947     $remote = Remote_profile::staticGet($profile->id);
1948     if ($remote) {
1949         return $remote->uri;
1950     }
1951     // XXX: this is a very bad profile!
1952     return null;
1953 }
1954
1955 function common_canonical_sms($sms)
1956 {
1957     // strip non-digits
1958     preg_replace('/\D/', '', $sms);
1959     return $sms;
1960 }
1961
1962 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1963 {
1964     switch ($errno) {
1965
1966      case E_ERROR:
1967      case E_COMPILE_ERROR:
1968      case E_CORE_ERROR:
1969      case E_USER_ERROR:
1970      case E_PARSE:
1971      case E_RECOVERABLE_ERROR:
1972         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1973         die();
1974         break;
1975
1976      case E_WARNING:
1977      case E_COMPILE_WARNING:
1978      case E_CORE_WARNING:
1979      case E_USER_WARNING:
1980         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1981         break;
1982
1983      case E_NOTICE:
1984      case E_USER_NOTICE:
1985         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1986         break;
1987
1988      case E_STRICT:
1989      case E_DEPRECATED:
1990      case E_USER_DEPRECATED:
1991         // XXX: config variable to log this stuff, too
1992         break;
1993
1994      default:
1995         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1996         die();
1997         break;
1998     }
1999
2000     // FIXME: show error page if we're on the Web
2001     /* Don't execute PHP internal error handler */
2002     return true;
2003 }
2004
2005 function common_session_token()
2006 {
2007     common_ensure_session();
2008     if (!array_key_exists('token', $_SESSION)) {
2009         $_SESSION['token'] = common_good_rand(64);
2010     }
2011     return $_SESSION['token'];
2012 }
2013
2014 function common_license_terms($uri)
2015 {
2016     if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2017         return explode('-',$matches[1]);
2018     }
2019     return array($uri);
2020 }
2021
2022 function common_compatible_license($from, $to)
2023 {
2024     $from_terms = common_license_terms($from);
2025     // public domain and cc-by are compatible with everything
2026     if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2027         return true;
2028     }
2029     $to_terms = common_license_terms($to);
2030     // sa is compatible across versions. IANAL
2031     if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2032         return count(array_diff($from_terms, $to_terms)) == 0;
2033     }
2034     // XXX: better compatibility check needed here!
2035     // Should at least normalise URIs
2036     return ($from == $to);
2037 }
2038
2039 /**
2040  * returns a quoted table name, if required according to config
2041  */
2042 function common_database_tablename($tablename)
2043 {
2044   if(common_config('db','quote_identifiers')) {
2045       $tablename = '"'. $tablename .'"';
2046   }
2047   //table prefixes could be added here later
2048   return $tablename;
2049 }
2050
2051 /**
2052  * Shorten a URL with the current user's configured shortening service,
2053  * or ur1.ca if configured, or not at all if no shortening is set up.
2054  *
2055  * @param string  $long_url original URL
2056  * @param User $user to specify a particular user's options
2057  * @param boolean $force    Force shortening (used when notice is too long)
2058  * @return string may return the original URL if shortening failed
2059  *
2060  * @fixme provide a way to specify a particular shortener
2061  */
2062 function common_shorten_url($long_url, User $user=null, $force = false)
2063 {
2064     $long_url = trim($long_url);
2065
2066     $user = common_current_user();
2067
2068     $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2069
2070     // $force forces shortening even if it's not strictly needed
2071     // I doubt URL shortening is ever 'strictly' needed. - ESP
2072
2073     if (mb_strlen($long_url) < $maxUrlLength && !$force) {
2074         return $long_url;
2075     }
2076
2077     $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2078
2079     if (Event::handle('StartShortenUrl',
2080                       array($long_url, $shortenerName, &$shortenedUrl))) {
2081         if ($shortenerName == 'internal') {
2082             $f = File::processNew($long_url);
2083             if (empty($f)) {
2084                 return $long_url;
2085             } else {
2086                 $shortenedUrl = common_local_url('redirecturl',
2087                                                  array('id' => $f->id));
2088                 return $shortenedUrl;
2089             }
2090         } else {
2091             return $long_url;
2092         }
2093     } else {
2094         //URL was shortened, so return the result
2095         return trim($shortenedUrl);
2096     }
2097 }
2098
2099 /**
2100  * @return mixed array($proxy, $ip) for web requests; proxy may be null
2101  *               null if not a web request
2102  *
2103  * @fixme X-Forwarded-For can be chained by multiple proxies;
2104           we should parse the list and provide a cleaner array
2105  * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2106  * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2107  *        use function to get exact request headers from Apache if possible.
2108  */
2109 function common_client_ip()
2110 {
2111     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2112         return null;
2113     }
2114
2115     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2116         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2117             $proxy = $_SERVER['HTTP_CLIENT_IP'];
2118         } else {
2119             $proxy = $_SERVER['REMOTE_ADDR'];
2120         }
2121         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2122     } else {
2123         $proxy = null;
2124         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2125             $ip = $_SERVER['HTTP_CLIENT_IP'];
2126         } else {
2127             $ip = $_SERVER['REMOTE_ADDR'];
2128         }
2129     }
2130
2131     return array($proxy, $ip);
2132 }
2133
2134 function common_url_to_nickname($url)
2135 {
2136     static $bad = array('query', 'user', 'password', 'port', 'fragment');
2137
2138     $parts = parse_url($url);
2139
2140     # If any of these parts exist, this won't work
2141
2142     foreach ($bad as $badpart) {
2143         if (array_key_exists($badpart, $parts)) {
2144             return null;
2145         }
2146     }
2147
2148     # We just have host and/or path
2149
2150     # If it's just a host...
2151     if (array_key_exists('host', $parts) &&
2152         (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2153     {
2154         $hostparts = explode('.', $parts['host']);
2155
2156         # Try to catch common idiom of nickname.service.tld
2157
2158         if ((count($hostparts) > 2) &&
2159             (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2160             (strcmp($hostparts[0], 'www') != 0))
2161         {
2162             return common_nicknamize($hostparts[0]);
2163         } else {
2164             # Do the whole hostname
2165             return common_nicknamize($parts['host']);
2166         }
2167     } else {
2168         if (array_key_exists('path', $parts)) {
2169             # Strip starting, ending slashes
2170             $path = preg_replace('@/$@', '', $parts['path']);
2171             $path = preg_replace('@^/@', '', $path);
2172             $path = basename($path);
2173
2174             // Hack for MediaWiki user pages, in the form:
2175             // http://example.com/wiki/User:Myname
2176             // ('User' may be localized.)
2177             if (strpos($path, ':')) {
2178                 $parts = array_filter(explode(':', $path));
2179                 $path = $parts[count($parts) - 1];
2180             }
2181
2182             if ($path) {
2183                 return common_nicknamize($path);
2184             }
2185         }
2186     }
2187
2188     return null;
2189 }
2190
2191 function common_nicknamize($str)
2192 {
2193     $str = preg_replace('/\W/', '', $str);
2194     return strtolower($str);
2195 }
2196
2197 function common_perf_counter($key, $val=null)
2198 {
2199     global $_perfCounters;
2200     if (isset($_perfCounters)) {
2201         if (common_config('site', 'logperf')) {
2202             if (array_key_exists($key, $_perfCounters)) {
2203                 $_perfCounters[$key][] = $val;
2204             } else {
2205                 $_perfCounters[$key] = array($val);
2206             }
2207             if (common_config('site', 'logperf_detail')) {
2208                 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2209             }
2210         }
2211     }
2212 }
2213
2214 function common_log_perf_counters()
2215 {
2216     if (common_config('site', 'logperf')) {
2217         global $_startTime, $_perfCounters;
2218
2219         if (isset($_startTime)) {
2220             $endTime = microtime(true);
2221             $diff = round(($endTime - $_startTime) * 1000);
2222             common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2223         }
2224         $counters = $_perfCounters;
2225         ksort($counters);
2226         foreach ($counters as $key => $values) {
2227             $count = count($values);
2228             $unique = count(array_unique($values));
2229             common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2230         }
2231     }
2232 }