]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/util.php
don't over specialize URLs
[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     // It comes in special'd, so we unspecial it before passing to the stringifying
476     // functions
477     $url = htmlspecialchars_decode($url);
478     $display = $url;
479     $url = (!preg_match('#^([a-z]+://|(mailto|aim|tel):)#i', $url)) ? 'http://'.$url : $url;
480
481     $attrs = array('href' => $url, 'rel' => 'external');
482
483     if ($longurl = common_longurl($url)) {
484         $attrs['title'] = $longurl;
485     }
486
487     return XMLStringer::estring('a', $attrs, $display);
488 }
489
490 function common_longurl($short_url)
491 {
492     $long_url = common_shorten_link($short_url, true);
493     if ($long_url === $short_url) return false;
494     return $long_url;
495 }
496
497 function common_longurl2($uri)
498 {
499     $uri_e = urlencode($uri);
500     $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
501     if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
502     return stripslashes($longurl['long_url']);
503 }
504
505 function common_shorten_links($text)
506 {
507     if (mb_strlen($text) <= 140) return $text;
508     static $cache = array();
509     if (isset($cache[$text])) return $cache[$text];
510     // \s = not a horizontal whitespace character (since PHP 5.2.4)
511     return $cache[$text] = common_replace_urls_callback($text, 'common_shorten_link');;
512 }
513
514 function common_shorten_link($url, $reverse = false)
515 {
516     static $url_cache = array();
517     if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
518
519     $user = common_current_user();
520
521     $curlh = curl_init();
522     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
523     curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
524     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
525
526     switch($user->urlshorteningservice) {
527      case 'ur1.ca':
528         $short_url_service = new LilUrl;
529         $short_url = $short_url_service->shorten($url);
530         break;
531
532      case '2tu.us':
533         $short_url_service = new TightUrl;
534         $short_url = $short_url_service->shorten($url);
535         break;
536
537      case 'ptiturl.com':
538         $short_url_service = new PtitUrl;
539         $short_url = $short_url_service->shorten($url);
540         break;
541
542      case 'bit.ly':
543         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
544         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
545         break;
546
547      case 'is.gd':
548         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
549         $short_url = curl_exec($curlh);
550         break;
551      case 'snipr.com':
552         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
553         $short_url = curl_exec($curlh);
554         break;
555      case 'metamark.net':
556         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
557         $short_url = curl_exec($curlh);
558         break;
559      case 'tinyurl.com':
560         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
561         $short_url = curl_exec($curlh);
562         break;
563      default:
564         $short_url = false;
565     }
566
567     curl_close($curlh);
568
569     if ($short_url) {
570         $url_cache[(string)$short_url] = $url;
571         return (string)$short_url;
572     }
573     return $url;
574 }
575
576 function common_xml_safe_str($str)
577 {
578     $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
579
580     // Replace control, formatting, and surrogate characters with '*', ala Twitter
581     return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
582 }
583
584 function common_tag_link($tag)
585 {
586     $canonical = common_canonical_tag($tag);
587     $url = common_local_url('tag', array('tag' => $canonical));
588     $xs = new XMLStringer();
589     $xs->elementStart('span', 'tag');
590     $xs->element('a', array('href' => $url,
591                             'rel' => 'tag'),
592                  $tag);
593     $xs->elementEnd();
594     return $xs->getString();
595 }
596
597 function common_canonical_tag($tag)
598 {
599     return strtolower(str_replace(array('-', '_', '.'), '', $tag));
600 }
601
602 function common_valid_profile_tag($str)
603 {
604     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
605 }
606
607 function common_at_link($sender_id, $nickname)
608 {
609     $sender = Profile::staticGet($sender_id);
610     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
611     if ($recipient) {
612         $xs = new XMLStringer(false);
613         $xs->elementStart('span', 'vcard');
614         $xs->elementStart('a', array('href' => $recipient->profileurl,
615                                      'class' => 'url'));
616         $xs->element('span', 'fn nickname', $nickname);
617         $xs->elementEnd('a');
618         $xs->elementEnd('span');
619         return $xs->getString();
620     } else {
621         return $nickname;
622     }
623 }
624
625 function common_group_link($sender_id, $nickname)
626 {
627     $sender = Profile::staticGet($sender_id);
628     $group = User_group::staticGet('nickname', common_canonical_nickname($nickname));
629     if ($group && $sender->isMember($group)) {
630         $xs = new XMLStringer();
631         $xs->elementStart('span', 'vcard');
632         $xs->elementStart('a', array('href' => $group->permalink(),
633                                      'class' => 'url'));
634         $xs->element('span', 'fn nickname', $nickname);
635         $xs->elementEnd('a');
636         $xs->elementEnd('span');
637         return $xs->getString();
638     } else {
639         return $nickname;
640     }
641 }
642
643 function common_at_hash_link($sender_id, $tag)
644 {
645     $user = User::staticGet($sender_id);
646     if (!$user) {
647         return $tag;
648     }
649     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
650     if ($tagged) {
651         $url = common_local_url('subscriptions',
652                                 array('nickname' => $user->nickname,
653                                       'tag' => $tag));
654         $xs = new XMLStringer();
655         $xs->elementStart('span', 'tag');
656         $xs->element('a', array('href' => $url,
657                                 'rel' => $tag),
658                      $tag);
659         $xs->elementEnd('span');
660         return $xs->getString();
661     } else {
662         return $tag;
663     }
664 }
665
666 function common_relative_profile($sender, $nickname, $dt=null)
667 {
668     // Try to find profiles this profile is subscribed to that have this nickname
669     $recipient = new Profile();
670     // XXX: use a join instead of a subquery
671     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
672     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
673     if ($recipient->find(true)) {
674         // XXX: should probably differentiate between profiles with
675         // the same name by date of most recent update
676         return $recipient;
677     }
678     // Try to find profiles that listen to this profile and that have this nickname
679     $recipient = new Profile();
680     // XXX: use a join instead of a subquery
681     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
682     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
683     if ($recipient->find(true)) {
684         // XXX: should probably differentiate between profiles with
685         // the same name by date of most recent update
686         return $recipient;
687     }
688     // If this is a local user, try to find a local user with that nickname.
689     $sender = User::staticGet($sender->id);
690     if ($sender) {
691         $recipient_user = User::staticGet('nickname', $nickname);
692         if ($recipient_user) {
693             return $recipient_user->getProfile();
694         }
695     }
696     // Otherwise, no links. @messages from local users to remote users,
697     // or from remote users to other remote users, are just
698     // outside our ability to make intelligent guesses about
699     return null;
700 }
701
702 function common_local_url($action, $args=null, $fragment=null)
703 {
704     common_debug("Action = $action, args = " . (($args) ? '(' . implode($args, ',') . ')' : $args) . ", fragment = $fragment");
705     $r = Router::get();
706     $start = microtime();
707     $path = $r->build($action, $args, $fragment);
708     $end = microtime();
709     common_debug("Pathbuilding took " . ($end - $start));
710     if ($path) {
711     }
712     if (common_config('site','fancy')) {
713         $url = common_path(mb_substr($path, 1));
714     } else {
715         $url = common_path('index.php'.$path);
716     }
717     return $url;
718 }
719
720 function common_path($relative)
721 {
722     global $config;
723     $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
724     return "http://".$config['site']['server'].'/'.$pathpart.$relative;
725 }
726
727 function common_date_string($dt)
728 {
729     // XXX: do some sexy date formatting
730     // return date(DATE_RFC822, $dt);
731     $t = strtotime($dt);
732     $now = time();
733     $diff = $now - $t;
734
735     if ($now < $t) { // that shouldn't happen!
736         return common_exact_date($dt);
737     } else if ($diff < 60) {
738         return _('a few seconds ago');
739     } else if ($diff < 92) {
740         return _('about a minute ago');
741     } else if ($diff < 3300) {
742         return sprintf(_('about %d minutes ago'), round($diff/60));
743     } else if ($diff < 5400) {
744         return _('about an hour ago');
745     } else if ($diff < 22 * 3600) {
746         return sprintf(_('about %d hours ago'), round($diff/3600));
747     } else if ($diff < 37 * 3600) {
748         return _('about a day ago');
749     } else if ($diff < 24 * 24 * 3600) {
750         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
751     } else if ($diff < 46 * 24 * 3600) {
752         return _('about a month ago');
753     } else if ($diff < 330 * 24 * 3600) {
754         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
755     } else if ($diff < 480 * 24 * 3600) {
756         return _('about a year ago');
757     } else {
758         return common_exact_date($dt);
759     }
760 }
761
762 function common_exact_date($dt)
763 {
764     static $_utc;
765     static $_siteTz;
766
767     if (!$_utc) {
768         $_utc = new DateTimeZone('UTC');
769         $_siteTz = new DateTimeZone(common_timezone());
770     }
771
772     $dateStr = date('d F Y H:i:s', strtotime($dt));
773     $d = new DateTime($dateStr, $_utc);
774     $d->setTimezone($_siteTz);
775     return $d->format(DATE_RFC850);
776 }
777
778 function common_date_w3dtf($dt)
779 {
780     $dateStr = date('d F Y H:i:s', strtotime($dt));
781     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
782     $d->setTimezone(new DateTimeZone(common_timezone()));
783     return $d->format(DATE_W3C);
784 }
785
786 function common_date_rfc2822($dt)
787 {
788     $dateStr = date('d F Y H:i:s', strtotime($dt));
789     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
790     $d->setTimezone(new DateTimeZone(common_timezone()));
791     return $d->format('r');
792 }
793
794 function common_date_iso8601($dt)
795 {
796     $dateStr = date('d F Y H:i:s', strtotime($dt));
797     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
798     $d->setTimezone(new DateTimeZone(common_timezone()));
799     return $d->format('c');
800 }
801
802 function common_sql_now()
803 {
804     return strftime('%Y-%m-%d %H:%M:%S', time());
805 }
806
807 function common_redirect($url, $code=307)
808 {
809     static $status = array(301 => "Moved Permanently",
810                            302 => "Found",
811                            303 => "See Other",
812                            307 => "Temporary Redirect");
813
814     header("Status: ${code} $status[$code]");
815     header("Location: $url");
816
817     $xo = new XMLOutputter();
818     $xo->startXML('a',
819                   '-//W3C//DTD XHTML 1.0 Strict//EN',
820                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
821     $xo->element('a', array('href' => $url), $url);
822     $xo->endXML();
823     exit;
824 }
825
826 function common_broadcast_notice($notice, $remote=false)
827 {
828
829     // Check to see if notice should go to Twitter
830     $flink = Foreign_link::getByUserID($notice->profile_id, 1); // 1 == Twitter
831     if (($flink->noticesync & FOREIGN_NOTICE_SEND) == FOREIGN_NOTICE_SEND) {
832
833         // If it's not a Twitter-style reply, or if the user WANTS to send replies...
834
835         if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
836             (($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) == FOREIGN_NOTICE_SEND_REPLY)) {
837
838             $result = common_twitter_broadcast($notice, $flink);
839
840             if (!$result) {
841                 common_debug('Unable to send notice: ' . $notice->id . ' to Twitter.', __FILE__);
842             }
843         }
844     }
845
846     if (common_config('queue', 'enabled')) {
847         // Do it later!
848         return common_enqueue_notice($notice);
849     } else {
850         return common_real_broadcast($notice, $remote);
851     }
852 }
853
854 function common_twitter_broadcast($notice, $flink)
855 {
856     global $config;
857     $success = true;
858     $fuser = $flink->getForeignUser();
859     $twitter_user = $fuser->nickname;
860     $twitter_password = $flink->credentials;
861     $uri = 'http://www.twitter.com/statuses/update.json';
862
863     // XXX: Hack to get around PHP cURL's use of @ being a a meta character
864     $statustxt = preg_replace('/^@/', ' @', $notice->content);
865
866     $options = array(
867                      CURLOPT_USERPWD         => "$twitter_user:$twitter_password",
868                      CURLOPT_POST            => true,
869                      CURLOPT_POSTFIELDS        => array(
870                                                         'status'    => $statustxt,
871                                                         'source'    => $config['integration']['source']
872                                                         ),
873                      CURLOPT_RETURNTRANSFER    => true,
874                      CURLOPT_FAILONERROR        => true,
875                      CURLOPT_HEADER            => false,
876                      CURLOPT_FOLLOWLOCATION    => true,
877                      CURLOPT_USERAGENT        => "Laconica",
878                      CURLOPT_CONNECTTIMEOUT    => 120,  // XXX: Scary!!!! How long should this be?
879                      CURLOPT_TIMEOUT            => 120,
880
881                      # Twitter is strict about accepting invalid "Expect" headers
882                      CURLOPT_HTTPHEADER => array('Expect:')
883                      );
884
885     $ch = curl_init($uri);
886     curl_setopt_array($ch, $options);
887     $data = curl_exec($ch);
888     $errmsg = curl_error($ch);
889
890     if ($errmsg) {
891         common_debug("cURL error: $errmsg - trying to send notice for $twitter_user.",
892                      __FILE__);
893         $success = false;
894     }
895
896     curl_close($ch);
897
898     if (!$data) {
899         common_debug("No data returned by Twitter's API trying to send update for $twitter_user",
900                      __FILE__);
901         $success = false;
902     }
903
904     // Twitter should return a status
905     $status = json_decode($data);
906
907     if (!$status->id) {
908         common_debug("Unexpected data returned by Twitter API trying to send update for $twitter_user",
909                      __FILE__);
910         $success = false;
911     }
912
913     return $success;
914 }
915
916 // Stick the notice on the queue
917
918 function common_enqueue_notice($notice)
919 {
920     foreach (array('jabber', 'omb', 'sms', 'public') as $transport) {
921         $qi = new Queue_item();
922         $qi->notice_id = $notice->id;
923         $qi->transport = $transport;
924         $qi->created = $notice->created;
925         $result = $qi->insert();
926         if (!$result) {
927             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
928             common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
929             return false;
930         }
931         common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
932     }
933     return $result;
934 }
935
936 function common_real_broadcast($notice, $remote=false)
937 {
938     $success = true;
939     if (!$remote) {
940         // Make sure we have the OMB stuff
941         require_once(INSTALLDIR.'/lib/omb.php');
942         $success = omb_broadcast_remote_subscribers($notice);
943         if (!$success) {
944             common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
945         }
946     }
947     if ($success) {
948         require_once(INSTALLDIR.'/lib/jabber.php');
949         $success = jabber_broadcast_notice($notice);
950         if (!$success) {
951             common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
952         }
953     }
954     if ($success) {
955         require_once(INSTALLDIR.'/lib/mail.php');
956         $success = mail_broadcast_notice_sms($notice);
957         if (!$success) {
958             common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
959         }
960     }
961     if ($success) {
962         $success = jabber_public_notice($notice);
963         if (!$success) {
964             common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
965         }
966     }
967     // XXX: broadcast notices to other IM
968     return $success;
969 }
970
971 function common_broadcast_profile($profile)
972 {
973     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
974     require_once(INSTALLDIR.'/lib/omb.php');
975     omb_broadcast_profile($profile);
976     // XXX: Other broadcasts...?
977     return true;
978 }
979
980 function common_profile_url($nickname)
981 {
982     return common_local_url('showstream', array('nickname' => $nickname));
983 }
984
985 // Should make up a reasonable root URL
986
987 function common_root_url()
988 {
989     return common_path('');
990 }
991
992 // returns $bytes bytes of random data as a hexadecimal string
993 // "good" here is a goal and not a guarantee
994
995 function common_good_rand($bytes)
996 {
997     // XXX: use random.org...?
998     if (file_exists('/dev/urandom')) {
999         return common_urandom($bytes);
1000     } else { // FIXME: this is probably not good enough
1001         return common_mtrand($bytes);
1002     }
1003 }
1004
1005 function common_urandom($bytes)
1006 {
1007     $h = fopen('/dev/urandom', 'rb');
1008     // should not block
1009     $src = fread($h, $bytes);
1010     fclose($h);
1011     $enc = '';
1012     for ($i = 0; $i < $bytes; $i++) {
1013         $enc .= sprintf("%02x", (ord($src[$i])));
1014     }
1015     return $enc;
1016 }
1017
1018 function common_mtrand($bytes)
1019 {
1020     $enc = '';
1021     for ($i = 0; $i < $bytes; $i++) {
1022         $enc .= sprintf("%02x", mt_rand(0, 255));
1023     }
1024     return $enc;
1025 }
1026
1027 function common_set_returnto($url)
1028 {
1029     common_ensure_session();
1030     $_SESSION['returnto'] = $url;
1031 }
1032
1033 function common_get_returnto()
1034 {
1035     common_ensure_session();
1036     return $_SESSION['returnto'];
1037 }
1038
1039 function common_timestamp()
1040 {
1041     return date('YmdHis');
1042 }
1043
1044 function common_ensure_syslog()
1045 {
1046     static $initialized = false;
1047     if (!$initialized) {
1048         global $config;
1049         openlog($config['syslog']['appname'], 0, LOG_USER);
1050         $initialized = true;
1051     }
1052 }
1053
1054 function common_log($priority, $msg, $filename=null)
1055 {
1056     $logfile = common_config('site', 'logfile');
1057     if ($logfile) {
1058         $log = fopen($logfile, "a");
1059         if ($log) {
1060             static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1061                                               'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1062             $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1063             fwrite($log, $output);
1064             fclose($log);
1065         }
1066     } else {
1067         common_ensure_syslog();
1068         syslog($priority, $msg);
1069     }
1070 }
1071
1072 function common_debug($msg, $filename=null)
1073 {
1074     if ($filename) {
1075         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1076     } else {
1077         common_log(LOG_DEBUG, $msg);
1078     }
1079 }
1080
1081 function common_log_db_error(&$object, $verb, $filename=null)
1082 {
1083     $objstr = common_log_objstring($object);
1084     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1085     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1086 }
1087
1088 function common_log_objstring(&$object)
1089 {
1090     if (is_null($object)) {
1091         return "null";
1092     }
1093     $arr = $object->toArray();
1094     $fields = array();
1095     foreach ($arr as $k => $v) {
1096         $fields[] = "$k='$v'";
1097     }
1098     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1099     return $objstring;
1100 }
1101
1102 function common_valid_http_url($url)
1103 {
1104     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1105 }
1106
1107 function common_valid_tag($tag)
1108 {
1109     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1110         return (Validate::email($matches[1]) ||
1111                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1112     }
1113     return false;
1114 }
1115
1116 /* Following functions are copied from MediaWiki GlobalFunctions.php
1117  * and written by Evan Prodromou. */
1118
1119 function common_accept_to_prefs($accept, $def = '*/*')
1120 {
1121     // No arg means accept anything (per HTTP spec)
1122     if(!$accept) {
1123         return array($def => 1);
1124     }
1125
1126     $prefs = array();
1127
1128     $parts = explode(',', $accept);
1129
1130     foreach($parts as $part) {
1131         // FIXME: doesn't deal with params like 'text/html; level=1'
1132         @list($value, $qpart) = explode(';', $part);
1133         $match = array();
1134         if(!isset($qpart)) {
1135             $prefs[$value] = 1;
1136         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1137             $prefs[$value] = $match[1];
1138         }
1139     }
1140
1141     return $prefs;
1142 }
1143
1144 function common_mime_type_match($type, $avail)
1145 {
1146     if(array_key_exists($type, $avail)) {
1147         return $type;
1148     } else {
1149         $parts = explode('/', $type);
1150         if(array_key_exists($parts[0] . '/*', $avail)) {
1151             return $parts[0] . '/*';
1152         } elseif(array_key_exists('*/*', $avail)) {
1153             return '*/*';
1154         } else {
1155             return null;
1156         }
1157     }
1158 }
1159
1160 function common_negotiate_type($cprefs, $sprefs)
1161 {
1162     $combine = array();
1163
1164     foreach(array_keys($sprefs) as $type) {
1165         $parts = explode('/', $type);
1166         if($parts[1] != '*') {
1167             $ckey = common_mime_type_match($type, $cprefs);
1168             if($ckey) {
1169                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1170             }
1171         }
1172     }
1173
1174     foreach(array_keys($cprefs) as $type) {
1175         $parts = explode('/', $type);
1176         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1177             $skey = common_mime_type_match($type, $sprefs);
1178             if($skey) {
1179                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1180             }
1181         }
1182     }
1183
1184     $bestq = 0;
1185     $besttype = 'text/html';
1186
1187     foreach(array_keys($combine) as $type) {
1188         if($combine[$type] > $bestq) {
1189             $besttype = $type;
1190             $bestq = $combine[$type];
1191         }
1192     }
1193
1194     if ('text/html' === $besttype) {
1195         return "text/html; charset=utf-8";
1196     }
1197     return $besttype;
1198 }
1199
1200 function common_config($main, $sub)
1201 {
1202     global $config;
1203     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1204 }
1205
1206 function common_copy_args($from)
1207 {
1208     $to = array();
1209     $strip = get_magic_quotes_gpc();
1210     foreach ($from as $k => $v) {
1211         $to[$k] = ($strip) ? stripslashes($v) : $v;
1212     }
1213     return $to;
1214 }
1215
1216 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1217 // This is used before handing a request off to OAuthRequest::from_request.
1218 function common_remove_magic_from_request()
1219 {
1220     if(get_magic_quotes_gpc()) {
1221         $_POST=array_map('stripslashes',$_POST);
1222         $_GET=array_map('stripslashes',$_GET);
1223     }
1224 }
1225
1226 function common_user_uri(&$user)
1227 {
1228     return common_local_url('userbyid', array('id' => $user->id));
1229 }
1230
1231 function common_notice_uri(&$notice)
1232 {
1233     return common_local_url('shownotice',
1234                             array('notice' => $notice->id));
1235 }
1236
1237 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1238
1239 function common_confirmation_code($bits)
1240 {
1241     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1242     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1243     $chars = ceil($bits/5);
1244     $code = '';
1245     for ($i = 0; $i < $chars; $i++) {
1246         // XXX: convert to string and back
1247         $num = hexdec(common_good_rand(1));
1248         // XXX: randomness is too precious to throw away almost
1249         // 40% of the bits we get!
1250         $code .= $codechars[$num%32];
1251     }
1252     return $code;
1253 }
1254
1255 // convert markup to HTML
1256
1257 function common_markup_to_html($c)
1258 {
1259     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1260     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1261     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1262     return Markdown($c);
1263 }
1264
1265 function common_profile_uri($profile)
1266 {
1267     if (!$profile) {
1268         return null;
1269     }
1270     $user = User::staticGet($profile->id);
1271     if ($user) {
1272         return $user->uri;
1273     }
1274
1275     $remote = Remote_profile::staticGet($profile->id);
1276     if ($remote) {
1277         return $remote->uri;
1278     }
1279     // XXX: this is a very bad profile!
1280     return null;
1281 }
1282
1283 function common_canonical_sms($sms)
1284 {
1285     // strip non-digits
1286     preg_replace('/\D/', '', $sms);
1287     return $sms;
1288 }
1289
1290 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1291 {
1292     switch ($errno) {
1293      case E_USER_ERROR:
1294         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1295         exit(1);
1296         break;
1297
1298      case E_USER_WARNING:
1299         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1300         break;
1301
1302      case E_USER_NOTICE:
1303         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1304         break;
1305     }
1306
1307     // FIXME: show error page if we're on the Web
1308     /* Don't execute PHP internal error handler */
1309     return true;
1310 }
1311
1312 function common_session_token()
1313 {
1314     common_ensure_session();
1315     if (!array_key_exists('token', $_SESSION)) {
1316         $_SESSION['token'] = common_good_rand(64);
1317     }
1318     return $_SESSION['token'];
1319 }
1320
1321 function common_cache_key($extra)
1322 {
1323     return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1324 }
1325
1326 function common_keyize($str)
1327 {
1328     $str = strtolower($str);
1329     $str = preg_replace('/\s/', '_', $str);
1330     return $str;
1331 }
1332
1333 function common_memcache()
1334 {
1335     static $cache = null;
1336     if (!common_config('memcached', 'enabled')) {
1337         return null;
1338     } else {
1339         if (!$cache) {
1340             $cache = new Memcache();
1341             $servers = common_config('memcached', 'server');
1342             if (is_array($servers)) {
1343                 foreach($servers as $server) {
1344                     $cache->addServer($server);
1345                 }
1346             } else {
1347                 $cache->addServer($servers);
1348             }
1349         }
1350         return $cache;
1351     }
1352 }
1353
1354 function common_compatible_license($from, $to)
1355 {
1356     // XXX: better compatibility check needed here!
1357     return ($from == $to);
1358 }