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 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$_+!*();/?:~-]))');
375 function common_render_content($text, $notice)
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);
386 function common_render_text($text)
388 $r = htmlspecialchars($text);
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);
397 function common_render_uri_thingy($matches)
402 // Some heuristics for extracting URIs from surrounding punctuation
403 // Strip from trailing text...
404 if (preg_match('/^(.*)([,.:"\']+)$/', $uri, $matches)) {
406 $trailer = $matches[2];
410 ']' => '[', // technically disallowed in URIs, but used in Java docs
411 ')' => '(', // far too frequent in Wikipedia and MSDN
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;
423 if ($longurl = common_longurl($uri)) {
424 $longurl = htmlentities($longurl, ENT_QUOTES, 'UTF-8');
425 $title = " title='$longurl'";
429 return '<a href="' . $uri . '"' . $title . ' class="extlink">' . $uri . '</a>' . $trailer;
432 function common_longurl($short_url)
434 $long_url = common_shorten_link($short_url, true);
435 if ($long_url === $short_url) return false;
439 function common_longurl2($uri)
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']);
447 function common_shorten_links($text)
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);
456 function common_shorten_link($url, $reverse = false)
458 static $url_cache = array();
459 if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
461 $user = common_current_user();
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);
468 switch($user->urlshorteningservice) {
470 $short_url_service = new LilUrl;
471 $short_url = $short_url_service->shorten($url);
475 $short_url_service = new TightUrl;
476 $short_url = $short_url_service->shorten($url);
480 $short_url_service = new PtitUrl;
481 $short_url = $short_url_service->shorten($url);
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;
490 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
491 $short_url = curl_exec($curlh);
494 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
495 $short_url = curl_exec($curlh);
498 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
499 $short_url = curl_exec($curlh);
502 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
503 $short_url = curl_exec($curlh);
512 $url_cache[(string)$short_url] = $url;
513 return (string)$short_url;
518 function common_xml_safe_str($str)
520 $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
522 // Replace control, formatting, and surrogate characters with '*', ala Twitter
523 return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
526 function common_tag_link($tag)
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>';
533 function common_canonical_tag($tag)
535 return strtolower(str_replace(array('-', '_', '.'), '', $tag));
538 function common_valid_profile_tag($str)
540 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
543 function common_at_link($sender_id, $nickname)
545 $sender = Profile::staticGet($sender_id);
546 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
548 return '<span class="vcard"><a href="'.htmlspecialchars($recipient->profileurl).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
554 function common_group_link($sender_id, $nickname)
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>';
565 function common_at_hash_link($sender_id, $tag)
567 $user = User::staticGet($sender_id);
571 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
573 $url = common_local_url('subscriptions',
574 array('nickname' => $user->nickname,
576 return '<span class="tag"><a href="'.htmlspecialchars($url).'" rel="tag">'.$tag.'</a></span>';
582 function common_relative_profile($sender, $nickname, $dt=null)
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
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
604 // If this is a local user, try to find a local user with that nickname.
605 $sender = User::staticGet($sender->id);
607 $recipient_user = User::staticGet('nickname', $nickname);
608 if ($recipient_user) {
609 return $recipient_user->getProfile();
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
618 // where should the avatar go for this user?
620 function common_avatar_filename($id, $extension, $size=null, $extra=null)
625 return $id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
627 return $id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
631 function common_avatar_path($filename)
634 return INSTALLDIR . '/avatar/' . $filename;
637 function common_avatar_url($filename)
639 return common_path('avatar/'.$filename);
642 function common_avatar_display_url($avatar)
644 $server = common_config('avatar', 'server');
646 return 'http://'.$server.'/'.$avatar->filename;
652 function common_default_avatar($size)
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');
660 function common_local_url($action, $args=null, $fragment=null)
663 if (common_config('site','fancy')) {
664 $url = common_fancy_url($action, $args);
666 $url = common_simple_url($action, $args);
668 if (!is_null($fragment)) {
669 $url .= '#'.$fragment;
674 function common_fancy_url($action, $args=null)
676 switch (strtolower($action)) {
678 if ($args && isset($args['page'])) {
679 return common_path('?page=' . $args['page']);
681 return common_path('');
684 if ($args && isset($args['page'])) {
685 return common_path('featured?page=' . $args['page']);
687 return common_path('featured');
690 if ($args && isset($args['page'])) {
691 return common_path('favorited?page=' . $args['page']);
693 return common_path('favorited');
696 return common_path('rss');
698 return common_path("api/statuses/public_timeline.atom");
700 return common_path('xrds');
702 return common_path('featuredrss');
704 return common_path('favoritedrss');
706 if ($args && $args['type']) {
707 return common_path('opensearch/'.$args['type']);
709 return common_path('opensearch/people');
712 return common_path('doc/'.$args['title']);
719 return common_path('main/'.$action);
721 return common_path('main/tagother?id='.$args['id']);
723 if ($args && $args['code']) {
724 return common_path('main/register/'.$args['code']);
726 return common_path('main/register');
728 case 'remotesubscribe':
729 if ($args && $args['nickname']) {
730 return common_path('main/remote?nickname=' . $args['nickname']);
732 return common_path('main/remote');
735 return common_path($args['nickname'].'/nudge');
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');
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');
755 if ($args && $args['replyto']) {
756 return common_path('notice/new?replyto='.$args['replyto']);
758 return common_path('notice/new');
761 return common_path('notice/'.$args['notice']);
763 if ($args && $args['notice']) {
764 return common_path('notice/delete/'.$args['notice']);
766 return common_path('notice/delete');
771 return common_path($args['nickname'].'/'.$action);
776 if ($args && isset($args['page'])) {
777 return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
779 return common_path($args['nickname'].'/'.$action);
781 case 'subscriptions':
783 $nickname = $args['nickname'];
784 unset($args['nickname']);
785 if (isset($args['tag'])) {
789 $params = http_build_query($args);
791 return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : '') . '?' . $params);
793 return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : ''));
796 return common_path($args['nickname'].'/all/rss');
798 return common_path($args['nickname'].'/replies/rss');
800 if (isset($args['limit']))
801 return common_path($args['nickname'].'/rss?limit=' . $args['limit']);
802 return common_path($args['nickname'].'/rss');
804 if ($args && isset($args['page'])) {
805 return common_path($args['nickname'].'?page=' . $args['page']);
807 return common_path($args['nickname']);
811 return common_path("api/statuses/user_timeline/".$args['nickname'].".atom");
812 case 'confirmaddress':
813 return common_path('main/confirmaddress/'.$args['code']);
815 return common_path('user/'.$args['id']);
816 case 'recoverpassword':
817 $path = 'main/recoverpassword';
819 $path .= '/' . $args['code'];
821 return common_path($path);
823 return common_path('settings/im');
824 case 'avatarsettings':
825 return common_path('settings/avatar');
827 return common_path('search/people' . (($args) ? ('?' . http_build_query($args)) : ''));
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']);
835 $path = 'tag/' . $args['tag'];
837 return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
838 case 'publictagcloud':
839 return common_path('tags');
841 $path = 'peopletag/' . $args['tag'];
843 return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
845 return common_path('tags' . (($args) ? ('?' . http_build_query($args)) : ''));
847 return common_path('main/favor');
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']);
854 return common_path($args['nickname'].'/favorites');
857 return common_path($args['nickname'].'/favorites/rss');
859 return common_path('message/' . $args['message']);
861 return common_path('message/new' . (($args) ? ('?' . http_build_query($args)) : ''));
863 // XXX: do fancy URLs for all the API methods
864 switch (strtolower($args['apiaction'])) {
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);
877 default: return common_simple_url($action, $args);
880 if ($args && isset($args['seconds'])) {
881 return common_path('main/sup?seconds='.$args['seconds']);
883 return common_path('main/sup');
886 return common_path('group/new');
888 return common_path('group/'.$args['nickname']);
890 return common_path('group/'.$args['nickname'].'/edit');
892 return common_path('group/'.$args['nickname'].'/join');
894 return common_path('group/'.$args['nickname'].'/leave');
896 return common_path('group/'.$args['id'].'/id');
898 return common_path('group/'.$args['nickname'].'/rss');
900 return common_path('group/'.$args['nickname'].'/members');
902 return common_path('group/'.$args['nickname'].'/logo');
904 return common_path($args['nickname'].'/groups');
906 return common_path('group');
908 return common_simple_url($action, $args);
912 function common_simple_url($action, $args=null)
915 /* XXX: pretty URLs */
918 foreach ($args as $key => $value) {
919 $extra .= "&${key}=${value}";
922 return common_path("index.php?action=${action}${extra}");
925 function common_path($relative)
928 $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
929 return "http://".$config['site']['server'].'/'.$pathpart.$relative;
932 function common_date_string($dt)
934 // XXX: do some sexy date formatting
935 // return date(DATE_RFC822, $dt);
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');
963 return common_exact_date($dt);
967 function common_exact_date($dt)
973 $_utc = new DateTimeZone('UTC');
974 $_siteTz = new DateTimeZone(common_timezone());
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);
983 function common_date_w3dtf($dt)
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);
991 function common_date_rfc2822($dt)
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');
999 function common_date_iso8601($dt)
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');
1007 function common_sql_now()
1009 return strftime('%Y-%m-%d %H:%M:%S', time());
1012 function common_redirect($url, $code=307)
1014 static $status = array(301 => "Moved Permanently",
1017 307 => "Temporary Redirect");
1019 header("Status: ${code} $status[$code]");
1020 header("Location: $url");
1022 $xo = new XMLOutputter();
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);
1031 function common_broadcast_notice($notice, $remote=false)
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) {
1038 // If it's not a Twitter-style reply, or if the user WANTS to send replies...
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)) {
1043 $result = common_twitter_broadcast($notice, $flink);
1046 common_debug('Unable to send notice: ' . $notice->id . ' to Twitter.', __FILE__);
1051 if (common_config('queue', 'enabled')) {
1053 return common_enqueue_notice($notice);
1055 return common_real_broadcast($notice, $remote);
1059 function common_twitter_broadcast($notice, $flink)
1063 $fuser = $flink->getForeignUser();
1064 $twitter_user = $fuser->nickname;
1065 $twitter_password = $flink->credentials;
1066 $uri = 'http://www.twitter.com/statuses/update.json';
1068 // XXX: Hack to get around PHP cURL's use of @ being a a meta character
1069 $statustxt = preg_replace('/^@/', ' @', $notice->content);
1072 CURLOPT_USERPWD => "$twitter_user:$twitter_password",
1073 CURLOPT_POST => true,
1074 CURLOPT_POSTFIELDS => array(
1075 'status' => $statustxt,
1076 'source' => $config['integration']['source']
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,
1086 # Twitter is strict about accepting invalid "Expect" headers
1087 CURLOPT_HTTPHEADER => array('Expect:')
1090 $ch = curl_init($uri);
1091 curl_setopt_array($ch, $options);
1092 $data = curl_exec($ch);
1093 $errmsg = curl_error($ch);
1096 common_debug("cURL error: $errmsg - trying to send notice for $twitter_user.",
1104 common_debug("No data returned by Twitter's API trying to send update for $twitter_user",
1109 // Twitter should return a status
1110 $status = json_decode($data);
1113 common_debug("Unexpected data returned by Twitter API trying to send update for $twitter_user",
1121 // Stick the notice on the queue
1123 function common_enqueue_notice($notice)
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();
1132 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1133 common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
1136 common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
1141 function common_dequeue_notice($notice)
1143 $qi = Queue_item::staticGet($notice->id);
1145 $result = $qi->delete();
1147 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1148 common_log(LOG_ERR, 'DB error deleting queue item: ' . $last_error->message);
1151 common_log(LOG_DEBUG, 'complete dequeueing notice ID = ' . $notice->id);
1158 function common_real_broadcast($notice, $remote=false)
1162 // Make sure we have the OMB stuff
1163 require_once(INSTALLDIR.'/lib/omb.php');
1164 $success = omb_broadcast_remote_subscribers($notice);
1166 common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
1170 require_once(INSTALLDIR.'/lib/jabber.php');
1171 $success = jabber_broadcast_notice($notice);
1173 common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
1177 require_once(INSTALLDIR.'/lib/mail.php');
1178 $success = mail_broadcast_notice_sms($notice);
1180 common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
1184 $success = jabber_public_notice($notice);
1186 common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
1189 // XXX: broadcast notices to other IM
1193 function common_broadcast_profile($profile)
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...?
1202 function common_profile_url($nickname)
1204 return common_local_url('showstream', array('nickname' => $nickname));
1207 // Should make up a reasonable root URL
1209 function common_root_url()
1211 return common_path('');
1214 // returns $bytes bytes of random data as a hexadecimal string
1215 // "good" here is a goal and not a guarantee
1217 function common_good_rand($bytes)
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);
1227 function common_urandom($bytes)
1229 $h = fopen('/dev/urandom', 'rb');
1231 $src = fread($h, $bytes);
1234 for ($i = 0; $i < $bytes; $i++) {
1235 $enc .= sprintf("%02x", (ord($src[$i])));
1240 function common_mtrand($bytes)
1243 for ($i = 0; $i < $bytes; $i++) {
1244 $enc .= sprintf("%02x", mt_rand(0, 255));
1249 function common_set_returnto($url)
1251 common_ensure_session();
1252 $_SESSION['returnto'] = $url;
1255 function common_get_returnto()
1257 common_ensure_session();
1258 return $_SESSION['returnto'];
1261 function common_timestamp()
1263 return date('YmdHis');
1266 function common_ensure_syslog()
1268 static $initialized = false;
1269 if (!$initialized) {
1271 openlog($config['syslog']['appname'], 0, LOG_USER);
1272 $initialized = true;
1276 function common_log($priority, $msg, $filename=null)
1278 $logfile = common_config('site', 'logfile');
1280 $log = fopen($logfile, "a");
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);
1289 common_ensure_syslog();
1290 syslog($priority, $msg);
1294 function common_debug($msg, $filename=null)
1297 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1299 common_log(LOG_DEBUG, $msg);
1303 function common_log_db_error(&$object, $verb, $filename=null)
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);
1310 function common_log_objstring(&$object)
1312 if (is_null($object)) {
1315 $arr = $object->toArray();
1317 foreach ($arr as $k => $v) {
1318 $fields[] = "$k='$v'";
1320 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1324 function common_valid_http_url($url)
1326 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1329 function common_valid_tag($tag)
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]));
1338 /* Following functions are copied from MediaWiki GlobalFunctions.php
1339 * and written by Evan Prodromou. */
1341 function common_accept_to_prefs($accept, $def = '*/*')
1343 // No arg means accept anything (per HTTP spec)
1345 return array($def => 1);
1350 $parts = explode(',', $accept);
1352 foreach($parts as $part) {
1353 // FIXME: doesn't deal with params like 'text/html; level=1'
1354 @list($value, $qpart) = explode(';', $part);
1356 if(!isset($qpart)) {
1358 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1359 $prefs[$value] = $match[1];
1366 function common_mime_type_match($type, $avail)
1368 if(array_key_exists($type, $avail)) {
1371 $parts = explode('/', $type);
1372 if(array_key_exists($parts[0] . '/*', $avail)) {
1373 return $parts[0] . '/*';
1374 } elseif(array_key_exists('*/*', $avail)) {
1382 function common_negotiate_type($cprefs, $sprefs)
1386 foreach(array_keys($sprefs) as $type) {
1387 $parts = explode('/', $type);
1388 if($parts[1] != '*') {
1389 $ckey = common_mime_type_match($type, $cprefs);
1391 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
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);
1401 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1407 $besttype = "text/html";
1409 foreach(array_keys($combine) as $type) {
1410 if($combine[$type] > $bestq) {
1412 $bestq = $combine[$type];
1419 function common_config($main, $sub)
1422 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1425 function common_copy_args($from)
1428 $strip = get_magic_quotes_gpc();
1429 foreach ($from as $k => $v) {
1430 $to[$k] = ($strip) ? stripslashes($v) : $v;
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()
1439 if(get_magic_quotes_gpc()) {
1440 $_POST=array_map('stripslashes',$_POST);
1441 $_GET=array_map('stripslashes',$_GET);
1445 function common_user_uri(&$user)
1447 return common_local_url('userbyid', array('id' => $user->id));
1450 function common_notice_uri(&$notice)
1452 return common_local_url('shownotice',
1453 array('notice' => $notice->id));
1456 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1458 function common_confirmation_code($bits)
1460 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1461 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1462 $chars = ceil($bits/5);
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];
1474 // convert markup to HTML
1476 function common_markup_to_html($c)
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);
1484 function common_profile_avatar_url($profile, $size=AVATAR_PROFILE_SIZE)
1486 $avatar = $profile->getAvatar($size);
1488 return common_avatar_display_url($avatar);
1490 return common_default_avatar($size);
1494 function common_profile_uri($profile)
1499 $user = User::staticGet($profile->id);
1504 $remote = Remote_profile::staticGet($profile->id);
1506 return $remote->uri;
1508 // XXX: this is a very bad profile!
1512 function common_canonical_sms($sms)
1515 preg_replace('/\D/', '', $sms);
1519 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1523 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1527 case E_USER_WARNING:
1528 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1532 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1536 // FIXME: show error page if we're on the Web
1537 /* Don't execute PHP internal error handler */
1541 function common_session_token()
1543 common_ensure_session();
1544 if (!array_key_exists('token', $_SESSION)) {
1545 $_SESSION['token'] = common_good_rand(64);
1547 return $_SESSION['token'];
1550 function common_cache_key($extra)
1552 return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1555 function common_keyize($str)
1557 $str = strtolower($str);
1558 $str = preg_replace('/\s/', '_', $str);
1562 function common_memcache()
1564 static $cache = null;
1565 if (!common_config('memcached', 'enabled')) {
1569 $cache = new Memcache();
1570 $servers = common_config('memcached', 'server');
1571 if (is_array($servers)) {
1572 foreach($servers as $server) {
1573 $cache->addServer($server);
1576 $cache->addServer($servers);
1583 function common_compatible_license($from, $to)
1585 // XXX: better compatibility check needed here!
1586 return ($from == $to);