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)://'.
402 '(?:mailto|aim|tel):'.
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) {
475 // It comes in special'd, so we unspecial it before passing to the stringifying
477 $ext = pathinfo($url, PATHINFO_EXTENSION);
478 $url = htmlspecialchars_decode($url);
479 $video_ext = array('mp4', 'flv', 'avi', 'mpg', 'mp3', 'ogg');
481 $url = (!preg_match('#^([a-z]+://|(mailto|aim|tel):)#i', $url)) ? 'http://'.$url : $url;
483 $attrs = array('href' => $url, 'rel' => 'external');
485 if (in_array($ext, $video_ext)) {
486 $attrs['class'] = 'media';
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)
522 static $url_cache = array();
523 if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
525 $user = common_current_user();
527 $curlh = curl_init();
528 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
529 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
530 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
532 switch($user->urlshorteningservice) {
534 $short_url_service = new LilUrl;
535 $short_url = $short_url_service->shorten($url);
539 $short_url_service = new TightUrl;
540 $short_url = $short_url_service->shorten($url);
544 $short_url_service = new PtitUrl;
545 $short_url = $short_url_service->shorten($url);
549 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
550 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
554 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
555 $short_url = curl_exec($curlh);
558 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
559 $short_url = curl_exec($curlh);
562 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
563 $short_url = curl_exec($curlh);
566 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
567 $short_url = curl_exec($curlh);
576 $url_cache[(string)$short_url] = $url;
577 return (string)$short_url;
582 function common_xml_safe_str($str)
584 $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
586 // Replace control, formatting, and surrogate characters with '*', ala Twitter
587 return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
590 function common_tag_link($tag)
592 $canonical = common_canonical_tag($tag);
593 $url = common_local_url('tag', array('tag' => $canonical));
594 $xs = new XMLStringer();
595 $xs->elementStart('span', 'tag');
596 $xs->element('a', array('href' => $url,
599 $xs->elementEnd('span');
600 return $xs->getString();
603 function common_canonical_tag($tag)
605 return strtolower(str_replace(array('-', '_', '.'), '', $tag));
608 function common_valid_profile_tag($str)
610 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
613 function common_at_link($sender_id, $nickname)
615 $sender = Profile::staticGet($sender_id);
616 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
618 $xs = new XMLStringer(false);
619 $xs->elementStart('span', 'vcard');
620 $xs->elementStart('a', array('href' => $recipient->profileurl,
622 $xs->element('span', 'fn nickname', $nickname);
623 $xs->elementEnd('a');
624 $xs->elementEnd('span');
625 return $xs->getString();
631 function common_group_link($sender_id, $nickname)
633 $sender = Profile::staticGet($sender_id);
634 $group = User_group::staticGet('nickname', common_canonical_nickname($nickname));
635 if ($group && $sender->isMember($group)) {
636 $xs = new XMLStringer();
637 $xs->elementStart('span', 'vcard');
638 $xs->elementStart('a', array('href' => $group->permalink(),
640 $xs->element('span', 'fn nickname', $nickname);
641 $xs->elementEnd('a');
642 $xs->elementEnd('span');
643 return $xs->getString();
649 function common_at_hash_link($sender_id, $tag)
651 $user = User::staticGet($sender_id);
655 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
657 $url = common_local_url('subscriptions',
658 array('nickname' => $user->nickname,
660 $xs = new XMLStringer();
661 $xs->elementStart('span', 'tag');
662 $xs->element('a', array('href' => $url,
665 $xs->elementEnd('span');
666 return $xs->getString();
672 function common_relative_profile($sender, $nickname, $dt=null)
674 // Try to find profiles this profile is subscribed to that have this nickname
675 $recipient = new Profile();
676 // XXX: use a join instead of a subquery
677 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
678 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
679 if ($recipient->find(true)) {
680 // XXX: should probably differentiate between profiles with
681 // the same name by date of most recent update
684 // Try to find profiles that listen to this profile and that have this nickname
685 $recipient = new Profile();
686 // XXX: use a join instead of a subquery
687 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
688 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
689 if ($recipient->find(true)) {
690 // XXX: should probably differentiate between profiles with
691 // the same name by date of most recent update
694 // If this is a local user, try to find a local user with that nickname.
695 $sender = User::staticGet($sender->id);
697 $recipient_user = User::staticGet('nickname', $nickname);
698 if ($recipient_user) {
699 return $recipient_user->getProfile();
702 // Otherwise, no links. @messages from local users to remote users,
703 // or from remote users to other remote users, are just
704 // outside our ability to make intelligent guesses about
708 function common_local_url($action, $args=null, $params=null, $fragment=null)
711 $path = $r->build($action, $args, $params, $fragment);
714 if (common_config('site','fancy')) {
715 $url = common_path(mb_substr($path, 1));
717 $url = common_path('index.php'.$path);
722 function common_path($relative)
725 $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
726 return "http://".$config['site']['server'].'/'.$pathpart.$relative;
729 function common_date_string($dt)
731 // XXX: do some sexy date formatting
732 // return date(DATE_RFC822, $dt);
737 if ($now < $t) { // that shouldn't happen!
738 return common_exact_date($dt);
739 } else if ($diff < 60) {
740 return _('a few seconds ago');
741 } else if ($diff < 92) {
742 return _('about a minute ago');
743 } else if ($diff < 3300) {
744 return sprintf(_('about %d minutes ago'), round($diff/60));
745 } else if ($diff < 5400) {
746 return _('about an hour ago');
747 } else if ($diff < 22 * 3600) {
748 return sprintf(_('about %d hours ago'), round($diff/3600));
749 } else if ($diff < 37 * 3600) {
750 return _('about a day ago');
751 } else if ($diff < 24 * 24 * 3600) {
752 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
753 } else if ($diff < 46 * 24 * 3600) {
754 return _('about a month ago');
755 } else if ($diff < 330 * 24 * 3600) {
756 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
757 } else if ($diff < 480 * 24 * 3600) {
758 return _('about a year ago');
760 return common_exact_date($dt);
764 function common_exact_date($dt)
770 $_utc = new DateTimeZone('UTC');
771 $_siteTz = new DateTimeZone(common_timezone());
774 $dateStr = date('d F Y H:i:s', strtotime($dt));
775 $d = new DateTime($dateStr, $_utc);
776 $d->setTimezone($_siteTz);
777 return $d->format(DATE_RFC850);
780 function common_date_w3dtf($dt)
782 $dateStr = date('d F Y H:i:s', strtotime($dt));
783 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
784 $d->setTimezone(new DateTimeZone(common_timezone()));
785 return $d->format(DATE_W3C);
788 function common_date_rfc2822($dt)
790 $dateStr = date('d F Y H:i:s', strtotime($dt));
791 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
792 $d->setTimezone(new DateTimeZone(common_timezone()));
793 return $d->format('r');
796 function common_date_iso8601($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('c');
804 function common_sql_now()
806 return strftime('%Y-%m-%d %H:%M:%S', time());
809 function common_redirect($url, $code=307)
811 static $status = array(301 => "Moved Permanently",
814 307 => "Temporary Redirect");
816 header("Status: ${code} $status[$code]");
817 header("Location: $url");
819 $xo = new XMLOutputter();
821 '-//W3C//DTD XHTML 1.0 Strict//EN',
822 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
823 $xo->element('a', array('href' => $url), $url);
828 function common_broadcast_notice($notice, $remote=false)
830 if (common_config('queue', 'enabled')) {
832 return common_enqueue_notice($notice);
834 return common_real_broadcast($notice, $remote);
838 // Stick the notice on the queue
840 function common_enqueue_notice($notice)
842 foreach (array('jabber', 'omb', 'sms', 'public', 'twitter', 'facebook') as $transport) {
843 $qi = new Queue_item();
844 $qi->notice_id = $notice->id;
845 $qi->transport = $transport;
846 $qi->created = $notice->created;
847 $result = $qi->insert();
849 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
850 common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
853 common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
858 function common_real_broadcast($notice, $remote=false)
862 // Make sure we have the OMB stuff
863 require_once(INSTALLDIR.'/lib/omb.php');
864 $success = omb_broadcast_remote_subscribers($notice);
866 common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
870 require_once(INSTALLDIR.'/lib/jabber.php');
871 $success = jabber_broadcast_notice($notice);
873 common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
877 require_once(INSTALLDIR.'/lib/mail.php');
878 $success = mail_broadcast_notice_sms($notice);
880 common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
884 $success = jabber_public_notice($notice);
886 common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
890 $success = broadcast_twitter($notice);
892 common_log(LOG_ERR, 'Error in Twitter broadcast for notice ' . $notice->id);
896 // XXX: Do a real-time FB broadcast here?
898 // XXX: broadcast notices to other IM
902 function common_broadcast_profile($profile)
904 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
905 require_once(INSTALLDIR.'/lib/omb.php');
906 omb_broadcast_profile($profile);
907 // XXX: Other broadcasts...?
911 function common_profile_url($nickname)
913 return common_local_url('showstream', array('nickname' => $nickname));
916 // Should make up a reasonable root URL
918 function common_root_url()
920 return common_path('');
923 // returns $bytes bytes of random data as a hexadecimal string
924 // "good" here is a goal and not a guarantee
926 function common_good_rand($bytes)
928 // XXX: use random.org...?
929 if (file_exists('/dev/urandom')) {
930 return common_urandom($bytes);
931 } else { // FIXME: this is probably not good enough
932 return common_mtrand($bytes);
936 function common_urandom($bytes)
938 $h = fopen('/dev/urandom', 'rb');
940 $src = fread($h, $bytes);
943 for ($i = 0; $i < $bytes; $i++) {
944 $enc .= sprintf("%02x", (ord($src[$i])));
949 function common_mtrand($bytes)
952 for ($i = 0; $i < $bytes; $i++) {
953 $enc .= sprintf("%02x", mt_rand(0, 255));
958 function common_set_returnto($url)
960 common_ensure_session();
961 $_SESSION['returnto'] = $url;
964 function common_get_returnto()
966 common_ensure_session();
967 return $_SESSION['returnto'];
970 function common_timestamp()
972 return date('YmdHis');
975 function common_ensure_syslog()
977 static $initialized = false;
980 openlog($config['syslog']['appname'], 0, LOG_USER);
985 function common_log($priority, $msg, $filename=null)
987 $logfile = common_config('site', 'logfile');
989 $log = fopen($logfile, "a");
991 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
992 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
993 $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
994 fwrite($log, $output);
998 common_ensure_syslog();
999 syslog($priority, $msg);
1003 function common_debug($msg, $filename=null)
1006 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1008 common_log(LOG_DEBUG, $msg);
1012 function common_log_db_error(&$object, $verb, $filename=null)
1014 $objstr = common_log_objstring($object);
1015 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1016 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1019 function common_log_objstring(&$object)
1021 if (is_null($object)) {
1024 $arr = $object->toArray();
1026 foreach ($arr as $k => $v) {
1027 $fields[] = "$k='$v'";
1029 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1033 function common_valid_http_url($url)
1035 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1038 function common_valid_tag($tag)
1040 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1041 return (Validate::email($matches[1]) ||
1042 preg_match('/^([\w-\.]+)$/', $matches[1]));
1047 /* Following functions are copied from MediaWiki GlobalFunctions.php
1048 * and written by Evan Prodromou. */
1050 function common_accept_to_prefs($accept, $def = '*/*')
1052 // No arg means accept anything (per HTTP spec)
1054 return array($def => 1);
1059 $parts = explode(',', $accept);
1061 foreach($parts as $part) {
1062 // FIXME: doesn't deal with params like 'text/html; level=1'
1063 @list($value, $qpart) = explode(';', $part);
1065 if(!isset($qpart)) {
1067 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1068 $prefs[$value] = $match[1];
1075 function common_mime_type_match($type, $avail)
1077 if(array_key_exists($type, $avail)) {
1080 $parts = explode('/', $type);
1081 if(array_key_exists($parts[0] . '/*', $avail)) {
1082 return $parts[0] . '/*';
1083 } elseif(array_key_exists('*/*', $avail)) {
1091 function common_negotiate_type($cprefs, $sprefs)
1095 foreach(array_keys($sprefs) as $type) {
1096 $parts = explode('/', $type);
1097 if($parts[1] != '*') {
1098 $ckey = common_mime_type_match($type, $cprefs);
1100 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1105 foreach(array_keys($cprefs) as $type) {
1106 $parts = explode('/', $type);
1107 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1108 $skey = common_mime_type_match($type, $sprefs);
1110 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1116 $besttype = 'text/html';
1118 foreach(array_keys($combine) as $type) {
1119 if($combine[$type] > $bestq) {
1121 $bestq = $combine[$type];
1125 if ('text/html' === $besttype) {
1126 return "text/html; charset=utf-8";
1131 function common_config($main, $sub)
1134 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1137 function common_copy_args($from)
1140 $strip = get_magic_quotes_gpc();
1141 foreach ($from as $k => $v) {
1142 $to[$k] = ($strip) ? stripslashes($v) : $v;
1147 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1148 // This is used before handing a request off to OAuthRequest::from_request.
1149 function common_remove_magic_from_request()
1151 if(get_magic_quotes_gpc()) {
1152 $_POST=array_map('stripslashes',$_POST);
1153 $_GET=array_map('stripslashes',$_GET);
1157 function common_user_uri(&$user)
1159 return common_local_url('userbyid', array('id' => $user->id));
1162 function common_notice_uri(&$notice)
1164 return common_local_url('shownotice',
1165 array('notice' => $notice->id));
1168 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1170 function common_confirmation_code($bits)
1172 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1173 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1174 $chars = ceil($bits/5);
1176 for ($i = 0; $i < $chars; $i++) {
1177 // XXX: convert to string and back
1178 $num = hexdec(common_good_rand(1));
1179 // XXX: randomness is too precious to throw away almost
1180 // 40% of the bits we get!
1181 $code .= $codechars[$num%32];
1186 // convert markup to HTML
1188 function common_markup_to_html($c)
1190 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1191 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1192 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1193 return Markdown($c);
1196 function common_profile_uri($profile)
1201 $user = User::staticGet($profile->id);
1206 $remote = Remote_profile::staticGet($profile->id);
1208 return $remote->uri;
1210 // XXX: this is a very bad profile!
1214 function common_canonical_sms($sms)
1217 preg_replace('/\D/', '', $sms);
1221 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1225 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1229 case E_USER_WARNING:
1230 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1234 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1238 // FIXME: show error page if we're on the Web
1239 /* Don't execute PHP internal error handler */
1243 function common_session_token()
1245 common_ensure_session();
1246 if (!array_key_exists('token', $_SESSION)) {
1247 $_SESSION['token'] = common_good_rand(64);
1249 return $_SESSION['token'];
1252 function common_cache_key($extra)
1254 return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1257 function common_keyize($str)
1259 $str = strtolower($str);
1260 $str = preg_replace('/\s/', '_', $str);
1264 function common_memcache()
1266 static $cache = null;
1267 if (!common_config('memcached', 'enabled')) {
1271 $cache = new Memcache();
1272 $servers = common_config('memcached', 'server');
1273 if (is_array($servers)) {
1274 foreach($servers as $server) {
1275 $cache->addServer($server);
1278 $cache->addServer($servers);
1285 function common_compatible_license($from, $to)
1287 // XXX: better compatibility check needed here!
1288 return ($from == $to);