]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/util.php
Upload logos for groups
[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 'peoplesearch':
827         return common_path('search/people' . (($args) ? ('?' . http_build_query($args)) : ''));
828      case 'noticesearch':
829         return common_path('search/notice' . (($args) ? ('?' . http_build_query($args)) : ''));
830      case 'noticesearchrss':
831         return common_path('search/notice/rss' . (($args) ? ('?' . http_build_query($args)) : ''));
832      case 'avatarbynickname':
833         return common_path($args['nickname'].'/avatar/'.$args['size']);
834      case 'tag':
835         $path = 'tag/' . $args['tag'];
836         unset($args['tag']);
837         return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
838      case 'publictagcloud':
839         return common_path('tags');
840      case 'peopletag':
841         $path = 'peopletag/' . $args['tag'];
842         unset($args['tag']);
843         return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
844      case 'tags':
845         return common_path('tags' . (($args) ? ('?' . http_build_query($args)) : ''));
846      case 'favor':
847         return common_path('main/favor');
848      case 'disfavor':
849         return common_path('main/disfavor');
850      case 'showfavorites':
851         if ($args && isset($args['page'])) {
852             return common_path($args['nickname'].'/favorites?page=' . $args['page']);
853         } else {
854             return common_path($args['nickname'].'/favorites');
855         }
856      case 'favoritesrss':
857         return common_path($args['nickname'].'/favorites/rss');
858      case 'showmessage':
859         return common_path('message/' . $args['message']);
860      case 'newmessage':
861         return common_path('message/new' . (($args) ? ('?' . http_build_query($args)) : ''));
862      case 'api':
863         // XXX: do fancy URLs for all the API methods
864         switch (strtolower($args['apiaction'])) {
865          case 'statuses':
866             switch (strtolower($args['method'])) {
867              case 'user_timeline.rss':
868                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.rss');
869              case 'user_timeline.atom':
870                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.atom');
871              case 'user_timeline.json':
872                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.json');
873              case 'user_timeline.xml':
874                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.xml');
875              default: return common_simple_url($action, $args);
876             }
877          default: return common_simple_url($action, $args);
878         }
879      case 'sup':
880         if ($args && isset($args['seconds'])) {
881             return common_path('main/sup?seconds='.$args['seconds']);
882         } else {
883             return common_path('main/sup');
884         }
885      case 'newgroup':
886         return common_path('group/new');
887      case 'showgroup':
888         return common_path('group/'.$args['nickname']);
889      case 'editgroup':
890         return common_path('group/'.$args['nickname'].'/edit');
891      case 'joingroup':
892         return common_path('group/'.$args['nickname'].'/join');
893      case 'leavegroup':
894         return common_path('group/'.$args['nickname'].'/leave');
895      case 'groupbyid':
896         return common_path('group/'.$args['id'].'/id');
897      case 'grouprss':
898         return common_path('group/'.$args['nickname'].'/rss');
899      case 'groupmembers':
900         return common_path('group/'.$args['nickname'].'/members');
901      case 'grouplogo':
902         return common_path('group/'.$args['nickname'].'/logo');
903      case 'usergroups':
904         return common_path($args['nickname'].'/groups');
905      case 'groups':
906         return common_path('group');
907      default:
908         return common_simple_url($action, $args);
909     }
910 }
911
912 function common_simple_url($action, $args=null)
913 {
914     global $config;
915     /* XXX: pretty URLs */
916     $extra = '';
917     if ($args) {
918         foreach ($args as $key => $value) {
919             $extra .= "&${key}=${value}";
920         }
921     }
922     return common_path("index.php?action=${action}${extra}");
923 }
924
925 function common_path($relative)
926 {
927     global $config;
928     $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
929     return "http://".$config['site']['server'].'/'.$pathpart.$relative;
930 }
931
932 function common_date_string($dt)
933 {
934     // XXX: do some sexy date formatting
935     // return date(DATE_RFC822, $dt);
936     $t = strtotime($dt);
937     $now = time();
938     $diff = $now - $t;
939
940     if ($now < $t) { // that shouldn't happen!
941         return common_exact_date($dt);
942     } else if ($diff < 60) {
943         return _('a few seconds ago');
944     } else if ($diff < 92) {
945         return _('about a minute ago');
946     } else if ($diff < 3300) {
947         return sprintf(_('about %d minutes ago'), round($diff/60));
948     } else if ($diff < 5400) {
949         return _('about an hour ago');
950     } else if ($diff < 22 * 3600) {
951         return sprintf(_('about %d hours ago'), round($diff/3600));
952     } else if ($diff < 37 * 3600) {
953         return _('about a day ago');
954     } else if ($diff < 24 * 24 * 3600) {
955         return sprintf(_('about %d days ago'), round($diff/(24*3600)));
956     } else if ($diff < 46 * 24 * 3600) {
957         return _('about a month ago');
958     } else if ($diff < 330 * 24 * 3600) {
959         return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
960     } else if ($diff < 480 * 24 * 3600) {
961         return _('about a year ago');
962     } else {
963         return common_exact_date($dt);
964     }
965 }
966
967 function common_exact_date($dt)
968 {
969     static $_utc;
970     static $_siteTz;
971
972     if (!$_utc) {
973         $_utc = new DateTimeZone('UTC');
974         $_siteTz = new DateTimeZone(common_timezone());
975     }
976
977     $dateStr = date('d F Y H:i:s', strtotime($dt));
978     $d = new DateTime($dateStr, $_utc);
979     $d->setTimezone($_siteTz);
980     return $d->format(DATE_RFC850);
981 }
982
983 function common_date_w3dtf($dt)
984 {
985     $dateStr = date('d F Y H:i:s', strtotime($dt));
986     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
987     $d->setTimezone(new DateTimeZone(common_timezone()));
988     return $d->format(DATE_W3C);
989 }
990
991 function common_date_rfc2822($dt)
992 {
993     $dateStr = date('d F Y H:i:s', strtotime($dt));
994     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
995     $d->setTimezone(new DateTimeZone(common_timezone()));
996     return $d->format('r');
997 }
998
999 function common_date_iso8601($dt)
1000 {
1001     $dateStr = date('d F Y H:i:s', strtotime($dt));
1002     $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1003     $d->setTimezone(new DateTimeZone(common_timezone()));
1004     return $d->format('c');
1005 }
1006
1007 function common_sql_now()
1008 {
1009     return strftime('%Y-%m-%d %H:%M:%S', time());
1010 }
1011
1012 function common_redirect($url, $code=307)
1013 {
1014     static $status = array(301 => "Moved Permanently",
1015                            302 => "Found",
1016                            303 => "See Other",
1017                            307 => "Temporary Redirect");
1018
1019     header("Status: ${code} $status[$code]");
1020     header("Location: $url");
1021
1022     $xo = new XMLOutputter();
1023     $xo->startXML('a',
1024                   '-//W3C//DTD XHTML 1.0 Strict//EN',
1025                   'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1026     $xo->element('a', array('href' => $url), $url);
1027     $xo->endXML();
1028     exit;
1029 }
1030
1031 function common_broadcast_notice($notice, $remote=false)
1032 {
1033
1034     // Check to see if notice should go to Twitter
1035     $flink = Foreign_link::getByUserID($notice->profile_id, 1); // 1 == Twitter
1036     if (($flink->noticesync & FOREIGN_NOTICE_SEND) == FOREIGN_NOTICE_SEND) {
1037
1038         // If it's not a Twitter-style reply, or if the user WANTS to send replies...
1039
1040         if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
1041             (($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) == FOREIGN_NOTICE_SEND_REPLY)) {
1042
1043             $result = common_twitter_broadcast($notice, $flink);
1044
1045             if (!$result) {
1046                 common_debug('Unable to send notice: ' . $notice->id . ' to Twitter.', __FILE__);
1047             }
1048         }
1049     }
1050
1051     if (common_config('queue', 'enabled')) {
1052         // Do it later!
1053         return common_enqueue_notice($notice);
1054     } else {
1055         return common_real_broadcast($notice, $remote);
1056     }
1057 }
1058
1059 function common_twitter_broadcast($notice, $flink)
1060 {
1061     global $config;
1062     $success = true;
1063     $fuser = $flink->getForeignUser();
1064     $twitter_user = $fuser->nickname;
1065     $twitter_password = $flink->credentials;
1066     $uri = 'http://www.twitter.com/statuses/update.json';
1067
1068     // XXX: Hack to get around PHP cURL's use of @ being a a meta character
1069     $statustxt = preg_replace('/^@/', ' @', $notice->content);
1070
1071     $options = array(
1072                      CURLOPT_USERPWD         => "$twitter_user:$twitter_password",
1073                      CURLOPT_POST            => true,
1074                      CURLOPT_POSTFIELDS        => array(
1075                                                         'status'    => $statustxt,
1076                                                         'source'    => $config['integration']['source']
1077                                                         ),
1078                      CURLOPT_RETURNTRANSFER    => true,
1079                      CURLOPT_FAILONERROR        => true,
1080                      CURLOPT_HEADER            => false,
1081                      CURLOPT_FOLLOWLOCATION    => true,
1082                      CURLOPT_USERAGENT        => "Laconica",
1083                      CURLOPT_CONNECTTIMEOUT    => 120,  // XXX: Scary!!!! How long should this be?
1084                      CURLOPT_TIMEOUT            => 120,
1085
1086                      # Twitter is strict about accepting invalid "Expect" headers
1087                      CURLOPT_HTTPHEADER => array('Expect:')
1088                      );
1089
1090     $ch = curl_init($uri);
1091     curl_setopt_array($ch, $options);
1092     $data = curl_exec($ch);
1093     $errmsg = curl_error($ch);
1094
1095     if ($errmsg) {
1096         common_debug("cURL error: $errmsg - trying to send notice for $twitter_user.",
1097                      __FILE__);
1098         $success = false;
1099     }
1100
1101     curl_close($ch);
1102
1103     if (!$data) {
1104         common_debug("No data returned by Twitter's API trying to send update for $twitter_user",
1105                      __FILE__);
1106         $success = false;
1107     }
1108
1109     // Twitter should return a status
1110     $status = json_decode($data);
1111
1112     if (!$status->id) {
1113         common_debug("Unexpected data returned by Twitter API trying to send update for $twitter_user",
1114                      __FILE__);
1115         $success = false;
1116     }
1117
1118     return $success;
1119 }
1120
1121 // Stick the notice on the queue
1122
1123 function common_enqueue_notice($notice)
1124 {
1125     foreach (array('jabber', 'omb', 'sms', 'public') as $transport) {
1126         $qi = new Queue_item();
1127         $qi->notice_id = $notice->id;
1128         $qi->transport = $transport;
1129         $qi->created = $notice->created;
1130         $result = $qi->insert();
1131         if (!$result) {
1132             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1133             common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
1134             return false;
1135         }
1136         common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
1137     }
1138     return $result;
1139 }
1140
1141 function common_dequeue_notice($notice)
1142 {
1143     $qi = Queue_item::staticGet($notice->id);
1144     if ($qi) {
1145         $result = $qi->delete();
1146         if (!$result) {
1147             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1148             common_log(LOG_ERR, 'DB error deleting queue item: ' . $last_error->message);
1149             return false;
1150         }
1151         common_log(LOG_DEBUG, 'complete dequeueing notice ID = ' . $notice->id);
1152         return $result;
1153     } else {
1154         return false;
1155     }
1156 }
1157
1158 function common_real_broadcast($notice, $remote=false)
1159 {
1160     $success = true;
1161     if (!$remote) {
1162         // Make sure we have the OMB stuff
1163         require_once(INSTALLDIR.'/lib/omb.php');
1164         $success = omb_broadcast_remote_subscribers($notice);
1165         if (!$success) {
1166             common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
1167         }
1168     }
1169     if ($success) {
1170         require_once(INSTALLDIR.'/lib/jabber.php');
1171         $success = jabber_broadcast_notice($notice);
1172         if (!$success) {
1173             common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
1174         }
1175     }
1176     if ($success) {
1177         require_once(INSTALLDIR.'/lib/mail.php');
1178         $success = mail_broadcast_notice_sms($notice);
1179         if (!$success) {
1180             common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
1181         }
1182     }
1183     if ($success) {
1184         $success = jabber_public_notice($notice);
1185         if (!$success) {
1186             common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
1187         }
1188     }
1189     // XXX: broadcast notices to other IM
1190     return $success;
1191 }
1192
1193 function common_broadcast_profile($profile)
1194 {
1195     // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1196     require_once(INSTALLDIR.'/lib/omb.php');
1197     omb_broadcast_profile($profile);
1198     // XXX: Other broadcasts...?
1199     return true;
1200 }
1201
1202 function common_profile_url($nickname)
1203 {
1204     return common_local_url('showstream', array('nickname' => $nickname));
1205 }
1206
1207 // Should make up a reasonable root URL
1208
1209 function common_root_url()
1210 {
1211     return common_path('');
1212 }
1213
1214 // returns $bytes bytes of random data as a hexadecimal string
1215 // "good" here is a goal and not a guarantee
1216
1217 function common_good_rand($bytes)
1218 {
1219     // XXX: use random.org...?
1220     if (file_exists('/dev/urandom')) {
1221         return common_urandom($bytes);
1222     } else { // FIXME: this is probably not good enough
1223         return common_mtrand($bytes);
1224     }
1225 }
1226
1227 function common_urandom($bytes)
1228 {
1229     $h = fopen('/dev/urandom', 'rb');
1230     // should not block
1231     $src = fread($h, $bytes);
1232     fclose($h);
1233     $enc = '';
1234     for ($i = 0; $i < $bytes; $i++) {
1235         $enc .= sprintf("%02x", (ord($src[$i])));
1236     }
1237     return $enc;
1238 }
1239
1240 function common_mtrand($bytes)
1241 {
1242     $enc = '';
1243     for ($i = 0; $i < $bytes; $i++) {
1244         $enc .= sprintf("%02x", mt_rand(0, 255));
1245     }
1246     return $enc;
1247 }
1248
1249 function common_set_returnto($url)
1250 {
1251     common_ensure_session();
1252     $_SESSION['returnto'] = $url;
1253 }
1254
1255 function common_get_returnto()
1256 {
1257     common_ensure_session();
1258     return $_SESSION['returnto'];
1259 }
1260
1261 function common_timestamp()
1262 {
1263     return date('YmdHis');
1264 }
1265
1266 function common_ensure_syslog()
1267 {
1268     static $initialized = false;
1269     if (!$initialized) {
1270         global $config;
1271         openlog($config['syslog']['appname'], 0, LOG_USER);
1272         $initialized = true;
1273     }
1274 }
1275
1276 function common_log($priority, $msg, $filename=null)
1277 {
1278     $logfile = common_config('site', 'logfile');
1279     if ($logfile) {
1280         $log = fopen($logfile, "a");
1281         if ($log) {
1282             static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1283                                               'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1284             $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1285             fwrite($log, $output);
1286             fclose($log);
1287         }
1288     } else {
1289         common_ensure_syslog();
1290         syslog($priority, $msg);
1291     }
1292 }
1293
1294 function common_debug($msg, $filename=null)
1295 {
1296     if ($filename) {
1297         common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1298     } else {
1299         common_log(LOG_DEBUG, $msg);
1300     }
1301 }
1302
1303 function common_log_db_error(&$object, $verb, $filename=null)
1304 {
1305     $objstr = common_log_objstring($object);
1306     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1307     common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1308 }
1309
1310 function common_log_objstring(&$object)
1311 {
1312     if (is_null($object)) {
1313         return "null";
1314     }
1315     $arr = $object->toArray();
1316     $fields = array();
1317     foreach ($arr as $k => $v) {
1318         $fields[] = "$k='$v'";
1319     }
1320     $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1321     return $objstring;
1322 }
1323
1324 function common_valid_http_url($url)
1325 {
1326     return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1327 }
1328
1329 function common_valid_tag($tag)
1330 {
1331     if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1332         return (Validate::email($matches[1]) ||
1333                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1334     }
1335     return false;
1336 }
1337
1338 /* Following functions are copied from MediaWiki GlobalFunctions.php
1339  * and written by Evan Prodromou. */
1340
1341 function common_accept_to_prefs($accept, $def = '*/*')
1342 {
1343     // No arg means accept anything (per HTTP spec)
1344     if(!$accept) {
1345         return array($def => 1);
1346     }
1347
1348     $prefs = array();
1349
1350     $parts = explode(',', $accept);
1351
1352     foreach($parts as $part) {
1353         // FIXME: doesn't deal with params like 'text/html; level=1'
1354         @list($value, $qpart) = explode(';', $part);
1355         $match = array();
1356         if(!isset($qpart)) {
1357             $prefs[$value] = 1;
1358         } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1359             $prefs[$value] = $match[1];
1360         }
1361     }
1362
1363     return $prefs;
1364 }
1365
1366 function common_mime_type_match($type, $avail)
1367 {
1368     if(array_key_exists($type, $avail)) {
1369         return $type;
1370     } else {
1371         $parts = explode('/', $type);
1372         if(array_key_exists($parts[0] . '/*', $avail)) {
1373             return $parts[0] . '/*';
1374         } elseif(array_key_exists('*/*', $avail)) {
1375             return '*/*';
1376         } else {
1377             return null;
1378         }
1379     }
1380 }
1381
1382 function common_negotiate_type($cprefs, $sprefs)
1383 {
1384     $combine = array();
1385
1386     foreach(array_keys($sprefs) as $type) {
1387         $parts = explode('/', $type);
1388         if($parts[1] != '*') {
1389             $ckey = common_mime_type_match($type, $cprefs);
1390             if($ckey) {
1391                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1392             }
1393         }
1394     }
1395
1396     foreach(array_keys($cprefs) as $type) {
1397         $parts = explode('/', $type);
1398         if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1399             $skey = common_mime_type_match($type, $sprefs);
1400             if($skey) {
1401                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1402             }
1403         }
1404     }
1405
1406     $bestq = 0;
1407     $besttype = "text/html";
1408
1409     foreach(array_keys($combine) as $type) {
1410         if($combine[$type] > $bestq) {
1411             $besttype = $type;
1412             $bestq = $combine[$type];
1413         }
1414     }
1415
1416     return $besttype;
1417 }
1418
1419 function common_config($main, $sub)
1420 {
1421     global $config;
1422     return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1423 }
1424
1425 function common_copy_args($from)
1426 {
1427     $to = array();
1428     $strip = get_magic_quotes_gpc();
1429     foreach ($from as $k => $v) {
1430         $to[$k] = ($strip) ? stripslashes($v) : $v;
1431     }
1432     return $to;
1433 }
1434
1435 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1436 // This is used before handing a request off to OAuthRequest::from_request.
1437 function common_remove_magic_from_request()
1438 {
1439     if(get_magic_quotes_gpc()) {
1440         $_POST=array_map('stripslashes',$_POST);
1441         $_GET=array_map('stripslashes',$_GET);
1442     }
1443 }
1444
1445 function common_user_uri(&$user)
1446 {
1447     return common_local_url('userbyid', array('id' => $user->id));
1448 }
1449
1450 function common_notice_uri(&$notice)
1451 {
1452     return common_local_url('shownotice',
1453                             array('notice' => $notice->id));
1454 }
1455
1456 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1457
1458 function common_confirmation_code($bits)
1459 {
1460     // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1461     static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1462     $chars = ceil($bits/5);
1463     $code = '';
1464     for ($i = 0; $i < $chars; $i++) {
1465         // XXX: convert to string and back
1466         $num = hexdec(common_good_rand(1));
1467         // XXX: randomness is too precious to throw away almost
1468         // 40% of the bits we get!
1469         $code .= $codechars[$num%32];
1470     }
1471     return $code;
1472 }
1473
1474 // convert markup to HTML
1475
1476 function common_markup_to_html($c)
1477 {
1478     $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1479     $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1480     $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1481     return Markdown($c);
1482 }
1483
1484 function common_profile_avatar_url($profile, $size=AVATAR_PROFILE_SIZE)
1485 {
1486     $avatar = $profile->getAvatar($size);
1487     if ($avatar) {
1488         return common_avatar_display_url($avatar);
1489     } else {
1490         return common_default_avatar($size);
1491     }
1492 }
1493
1494 function common_profile_uri($profile)
1495 {
1496     if (!$profile) {
1497         return null;
1498     }
1499     $user = User::staticGet($profile->id);
1500     if ($user) {
1501         return $user->uri;
1502     }
1503
1504     $remote = Remote_profile::staticGet($profile->id);
1505     if ($remote) {
1506         return $remote->uri;
1507     }
1508     // XXX: this is a very bad profile!
1509     return null;
1510 }
1511
1512 function common_canonical_sms($sms)
1513 {
1514     // strip non-digits
1515     preg_replace('/\D/', '', $sms);
1516     return $sms;
1517 }
1518
1519 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1520 {
1521     switch ($errno) {
1522      case E_USER_ERROR:
1523         common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1524         exit(1);
1525         break;
1526
1527      case E_USER_WARNING:
1528         common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1529         break;
1530
1531      case E_USER_NOTICE:
1532         common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1533         break;
1534     }
1535
1536     // FIXME: show error page if we're on the Web
1537     /* Don't execute PHP internal error handler */
1538     return true;
1539 }
1540
1541 function common_session_token()
1542 {
1543     common_ensure_session();
1544     if (!array_key_exists('token', $_SESSION)) {
1545         $_SESSION['token'] = common_good_rand(64);
1546     }
1547     return $_SESSION['token'];
1548 }
1549
1550 function common_cache_key($extra)
1551 {
1552     return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1553 }
1554
1555 function common_keyize($str)
1556 {
1557     $str = strtolower($str);
1558     $str = preg_replace('/\s/', '_', $str);
1559     return $str;
1560 }
1561
1562 function common_memcache()
1563 {
1564     static $cache = null;
1565     if (!common_config('memcached', 'enabled')) {
1566         return null;
1567     } else {
1568         if (!$cache) {
1569             $cache = new Memcache();
1570             $servers = common_config('memcached', 'server');
1571             if (is_array($servers)) {
1572                 foreach($servers as $server) {
1573                     $cache->addServer($server);
1574                 }
1575             } else {
1576                 $cache->addServer($servers);
1577             }
1578         }
1579         return $cache;
1580     }
1581 }
1582
1583 function common_compatible_license($from, $to)
1584 {
1585     // XXX: better compatibility check needed here!
1586     return ($from == $to);
1587 }