]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/util.php
URLs surrounded by (),{}, and [] are correctly handled now!
[quix0rs-gnu-social.git] / lib / util.php
1 <?php
2 /*
3  * Laconica - a distributed open-source microblogging tool
4  * Copyright (C) 2008, 2009, Control Yourself, 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 // Show a server error
23
24 function common_server_error($msg, $code=500)
25 {
26     $err = new ServerErrorAction($msg, $code);
27     $err->showPage();
28 }
29
30 // Show a user error
31 function common_user_error($msg, $code=400)
32 {
33     $err = new ClientErrorAction($msg, $code);
34     $err->showPage();
35 }
36
37 function common_init_locale($language=null)
38 {
39     if(!$language) {
40         $language = common_language();
41     }
42     putenv('LANGUAGE='.$language);
43     putenv('LANG='.$language);
44     return setlocale(LC_ALL, $language . ".utf8",
45                      $language . ".UTF8",
46                      $language . ".utf-8",
47                      $language . ".UTF-8",
48                      $language);
49 }
50
51 function common_init_language()
52 {
53     mb_internal_encoding('UTF-8');
54     $language = common_language();
55     // So we don't have to make people install the gettext locales
56     $locale_set = common_init_locale($language);
57     bindtextdomain("laconica", common_config('site','locale_path'));
58     bind_textdomain_codeset("laconica", "UTF-8");
59     textdomain("laconica");
60     setlocale(LC_CTYPE, 'C');
61     if(!$locale_set) {
62         common_log(LOG_INFO,'Language requested:'.$language.' - locale could not be set:',__FILE__);
63     }
64 }
65
66 function common_timezone()
67 {
68     if (common_logged_in()) {
69         $user = common_current_user();
70         if ($user->timezone) {
71             return $user->timezone;
72         }
73     }
74
75     return common_config('site', 'timezone');
76 }
77
78 function common_language()
79 {
80
81     // If there is a user logged in and they've set a language preference
82     // then return that one...
83     if (_have_config() && common_logged_in()) {
84         $user = common_current_user();
85         $user_language = $user->language;
86         if ($user_language)
87           return $user_language;
88     }
89
90     // Otherwise, find the best match for the languages requested by the
91     // user's browser...
92     $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
93     if (!empty($httplang)) {
94         $language = client_prefered_language($httplang);
95         if ($language)
96           return $language;
97     }
98
99     // Finally, if none of the above worked, use the site's default...
100     return common_config('site', 'language');
101 }
102 // salted, hashed passwords are stored in the DB
103
104 function common_munge_password($password, $id)
105 {
106     return md5($password . $id);
107 }
108
109 // check if a username exists and has matching password
110 function common_check_user($nickname, $password)
111 {
112     // NEVER allow blank passwords, even if they match the DB
113     if (mb_strlen($password) == 0) {
114         return false;
115     }
116     $user = User::staticGet('nickname', $nickname);
117     if (is_null($user) || $user === false) {
118         return false;
119     } else {
120         if (0 == strcmp(common_munge_password($password, $user->id),
121                         $user->password)) {
122             return $user;
123         } else {
124             return false;
125         }
126     }
127 }
128
129 // is the current user logged in?
130 function common_logged_in()
131 {
132     return (!is_null(common_current_user()));
133 }
134
135 function common_have_session()
136 {
137     return (0 != strcmp(session_id(), ''));
138 }
139
140 function common_ensure_session()
141 {
142     $c = null;
143     if (array_key_exists(session_name(), $_COOKIE)) {
144         $c = $_COOKIE[session_name()];
145     }
146     if (!common_have_session()) {
147         if (common_config('sessions', 'handle')) {
148             Session::setSaveHandler();
149         }
150         @session_start();
151         if (!isset($_SESSION['started'])) {
152             $_SESSION['started'] = time();
153             if (!empty($c)) {
154                 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
155                            ' is set but started value is null');
156             }
157         }
158     }
159 }
160
161 // Three kinds of arguments:
162 // 1) a user object
163 // 2) a nickname
164 // 3) null to clear
165
166 // Initialize to false; set to null if none found
167
168 $_cur = false;
169
170 function common_set_user($user)
171 {
172
173     global $_cur;
174
175     if (is_null($user) && common_have_session()) {
176         $_cur = null;
177         unset($_SESSION['userid']);
178         return true;
179     } else if (is_string($user)) {
180         $nickname = $user;
181         $user = User::staticGet('nickname', $nickname);
182     } else if (!($user instanceof User)) {
183         return false;
184     }
185
186     if ($user) {
187         common_ensure_session();
188         $_SESSION['userid'] = $user->id;
189         $_cur = $user;
190         return $_cur;
191     }
192     return false;
193 }
194
195 function common_set_cookie($key, $value, $expiration=0)
196 {
197     $path = common_config('site', 'path');
198     $server = common_config('site', 'server');
199
200     if ($path && ($path != '/')) {
201         $cookiepath = '/' . $path . '/';
202     } else {
203         $cookiepath = '/';
204     }
205     return setcookie($key,
206                      $value,
207                      $expiration,
208                      $cookiepath,
209                      $server);
210 }
211
212 define('REMEMBERME', 'rememberme');
213 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
214
215 function common_rememberme($user=null)
216 {
217     if (!$user) {
218         $user = common_current_user();
219         if (!$user) {
220             common_debug('No current user to remember', __FILE__);
221             return false;
222         }
223     }
224
225     $rm = new Remember_me();
226
227     $rm->code = common_good_rand(16);
228     $rm->user_id = $user->id;
229
230     // Wrap the insert in some good ol' fashioned transaction code
231
232     $rm->query('BEGIN');
233
234     $result = $rm->insert();
235
236     if (!$result) {
237         common_log_db_error($rm, 'INSERT', __FILE__);
238         common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
239         return false;
240     }
241
242     $rm->query('COMMIT');
243
244     common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
245
246     $cookieval = $rm->user_id . ':' . $rm->code;
247
248     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
249
250     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
251
252     return true;
253 }
254
255 function common_remembered_user()
256 {
257
258     $user = null;
259
260     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
261
262     if (!$packed) {
263         return null;
264     }
265
266     list($id, $code) = explode(':', $packed);
267
268     if (!$id || !$code) {
269         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
270         common_forgetme();
271         return null;
272     }
273
274     $rm = Remember_me::staticGet($code);
275
276     if (!$rm) {
277         common_log(LOG_WARNING, 'No such remember code: ' . $code);
278         common_forgetme();
279         return null;
280     }
281
282     if ($rm->user_id != $id) {
283         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
284         common_forgetme();
285         return null;
286     }
287
288     $user = User::staticGet($rm->user_id);
289
290     if (!$user) {
291         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
292         common_forgetme();
293         return null;
294     }
295
296     // successful!
297     $result = $rm->delete();
298
299     if (!$result) {
300         common_log_db_error($rm, 'DELETE', __FILE__);
301         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
302         common_forgetme();
303         return null;
304     }
305
306     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
307
308     common_set_user($user);
309     common_real_login(false);
310
311     // We issue a new cookie, so they can log in
312     // automatically again after this session
313
314     common_rememberme($user);
315
316     return $user;
317 }
318
319 // must be called with a valid user!
320
321 function common_forgetme()
322 {
323     common_set_cookie(REMEMBERME, '', 0);
324 }
325
326 // who is the current user?
327 function common_current_user()
328 {
329     global $_cur;
330
331     if (!_have_config()) {
332         return null;
333     }
334
335     if ($_cur === false) {
336
337         if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
338             common_ensure_session();
339             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
340             if ($id) {
341                 $_cur = User::staticGet($id);
342                 return $_cur;
343             }
344         }
345
346         // that didn't work; try to remember; will init $_cur to null on failure
347         $_cur = common_remembered_user();
348
349         if ($_cur) {
350             common_debug("Got User " . $_cur->nickname);
351             common_debug("Faking session on remembered user");
352             // XXX: Is this necessary?
353             $_SESSION['userid'] = $_cur->id;
354         }
355     }
356
357     return $_cur;
358 }
359
360 // Logins that are 'remembered' aren't 'real' -- they're subject to
361 // cookie-stealing. So, we don't let them do certain things. New reg,
362 // OpenID, and password logins _are_ real.
363
364 function common_real_login($real=true)
365 {
366     common_ensure_session();
367     $_SESSION['real_login'] = $real;
368 }
369
370 function common_is_real_login()
371 {
372     return common_logged_in() && $_SESSION['real_login'];
373 }
374
375 // get canonical version of nickname for comparison
376 function common_canonical_nickname($nickname)
377 {
378     // XXX: UTF-8 canonicalization (like combining chars)
379     return strtolower($nickname);
380 }
381
382 // get canonical version of email for comparison
383 function common_canonical_email($email)
384 {
385     // XXX: canonicalize UTF-8
386     // XXX: lcase the domain part
387     return $email;
388 }
389
390 function common_render_content($text, $notice)
391 {
392     $r = common_render_text($text);
393     $id = $notice->profile_id;
394     $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
395     $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
396     $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
397     $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
398     return $r;
399 }
400
401 function common_render_text($text)
402 {
403     $r = htmlspecialchars($text);
404
405     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
406     $r = common_replace_urls_callback($r, 'common_linkify');
407     $r = preg_replace('/(^|\(|\[|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
408     // XXX: machine tags
409     return $r;
410 }
411
412 function common_replace_urls_callback($text, $callback, $notice_id = null) {
413     // Start off with a regex
414     $regex = '#'.
415     '(?:^|[\s\(\)\[\]\{\}]+)('.
416         '(?:'. //Known protocols
417             '(?:'.
418                 '(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://'.
419                 '|'.
420                 '(?:mailto|aim|tel|xmpp):'.
421             ')[^\s\(\)\[\]\{\}]+'.
422         ')'.
423         '|(?:(?: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
424         '|(?:'. //IPv6
425             '(?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,6}|'.
426             '(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,5}|'.
427             '(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,4}|'.
428             '(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,3}|'.
429             '(?:[0-9a-f]{1,4}:){1,5}(?::[0-9a-f]{1,4}){1,2}|'.
430             '(?:[0-9a-f]{1,4}:){1,6}(?::[0-9a-f]{1,4}){1,1}|'.
431             '(?:(?:[0-9a-f]{1,4}:){1,7}|:):|'.
432             ':(?::[0-9a-f]{1,4}){1,7}|'.
433             '(?:(?:(?:[0-9a-f]{1,4}:){6})(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3})|'.
434             '(?:(?:[0-9a-f]{1,4}:){5}[0-9a-f]{1,4}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3})|'.
435             '(?:[0-9a-f]{1,4}:){5}:[0-9a-f]{1,4}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
436             '(?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,4}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
437             '(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,3}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
438             '(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,2}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
439             '(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,1}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
440             '(?:(?:[0-9a-f]{1,4}:){1,5}|:):(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
441             ':(?::[0-9a-f]{1,4}){1,5}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}'.
442         ')|(?:'. //DNS
443             '\S+\.(?:museum|travel|onion|local|[a-z]{2,4})'.
444         ')'.
445         '([^\s\(\)\[\]\{\}]*)'.
446     ')'.
447     '#ix';
448     return preg_replace_callback($regex, curry(callback_helper,$callback,$notice_id) ,$text);
449 }
450
451 function callback_helper($matches, $callback, $notice_id) {
452     $pos = strpos($matches[0],$matches[1]);
453     $left = substr($matches[0],0,$pos);
454     $right = substr($matches[0],$pos+strlen($matches[1]));
455     
456     if(empty($notice_id)){
457         $result = call_user_func_array($callback,$matches[1]);
458     }else{
459         $result = call_user_func_array($callback, array($matches[1],$notice_id) );
460     }
461     return $left . $result . $right;
462 }
463
464 function curry($fn) {
465     //TODO switch to a PHP 5.3 function closure based approach if PHP 5.3 is used
466     $args = func_get_args();
467     array_shift($args);
468     $id = uniqid('_partial');
469     $GLOBALS[$id] = array($fn, $args);
470     return create_function(
471         '',
472         '
473         $args = func_get_args();
474         return call_user_func_array(
475         $GLOBALS["'.$id.'"][0],
476         array_merge(
477             $args,
478             $GLOBALS["'.$id.'"][1]));
479     ');
480 }
481
482 function common_linkify($url) {
483     // It comes in special'd, so we unspecial it before passing to the stringifying
484     // functions
485     $url = htmlspecialchars_decode($url);
486
487    if(strpos($url, '@')!==false && strpos($url, ':')===false){
488        //url is an email address without the mailto: protocol
489        return XMLStringer::estring('a', array('href' => "mailto:$url", 'rel' => 'external'), $url);
490    }
491
492     $canon = File_redirection::_canonUrl($url);
493
494     $longurl_data = File_redirection::where($url);
495     if (is_array($longurl_data)) {
496         $longurl = $longurl_data['url'];
497     } elseif (is_string($longurl_data)) {
498         $longurl = $longurl_data;
499     } else {
500         throw new ServerException("Can't linkify url '$url'");
501     }
502
503     $attrs = array('href' => $canon, 'rel' => 'external');
504
505     $is_attachment = false;
506     $attachment_id = null;
507     $has_thumb = false;
508
509     // Check to see whether there's a filename associated with this URL.
510     // If there is, it's an upload and qualifies as an attachment
511
512     $localfile = File::staticGet('url', $longurl);
513
514     if (!empty($localfile)) {
515         if (isset($localfile->filename)) {
516             $is_attachment = true;
517             $attachment_id = $localfile->id;
518         }
519     }
520
521     // if this URL is an attachment, then we set class='attachment' and id='attahcment-ID'
522     // where ID is the id of the attachment for the given URL.
523     //
524     // we need a better test telling what can be shown as an attachment
525     // we're currently picking up oembeds only.
526     // I think the best option is another file_view table in the db
527     // and associated dbobject.
528
529     $query = "select file_oembed.file_id as file_id from file join file_oembed on file.id = file_oembed.file_id where file.url='$longurl'";
530     $file = new File;
531     $file->query($query);
532     $file->fetch();
533
534     if (!empty($file->file_id)) {
535         $is_attachment = true;
536         $attachment_id = $file->file_id;
537
538         $query = "select file_thumbnail.file_id as file_id from file join file_thumbnail on file.id = file_thumbnail.file_id where file.url='$longurl'";
539         $file2 = new File;
540         $file2->query($query);
541         $file2->fetch();
542
543         if (!empty($file2)) {
544             $has_thumb = true;
545         }
546     }
547
548     // Add clippy
549     if ($is_attachment) {
550         $attrs['class'] = 'attachment';
551         if ($has_thumb) {
552             $attrs['class'] = 'attachment thumbnail';
553         }
554         $attrs['id'] = "attachment-{$attachment_id}";
555     }
556
557     return XMLStringer::estring('a', $attrs, $url);
558 }
559
560 function common_shorten_links($text)
561 {
562     if (mb_strlen($text) <= 140) return $text;
563     return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
564 }
565
566 function common_xml_safe_str($str)
567 {
568     // Neutralize control codes and surrogates
569         return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
570 }
571
572 function common_tag_link($tag)
573 {
574     $canonical = common_canonical_tag($tag);
575     $url = common_local_url('tag', array('tag' => $canonical));
576     $xs = new XMLStringer();
577     $xs->elementStart('span', 'tag');
578     $xs->element('a', array('href' => $url,
579                             'rel' => 'tag'),
580                  $tag);
581     $xs->elementEnd('span');
582     return $xs->getString();
583 }
584
585 function common_canonical_tag($tag)
586 {
587   $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
588   return str_replace(array('-', '_', '.'), '', $tag);
589 }
590
591 function common_valid_profile_tag($str)
592 {
593     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
594 }
595
596 function common_at_link($sender_id, $nickname)
597 {
598     $sender = Profile::staticGet($sender_id);
599     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
600     if ($recipient) {
601         $user = User::staticGet('id', $recipient->id);
602         if ($user) {
603             $url = common_local_url('userbyid', array('id' => $user->id));
604         } else {
605             $url = $recipient->profileurl;
606         }
607         $xs = new XMLStringer(false);
608         $attrs = array('href' => $url,
609                        'class' => 'url');
610         if (!empty($recipient->fullname)) {
611             $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
612         }
613         $xs->elementStart('span', 'vcard');
614         $xs->elementStart('a', $attrs);
615         $xs->element('span', 'fn nickname', $nickname);
616         $xs->elementEnd('a');
617         $xs->elementEnd('span');
618         return $xs->getString();
619     } else {
620         return $nickname;
621     }
622 }
623
624 function common_group_link($sender_id, $nickname)
625 {
626     $sender = Profile::staticGet($sender_id);
627     $group = User_group::getForNickname($nickname);
628     if ($group && $sender->isMember($group)) {
629         $attrs = array('href' => $group->permalink(),
630                        'class' => 'url');
631         if (!empty($group->fullname)) {
632             $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
633         }
634         $xs = new XMLStringer();
635         $xs->elementStart('span', 'vcard');
636         $xs->elementStart('a', $attrs);
637         $xs->element('span', 'fn nickname', $nickname);
638         $xs->elementEnd('a');
639         $xs->elementEnd('span');
640         return $xs->getString();
641     } else {
642         return $nickname;
643     }
644 }
645
646 function common_at_hash_link($sender_id, $tag)
647 {
648     $user = User::staticGet($sender_id);
649     if (!$user) {
650         return $tag;
651     }
652     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
653     if ($tagged) {
654         $url = common_local_url('subscriptions',
655                                 array('nickname' => $user->nickname,
656                                       'tag' => $tag));
657         $xs = new XMLStringer();
658         $xs->elementStart('span', 'tag');
659         $xs->element('a', array('href' => $url,
660                                 'rel' => $tag),
661                      $tag);
662         $xs->elementEnd('span');
663         return $xs->getString();
664     } else {
665         return $tag;
666     }
667 }
668
669 function common_relative_profile($sender, $nickname, $dt=null)
670 {
671     // Try to find profiles this profile is subscribed to that have this nickname
672     $recipient = new Profile();
673     // XXX: use a join instead of a subquery
674     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
675     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
676     if ($recipient->find(true)) {
677         // XXX: should probably differentiate between profiles with
678         // the same name by date of most recent update
679         return $recipient;
680     }
681     // Try to find profiles that listen to this profile and that have this nickname
682     $recipient = new Profile();
683     // XXX: use a join instead of a subquery
684     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
685     $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
686     if ($recipient->find(true)) {
687         // XXX: should probably differentiate between profiles with
688         // the same name by date of most recent update
689         return $recipient;
690     }
691     // If this is a local user, try to find a local user with that nickname.
692     $sender = User::staticGet($sender->id);
693     if ($sender) {
694         $recipient_user = User::staticGet('nickname', $nickname);
695         if ($recipient_user) {
696             return $recipient_user->getProfile();
697         }
698     }
699     // Otherwise, no links. @messages from local users to remote users,
700     // or from remote users to other remote users, are just
701     // outside our ability to make intelligent guesses about
702     return null;
703 }
704
705 function common_local_url($action, $args=null, $params=null, $fragment=null)
706 {
707     static $sensitive = array('login', 'register', 'passwordsettings',
708                               'twittersettings', 'finishopenidlogin',
709                               'finishaddopenid', 'api');
710
711     $r = Router::get();
712     $path = $r->build($action, $args, $params, $fragment);
713
714     $ssl = in_array($action, $sensitive);
715
716     if (common_config('site','fancy')) {
717         $url = common_path(mb_substr($path, 1), $ssl);
718     } else {
719         if (mb_strpos($path, '/index.php') === 0) {
720             $url = common_path(mb_substr($path, 1), $ssl);
721         } else {
722             $url = common_path('index.php'.$path, $ssl);
723         }
724     }
725     return $url;
726 }
727
728 function common_path($relative, $ssl=false)
729 {
730     $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
731
732     if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
733         || common_config('site', 'ssl') === 'always') {
734         $proto = 'https';
735         if (is_string(common_config('site', 'sslserver')) &&
736             mb_strlen(common_config('site', 'sslserver')) > 0) {
737             $serverpart = common_config('site', 'sslserver');
738         } else {
739             $serverpart = common_config('site', 'server');
740         }
741     } else {
742         $proto = 'http';
743         $serverpart = common_config('site', 'server');
744     }
745
746     return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
747 }
748
749 function common_date_string($dt)
750 {
751     // XXX: do some sexy date formatting
752     // return date(DATE_RFC822, $dt);
753     $t = strtotime($dt);
754     $now = time();
755     $diff = $now - $t;
756
757     if ($now < $t) { // that shouldn't happen!
758         return common_exact_date($dt);
759     } else if ($diff < 60) {
760         return _('a few seconds ago');
761     } else if ($diff < 92) {
762         return _('about a minute ago');
763     } else if ($diff < 3300) {
764         return sprintf(_('about %d minutes ago'), round($diff/60));
765     } else if ($diff < 5400) {
766         return _('about an hour ago');
767     } else if ($diff < 22 * 3600) {
768         return sprintf(_('about %d hours ago'), round($diff/3600));
769     } else if ($diff < 37 * 3600) {
770         return _('about a day ago');
771     } else if ($diff < 24 * 24 * 3600) {
772         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
773     } else if ($diff < 46 * 24 * 3600) {
774         return _('about a month ago');
775     } else if ($diff < 330 * 24 * 3600) {
776         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
777     } else if ($diff < 480 * 24 * 3600) {
778         return _('about a year ago');
779     } else {
780         return common_exact_date($dt);
781     }
782 }
783
784 function common_exact_date($dt)
785 {
786     static $_utc;
787     static $_siteTz;
788
789     if (!$_utc) {
790         $_utc = new DateTimeZone('UTC');
791         $_siteTz = new DateTimeZone(common_timezone());
792     }
793
794     $dateStr = date('d F Y H:i:s', strtotime($dt));
795     $d = new DateTime($dateStr, $_utc);
796     $d->setTimezone($_siteTz);
797     return $d->format(DATE_RFC850);
798 }
799
800 function common_date_w3dtf($dt)
801 {
802     $dateStr = date('d F Y H:i:s', strtotime($dt));
803     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
804     $d->setTimezone(new DateTimeZone(common_timezone()));
805     return $d->format(DATE_W3C);
806 }
807
808 function common_date_rfc2822($dt)
809 {
810     $dateStr = date('d F Y H:i:s', strtotime($dt));
811     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
812     $d->setTimezone(new DateTimeZone(common_timezone()));
813     return $d->format('r');
814 }
815
816 function common_date_iso8601($dt)
817 {
818     $dateStr = date('d F Y H:i:s', strtotime($dt));
819     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
820     $d->setTimezone(new DateTimeZone(common_timezone()));
821     return $d->format('c');
822 }
823
824 function common_sql_now()
825 {
826     return common_sql_date(time());
827 }
828
829 function common_sql_date($datetime)
830 {
831     return strftime('%Y-%m-%d %H:%M:%S', $datetime);
832 }
833
834 function common_redirect($url, $code=307)
835 {
836     static $status = array(301 => "Moved Permanently",
837                            302 => "Found",
838                            303 => "See Other",
839                            307 => "Temporary Redirect");
840
841     header('HTTP/1.1 '.$code.' '.$status[$code]);
842     header("Location: $url");
843
844     $xo = new XMLOutputter();
845     $xo->startXML('a',
846                   '-//W3C//DTD XHTML 1.0 Strict//EN',
847                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
848     $xo->element('a', array('href' => $url), $url);
849     $xo->endXML();
850     exit;
851 }
852
853 function common_broadcast_notice($notice, $remote=false)
854 {
855     return common_enqueue_notice($notice);
856 }
857
858 // Stick the notice on the queue
859
860 function common_enqueue_notice($notice)
861 {
862     static $localTransports = array('omb',
863                                     'twitter',
864                                     'facebook',
865                                     'ping');
866     static $allTransports = array('sms');
867
868     $transports = $allTransports;
869
870     $xmpp = common_config('xmpp', 'enabled');
871
872     if ($xmpp) {
873         $transports[] = 'jabber';
874     }
875
876     if ($notice->is_local == Notice::LOCAL_PUBLIC ||
877         $notice->is_local == Notice::LOCAL_NONPUBLIC) {
878         $transports = array_merge($transports, $localTransports);
879         if ($xmpp) {
880             $transports[] = 'public';
881         }
882     }
883
884     $qm = QueueManager::get();
885
886     foreach ($transports as $transport)
887     {
888         $qm->enqueue($notice, $transport);
889     }
890
891     return true;
892 }
893
894 function common_broadcast_profile($profile)
895 {
896     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
897     require_once(INSTALLDIR.'/lib/omb.php');
898     omb_broadcast_profile($profile);
899     // XXX: Other broadcasts...?
900     return true;
901 }
902
903 function common_profile_url($nickname)
904 {
905     return common_local_url('showstream', array('nickname' => $nickname));
906 }
907
908 // Should make up a reasonable root URL
909
910 function common_root_url($ssl=false)
911 {
912     return common_path('', $ssl);
913 }
914
915 // returns $bytes bytes of random data as a hexadecimal string
916 // "good" here is a goal and not a guarantee
917
918 function common_good_rand($bytes)
919 {
920     // XXX: use random.org...?
921     if (@file_exists('/dev/urandom')) {
922         return common_urandom($bytes);
923     } else { // FIXME: this is probably not good enough
924         return common_mtrand($bytes);
925     }
926 }
927
928 function common_urandom($bytes)
929 {
930     $h = fopen('/dev/urandom', 'rb');
931     // should not block
932     $src = fread($h, $bytes);
933     fclose($h);
934     $enc = '';
935     for ($i = 0; $i < $bytes; $i++) {
936         $enc .= sprintf("%02x", (ord($src[$i])));
937     }
938     return $enc;
939 }
940
941 function common_mtrand($bytes)
942 {
943     $enc = '';
944     for ($i = 0; $i < $bytes; $i++) {
945         $enc .= sprintf("%02x", mt_rand(0, 255));
946     }
947     return $enc;
948 }
949
950 function common_set_returnto($url)
951 {
952     common_ensure_session();
953     $_SESSION['returnto'] = $url;
954 }
955
956 function common_get_returnto()
957 {
958     common_ensure_session();
959     return $_SESSION['returnto'];
960 }
961
962 function common_timestamp()
963 {
964     return date('YmdHis');
965 }
966
967 function common_ensure_syslog()
968 {
969     static $initialized = false;
970     if (!$initialized) {
971         openlog(common_config('syslog', 'appname'), 0,
972             common_config('syslog', 'facility'));
973         $initialized = true;
974     }
975 }
976
977 function common_log_line($priority, $msg)
978 {
979     static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
980                                       'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
981     return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
982 }
983
984 function common_log($priority, $msg, $filename=null)
985 {
986     $logfile = common_config('site', 'logfile');
987     if ($logfile) {
988         $log = fopen($logfile, "a");
989         if ($log) {
990             $output = common_log_line($priority, $msg);
991             fwrite($log, $output);
992             fclose($log);
993         }
994     } else {
995         common_ensure_syslog();
996         syslog($priority, $msg);
997     }
998 }
999
1000 function common_debug($msg, $filename=null)
1001 {
1002     if ($filename) {
1003         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1004     } else {
1005         common_log(LOG_DEBUG, $msg);
1006     }
1007 }
1008
1009 function common_log_db_error(&$object, $verb, $filename=null)
1010 {
1011     $objstr = common_log_objstring($object);
1012     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1013     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1014 }
1015
1016 function common_log_objstring(&$object)
1017 {
1018     if (is_null($object)) {
1019         return "null";
1020     }
1021     if (!($object instanceof DB_DataObject)) {
1022         return "(unknown)";
1023     }
1024     $arr = $object->toArray();
1025     $fields = array();
1026     foreach ($arr as $k => $v) {
1027         $fields[] = "$k='$v'";
1028     }
1029     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1030     return $objstring;
1031 }
1032
1033 function common_valid_http_url($url)
1034 {
1035     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1036 }
1037
1038 function common_valid_tag($tag)
1039 {
1040     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1041         return (Validate::email($matches[1]) ||
1042                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1043     }
1044     return false;
1045 }
1046
1047 /* Following functions are copied from MediaWiki GlobalFunctions.php
1048  * and written by Evan Prodromou. */
1049
1050 function common_accept_to_prefs($accept, $def = '*/*')
1051 {
1052     // No arg means accept anything (per HTTP spec)
1053     if(!$accept) {
1054         return array($def => 1);
1055     }
1056
1057     $prefs = array();
1058
1059     $parts = explode(',', $accept);
1060
1061     foreach($parts as $part) {
1062         // FIXME: doesn't deal with params like 'text/html; level=1'
1063         @list($value, $qpart) = explode(';', trim($part));
1064         $match = array();
1065         if(!isset($qpart)) {
1066             $prefs[$value] = 1;
1067         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1068             $prefs[$value] = $match[1];
1069         }
1070     }
1071
1072     return $prefs;
1073 }
1074
1075 function common_mime_type_match($type, $avail)
1076 {
1077     if(array_key_exists($type, $avail)) {
1078         return $type;
1079     } else {
1080         $parts = explode('/', $type);
1081         if(array_key_exists($parts[0] . '/*', $avail)) {
1082             return $parts[0] . '/*';
1083         } elseif(array_key_exists('*/*', $avail)) {
1084             return '*/*';
1085         } else {
1086             return null;
1087         }
1088     }
1089 }
1090
1091 function common_negotiate_type($cprefs, $sprefs)
1092 {
1093     $combine = array();
1094
1095     foreach(array_keys($sprefs) as $type) {
1096         $parts = explode('/', $type);
1097         if($parts[1] != '*') {
1098             $ckey = common_mime_type_match($type, $cprefs);
1099             if($ckey) {
1100                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1101             }
1102         }
1103     }
1104
1105     foreach(array_keys($cprefs) as $type) {
1106         $parts = explode('/', $type);
1107         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1108             $skey = common_mime_type_match($type, $sprefs);
1109             if($skey) {
1110                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1111             }
1112         }
1113     }
1114
1115     $bestq = 0;
1116     $besttype = 'text/html';
1117
1118     foreach(array_keys($combine) as $type) {
1119         if($combine[$type] > $bestq) {
1120             $besttype = $type;
1121             $bestq = $combine[$type];
1122         }
1123     }
1124
1125     if ('text/html' === $besttype) {
1126         return "text/html; charset=utf-8";
1127     }
1128     return $besttype;
1129 }
1130
1131 function common_config($main, $sub)
1132 {
1133     global $config;
1134     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1135 }
1136
1137 function common_copy_args($from)
1138 {
1139     $to = array();
1140     $strip = get_magic_quotes_gpc();
1141     foreach ($from as $k => $v) {
1142         $to[$k] = ($strip) ? stripslashes($v) : $v;
1143     }
1144     return $to;
1145 }
1146
1147 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1148 // This is used before handing a request off to OAuthRequest::from_request.
1149 function common_remove_magic_from_request()
1150 {
1151     if(get_magic_quotes_gpc()) {
1152         $_POST=array_map('stripslashes',$_POST);
1153         $_GET=array_map('stripslashes',$_GET);
1154     }
1155 }
1156
1157 function common_user_uri(&$user)
1158 {
1159     return common_local_url('userbyid', array('id' => $user->id));
1160 }
1161
1162 function common_notice_uri(&$notice)
1163 {
1164     return common_local_url('shownotice',
1165                             array('notice' => $notice->id));
1166 }
1167
1168 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1169
1170 function common_confirmation_code($bits)
1171 {
1172     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1173     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1174     $chars = ceil($bits/5);
1175     $code = '';
1176     for ($i = 0; $i < $chars; $i++) {
1177         // XXX: convert to string and back
1178         $num = hexdec(common_good_rand(1));
1179         // XXX: randomness is too precious to throw away almost
1180         // 40% of the bits we get!
1181         $code .= $codechars[$num%32];
1182     }
1183     return $code;
1184 }
1185
1186 // convert markup to HTML
1187
1188 function common_markup_to_html($c)
1189 {
1190     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1191     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1192     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1193     return Markdown($c);
1194 }
1195
1196 function common_profile_uri($profile)
1197 {
1198     if (!$profile) {
1199         return null;
1200     }
1201     $user = User::staticGet($profile->id);
1202     if ($user) {
1203         return $user->uri;
1204     }
1205
1206     $remote = Remote_profile::staticGet($profile->id);
1207     if ($remote) {
1208         return $remote->uri;
1209     }
1210     // XXX: this is a very bad profile!
1211     return null;
1212 }
1213
1214 function common_canonical_sms($sms)
1215 {
1216     // strip non-digits
1217     preg_replace('/\D/', '', $sms);
1218     return $sms;
1219 }
1220
1221 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1222 {
1223     switch ($errno) {
1224
1225      case E_ERROR:
1226      case E_COMPILE_ERROR:
1227      case E_CORE_ERROR:
1228      case E_USER_ERROR:
1229      case E_PARSE:
1230      case E_RECOVERABLE_ERROR:
1231         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1232         die();
1233         break;
1234
1235      case E_WARNING:
1236      case E_COMPILE_WARNING:
1237      case E_CORE_WARNING:
1238      case E_USER_WARNING:
1239         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1240         break;
1241
1242      case E_NOTICE:
1243      case E_USER_NOTICE:
1244         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1245         break;
1246
1247      case E_STRICT:
1248      case E_DEPRECATED:
1249      case E_USER_DEPRECATED:
1250         // XXX: config variable to log this stuff, too
1251         break;
1252
1253      default:
1254         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1255         die();
1256         break;
1257     }
1258
1259     // FIXME: show error page if we're on the Web
1260     /* Don't execute PHP internal error handler */
1261     return true;
1262 }
1263
1264 function common_session_token()
1265 {
1266     common_ensure_session();
1267     if (!array_key_exists('token', $_SESSION)) {
1268         $_SESSION['token'] = common_good_rand(64);
1269     }
1270     return $_SESSION['token'];
1271 }
1272
1273 function common_cache_key($extra)
1274 {
1275     $base_key = common_config('memcached', 'base');
1276
1277     if (empty($base_key)) {
1278         $base_key = common_keyize(common_config('site', 'name'));
1279     }
1280
1281     return 'laconica:' . $base_key . ':' . $extra;
1282 }
1283
1284 function common_keyize($str)
1285 {
1286     $str = strtolower($str);
1287     $str = preg_replace('/\s/', '_', $str);
1288     return $str;
1289 }
1290
1291 function common_memcache()
1292 {
1293     static $cache = null;
1294     if (!common_config('memcached', 'enabled')) {
1295         return null;
1296     } else {
1297         if (!$cache) {
1298             $cache = new Memcache();
1299             $servers = common_config('memcached', 'server');
1300             if (is_array($servers)) {
1301                 foreach($servers as $server) {
1302                     $cache->addServer($server);
1303                 }
1304             } else {
1305                 $cache->addServer($servers);
1306             }
1307         }
1308         return $cache;
1309     }
1310 }
1311
1312 function common_compatible_license($from, $to)
1313 {
1314     // XXX: better compatibility check needed here!
1315     return ($from == $to);
1316 }
1317
1318 /**
1319  * returns a quoted table name, if required according to config
1320  */
1321 function common_database_tablename($tablename)
1322 {
1323
1324   if(common_config('db','quote_identifiers')) {
1325       $tablename = '"'. $tablename .'"';
1326   }
1327   //table prefixes could be added here later
1328   return $tablename;
1329 }
1330
1331 function common_shorten_url($long_url)
1332 {
1333     $user = common_current_user();
1334     if (empty($user)) {
1335         // common current user does not find a user when called from the XMPP daemon
1336         // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1337         $svc = 'ur1.ca';
1338     } else {
1339         $svc = $user->urlshorteningservice;
1340     }
1341
1342     $curlh = curl_init();
1343     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1344     curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
1345     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1346
1347     switch($svc) {
1348      case 'ur1.ca':
1349         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1350         $short_url_service = new LilUrl;
1351         $short_url = $short_url_service->shorten($long_url);
1352         break;
1353
1354      case '2tu.us':
1355         $short_url_service = new TightUrl;
1356         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1357         $short_url = $short_url_service->shorten($long_url);
1358         break;
1359
1360      case 'ptiturl.com':
1361         require_once INSTALLDIR.'/lib/Shorturl_api.php';
1362         $short_url_service = new PtitUrl;
1363         $short_url = $short_url_service->shorten($long_url);
1364         break;
1365
1366      case 'bit.ly':
1367         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1368         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1369         break;
1370
1371      case 'is.gd':
1372         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1373         $short_url = curl_exec($curlh);
1374         break;
1375      case 'snipr.com':
1376         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1377         $short_url = curl_exec($curlh);
1378         break;
1379      case 'metamark.net':
1380         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1381         $short_url = curl_exec($curlh);
1382         break;
1383      case 'tinyurl.com':
1384         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1385         $short_url = curl_exec($curlh);
1386         break;
1387      default:
1388         $short_url = false;
1389     }
1390
1391     curl_close($curlh);
1392
1393     return $short_url;
1394 }
1395
1396 function common_client_ip()
1397 {
1398     if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1399         return null;
1400     }
1401
1402     if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1403         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1404             $proxy = $_SERVER['HTTP_CLIENT_IP'];
1405         } else {
1406             $proxy = $_SERVER['REMOTE_ADDR'];
1407         }
1408         $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1409     } else {
1410         $proxy = null;
1411         if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1412             $ip = $_SERVER['HTTP_CLIENT_IP'];
1413         } else {
1414             $ip = $_SERVER['REMOTE_ADDR'];
1415         }
1416     }
1417
1418     return array($proxy, $ip);
1419 }