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;
75 return common_config('site', 'timezone');
78 function common_language()
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;
87 return $user_language;
90 // Otherwise, find the best match for the languages requested by the
92 $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
93 if (!empty($httplang)) {
94 $language = client_prefered_language($httplang);
99 // Finally, if none of the above worked, use the site's default...
100 return common_config('site', 'language');
102 // salted, hashed passwords are stored in the DB
104 function common_munge_password($password, $id)
106 return md5($password . $id);
109 // check if a username exists and has matching password
110 function common_check_user($nickname, $password)
112 // NEVER allow blank passwords, even if they match the DB
113 if (mb_strlen($password) == 0) {
116 $user = User::staticGet('nickname', $nickname);
117 if (is_null($user)) {
120 if (0 == strcmp(common_munge_password($password, $user->id),
129 // is the current user logged in?
130 function common_logged_in()
132 return (!is_null(common_current_user()));
135 function common_have_session()
137 return (0 != strcmp(session_id(), ''));
140 function common_ensure_session()
142 if (!common_have_session()) {
147 // Three kinds of arguments:
152 // Initialize to false; set to null if none found
156 function common_set_user($user)
161 if (is_null($user) && common_have_session()) {
163 unset($_SESSION['userid']);
165 } else if (is_string($user)) {
167 $user = User::staticGet('nickname', $nickname);
168 } else if (!($user instanceof User)) {
173 common_ensure_session();
174 $_SESSION['userid'] = $user->id;
181 function common_set_cookie($key, $value, $expiration=0)
183 $path = common_config('site', 'path');
184 $server = common_config('site', 'server');
186 if ($path && ($path != '/')) {
187 $cookiepath = '/' . $path . '/';
191 return setcookie($key,
198 define('REMEMBERME', 'rememberme');
199 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
201 function common_rememberme($user=null)
204 $user = common_current_user();
206 common_debug('No current user to remember', __FILE__);
211 $rm = new Remember_me();
213 $rm->code = common_good_rand(16);
214 $rm->user_id = $user->id;
216 // Wrap the insert in some good ol' fashioned transaction code
220 $result = $rm->insert();
223 common_log_db_error($rm, 'INSERT', __FILE__);
224 common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
228 $rm->query('COMMIT');
230 common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
232 $cookieval = $rm->user_id . ':' . $rm->code;
234 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
236 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
241 function common_remembered_user()
246 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
252 list($id, $code) = explode(':', $packed);
254 if (!$id || !$code) {
255 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
260 $rm = Remember_me::staticGet($code);
263 common_log(LOG_WARNING, 'No such remember code: ' . $code);
268 if ($rm->user_id != $id) {
269 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
274 $user = User::staticGet($rm->user_id);
277 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
283 $result = $rm->delete();
286 common_log_db_error($rm, 'DELETE', __FILE__);
287 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
292 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
294 common_set_user($user);
295 common_real_login(false);
297 // We issue a new cookie, so they can log in
298 // automatically again after this session
300 common_rememberme($user);
305 // must be called with a valid user!
307 function common_forgetme()
309 common_set_cookie(REMEMBERME, '', 0);
312 // who is the current user?
313 function common_current_user()
317 if (!_have_config()) {
321 if ($_cur === false) {
323 if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
324 common_ensure_session();
325 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
327 $_cur = User::staticGet($id);
332 // that didn't work; try to remember; will init $_cur to null on failure
333 $_cur = common_remembered_user();
336 common_debug("Got User " . $_cur->nickname);
337 common_debug("Faking session on remembered user");
338 // XXX: Is this necessary?
339 $_SESSION['userid'] = $_cur->id;
346 // Logins that are 'remembered' aren't 'real' -- they're subject to
347 // cookie-stealing. So, we don't let them do certain things. New reg,
348 // OpenID, and password logins _are_ real.
350 function common_real_login($real=true)
352 common_ensure_session();
353 $_SESSION['real_login'] = $real;
356 function common_is_real_login()
358 return common_logged_in() && $_SESSION['real_login'];
361 // get canonical version of nickname for comparison
362 function common_canonical_nickname($nickname)
364 // XXX: UTF-8 canonicalization (like combining chars)
365 return strtolower($nickname);
368 // get canonical version of email for comparison
369 function common_canonical_email($email)
371 // XXX: canonicalize UTF-8
372 // XXX: lcase the domain part
376 function common_render_content($text, $notice)
378 $r = common_render_text($text);
379 $id = $notice->profile_id;
380 $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
381 $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
382 $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
383 $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
387 function common_render_text($text)
389 $r = htmlspecialchars($text);
391 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
392 $r = common_replace_urls_callback($r, 'common_linkify');
393 $r = preg_replace('/(^|\(|\[|\s+)#([A-Za-z0-9_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
398 function common_replace_urls_callback($text, $callback) {
399 // Start off with a regex
403 '(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|xmpp|irc)://'.
405 '(?:mailto|aim|tel):'.
410 '(?:museum|travel|[a-z]{2,4})'.
414 preg_match_all($regex, $text, $matches);
416 // Then clean up what the regex left behind
418 foreach($matches[0] as $orig_url) {
419 $url = htmlspecialchars_decode($orig_url);
421 // Make sure we didn't pick up an email address
422 if (preg_match('#^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$#i', $url)) continue;
424 // Remove surrounding punctuation
425 $url = trim($url, '.?!,;:\'"`([<');
427 // Remove surrounding parens and the like
428 preg_match('/[)\]>]+$/', $url, $trailing);
429 if (isset($trailing[0])) {
430 preg_match_all('/[(\[<]/', $url, $opened);
431 preg_match_all('/[)\]>]/', $url, $closed);
432 $unopened = count($closed[0]) - count($opened[0]);
434 // Make sure not to take off more closing parens than there are at the end
435 $unopened = ($unopened > mb_strlen($trailing[0])) ? mb_strlen($trailing[0]):$unopened;
437 $url = ($unopened > 0) ? mb_substr($url, 0, $unopened * -1):$url;
440 // Remove trailing punctuation again (in case there were some inside parens)
441 $url = rtrim($url, '.?!,;:\'"`');
443 // Make sure we didn't capture part of the next sentence
444 preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
446 // Were the parts capitalized any?
447 $last_part = (mb_strtolower($url_parts[2]) !== $url_parts[2]) ? true:false;
448 $prev_part = (mb_strtolower($url_parts[1]) !== $url_parts[1]) ? true:false;
450 // If the first part wasn't cap'd but the last part was, we captured too much
451 if ((!$prev_part && $last_part)) {
452 $url = mb_substr($url, 0 , mb_strpos($url, '.'.$url_parts['2'], 0));
455 // Capture the new TLD
456 preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
458 $tlds = array('ac', 'ad', 'ae', 'aero', 'af', 'ag', 'ai', 'al', 'am', 'an', 'ao', 'aq', 'ar', 'arpa', 'as', 'asia', 'at', 'au', 'aw', 'ax', 'az', 'ba', 'bb', 'bd', 'be', 'bf', 'bg', 'bh', 'bi', 'biz', 'bj', 'bm', 'bn', 'bo', 'br', 'bs', 'bt', 'bv', 'bw', 'by', 'bz', 'ca', 'cat', 'cc', 'cd', 'cf', 'cg', 'ch', 'ci', 'ck', 'cl', 'cm', 'cn', 'co', 'com', 'coop', 'cr', 'cu', 'cv', 'cx', 'cy', 'cz', 'de', 'dj', 'dk', 'dm', 'do', 'dz', 'ec', 'edu', 'ee', 'eg', 'er', 'es', 'et', 'eu', 'fi', 'fj', 'fk', 'fm', 'fo', 'fr', 'ga', 'gb', 'gd', 'ge', 'gf', 'gg', 'gh', 'gi', 'gl', 'gm', 'gn', 'gov', 'gp', 'gq', 'gr', 'gs', 'gt', 'gu', 'gw', 'gy', 'hk', 'hm', 'hn', 'hr', 'ht', 'hu', 'id', 'ie', 'il', 'im', 'in', 'info', 'int', 'io', 'iq', 'ir', 'is', 'it', 'je', 'jm', 'jo', 'jobs', 'jp', 'ke', 'kg', 'kh', 'ki', 'km', 'kn', 'kp', 'kr', 'kw', 'ky', 'kz', 'la', 'lb', 'lc', 'li', 'lk', 'lr', 'ls', 'lt', 'lu', 'lv', 'ly', 'ma', 'mc', 'md', 'me', 'mg', 'mh', 'mil', 'mk', 'ml', 'mm', 'mn', 'mo', 'mobi', 'mp', 'mq', 'mr', 'ms', 'mt', 'mu', 'museum', 'mv', 'mw', 'mx', 'my', 'mz', 'na', 'name', 'nc', 'ne', 'net', 'nf', 'ng', 'ni', 'nl', 'no', 'np', 'nr', 'nu', 'nz', 'om', 'org', 'pa', 'pe', 'pf', 'pg', 'ph', 'pk', 'pl', 'pm', 'pn', 'pr', 'pro', 'ps', 'pt', 'pw', 'py', 'qa', 're', 'ro', 'rs', 'ru', 'rw', 'sa', 'sb', 'sc', 'sd', 'se', 'sg', 'sh', 'si', 'sj', 'sk', 'sl', 'sm', 'sn', 'so', 'sr', 'st', 'su', 'sv', 'sy', 'sz', 'tc', 'td', 'tel', 'tf', 'tg', 'th', 'tj', 'tk', 'tl', 'tm', 'tn', 'to', 'tp', 'tr', 'travel', 'tt', 'tv', 'tw', 'tz', 'ua', 'ug', 'uk', 'us', 'uy', 'uz', 'va', 'vc', 've', 'vg', 'vi', 'vn', 'vu', 'wf', 'ws', 'ye', 'yt', 'yu', 'za', 'zm', 'zw');
460 if (!in_array($url_parts[2], $tlds)) continue;
462 // Make sure we didn't capture a hash tag
463 if (strpos($url, '#') === 0) continue;
465 // Put the url back the way we found it.
466 $url = (mb_strpos($orig_url, htmlspecialchars($url)) === FALSE) ? $url:htmlspecialchars($url);
468 // Call user specified func
469 $modified_url = call_user_func($callback, $url);
472 $start = mb_strpos($text, $url, $offset);
473 $text = mb_substr($text, 0, $start).$modified_url.mb_substr($text, $start + mb_strlen($url), mb_strlen($text));
474 $offset = $start + mb_strlen($modified_url);
480 function common_linkify($url) {
481 // It comes in special'd, so we unspecial it before passing to the stringifying
483 $url = htmlspecialchars_decode($url);
485 $url = (!preg_match('#^([a-z]+://|(mailto|aim|tel):)#i', $url)) ? 'http://'.$url : $url;
487 $attrs = array('href' => $url, 'rel' => 'external');
489 if ($longurl = common_longurl($url)) {
490 $attrs['title'] = $longurl;
493 return XMLStringer::estring('a', $attrs, $display);
496 function common_longurl($short_url)
498 $long_url = common_shorten_link($short_url, true);
499 if ($long_url === $short_url) return false;
503 function common_longurl2($uri)
505 $uri_e = urlencode($uri);
506 $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
507 if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
508 return stripslashes($longurl['long_url']);
511 function common_shorten_links($text)
513 if (mb_strlen($text) <= 140) return $text;
514 static $cache = array();
515 if (isset($cache[$text])) return $cache[$text];
516 // \s = not a horizontal whitespace character (since PHP 5.2.4)
517 return $cache[$text] = common_replace_urls_callback($text, 'common_shorten_link');;
520 function common_shorten_link($url, $reverse = false)
523 static $url_cache = array();
524 if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
526 $user = common_current_user();
528 // common current user does not find a user when called from the XMPP daemon
529 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
530 $user->urlshorteningservice = 'ur1.ca';
532 $curlh = curl_init();
533 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
534 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
535 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
537 switch($user->urlshorteningservice) {
539 $short_url_service = new LilUrl;
540 $short_url = $short_url_service->shorten($url);
544 $short_url_service = new TightUrl;
545 $short_url = $short_url_service->shorten($url);
549 $short_url_service = new PtitUrl;
550 $short_url = $short_url_service->shorten($url);
554 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
555 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
559 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
560 $short_url = curl_exec($curlh);
563 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
564 $short_url = curl_exec($curlh);
567 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
568 $short_url = curl_exec($curlh);
571 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
572 $short_url = curl_exec($curlh);
581 $url_cache[(string)$short_url] = $url;
582 return (string)$short_url;
587 function common_xml_safe_str($str)
589 // Neutralize control codes and surrogates
590 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
593 function common_tag_link($tag)
595 $canonical = common_canonical_tag($tag);
596 $url = common_local_url('tag', array('tag' => $canonical));
597 $xs = new XMLStringer();
598 $xs->elementStart('span', 'tag');
599 $xs->element('a', array('href' => $url,
602 $xs->elementEnd('span');
603 return $xs->getString();
606 function common_canonical_tag($tag)
608 return strtolower(str_replace(array('-', '_', '.'), '', $tag));
611 function common_valid_profile_tag($str)
613 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
616 function common_at_link($sender_id, $nickname)
618 $sender = Profile::staticGet($sender_id);
619 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
621 $user = User::staticGet('id', $recipient->id);
623 $url = common_local_url('userbyid', array('id' => $user->id));
625 $url = $recipient->profileurl;
627 $xs = new XMLStringer(false);
628 $attrs = array('href' => $url,
630 if (!empty($recipient->fullname)) {
631 $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
633 $xs->elementStart('span', 'vcard');
634 $xs->elementStart('a', $attrs);
635 $xs->element('span', 'fn nickname', $nickname);
636 $xs->elementEnd('a');
637 $xs->elementEnd('span');
638 return $xs->getString();
644 function common_group_link($sender_id, $nickname)
646 $sender = Profile::staticGet($sender_id);
647 $group = User_group::staticGet('nickname', common_canonical_nickname($nickname));
648 if ($group && $sender->isMember($group)) {
649 $attrs = array('href' => $group->permalink(),
651 if (!empty($group->fullname)) {
652 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
654 $xs = new XMLStringer();
655 $xs->elementStart('span', 'vcard');
656 $xs->elementStart('a', $attrs);
657 $xs->element('span', 'fn nickname', $nickname);
658 $xs->elementEnd('a');
659 $xs->elementEnd('span');
660 return $xs->getString();
666 function common_at_hash_link($sender_id, $tag)
668 $user = User::staticGet($sender_id);
672 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
674 $url = common_local_url('subscriptions',
675 array('nickname' => $user->nickname,
677 $xs = new XMLStringer();
678 $xs->elementStart('span', 'tag');
679 $xs->element('a', array('href' => $url,
682 $xs->elementEnd('span');
683 return $xs->getString();
689 function common_relative_profile($sender, $nickname, $dt=null)
691 // Try to find profiles this profile is subscribed to that have this nickname
692 $recipient = new Profile();
693 // XXX: use a join instead of a subquery
694 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
695 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
696 if ($recipient->find(true)) {
697 // XXX: should probably differentiate between profiles with
698 // the same name by date of most recent update
701 // Try to find profiles that listen to this profile and that have this nickname
702 $recipient = new Profile();
703 // XXX: use a join instead of a subquery
704 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
705 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
706 if ($recipient->find(true)) {
707 // XXX: should probably differentiate between profiles with
708 // the same name by date of most recent update
711 // If this is a local user, try to find a local user with that nickname.
712 $sender = User::staticGet($sender->id);
714 $recipient_user = User::staticGet('nickname', $nickname);
715 if ($recipient_user) {
716 return $recipient_user->getProfile();
719 // Otherwise, no links. @messages from local users to remote users,
720 // or from remote users to other remote users, are just
721 // outside our ability to make intelligent guesses about
725 function common_local_url($action, $args=null, $params=null, $fragment=null)
727 static $sensitive = array('login', 'register', 'passwordsettings',
728 'twittersettings', 'finishopenidlogin',
729 'finishaddopenid', 'api');
732 $path = $r->build($action, $args, $params, $fragment);
734 $ssl = in_array($action, $sensitive);
736 if (common_config('site','fancy')) {
737 $url = common_path(mb_substr($path, 1), $ssl);
739 if (mb_strpos($path, '/index.php') === 0) {
740 $url = common_path(mb_substr($path, 1), $ssl);
742 $url = common_path('index.php'.$path, $ssl);
748 function common_path($relative, $ssl=false)
750 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
752 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
753 || common_config('site', 'ssl') === 'always') {
755 if (is_string(common_config('site', 'sslserver')) &&
756 mb_strlen(common_config('site', 'sslserver')) > 0) {
757 $serverpart = common_config('site', 'sslserver');
759 $serverpart = common_config('site', 'server');
763 $serverpart = common_config('site', 'server');
766 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
769 function common_date_string($dt)
771 // XXX: do some sexy date formatting
772 // return date(DATE_RFC822, $dt);
777 if ($now < $t) { // that shouldn't happen!
778 return common_exact_date($dt);
779 } else if ($diff < 60) {
780 return _('a few seconds ago');
781 } else if ($diff < 92) {
782 return _('about a minute ago');
783 } else if ($diff < 3300) {
784 return sprintf(_('about %d minutes ago'), round($diff/60));
785 } else if ($diff < 5400) {
786 return _('about an hour ago');
787 } else if ($diff < 22 * 3600) {
788 return sprintf(_('about %d hours ago'), round($diff/3600));
789 } else if ($diff < 37 * 3600) {
790 return _('about a day ago');
791 } else if ($diff < 24 * 24 * 3600) {
792 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
793 } else if ($diff < 46 * 24 * 3600) {
794 return _('about a month ago');
795 } else if ($diff < 330 * 24 * 3600) {
796 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
797 } else if ($diff < 480 * 24 * 3600) {
798 return _('about a year ago');
800 return common_exact_date($dt);
804 function common_exact_date($dt)
810 $_utc = new DateTimeZone('UTC');
811 $_siteTz = new DateTimeZone(common_timezone());
814 $dateStr = date('d F Y H:i:s', strtotime($dt));
815 $d = new DateTime($dateStr, $_utc);
816 $d->setTimezone($_siteTz);
817 return $d->format(DATE_RFC850);
820 function common_date_w3dtf($dt)
822 $dateStr = date('d F Y H:i:s', strtotime($dt));
823 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
824 $d->setTimezone(new DateTimeZone(common_timezone()));
825 return $d->format(DATE_W3C);
828 function common_date_rfc2822($dt)
830 $dateStr = date('d F Y H:i:s', strtotime($dt));
831 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
832 $d->setTimezone(new DateTimeZone(common_timezone()));
833 return $d->format('r');
836 function common_date_iso8601($dt)
838 $dateStr = date('d F Y H:i:s', strtotime($dt));
839 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
840 $d->setTimezone(new DateTimeZone(common_timezone()));
841 return $d->format('c');
844 function common_sql_now()
846 return strftime('%Y-%m-%d %H:%M:%S', time());
849 function common_redirect($url, $code=307)
851 static $status = array(301 => "Moved Permanently",
854 307 => "Temporary Redirect");
856 header('HTTP/1.1 '.$code.' '.$status[$code]);
857 header("Location: $url");
859 $xo = new XMLOutputter();
861 '-//W3C//DTD XHTML 1.0 Strict//EN',
862 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
863 $xo->element('a', array('href' => $url), $url);
868 function common_broadcast_notice($notice, $remote=false)
870 if (common_config('queue', 'enabled')) {
872 return common_enqueue_notice($notice);
874 return common_real_broadcast($notice, $remote);
878 // Stick the notice on the queue
880 function common_enqueue_notice($notice)
882 foreach (array('jabber', 'omb', 'sms', 'public', 'twitter', 'facebook', 'ping') as $transport) {
883 $qi = new Queue_item();
884 $qi->notice_id = $notice->id;
885 $qi->transport = $transport;
886 $qi->created = $notice->created;
887 $result = $qi->insert();
889 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
890 common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
893 common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
898 function common_real_broadcast($notice, $remote=false)
902 // Make sure we have the OMB stuff
903 require_once(INSTALLDIR.'/lib/omb.php');
904 $success = omb_broadcast_remote_subscribers($notice);
906 common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
910 require_once(INSTALLDIR.'/lib/jabber.php');
911 $success = jabber_broadcast_notice($notice);
913 common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
917 require_once(INSTALLDIR.'/lib/mail.php');
918 $success = mail_broadcast_notice_sms($notice);
920 common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
924 $success = jabber_public_notice($notice);
926 common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
930 $success = broadcast_twitter($notice);
932 common_log(LOG_ERR, 'Error in Twitter broadcast for notice ' . $notice->id);
936 // XXX: Do a real-time FB broadcast here?
938 // XXX: broadcast notices to other IM
942 function common_broadcast_profile($profile)
944 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
945 require_once(INSTALLDIR.'/lib/omb.php');
946 omb_broadcast_profile($profile);
947 // XXX: Other broadcasts...?
951 function common_profile_url($nickname)
953 return common_local_url('showstream', array('nickname' => $nickname));
956 // Should make up a reasonable root URL
958 function common_root_url($ssl=false)
960 return common_path('', $ssl);
963 // returns $bytes bytes of random data as a hexadecimal string
964 // "good" here is a goal and not a guarantee
966 function common_good_rand($bytes)
968 // XXX: use random.org...?
969 if (@file_exists('/dev/urandom')) {
970 return common_urandom($bytes);
971 } else { // FIXME: this is probably not good enough
972 return common_mtrand($bytes);
976 function common_urandom($bytes)
978 $h = fopen('/dev/urandom', 'rb');
980 $src = fread($h, $bytes);
983 for ($i = 0; $i < $bytes; $i++) {
984 $enc .= sprintf("%02x", (ord($src[$i])));
989 function common_mtrand($bytes)
992 for ($i = 0; $i < $bytes; $i++) {
993 $enc .= sprintf("%02x", mt_rand(0, 255));
998 function common_set_returnto($url)
1000 common_ensure_session();
1001 $_SESSION['returnto'] = $url;
1004 function common_get_returnto()
1006 common_ensure_session();
1007 return $_SESSION['returnto'];
1010 function common_timestamp()
1012 return date('YmdHis');
1015 function common_ensure_syslog()
1017 static $initialized = false;
1018 if (!$initialized) {
1019 openlog(common_config('syslog', 'appname'), 0, LOG_USER);
1020 $initialized = true;
1024 function common_log($priority, $msg, $filename=null)
1026 $logfile = common_config('site', 'logfile');
1028 $log = fopen($logfile, "a");
1030 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1031 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1032 $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1033 fwrite($log, $output);
1037 common_ensure_syslog();
1038 syslog($priority, $msg);
1042 function common_debug($msg, $filename=null)
1045 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1047 common_log(LOG_DEBUG, $msg);
1051 function common_log_db_error(&$object, $verb, $filename=null)
1053 $objstr = common_log_objstring($object);
1054 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1055 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1058 function common_log_objstring(&$object)
1060 if (is_null($object)) {
1063 $arr = $object->toArray();
1065 foreach ($arr as $k => $v) {
1066 $fields[] = "$k='$v'";
1068 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1072 function common_valid_http_url($url)
1074 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1077 function common_valid_tag($tag)
1079 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1080 return (Validate::email($matches[1]) ||
1081 preg_match('/^([\w-\.]+)$/', $matches[1]));
1086 /* Following functions are copied from MediaWiki GlobalFunctions.php
1087 * and written by Evan Prodromou. */
1089 function common_accept_to_prefs($accept, $def = '*/*')
1091 // No arg means accept anything (per HTTP spec)
1093 return array($def => 1);
1098 $parts = explode(',', $accept);
1100 foreach($parts as $part) {
1101 // FIXME: doesn't deal with params like 'text/html; level=1'
1102 @list($value, $qpart) = explode(';', $part);
1104 if(!isset($qpart)) {
1106 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1107 $prefs[$value] = $match[1];
1114 function common_mime_type_match($type, $avail)
1116 if(array_key_exists($type, $avail)) {
1119 $parts = explode('/', $type);
1120 if(array_key_exists($parts[0] . '/*', $avail)) {
1121 return $parts[0] . '/*';
1122 } elseif(array_key_exists('*/*', $avail)) {
1130 function common_negotiate_type($cprefs, $sprefs)
1134 foreach(array_keys($sprefs) as $type) {
1135 $parts = explode('/', $type);
1136 if($parts[1] != '*') {
1137 $ckey = common_mime_type_match($type, $cprefs);
1139 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1144 foreach(array_keys($cprefs) as $type) {
1145 $parts = explode('/', $type);
1146 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1147 $skey = common_mime_type_match($type, $sprefs);
1149 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1155 $besttype = 'text/html';
1157 foreach(array_keys($combine) as $type) {
1158 if($combine[$type] > $bestq) {
1160 $bestq = $combine[$type];
1164 if ('text/html' === $besttype) {
1165 return "text/html; charset=utf-8";
1170 function common_config($main, $sub)
1173 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1176 function common_copy_args($from)
1179 $strip = get_magic_quotes_gpc();
1180 foreach ($from as $k => $v) {
1181 $to[$k] = ($strip) ? stripslashes($v) : $v;
1186 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1187 // This is used before handing a request off to OAuthRequest::from_request.
1188 function common_remove_magic_from_request()
1190 if(get_magic_quotes_gpc()) {
1191 $_POST=array_map('stripslashes',$_POST);
1192 $_GET=array_map('stripslashes',$_GET);
1196 function common_user_uri(&$user)
1198 return common_local_url('userbyid', array('id' => $user->id));
1201 function common_notice_uri(&$notice)
1203 return common_local_url('shownotice',
1204 array('notice' => $notice->id));
1207 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1209 function common_confirmation_code($bits)
1211 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1212 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1213 $chars = ceil($bits/5);
1215 for ($i = 0; $i < $chars; $i++) {
1216 // XXX: convert to string and back
1217 $num = hexdec(common_good_rand(1));
1218 // XXX: randomness is too precious to throw away almost
1219 // 40% of the bits we get!
1220 $code .= $codechars[$num%32];
1225 // convert markup to HTML
1227 function common_markup_to_html($c)
1229 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1230 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1231 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1232 return Markdown($c);
1235 function common_profile_uri($profile)
1240 $user = User::staticGet($profile->id);
1245 $remote = Remote_profile::staticGet($profile->id);
1247 return $remote->uri;
1249 // XXX: this is a very bad profile!
1253 function common_canonical_sms($sms)
1256 preg_replace('/\D/', '', $sms);
1260 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1264 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1268 case E_USER_WARNING:
1269 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1273 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1277 // FIXME: show error page if we're on the Web
1278 /* Don't execute PHP internal error handler */
1282 function common_session_token()
1284 common_ensure_session();
1285 if (!array_key_exists('token', $_SESSION)) {
1286 $_SESSION['token'] = common_good_rand(64);
1288 return $_SESSION['token'];
1291 function common_cache_key($extra)
1293 return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1296 function common_keyize($str)
1298 $str = strtolower($str);
1299 $str = preg_replace('/\s/', '_', $str);
1303 function common_memcache()
1305 static $cache = null;
1306 if (!common_config('memcached', 'enabled')) {
1310 $cache = new Memcache();
1311 $servers = common_config('memcached', 'server');
1312 if (is_array($servers)) {
1313 foreach($servers as $server) {
1314 $cache->addServer($server);
1317 $cache->addServer($servers);
1324 function common_compatible_license($from, $to)
1326 // XXX: better compatibility check needed here!
1327 return ($from == $to);
1331 * returns a quoted table name, if required according to config
1333 function common_database_tablename($tablename)
1336 if(common_config('db','quote_identifiers')) {
1337 $tablename = '"'. $tablename .'"';
1339 //table prefixes could be added here later