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