3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, Controlez-Vous, Inc.
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.
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.
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/>.
20 /* XXX: break up into separate modules (HTTP, user, files) */
22 // Show a server error
24 function common_server_error($msg, $code=500)
26 $err = new ServerErrorAction($msg, $code);
31 function common_user_error($msg, $code=400)
33 $err = new ClientErrorAction($msg, $code);
37 function common_init_locale($language=null)
40 $language = common_language();
42 putenv('LANGUAGE='.$language);
43 putenv('LANG='.$language);
44 return setlocale(LC_ALL, $language . ".utf8",
51 function common_init_language()
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');
62 common_log(LOG_INFO,'Language requested:'.$language.' - locale could not be set:',__FILE__);
66 function common_timezone()
68 if (common_logged_in()) {
69 $user = common_current_user();
70 if ($user->timezone) {
71 return $user->timezone;
76 return $config['site']['timezone'];
79 function common_language()
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;
88 return $user_language;
91 // Otherwise, find the best match for the languages requested by the
93 $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
94 if (!empty($httplang)) {
95 $language = client_prefered_language($httplang);
100 // Finally, if none of the above worked, use the site's default...
101 return common_config('site', 'language');
103 // salted, hashed passwords are stored in the DB
105 function common_munge_password($password, $id)
107 return md5($password . $id);
110 // check if a username exists and has matching password
111 function common_check_user($nickname, $password)
113 // NEVER allow blank passwords, even if they match the DB
114 if (mb_strlen($password) == 0) {
117 $user = User::staticGet('nickname', $nickname);
118 if (is_null($user)) {
121 if (0 == strcmp(common_munge_password($password, $user->id),
130 // is the current user logged in?
131 function common_logged_in()
133 return (!is_null(common_current_user()));
136 function common_have_session()
138 return (0 != strcmp(session_id(), ''));
141 function common_ensure_session()
143 if (!common_have_session()) {
148 // Three kinds of arguments:
153 // Initialize to false; set to null if none found
157 function common_set_user($user)
162 if (is_null($user) && common_have_session()) {
164 unset($_SESSION['userid']);
166 } else if (is_string($user)) {
168 $user = User::staticGet('nickname', $nickname);
169 } else if (!($user instanceof User)) {
174 common_ensure_session();
175 $_SESSION['userid'] = $user->id;
182 function common_set_cookie($key, $value, $expiration=0)
184 $path = common_config('site', 'path');
185 $server = common_config('site', 'server');
187 if ($path && ($path != '/')) {
188 $cookiepath = '/' . $path . '/';
192 return setcookie($key,
199 define('REMEMBERME', 'rememberme');
200 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
202 function common_rememberme($user=null)
205 $user = common_current_user();
207 common_debug('No current user to remember', __FILE__);
212 $rm = new Remember_me();
214 $rm->code = common_good_rand(16);
215 $rm->user_id = $user->id;
217 // Wrap the insert in some good ol' fashioned transaction code
221 $result = $rm->insert();
224 common_log_db_error($rm, 'INSERT', __FILE__);
225 common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
229 $rm->query('COMMIT');
231 common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
233 $cookieval = $rm->user_id . ':' . $rm->code;
235 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
237 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
242 function common_remembered_user()
247 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
253 list($id, $code) = explode(':', $packed);
255 if (!$id || !$code) {
256 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
261 $rm = Remember_me::staticGet($code);
264 common_log(LOG_WARNING, 'No such remember code: ' . $code);
269 if ($rm->user_id != $id) {
270 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
275 $user = User::staticGet($rm->user_id);
278 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
284 $result = $rm->delete();
287 common_log_db_error($rm, 'DELETE', __FILE__);
288 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
293 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
295 common_set_user($user);
296 common_real_login(false);
298 // We issue a new cookie, so they can log in
299 // automatically again after this session
301 common_rememberme($user);
306 // must be called with a valid user!
308 function common_forgetme()
310 common_set_cookie(REMEMBERME, '', 0);
313 // who is the current user?
314 function common_current_user()
318 if ($_cur === false) {
320 if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
321 common_ensure_session();
322 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
324 $_cur = User::staticGet($id);
329 // that didn't work; try to remember; will init $_cur to null on failure
330 $_cur = common_remembered_user();
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;
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.
347 function common_real_login($real=true)
349 common_ensure_session();
350 $_SESSION['real_login'] = $real;
353 function common_is_real_login()
355 return common_logged_in() && $_SESSION['real_login'];
358 // get canonical version of nickname for comparison
359 function common_canonical_nickname($nickname)
361 // XXX: UTF-8 canonicalization (like combining chars)
362 return strtolower($nickname);
365 // get canonical version of email for comparison
366 function common_canonical_email($email)
368 // XXX: canonicalize UTF-8
369 // XXX: lcase the domain part
373 function common_render_content($text, $notice)
375 $r = common_render_text($text);
376 $id = $notice->profile_id;
377 $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
378 $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
379 $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
380 $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
384 function common_render_text($text)
386 $r = htmlspecialchars($text);
388 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
389 $r = preg_replace_callback('@(ftp|http|https|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|xmpp|irc)://[^\]>\s]+@', 'common_render_uri_thingy', $r);
390 $r = preg_replace_callback('@(mailto|aim|tel):[^\]>\s]+@', 'common_render_uri_thingy', $r); // Pseudo-protocols don't require '//' after ':'.
391 $r = preg_replace('/(^|\s+)#([A-Za-z0-9_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
396 function common_render_uri_thingy($matches)
401 // Some heuristics for extracting URIs from surrounding punctuation
402 // Strip from trailing text...
403 if (preg_match('/^(.*)([,.:"\']+)$/', $uri, $matches)) {
405 $trailer = $matches[2];
409 ']' => '[', // technically disallowed in URIs, but used in Java docs
410 ')' => '(', // far too frequent in Wikipedia and MSDN
412 $final = substr($uri, -1, 1);
413 if (isset($pairs[$final])) {
414 $openers = substr_count($uri, $pairs[$final]);
415 $closers = substr_count($uri, $final);
416 if ($closers > $openers) {
417 // Assume the paren was opened outside the URI
418 $uri = substr($uri, 0, -1);
419 $trailer = $final . $trailer;
422 if ($longurl = common_longurl($uri)) {
423 $longurl = htmlentities($longurl, ENT_QUOTES, 'UTF-8');
424 $title = " title='$longurl'";
428 return '<a href="' . $uri . '"' . $title . ' class="extlink">' . $uri . '</a>' . $trailer;
431 function common_longurl($short_url)
433 $long_url = common_shorten_link($short_url, true);
434 if ($long_url === $short_url) return false;
438 function common_longurl2($uri)
440 $uri_e = urlencode($uri);
441 $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
442 if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
443 return stripslashes($longurl['long_url']);
446 function common_shorten_links($text)
448 if (mb_strlen($text) <= 140) return $text;
449 static $cache = array();
450 if (isset($cache[$text])) return $cache[$text];
451 // \s = not a horizontal whitespace character (since PHP 5.2.4)
452 return $cache[$text] = preg_replace('@https?://[^)\]>\s]+@e', "common_shorten_link('\\0')", $text);
455 function common_shorten_link($url, $reverse = false)
457 static $url_cache = array();
458 if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
460 $user = common_current_user();
462 $curlh = curl_init();
463 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
464 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
465 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
467 switch($user->urlshorteningservice) {
469 $short_url_service = new LilUrl;
470 $short_url = $short_url_service->shorten($url);
474 $short_url_service = new TightUrl;
475 $short_url = $short_url_service->shorten($url);
479 $short_url_service = new PtitUrl;
480 $short_url = $short_url_service->shorten($url);
484 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
485 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
489 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
490 $short_url = curl_exec($curlh);
493 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
494 $short_url = curl_exec($curlh);
497 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
498 $short_url = curl_exec($curlh);
501 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
502 $short_url = curl_exec($curlh);
511 $url_cache[(string)$short_url] = $url;
512 return (string)$short_url;
517 function common_xml_safe_str($str)
519 $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
521 // Replace control, formatting, and surrogate characters with '*', ala Twitter
522 return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
525 function common_tag_link($tag)
527 $canonical = common_canonical_tag($tag);
528 $url = common_local_url('tag', array('tag' => $canonical));
529 return '<span class="tag"><a href="' . htmlspecialchars($url) . '" rel="tag">' . htmlspecialchars($tag) . '</a></span>';
532 function common_canonical_tag($tag)
534 return strtolower(str_replace(array('-', '_', '.'), '', $tag));
537 function common_valid_profile_tag($str)
539 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
542 function common_at_link($sender_id, $nickname)
544 $sender = Profile::staticGet($sender_id);
545 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
547 return '<span class="vcard"><a href="'.htmlspecialchars($recipient->profileurl).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
553 function common_group_link($sender_id, $nickname)
555 $sender = Profile::staticGet($sender_id);
556 $group = User_group::staticGet('nickname', common_canonical_nickname($nickname));
557 if ($group && $sender->isMember($group)) {
558 return '<span class="vcard"><a href="'.htmlspecialchars($group->permalink()).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
564 function common_at_hash_link($sender_id, $tag)
566 $user = User::staticGet($sender_id);
570 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
572 $url = common_local_url('subscriptions',
573 array('nickname' => $user->nickname,
575 return '<span class="tag"><a href="'.htmlspecialchars($url).'" rel="tag">'.$tag.'</a></span>';
581 function common_relative_profile($sender, $nickname, $dt=null)
583 // Try to find profiles this profile is subscribed to that have this nickname
584 $recipient = new Profile();
585 // XXX: use a join instead of a subquery
586 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
587 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
588 if ($recipient->find(true)) {
589 // XXX: should probably differentiate between profiles with
590 // the same name by date of most recent update
593 // Try to find profiles that listen to this profile and that have this nickname
594 $recipient = new Profile();
595 // XXX: use a join instead of a subquery
596 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
597 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
598 if ($recipient->find(true)) {
599 // XXX: should probably differentiate between profiles with
600 // the same name by date of most recent update
603 // If this is a local user, try to find a local user with that nickname.
604 $sender = User::staticGet($sender->id);
606 $recipient_user = User::staticGet('nickname', $nickname);
607 if ($recipient_user) {
608 return $recipient_user->getProfile();
611 // Otherwise, no links. @messages from local users to remote users,
612 // or from remote users to other remote users, are just
613 // outside our ability to make intelligent guesses about
617 // where should the avatar go for this user?
619 function common_avatar_filename($id, $extension, $size=null, $extra=null)
624 return $id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
626 return $id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
630 function common_avatar_path($filename)
633 return INSTALLDIR . '/avatar/' . $filename;
636 function common_avatar_url($filename)
638 return common_path('avatar/'.$filename);
641 function common_avatar_display_url($avatar)
643 $server = common_config('avatar', 'server');
645 return 'http://'.$server.'/'.$avatar->filename;
651 function common_default_avatar($size)
653 static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
654 AVATAR_STREAM_SIZE => 'stream',
655 AVATAR_MINI_SIZE => 'mini');
656 return theme_path('default-avatar-'.$sizenames[$size].'.png');
659 function common_local_url($action, $args=null, $fragment=null)
662 if (common_config('site','fancy')) {
663 $url = common_fancy_url($action, $args);
665 $url = common_simple_url($action, $args);
667 if (!is_null($fragment)) {
668 $url .= '#'.$fragment;
673 function common_fancy_url($action, $args=null)
675 switch (strtolower($action)) {
677 if ($args && isset($args['page'])) {
678 return common_path('?page=' . $args['page']);
680 return common_path('');
683 if ($args && isset($args['page'])) {
684 return common_path('featured?page=' . $args['page']);
686 return common_path('featured');
689 if ($args && isset($args['page'])) {
690 return common_path('favorited?page=' . $args['page']);
692 return common_path('favorited');
695 return common_path('rss');
697 return common_path("api/statuses/public_timeline.atom");
699 return common_path('xrds');
701 return common_path('featuredrss');
703 return common_path('favoritedrss');
705 if ($args && $args['type']) {
706 return common_path('opensearch/'.$args['type']);
708 return common_path('opensearch/people');
711 return common_path('doc/'.$args['title']);
718 return common_path('main/'.$action);
720 return common_path('main/tagother?id='.$args['id']);
722 if ($args && $args['code']) {
723 return common_path('main/register/'.$args['code']);
725 return common_path('main/register');
727 case 'remotesubscribe':
728 if ($args && $args['nickname']) {
729 return common_path('main/remote?nickname=' . $args['nickname']);
731 return common_path('main/remote');
734 return common_path($args['nickname'].'/nudge');
736 return common_path('main/openid');
737 case 'profilesettings':
738 return common_path('settings/profile');
739 case 'passwordsettings':
740 return common_path('settings/password');
741 case 'emailsettings':
742 return common_path('settings/email');
743 case 'openidsettings':
744 return common_path('settings/openid');
746 return common_path('settings/sms');
747 case 'twittersettings':
748 return common_path('settings/twitter');
749 case 'othersettings':
750 return common_path('settings/other');
751 case 'deleteprofile':
752 return common_path('settings/delete');
754 if ($args && $args['replyto']) {
755 return common_path('notice/new?replyto='.$args['replyto']);
757 return common_path('notice/new');
760 return common_path('notice/'.$args['notice']);
762 if ($args && $args['notice']) {
763 return common_path('notice/delete/'.$args['notice']);
765 return common_path('notice/delete');
770 return common_path($args['nickname'].'/'.$action);
775 if ($args && isset($args['page'])) {
776 return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
778 return common_path($args['nickname'].'/'.$action);
780 case 'subscriptions':
782 $nickname = $args['nickname'];
783 unset($args['nickname']);
784 if (isset($args['tag'])) {
788 $params = http_build_query($args);
790 return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : '') . '?' . $params);
792 return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : ''));
795 return common_path($args['nickname'].'/all/rss');
797 return common_path($args['nickname'].'/replies/rss');
799 if (isset($args['limit']))
800 return common_path($args['nickname'].'/rss?limit=' . $args['limit']);
801 return common_path($args['nickname'].'/rss');
803 if ($args && isset($args['page'])) {
804 return common_path($args['nickname'].'?page=' . $args['page']);
806 return common_path($args['nickname']);
810 return common_path("api/statuses/user_timeline/".$args['nickname'].".atom");
811 case 'confirmaddress':
812 return common_path('main/confirmaddress/'.$args['code']);
814 return common_path('user/'.$args['id']);
815 case 'recoverpassword':
816 $path = 'main/recoverpassword';
818 $path .= '/' . $args['code'];
820 return common_path($path);
822 return common_path('settings/im');
823 case 'avatarsettings':
824 return common_path('settings/avatar');
826 return common_path('search/group' . (($args) ? ('?' . http_build_query($args)) : ''));
828 return common_path('search/people' . (($args) ? ('?' . http_build_query($args)) : ''));
830 return common_path('search/notice' . (($args) ? ('?' . http_build_query($args)) : ''));
831 case 'noticesearchrss':
832 return common_path('search/notice/rss' . (($args) ? ('?' . http_build_query($args)) : ''));
833 case 'avatarbynickname':
834 return common_path($args['nickname'].'/avatar/'.$args['size']);
836 $path = 'tag/' . $args['tag'];
838 return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
839 case 'publictagcloud':
840 return common_path('tags');
842 $path = 'peopletag/' . $args['tag'];
844 return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
846 return common_path('tags' . (($args) ? ('?' . http_build_query($args)) : ''));
848 return common_path('main/favor');
850 return common_path('main/disfavor');
851 case 'showfavorites':
852 if ($args && isset($args['page'])) {
853 return common_path($args['nickname'].'/favorites?page=' . $args['page']);
855 return common_path($args['nickname'].'/favorites');
858 return common_path($args['nickname'].'/favorites/rss');
860 return common_path('message/' . $args['message']);
862 return common_path('message/new' . (($args) ? ('?' . http_build_query($args)) : ''));
864 // XXX: do fancy URLs for all the API methods
865 switch (strtolower($args['apiaction'])) {
867 switch (strtolower($args['method'])) {
868 case 'user_timeline.rss':
869 return common_path('api/statuses/user_timeline/'.$args['argument'].'.rss');
870 case 'user_timeline.atom':
871 return common_path('api/statuses/user_timeline/'.$args['argument'].'.atom');
872 case 'user_timeline.json':
873 return common_path('api/statuses/user_timeline/'.$args['argument'].'.json');
874 case 'user_timeline.xml':
875 return common_path('api/statuses/user_timeline/'.$args['argument'].'.xml');
876 default: return common_simple_url($action, $args);
878 default: return common_simple_url($action, $args);
881 if ($args && isset($args['seconds'])) {
882 return common_path('main/sup?seconds='.$args['seconds']);
884 return common_path('main/sup');
887 return common_path('group/new');
889 return common_path('group/'.$args['nickname'] . (($args['page']) ? ('?page=' . $args['page']) : ''));
891 return common_path('group/'.$args['nickname'].'/edit');
893 return common_path('group/'.$args['nickname'].'/join');
895 return common_path('group/'.$args['nickname'].'/leave');
897 return common_path('group/'.$args['id'].'/id');
899 return common_path('group/'.$args['nickname'].'/rss');
901 return common_path('group/'.$args['nickname'].'/members' . (($args['page']) ? ('?page=' . $args['page']) : ''));
903 return common_path('group/'.$args['nickname'].'/logo');
905 $nickname = $args['nickname'];
906 unset($args['nickname']);
907 return common_path($nickname.'/groups' . (($args) ? ('?' . http_build_query($args)) : ''));
909 return common_path('group' . (($args) ? ('?' . http_build_query($args)) : ''));
911 return common_simple_url($action, $args);
915 function common_simple_url($action, $args=null)
918 /* XXX: pretty URLs */
921 foreach ($args as $key => $value) {
922 $extra .= "&${key}=${value}";
925 return common_path("index.php?action=${action}${extra}");
928 function common_path($relative)
931 $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
932 return "http://".$config['site']['server'].'/'.$pathpart.$relative;
935 function common_date_string($dt)
937 // XXX: do some sexy date formatting
938 // return date(DATE_RFC822, $dt);
943 if ($now < $t) { // that shouldn't happen!
944 return common_exact_date($dt);
945 } else if ($diff < 60) {
946 return _('a few seconds ago');
947 } else if ($diff < 92) {
948 return _('about a minute ago');
949 } else if ($diff < 3300) {
950 return sprintf(_('about %d minutes ago'), round($diff/60));
951 } else if ($diff < 5400) {
952 return _('about an hour ago');
953 } else if ($diff < 22 * 3600) {
954 return sprintf(_('about %d hours ago'), round($diff/3600));
955 } else if ($diff < 37 * 3600) {
956 return _('about a day ago');
957 } else if ($diff < 24 * 24 * 3600) {
958 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
959 } else if ($diff < 46 * 24 * 3600) {
960 return _('about a month ago');
961 } else if ($diff < 330 * 24 * 3600) {
962 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
963 } else if ($diff < 480 * 24 * 3600) {
964 return _('about a year ago');
966 return common_exact_date($dt);
970 function common_exact_date($dt)
976 $_utc = new DateTimeZone('UTC');
977 $_siteTz = new DateTimeZone(common_timezone());
980 $dateStr = date('d F Y H:i:s', strtotime($dt));
981 $d = new DateTime($dateStr, $_utc);
982 $d->setTimezone($_siteTz);
983 return $d->format(DATE_RFC850);
986 function common_date_w3dtf($dt)
988 $dateStr = date('d F Y H:i:s', strtotime($dt));
989 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
990 $d->setTimezone(new DateTimeZone(common_timezone()));
991 return $d->format(DATE_W3C);
994 function common_date_rfc2822($dt)
996 $dateStr = date('d F Y H:i:s', strtotime($dt));
997 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
998 $d->setTimezone(new DateTimeZone(common_timezone()));
999 return $d->format('r');
1002 function common_date_iso8601($dt)
1004 $dateStr = date('d F Y H:i:s', strtotime($dt));
1005 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1006 $d->setTimezone(new DateTimeZone(common_timezone()));
1007 return $d->format('c');
1010 function common_sql_now()
1012 return strftime('%Y-%m-%d %H:%M:%S', time());
1015 function common_redirect($url, $code=307)
1017 static $status = array(301 => "Moved Permanently",
1020 307 => "Temporary Redirect");
1022 header("Status: ${code} $status[$code]");
1023 header("Location: $url");
1025 $xo = new XMLOutputter();
1027 '-//W3C//DTD XHTML 1.0 Strict//EN',
1028 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1029 $xo->element('a', array('href' => $url), $url);
1034 function common_broadcast_notice($notice, $remote=false)
1037 // Check to see if notice should go to Twitter
1038 $flink = Foreign_link::getByUserID($notice->profile_id, 1); // 1 == Twitter
1039 if (($flink->noticesync & FOREIGN_NOTICE_SEND) == FOREIGN_NOTICE_SEND) {
1041 // If it's not a Twitter-style reply, or if the user WANTS to send replies...
1043 if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
1044 (($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) == FOREIGN_NOTICE_SEND_REPLY)) {
1046 $result = common_twitter_broadcast($notice, $flink);
1049 common_debug('Unable to send notice: ' . $notice->id . ' to Twitter.', __FILE__);
1054 if (common_config('queue', 'enabled')) {
1056 return common_enqueue_notice($notice);
1058 return common_real_broadcast($notice, $remote);
1062 function common_twitter_broadcast($notice, $flink)
1066 $fuser = $flink->getForeignUser();
1067 $twitter_user = $fuser->nickname;
1068 $twitter_password = $flink->credentials;
1069 $uri = 'http://www.twitter.com/statuses/update.json';
1071 // XXX: Hack to get around PHP cURL's use of @ being a a meta character
1072 $statustxt = preg_replace('/^@/', ' @', $notice->content);
1075 CURLOPT_USERPWD => "$twitter_user:$twitter_password",
1076 CURLOPT_POST => true,
1077 CURLOPT_POSTFIELDS => array(
1078 'status' => $statustxt,
1079 'source' => $config['integration']['source']
1081 CURLOPT_RETURNTRANSFER => true,
1082 CURLOPT_FAILONERROR => true,
1083 CURLOPT_HEADER => false,
1084 CURLOPT_FOLLOWLOCATION => true,
1085 CURLOPT_USERAGENT => "Laconica",
1086 CURLOPT_CONNECTTIMEOUT => 120, // XXX: Scary!!!! How long should this be?
1087 CURLOPT_TIMEOUT => 120,
1089 # Twitter is strict about accepting invalid "Expect" headers
1090 CURLOPT_HTTPHEADER => array('Expect:')
1093 $ch = curl_init($uri);
1094 curl_setopt_array($ch, $options);
1095 $data = curl_exec($ch);
1096 $errmsg = curl_error($ch);
1099 common_debug("cURL error: $errmsg - trying to send notice for $twitter_user.",
1107 common_debug("No data returned by Twitter's API trying to send update for $twitter_user",
1112 // Twitter should return a status
1113 $status = json_decode($data);
1116 common_debug("Unexpected data returned by Twitter API trying to send update for $twitter_user",
1124 // Stick the notice on the queue
1126 function common_enqueue_notice($notice)
1128 foreach (array('jabber', 'omb', 'sms', 'public') as $transport) {
1129 $qi = new Queue_item();
1130 $qi->notice_id = $notice->id;
1131 $qi->transport = $transport;
1132 $qi->created = $notice->created;
1133 $result = $qi->insert();
1135 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1136 common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
1139 common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
1144 function common_real_broadcast($notice, $remote=false)
1148 // Make sure we have the OMB stuff
1149 require_once(INSTALLDIR.'/lib/omb.php');
1150 $success = omb_broadcast_remote_subscribers($notice);
1152 common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
1156 require_once(INSTALLDIR.'/lib/jabber.php');
1157 $success = jabber_broadcast_notice($notice);
1159 common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
1163 require_once(INSTALLDIR.'/lib/mail.php');
1164 $success = mail_broadcast_notice_sms($notice);
1166 common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
1170 $success = jabber_public_notice($notice);
1172 common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
1175 // XXX: broadcast notices to other IM
1179 function common_broadcast_profile($profile)
1181 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1182 require_once(INSTALLDIR.'/lib/omb.php');
1183 omb_broadcast_profile($profile);
1184 // XXX: Other broadcasts...?
1188 function common_profile_url($nickname)
1190 return common_local_url('showstream', array('nickname' => $nickname));
1193 // Should make up a reasonable root URL
1195 function common_root_url()
1197 return common_path('');
1200 // returns $bytes bytes of random data as a hexadecimal string
1201 // "good" here is a goal and not a guarantee
1203 function common_good_rand($bytes)
1205 // XXX: use random.org...?
1206 if (file_exists('/dev/urandom')) {
1207 return common_urandom($bytes);
1208 } else { // FIXME: this is probably not good enough
1209 return common_mtrand($bytes);
1213 function common_urandom($bytes)
1215 $h = fopen('/dev/urandom', 'rb');
1217 $src = fread($h, $bytes);
1220 for ($i = 0; $i < $bytes; $i++) {
1221 $enc .= sprintf("%02x", (ord($src[$i])));
1226 function common_mtrand($bytes)
1229 for ($i = 0; $i < $bytes; $i++) {
1230 $enc .= sprintf("%02x", mt_rand(0, 255));
1235 function common_set_returnto($url)
1237 common_ensure_session();
1238 $_SESSION['returnto'] = $url;
1241 function common_get_returnto()
1243 common_ensure_session();
1244 return $_SESSION['returnto'];
1247 function common_timestamp()
1249 return date('YmdHis');
1252 function common_ensure_syslog()
1254 static $initialized = false;
1255 if (!$initialized) {
1257 openlog($config['syslog']['appname'], 0, LOG_USER);
1258 $initialized = true;
1262 function common_log($priority, $msg, $filename=null)
1264 $logfile = common_config('site', 'logfile');
1266 $log = fopen($logfile, "a");
1268 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1269 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1270 $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1271 fwrite($log, $output);
1275 common_ensure_syslog();
1276 syslog($priority, $msg);
1280 function common_debug($msg, $filename=null)
1283 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1285 common_log(LOG_DEBUG, $msg);
1289 function common_log_db_error(&$object, $verb, $filename=null)
1291 $objstr = common_log_objstring($object);
1292 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1293 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1296 function common_log_objstring(&$object)
1298 if (is_null($object)) {
1301 $arr = $object->toArray();
1303 foreach ($arr as $k => $v) {
1304 $fields[] = "$k='$v'";
1306 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1310 function common_valid_http_url($url)
1312 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1315 function common_valid_tag($tag)
1317 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1318 return (Validate::email($matches[1]) ||
1319 preg_match('/^([\w-\.]+)$/', $matches[1]));
1324 /* Following functions are copied from MediaWiki GlobalFunctions.php
1325 * and written by Evan Prodromou. */
1327 function common_accept_to_prefs($accept, $def = '*/*')
1329 // No arg means accept anything (per HTTP spec)
1331 return array($def => 1);
1336 $parts = explode(',', $accept);
1338 foreach($parts as $part) {
1339 // FIXME: doesn't deal with params like 'text/html; level=1'
1340 @list($value, $qpart) = explode(';', $part);
1342 if(!isset($qpart)) {
1344 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1345 $prefs[$value] = $match[1];
1352 function common_mime_type_match($type, $avail)
1354 if(array_key_exists($type, $avail)) {
1357 $parts = explode('/', $type);
1358 if(array_key_exists($parts[0] . '/*', $avail)) {
1359 return $parts[0] . '/*';
1360 } elseif(array_key_exists('*/*', $avail)) {
1368 function common_negotiate_type($cprefs, $sprefs)
1372 foreach(array_keys($sprefs) as $type) {
1373 $parts = explode('/', $type);
1374 if($parts[1] != '*') {
1375 $ckey = common_mime_type_match($type, $cprefs);
1377 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1382 foreach(array_keys($cprefs) as $type) {
1383 $parts = explode('/', $type);
1384 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1385 $skey = common_mime_type_match($type, $sprefs);
1387 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1393 $besttype = 'text/html';
1395 foreach(array_keys($combine) as $type) {
1396 if($combine[$type] > $bestq) {
1398 $bestq = $combine[$type];
1402 if ('text/html' === $besttype) {
1403 return "text/html; charset=utf-8";
1408 function common_config($main, $sub)
1411 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1414 function common_copy_args($from)
1417 $strip = get_magic_quotes_gpc();
1418 foreach ($from as $k => $v) {
1419 $to[$k] = ($strip) ? stripslashes($v) : $v;
1424 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1425 // This is used before handing a request off to OAuthRequest::from_request.
1426 function common_remove_magic_from_request()
1428 if(get_magic_quotes_gpc()) {
1429 $_POST=array_map('stripslashes',$_POST);
1430 $_GET=array_map('stripslashes',$_GET);
1434 function common_user_uri(&$user)
1436 return common_local_url('userbyid', array('id' => $user->id));
1439 function common_notice_uri(&$notice)
1441 return common_local_url('shownotice',
1442 array('notice' => $notice->id));
1445 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1447 function common_confirmation_code($bits)
1449 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1450 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1451 $chars = ceil($bits/5);
1453 for ($i = 0; $i < $chars; $i++) {
1454 // XXX: convert to string and back
1455 $num = hexdec(common_good_rand(1));
1456 // XXX: randomness is too precious to throw away almost
1457 // 40% of the bits we get!
1458 $code .= $codechars[$num%32];
1463 // convert markup to HTML
1465 function common_markup_to_html($c)
1467 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1468 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1469 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1470 return Markdown($c);
1473 function common_profile_avatar_url($profile, $size=AVATAR_PROFILE_SIZE)
1475 $avatar = $profile->getAvatar($size);
1477 return common_avatar_display_url($avatar);
1479 return common_default_avatar($size);
1483 function common_profile_uri($profile)
1488 $user = User::staticGet($profile->id);
1493 $remote = Remote_profile::staticGet($profile->id);
1495 return $remote->uri;
1497 // XXX: this is a very bad profile!
1501 function common_canonical_sms($sms)
1504 preg_replace('/\D/', '', $sms);
1508 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1512 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1516 case E_USER_WARNING:
1517 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1521 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1525 // FIXME: show error page if we're on the Web
1526 /* Don't execute PHP internal error handler */
1530 function common_session_token()
1532 common_ensure_session();
1533 if (!array_key_exists('token', $_SESSION)) {
1534 $_SESSION['token'] = common_good_rand(64);
1536 return $_SESSION['token'];
1539 function common_cache_key($extra)
1541 return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1544 function common_keyize($str)
1546 $str = strtolower($str);
1547 $str = preg_replace('/\s/', '_', $str);
1551 function common_memcache()
1553 static $cache = null;
1554 if (!common_config('memcached', 'enabled')) {
1558 $cache = new Memcache();
1559 $servers = common_config('memcached', 'server');
1560 if (is_array($servers)) {
1561 foreach($servers as $server) {
1562 $cache->addServer($server);
1565 $cache->addServer($servers);
1572 function common_compatible_license($from, $to)
1574 // XXX: better compatibility check needed here!
1575 return ($from == $to);