]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/util.php
Refactor on File::processNew
[quix0rs-gnu-social.git] / lib / util.php
1 <?php
2 /*
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2008-2011, 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, Profile $profile=null)
214 {
215     $hashed = null;
216
217     if (Event::handle('StartHashPassword', array(&$hashed, $password, $profile))) {
218         Event::handle('EndHashPassword', array(&$hashed, $password, $profile));
219     }
220     if (empty($hashed)) {
221         throw new PasswordHashException();
222     }
223
224     return $hashed;
225 }
226
227 /**
228  * Check if a username exists and has matching password.
229  */
230 function common_check_user($nickname, $password)
231 {
232     // empty nickname always unacceptable
233     if (empty($nickname)) {
234         return false;
235     }
236
237     $authenticatedUser = false;
238
239     if (Event::handle('StartCheckPassword', array($nickname, $password, &$authenticatedUser))) {
240
241         if (common_is_email($nickname)) {
242             $user = User::getKV('email', common_canonical_email($nickname));
243         } else {
244             $user = User::getKV('nickname', Nickname::normalize($nickname));
245         }
246
247         if ($user instanceof User && !empty($password)) {
248             if (0 == strcmp(common_munge_password($password, $user->getProfile()), $user->password)) {
249                 //internal checking passed
250                 $authenticatedUser = $user;
251             }
252         }
253     }
254     Event::handle('EndCheckPassword', array($nickname, $password, $authenticatedUser));
255
256     return $authenticatedUser;
257 }
258
259 /**
260  * Is the current user logged in?
261  */
262 function common_logged_in()
263 {
264     return (!is_null(common_current_user()));
265 }
266
267 function common_have_session()
268 {
269     return (0 != strcmp(session_id(), ''));
270 }
271
272 function common_ensure_session()
273 {
274     $c = null;
275     if (array_key_exists(session_name(), $_COOKIE)) {
276         $c = $_COOKIE[session_name()];
277     }
278     if (!common_have_session()) {
279         if (common_config('sessions', 'handle')) {
280             Session::setSaveHandler();
281         }
282         if (array_key_exists(session_name(), $_GET)) {
283             $id = $_GET[session_name()];
284         } else if (array_key_exists(session_name(), $_COOKIE)) {
285             $id = $_COOKIE[session_name()];
286         }
287         if (isset($id)) {
288             session_id($id);
289         }
290         @session_start();
291         if (!isset($_SESSION['started'])) {
292             $_SESSION['started'] = time();
293             if (!empty($id)) {
294                 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
295                            ' is set but started value is null');
296             }
297         }
298     }
299 }
300
301 // Three kinds of arguments:
302 // 1) a user object
303 // 2) a nickname
304 // 3) null to clear
305
306 // Initialize to false; set to null if none found
307 $_cur = false;
308
309 function common_set_user($user)
310 {
311     global $_cur;
312
313     if (is_null($user) && common_have_session()) {
314         $_cur = null;
315         unset($_SESSION['userid']);
316         return true;
317     } else if (is_string($user)) {
318         $nickname = $user;
319         $user = User::getKV('nickname', $nickname);
320     } else if (!$user instanceof User) {
321         return false;
322     }
323
324     if ($user) {
325         if (Event::handle('StartSetUser', array(&$user))) {
326             if (!empty($user)) {
327                 if (!$user->hasRight(Right::WEBLOGIN)) {
328                     // TRANS: Authorisation exception thrown when a user a not allowed to login.
329                     throw new AuthorizationException(_('Not allowed to log in.'));
330                 }
331                 common_ensure_session();
332                 $_SESSION['userid'] = $user->id;
333                 $_cur = $user;
334                 Event::handle('EndSetUser', array($user));
335                 return $_cur;
336             }
337         }
338     }
339     return false;
340 }
341
342 function common_set_cookie($key, $value, $expiration=0)
343 {
344     $path = common_config('site', 'path');
345     $server = common_config('site', 'server');
346
347     if ($path && ($path != '/')) {
348         $cookiepath = '/' . $path . '/';
349     } else {
350         $cookiepath = '/';
351     }
352     return setcookie($key,
353                      $value,
354                      $expiration,
355                      $cookiepath,
356                      $server,
357                      common_config('site', 'ssl')=='always');
358 }
359
360 define('REMEMBERME', 'rememberme');
361 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
362
363 function common_rememberme($user=null)
364 {
365     if (!$user) {
366         $user = common_current_user();
367         if (!$user) {
368             return false;
369         }
370     }
371
372     $rm = new Remember_me();
373
374     $rm->code = common_random_hexstr(16);
375     $rm->user_id = $user->id;
376
377     // Wrap the insert in some good ol' fashioned transaction code
378
379     $rm->query('BEGIN');
380
381     $result = $rm->insert();
382
383     if (!$result) {
384         common_log_db_error($rm, 'INSERT', __FILE__);
385         $rm->query('ROLLBACK');
386         return false;
387     }
388
389     $rm->query('COMMIT');
390
391     $cookieval = $rm->user_id . ':' . $rm->code;
392
393     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
394
395     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
396
397     return true;
398 }
399
400 function common_remembered_user()
401 {
402     $user = null;
403
404     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
405
406     if (!$packed) {
407         return null;
408     }
409
410     list($id, $code) = explode(':', $packed);
411
412     if (!$id || !$code) {
413         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
414         common_forgetme();
415         return null;
416     }
417
418     $rm = Remember_me::getKV('code', $code);
419
420     if (!$rm) {
421         common_log(LOG_WARNING, 'No such remember code: ' . $code);
422         common_forgetme();
423         return null;
424     }
425
426     if ($rm->user_id != $id) {
427         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
428         common_forgetme();
429         return null;
430     }
431
432     $user = User::getKV('id', $rm->user_id);
433
434     if (!$user instanceof User) {
435         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
436         common_forgetme();
437         return null;
438     }
439
440     // successful!
441     $result = $rm->delete();
442
443     if (!$result) {
444         common_log_db_error($rm, 'DELETE', __FILE__);
445         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
446         common_forgetme();
447         return null;
448     }
449
450     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
451
452     common_set_user($user);
453     common_real_login(false);
454
455     // We issue a new cookie, so they can log in
456     // automatically again after this session
457
458     common_rememberme($user);
459
460     return $user;
461 }
462
463 /**
464  * must be called with a valid user!
465  */
466 function common_forgetme()
467 {
468     common_set_cookie(REMEMBERME, '', 0);
469 }
470
471 /**
472  * Who is the current user?
473  */
474 function common_current_user()
475 {
476     global $_cur;
477
478     if (!_have_config()) {
479         return null;
480     }
481
482     if ($_cur === false) {
483
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;
488             if ($id) {
489                 $user = User::getKV('id', $id);
490                 if ($user instanceof User) {
491                         $_cur = $user;
492                         return $_cur;
493                 }
494             }
495         }
496
497         // that didn't work; try to remember; will init $_cur to null on failure
498         $_cur = common_remembered_user();
499
500         if ($_cur) {
501             // XXX: Is this necessary?
502             $_SESSION['userid'] = $_cur->id;
503         }
504     }
505
506     return $_cur;
507 }
508
509 /**
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.
513  */
514 function common_real_login($real=true)
515 {
516     common_ensure_session();
517     $_SESSION['real_login'] = $real;
518 }
519
520 function common_is_real_login()
521 {
522     return common_logged_in() && $_SESSION['real_login'];
523 }
524
525 /**
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.
530  *
531  * This should not be considered secure information.
532  *
533  * @param User $user (optional; uses common_current_user() if left out)
534  * @return string
535  */
536 function common_user_cache_hash($user=false)
537 {
538     if ($user === false) {
539         $user = common_current_user();
540     }
541     if ($user) {
542         return crc32($user->id . ':' . $user->nickname);
543     } else {
544         return '0';
545     }
546 }
547
548 /**
549  * get canonical version of nickname for comparison
550  *
551  * @param string $nickname
552  * @return string
553  *
554  * @throws NicknameException on invalid input
555  * @deprecated call Nickname::normalize() directly.
556  */
557 function common_canonical_nickname($nickname)
558 {
559     return Nickname::normalize($nickname);
560 }
561
562 /**
563  * get canonical version of email for comparison
564  *
565  * @fixme actually normalize
566  * @fixme reject invalid input
567  *
568  * @param string $email
569  * @return string
570  */
571 function common_canonical_email($email)
572 {
573     // XXX: canonicalize UTF-8
574     // XXX: lcase the domain part
575     return $email;
576 }
577
578 function common_purify($html)
579 {
580     require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
581
582     $config = array('safe' => 1,    // means that elements=* means elements=*-applet-embed-iframe-object-script or so
583                     'elements' => '*',
584                     'deny_attribute' => 'id,style,on*');
585
586     // Remove more elements than what the 'safe' filter gives (elements must be '*' before this)
587     // http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed/htmLawed_README.htm#s3.6
588     foreach (common_config('htmlfilter') as $tag=>$filter) {
589         if ($filter === true) {
590             $config['elements'] .= "-{$tag}";
591         }
592     }
593
594     $html = common_remove_unicode_formatting($html);
595
596     return htmLawed($html, $config);
597 }
598
599 function common_remove_unicode_formatting($text)
600 {
601     // Strip Unicode text formatting/direction codes
602     // this is pretty dangerous for visualisation of text and can be used for mischief
603     return preg_replace('/[\\x{200b}-\\x{200f}\\x{202a}-\\x{202e}]/u', '', $text);
604 }
605
606 /**
607  * Partial notice markup rendering step: build links to !group references.
608  *
609  * @param string $text partially rendered HTML
610  * @param Notice $notice in whose context we're working
611  * @return string partially rendered HTML
612  */
613 function common_render_content($text, Notice $notice)
614 {
615     $text = common_render_text($text);
616     $text = common_linkify_mentions($text, $notice);
617     return $text;
618 }
619
620 /**
621  * Finds @-mentions within the partially-rendered text section and
622  * turns them into live links.
623  *
624  * Should generally not be called except from common_render_content().
625  *
626  * @param string $text partially-rendered HTML
627  * @param Notice $notice in-progress or complete Notice object for context
628  * @return string partially-rendered HTML
629  */
630 function common_linkify_mentions($text, Notice $notice)
631 {
632     $mentions = common_find_mentions($text, $notice);
633
634     // We need to go through in reverse order by position,
635     // so our positions stay valid despite our fudging with the
636     // string!
637
638     $points = array();
639
640     foreach ($mentions as $mention)
641     {
642         $points[$mention['position']] = $mention;
643     }
644
645     krsort($points);
646
647     foreach ($points as $position => $mention) {
648
649         $linkText = common_linkify_mention($mention);
650
651         $text = substr_replace($text, $linkText, $position, mb_strlen($mention['text']));
652     }
653
654     return $text;
655 }
656
657 function common_linkify_mention(array $mention)
658 {
659     $output = null;
660
661     if (Event::handle('StartLinkifyMention', array($mention, &$output))) {
662
663         $xs = new XMLStringer(false);
664
665         $attrs = array('href' => $mention['url'],
666                        'class' => 'h-card '.$mention['type']);
667
668         if (!empty($mention['title'])) {
669             $attrs['title'] = $mention['title'];
670         }
671
672         $xs->element('a', $attrs, $mention['text']);
673
674         $output = $xs->getString();
675
676         Event::handle('EndLinkifyMention', array($mention, &$output));
677     }
678
679     return $output;
680 }
681
682 /**
683  * Find @-mentions in the given text, using the given notice object as context.
684  * References will be resolved with common_relative_profile() against the user
685  * who posted the notice.
686  *
687  * Note the return data format is internal, to be used for building links and
688  * such. Should not be used directly; rather, call common_linkify_mentions().
689  *
690  * @param string $text
691  * @param Notice $notice notice in whose context we're building links
692  *
693  * @return array
694  *
695  * @access private
696  */
697 function common_find_mentions($text, Notice $notice)
698 {
699     // The getProfile call throws NoProfileException on failure
700     $sender = $notice->getProfile();
701
702     $mentions = array();
703
704     if (Event::handle('StartFindMentions', array($sender, $text, &$mentions))) {
705         // Get the context of the original notice, if any
706         $origAuthor   = null;
707         $origNotice   = null;
708         $origMentions = array();
709
710         // Is it a reply?
711
712         try {
713             $origNotice = $notice->getParent();
714             $origAuthor = $origNotice->getProfile();
715
716             $ids = $origNotice->getReplies();
717
718             foreach ($ids as $id) {
719                 try {
720                     $repliedTo = Profile::getByID($id);
721                     $origMentions[$repliedTo->getNickname()] = $repliedTo;
722                 } catch (NoResultException $e) {
723                     // continue foreach
724                 }
725             }
726         } catch (NoParentNoticeException $e) {
727             // It wasn't a reply to anything, so we can't harvest nickname-relations.
728         } catch (NoResultException $e) {
729             // The parent notice was deleted.
730         }
731
732         $matches = common_find_mentions_raw($text);
733
734         foreach ($matches as $match) {
735             try {
736                 $nickname = Nickname::normalize($match[0]);
737             } catch (NicknameException $e) {
738                 // Bogus match? Drop it.
739                 continue;
740             }
741
742             // Try to get a profile for this nickname.
743             // Start with conversation context, then go to
744             // sender context.
745
746             if ($origAuthor instanceof Profile && $origAuthor->nickname == $nickname) {
747                 $mentioned = $origAuthor;
748             } else if (!empty($origMentions) &&
749                        array_key_exists($nickname, $origMentions)) {
750                 $mentioned = $origMentions[$nickname];
751             } else {
752                 $mentioned = common_relative_profile($sender, $nickname);
753             }
754
755             if ($mentioned instanceof Profile) {
756                 $user = User::getKV('id', $mentioned->id);
757
758                 if ($user instanceof User) {
759                     $url = common_local_url('userbyid', array('id' => $user->id));
760                 } else {
761                     $url = $mentioned->profileurl;
762                 }
763
764                 $mention = array('mentioned' => array($mentioned),
765                                  'type' => 'mention',
766                                  'text' => $match[0],
767                                  'position' => $match[1],
768                                  'url' => $url);
769
770                 if (!empty($mentioned->fullname)) {
771                     $mention['title'] = $mentioned->fullname;
772                 }
773
774                 $mentions[] = $mention;
775             }
776         }
777
778         // @#tag => mention of all subscriptions tagged 'tag'
779
780         preg_match_all('/(?:^|[\s\.\,\:\;]+)@#([\pL\pN_\-\.]{1,64})/',
781                        $text, $hmatches, PREG_OFFSET_CAPTURE);
782         foreach ($hmatches[1] as $hmatch) {
783             $tag = common_canonical_tag($hmatch[0]);
784             $plist = Profile_list::getByTaggerAndTag($sender->id, $tag);
785             if (!$plist instanceof Profile_list || $plist->private) {
786                 continue;
787             }
788             $tagged = $sender->getTaggedSubscribers($tag);
789
790             $url = common_local_url('showprofiletag',
791                                     array('nickname' => $sender->getNickname(),
792                                           'tag' => $tag));
793
794             $mentions[] = array('mentioned' => $tagged,
795                                 'type'      => 'list',
796                                 'text' => $hmatch[0],
797                                 'position' => $hmatch[1],
798                                 'url' => $url);
799         }
800
801         preg_match_all('/(?:^|[\s\.\,\:\;]+)!(' . Nickname::DISPLAY_FMT . ')/',
802                        $text, $hmatches, PREG_OFFSET_CAPTURE);
803         foreach ($hmatches[1] as $hmatch) {
804             $nickname = Nickname::normalize($hmatch[0]);
805             $group = User_group::getForNickname($nickname, $sender);
806
807             if (!$group instanceof User_group || !$sender->isMember($group)) {
808                 continue;
809             }
810
811             $profile = $group->getProfile();
812
813             $mentions[] = array('mentioned' => array($profile),
814                                 'type'      => 'group',
815                                 'text'      => $hmatch[0],
816                                 'position'  => $hmatch[1],
817                                 'url'       => $group->permalink(),
818                                 'title'     => $group->getFancyName());
819         }
820
821         Event::handle('EndFindMentions', array($sender, $text, &$mentions));
822     }
823
824     return $mentions;
825 }
826
827 /**
828  * Does the actual regex pulls to find @-mentions in text.
829  * Should generally not be called directly; for use in common_find_mentions.
830  *
831  * @param string $text
832  * @return array of PCRE match arrays
833  */
834 function common_find_mentions_raw($text)
835 {
836     $tmatches = array();
837     preg_match_all('/^T (' . Nickname::DISPLAY_FMT . ') /',
838                    $text,
839                    $tmatches,
840                    PREG_OFFSET_CAPTURE);
841
842     $atmatches = array();
843     preg_match_all('/(?:^|\s+)@(' . Nickname::DISPLAY_FMT . ')\b/',
844                    $text,
845                    $atmatches,
846                    PREG_OFFSET_CAPTURE);
847
848     $matches = array_merge($tmatches[1], $atmatches[1]);
849     return $matches;
850 }
851
852 function common_render_text($text)
853 {
854     $text = common_remove_unicode_formatting($text);
855     $text = nl2br(htmlspecialchars($text));
856
857     $text = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $text);
858     $text = common_replace_urls_callback($text, 'common_linkify');
859     $text = preg_replace_callback('/(^|\&quot\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/u',
860                 function ($m) { return "{$m[1]}#".common_tag_link($m[2]); }, $text);
861     // XXX: machine tags
862     return $text;
863 }
864
865 /**
866  * Find links in the given text and pass them to the given callback function.
867  *
868  * @param string $text
869  * @param function($text, $arg) $callback: return replacement text
870  * @param mixed $arg: optional argument will be passed on to the callback
871  */
872 function common_replace_urls_callback($text, $callback, $arg = null) {
873     // Start off with a regex
874     $regex = '#'.
875     '(?:^|[\s\<\>\(\)\[\]\{\}\\\'\\\";]+)(?![\@\!\#])'.
876     '('.
877         '(?:'.
878             '(?:'. //Known protocols
879                 '(?:'.
880                     '(?:(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://)'.
881                     '|'.
882                     '(?:(?:mailto|aim|tel|xmpp):)'.
883                 ')'.
884                 '(?:[\pN\pL\-\_\+\%\~]+(?::[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
885                 '(?:'.
886                     '(?:'.
887                         '\[[\pN\pL\-\_\:\.]+(?<![\.\:])\]'. //[dns]
888                     ')|(?:'.
889                         '[\pN\pL\-\_\:\.]+(?<![\.\:])'. //dns
890                     ')'.
891                 ')'.
892             ')'.
893             '|(?:(?:magnet):)'. // URLs without domain name
894             '|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)'. //IPv4
895             '|(?:'. //IPv6
896                 '\[?(?:(?:(?:[0-9A-Fa-f]{1,4}:){7}(?:(?:[0-9A-Fa-f]{1,4})|:))|(?:(?:[0-9A-Fa-f]{1,4}:){6}(?::|(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})|(?::[0-9A-Fa-f]{1,4})))|(?:(?:[0-9A-Fa-f]{1,4}:){5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){4}(?::[0-9A-Fa-f]{1,4}){0,1}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){3}(?::[0-9A-Fa-f]{1,4}){0,2}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){2}(?::[0-9A-Fa-f]{1,4}){0,3}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:)(?::[0-9A-Fa-f]{1,4}){0,4}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?::(?::[0-9A-Fa-f]{1,4}){0,5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})))\]?(?<!:)'.
897             ')'.
898             (common_config('linkify', 'bare_domains')
899                 ? '|(?:'. //DNS
900                     '(?:[\pN\pL\-\_\+\%\~]+(?:\:[\pN\pL\-\_\+\%\~]+)?\@)?'. //user:pass@
901                     '[\pN\pL\-\_]+(?:\.[\pN\pL\-\_]+)*\.'.
902                     //tld list from http://data.iana.org/TLD/tlds-alpha-by-domain.txt, also added local, loc, and onion
903                     '(?:AC|AD|AE|AERO|AF|AG|AI|AL|AM|AN|AO|AQ|AR|ARPA|AS|ASIA|AT|AU|AW|AX|AZ|BA|BB|BD|BE|BF|BG|BH|BI|BIZ|BJ|BM|BN|BO|BR|BS|BT|BV|BW|BY|BZ|CA|CAT|CC|CD|CF|CG|CH|CI|CK|CL|CM|CN|CO|COM|COOP|CR|CU|CV|CX|CY|CZ|DE|DJ|DK|DM|DO|DZ|EC|EDU|EE|EG|ER|ES|ET|EU|FI|FJ|FK|FM|FO|FR|GA|GB|GD|GE|GF|GG|GH|GI|GL|GM|GN|GOV|GP|GQ|GR|GS|GT|GU|GW|GY|HK|HM|HN|HR|HT|HU|ID|IE|IL|IM|IN|INFO|INT|IO|IQ|IR|IS|IT|JE|JM|JO|JOBS|JP|KE|KG|KH|KI|KM|KN|KP|KR|KW|KY|KZ|LA|LB|LC|LI|LK|LR|LS|LT|LU|LV|LY|MA|MC|MD|ME|MG|MH|MIL|MK|ML|MM|MN|MO|MOBI|MP|MQ|MR|MS|MT|MU|MUSEUM|MV|MW|MX|MY|MZ|NA|NAME|NC|NE|NET|NF|NG|NI|NL|NO|NP|NR|NU|NZ|OM|ORG|PA|PE|PF|PG|PH|PK|PL|PM|PN|PR|PRO|PS|PT|PW|PY|QA|RE|RO|RS|RU|RW|SA|SB|SC|SD|SE|SG|SH|SI|SJ|SK|SL|SM|SN|SO|SR|ST|SU|SV|SY|SZ|TC|TD|TEL|TF|TG|TH|TJ|TK|TL|TM|TN|TO|TP|TR|TRAVEL|TT|TV|TW|TZ|UA|UG|UK|US|UY|UZ|VA|VC|VE|VG|VI|VN|VU|WF|WS|XN--0ZWM56D|测试|XN--11B5BS3A9AJ6G|परीक्षा|XN--80AKHBYKNJ4F|испытание|XN--9T4B11YI5A|테스트|XN--DEBA0AD|טעסט|XN--G6W251D|測試|XN--HGBK6AJ7F53BBA|آزمایشی|XN--HLCJ6AYA9ESC7A|பரிட்சை|XN--JXALPDLP|δοκιμή|XN--KGBECHTV|إختبار|XN--ZCKZAH|テスト|YE|YT|YU|ZA|ZM|ZONE|ZW|local|loc|onion)'.
904             ')(?![\pN\pL\-\_])'
905                 : '') . // if common_config('linkify', 'bare_domains') is false, don't add anything here
906         ')'.
907         '(?:'.
908             '(?:\:\d+)?'. //:port
909             '(?:/[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@]*)?'. // /path
910             '(?:\?[\pN\pL\$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'@\/]*)?'. // ?query string
911             '(?:\#[\pN\pL$\,\!\(\)\.\:\-\_\+\/\=\&\;\%\~\*\$\+\'\@/\?\#]*)?'. // #fragment
912         ')(?<![\?\.\,\#\,])'.
913     ')'.
914     '#ixu';
915     //preg_match_all($regex,$text,$matches);
916     //print_r($matches);
917     return preg_replace_callback($regex, curry('callback_helper',$callback,$arg) ,$text);
918 }
919
920 /**
921  * Intermediate callback for common_replace_links(), helps resolve some
922  * ambiguous link forms before passing on to the final callback.
923  *
924  * @param array $matches
925  * @param callable $callback
926  * @param mixed $arg optional argument to pass on as second param to callback
927  * @return string
928  *
929  * @access private
930  */
931 function callback_helper($matches, $callback, $arg=null) {
932     $url=$matches[1];
933     $left = strpos($matches[0],$url);
934     $right = $left+strlen($url);
935
936     $groupSymbolSets=array(
937         array(
938             'left'=>'(',
939             'right'=>')'
940         ),
941         array(
942             'left'=>'[',
943             'right'=>']'
944         ),
945         array(
946             'left'=>'{',
947             'right'=>'}'
948         ),
949         array(
950             'left'=>'<',
951             'right'=>'>'
952         )
953     );
954     $cannotEndWith=array('.','?',',','#');
955     $original_url=$url;
956     do{
957         $original_url=$url;
958         foreach($groupSymbolSets as $groupSymbolSet){
959             if(substr($url,-1)==$groupSymbolSet['right']){
960                 $group_left_count = substr_count($url,$groupSymbolSet['left']);
961                 $group_right_count = substr_count($url,$groupSymbolSet['right']);
962                 if($group_left_count<$group_right_count){
963                     $right-=1;
964                     $url=substr($url,0,-1);
965                 }
966             }
967         }
968         if(in_array(substr($url,-1),$cannotEndWith)){
969             $right-=1;
970             $url=substr($url,0,-1);
971         }
972     }while($original_url!=$url);
973
974     $result = call_user_func_array($callback, array($url, $arg));
975     return substr($matches[0],0,$left) . $result . substr($matches[0],$right);
976 }
977
978 require_once INSTALLDIR . "/lib/curry.php";
979
980 function common_linkify($url) {
981     // It comes in special'd, so we unspecial it before passing to the stringifying
982     // functions
983     $url = htmlspecialchars_decode($url);
984
985     if (strpos($url, '@') !== false && strpos($url, ':') === false && Validate::email($url)) {
986         //url is an email address without the mailto: protocol
987         $canon = "mailto:$url";
988         $longurl = "mailto:$url";
989     } else {
990         $canon = File_redirection::_canonUrl($url);
991         $longurl_data = File_redirection::where($canon, common_config('attachments', 'process_links'));
992         $longurl = $longurl_data->url;
993     }
994
995     $attrs = array('href' => $canon, 'title' => $longurl);
996
997     $is_attachment = false;
998     $attachment_id = null;
999     $has_thumb = false;
1000
1001     // Check to see whether this is a known "attachment" URL.
1002
1003     $f = File::getKV('url', $longurl);
1004
1005     if (!$f instanceof File) {
1006         if (common_config('attachments', 'process_links')) {
1007             // XXX: this writes to the database. :<
1008             try {
1009                 $f = File::processNew($longurl);
1010             } catch (ServerException $e) {
1011                 $f = null;
1012             }
1013         }
1014     }
1015
1016     if ($f instanceof File) {
1017         try {
1018             $enclosure = $f->getEnclosure();
1019             $is_attachment = true;
1020             $attachment_id = $f->id;
1021
1022             $thumb = File_thumbnail::getKV('file_id', $f->id);
1023             $has_thumb = ($thumb instanceof File_thumbnail);
1024         } catch (ServerException $e) {
1025             // There was not enough metadata available
1026         }
1027     }
1028
1029     // Add clippy
1030     if ($is_attachment) {
1031         $attrs['class'] = 'attachment';
1032         if ($has_thumb) {
1033             $attrs['class'] = 'attachment thumbnail';
1034         }
1035         $attrs['id'] = "attachment-{$attachment_id}";
1036     }
1037
1038     // Whether to nofollow
1039
1040     $nf = common_config('nofollow', 'external');
1041
1042     if ($nf == 'never') {
1043         $attrs['rel'] = 'external';
1044     } else {
1045         $attrs['rel'] = 'nofollow external';
1046     }
1047
1048     return XMLStringer::estring('a', $attrs, $url);
1049 }
1050
1051 /**
1052  * Find and shorten links in a given chunk of text if it's longer than the
1053  * configured notice content limit (or unconditionally).
1054  *
1055  * Side effects: may save file and file_redirection records for referenced URLs.
1056  *
1057  * Pass the $user option or call $user->shortenLinks($text) to ensure the proper
1058  * user's options are used; otherwise the current web session user's setitngs
1059  * will be used or ur1.ca if there is no active web login.
1060  *
1061  * @param string $text
1062  * @param boolean $always (optional)
1063  * @param User $user (optional)
1064  *
1065  * @return string
1066  */
1067 function common_shorten_links($text, $always = false, User $user=null)
1068 {
1069     if ($user === null) {
1070         $user = common_current_user();
1071     }
1072
1073     $maxLength = User_urlshortener_prefs::maxNoticeLength($user);
1074
1075     if ($always || ($maxLength != -1 && mb_strlen($text) > $maxLength)) {
1076         return common_replace_urls_callback($text, array('File_redirection', 'forceShort'), $user);
1077     } else {
1078         return common_replace_urls_callback($text, array('File_redirection', 'makeShort'), $user);
1079     }
1080 }
1081
1082 /**
1083  * Very basic stripping of invalid UTF-8 input text.
1084  *
1085  * @param string $str
1086  * @return mixed string or null if invalid input
1087  *
1088  * @todo ideally we should drop bad chars, and maybe do some of the checks
1089  *       from common_xml_safe_str. But we can't strip newlines, etc.
1090  * @todo Unicode normalization might also be useful, but not needed now.
1091  */
1092 function common_validate_utf8($str)
1093 {
1094     // preg_replace will return NULL on invalid UTF-8 input.
1095     //
1096     // Note: empty regex //u also caused NULL return on some
1097     // production machines, but none of our test machines.
1098     //
1099     // This should be replaced with a more reliable check.
1100     return preg_replace('/\x00/u', '', $str);
1101 }
1102
1103 /**
1104  * Make sure an arbitrary string is safe for output in XML as a single line.
1105  *
1106  * @param string $str
1107  * @return string
1108  */
1109 function common_xml_safe_str($str)
1110 {
1111     // Replace common eol and extra whitespace input chars
1112     $unWelcome = array(
1113         "\t",  // tab
1114         "\n",  // newline
1115         "\r",  // cr
1116         "\0",  // null byte eos
1117         "\x0B" // vertical tab
1118     );
1119
1120     $replacement = array(
1121         ' ', // single space
1122         ' ',
1123         '',  // nothing
1124         '',
1125         ' '
1126     );
1127
1128     $str = str_replace($unWelcome, $replacement, $str);
1129
1130     // Neutralize any additional control codes and UTF-16 surrogates
1131     // (Twitter uses '*')
1132     return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
1133 }
1134
1135 function common_slugify($str)
1136 {
1137     // php5-intl is highly recommended...
1138     if (!function_exists('transliterator_transliterate')) {
1139         $str = preg_replace('/[^\pL\pN]/u', '', $str);
1140         $str = mb_convert_case($str, MB_CASE_LOWER, 'UTF-8');
1141         $str = substr($str, 0, 64);
1142         return $str;
1143     }
1144     $str = transliterator_transliterate(
1145                         'Any-Latin;' .      // any charset to latin compatible
1146                             'NFD;' .        // decompose
1147                             '[:Nonspacing Mark:] Remove;' . // remove nonspacing marks (accents etc.)
1148                             'NFC;' .        // composite again
1149                             '[:Punctuation:] Remove;' . // remove punctuation (.,¿? etc.)
1150                             'Lower();' .    // turn into lowercase
1151                             'Latin-ASCII;',  // get ASCII equivalents (ð to d for example)
1152                         $str);
1153     return preg_replace('/[^\pL\pN]/', '', $str);
1154 }
1155
1156 function common_tag_link($tag)
1157 {
1158     $canonical = common_canonical_tag($tag);
1159     if (common_config('singleuser', 'enabled')) {
1160         // regular TagAction isn't set up in 1user mode
1161         $nickname = User::singleUserNickname();
1162         $url = common_local_url('showstream',
1163                                 array('nickname' => $nickname,
1164                                       'tag' => $canonical));
1165     } else {
1166         $url = common_local_url('tag', array('tag' => $canonical));
1167     }
1168     $xs = new XMLStringer();
1169     $xs->elementStart('span', 'tag');
1170     $xs->element('a', array('href' => $url,
1171                             'rel' => 'tag'),
1172                  $tag);
1173     $xs->elementEnd('span');
1174     return $xs->getString();
1175 }
1176
1177 function common_canonical_tag($tag)
1178 {
1179     $tag = common_slugify($tag);
1180     $tag = substr($tag, 0, 64);
1181     return $tag;
1182 }
1183
1184 function common_valid_profile_tag($str)
1185 {
1186     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
1187 }
1188
1189 /**
1190  * Resolve an ambiguous profile nickname reference, checking in following order:
1191  * - profiles that $sender subscribes to
1192  * - profiles that subscribe to $sender
1193  * - local user profiles
1194  *
1195  * WARNING: does not validate or normalize $nickname -- MUST BE PRE-VALIDATED
1196  * OR THERE MAY BE A RISK OF SQL INJECTION ATTACKS. THIS FUNCTION DOES NOT
1197  * ESCAPE SQL.
1198  *
1199  * @fixme validate input
1200  * @fixme escape SQL
1201  * @fixme fix or remove mystery third parameter
1202  * @fixme is $sender a User or Profile?
1203  *
1204  * @param <type> $sender the user or profile in whose context we're looking
1205  * @param string $nickname validated nickname of
1206  * @param <type> $dt unused mystery parameter; in Notice reply-to handling a timestamp is passed.
1207  *
1208  * @return Profile or null
1209  */
1210 function common_relative_profile($sender, $nickname, $dt=null)
1211 {
1212     // Will throw exception on invalid input.
1213     $nickname = Nickname::normalize($nickname);
1214
1215     // Try to find profiles this profile is subscribed to that have this nickname
1216     $recipient = new Profile();
1217     // XXX: use a join instead of a subquery
1218     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.intval($sender->id).' and subscribed = id)', 'AND');
1219     $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1220     if ($recipient->find(true)) {
1221         // XXX: should probably differentiate between profiles with
1222         // the same name by date of most recent update
1223         return $recipient;
1224     }
1225     // Try to find profiles that listen to this profile and that have this nickname
1226     $recipient = new Profile();
1227     // XXX: use a join instead of a subquery
1228     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.intval($sender->id).' and subscriber = id)', 'AND');
1229     $recipient->whereAdd("nickname = '" . $recipient->escape($nickname) . "'", 'AND');
1230     if ($recipient->find(true)) {
1231         // XXX: should probably differentiate between profiles with
1232         // the same name by date of most recent update
1233         return $recipient;
1234     }
1235     // If this is a local user, try to find a local user with that nickname.
1236     $sender = User::getKV('id', $sender->id);
1237     if ($sender instanceof User) {
1238         $recipient_user = User::getKV('nickname', $nickname);
1239         if ($recipient_user instanceof User) {
1240             return $recipient_user->getProfile();
1241         }
1242     }
1243     // Otherwise, no links. @messages from local users to remote users,
1244     // or from remote users to other remote users, are just
1245     // outside our ability to make intelligent guesses about
1246     return null;
1247 }
1248
1249 function common_local_url($action, $args=null, $params=null, $fragment=null, $addSession=true)
1250 {
1251     if (Event::handle('StartLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url))) {
1252         $r = Router::get();
1253         $path = $r->build($action, $args, $params, $fragment);
1254
1255         $ssl = common_config('site', 'ssl') === 'always'
1256                 || GNUsocial::isHTTPS()
1257                 || common_is_sensitive($action);
1258
1259         if (common_config('site','fancy')) {
1260             $url = common_path($path, $ssl, $addSession);
1261         } else {
1262             if (mb_strpos($path, '/index.php') === 0) {
1263                 $url = common_path($path, $ssl, $addSession);
1264             } else {
1265                 $url = common_path('index.php/'.$path, $ssl, $addSession);
1266             }
1267         }
1268         Event::handle('EndLocalURL', array(&$action, &$params, &$fragment, &$addSession, &$url));
1269     }
1270     return $url;
1271 }
1272
1273 function common_is_sensitive($action)
1274 {
1275     static $sensitive = array(
1276         'login',
1277         'register',
1278         'passwordsettings',
1279         'api',
1280         'ApiOAuthRequestToken',
1281         'ApiOAuthAccessToken',
1282         'ApiOAuthAuthorize',
1283         'ApiOAuthPin',
1284         'showapplication'
1285     );
1286     $ssl = null;
1287
1288     if (Event::handle('SensitiveAction', array($action, &$ssl))) {
1289         $ssl = in_array($action, $sensitive);
1290     }
1291
1292     return $ssl;
1293 }
1294
1295 function common_path($relative, $ssl=false, $addSession=true)
1296 {
1297     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
1298
1299     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
1300         || GNUsocial::isHTTPS()
1301         || common_config('site', 'ssl') === 'always') {
1302         $proto = 'https';
1303         if (is_string(common_config('site', 'sslserver')) &&
1304             mb_strlen(common_config('site', 'sslserver')) > 0) {
1305             $serverpart = common_config('site', 'sslserver');
1306         } else if (common_config('site', 'server')) {
1307             $serverpart = common_config('site', 'server');
1308         } else {
1309             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1310         }
1311     } else {
1312         $proto = 'http';
1313         if (common_config('site', 'server')) {
1314             $serverpart = common_config('site', 'server');
1315         } else {
1316             common_log(LOG_ERR, 'Site server not configured, unable to determine site name.');
1317         }
1318     }
1319
1320     if ($addSession) {
1321         $relative = common_inject_session($relative, $serverpart);
1322     }
1323
1324     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
1325 }
1326
1327 function common_inject_session($url, $serverpart = null)
1328 {
1329     if (!common_have_session()) {
1330         return $url;
1331     }
1332
1333     if (empty($serverpart)) {
1334         $serverpart = parse_url($url, PHP_URL_HOST);
1335     }
1336
1337     $currentServer = (array_key_exists('HTTP_HOST', $_SERVER)) ? $_SERVER['HTTP_HOST'] : null;
1338
1339     // Are we pointing to another server (like an SSL server?)
1340
1341     if (!empty($currentServer) && 0 != strcasecmp($currentServer, $serverpart)) {
1342         // Pass the session ID as a GET parameter
1343         $sesspart = session_name() . '=' . session_id();
1344         $i = strpos($url, '?');
1345         if ($i === false) { // no GET params, just append
1346             $url .= '?' . $sesspart;
1347         } else {
1348             $url = substr($url, 0, $i + 1).$sesspart.'&'.substr($url, $i + 1);
1349         }
1350     }
1351
1352     return $url;
1353 }
1354
1355 function common_date_string($dt)
1356 {
1357     // XXX: do some sexy date formatting
1358     // return date(DATE_RFC822, $dt);
1359     $t = strtotime($dt);
1360     $now = time();
1361     $diff = $now - $t;
1362
1363     if ($now < $t) { // that shouldn't happen!
1364         return common_exact_date($dt);
1365     } else if ($diff < 60) {
1366         // TRANS: Used in notices to indicate when the notice was made compared to now.
1367         return _('a few seconds ago');
1368     } else if ($diff < 92) {
1369         // TRANS: Used in notices to indicate when the notice was made compared to now.
1370         return _('about a minute ago');
1371     } else if ($diff < 3300) {
1372         $minutes = round($diff/60);
1373         // TRANS: Used in notices to indicate when the notice was made compared to now.
1374         return sprintf( _m('about one minute ago', 'about %d minutes ago', $minutes), $minutes);
1375     } else if ($diff < 5400) {
1376         // TRANS: Used in notices to indicate when the notice was made compared to now.
1377         return _('about an hour ago');
1378     } else if ($diff < 22 * 3600) {
1379         $hours = round($diff/3600);
1380         // TRANS: Used in notices to indicate when the notice was made compared to now.
1381         return sprintf( _m('about one hour ago', 'about %d hours ago', $hours), $hours);
1382     } else if ($diff < 37 * 3600) {
1383         // TRANS: Used in notices to indicate when the notice was made compared to now.
1384         return _('about a day ago');
1385     } else if ($diff < 24 * 24 * 3600) {
1386         $days = round($diff/(24*3600));
1387         // TRANS: Used in notices to indicate when the notice was made compared to now.
1388         return sprintf( _m('about one day ago', 'about %d days ago', $days), $days);
1389     } else if ($diff < 46 * 24 * 3600) {
1390         // TRANS: Used in notices to indicate when the notice was made compared to now.
1391         return _('about a month ago');
1392     } else if ($diff < 330 * 24 * 3600) {
1393         $months = round($diff/(30*24*3600));
1394         // TRANS: Used in notices to indicate when the notice was made compared to now.
1395         return sprintf( _m('about one month ago', 'about %d months ago',$months), $months);
1396     } else if ($diff < 480 * 24 * 3600) {
1397         // TRANS: Used in notices to indicate when the notice was made compared to now.
1398         return _('about a year ago');
1399     } else {
1400         return common_exact_date($dt);
1401     }
1402 }
1403
1404 function common_exact_date($dt)
1405 {
1406     static $_utc;
1407     static $_siteTz;
1408
1409     if (!$_utc) {
1410         $_utc = new DateTimeZone('UTC');
1411         $_siteTz = new DateTimeZone(common_timezone());
1412     }
1413
1414     $dateStr = date('d F Y H:i:s', strtotime($dt));
1415     $d = new DateTime($dateStr, $_utc);
1416     $d->setTimezone($_siteTz);
1417     // TRANS: Human-readable full date-time specification (formatting on http://php.net/date)
1418     return $d->format(_('l, d-M-Y H:i:s T'));
1419 }
1420
1421 function common_date_w3dtf($dt)
1422 {
1423     $dateStr = date('d F Y H:i:s', strtotime($dt));
1424     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1425     $d->setTimezone(new DateTimeZone(common_timezone()));
1426     return $d->format(DATE_W3C);
1427 }
1428
1429 function common_date_rfc2822($dt)
1430 {
1431     $dateStr = date('d F Y H:i:s', strtotime($dt));
1432     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1433     $d->setTimezone(new DateTimeZone(common_timezone()));
1434     return $d->format('r');
1435 }
1436
1437 function common_date_iso8601($dt)
1438 {
1439     $dateStr = date('d F Y H:i:s', strtotime($dt));
1440     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1441     $d->setTimezone(new DateTimeZone(common_timezone()));
1442     return $d->format('c');
1443 }
1444
1445 function common_sql_now()
1446 {
1447     return common_sql_date(time());
1448 }
1449
1450 function common_sql_date($datetime)
1451 {
1452     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
1453 }
1454
1455 /**
1456  * Return an SQL fragment to calculate an age-based weight from a given
1457  * timestamp or datetime column.
1458  *
1459  * @param string $column name of field we're comparing against current time
1460  * @param integer $dropoff divisor for age in seconds before exponentiation
1461  * @return string SQL fragment
1462  */
1463 function common_sql_weight($column, $dropoff)
1464 {
1465     if (common_config('db', 'type') == 'pgsql') {
1466         // PostgreSQL doesn't support timestampdiff function.
1467         // @fixme will this use the right time zone?
1468         // @fixme does this handle cross-year subtraction correctly?
1469         return "sum(exp(-extract(epoch from (now() - $column)) / $dropoff))";
1470     } else {
1471         return "sum(exp(timestampdiff(second, utc_timestamp(), $column) / $dropoff))";
1472     }
1473 }
1474
1475 function common_redirect($url, $code=307)
1476 {
1477     static $status = array(301 => "Moved Permanently",
1478                            302 => "Found",
1479                            303 => "See Other",
1480                            307 => "Temporary Redirect");
1481
1482     header('HTTP/1.1 '.$code.' '.$status[$code]);
1483     header("Location: $url");
1484     header("Connection: close");
1485
1486     $xo = new XMLOutputter();
1487     $xo->startXML('a',
1488                   '-//W3C//DTD XHTML 1.0 Strict//EN',
1489                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1490     $xo->element('a', array('href' => $url), $url);
1491     $xo->endXML();
1492     exit;
1493 }
1494
1495 // Stick the notice on the queue
1496
1497 function common_enqueue_notice($notice)
1498 {
1499     static $localTransports = array('ping');
1500
1501     $transports = array();
1502     if (common_config('sms', 'enabled')) {
1503         $transports[] = 'sms';
1504     }
1505     if (Event::hasHandler('HandleQueuedNotice')) {
1506         $transports[] = 'plugin';
1507     }
1508
1509     // We can skip these for gatewayed notices.
1510     if ($notice->isLocal()) {
1511         $transports = array_merge($transports, $localTransports);
1512     }
1513
1514     if (Event::handle('StartEnqueueNotice', array($notice, &$transports))) {
1515
1516         $qm = QueueManager::get();
1517
1518         foreach ($transports as $transport)
1519         {
1520             $qm->enqueue($notice, $transport);
1521         }
1522
1523         Event::handle('EndEnqueueNotice', array($notice, $transports));
1524     }
1525
1526     return true;
1527 }
1528
1529 function common_profile_url($nickname)
1530 {
1531     return common_local_url('showstream', array('nickname' => $nickname),
1532                             null, null, false);
1533 }
1534
1535 /**
1536  * Should make up a reasonable root URL
1537  */
1538 function common_root_url($ssl=false)
1539 {
1540     $url = common_path('', $ssl, false);
1541     $i = strpos($url, '?');
1542     if ($i !== false) {
1543         $url = substr($url, 0, $i);
1544     }
1545     return $url;
1546 }
1547
1548 /**
1549  * returns $bytes bytes of raw random data
1550  */
1551 function common_random_rawstr($bytes)
1552 {
1553     $rawstr = @file_exists('/dev/urandom')
1554             ? common_urandom($bytes)
1555             : common_mtrand($bytes);
1556
1557     return $rawstr;
1558 }
1559
1560 /**
1561  * returns $bytes bytes of random data as a hexadecimal string
1562  */
1563 function common_random_hexstr($bytes)
1564 {
1565     $str = common_random_rawstr($bytes);
1566
1567     $hexstr = '';
1568     for ($i = 0; $i < $bytes; $i++) {
1569         $hexstr .= sprintf("%02x", ord($str[$i]));
1570     }
1571     return $hexstr;
1572 }
1573
1574 function common_urandom($bytes)
1575 {
1576     $h = fopen('/dev/urandom', 'rb');
1577     // should not block
1578     $src = fread($h, $bytes);
1579     fclose($h);
1580     return $src;
1581 }
1582
1583 function common_mtrand($bytes)
1584 {
1585     $str = '';
1586     for ($i = 0; $i < $bytes; $i++) {
1587         $str .= chr(mt_rand(0, 255));
1588     }
1589     return $str;
1590 }
1591
1592 /**
1593  * Record the given URL as the return destination for a future
1594  * form submission, to be read by common_get_returnto().
1595  *
1596  * @param string $url
1597  *
1598  * @fixme as a session-global setting, this can allow multiple forms
1599  * to conflict and overwrite each others' returnto destinations if
1600  * the user has multiple tabs or windows open.
1601  *
1602  * Should refactor to index with a token or otherwise only pass the
1603  * data along its intended path.
1604  */
1605 function common_set_returnto($url)
1606 {
1607     common_ensure_session();
1608     $_SESSION['returnto'] = $url;
1609 }
1610
1611 /**
1612  * Fetch a return-destination URL previously recorded by
1613  * common_set_returnto().
1614  *
1615  * @return mixed URL string or null
1616  *
1617  * @fixme as a session-global setting, this can allow multiple forms
1618  * to conflict and overwrite each others' returnto destinations if
1619  * the user has multiple tabs or windows open.
1620  *
1621  * Should refactor to index with a token or otherwise only pass the
1622  * data along its intended path.
1623  */
1624 function common_get_returnto()
1625 {
1626     common_ensure_session();
1627     return (array_key_exists('returnto', $_SESSION)) ? $_SESSION['returnto'] : null;
1628 }
1629
1630 function common_timestamp()
1631 {
1632     return date('YmdHis');
1633 }
1634
1635 function common_ensure_syslog()
1636 {
1637     static $initialized = false;
1638     if (!$initialized) {
1639         openlog(common_config('syslog', 'appname'), 0,
1640             common_config('syslog', 'facility'));
1641         $initialized = true;
1642     }
1643 }
1644
1645 function common_log_line($priority, $msg)
1646 {
1647     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1648                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1649     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . PHP_EOL;
1650 }
1651
1652 function common_request_id()
1653 {
1654     $pid = getmypid();
1655     $server = common_config('site', 'server');
1656     if (php_sapi_name() == 'cli') {
1657         $script = basename($_SERVER['PHP_SELF']);
1658         return "$server:$script:$pid";
1659     } else {
1660         static $req_id = null;
1661         if (!isset($req_id)) {
1662             $req_id = substr(md5(mt_rand()), 0, 8);
1663         }
1664         if (isset($_SERVER['REQUEST_URI'])) {
1665             $url = $_SERVER['REQUEST_URI'];
1666         }
1667         $method = $_SERVER['REQUEST_METHOD'];
1668         return "$server:$pid.$req_id $method $url";
1669     }
1670 }
1671
1672 function common_log($priority, $msg, $filename=null)
1673 {
1674     if(Event::handle('StartLog', array(&$priority, &$msg, &$filename))){
1675         $msg = (empty($filename)) ? $msg : basename($filename) . ' - ' . $msg;
1676         $msg = '[' . common_request_id() . '] ' . $msg;
1677         $logfile = common_config('site', 'logfile');
1678         if ($logfile) {
1679             $log = fopen($logfile, "a");
1680             if ($log) {
1681                 $output = common_log_line($priority, $msg);
1682                 fwrite($log, $output);
1683                 fclose($log);
1684             }
1685         } else {
1686             common_ensure_syslog();
1687             syslog($priority, $msg);
1688         }
1689         Event::handle('EndLog', array($priority, $msg, $filename));
1690     }
1691 }
1692
1693 function common_debug($msg, $filename=null)
1694 {
1695     if ($filename) {
1696         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1697     } else {
1698         common_log(LOG_DEBUG, $msg);
1699     }
1700 }
1701
1702 function common_log_db_error(&$object, $verb, $filename=null)
1703 {
1704     global $_PEAR;
1705
1706     $objstr = common_log_objstring($object);
1707     $last_error = &$_PEAR->getStaticProperty('DB_DataObject','lastError');
1708     if (is_object($last_error)) {
1709         $msg = $last_error->message;
1710     } else {
1711         $msg = 'Unknown error (' . var_export($last_error, true) . ')';
1712     }
1713     common_log(LOG_ERR, $msg . '(' . $verb . ' on ' . $objstr . ')', $filename);
1714 }
1715
1716 function common_log_objstring(&$object)
1717 {
1718     if (is_null($object)) {
1719         return "null";
1720     }
1721     if (!($object instanceof DB_DataObject)) {
1722         return "(unknown)";
1723     }
1724     $arr = $object->toArray();
1725     $fields = array();
1726     foreach ($arr as $k => $v) {
1727         if (is_object($v)) {
1728             $fields[] = "$k='".get_class($v)."'";
1729         } else {
1730             $fields[] = "$k='$v'";
1731         }
1732     }
1733     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1734     return $objstring;
1735 }
1736
1737 function common_valid_http_url($url, $secure=false)
1738 {
1739     // If $secure is true, only allow https URLs to pass
1740     // (if false, we use '?' in 'https?' to say the 's' is optional)
1741     $regex = $secure ? '/^https$/' : '/^https?$/';
1742     return filter_var($url, FILTER_VALIDATE_URL)
1743             && preg_match($regex, parse_url($url, PHP_URL_SCHEME));
1744 }
1745
1746 function common_valid_tag($tag)
1747 {
1748     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1749         return (Validate::email($matches[1]) ||
1750                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1751     }
1752     return false;
1753 }
1754
1755 /**
1756  * Determine if given domain or address literal is valid
1757  * eg for use in JIDs and URLs. Does not check if the domain
1758  * exists!
1759  *
1760  * @param string $domain
1761  * @return boolean valid or not
1762  */
1763 function common_valid_domain($domain)
1764 {
1765     $octet = "(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9][0-9]|[0-9])";
1766     $ipv4 = "(?:$octet(?:\.$octet){3})";
1767     if (preg_match("/^$ipv4$/u", $domain)) return true;
1768
1769     $group = "(?:[0-9a-f]{1,4})";
1770     $ipv6 = "(?:\[($group(?::$group){0,7})?(::)?($group(?::$group){0,7})?\])"; // http://tools.ietf.org/html/rfc3513#section-2.2
1771
1772     if (preg_match("/^$ipv6$/ui", $domain, $matches)) {
1773         $before = explode(":", $matches[1]);
1774         $zeroes = $matches[2];
1775         $after = explode(":", $matches[3]);
1776         if ($zeroes) {
1777             $min = 0;
1778             $max = 7;
1779         } else {
1780             $min = 1;
1781             $max = 8;
1782         }
1783         $explicit = count($before) + count($after);
1784         if ($explicit < $min || $explicit > $max) {
1785             return false;
1786         }
1787         return true;
1788     }
1789
1790     try {
1791         require_once "Net/IDNA.php";
1792         $idn = Net_IDNA::getInstance();
1793         $domain = $idn->encode($domain);
1794     } catch (Exception $e) {
1795         return false;
1796     }
1797
1798     $subdomain = "(?:[a-z0-9][a-z0-9-]*)"; // @fixme
1799     $fqdn = "(?:$subdomain(?:\.$subdomain)*\.?)";
1800
1801     return preg_match("/^$fqdn$/ui", $domain);
1802 }
1803
1804 /* Following functions are copied from MediaWiki GlobalFunctions.php
1805  * and written by Evan Prodromou. */
1806
1807 function common_accept_to_prefs($accept, $def = '*/*')
1808 {
1809     // No arg means accept anything (per HTTP spec)
1810     if(!$accept) {
1811         return array($def => 1);
1812     }
1813
1814     $prefs = array();
1815
1816     $parts = explode(',', $accept);
1817
1818     foreach($parts as $part) {
1819         // FIXME: doesn't deal with params like 'text/html; level=1'
1820         @list($value, $qpart) = explode(';', trim($part));
1821         $match = array();
1822         if(!isset($qpart)) {
1823             $prefs[$value] = 1;
1824         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1825             $prefs[$value] = $match[1];
1826         }
1827     }
1828
1829     return $prefs;
1830 }
1831
1832 // Match by our supported file extensions
1833 function common_supported_ext_to_mime($fileext)
1834 {
1835     // Accept a filename and take out the extension
1836     if (strpos($fileext, '.') !== false) {
1837         $fileext = substr(strrchr($fileext, '.'), 1);
1838     }
1839
1840     $supported = common_config('attachments', 'supported');
1841     foreach($supported as $type => $ext) {
1842         if ($ext === $fileext) {
1843             return $type;
1844         }
1845     }
1846
1847     throw new ServerException('Unsupported file extension');
1848 }
1849
1850 // Match by our supported mime types
1851 function common_supported_mime_to_ext($mimetype)
1852 {
1853     $supported = common_config('attachments', 'supported');
1854     foreach($supported as $type => $ext) {
1855         if ($mimetype === $type) {
1856             return $ext;
1857         }
1858     }
1859
1860     throw new ServerException('Unsupported MIME type');
1861 }
1862
1863 // The MIME "media" is the part before the slash (video in video/webm)
1864 function common_get_mime_media($type)
1865 {
1866     $tmp = explode('/', $type);
1867     return strtolower($tmp[0]);
1868 }
1869
1870 // Get only the mimetype and not additional info (separated from bare mime with semi-colon)
1871 function common_bare_mime($mimetype)
1872 {
1873     $mimetype = mb_strtolower($mimetype);
1874     if ($semicolon = mb_strpos($mimetype, ';')) {
1875         $mimetype = mb_substr($mimetype, 0, $semicolon);
1876     }
1877     return $mimetype;
1878 }
1879
1880 function common_mime_type_match($type, $avail)
1881 {
1882     if(array_key_exists($type, $avail)) {
1883         return $type;
1884     } else {
1885         $parts = explode('/', $type);
1886         if(array_key_exists($parts[0] . '/*', $avail)) {
1887             return $parts[0] . '/*';
1888         } elseif(array_key_exists('*/*', $avail)) {
1889             return '*/*';
1890         } else {
1891             return null;
1892         }
1893     }
1894 }
1895
1896 function common_negotiate_type($cprefs, $sprefs)
1897 {
1898     $combine = array();
1899
1900     foreach(array_keys($sprefs) as $type) {
1901         $parts = explode('/', $type);
1902         if($parts[1] != '*') {
1903             $ckey = common_mime_type_match($type, $cprefs);
1904             if($ckey) {
1905                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1906             }
1907         }
1908     }
1909
1910     foreach(array_keys($cprefs) as $type) {
1911         $parts = explode('/', $type);
1912         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1913             $skey = common_mime_type_match($type, $sprefs);
1914             if($skey) {
1915                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1916             }
1917         }
1918     }
1919
1920     $bestq = 0;
1921     $besttype = 'text/html';
1922
1923     foreach(array_keys($combine) as $type) {
1924         if($combine[$type] > $bestq) {
1925             $besttype = $type;
1926             $bestq = $combine[$type];
1927         }
1928     }
1929
1930     if ('text/html' === $besttype) {
1931         return "text/html; charset=utf-8";
1932     }
1933     return $besttype;
1934 }
1935
1936 function common_config($main, $sub=null)
1937 {
1938     global $config;
1939     if (is_null($sub)) {
1940         // Return the config category array
1941         return array_key_exists($main, $config) ? $config[$main] : array();
1942     }
1943     // Return the config value
1944     return (array_key_exists($main, $config) &&
1945             array_key_exists($sub, $config[$main])) ? $config[$main][$sub] : false;
1946 }
1947
1948 function common_config_set($main, $sub, $value)
1949 {
1950     global $config;
1951     if (!array_key_exists($main, $config)) {
1952         $config[$main] = array();
1953     }
1954     $config[$main][$sub] = $value;
1955 }
1956
1957 function common_config_append($main, $sub, $value)
1958 {
1959     global $config;
1960     if (!array_key_exists($main, $config)) {
1961         $config[$main] = array();
1962     }
1963     if (!array_key_exists($sub, $config[$main])) {
1964         $config[$main][$sub] = array();
1965     }
1966     if (!is_array($config[$main][$sub])) {
1967         $config[$main][$sub] = array($config[$main][$sub]);
1968     }
1969     array_push($config[$main][$sub], $value);
1970 }
1971
1972 /**
1973  * Pull arguments from a GET/POST/REQUEST array with first-level input checks:
1974  * strips "magic quotes" slashes if necessary, and kills invalid UTF-8 strings.
1975  *
1976  * @param array $from
1977  * @return array
1978  */
1979 function common_copy_args($from)
1980 {
1981     $to = array();
1982     $strip = get_magic_quotes_gpc();
1983     foreach ($from as $k => $v) {
1984         if(is_array($v)) {
1985             $to[$k] = common_copy_args($v);
1986         } else {
1987             if ($strip) {
1988                 $v = stripslashes($v);
1989             }
1990             $to[$k] = strval(common_validate_utf8($v));
1991         }
1992     }
1993     return $to;
1994 }
1995
1996 /**
1997  * Neutralise the evil effects of magic_quotes_gpc in the current request.
1998  * This is used before handing a request off to OAuthRequest::from_request.
1999  * @fixme Doesn't consider vars other than _POST and _GET?
2000  * @fixme Can't be undone and could corrupt data if run twice.
2001  */
2002 function common_remove_magic_from_request()
2003 {
2004     if(get_magic_quotes_gpc()) {
2005         $_POST=array_map('stripslashes',$_POST);
2006         $_GET=array_map('stripslashes',$_GET);
2007     }
2008 }
2009
2010 function common_user_uri(&$user)
2011 {
2012     return common_local_url('userbyid', array('id' => $user->id),
2013                             null, null, false);
2014 }
2015
2016 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2017
2018 function common_confirmation_code($bits)
2019 {
2020     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
2021     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
2022     $chars = ceil($bits/5);
2023     $code = '';
2024     for ($i = 0; $i < $chars; $i++) {
2025         // XXX: convert to string and back
2026         $num = hexdec(common_random_hexstr(1));
2027         // XXX: randomness is too precious to throw away almost
2028         // 40% of the bits we get!
2029         $code .= $codechars[$num%32];
2030     }
2031     return $code;
2032 }
2033
2034 // convert markup to HTML
2035 function common_markup_to_html($c, $args=null)
2036 {
2037     if ($c === null) {
2038         return '';
2039     }
2040
2041     if (is_null($args)) {
2042         $args = array();
2043     }
2044
2045     // XXX: not very efficient
2046
2047     foreach ($args as $name => $value) {
2048         $c = preg_replace('/%%arg.'.$name.'%%/', $value, $c);
2049     }
2050
2051     $c = preg_replace_callback('/%%user.(\w+)%%/', function ($m) { return common_user_property($m[1]); }, $c);
2052     $c = preg_replace_callback('/%%action.(\w+)%%/', function ($m) { return common_local_url($m[1]); }, $c);
2053     $c = preg_replace_callback('/%%doc.(\w+)%%/', function ($m) { return common_local_url('doc', array('title'=>$m[1])); }, $c);
2054     $c = preg_replace_callback('/%%(\w+).(\w+)%%/', function ($m) { return common_config($m[1], $m[2]); }, $c);
2055
2056     return \Michelf\Markdown::defaultTransform($c);
2057 }
2058
2059 function common_user_property($property)
2060 {
2061     $profile = Profile::current();
2062
2063     if (empty($profile)) {
2064         return null;
2065     }
2066
2067     switch ($property) {
2068     case 'profileurl':
2069     case 'nickname':
2070     case 'fullname':
2071     case 'location':
2072     case 'bio':
2073         return $profile->$property;
2074         break;
2075     case 'avatar':
2076         try {
2077             return $profile->getAvatar(AVATAR_STREAM_SIZE);
2078         } catch (Exception $e) {
2079             return null;
2080         }
2081         break;
2082     case 'bestname':
2083         return $profile->getBestName();
2084         break;
2085     default:
2086         return null;
2087     }
2088 }
2089
2090 function common_profile_uri($profile)
2091 {
2092     $uri = null;
2093
2094     if (!empty($profile)) {
2095         if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) {
2096             $user = User::getKV('id', $profile->id);
2097             if ($user instanceof User) {
2098                 $uri = $user->getUri();
2099             }
2100             Event::handle('EndCommonProfileURI', array($profile, &$uri));
2101         }
2102     }
2103
2104     // XXX: this is a very bad profile!
2105     return $uri;
2106 }
2107
2108 function common_canonical_sms($sms)
2109 {
2110     // strip non-digits
2111     preg_replace('/\D/', '', $sms);
2112     return $sms;
2113 }
2114
2115 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
2116 {
2117     switch ($errno) {
2118
2119      case E_ERROR:
2120      case E_COMPILE_ERROR:
2121      case E_CORE_ERROR:
2122      case E_USER_ERROR:
2123      case E_PARSE:
2124      case E_RECOVERABLE_ERROR:
2125         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
2126         die();
2127         break;
2128
2129      case E_WARNING:
2130      case E_COMPILE_WARNING:
2131      case E_CORE_WARNING:
2132      case E_USER_WARNING:
2133         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
2134         break;
2135
2136      case E_NOTICE:
2137      case E_USER_NOTICE:
2138         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
2139         break;
2140
2141      case E_STRICT:
2142      case E_DEPRECATED:
2143      case E_USER_DEPRECATED:
2144         // XXX: config variable to log this stuff, too
2145         break;
2146
2147      default:
2148         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
2149         die();
2150         break;
2151     }
2152
2153     // FIXME: show error page if we're on the Web
2154     /* Don't execute PHP internal error handler */
2155     return true;
2156 }
2157
2158 function common_session_token()
2159 {
2160     common_ensure_session();
2161     if (!array_key_exists('token', $_SESSION)) {
2162         $_SESSION['token'] = common_random_hexstr(64);
2163     }
2164     return $_SESSION['token'];
2165 }
2166
2167 function common_license_terms($uri)
2168 {
2169     if(preg_match('/creativecommons.org\/licenses\/([^\/]+)/', $uri, $matches)) {
2170         return explode('-',$matches[1]);
2171     }
2172     return array($uri);
2173 }
2174
2175 function common_compatible_license($from, $to)
2176 {
2177     $from_terms = common_license_terms($from);
2178     // public domain and cc-by are compatible with everything
2179     if(count($from_terms) == 1 && ($from_terms[0] == 'publicdomain' || $from_terms[0] == 'by')) {
2180         return true;
2181     }
2182     $to_terms = common_license_terms($to);
2183     // sa is compatible across versions. IANAL
2184     if(in_array('sa',$from_terms) || in_array('sa',$to_terms)) {
2185         return count(array_diff($from_terms, $to_terms)) == 0;
2186     }
2187     // XXX: better compatibility check needed here!
2188     // Should at least normalise URIs
2189     return ($from == $to);
2190 }
2191
2192 /**
2193  * returns a quoted table name, if required according to config
2194  */
2195 function common_database_tablename($tablename)
2196 {
2197   if(common_config('db','quote_identifiers')) {
2198       $tablename = '"'. $tablename .'"';
2199   }
2200   //table prefixes could be added here later
2201   return $tablename;
2202 }
2203
2204 /**
2205  * Shorten a URL with the current user's configured shortening service,
2206  * or ur1.ca if configured, or not at all if no shortening is set up.
2207  *
2208  * @param string  $long_url original URL
2209  * @param User $user to specify a particular user's options
2210  * @param boolean $force    Force shortening (used when notice is too long)
2211  * @return string may return the original URL if shortening failed
2212  *
2213  * @fixme provide a way to specify a particular shortener
2214  */
2215 function common_shorten_url($long_url, User $user=null, $force = false)
2216 {
2217     $long_url = trim($long_url);
2218
2219     $user = common_current_user();
2220
2221     $maxUrlLength = User_urlshortener_prefs::maxUrlLength($user);
2222
2223     // $force forces shortening even if it's not strictly needed
2224     // I doubt URL shortening is ever 'strictly' needed. - ESP
2225
2226     if (($maxUrlLength == -1 || mb_strlen($long_url) < $maxUrlLength) && !$force) {
2227         return $long_url;
2228     }
2229
2230     $shortenerName = User_urlshortener_prefs::urlShorteningService($user);
2231
2232     if (Event::handle('StartShortenUrl',
2233                       array($long_url, $shortenerName, &$shortenedUrl))) {
2234         if ($shortenerName == 'internal') {
2235             try {
2236                 $f = File::processNew($long_url);
2237                 $shortenedUrl = common_local_url('redirecturl', array('id' => $f->id));
2238                 if ((mb_strlen($shortenedUrl) < mb_strlen($long_url)) || $force) {
2239                     return $shortenedUrl;
2240                 } else {
2241                     return $long_url;
2242                 }
2243             } catch (ServerException $e) {
2244                 return $long_url;
2245             }
2246         } else {
2247             return $long_url;
2248         }
2249     } else {
2250         //URL was shortened, so return the result
2251         return trim($shortenedUrl);
2252     }
2253 }
2254
2255 /**
2256  * @return mixed array($proxy, $ip) for web requests; proxy may be null
2257  *               null if not a web request
2258  *
2259  * @fixme X-Forwarded-For can be chained by multiple proxies;
2260           we should parse the list and provide a cleaner array
2261  * @fixme X-Forwarded-For can be forged by clients; only use them if trusted
2262  * @fixme X_Forwarded_For headers will override X-Forwarded-For read through $_SERVER;
2263  *        use function to get exact request headers from Apache if possible.
2264  */
2265 function common_client_ip()
2266 {
2267     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
2268         return null;
2269     }
2270
2271     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
2272         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2273             $proxy = $_SERVER['HTTP_CLIENT_IP'];
2274         } else {
2275             $proxy = $_SERVER['REMOTE_ADDR'];
2276         }
2277         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
2278     } else {
2279         $proxy = null;
2280         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
2281             $ip = $_SERVER['HTTP_CLIENT_IP'];
2282         } else {
2283             $ip = $_SERVER['REMOTE_ADDR'];
2284         }
2285     }
2286
2287     return array($proxy, $ip);
2288 }
2289
2290 function common_url_to_nickname($url)
2291 {
2292     static $bad = array('query', 'user', 'password', 'port', 'fragment');
2293
2294     $parts = parse_url($url);
2295
2296     // If any of these parts exist, this won't work
2297
2298     foreach ($bad as $badpart) {
2299         if (array_key_exists($badpart, $parts)) {
2300             return null;
2301         }
2302     }
2303
2304     // We just have host and/or path
2305
2306     // If it's just a host...
2307     if (array_key_exists('host', $parts) &&
2308         (!array_key_exists('path', $parts) || strcmp($parts['path'], '/') == 0))
2309     {
2310         $hostparts = explode('.', $parts['host']);
2311
2312         // Try to catch common idiom of nickname.service.tld
2313
2314         if ((count($hostparts) > 2) &&
2315             (strlen($hostparts[count($hostparts) - 2]) > 3) && # try to skip .co.uk, .com.au
2316             (strcmp($hostparts[0], 'www') != 0))
2317         {
2318             return common_nicknamize($hostparts[0]);
2319         } else {
2320             // Do the whole hostname
2321             return common_nicknamize($parts['host']);
2322         }
2323     } else {
2324         if (array_key_exists('path', $parts)) {
2325             // Strip starting, ending slashes
2326             $path = preg_replace('@/$@', '', $parts['path']);
2327             $path = preg_replace('@^/@', '', $path);
2328             $path = basename($path);
2329
2330             // Hack for MediaWiki user pages, in the form:
2331             // http://example.com/wiki/User:Myname
2332             // ('User' may be localized.)
2333             if (strpos($path, ':')) {
2334                 $parts = array_filter(explode(':', $path));
2335                 $path = $parts[count($parts) - 1];
2336             }
2337
2338             if ($path) {
2339                 return common_nicknamize($path);
2340             }
2341         }
2342     }
2343
2344     return null;
2345 }
2346
2347 function common_nicknamize($str)
2348 {
2349     try {
2350         return Nickname::normalize($str);
2351     } catch (NicknameException $e) {
2352         return null;
2353     }
2354 }
2355
2356 function common_perf_counter($key, $val=null)
2357 {
2358     global $_perfCounters;
2359     if (isset($_perfCounters)) {
2360         if (common_config('site', 'logperf')) {
2361             if (array_key_exists($key, $_perfCounters)) {
2362                 $_perfCounters[$key][] = $val;
2363             } else {
2364                 $_perfCounters[$key] = array($val);
2365             }
2366             if (common_config('site', 'logperf_detail')) {
2367                 common_log(LOG_DEBUG, "PERF COUNTER HIT: $key $val");
2368             }
2369         }
2370     }
2371 }
2372
2373 function common_log_perf_counters()
2374 {
2375     if (common_config('site', 'logperf')) {
2376         global $_startTime, $_perfCounters;
2377
2378         if (isset($_startTime)) {
2379             $endTime = microtime(true);
2380             $diff = round(($endTime - $_startTime) * 1000);
2381             common_log(LOG_DEBUG, "PERF runtime: ${diff}ms");
2382         }
2383         $counters = $_perfCounters;
2384         ksort($counters);
2385         foreach ($counters as $key => $values) {
2386             $count = count($values);
2387             $unique = count(array_unique($values));
2388             common_log(LOG_DEBUG, "PERF COUNTER: $key $count ($unique unique)");
2389         }
2390     }
2391 }
2392
2393 function common_is_email($str)
2394 {
2395     return (strpos($str, '@') !== false);
2396 }
2397
2398 function common_init_stats()
2399 {
2400     global $_mem, $_ts;
2401
2402     $_mem = memory_get_usage(true);
2403     $_ts  = microtime(true);
2404 }
2405
2406 function common_log_delta($comment=null)
2407 {
2408     global $_mem, $_ts;
2409
2410     $mold = $_mem;
2411     $told = $_ts;
2412
2413     $_mem = memory_get_usage(true);
2414     $_ts  = microtime(true);
2415
2416     $mtotal = $_mem - $mold;
2417     $ttotal = $_ts - $told;
2418
2419     if (empty($comment)) {
2420         $comment = 'Delta';
2421     }
2422
2423     common_debug(sprintf("%s: %d %d", $comment, $mtotal, round($ttotal * 1000000)));
2424 }
2425
2426 function common_strip_html($html, $trim=true, $save_whitespace=false)
2427 {
2428     if (!$save_whitespace) {
2429         $html = preg_replace('/\s+/', ' ', $html);
2430     }
2431     $text = html_entity_decode(strip_tags($html), ENT_QUOTES, 'UTF-8');
2432     return $trim ? trim($text) : $text;
2433 }
2434
2435 function html_sprintf()
2436 {
2437     $args = func_get_args();
2438     for ($i=1; $i<count($args); $i++) {
2439         $args[$i] = htmlspecialchars($args[$i]);
2440     }
2441     return call_user_func_array('sprintf', $args);
2442 }