]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/util.php
3690f0ad543bd4f9bcd01a0e7833c9622dcd3fda
[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 define('URL_REGEX', '^|[ \t\r\n])((ftp|http|https|gopher|mailto|news|nntp|telnet|wais|file|prospero|aim|webcal):(([A-Za-z0-9$_.+!*(),;/?:@&~=-])|%[A-Fa-f0-9]{2}){2,}(#([a-zA-Z0-9][a-zA-Z0-9$_.+!*(),;/?:@&~=%-]*))?([A-Za-z0-9$_+!*();/?:~-]))');
374
375 function common_render_content($text, $notice)
376 {
377     $r = common_render_text($text);
378     $id = $notice->profile_id;
379     $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
380     $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
381     $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
382     $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
383     return $r;
384 }
385
386 function common_render_text($text)
387 {
388     $r = htmlspecialchars($text);
389
390     $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
391     $r = preg_replace_callback('@https?://[^\]>\s]+@', 'common_render_uri_thingy', $r);
392     $r = preg_replace('/(^|\s+)#([A-Za-z0-9_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
393     // XXX: machine tags
394     return $r;
395 }
396
397 function common_render_uri_thingy($matches)
398 {
399     $uri = $matches[0];
400     $trailer = '';
401
402     // Some heuristics for extracting URIs from surrounding punctuation
403     // Strip from trailing text...
404     if (preg_match('/^(.*)([,.:"\']+)$/', $uri, $matches)) {
405         $uri = $matches[1];
406         $trailer = $matches[2];
407     }
408
409     $pairs = array(
410                    ']' => '[', // technically disallowed in URIs, but used in Java docs
411                    ')' => '(', // far too frequent in Wikipedia and MSDN
412                    );
413     $final = substr($uri, -1, 1);
414     if (isset($pairs[$final])) {
415         $openers = substr_count($uri, $pairs[$final]);
416         $closers = substr_count($uri, $final);
417         if ($closers > $openers) {
418             // Assume the paren was opened outside the URI
419             $uri = substr($uri, 0, -1);
420             $trailer = $final . $trailer;
421         }
422     }
423     if ($longurl = common_longurl($uri)) {
424         $longurl = htmlentities($longurl, ENT_QUOTES, 'UTF-8');
425         $title = " title='$longurl'";
426     }
427     else $title = '';
428
429     return '<a href="' . $uri . '"' . $title . ' class="extlink">' . $uri . '</a>' . $trailer;
430 }
431
432 function common_longurl($short_url)
433 {
434     $long_url = common_shorten_link($short_url, true);
435     if ($long_url === $short_url) return false;
436     return $long_url;
437 }
438
439 function common_longurl2($uri)
440 {
441     $uri_e = urlencode($uri);
442     $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
443     if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
444     return stripslashes($longurl['long_url']);
445 }
446
447 function common_shorten_links($text)
448 {
449     if (mb_strlen($text) <= 140) return $text;
450     static $cache = array();
451     if (isset($cache[$text])) return $cache[$text];
452     // \s = not a horizontal whitespace character (since PHP 5.2.4)
453     return $cache[$text] = preg_replace('@https?://[^)\]>\s]+@e', "common_shorten_link('\\0')", $text);
454 }
455
456 function common_shorten_link($url, $reverse = false)
457 {
458     static $url_cache = array();
459     if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
460
461     $user = common_current_user();
462
463     $curlh = curl_init();
464     curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
465     curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
466     curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
467
468     switch($user->urlshorteningservice) {
469      case 'ur1.ca':
470         $short_url_service = new LilUrl;
471         $short_url = $short_url_service->shorten($url);
472         break;
473
474      case '2tu.us':
475         $short_url_service = new TightUrl;
476         $short_url = $short_url_service->shorten($url);
477         break;
478
479      case 'ptiturl.com':
480         $short_url_service = new PtitUrl;
481         $short_url = $short_url_service->shorten($url);
482         break;
483
484      case 'bit.ly':
485         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
486         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
487         break;
488
489      case 'is.gd':
490         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
491         $short_url = curl_exec($curlh);
492         break;
493      case 'snipr.com':
494         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
495         $short_url = curl_exec($curlh);
496         break;
497      case 'metamark.net':
498         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
499         $short_url = curl_exec($curlh);
500         break;
501      case 'tinyurl.com':
502         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
503         $short_url = curl_exec($curlh);
504         break;
505      default:
506         $short_url = false;
507     }
508
509     curl_close($curlh);
510
511     if ($short_url) {
512         $url_cache[(string)$short_url] = $url;
513         return (string)$short_url;
514     }
515     return $url;
516 }
517
518 function common_xml_safe_str($str)
519 {
520     $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
521
522     // Replace control, formatting, and surrogate characters with '*', ala Twitter
523     return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
524 }
525
526 function common_tag_link($tag)
527 {
528     $canonical = common_canonical_tag($tag);
529     $url = common_local_url('tag', array('tag' => $canonical));
530     return '<span class="tag"><a href="' . htmlspecialchars($url) . '" rel="tag">' . htmlspecialchars($tag) . '</a></span>';
531 }
532
533 function common_canonical_tag($tag)
534 {
535     return strtolower(str_replace(array('-', '_', '.'), '', $tag));
536 }
537
538 function common_valid_profile_tag($str)
539 {
540     return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
541 }
542
543 function common_at_link($sender_id, $nickname)
544 {
545     $sender = Profile::staticGet($sender_id);
546     $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
547     if ($recipient) {
548         return '<span class="vcard"><a href="'.htmlspecialchars($recipient->profileurl).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
549     } else {
550         return $nickname;
551     }
552 }
553
554 function common_group_link($sender_id, $nickname)
555 {
556     $sender = Profile::staticGet($sender_id);
557     $group = User_group::staticGet('nickname', common_canonical_nickname($nickname));
558     if ($group && $sender->isMember($group)) {
559         return '<span class="vcard"><a href="'.htmlspecialchars($group->permalink()).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
560     } else {
561         return $nickname;
562     }
563 }
564
565 function common_at_hash_link($sender_id, $tag)
566 {
567     $user = User::staticGet($sender_id);
568     if (!$user) {
569         return $tag;
570     }
571     $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
572     if ($tagged) {
573         $url = common_local_url('subscriptions',
574                                 array('nickname' => $user->nickname,
575                                       'tag' => $tag));
576         return '<span class="tag"><a href="'.htmlspecialchars($url).'" rel="tag">'.$tag.'</a></span>';
577     } else {
578         return $tag;
579     }
580 }
581
582 function common_relative_profile($sender, $nickname, $dt=null)
583 {
584     // Try to find profiles this profile is subscribed to that have this nickname
585     $recipient = new Profile();
586     // XXX: use a join instead of a subquery
587     $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
588     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
589     if ($recipient->find(true)) {
590         // XXX: should probably differentiate between profiles with
591         // the same name by date of most recent update
592         return $recipient;
593     }
594     // Try to find profiles that listen to this profile and that have this nickname
595     $recipient = new Profile();
596     // XXX: use a join instead of a subquery
597     $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
598     $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
599     if ($recipient->find(true)) {
600         // XXX: should probably differentiate between profiles with
601         // the same name by date of most recent update
602         return $recipient;
603     }
604     // If this is a local user, try to find a local user with that nickname.
605     $sender = User::staticGet($sender->id);
606     if ($sender) {
607         $recipient_user = User::staticGet('nickname', $nickname);
608         if ($recipient_user) {
609             return $recipient_user->getProfile();
610         }
611     }
612     // Otherwise, no links. @messages from local users to remote users,
613     // or from remote users to other remote users, are just
614     // outside our ability to make intelligent guesses about
615     return null;
616 }
617
618 // where should the avatar go for this user?
619
620 function common_avatar_filename($id, $extension, $size=null, $extra=null)
621 {
622     global $config;
623
624     if ($size) {
625         return $id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
626     } else {
627         return $id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
628     }
629 }
630
631 function common_avatar_path($filename)
632 {
633     global $config;
634     return INSTALLDIR . '/avatar/' . $filename;
635 }
636
637 function common_avatar_url($filename)
638 {
639     return common_path('avatar/'.$filename);
640 }
641
642 function common_avatar_display_url($avatar)
643 {
644     $server = common_config('avatar', 'server');
645     if ($server) {
646         return 'http://'.$server.'/'.$avatar->filename;
647     } else {
648         return $avatar->url;
649     }
650 }
651
652 function common_default_avatar($size)
653 {
654     static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
655                               AVATAR_STREAM_SIZE => 'stream',
656                               AVATAR_MINI_SIZE => 'mini');
657     return theme_path('default-avatar-'.$sizenames[$size].'.png');
658 }
659
660 function common_local_url($action, $args=null, $fragment=null)
661 {
662     $url = null;
663     if (common_config('site','fancy')) {
664         $url = common_fancy_url($action, $args);
665     } else {
666         $url = common_simple_url($action, $args);
667     }
668     if (!is_null($fragment)) {
669         $url .= '#'.$fragment;
670     }
671     return $url;
672 }
673
674 function common_fancy_url($action, $args=null)
675 {
676     switch (strtolower($action)) {
677      case 'public':
678         if ($args && isset($args['page'])) {
679             return common_path('?page=' . $args['page']);
680         } else {
681             return common_path('');
682         }
683      case 'featured':
684         if ($args && isset($args['page'])) {
685             return common_path('featured?page=' . $args['page']);
686         } else {
687             return common_path('featured');
688         }
689      case 'favorited':
690         if ($args && isset($args['page'])) {
691             return common_path('favorited?page=' . $args['page']);
692         } else {
693             return common_path('favorited');
694         }
695      case 'publicrss':
696         return common_path('rss');
697      case 'publicatom':
698         return common_path("api/statuses/public_timeline.atom");
699      case 'publicxrds':
700         return common_path('xrds');
701      case 'featuredrss':
702         return common_path('featuredrss');
703      case 'favoritedrss':
704         return common_path('favoritedrss');
705      case 'opensearch':
706         if ($args && $args['type']) {
707             return common_path('opensearch/'.$args['type']);
708         } else {
709             return common_path('opensearch/people');
710         }
711      case 'doc':
712         return common_path('doc/'.$args['title']);
713      case 'block':
714      case 'login':
715      case 'logout':
716      case 'subscribe':
717      case 'unsubscribe':
718      case 'invite':
719         return common_path('main/'.$action);
720      case 'tagother':
721         return common_path('main/tagother?id='.$args['id']);
722      case 'register':
723         if ($args && $args['code']) {
724             return common_path('main/register/'.$args['code']);
725         } else {
726             return common_path('main/register');
727         }
728      case 'remotesubscribe':
729         if ($args && $args['nickname']) {
730             return common_path('main/remote?nickname=' . $args['nickname']);
731         } else {
732             return common_path('main/remote');
733         }
734      case 'nudge':
735         return common_path($args['nickname'].'/nudge');
736      case 'openidlogin':
737         return common_path('main/openid');
738      case 'profilesettings':
739         return common_path('settings/profile');
740      case 'passwordsettings':
741         return common_path('settings/password');
742      case 'emailsettings':
743         return common_path('settings/email');
744      case 'openidsettings':
745         return common_path('settings/openid');
746      case 'smssettings':
747         return common_path('settings/sms');
748      case 'twittersettings':
749         return common_path('settings/twitter');
750      case 'othersettings':
751         return common_path('settings/other');
752      case 'deleteprofile':
753         return common_path('settings/delete');
754      case 'newnotice':
755         if ($args && $args['replyto']) {
756             return common_path('notice/new?replyto='.$args['replyto']);
757         } else {
758             return common_path('notice/new');
759         }
760      case 'shownotice':
761         return common_path('notice/'.$args['notice']);
762      case 'deletenotice':
763         if ($args && $args['notice']) {
764             return common_path('notice/delete/'.$args['notice']);
765         } else {
766             return common_path('notice/delete');
767         }
768      case 'microsummary':
769      case 'xrds':
770      case 'foaf':
771         return common_path($args['nickname'].'/'.$action);
772      case 'all':
773      case 'replies':
774      case 'inbox':
775      case 'outbox':
776         if ($args && isset($args['page'])) {
777             return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
778         } else {
779             return common_path($args['nickname'].'/'.$action);
780         }
781      case 'subscriptions':
782      case 'subscribers':
783         $nickname = $args['nickname'];
784         unset($args['nickname']);
785         if (isset($args['tag'])) {
786             $tag = $args['tag'];
787             unset($args['tag']);
788         }
789         $params = http_build_query($args);
790         if ($params) {
791             return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : '') . '?' . $params);
792         } else {
793             return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : ''));
794         }
795      case 'allrss':
796         return common_path($args['nickname'].'/all/rss');
797      case 'repliesrss':
798         return common_path($args['nickname'].'/replies/rss');
799      case 'userrss':
800         if (isset($args['limit']))
801           return common_path($args['nickname'].'/rss?limit=' . $args['limit']);
802         return common_path($args['nickname'].'/rss');
803      case 'showstream':
804         if ($args && isset($args['page'])) {
805             return common_path($args['nickname'].'?page=' . $args['page']);
806         } else {
807             return common_path($args['nickname']);
808         }
809
810      case 'usertimeline':
811         return common_path("api/statuses/user_timeline/".$args['nickname'].".atom");
812      case 'confirmaddress':
813         return common_path('main/confirmaddress/'.$args['code']);
814      case 'userbyid':
815         return common_path('user/'.$args['id']);
816      case 'recoverpassword':
817         $path = 'main/recoverpassword';
818         if ($args['code']) {
819             $path .= '/' . $args['code'];
820         }
821         return common_path($path);
822      case 'imsettings':
823         return common_path('settings/im');
824      case 'avatarsettings':
825         return common_path('settings/avatar');
826      case 'groupsearch':
827         return common_path('search/group' . (($args) ? ('?' . http_build_query($args)) : ''));
828      case 'peoplesearch':
829         return common_path('search/people' . (($args) ? ('?' . http_build_query($args)) : ''));
830      case 'noticesearch':
831         return common_path('search/notice' . (($args) ? ('?' . http_build_query($args)) : ''));
832      case 'noticesearchrss':
833         return common_path('search/notice/rss' . (($args) ? ('?' . http_build_query($args)) : ''));
834      case 'avatarbynickname':
835         return common_path($args['nickname'].'/avatar/'.$args['size']);
836      case 'tag':
837         $path = 'tag/' . $args['tag'];
838         unset($args['tag']);
839         return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
840      case 'publictagcloud':
841         return common_path('tags');
842      case 'peopletag':
843         $path = 'peopletag/' . $args['tag'];
844         unset($args['tag']);
845         return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
846      case 'tags':
847         return common_path('tags' . (($args) ? ('?' . http_build_query($args)) : ''));
848      case 'favor':
849         return common_path('main/favor');
850      case 'disfavor':
851         return common_path('main/disfavor');
852      case 'showfavorites':
853         if ($args && isset($args['page'])) {
854             return common_path($args['nickname'].'/favorites?page=' . $args['page']);
855         } else {
856             return common_path($args['nickname'].'/favorites');
857         }
858      case 'favoritesrss':
859         return common_path($args['nickname'].'/favorites/rss');
860      case 'showmessage':
861         return common_path('message/' . $args['message']);
862      case 'newmessage':
863         return common_path('message/new' . (($args) ? ('?' . http_build_query($args)) : ''));
864      case 'api':
865         // XXX: do fancy URLs for all the API methods
866         switch (strtolower($args['apiaction'])) {
867          case 'statuses':
868             switch (strtolower($args['method'])) {
869              case 'user_timeline.rss':
870                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.rss');
871              case 'user_timeline.atom':
872                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.atom');
873              case 'user_timeline.json':
874                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.json');
875              case 'user_timeline.xml':
876                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.xml');
877              default: return common_simple_url($action, $args);
878             }
879          default: return common_simple_url($action, $args);
880         }
881      case 'sup':
882         if ($args && isset($args['seconds'])) {
883             return common_path('main/sup?seconds='.$args['seconds']);
884         } else {
885             return common_path('main/sup');
886         }
887      case 'newgroup':
888         return common_path('group/new');
889      case 'showgroup':
890         return common_path('group/'.$args['nickname'] . (($args['page']) ? ('?page=' . $args['page']) : ''));
891      case 'editgroup':
892         return common_path('group/'.$args['nickname'].'/edit');
893      case 'joingroup':
894         return common_path('group/'.$args['nickname'].'/join');
895      case 'leavegroup':
896         return common_path('group/'.$args['nickname'].'/leave');
897      case 'groupbyid':
898         return common_path('group/'.$args['id'].'/id');
899      case 'grouprss':
900         return common_path('group/'.$args['nickname'].'/rss');
901      case 'groupmembers':
902         return common_path('group/'.$args['nickname'].'/members');
903      case 'grouplogo':
904         return common_path('group/'.$args['nickname'].'/logo');
905      case 'usergroups':
906         $nickname = $args['nickname'];
907         unset($args['nickname']);
908         return common_path($nickname.'/groups' . (($args) ? ('?' . http_build_query($args)) : ''));
909      case 'groups':
910         return common_path('group' . (($args) ? ('?' . http_build_query($args)) : ''));
911      default:
912         return common_simple_url($action, $args);
913     }
914 }
915
916 function common_simple_url($action, $args=null)
917 {
918     global $config;
919     /* XXX: pretty URLs */
920     $extra = '';
921     if ($args) {
922         foreach ($args as $key => $value) {
923             $extra .= "&${key}=${value}";
924         }
925     }
926     return common_path("index.php?action=${action}${extra}");
927 }
928
929 function common_path($relative)
930 {
931     global $config;
932     $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
933     return "http://".$config['site']['server'].'/'.$pathpart.$relative;
934 }
935
936 function common_date_string($dt)
937 {
938     // XXX: do some sexy date formatting
939     // return date(DATE_RFC822, $dt);
940     $t = strtotime($dt);
941     $now = time();
942     $diff = $now - $t;
943
944     if ($now < $t) { // that shouldn't happen!
945         return common_exact_date($dt);
946     } else if ($diff < 60) {
947         return _('a few seconds ago');
948     } else if ($diff < 92) {
949         return _('about a minute ago');
950     } else if ($diff < 3300) {
951         return sprintf(_('about %d minutes ago'), round($diff/60));
952     } else if ($diff < 5400) {
953         return _('about an hour ago');
954     } else if ($diff < 22 * 3600) {
955         return sprintf(_('about %d hours ago'), round($diff/3600));
956     } else if ($diff < 37 * 3600) {
957         return _('about a day ago');
958     } else if ($diff < 24 * 24 * 3600) {
959         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
960     } else if ($diff < 46 * 24 * 3600) {
961         return _('about a month ago');
962     } else if ($diff < 330 * 24 * 3600) {
963         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
964     } else if ($diff < 480 * 24 * 3600) {
965         return _('about a year ago');
966     } else {
967         return common_exact_date($dt);
968     }
969 }
970
971 function common_exact_date($dt)
972 {
973     static $_utc;
974     static $_siteTz;
975
976     if (!$_utc) {
977         $_utc = new DateTimeZone('UTC');
978         $_siteTz = new DateTimeZone(common_timezone());
979     }
980
981     $dateStr = date('d F Y H:i:s', strtotime($dt));
982     $d = new DateTime($dateStr, $_utc);
983     $d->setTimezone($_siteTz);
984     return $d->format(DATE_RFC850);
985 }
986
987 function common_date_w3dtf($dt)
988 {
989     $dateStr = date('d F Y H:i:s', strtotime($dt));
990     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
991     $d->setTimezone(new DateTimeZone(common_timezone()));
992     return $d->format(DATE_W3C);
993 }
994
995 function common_date_rfc2822($dt)
996 {
997     $dateStr = date('d F Y H:i:s', strtotime($dt));
998     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
999     $d->setTimezone(new DateTimeZone(common_timezone()));
1000     return $d->format('r');
1001 }
1002
1003 function common_date_iso8601($dt)
1004 {
1005     $dateStr = date('d F Y H:i:s', strtotime($dt));
1006     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1007     $d->setTimezone(new DateTimeZone(common_timezone()));
1008     return $d->format('c');
1009 }
1010
1011 function common_sql_now()
1012 {
1013     return strftime('%Y-%m-%d %H:%M:%S', time());
1014 }
1015
1016 function common_redirect($url, $code=307)
1017 {
1018     static $status = array(301 => "Moved Permanently",
1019                            302 => "Found",
1020                            303 => "See Other",
1021                            307 => "Temporary Redirect");
1022
1023     header("Status: ${code} $status[$code]");
1024     header("Location: $url");
1025
1026     $xo = new XMLOutputter();
1027     $xo->startXML('a',
1028                   '-//W3C//DTD XHTML 1.0 Strict//EN',
1029                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1030     $xo->element('a', array('href' => $url), $url);
1031     $xo->endXML();
1032     exit;
1033 }
1034
1035 function common_broadcast_notice($notice, $remote=false)
1036 {
1037
1038     // Check to see if notice should go to Twitter
1039     $flink = Foreign_link::getByUserID($notice->profile_id, 1); // 1 == Twitter
1040     if (($flink->noticesync & FOREIGN_NOTICE_SEND) == FOREIGN_NOTICE_SEND) {
1041
1042         // If it's not a Twitter-style reply, or if the user WANTS to send replies...
1043
1044         if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
1045             (($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) == FOREIGN_NOTICE_SEND_REPLY)) {
1046
1047             $result = common_twitter_broadcast($notice, $flink);
1048
1049             if (!$result) {
1050                 common_debug('Unable to send notice: ' . $notice->id . ' to Twitter.', __FILE__);
1051             }
1052         }
1053     }
1054
1055     if (common_config('queue', 'enabled')) {
1056         // Do it later!
1057         return common_enqueue_notice($notice);
1058     } else {
1059         return common_real_broadcast($notice, $remote);
1060     }
1061 }
1062
1063 function common_twitter_broadcast($notice, $flink)
1064 {
1065     global $config;
1066     $success = true;
1067     $fuser = $flink->getForeignUser();
1068     $twitter_user = $fuser->nickname;
1069     $twitter_password = $flink->credentials;
1070     $uri = 'http://www.twitter.com/statuses/update.json';
1071
1072     // XXX: Hack to get around PHP cURL's use of @ being a a meta character
1073     $statustxt = preg_replace('/^@/', ' @', $notice->content);
1074
1075     $options = array(
1076                      CURLOPT_USERPWD         => "$twitter_user:$twitter_password",
1077                      CURLOPT_POST            => true,
1078                      CURLOPT_POSTFIELDS        => array(
1079                                                         'status'    => $statustxt,
1080                                                         'source'    => $config['integration']['source']
1081                                                         ),
1082                      CURLOPT_RETURNTRANSFER    => true,
1083                      CURLOPT_FAILONERROR        => true,
1084                      CURLOPT_HEADER            => false,
1085                      CURLOPT_FOLLOWLOCATION    => true,
1086                      CURLOPT_USERAGENT        => "Laconica",
1087                      CURLOPT_CONNECTTIMEOUT    => 120,  // XXX: Scary!!!! How long should this be?
1088                      CURLOPT_TIMEOUT            => 120,
1089
1090                      # Twitter is strict about accepting invalid "Expect" headers
1091                      CURLOPT_HTTPHEADER => array('Expect:')
1092                      );
1093
1094     $ch = curl_init($uri);
1095     curl_setopt_array($ch, $options);
1096     $data = curl_exec($ch);
1097     $errmsg = curl_error($ch);
1098
1099     if ($errmsg) {
1100         common_debug("cURL error: $errmsg - trying to send notice for $twitter_user.",
1101                      __FILE__);
1102         $success = false;
1103     }
1104
1105     curl_close($ch);
1106
1107     if (!$data) {
1108         common_debug("No data returned by Twitter's API trying to send update for $twitter_user",
1109                      __FILE__);
1110         $success = false;
1111     }
1112
1113     // Twitter should return a status
1114     $status = json_decode($data);
1115
1116     if (!$status->id) {
1117         common_debug("Unexpected data returned by Twitter API trying to send update for $twitter_user",
1118                      __FILE__);
1119         $success = false;
1120     }
1121
1122     return $success;
1123 }
1124
1125 // Stick the notice on the queue
1126
1127 function common_enqueue_notice($notice)
1128 {
1129     foreach (array('jabber', 'omb', 'sms', 'public') as $transport) {
1130         $qi = new Queue_item();
1131         $qi->notice_id = $notice->id;
1132         $qi->transport = $transport;
1133         $qi->created = $notice->created;
1134         $result = $qi->insert();
1135         if (!$result) {
1136             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1137             common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
1138             return false;
1139         }
1140         common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
1141     }
1142     return $result;
1143 }
1144
1145 function common_real_broadcast($notice, $remote=false)
1146 {
1147     $success = true;
1148     if (!$remote) {
1149         // Make sure we have the OMB stuff
1150         require_once(INSTALLDIR.'/lib/omb.php');
1151         $success = omb_broadcast_remote_subscribers($notice);
1152         if (!$success) {
1153             common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
1154         }
1155     }
1156     if ($success) {
1157         require_once(INSTALLDIR.'/lib/jabber.php');
1158         $success = jabber_broadcast_notice($notice);
1159         if (!$success) {
1160             common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
1161         }
1162     }
1163     if ($success) {
1164         require_once(INSTALLDIR.'/lib/mail.php');
1165         $success = mail_broadcast_notice_sms($notice);
1166         if (!$success) {
1167             common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
1168         }
1169     }
1170     if ($success) {
1171         $success = jabber_public_notice($notice);
1172         if (!$success) {
1173             common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
1174         }
1175     }
1176     // XXX: broadcast notices to other IM
1177     return $success;
1178 }
1179
1180 function common_broadcast_profile($profile)
1181 {
1182     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1183     require_once(INSTALLDIR.'/lib/omb.php');
1184     omb_broadcast_profile($profile);
1185     // XXX: Other broadcasts...?
1186     return true;
1187 }
1188
1189 function common_profile_url($nickname)
1190 {
1191     return common_local_url('showstream', array('nickname' => $nickname));
1192 }
1193
1194 // Should make up a reasonable root URL
1195
1196 function common_root_url()
1197 {
1198     return common_path('');
1199 }
1200
1201 // returns $bytes bytes of random data as a hexadecimal string
1202 // "good" here is a goal and not a guarantee
1203
1204 function common_good_rand($bytes)
1205 {
1206     // XXX: use random.org...?
1207     if (file_exists('/dev/urandom')) {
1208         return common_urandom($bytes);
1209     } else { // FIXME: this is probably not good enough
1210         return common_mtrand($bytes);
1211     }
1212 }
1213
1214 function common_urandom($bytes)
1215 {
1216     $h = fopen('/dev/urandom', 'rb');
1217     // should not block
1218     $src = fread($h, $bytes);
1219     fclose($h);
1220     $enc = '';
1221     for ($i = 0; $i < $bytes; $i++) {
1222         $enc .= sprintf("%02x", (ord($src[$i])));
1223     }
1224     return $enc;
1225 }
1226
1227 function common_mtrand($bytes)
1228 {
1229     $enc = '';
1230     for ($i = 0; $i < $bytes; $i++) {
1231         $enc .= sprintf("%02x", mt_rand(0, 255));
1232     }
1233     return $enc;
1234 }
1235
1236 function common_set_returnto($url)
1237 {
1238     common_ensure_session();
1239     $_SESSION['returnto'] = $url;
1240 }
1241
1242 function common_get_returnto()
1243 {
1244     common_ensure_session();
1245     return $_SESSION['returnto'];
1246 }
1247
1248 function common_timestamp()
1249 {
1250     return date('YmdHis');
1251 }
1252
1253 function common_ensure_syslog()
1254 {
1255     static $initialized = false;
1256     if (!$initialized) {
1257         global $config;
1258         openlog($config['syslog']['appname'], 0, LOG_USER);
1259         $initialized = true;
1260     }
1261 }
1262
1263 function common_log($priority, $msg, $filename=null)
1264 {
1265     $logfile = common_config('site', 'logfile');
1266     if ($logfile) {
1267         $log = fopen($logfile, "a");
1268         if ($log) {
1269             static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1270                                               'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1271             $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1272             fwrite($log, $output);
1273             fclose($log);
1274         }
1275     } else {
1276         common_ensure_syslog();
1277         syslog($priority, $msg);
1278     }
1279 }
1280
1281 function common_debug($msg, $filename=null)
1282 {
1283     if ($filename) {
1284         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1285     } else {
1286         common_log(LOG_DEBUG, $msg);
1287     }
1288 }
1289
1290 function common_log_db_error(&$object, $verb, $filename=null)
1291 {
1292     $objstr = common_log_objstring($object);
1293     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1294     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1295 }
1296
1297 function common_log_objstring(&$object)
1298 {
1299     if (is_null($object)) {
1300         return "null";
1301     }
1302     $arr = $object->toArray();
1303     $fields = array();
1304     foreach ($arr as $k => $v) {
1305         $fields[] = "$k='$v'";
1306     }
1307     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1308     return $objstring;
1309 }
1310
1311 function common_valid_http_url($url)
1312 {
1313     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1314 }
1315
1316 function common_valid_tag($tag)
1317 {
1318     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1319         return (Validate::email($matches[1]) ||
1320                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1321     }
1322     return false;
1323 }
1324
1325 /* Following functions are copied from MediaWiki GlobalFunctions.php
1326  * and written by Evan Prodromou. */
1327
1328 function common_accept_to_prefs($accept, $def = '*/*')
1329 {
1330     // No arg means accept anything (per HTTP spec)
1331     if(!$accept) {
1332         return array($def => 1);
1333     }
1334
1335     $prefs = array();
1336
1337     $parts = explode(',', $accept);
1338
1339     foreach($parts as $part) {
1340         // FIXME: doesn't deal with params like 'text/html; level=1'
1341         @list($value, $qpart) = explode(';', $part);
1342         $match = array();
1343         if(!isset($qpart)) {
1344             $prefs[$value] = 1;
1345         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1346             $prefs[$value] = $match[1];
1347         }
1348     }
1349
1350     return $prefs;
1351 }
1352
1353 function common_mime_type_match($type, $avail)
1354 {
1355     if(array_key_exists($type, $avail)) {
1356         return $type;
1357     } else {
1358         $parts = explode('/', $type);
1359         if(array_key_exists($parts[0] . '/*', $avail)) {
1360             return $parts[0] . '/*';
1361         } elseif(array_key_exists('*/*', $avail)) {
1362             return '*/*';
1363         } else {
1364             return null;
1365         }
1366     }
1367 }
1368
1369 function common_negotiate_type($cprefs, $sprefs)
1370 {
1371     $combine = array();
1372
1373     foreach(array_keys($sprefs) as $type) {
1374         $parts = explode('/', $type);
1375         if($parts[1] != '*') {
1376             $ckey = common_mime_type_match($type, $cprefs);
1377             if($ckey) {
1378                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1379             }
1380         }
1381     }
1382
1383     foreach(array_keys($cprefs) as $type) {
1384         $parts = explode('/', $type);
1385         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1386             $skey = common_mime_type_match($type, $sprefs);
1387             if($skey) {
1388                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1389             }
1390         }
1391     }
1392
1393     $bestq = 0;
1394     $besttype = "text/html";
1395
1396     foreach(array_keys($combine) as $type) {
1397         if($combine[$type] > $bestq) {
1398             $besttype = $type;
1399             $bestq = $combine[$type];
1400         }
1401     }
1402
1403     return $besttype;
1404 }
1405
1406 function common_config($main, $sub)
1407 {
1408     global $config;
1409     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1410 }
1411
1412 function common_copy_args($from)
1413 {
1414     $to = array();
1415     $strip = get_magic_quotes_gpc();
1416     foreach ($from as $k => $v) {
1417         $to[$k] = ($strip) ? stripslashes($v) : $v;
1418     }
1419     return $to;
1420 }
1421
1422 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1423 // This is used before handing a request off to OAuthRequest::from_request.
1424 function common_remove_magic_from_request()
1425 {
1426     if(get_magic_quotes_gpc()) {
1427         $_POST=array_map('stripslashes',$_POST);
1428         $_GET=array_map('stripslashes',$_GET);
1429     }
1430 }
1431
1432 function common_user_uri(&$user)
1433 {
1434     return common_local_url('userbyid', array('id' => $user->id));
1435 }
1436
1437 function common_notice_uri(&$notice)
1438 {
1439     return common_local_url('shownotice',
1440                             array('notice' => $notice->id));
1441 }
1442
1443 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1444
1445 function common_confirmation_code($bits)
1446 {
1447     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1448     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1449     $chars = ceil($bits/5);
1450     $code = '';
1451     for ($i = 0; $i < $chars; $i++) {
1452         // XXX: convert to string and back
1453         $num = hexdec(common_good_rand(1));
1454         // XXX: randomness is too precious to throw away almost
1455         // 40% of the bits we get!
1456         $code .= $codechars[$num%32];
1457     }
1458     return $code;
1459 }
1460
1461 // convert markup to HTML
1462
1463 function common_markup_to_html($c)
1464 {
1465     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1466     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1467     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1468     return Markdown($c);
1469 }
1470
1471 function common_profile_avatar_url($profile, $size=AVATAR_PROFILE_SIZE)
1472 {
1473     $avatar = $profile->getAvatar($size);
1474     if ($avatar) {
1475         return common_avatar_display_url($avatar);
1476     } else {
1477         return common_default_avatar($size);
1478     }
1479 }
1480
1481 function common_profile_uri($profile)
1482 {
1483     if (!$profile) {
1484         return null;
1485     }
1486     $user = User::staticGet($profile->id);
1487     if ($user) {
1488         return $user->uri;
1489     }
1490
1491     $remote = Remote_profile::staticGet($profile->id);
1492     if ($remote) {
1493         return $remote->uri;
1494     }
1495     // XXX: this is a very bad profile!
1496     return null;
1497 }
1498
1499 function common_canonical_sms($sms)
1500 {
1501     // strip non-digits
1502     preg_replace('/\D/', '', $sms);
1503     return $sms;
1504 }
1505
1506 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1507 {
1508     switch ($errno) {
1509      case E_USER_ERROR:
1510         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1511         exit(1);
1512         break;
1513
1514      case E_USER_WARNING:
1515         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1516         break;
1517
1518      case E_USER_NOTICE:
1519         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1520         break;
1521     }
1522
1523     // FIXME: show error page if we're on the Web
1524     /* Don't execute PHP internal error handler */
1525     return true;
1526 }
1527
1528 function common_session_token()
1529 {
1530     common_ensure_session();
1531     if (!array_key_exists('token', $_SESSION)) {
1532         $_SESSION['token'] = common_good_rand(64);
1533     }
1534     return $_SESSION['token'];
1535 }
1536
1537 function common_cache_key($extra)
1538 {
1539     return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1540 }
1541
1542 function common_keyize($str)
1543 {
1544     $str = strtolower($str);
1545     $str = preg_replace('/\s/', '_', $str);
1546     return $str;
1547 }
1548
1549 function common_memcache()
1550 {
1551     static $cache = null;
1552     if (!common_config('memcached', 'enabled')) {
1553         return null;
1554     } else {
1555         if (!$cache) {
1556             $cache = new Memcache();
1557             $servers = common_config('memcached', 'server');
1558             if (is_array($servers)) {
1559                 foreach($servers as $server) {
1560                     $cache->addServer($server);
1561                 }
1562             } else {
1563                 $cache->addServer($servers);
1564             }
1565         }
1566         return $cache;
1567     }
1568 }
1569
1570 function common_compatible_license($from, $to)
1571 {
1572     // XXX: better compatibility check needed here!
1573     return ($from == $to);
1574 }