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 (_have_config() && 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 (!_have_config()) {
322 if ($_cur === false) {
324 if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
325 common_ensure_session();
326 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
328 $_cur = User::staticGet($id);
333 // that didn't work; try to remember; will init $_cur to null on failure
334 $_cur = common_remembered_user();
337 common_debug("Got User " . $_cur->nickname);
338 common_debug("Faking session on remembered user");
339 // XXX: Is this necessary?
340 $_SESSION['userid'] = $_cur->id;
347 // Logins that are 'remembered' aren't 'real' -- they're subject to
348 // cookie-stealing. So, we don't let them do certain things. New reg,
349 // OpenID, and password logins _are_ real.
351 function common_real_login($real=true)
353 common_ensure_session();
354 $_SESSION['real_login'] = $real;
357 function common_is_real_login()
359 return common_logged_in() && $_SESSION['real_login'];
362 // get canonical version of nickname for comparison
363 function common_canonical_nickname($nickname)
365 // XXX: UTF-8 canonicalization (like combining chars)
366 return strtolower($nickname);
369 // get canonical version of email for comparison
370 function common_canonical_email($email)
372 // XXX: canonicalize UTF-8
373 // XXX: lcase the domain part
377 function common_render_content($text, $notice)
379 $r = common_render_text($text);
380 $id = $notice->profile_id;
381 $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
382 $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
383 $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
384 $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
388 function common_render_text($text)
390 $r = htmlspecialchars($text);
392 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
393 $r = common_replace_urls_callback($r, 'common_linkify');
394 $r = preg_replace('/(^|\(|\[|\s+)#([A-Za-z0-9_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
399 function common_replace_urls_callback($text, $callback) {
400 // Start off with a regex
404 '(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|xmpp|irc)://'.
406 '(?:mailto|aim|tel):'.
411 '(?:museum|travel|[a-z]{2,4})'.
415 preg_match_all($regex, $text, $matches);
417 // Then clean up what the regex left behind
419 foreach($matches[0] as $orig_url) {
420 $url = htmlspecialchars_decode($orig_url);
422 // Make sure we didn't pick up an email address
423 if (preg_match('#^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$#i', $url)) continue;
425 // Remove surrounding punctuation
426 $url = trim($url, '.?!,;:\'"`([<');
428 // Remove surrounding parens and the like
429 preg_match('/[)\]>]+$/', $url, $trailing);
430 if (isset($trailing[0])) {
431 preg_match_all('/[(\[<]/', $url, $opened);
432 preg_match_all('/[)\]>]/', $url, $closed);
433 $unopened = count($closed[0]) - count($opened[0]);
435 // Make sure not to take off more closing parens than there are at the end
436 $unopened = ($unopened > mb_strlen($trailing[0])) ? mb_strlen($trailing[0]):$unopened;
438 $url = ($unopened > 0) ? mb_substr($url, 0, $unopened * -1):$url;
441 // Remove trailing punctuation again (in case there were some inside parens)
442 $url = rtrim($url, '.?!,;:\'"`');
444 // Make sure we didn't capture part of the next sentence
445 preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
447 // Were the parts capitalized any?
448 $last_part = (mb_strtolower($url_parts[2]) !== $url_parts[2]) ? true:false;
449 $prev_part = (mb_strtolower($url_parts[1]) !== $url_parts[1]) ? true:false;
451 // If the first part wasn't cap'd but the last part was, we captured too much
452 if ((!$prev_part && $last_part)) {
453 $url = mb_substr($url, 0 , mb_strpos($url, '.'.$url_parts['2'], 0));
456 // Capture the new TLD
457 preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
459 $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');
461 if (!in_array($url_parts[2], $tlds)) continue;
463 // Make sure we didn't capture a hash tag
464 if (strpos($url, '#') === 0) continue;
466 // Put the url back the way we found it.
467 $url = (mb_strpos($orig_url, htmlspecialchars($url)) === FALSE) ? $url:htmlspecialchars($url);
469 // Call user specified func
470 $modified_url = $callback($url);
473 $start = mb_strpos($text, $url, $offset);
474 $text = mb_substr($text, 0, $start).$modified_url.mb_substr($text, $start + mb_strlen($url), mb_strlen($text));
475 $offset = $start + mb_strlen($modified_url);
481 function common_linkify($url) {
482 // It comes in special'd, so we unspecial it before passing to the stringifying
484 $ext = pathinfo($url, PATHINFO_EXTENSION);
485 $url = htmlspecialchars_decode($url);
486 $video_ext = array('mp4', 'flv', 'avi', 'mpg', 'mp3', 'ogg');
488 $url = (!preg_match('#^([a-z]+://|(mailto|aim|tel):)#i', $url)) ? 'http://'.$url : $url;
490 $attrs = array('href' => $url, 'rel' => 'external');
492 if (in_array($ext, $video_ext)) {
493 $attrs['class'] = 'media';
496 if ($longurl = common_longurl($url)) {
497 $attrs['title'] = $longurl;
500 return XMLStringer::estring('a', $attrs, $display);
503 function common_longurl($short_url)
505 $long_url = common_shorten_link($short_url, true);
506 if ($long_url === $short_url) return false;
510 function common_longurl2($uri)
512 $uri_e = urlencode($uri);
513 $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
514 if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
515 return stripslashes($longurl['long_url']);
518 function common_shorten_links($text)
520 if (mb_strlen($text) <= 140) return $text;
521 static $cache = array();
522 if (isset($cache[$text])) return $cache[$text];
523 // \s = not a horizontal whitespace character (since PHP 5.2.4)
524 return $cache[$text] = common_replace_urls_callback($text, 'common_shorten_link');;
527 function common_shorten_link($url, $reverse = false)
529 static $url_cache = array();
530 if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
532 $user = common_current_user();
534 $curlh = curl_init();
535 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
536 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
537 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
539 switch($user->urlshorteningservice) {
541 $short_url_service = new LilUrl;
542 $short_url = $short_url_service->shorten($url);
546 $short_url_service = new TightUrl;
547 $short_url = $short_url_service->shorten($url);
551 $short_url_service = new PtitUrl;
552 $short_url = $short_url_service->shorten($url);
556 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
557 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
561 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
562 $short_url = curl_exec($curlh);
565 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
566 $short_url = curl_exec($curlh);
569 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
570 $short_url = curl_exec($curlh);
573 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
574 $short_url = curl_exec($curlh);
583 $url_cache[(string)$short_url] = $url;
584 return (string)$short_url;
589 function common_xml_safe_str($str)
591 $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
593 // Replace control, formatting, and surrogate characters with '*', ala Twitter
594 return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
597 function common_tag_link($tag)
599 $canonical = common_canonical_tag($tag);
600 $url = common_local_url('tag', array('tag' => $canonical));
601 $xs = new XMLStringer();
602 $xs->elementStart('span', 'tag');
603 $xs->element('a', array('href' => $url,
606 $xs->elementEnd('span');
607 return $xs->getString();
610 function common_canonical_tag($tag)
612 return strtolower(str_replace(array('-', '_', '.'), '', $tag));
615 function common_valid_profile_tag($str)
617 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
620 function common_at_link($sender_id, $nickname)
622 $sender = Profile::staticGet($sender_id);
623 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
625 $user = User::staticGet('id', $recipient->id);
627 $url = common_local_url('userbyid', array('id' => $user->id));
629 $url = $recipient->profileurl;
631 $xs = new XMLStringer(false);
632 $xs->elementStart('span', 'vcard');
633 $xs->elementStart('a', array('href' => $url,
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 $xs = new XMLStringer();
650 $xs->elementStart('span', 'vcard');
651 $xs->elementStart('a', array('href' => $group->permalink(),
653 $xs->element('span', 'fn nickname', $nickname);
654 $xs->elementEnd('a');
655 $xs->elementEnd('span');
656 return $xs->getString();
662 function common_at_hash_link($sender_id, $tag)
664 $user = User::staticGet($sender_id);
668 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
670 $url = common_local_url('subscriptions',
671 array('nickname' => $user->nickname,
673 $xs = new XMLStringer();
674 $xs->elementStart('span', 'tag');
675 $xs->element('a', array('href' => $url,
678 $xs->elementEnd('span');
679 return $xs->getString();
685 function common_relative_profile($sender, $nickname, $dt=null)
687 // Try to find profiles this profile is subscribed to that have this nickname
688 $recipient = new Profile();
689 // XXX: use a join instead of a subquery
690 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
691 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
692 if ($recipient->find(true)) {
693 // XXX: should probably differentiate between profiles with
694 // the same name by date of most recent update
697 // Try to find profiles that listen to this profile and that have this nickname
698 $recipient = new Profile();
699 // XXX: use a join instead of a subquery
700 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
701 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
702 if ($recipient->find(true)) {
703 // XXX: should probably differentiate between profiles with
704 // the same name by date of most recent update
707 // If this is a local user, try to find a local user with that nickname.
708 $sender = User::staticGet($sender->id);
710 $recipient_user = User::staticGet('nickname', $nickname);
711 if ($recipient_user) {
712 return $recipient_user->getProfile();
715 // Otherwise, no links. @messages from local users to remote users,
716 // or from remote users to other remote users, are just
717 // outside our ability to make intelligent guesses about
721 function common_local_url($action, $args=null, $params=null, $fragment=null)
724 $path = $r->build($action, $args, $params, $fragment);
726 if (common_config('site','fancy')) {
727 $url = common_path(mb_substr($path, 1));
729 if (mb_strpos($path, '/index.php') === 0) {
730 $url = common_path(mb_substr($path, 1));
732 $url = common_path('index.php'.$path);
738 function common_path($relative)
741 $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
742 return "http://".$config['site']['server'].'/'.$pathpart.$relative;
745 function common_date_string($dt)
747 // XXX: do some sexy date formatting
748 // return date(DATE_RFC822, $dt);
753 if ($now < $t) { // that shouldn't happen!
754 return common_exact_date($dt);
755 } else if ($diff < 60) {
756 return _('a few seconds ago');
757 } else if ($diff < 92) {
758 return _('about a minute ago');
759 } else if ($diff < 3300) {
760 return sprintf(_('about %d minutes ago'), round($diff/60));
761 } else if ($diff < 5400) {
762 return _('about an hour ago');
763 } else if ($diff < 22 * 3600) {
764 return sprintf(_('about %d hours ago'), round($diff/3600));
765 } else if ($diff < 37 * 3600) {
766 return _('about a day ago');
767 } else if ($diff < 24 * 24 * 3600) {
768 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
769 } else if ($diff < 46 * 24 * 3600) {
770 return _('about a month ago');
771 } else if ($diff < 330 * 24 * 3600) {
772 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
773 } else if ($diff < 480 * 24 * 3600) {
774 return _('about a year ago');
776 return common_exact_date($dt);
780 function common_exact_date($dt)
786 $_utc = new DateTimeZone('UTC');
787 $_siteTz = new DateTimeZone(common_timezone());
790 $dateStr = date('d F Y H:i:s', strtotime($dt));
791 $d = new DateTime($dateStr, $_utc);
792 $d->setTimezone($_siteTz);
793 return $d->format(DATE_RFC850);
796 function common_date_w3dtf($dt)
798 $dateStr = date('d F Y H:i:s', strtotime($dt));
799 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
800 $d->setTimezone(new DateTimeZone(common_timezone()));
801 return $d->format(DATE_W3C);
804 function common_date_rfc2822($dt)
806 $dateStr = date('d F Y H:i:s', strtotime($dt));
807 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
808 $d->setTimezone(new DateTimeZone(common_timezone()));
809 return $d->format('r');
812 function common_date_iso8601($dt)
814 $dateStr = date('d F Y H:i:s', strtotime($dt));
815 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
816 $d->setTimezone(new DateTimeZone(common_timezone()));
817 return $d->format('c');
820 function common_sql_now()
822 return strftime('%Y-%m-%d %H:%M:%S', time());
825 function common_redirect($url, $code=307)
827 static $status = array(301 => "Moved Permanently",
830 307 => "Temporary Redirect");
832 header("Status: ${code} $status[$code]");
833 header("Location: $url");
835 $xo = new XMLOutputter();
837 '-//W3C//DTD XHTML 1.0 Strict//EN',
838 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
839 $xo->element('a', array('href' => $url), $url);
844 function common_broadcast_notice($notice, $remote=false)
846 if (common_config('queue', 'enabled')) {
848 return common_enqueue_notice($notice);
850 return common_real_broadcast($notice, $remote);
854 // Stick the notice on the queue
856 function common_enqueue_notice($notice)
858 foreach (array('jabber', 'omb', 'sms', 'public', 'twitter', 'facebook', 'ping') as $transport) {
859 $qi = new Queue_item();
860 $qi->notice_id = $notice->id;
861 $qi->transport = $transport;
862 $qi->created = $notice->created;
863 $result = $qi->insert();
865 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
866 common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
869 common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
874 function common_real_broadcast($notice, $remote=false)
878 // Make sure we have the OMB stuff
879 require_once(INSTALLDIR.'/lib/omb.php');
880 $success = omb_broadcast_remote_subscribers($notice);
882 common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
886 require_once(INSTALLDIR.'/lib/jabber.php');
887 $success = jabber_broadcast_notice($notice);
889 common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
893 require_once(INSTALLDIR.'/lib/mail.php');
894 $success = mail_broadcast_notice_sms($notice);
896 common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
900 $success = jabber_public_notice($notice);
902 common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
906 $success = broadcast_twitter($notice);
908 common_log(LOG_ERR, 'Error in Twitter broadcast for notice ' . $notice->id);
912 // XXX: Do a real-time FB broadcast here?
914 // XXX: broadcast notices to other IM
918 function common_broadcast_profile($profile)
920 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
921 require_once(INSTALLDIR.'/lib/omb.php');
922 omb_broadcast_profile($profile);
923 // XXX: Other broadcasts...?
927 function common_profile_url($nickname)
929 return common_local_url('showstream', array('nickname' => $nickname));
932 // Should make up a reasonable root URL
934 function common_root_url()
936 return common_path('');
939 // returns $bytes bytes of random data as a hexadecimal string
940 // "good" here is a goal and not a guarantee
942 function common_good_rand($bytes)
944 // XXX: use random.org...?
945 if (file_exists('/dev/urandom')) {
946 return common_urandom($bytes);
947 } else { // FIXME: this is probably not good enough
948 return common_mtrand($bytes);
952 function common_urandom($bytes)
954 $h = fopen('/dev/urandom', 'rb');
956 $src = fread($h, $bytes);
959 for ($i = 0; $i < $bytes; $i++) {
960 $enc .= sprintf("%02x", (ord($src[$i])));
965 function common_mtrand($bytes)
968 for ($i = 0; $i < $bytes; $i++) {
969 $enc .= sprintf("%02x", mt_rand(0, 255));
974 function common_set_returnto($url)
976 common_ensure_session();
977 $_SESSION['returnto'] = $url;
980 function common_get_returnto()
982 common_ensure_session();
983 return $_SESSION['returnto'];
986 function common_timestamp()
988 return date('YmdHis');
991 function common_ensure_syslog()
993 static $initialized = false;
996 openlog($config['syslog']['appname'], 0, LOG_USER);
1001 function common_log($priority, $msg, $filename=null)
1003 $logfile = common_config('site', 'logfile');
1005 $log = fopen($logfile, "a");
1007 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1008 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1009 $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1010 fwrite($log, $output);
1014 common_ensure_syslog();
1015 syslog($priority, $msg);
1019 function common_debug($msg, $filename=null)
1022 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1024 common_log(LOG_DEBUG, $msg);
1028 function common_log_db_error(&$object, $verb, $filename=null)
1030 $objstr = common_log_objstring($object);
1031 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1032 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1035 function common_log_objstring(&$object)
1037 if (is_null($object)) {
1040 $arr = $object->toArray();
1042 foreach ($arr as $k => $v) {
1043 $fields[] = "$k='$v'";
1045 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1049 function common_valid_http_url($url)
1051 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1054 function common_valid_tag($tag)
1056 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1057 return (Validate::email($matches[1]) ||
1058 preg_match('/^([\w-\.]+)$/', $matches[1]));
1063 /* Following functions are copied from MediaWiki GlobalFunctions.php
1064 * and written by Evan Prodromou. */
1066 function common_accept_to_prefs($accept, $def = '*/*')
1068 // No arg means accept anything (per HTTP spec)
1070 return array($def => 1);
1075 $parts = explode(',', $accept);
1077 foreach($parts as $part) {
1078 // FIXME: doesn't deal with params like 'text/html; level=1'
1079 @list($value, $qpart) = explode(';', $part);
1081 if(!isset($qpart)) {
1083 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1084 $prefs[$value] = $match[1];
1091 function common_mime_type_match($type, $avail)
1093 if(array_key_exists($type, $avail)) {
1096 $parts = explode('/', $type);
1097 if(array_key_exists($parts[0] . '/*', $avail)) {
1098 return $parts[0] . '/*';
1099 } elseif(array_key_exists('*/*', $avail)) {
1107 function common_negotiate_type($cprefs, $sprefs)
1111 foreach(array_keys($sprefs) as $type) {
1112 $parts = explode('/', $type);
1113 if($parts[1] != '*') {
1114 $ckey = common_mime_type_match($type, $cprefs);
1116 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1121 foreach(array_keys($cprefs) as $type) {
1122 $parts = explode('/', $type);
1123 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1124 $skey = common_mime_type_match($type, $sprefs);
1126 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1132 $besttype = 'text/html';
1134 foreach(array_keys($combine) as $type) {
1135 if($combine[$type] > $bestq) {
1137 $bestq = $combine[$type];
1141 if ('text/html' === $besttype) {
1142 return "text/html; charset=utf-8";
1147 function common_config($main, $sub)
1150 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1153 function common_copy_args($from)
1156 $strip = get_magic_quotes_gpc();
1157 foreach ($from as $k => $v) {
1158 $to[$k] = ($strip) ? stripslashes($v) : $v;
1163 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1164 // This is used before handing a request off to OAuthRequest::from_request.
1165 function common_remove_magic_from_request()
1167 if(get_magic_quotes_gpc()) {
1168 $_POST=array_map('stripslashes',$_POST);
1169 $_GET=array_map('stripslashes',$_GET);
1173 function common_user_uri(&$user)
1175 return common_local_url('userbyid', array('id' => $user->id));
1178 function common_notice_uri(&$notice)
1180 return common_local_url('shownotice',
1181 array('notice' => $notice->id));
1184 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1186 function common_confirmation_code($bits)
1188 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1189 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1190 $chars = ceil($bits/5);
1192 for ($i = 0; $i < $chars; $i++) {
1193 // XXX: convert to string and back
1194 $num = hexdec(common_good_rand(1));
1195 // XXX: randomness is too precious to throw away almost
1196 // 40% of the bits we get!
1197 $code .= $codechars[$num%32];
1202 // convert markup to HTML
1204 function common_markup_to_html($c)
1206 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1207 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1208 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1209 return Markdown($c);
1212 function common_profile_uri($profile)
1217 $user = User::staticGet($profile->id);
1222 $remote = Remote_profile::staticGet($profile->id);
1224 return $remote->uri;
1226 // XXX: this is a very bad profile!
1230 function common_canonical_sms($sms)
1233 preg_replace('/\D/', '', $sms);
1237 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1241 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1245 case E_USER_WARNING:
1246 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1250 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1254 // FIXME: show error page if we're on the Web
1255 /* Don't execute PHP internal error handler */
1259 function common_session_token()
1261 common_ensure_session();
1262 if (!array_key_exists('token', $_SESSION)) {
1263 $_SESSION['token'] = common_good_rand(64);
1265 return $_SESSION['token'];
1268 function common_cache_key($extra)
1270 return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1273 function common_keyize($str)
1275 $str = strtolower($str);
1276 $str = preg_replace('/\s/', '_', $str);
1280 function common_memcache()
1282 static $cache = null;
1283 if (!common_config('memcached', 'enabled')) {
1287 $cache = new Memcache();
1288 $servers = common_config('memcached', 'server');
1289 if (is_array($servers)) {
1290 foreach($servers as $server) {
1291 $cache->addServer($server);
1294 $cache->addServer($servers);
1301 function common_compatible_license($from, $to)
1303 // XXX: better compatibility check needed here!
1304 return ($from == $to);