]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/util.php
Merge branch 'sgmurphy-clone/0.7.x' into 0.7.x
[quix0rs-gnu-social.git] / lib / util.php
1 <?php
2 /*
3  * Laconica - a distributed open-source microblogging tool
4  * Copyright (C) 2008, Controlez-Vous, 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     global $config;
76     return $config['site']['timezone'];
77 }
78
79 function common_language()
80 {
81
82     // If there is a user logged in and they've set a language preference
83     // then return that one...
84     if (common_logged_in()) {
85         $user = common_current_user();
86         $user_language = $user->language;
87         if ($user_language)
88           return $user_language;
89     }
90
91     // Otherwise, find the best match for the languages requested by the
92     // user's browser...
93     $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
94     if (!empty($httplang)) {
95         $language = client_prefered_language($httplang);
96         if ($language)
97           return $language;
98     }
99
100     // Finally, if none of the above worked, use the site's default...
101     return common_config('site', 'language');
102 }
103 // salted, hashed passwords are stored in the DB
104
105 function common_munge_password($password, $id)
106 {
107     return md5($password . $id);
108 }
109
110 // check if a username exists and has matching password
111 function common_check_user($nickname, $password)
112 {
113     // NEVER allow blank passwords, even if they match the DB
114     if (mb_strlen($password) == 0) {
115         return false;
116     }
117     $user = User::staticGet('nickname', $nickname);
118     if (is_null($user)) {
119         return false;
120     } else {
121         if (0 == strcmp(common_munge_password($password, $user->id),
122                         $user->password)) {
123             return $user;
124         } else {
125             return false;
126         }
127     }
128 }
129
130 // is the current user logged in?
131 function common_logged_in()
132 {
133     return (!is_null(common_current_user()));
134 }
135
136 function common_have_session()
137 {
138     return (0 != strcmp(session_id(), ''));
139 }
140
141 function common_ensure_session()
142 {
143     if (!common_have_session()) {
144         @session_start();
145     }
146 }
147
148 // Three kinds of arguments:
149 // 1) a user object
150 // 2) a nickname
151 // 3) null to clear
152
153 // Initialize to false; set to null if none found
154
155 $_cur = false;
156
157 function common_set_user($user)
158 {
159
160     global $_cur;
161
162     if (is_null($user) && common_have_session()) {
163         $_cur = null;
164         unset($_SESSION['userid']);
165         return true;
166     } else if (is_string($user)) {
167         $nickname = $user;
168         $user = User::staticGet('nickname', $nickname);
169     } else if (!($user instanceof User)) {
170         return false;
171     }
172
173     if ($user) {
174         common_ensure_session();
175         $_SESSION['userid'] = $user->id;
176         $_cur = $user;
177         return $_cur;
178     }
179     return false;
180 }
181
182 function common_set_cookie($key, $value, $expiration=0)
183 {
184     $path = common_config('site', 'path');
185     $server = common_config('site', 'server');
186
187     if ($path && ($path != '/')) {
188         $cookiepath = '/' . $path . '/';
189     } else {
190         $cookiepath = '/';
191     }
192     return setcookie($key,
193                      $value,
194                      $expiration,
195                      $cookiepath,
196                      $server);
197 }
198
199 define('REMEMBERME', 'rememberme');
200 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
201
202 function common_rememberme($user=null)
203 {
204     if (!$user) {
205         $user = common_current_user();
206         if (!$user) {
207             common_debug('No current user to remember', __FILE__);
208             return false;
209         }
210     }
211
212     $rm = new Remember_me();
213
214     $rm->code = common_good_rand(16);
215     $rm->user_id = $user->id;
216
217     // Wrap the insert in some good ol' fashioned transaction code
218
219     $rm->query('BEGIN');
220
221     $result = $rm->insert();
222
223     if (!$result) {
224         common_log_db_error($rm, 'INSERT', __FILE__);
225         common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
226         return false;
227     }
228
229     $rm->query('COMMIT');
230
231     common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
232
233     $cookieval = $rm->user_id . ':' . $rm->code;
234
235     common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
236
237     common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
238
239     return true;
240 }
241
242 function common_remembered_user()
243 {
244
245     $user = null;
246
247     $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
248
249     if (!$packed) {
250         return null;
251     }
252
253     list($id, $code) = explode(':', $packed);
254
255     if (!$id || !$code) {
256         common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
257         common_forgetme();
258         return null;
259     }
260
261     $rm = Remember_me::staticGet($code);
262
263     if (!$rm) {
264         common_log(LOG_WARNING, 'No such remember code: ' . $code);
265         common_forgetme();
266         return null;
267     }
268
269     if ($rm->user_id != $id) {
270         common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
271         common_forgetme();
272         return null;
273     }
274
275     $user = User::staticGet($rm->user_id);
276
277     if (!$user) {
278         common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
279         common_forgetme();
280         return null;
281     }
282
283     // successful!
284     $result = $rm->delete();
285
286     if (!$result) {
287         common_log_db_error($rm, 'DELETE', __FILE__);
288         common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
289         common_forgetme();
290         return null;
291     }
292
293     common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
294
295     common_set_user($user);
296     common_real_login(false);
297
298     // We issue a new cookie, so they can log in
299     // automatically again after this session
300
301     common_rememberme($user);
302
303     return $user;
304 }
305
306 // must be called with a valid user!
307
308 function common_forgetme()
309 {
310     common_set_cookie(REMEMBERME, '', 0);
311 }
312
313 // who is the current user?
314 function common_current_user()
315 {
316     global $_cur;
317
318     if ($_cur === false) {
319
320         if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
321             common_ensure_session();
322             $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
323             if ($id) {
324                 $_cur = User::staticGet($id);
325                 return $_cur;
326             }
327         }
328
329         // that didn't work; try to remember; will init $_cur to null on failure
330         $_cur = common_remembered_user();
331
332         if ($_cur) {
333             common_debug("Got User " . $_cur->nickname);
334             common_debug("Faking session on remembered user");
335             // XXX: Is this necessary?
336             $_SESSION['userid'] = $_cur->id;
337         }
338     }
339
340     return $_cur;
341 }
342
343 // Logins that are 'remembered' aren't 'real' -- they're subject to
344 // cookie-stealing. So, we don't let them do certain things. New reg,
345 // OpenID, and password logins _are_ real.
346
347 function common_real_login($real=true)
348 {
349     common_ensure_session();
350     $_SESSION['real_login'] = $real;
351 }
352
353 function common_is_real_login()
354 {
355     return common_logged_in() && $_SESSION['real_login'];
356 }
357
358 // get canonical version of nickname for comparison
359 function common_canonical_nickname($nickname)
360 {
361     // XXX: UTF-8 canonicalization (like combining chars)
362     return strtolower($nickname);
363 }
364
365 // get canonical version of email for comparison
366 function common_canonical_email($email)
367 {
368     // XXX: canonicalize UTF-8
369     // XXX: lcase the domain part
370     return $email;
371 }
372
373 function common_render_content($text, $notice)
374 {
375     $r = common_render_text($text);
376     $id = $notice->profile_id;
377     $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
378     $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
379     $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
380     $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
381     return $r;
382 }
383
384 function common_render_text($text)
385 {
386     $r = htmlspecialchars($text);
387
388     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
389     $r = common_replace_urls_callback($r, 'common_linkify');
390     $r = preg_replace('/(^|\(|\[|\s+)#([A-Za-z0-9_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
391     // XXX: machine tags
392     return $r;
393 }
394
395 function common_replace_urls_callback($text, $callback) {
396     // Start off with a regex
397     $regex = '#
398     (?:
399         (?:
400             (?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|xmpp|irc)://
401             |
402             (?:mailto|aim|tel):
403         )
404         [^.\s]+\.[^\s]+
405         |
406         (?:[^.\s/:]+\.)+
407         (?:museum|travel|[a-z]{2,4})
408         (?:[:/][^\s]*)?
409     )
410     #ix';
411     preg_match_all($regex, $text, $matches);
412
413     // Then clean up what the regex left behind
414     $offset = 0;
415     foreach($matches[0] as $orig_url) {
416         $url = htmlspecialchars_decode($orig_url);
417
418         // Make sure we didn't pick up an email address
419         if (preg_match('#^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$#i', $url)) continue;
420
421         // Remove surrounding punctuation
422         $url = trim($url, '.?!,;:\'"`([<');
423
424         // Remove surrounding parens and the like
425         preg_match('/[)\]>]+$/', $url, $trailing);
426         if (isset($trailing[0])) {
427             preg_match_all('/[(\[<]/', $url, $opened);
428             preg_match_all('/[)\]>]/', $url, $closed);
429             $unopened = count($closed[0]) - count($opened[0]);
430
431             // Make sure not to take off more closing parens than there are at the end
432             $unopened = ($unopened > mb_strlen($trailing[0])) ? mb_strlen($trailing[0]):$unopened;
433
434             $url = ($unopened > 0) ? mb_substr($url, 0, $unopened * -1):$url;
435         }
436
437         // Remove trailing punctuation again (in case there were some inside parens)
438         $url = rtrim($url, '.?!,;:\'"`');
439
440         // Make sure we didn't capture part of the next sentence
441         preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
442
443         // Were the parts capitalized any?
444         $last_part = (mb_strtolower($url_parts[2]) !== $url_parts[2]) ? true:false;
445         $prev_part = (mb_strtolower($url_parts[1]) !== $url_parts[1]) ? true:false;
446
447         // If the first part wasn't cap'd but the last part was, we captured too much
448         if ((!$prev_part && $last_part)) {
449             $url = mb_substr($url, 0 , mb_strpos($url, '.'.$url_parts['2'], 0));
450         }
451
452         // Capture the new TLD
453         preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
454
455         $tlds = array('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', 'ye', 'yt', 'yu', 'za', 'zm', 'zw');
456
457         if (!in_array($url_parts[2], $tlds)) continue;
458
459         // Put the url back the way we found it.
460         $url = (mb_strpos($orig_url, htmlspecialchars($url)) === FALSE) ? $url:htmlspecialchars($url);
461
462         // Call user specified func
463         $modified_url = $callback($url);
464
465         // Replace it!
466         $start = mb_strpos($text, $url, $offset);
467         $text = mb_substr($text, 0, $start).$modified_url.mb_substr($text, $start + mb_strlen($url), mb_strlen($text));
468         $offset = $start + mb_strlen($modified_url);
469     }
470
471     return $text;
472 }
473
474 function common_linkify($url) {
475     $display = $url;
476     $url = (!preg_match('#^([a-z]+://|(mailto|aim|tel):)#i', $url)) ? 'http://'.$url:$url;
477
478     if ($longurl = common_longurl($url)) {
479         $longurl = htmlentities($longurl, ENT_QUOTES, 'UTF-8');
480         $title = "title=\"$longurl\"";
481     }
482     else $title = '';
483
484     return "<a href=\"$url\" $title rel=\"external\">$display</a>";
485 }
486
487 function common_longurl($short_url)
488 {
489     $long_url = common_shorten_link($short_url, true);
490     if ($long_url === $short_url) return false;
491     return $long_url;
492 }
493
494 function common_longurl2($uri)
495 {
496     $uri_e = urlencode($uri);
497     $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
498     if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
499     return stripslashes($longurl['long_url']);
500 }
501
502 function common_shorten_links($text)
503 {
504     if (mb_strlen($text) <= 140) return $text;
505     static $cache = array();
506     if (isset($cache[$text])) return $cache[$text];
507     // \s = not a horizontal whitespace character (since PHP 5.2.4)
508     return $cache[$text] = common_replace_urls_callback($text, 'common_shorten_link');;
509 }
510
511 function common_shorten_link($url, $reverse = false)
512 {
513     static $url_cache = array();
514     if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
515
516     $user = common_current_user();
517
518     $curlh = curl_init();
519     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
520     curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
521     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
522
523     switch($user->urlshorteningservice) {
524      case 'ur1.ca':
525         $short_url_service = new LilUrl;
526         $short_url = $short_url_service->shorten($url);
527         break;
528
529      case '2tu.us':
530         $short_url_service = new TightUrl;
531         $short_url = $short_url_service->shorten($url);
532         break;
533
534      case 'ptiturl.com':
535         $short_url_service = new PtitUrl;
536         $short_url = $short_url_service->shorten($url);
537         break;
538
539      case 'bit.ly':
540         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
541         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
542         break;
543
544      case 'is.gd':
545         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
546         $short_url = curl_exec($curlh);
547         break;
548      case 'snipr.com':
549         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
550         $short_url = curl_exec($curlh);
551         break;
552      case 'metamark.net':
553         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
554         $short_url = curl_exec($curlh);
555         break;
556      case 'tinyurl.com':
557         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
558         $short_url = curl_exec($curlh);
559         break;
560      default:
561         $short_url = false;
562     }
563
564     curl_close($curlh);
565
566     if ($short_url) {
567         $url_cache[(string)$short_url] = $url;
568         return (string)$short_url;
569     }
570     return $url;
571 }
572
573 function common_xml_safe_str($str)
574 {
575     $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
576
577     // Replace control, formatting, and surrogate characters with '*', ala Twitter
578     return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
579 }
580
581 function common_tag_link($tag)
582 {
583     $canonical = common_canonical_tag($tag);
584     $url = common_local_url('tag', array('tag' => $canonical));
585     return '<span class="tag"><a href="' . htmlspecialchars($url) . '" rel="tag">' . htmlspecialchars($tag) . '</a></span>';
586 }
587
588 function common_canonical_tag($tag)
589 {
590     return strtolower(str_replace(array('-', '_', '.'), '', $tag));
591 }
592
593 function common_valid_profile_tag($str)
594 {
595     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
596 }
597
598 function common_at_link($sender_id, $nickname)
599 {
600     $sender = Profile::staticGet($sender_id);
601     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
602     if ($recipient) {
603         return '<span class="vcard"><a href="'.htmlspecialchars($recipient->profileurl).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
604     } else {
605         return $nickname;
606     }
607 }
608
609 function common_group_link($sender_id, $nickname)
610 {
611     $sender = Profile::staticGet($sender_id);
612     $group = User_group::staticGet('nickname', common_canonical_nickname($nickname));
613     if ($group && $sender->isMember($group)) {
614         return '<span class="vcard"><a href="'.htmlspecialchars($group->permalink()).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
615     } else {
616         return $nickname;
617     }
618 }
619
620 function common_at_hash_link($sender_id, $tag)
621 {
622     $user = User::staticGet($sender_id);
623     if (!$user) {
624         return $tag;
625     }
626     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
627     if ($tagged) {
628         $url = common_local_url('subscriptions',
629                                 array('nickname' => $user->nickname,
630                                       'tag' => $tag));
631         return '<span class="tag"><a href="'.htmlspecialchars($url).'" rel="tag">'.$tag.'</a></span>';
632     } else {
633         return $tag;
634     }
635 }
636
637 function common_relative_profile($sender, $nickname, $dt=null)
638 {
639     // Try to find profiles this profile is subscribed to that have this nickname
640     $recipient = new Profile();
641     // XXX: use a join instead of a subquery
642     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
643     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
644     if ($recipient->find(true)) {
645         // XXX: should probably differentiate between profiles with
646         // the same name by date of most recent update
647         return $recipient;
648     }
649     // Try to find profiles that listen to this profile and that have this nickname
650     $recipient = new Profile();
651     // XXX: use a join instead of a subquery
652     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
653     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
654     if ($recipient->find(true)) {
655         // XXX: should probably differentiate between profiles with
656         // the same name by date of most recent update
657         return $recipient;
658     }
659     // If this is a local user, try to find a local user with that nickname.
660     $sender = User::staticGet($sender->id);
661     if ($sender) {
662         $recipient_user = User::staticGet('nickname', $nickname);
663         if ($recipient_user) {
664             return $recipient_user->getProfile();
665         }
666     }
667     // Otherwise, no links. @messages from local users to remote users,
668     // or from remote users to other remote users, are just
669     // outside our ability to make intelligent guesses about
670     return null;
671 }
672
673 function common_local_url($action, $args=null, $fragment=null)
674 {
675     common_debug("Action = $action, args = " . (($args) ? '(' . implode($args, ',') . ')' : $args) . ", fragment = $fragment");
676     $r = Router::get();
677     $start = microtime();
678     $path = $r->build($action, $args, $fragment);
679     $end = microtime();
680     common_debug("Pathbuilding took " . ($end - $start));
681     if ($path) {
682     }
683     if (common_config('site','fancy')) {
684         $url = common_path(mb_substr($path, 1));
685     } else {
686         $url = common_path('index.php'.$path);
687     }
688     return $url;
689 }
690
691 function common_path($relative)
692 {
693     global $config;
694     $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
695     return "http://".$config['site']['server'].'/'.$pathpart.$relative;
696 }
697
698 function common_date_string($dt)
699 {
700     // XXX: do some sexy date formatting
701     // return date(DATE_RFC822, $dt);
702     $t = strtotime($dt);
703     $now = time();
704     $diff = $now - $t;
705
706     if ($now < $t) { // that shouldn't happen!
707         return common_exact_date($dt);
708     } else if ($diff < 60) {
709         return _('a few seconds ago');
710     } else if ($diff < 92) {
711         return _('about a minute ago');
712     } else if ($diff < 3300) {
713         return sprintf(_('about %d minutes ago'), round($diff/60));
714     } else if ($diff < 5400) {
715         return _('about an hour ago');
716     } else if ($diff < 22 * 3600) {
717         return sprintf(_('about %d hours ago'), round($diff/3600));
718     } else if ($diff < 37 * 3600) {
719         return _('about a day ago');
720     } else if ($diff < 24 * 24 * 3600) {
721         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
722     } else if ($diff < 46 * 24 * 3600) {
723         return _('about a month ago');
724     } else if ($diff < 330 * 24 * 3600) {
725         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
726     } else if ($diff < 480 * 24 * 3600) {
727         return _('about a year ago');
728     } else {
729         return common_exact_date($dt);
730     }
731 }
732
733 function common_exact_date($dt)
734 {
735     static $_utc;
736     static $_siteTz;
737
738     if (!$_utc) {
739         $_utc = new DateTimeZone('UTC');
740         $_siteTz = new DateTimeZone(common_timezone());
741     }
742
743     $dateStr = date('d F Y H:i:s', strtotime($dt));
744     $d = new DateTime($dateStr, $_utc);
745     $d->setTimezone($_siteTz);
746     return $d->format(DATE_RFC850);
747 }
748
749 function common_date_w3dtf($dt)
750 {
751     $dateStr = date('d F Y H:i:s', strtotime($dt));
752     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
753     $d->setTimezone(new DateTimeZone(common_timezone()));
754     return $d->format(DATE_W3C);
755 }
756
757 function common_date_rfc2822($dt)
758 {
759     $dateStr = date('d F Y H:i:s', strtotime($dt));
760     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
761     $d->setTimezone(new DateTimeZone(common_timezone()));
762     return $d->format('r');
763 }
764
765 function common_date_iso8601($dt)
766 {
767     $dateStr = date('d F Y H:i:s', strtotime($dt));
768     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
769     $d->setTimezone(new DateTimeZone(common_timezone()));
770     return $d->format('c');
771 }
772
773 function common_sql_now()
774 {
775     return strftime('%Y-%m-%d %H:%M:%S', time());
776 }
777
778 function common_redirect($url, $code=307)
779 {
780     static $status = array(301 => "Moved Permanently",
781                            302 => "Found",
782                            303 => "See Other",
783                            307 => "Temporary Redirect");
784
785     header("Status: ${code} $status[$code]");
786     header("Location: $url");
787
788     $xo = new XMLOutputter();
789     $xo->startXML('a',
790                   '-//W3C//DTD XHTML 1.0 Strict//EN',
791                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
792     $xo->element('a', array('href' => $url), $url);
793     $xo->endXML();
794     exit;
795 }
796
797 function common_broadcast_notice($notice, $remote=false)
798 {
799
800     // Check to see if notice should go to Twitter
801     $flink = Foreign_link::getByUserID($notice->profile_id, 1); // 1 == Twitter
802     if (($flink->noticesync & FOREIGN_NOTICE_SEND) == FOREIGN_NOTICE_SEND) {
803
804         // If it's not a Twitter-style reply, or if the user WANTS to send replies...
805
806         if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
807             (($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) == FOREIGN_NOTICE_SEND_REPLY)) {
808
809             $result = common_twitter_broadcast($notice, $flink);
810
811             if (!$result) {
812                 common_debug('Unable to send notice: ' . $notice->id . ' to Twitter.', __FILE__);
813             }
814         }
815     }
816
817     if (common_config('queue', 'enabled')) {
818         // Do it later!
819         return common_enqueue_notice($notice);
820     } else {
821         return common_real_broadcast($notice, $remote);
822     }
823 }
824
825 function common_twitter_broadcast($notice, $flink)
826 {
827     global $config;
828     $success = true;
829     $fuser = $flink->getForeignUser();
830     $twitter_user = $fuser->nickname;
831     $twitter_password = $flink->credentials;
832     $uri = 'http://www.twitter.com/statuses/update.json';
833
834     // XXX: Hack to get around PHP cURL's use of @ being a a meta character
835     $statustxt = preg_replace('/^@/', ' @', $notice->content);
836
837     $options = array(
838                      CURLOPT_USERPWD         => "$twitter_user:$twitter_password",
839                      CURLOPT_POST            => true,
840                      CURLOPT_POSTFIELDS        => array(
841                                                         'status'    => $statustxt,
842                                                         'source'    => $config['integration']['source']
843                                                         ),
844                      CURLOPT_RETURNTRANSFER    => true,
845                      CURLOPT_FAILONERROR        => true,
846                      CURLOPT_HEADER            => false,
847                      CURLOPT_FOLLOWLOCATION    => true,
848                      CURLOPT_USERAGENT        => "Laconica",
849                      CURLOPT_CONNECTTIMEOUT    => 120,  // XXX: Scary!!!! How long should this be?
850                      CURLOPT_TIMEOUT            => 120,
851
852                      # Twitter is strict about accepting invalid "Expect" headers
853                      CURLOPT_HTTPHEADER => array('Expect:')
854                      );
855
856     $ch = curl_init($uri);
857     curl_setopt_array($ch, $options);
858     $data = curl_exec($ch);
859     $errmsg = curl_error($ch);
860
861     if ($errmsg) {
862         common_debug("cURL error: $errmsg - trying to send notice for $twitter_user.",
863                      __FILE__);
864         $success = false;
865     }
866
867     curl_close($ch);
868
869     if (!$data) {
870         common_debug("No data returned by Twitter's API trying to send update for $twitter_user",
871                      __FILE__);
872         $success = false;
873     }
874
875     // Twitter should return a status
876     $status = json_decode($data);
877
878     if (!$status->id) {
879         common_debug("Unexpected data returned by Twitter API trying to send update for $twitter_user",
880                      __FILE__);
881         $success = false;
882     }
883
884     return $success;
885 }
886
887 // Stick the notice on the queue
888
889 function common_enqueue_notice($notice)
890 {
891     foreach (array('jabber', 'omb', 'sms', 'public') as $transport) {
892         $qi = new Queue_item();
893         $qi->notice_id = $notice->id;
894         $qi->transport = $transport;
895         $qi->created = $notice->created;
896         $result = $qi->insert();
897         if (!$result) {
898             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
899             common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
900             return false;
901         }
902         common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
903     }
904     return $result;
905 }
906
907 function common_real_broadcast($notice, $remote=false)
908 {
909     $success = true;
910     if (!$remote) {
911         // Make sure we have the OMB stuff
912         require_once(INSTALLDIR.'/lib/omb.php');
913         $success = omb_broadcast_remote_subscribers($notice);
914         if (!$success) {
915             common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
916         }
917     }
918     if ($success) {
919         require_once(INSTALLDIR.'/lib/jabber.php');
920         $success = jabber_broadcast_notice($notice);
921         if (!$success) {
922             common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
923         }
924     }
925     if ($success) {
926         require_once(INSTALLDIR.'/lib/mail.php');
927         $success = mail_broadcast_notice_sms($notice);
928         if (!$success) {
929             common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
930         }
931     }
932     if ($success) {
933         $success = jabber_public_notice($notice);
934         if (!$success) {
935             common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
936         }
937     }
938     // XXX: broadcast notices to other IM
939     return $success;
940 }
941
942 function common_broadcast_profile($profile)
943 {
944     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
945     require_once(INSTALLDIR.'/lib/omb.php');
946     omb_broadcast_profile($profile);
947     // XXX: Other broadcasts...?
948     return true;
949 }
950
951 function common_profile_url($nickname)
952 {
953     return common_local_url('showstream', array('nickname' => $nickname));
954 }
955
956 // Should make up a reasonable root URL
957
958 function common_root_url()
959 {
960     return common_path('');
961 }
962
963 // returns $bytes bytes of random data as a hexadecimal string
964 // "good" here is a goal and not a guarantee
965
966 function common_good_rand($bytes)
967 {
968     // XXX: use random.org...?
969     if (file_exists('/dev/urandom')) {
970         return common_urandom($bytes);
971     } else { // FIXME: this is probably not good enough
972         return common_mtrand($bytes);
973     }
974 }
975
976 function common_urandom($bytes)
977 {
978     $h = fopen('/dev/urandom', 'rb');
979     // should not block
980     $src = fread($h, $bytes);
981     fclose($h);
982     $enc = '';
983     for ($i = 0; $i < $bytes; $i++) {
984         $enc .= sprintf("%02x", (ord($src[$i])));
985     }
986     return $enc;
987 }
988
989 function common_mtrand($bytes)
990 {
991     $enc = '';
992     for ($i = 0; $i < $bytes; $i++) {
993         $enc .= sprintf("%02x", mt_rand(0, 255));
994     }
995     return $enc;
996 }
997
998 function common_set_returnto($url)
999 {
1000     common_ensure_session();
1001     $_SESSION['returnto'] = $url;
1002 }
1003
1004 function common_get_returnto()
1005 {
1006     common_ensure_session();
1007     return $_SESSION['returnto'];
1008 }
1009
1010 function common_timestamp()
1011 {
1012     return date('YmdHis');
1013 }
1014
1015 function common_ensure_syslog()
1016 {
1017     static $initialized = false;
1018     if (!$initialized) {
1019         global $config;
1020         openlog($config['syslog']['appname'], 0, LOG_USER);
1021         $initialized = true;
1022     }
1023 }
1024
1025 function common_log($priority, $msg, $filename=null)
1026 {
1027     $logfile = common_config('site', 'logfile');
1028     if ($logfile) {
1029         $log = fopen($logfile, "a");
1030         if ($log) {
1031             static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1032                                               'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1033             $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1034             fwrite($log, $output);
1035             fclose($log);
1036         }
1037     } else {
1038         common_ensure_syslog();
1039         syslog($priority, $msg);
1040     }
1041 }
1042
1043 function common_debug($msg, $filename=null)
1044 {
1045     if ($filename) {
1046         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1047     } else {
1048         common_log(LOG_DEBUG, $msg);
1049     }
1050 }
1051
1052 function common_log_db_error(&$object, $verb, $filename=null)
1053 {
1054     $objstr = common_log_objstring($object);
1055     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1056     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1057 }
1058
1059 function common_log_objstring(&$object)
1060 {
1061     if (is_null($object)) {
1062         return "null";
1063     }
1064     $arr = $object->toArray();
1065     $fields = array();
1066     foreach ($arr as $k => $v) {
1067         $fields[] = "$k='$v'";
1068     }
1069     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1070     return $objstring;
1071 }
1072
1073 function common_valid_http_url($url)
1074 {
1075     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1076 }
1077
1078 function common_valid_tag($tag)
1079 {
1080     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1081         return (Validate::email($matches[1]) ||
1082                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1083     }
1084     return false;
1085 }
1086
1087 /* Following functions are copied from MediaWiki GlobalFunctions.php
1088  * and written by Evan Prodromou. */
1089
1090 function common_accept_to_prefs($accept, $def = '*/*')
1091 {
1092     // No arg means accept anything (per HTTP spec)
1093     if(!$accept) {
1094         return array($def => 1);
1095     }
1096
1097     $prefs = array();
1098
1099     $parts = explode(',', $accept);
1100
1101     foreach($parts as $part) {
1102         // FIXME: doesn't deal with params like 'text/html; level=1'
1103         @list($value, $qpart) = explode(';', $part);
1104         $match = array();
1105         if(!isset($qpart)) {
1106             $prefs[$value] = 1;
1107         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1108             $prefs[$value] = $match[1];
1109         }
1110     }
1111
1112     return $prefs;
1113 }
1114
1115 function common_mime_type_match($type, $avail)
1116 {
1117     if(array_key_exists($type, $avail)) {
1118         return $type;
1119     } else {
1120         $parts = explode('/', $type);
1121         if(array_key_exists($parts[0] . '/*', $avail)) {
1122             return $parts[0] . '/*';
1123         } elseif(array_key_exists('*/*', $avail)) {
1124             return '*/*';
1125         } else {
1126             return null;
1127         }
1128     }
1129 }
1130
1131 function common_negotiate_type($cprefs, $sprefs)
1132 {
1133     $combine = array();
1134
1135     foreach(array_keys($sprefs) as $type) {
1136         $parts = explode('/', $type);
1137         if($parts[1] != '*') {
1138             $ckey = common_mime_type_match($type, $cprefs);
1139             if($ckey) {
1140                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1141             }
1142         }
1143     }
1144
1145     foreach(array_keys($cprefs) as $type) {
1146         $parts = explode('/', $type);
1147         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1148             $skey = common_mime_type_match($type, $sprefs);
1149             if($skey) {
1150                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1151             }
1152         }
1153     }
1154
1155     $bestq = 0;
1156     $besttype = 'text/html';
1157
1158     foreach(array_keys($combine) as $type) {
1159         if($combine[$type] > $bestq) {
1160             $besttype = $type;
1161             $bestq = $combine[$type];
1162         }
1163     }
1164
1165     if ('text/html' === $besttype) {
1166         return "text/html; charset=utf-8";
1167     }
1168     return $besttype;
1169 }
1170
1171 function common_config($main, $sub)
1172 {
1173     global $config;
1174     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1175 }
1176
1177 function common_copy_args($from)
1178 {
1179     $to = array();
1180     $strip = get_magic_quotes_gpc();
1181     foreach ($from as $k => $v) {
1182         $to[$k] = ($strip) ? stripslashes($v) : $v;
1183     }
1184     return $to;
1185 }
1186
1187 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1188 // This is used before handing a request off to OAuthRequest::from_request.
1189 function common_remove_magic_from_request()
1190 {
1191     if(get_magic_quotes_gpc()) {
1192         $_POST=array_map('stripslashes',$_POST);
1193         $_GET=array_map('stripslashes',$_GET);
1194     }
1195 }
1196
1197 function common_user_uri(&$user)
1198 {
1199     return common_local_url('userbyid', array('id' => $user->id));
1200 }
1201
1202 function common_notice_uri(&$notice)
1203 {
1204     return common_local_url('shownotice',
1205                             array('notice' => $notice->id));
1206 }
1207
1208 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1209
1210 function common_confirmation_code($bits)
1211 {
1212     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1213     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1214     $chars = ceil($bits/5);
1215     $code = '';
1216     for ($i = 0; $i < $chars; $i++) {
1217         // XXX: convert to string and back
1218         $num = hexdec(common_good_rand(1));
1219         // XXX: randomness is too precious to throw away almost
1220         // 40% of the bits we get!
1221         $code .= $codechars[$num%32];
1222     }
1223     return $code;
1224 }
1225
1226 // convert markup to HTML
1227
1228 function common_markup_to_html($c)
1229 {
1230     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1231     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1232     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1233     return Markdown($c);
1234 }
1235
1236 function common_profile_uri($profile)
1237 {
1238     if (!$profile) {
1239         return null;
1240     }
1241     $user = User::staticGet($profile->id);
1242     if ($user) {
1243         return $user->uri;
1244     }
1245
1246     $remote = Remote_profile::staticGet($profile->id);
1247     if ($remote) {
1248         return $remote->uri;
1249     }
1250     // XXX: this is a very bad profile!
1251     return null;
1252 }
1253
1254 function common_canonical_sms($sms)
1255 {
1256     // strip non-digits
1257     preg_replace('/\D/', '', $sms);
1258     return $sms;
1259 }
1260
1261 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1262 {
1263     switch ($errno) {
1264      case E_USER_ERROR:
1265         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1266         exit(1);
1267         break;
1268
1269      case E_USER_WARNING:
1270         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1271         break;
1272
1273      case E_USER_NOTICE:
1274         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1275         break;
1276     }
1277
1278     // FIXME: show error page if we're on the Web
1279     /* Don't execute PHP internal error handler */
1280     return true;
1281 }
1282
1283 function common_session_token()
1284 {
1285     common_ensure_session();
1286     if (!array_key_exists('token', $_SESSION)) {
1287         $_SESSION['token'] = common_good_rand(64);
1288     }
1289     return $_SESSION['token'];
1290 }
1291
1292 function common_cache_key($extra)
1293 {
1294     return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1295 }
1296
1297 function common_keyize($str)
1298 {
1299     $str = strtolower($str);
1300     $str = preg_replace('/\s/', '_', $str);
1301     return $str;
1302 }
1303
1304 function common_memcache()
1305 {
1306     static $cache = null;
1307     if (!common_config('memcached', 'enabled')) {
1308         return null;
1309     } else {
1310         if (!$cache) {
1311             $cache = new Memcache();
1312             $servers = common_config('memcached', 'server');
1313             if (is_array($servers)) {
1314                 foreach($servers as $server) {
1315                     $cache->addServer($server);
1316                 }
1317             } else {
1318                 $cache->addServer($servers);
1319             }
1320         }
1321         return $cache;
1322     }
1323 }
1324
1325 function common_compatible_license($from, $to)
1326 {
1327     // XXX: better compatibility check needed here!
1328     return ($from == $to);
1329 }