3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, Controlez-Vous, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 /* XXX: break up into separate modules (HTTP, user, files) */
22 // Show a server error
24 function common_server_error($msg, $code=500)
26 $err = new ServerErrorAction($msg, $code);
31 function common_user_error($msg, $code=400)
33 $err = new ClientErrorAction($msg, $code);
37 function common_init_locale($language=null)
40 $language = common_language();
42 putenv('LANGUAGE='.$language);
43 putenv('LANG='.$language);
44 return setlocale(LC_ALL, $language . ".utf8",
51 function common_init_language()
53 mb_internal_encoding('UTF-8');
54 $language = common_language();
55 // So we don't have to make people install the gettext locales
56 $locale_set = common_init_locale($language);
57 bindtextdomain("laconica", common_config('site','locale_path'));
58 bind_textdomain_codeset("laconica", "UTF-8");
59 textdomain("laconica");
60 setlocale(LC_CTYPE, 'C');
62 common_log(LOG_INFO,'Language requested:'.$language.' - locale could not be set:',__FILE__);
66 function common_timezone()
68 if (common_logged_in()) {
69 $user = common_current_user();
70 if ($user->timezone) {
71 return $user->timezone;
76 return $config['site']['timezone'];
79 function common_language()
82 // If there is a user logged in and they've set a language preference
83 // then return that one...
84 if (common_logged_in()) {
85 $user = common_current_user();
86 $user_language = $user->language;
88 return $user_language;
91 // Otherwise, find the best match for the languages requested by the
93 $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
94 if (!empty($httplang)) {
95 $language = client_prefered_language($httplang);
100 // Finally, if none of the above worked, use the site's default...
101 return common_config('site', 'language');
103 // salted, hashed passwords are stored in the DB
105 function common_munge_password($password, $id)
107 return md5($password . $id);
110 // check if a username exists and has matching password
111 function common_check_user($nickname, $password)
113 // NEVER allow blank passwords, even if they match the DB
114 if (mb_strlen($password) == 0) {
117 $user = User::staticGet('nickname', $nickname);
118 if (is_null($user)) {
121 if (0 == strcmp(common_munge_password($password, $user->id),
130 // is the current user logged in?
131 function common_logged_in()
133 return (!is_null(common_current_user()));
136 function common_have_session()
138 return (0 != strcmp(session_id(), ''));
141 function common_ensure_session()
143 if (!common_have_session()) {
148 // Three kinds of arguments:
153 // Initialize to false; set to null if none found
157 function common_set_user($user)
162 if (is_null($user) && common_have_session()) {
164 unset($_SESSION['userid']);
166 } else if (is_string($user)) {
168 $user = User::staticGet('nickname', $nickname);
169 } else if (!($user instanceof User)) {
174 common_ensure_session();
175 $_SESSION['userid'] = $user->id;
182 function common_set_cookie($key, $value, $expiration=0)
184 $path = common_config('site', 'path');
185 $server = common_config('site', 'server');
187 if ($path && ($path != '/')) {
188 $cookiepath = '/' . $path . '/';
192 return setcookie($key,
199 define('REMEMBERME', 'rememberme');
200 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
202 function common_rememberme($user=null)
205 $user = common_current_user();
207 common_debug('No current user to remember', __FILE__);
212 $rm = new Remember_me();
214 $rm->code = common_good_rand(16);
215 $rm->user_id = $user->id;
217 // Wrap the insert in some good ol' fashioned transaction code
221 $result = $rm->insert();
224 common_log_db_error($rm, 'INSERT', __FILE__);
225 common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
229 $rm->query('COMMIT');
231 common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
233 $cookieval = $rm->user_id . ':' . $rm->code;
235 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
237 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
242 function common_remembered_user()
247 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
253 list($id, $code) = explode(':', $packed);
255 if (!$id || !$code) {
256 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
261 $rm = Remember_me::staticGet($code);
264 common_log(LOG_WARNING, 'No such remember code: ' . $code);
269 if ($rm->user_id != $id) {
270 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
275 $user = User::staticGet($rm->user_id);
278 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
284 $result = $rm->delete();
287 common_log_db_error($rm, 'DELETE', __FILE__);
288 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
293 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
295 common_set_user($user);
296 common_real_login(false);
298 // We issue a new cookie, so they can log in
299 // automatically again after this session
301 common_rememberme($user);
306 // must be called with a valid user!
308 function common_forgetme()
310 common_set_cookie(REMEMBERME, '', 0);
313 // who is the current user?
314 function common_current_user()
318 if ($_cur === false) {
320 if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
321 common_ensure_session();
322 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
324 $_cur = User::staticGet($id);
329 // that didn't work; try to remember; will init $_cur to null on failure
330 $_cur = common_remembered_user();
333 common_debug("Got User " . $_cur->nickname);
334 common_debug("Faking session on remembered user");
335 // XXX: Is this necessary?
336 $_SESSION['userid'] = $_cur->id;
343 // Logins that are 'remembered' aren't 'real' -- they're subject to
344 // cookie-stealing. So, we don't let them do certain things. New reg,
345 // OpenID, and password logins _are_ real.
347 function common_real_login($real=true)
349 common_ensure_session();
350 $_SESSION['real_login'] = $real;
353 function common_is_real_login()
355 return common_logged_in() && $_SESSION['real_login'];
358 // get canonical version of nickname for comparison
359 function common_canonical_nickname($nickname)
361 // XXX: UTF-8 canonicalization (like combining chars)
362 return strtolower($nickname);
365 // get canonical version of email for comparison
366 function common_canonical_email($email)
368 // XXX: canonicalize UTF-8
369 // XXX: lcase the domain part
373 function common_render_content($text, $notice)
375 $r = common_render_text($text);
376 $id = $notice->profile_id;
377 $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
378 $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
379 $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
380 $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
384 function common_render_text($text)
386 $r = htmlspecialchars($text);
388 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
389 $r = common_replace_urls_callback($r, 'common_linkify');
390 $r = preg_replace('/(^|\(|\[|\s+)#([A-Za-z0-9_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
395 function common_replace_urls_callback($text, $callback) {
396 // Start off with a regex
400 (?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|xmpp|irc)://
407 (?:museum|travel|[a-z]{2,4})
411 preg_match_all($regex, $text, $matches);
413 // Then clean up what the regex left behind
415 foreach($matches[0] as $orig_url) {
416 $url = htmlspecialchars_decode($orig_url);
418 // Make sure we didn't pick up an email address
419 if (preg_match('#^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$#i', $url)) continue;
421 // Remove surrounding punctuation
422 $url = trim($url, '.?!,;:\'"`([<');
424 // Remove surrounding parens and the like
425 preg_match('/[)\]>]+$/', $url, $trailing);
426 if (isset($trailing[0])) {
427 preg_match_all('/[(\[<]/', $url, $opened);
428 preg_match_all('/[)\]>]/', $url, $closed);
429 $unopened = count($closed[0]) - count($opened[0]);
431 // Make sure not to take off more closing parens than there are at the end
432 $unopened = ($unopened > mb_strlen($trailing[0])) ? mb_strlen($trailing[0]):$unopened;
434 $url = ($unopened > 0) ? mb_substr($url, 0, $unopened * -1):$url;
437 // Remove trailing punctuation again (in case there were some inside parens)
438 $url = rtrim($url, '.?!,;:\'"`');
440 // Make sure we didn't capture part of the next sentence
441 preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
443 // Were the parts capitalized any?
444 $last_part = (mb_strtolower($url_parts[2]) !== $url_parts[2]) ? true:false;
445 $prev_part = (mb_strtolower($url_parts[1]) !== $url_parts[1]) ? true:false;
447 // If the first part wasn't cap'd but the last part was, we captured too much
448 if ((!$prev_part && $last_part)) {
449 $url = mb_substr($url, 0 , mb_strpos($url, '.'.$url_parts['2'], 0));
452 // Capture the new TLD
453 preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
455 $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');
457 if (!in_array($url_parts[2], $tlds)) continue;
459 // Put the url back the way we found it.
460 $url = (mb_strpos($orig_url, htmlspecialchars($url)) === FALSE) ? $url:htmlspecialchars($url);
462 // Call user specified func
463 $modified_url = $callback($url);
466 $start = mb_strpos($text, $url, $offset);
467 $text = mb_substr($text, 0, $start).$modified_url.mb_substr($text, $start + mb_strlen($url), mb_strlen($text));
468 $offset = $start + mb_strlen($modified_url);
474 function common_linkify($url) {
476 $url = (!preg_match('#^([a-z]+://|(mailto|aim|tel):)#i', $url)) ? 'http://'.$url:$url;
478 if ($longurl = common_longurl($url)) {
479 $longurl = htmlentities($longurl, ENT_QUOTES, 'UTF-8');
480 $title = "title=\"$longurl\"";
484 return "<a href=\"$url\" $title rel=\"external\">$display</a>";
487 function common_longurl($short_url)
489 $long_url = common_shorten_link($short_url, true);
490 if ($long_url === $short_url) return false;
494 function common_longurl2($uri)
496 $uri_e = urlencode($uri);
497 $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
498 if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
499 return stripslashes($longurl['long_url']);
502 function common_shorten_links($text)
504 if (mb_strlen($text) <= 140) return $text;
505 static $cache = array();
506 if (isset($cache[$text])) return $cache[$text];
507 // \s = not a horizontal whitespace character (since PHP 5.2.4)
508 return $cache[$text] = common_replace_urls_callback($text, 'common_shorten_link');;
511 function common_shorten_link($url, $reverse = false)
513 static $url_cache = array();
514 if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
516 $user = common_current_user();
518 $curlh = curl_init();
519 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
520 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
521 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
523 switch($user->urlshorteningservice) {
525 $short_url_service = new LilUrl;
526 $short_url = $short_url_service->shorten($url);
530 $short_url_service = new TightUrl;
531 $short_url = $short_url_service->shorten($url);
535 $short_url_service = new PtitUrl;
536 $short_url = $short_url_service->shorten($url);
540 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
541 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
545 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
546 $short_url = curl_exec($curlh);
549 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
550 $short_url = curl_exec($curlh);
553 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
554 $short_url = curl_exec($curlh);
557 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
558 $short_url = curl_exec($curlh);
567 $url_cache[(string)$short_url] = $url;
568 return (string)$short_url;
573 function common_xml_safe_str($str)
575 $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
577 // Replace control, formatting, and surrogate characters with '*', ala Twitter
578 return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
581 function common_tag_link($tag)
583 $canonical = common_canonical_tag($tag);
584 $url = common_local_url('tag', array('tag' => $canonical));
585 return '<span class="tag"><a href="' . htmlspecialchars($url) . '" rel="tag">' . htmlspecialchars($tag) . '</a></span>';
588 function common_canonical_tag($tag)
590 return strtolower(str_replace(array('-', '_', '.'), '', $tag));
593 function common_valid_profile_tag($str)
595 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
598 function common_at_link($sender_id, $nickname)
600 $sender = Profile::staticGet($sender_id);
601 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
603 return '<span class="vcard"><a href="'.htmlspecialchars($recipient->profileurl).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
609 function common_group_link($sender_id, $nickname)
611 $sender = Profile::staticGet($sender_id);
612 $group = User_group::staticGet('nickname', common_canonical_nickname($nickname));
613 if ($group && $sender->isMember($group)) {
614 return '<span class="vcard"><a href="'.htmlspecialchars($group->permalink()).'" class="url"><span class="fn nickname">'.$nickname.'</span></a></span>';
620 function common_at_hash_link($sender_id, $tag)
622 $user = User::staticGet($sender_id);
626 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
628 $url = common_local_url('subscriptions',
629 array('nickname' => $user->nickname,
631 return '<span class="tag"><a href="'.htmlspecialchars($url).'" rel="tag">'.$tag.'</a></span>';
637 function common_relative_profile($sender, $nickname, $dt=null)
639 // Try to find profiles this profile is subscribed to that have this nickname
640 $recipient = new Profile();
641 // XXX: use a join instead of a subquery
642 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
643 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
644 if ($recipient->find(true)) {
645 // XXX: should probably differentiate between profiles with
646 // the same name by date of most recent update
649 // Try to find profiles that listen to this profile and that have this nickname
650 $recipient = new Profile();
651 // XXX: use a join instead of a subquery
652 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
653 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
654 if ($recipient->find(true)) {
655 // XXX: should probably differentiate between profiles with
656 // the same name by date of most recent update
659 // If this is a local user, try to find a local user with that nickname.
660 $sender = User::staticGet($sender->id);
662 $recipient_user = User::staticGet('nickname', $nickname);
663 if ($recipient_user) {
664 return $recipient_user->getProfile();
667 // Otherwise, no links. @messages from local users to remote users,
668 // or from remote users to other remote users, are just
669 // outside our ability to make intelligent guesses about
673 function common_local_url($action, $args=null, $fragment=null)
675 common_debug("Action = $action, args = " . (($args) ? '(' . implode($args, ',') . ')' : $args) . ", fragment = $fragment");
677 $start = microtime();
678 $path = $r->build($action, $args, $fragment);
680 common_debug("Pathbuilding took " . ($end - $start));
683 if (common_config('site','fancy')) {
684 $url = common_path(mb_substr($path, 1));
686 $url = common_path('index.php'.$path);
691 function common_path($relative)
694 $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
695 return "http://".$config['site']['server'].'/'.$pathpart.$relative;
698 function common_date_string($dt)
700 // XXX: do some sexy date formatting
701 // return date(DATE_RFC822, $dt);
706 if ($now < $t) { // that shouldn't happen!
707 return common_exact_date($dt);
708 } else if ($diff < 60) {
709 return _('a few seconds ago');
710 } else if ($diff < 92) {
711 return _('about a minute ago');
712 } else if ($diff < 3300) {
713 return sprintf(_('about %d minutes ago'), round($diff/60));
714 } else if ($diff < 5400) {
715 return _('about an hour ago');
716 } else if ($diff < 22 * 3600) {
717 return sprintf(_('about %d hours ago'), round($diff/3600));
718 } else if ($diff < 37 * 3600) {
719 return _('about a day ago');
720 } else if ($diff < 24 * 24 * 3600) {
721 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
722 } else if ($diff < 46 * 24 * 3600) {
723 return _('about a month ago');
724 } else if ($diff < 330 * 24 * 3600) {
725 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
726 } else if ($diff < 480 * 24 * 3600) {
727 return _('about a year ago');
729 return common_exact_date($dt);
733 function common_exact_date($dt)
739 $_utc = new DateTimeZone('UTC');
740 $_siteTz = new DateTimeZone(common_timezone());
743 $dateStr = date('d F Y H:i:s', strtotime($dt));
744 $d = new DateTime($dateStr, $_utc);
745 $d->setTimezone($_siteTz);
746 return $d->format(DATE_RFC850);
749 function common_date_w3dtf($dt)
751 $dateStr = date('d F Y H:i:s', strtotime($dt));
752 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
753 $d->setTimezone(new DateTimeZone(common_timezone()));
754 return $d->format(DATE_W3C);
757 function common_date_rfc2822($dt)
759 $dateStr = date('d F Y H:i:s', strtotime($dt));
760 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
761 $d->setTimezone(new DateTimeZone(common_timezone()));
762 return $d->format('r');
765 function common_date_iso8601($dt)
767 $dateStr = date('d F Y H:i:s', strtotime($dt));
768 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
769 $d->setTimezone(new DateTimeZone(common_timezone()));
770 return $d->format('c');
773 function common_sql_now()
775 return strftime('%Y-%m-%d %H:%M:%S', time());
778 function common_redirect($url, $code=307)
780 static $status = array(301 => "Moved Permanently",
783 307 => "Temporary Redirect");
785 header("Status: ${code} $status[$code]");
786 header("Location: $url");
788 $xo = new XMLOutputter();
790 '-//W3C//DTD XHTML 1.0 Strict//EN',
791 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
792 $xo->element('a', array('href' => $url), $url);
797 function common_broadcast_notice($notice, $remote=false)
799 if (common_config('queue', 'enabled')) {
801 return common_enqueue_notice($notice);
803 return common_real_broadcast($notice, $remote);
807 // Stick the notice on the queue
809 function common_enqueue_notice($notice)
811 foreach (array('jabber', 'omb', 'sms', 'public') as $transport) {
812 $qi = new Queue_item();
813 $qi->notice_id = $notice->id;
814 $qi->transport = $transport;
815 $qi->created = $notice->created;
816 $result = $qi->insert();
818 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
819 common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
822 common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
827 function common_real_broadcast($notice, $remote=false)
831 // Make sure we have the OMB stuff
832 require_once(INSTALLDIR.'/lib/omb.php');
833 $success = omb_broadcast_remote_subscribers($notice);
835 common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
839 require_once(INSTALLDIR.'/lib/jabber.php');
840 $success = jabber_broadcast_notice($notice);
842 common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
846 require_once(INSTALLDIR.'/lib/mail.php');
847 $success = mail_broadcast_notice_sms($notice);
849 common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
853 $success = jabber_public_notice($notice);
855 common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
859 $success = broadcast_twitter($notice);
861 common_log(LOG_ERR, 'Error in Twitter broadcast for notice ' . $notice->id);
865 // XXX: broadcast notices to other IM
869 function common_broadcast_profile($profile)
871 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
872 require_once(INSTALLDIR.'/lib/omb.php');
873 omb_broadcast_profile($profile);
874 // XXX: Other broadcasts...?
878 function common_profile_url($nickname)
880 return common_local_url('showstream', array('nickname' => $nickname));
883 // Should make up a reasonable root URL
885 function common_root_url()
887 return common_path('');
890 // returns $bytes bytes of random data as a hexadecimal string
891 // "good" here is a goal and not a guarantee
893 function common_good_rand($bytes)
895 // XXX: use random.org...?
896 if (file_exists('/dev/urandom')) {
897 return common_urandom($bytes);
898 } else { // FIXME: this is probably not good enough
899 return common_mtrand($bytes);
903 function common_urandom($bytes)
905 $h = fopen('/dev/urandom', 'rb');
907 $src = fread($h, $bytes);
910 for ($i = 0; $i < $bytes; $i++) {
911 $enc .= sprintf("%02x", (ord($src[$i])));
916 function common_mtrand($bytes)
919 for ($i = 0; $i < $bytes; $i++) {
920 $enc .= sprintf("%02x", mt_rand(0, 255));
925 function common_set_returnto($url)
927 common_ensure_session();
928 $_SESSION['returnto'] = $url;
931 function common_get_returnto()
933 common_ensure_session();
934 return $_SESSION['returnto'];
937 function common_timestamp()
939 return date('YmdHis');
942 function common_ensure_syslog()
944 static $initialized = false;
947 openlog($config['syslog']['appname'], 0, LOG_USER);
952 function common_log($priority, $msg, $filename=null)
954 $logfile = common_config('site', 'logfile');
956 $log = fopen($logfile, "a");
958 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
959 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
960 $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
961 fwrite($log, $output);
965 common_ensure_syslog();
966 syslog($priority, $msg);
970 function common_debug($msg, $filename=null)
973 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
975 common_log(LOG_DEBUG, $msg);
979 function common_log_db_error(&$object, $verb, $filename=null)
981 $objstr = common_log_objstring($object);
982 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
983 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
986 function common_log_objstring(&$object)
988 if (is_null($object)) {
991 $arr = $object->toArray();
993 foreach ($arr as $k => $v) {
994 $fields[] = "$k='$v'";
996 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1000 function common_valid_http_url($url)
1002 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1005 function common_valid_tag($tag)
1007 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1008 return (Validate::email($matches[1]) ||
1009 preg_match('/^([\w-\.]+)$/', $matches[1]));
1014 /* Following functions are copied from MediaWiki GlobalFunctions.php
1015 * and written by Evan Prodromou. */
1017 function common_accept_to_prefs($accept, $def = '*/*')
1019 // No arg means accept anything (per HTTP spec)
1021 return array($def => 1);
1026 $parts = explode(',', $accept);
1028 foreach($parts as $part) {
1029 // FIXME: doesn't deal with params like 'text/html; level=1'
1030 @list($value, $qpart) = explode(';', $part);
1032 if(!isset($qpart)) {
1034 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1035 $prefs[$value] = $match[1];
1042 function common_mime_type_match($type, $avail)
1044 if(array_key_exists($type, $avail)) {
1047 $parts = explode('/', $type);
1048 if(array_key_exists($parts[0] . '/*', $avail)) {
1049 return $parts[0] . '/*';
1050 } elseif(array_key_exists('*/*', $avail)) {
1058 function common_negotiate_type($cprefs, $sprefs)
1062 foreach(array_keys($sprefs) as $type) {
1063 $parts = explode('/', $type);
1064 if($parts[1] != '*') {
1065 $ckey = common_mime_type_match($type, $cprefs);
1067 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1072 foreach(array_keys($cprefs) as $type) {
1073 $parts = explode('/', $type);
1074 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1075 $skey = common_mime_type_match($type, $sprefs);
1077 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1083 $besttype = 'text/html';
1085 foreach(array_keys($combine) as $type) {
1086 if($combine[$type] > $bestq) {
1088 $bestq = $combine[$type];
1092 if ('text/html' === $besttype) {
1093 return "text/html; charset=utf-8";
1098 function common_config($main, $sub)
1101 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1104 function common_copy_args($from)
1107 $strip = get_magic_quotes_gpc();
1108 foreach ($from as $k => $v) {
1109 $to[$k] = ($strip) ? stripslashes($v) : $v;
1114 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1115 // This is used before handing a request off to OAuthRequest::from_request.
1116 function common_remove_magic_from_request()
1118 if(get_magic_quotes_gpc()) {
1119 $_POST=array_map('stripslashes',$_POST);
1120 $_GET=array_map('stripslashes',$_GET);
1124 function common_user_uri(&$user)
1126 return common_local_url('userbyid', array('id' => $user->id));
1129 function common_notice_uri(&$notice)
1131 return common_local_url('shownotice',
1132 array('notice' => $notice->id));
1135 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1137 function common_confirmation_code($bits)
1139 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1140 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1141 $chars = ceil($bits/5);
1143 for ($i = 0; $i < $chars; $i++) {
1144 // XXX: convert to string and back
1145 $num = hexdec(common_good_rand(1));
1146 // XXX: randomness is too precious to throw away almost
1147 // 40% of the bits we get!
1148 $code .= $codechars[$num%32];
1153 // convert markup to HTML
1155 function common_markup_to_html($c)
1157 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1158 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1159 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1160 return Markdown($c);
1163 function common_profile_uri($profile)
1168 $user = User::staticGet($profile->id);
1173 $remote = Remote_profile::staticGet($profile->id);
1175 return $remote->uri;
1177 // XXX: this is a very bad profile!
1181 function common_canonical_sms($sms)
1184 preg_replace('/\D/', '', $sms);
1188 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1192 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1196 case E_USER_WARNING:
1197 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1201 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1205 // FIXME: show error page if we're on the Web
1206 /* Don't execute PHP internal error handler */
1210 function common_session_token()
1212 common_ensure_session();
1213 if (!array_key_exists('token', $_SESSION)) {
1214 $_SESSION['token'] = common_good_rand(64);
1216 return $_SESSION['token'];
1219 function common_cache_key($extra)
1221 return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1224 function common_keyize($str)
1226 $str = strtolower($str);
1227 $str = preg_replace('/\s/', '_', $str);
1231 function common_memcache()
1233 static $cache = null;
1234 if (!common_config('memcached', 'enabled')) {
1238 $cache = new Memcache();
1239 $servers = common_config('memcached', 'server');
1240 if (is_array($servers)) {
1241 foreach($servers as $server) {
1242 $cache->addServer($server);
1245 $cache->addServer($servers);
1252 function common_compatible_license($from, $to)
1254 // XXX: better compatibility check needed here!
1255 return ($from == $to);