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