3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, Control Yourself, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 /* XXX: break up into separate modules (HTTP, user, files) */
22 // Show a server error
24 function common_server_error($msg, $code=500)
26 $err = new ServerErrorAction($msg, $code);
31 function common_user_error($msg, $code=400)
33 $err = new ClientErrorAction($msg, $code);
37 function common_init_locale($language=null)
40 $language = common_language();
42 putenv('LANGUAGE='.$language);
43 putenv('LANG='.$language);
44 return setlocale(LC_ALL, $language . ".utf8",
51 function common_init_language()
53 mb_internal_encoding('UTF-8');
54 $language = common_language();
55 // So we don't have to make people install the gettext locales
56 $locale_set = common_init_locale($language);
57 bindtextdomain("laconica", common_config('site','locale_path'));
58 bind_textdomain_codeset("laconica", "UTF-8");
59 textdomain("laconica");
60 setlocale(LC_CTYPE, 'C');
62 common_log(LOG_INFO,'Language requested:'.$language.' - locale could not be set:',__FILE__);
66 function common_timezone()
68 if (common_logged_in()) {
69 $user = common_current_user();
70 if ($user->timezone) {
71 return $user->timezone;
75 return common_config('site', 'timezone');
78 function common_language()
81 // If there is a user logged in and they've set a language preference
82 // then return that one...
83 if (_have_config() && common_logged_in()) {
84 $user = common_current_user();
85 $user_language = $user->language;
87 return $user_language;
90 // Otherwise, find the best match for the languages requested by the
92 $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : null;
93 if (!empty($httplang)) {
94 $language = client_prefered_language($httplang);
99 // Finally, if none of the above worked, use the site's default...
100 return common_config('site', 'language');
102 // salted, hashed passwords are stored in the DB
104 function common_munge_password($password, $id)
106 return md5($password . $id);
109 // check if a username exists and has matching password
110 function common_check_user($nickname, $password)
112 // NEVER allow blank passwords, even if they match the DB
113 if (mb_strlen($password) == 0) {
116 $user = User::staticGet('nickname', $nickname);
117 if (is_null($user)) {
120 if (0 == strcmp(common_munge_password($password, $user->id),
129 // is the current user logged in?
130 function common_logged_in()
132 return (!is_null(common_current_user()));
135 function common_have_session()
137 return (0 != strcmp(session_id(), ''));
140 function common_ensure_session()
143 if (array_key_exists(session_name, $_COOKIE)) {
144 $c = $_COOKIE[session_name()];
146 if (!common_have_session()) {
147 if (common_config('sessions', 'handle')) {
148 common_log(LOG_INFO, "Using our own session handler");
149 Session::setSaveHandler();
152 if (!isset($_SESSION['started'])) {
153 $_SESSION['started'] = time();
155 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
156 ' is set but started value is null');
162 // Three kinds of arguments:
167 // Initialize to false; set to null if none found
171 function common_set_user($user)
176 if (is_null($user) && common_have_session()) {
178 unset($_SESSION['userid']);
180 } else if (is_string($user)) {
182 $user = User::staticGet('nickname', $nickname);
183 } else if (!($user instanceof User)) {
188 common_ensure_session();
189 $_SESSION['userid'] = $user->id;
196 function common_set_cookie($key, $value, $expiration=0)
198 $path = common_config('site', 'path');
199 $server = common_config('site', 'server');
201 if ($path && ($path != '/')) {
202 $cookiepath = '/' . $path . '/';
206 return setcookie($key,
213 define('REMEMBERME', 'rememberme');
214 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
216 function common_rememberme($user=null)
219 $user = common_current_user();
221 common_debug('No current user to remember', __FILE__);
226 $rm = new Remember_me();
228 $rm->code = common_good_rand(16);
229 $rm->user_id = $user->id;
231 // Wrap the insert in some good ol' fashioned transaction code
235 $result = $rm->insert();
238 common_log_db_error($rm, 'INSERT', __FILE__);
239 common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
243 $rm->query('COMMIT');
245 common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
247 $cookieval = $rm->user_id . ':' . $rm->code;
249 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
251 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
256 function common_remembered_user()
261 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
267 list($id, $code) = explode(':', $packed);
269 if (!$id || !$code) {
270 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
275 $rm = Remember_me::staticGet($code);
278 common_log(LOG_WARNING, 'No such remember code: ' . $code);
283 if ($rm->user_id != $id) {
284 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
289 $user = User::staticGet($rm->user_id);
292 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
298 $result = $rm->delete();
301 common_log_db_error($rm, 'DELETE', __FILE__);
302 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
307 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
309 common_set_user($user);
310 common_real_login(false);
312 // We issue a new cookie, so they can log in
313 // automatically again after this session
315 common_rememberme($user);
320 // must be called with a valid user!
322 function common_forgetme()
324 common_set_cookie(REMEMBERME, '', 0);
327 // who is the current user?
328 function common_current_user()
332 if (!_have_config()) {
336 if ($_cur === false) {
338 if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
339 common_ensure_session();
340 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
342 $_cur = User::staticGet($id);
347 // that didn't work; try to remember; will init $_cur to null on failure
348 $_cur = common_remembered_user();
351 common_debug("Got User " . $_cur->nickname);
352 common_debug("Faking session on remembered user");
353 // XXX: Is this necessary?
354 $_SESSION['userid'] = $_cur->id;
361 // Logins that are 'remembered' aren't 'real' -- they're subject to
362 // cookie-stealing. So, we don't let them do certain things. New reg,
363 // OpenID, and password logins _are_ real.
365 function common_real_login($real=true)
367 common_ensure_session();
368 $_SESSION['real_login'] = $real;
371 function common_is_real_login()
373 return common_logged_in() && $_SESSION['real_login'];
376 // get canonical version of nickname for comparison
377 function common_canonical_nickname($nickname)
379 // XXX: UTF-8 canonicalization (like combining chars)
380 return strtolower($nickname);
383 // get canonical version of email for comparison
384 function common_canonical_email($email)
386 // XXX: canonicalize UTF-8
387 // XXX: lcase the domain part
391 function common_render_content($text, $notice)
393 $r = common_render_text($text);
394 $id = $notice->profile_id;
395 $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
396 $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
397 $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
398 $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
402 function common_render_text($text)
404 $r = htmlspecialchars($text);
406 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
407 $r = common_replace_urls_callback($r, 'common_linkify');
408 $r = preg_replace('/(^|\(|\[|\s+)#([A-Za-z0-9_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
413 function common_replace_urls_callback($text, $callback, $notice_id = null) {
414 // Start off with a regex
418 '(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|xmpp|irc)://'.
420 '(?:mailto|aim|tel):'.
425 '(?:museum|travel|[a-z]{2,4})'.
429 preg_match_all($regex, $text, $matches);
431 // Then clean up what the regex left behind
433 foreach($matches[0] as $orig_url) {
434 $url = htmlspecialchars_decode($orig_url);
436 // Make sure we didn't pick up an email address
437 if (preg_match('#^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$#i', $url)) continue;
439 // Remove surrounding punctuation
440 $url = trim($url, '.?!,;:\'"`([<');
442 // Remove surrounding parens and the like
443 preg_match('/[)\]>]+$/', $url, $trailing);
444 if (isset($trailing[0])) {
445 preg_match_all('/[(\[<]/', $url, $opened);
446 preg_match_all('/[)\]>]/', $url, $closed);
447 $unopened = count($closed[0]) - count($opened[0]);
449 // Make sure not to take off more closing parens than there are at the end
450 $unopened = ($unopened > mb_strlen($trailing[0])) ? mb_strlen($trailing[0]):$unopened;
452 $url = ($unopened > 0) ? mb_substr($url, 0, $unopened * -1):$url;
455 // Remove trailing punctuation again (in case there were some inside parens)
456 $url = rtrim($url, '.?!,;:\'"`');
458 // Make sure we didn't capture part of the next sentence
459 preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
461 // Were the parts capitalized any?
462 $last_part = (mb_strtolower($url_parts[2]) !== $url_parts[2]) ? true:false;
463 $prev_part = (mb_strtolower($url_parts[1]) !== $url_parts[1]) ? true:false;
465 // If the first part wasn't cap'd but the last part was, we captured too much
466 if ((!$prev_part && $last_part)) {
467 $url = mb_substr($url, 0 , mb_strpos($url, '.'.$url_parts['2'], 0));
470 // Capture the new TLD
471 preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
473 $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');
475 if (!in_array($url_parts[2], $tlds)) continue;
477 // Make sure we didn't capture a hash tag
478 if (strpos($url, '#') === 0) continue;
480 // Put the url back the way we found it.
481 $url = (mb_strpos($orig_url, htmlspecialchars($url)) === FALSE) ? $url:htmlspecialchars($url);
483 // Call user specified func
484 if (empty($notice_id)) {
485 $modified_url = call_user_func($callback, $url);
487 $modified_url = call_user_func($callback, array($url, $notice_id));
491 $start = mb_strpos($text, $url, $offset);
492 $text = mb_substr($text, 0, $start).$modified_url.mb_substr($text, $start + mb_strlen($url), mb_strlen($text));
493 $offset = $start + mb_strlen($modified_url);
499 function common_linkify($url) {
500 // It comes in special'd, so we unspecial it before passing to the stringifying
502 $url = htmlspecialchars_decode($url);
504 $canon = File_redirection::_canonUrl($url);
506 $longurl_data = File_redirection::where($url);
507 if (is_array($longurl_data)) {
508 $longurl = $longurl_data['url'];
509 } elseif (is_string($longurl_data)) {
510 $longurl = $longurl_data;
512 throw new ServerException("Can't linkify url '$url'");
515 $attrs = array('href' => $canon, 'rel' => 'external');
517 $is_attachment = false;
518 $attachment_id = null;
521 // Check to see whether there's a filename associated with this URL.
522 // If there is, it's an upload and qualifies as an attachment
524 $localfile = File::staticGet('url', $longurl);
526 if (!empty($localfile)) {
527 if (isset($localfile->filename)) {
528 $is_attachment = true;
529 $attachment_id = $localfile->id;
533 // if this URL is an attachment, then we set class='attachment' and id='attahcment-ID'
534 // where ID is the id of the attachment for the given URL.
536 // we need a better test telling what can be shown as an attachment
537 // we're currently picking up oembeds only.
538 // I think the best option is another file_view table in the db
539 // and associated dbobject.
541 $query = "select file_oembed.file_id as file_id from file join file_oembed on file.id = file_oembed.file_id where file.url='$longurl'";
543 $file->query($query);
546 if (!empty($file->file_id)) {
547 $is_attachment = true;
548 $attachment_id = $file->file_id;
550 $query = "select file_thumbnail.file_id as file_id from file join file_thumbnail on file.id = file_thumbnail.file_id where file.url='$longurl'";
552 $file2->query($query);
555 if (!empty($file2)) {
561 if ($is_attachment) {
562 $attrs['class'] = 'attachment';
564 $attrs['class'] = 'attachment thumbnail';
566 $attrs['id'] = "attachment-{$attachment_id}";
569 return XMLStringer::estring('a', $attrs, $url);
572 function common_shorten_links($text)
574 if (mb_strlen($text) <= 140) return $text;
575 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
578 function common_xml_safe_str($str)
580 // Neutralize control codes and surrogates
581 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
584 function common_tag_link($tag)
586 $canonical = common_canonical_tag($tag);
587 $url = common_local_url('tag', array('tag' => $canonical));
588 $xs = new XMLStringer();
589 $xs->elementStart('span', 'tag');
590 $xs->element('a', array('href' => $url,
593 $xs->elementEnd('span');
594 return $xs->getString();
597 function common_canonical_tag($tag)
599 return strtolower(str_replace(array('-', '_', '.'), '', $tag));
602 function common_valid_profile_tag($str)
604 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
607 function common_at_link($sender_id, $nickname)
609 $sender = Profile::staticGet($sender_id);
610 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
612 $user = User::staticGet('id', $recipient->id);
614 $url = common_local_url('userbyid', array('id' => $user->id));
616 $url = $recipient->profileurl;
618 $xs = new XMLStringer(false);
619 $attrs = array('href' => $url,
621 if (!empty($recipient->fullname)) {
622 $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
624 $xs->elementStart('span', 'vcard');
625 $xs->elementStart('a', $attrs);
626 $xs->element('span', 'fn nickname', $nickname);
627 $xs->elementEnd('a');
628 $xs->elementEnd('span');
629 return $xs->getString();
635 function common_group_link($sender_id, $nickname)
637 $sender = Profile::staticGet($sender_id);
638 $group = User_group::getForNickname($nickname);
639 if ($group && $sender->isMember($group)) {
640 $attrs = array('href' => $group->permalink(),
642 if (!empty($group->fullname)) {
643 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
645 $xs = new XMLStringer();
646 $xs->elementStart('span', 'vcard');
647 $xs->elementStart('a', $attrs);
648 $xs->element('span', 'fn nickname', $nickname);
649 $xs->elementEnd('a');
650 $xs->elementEnd('span');
651 return $xs->getString();
657 function common_at_hash_link($sender_id, $tag)
659 $user = User::staticGet($sender_id);
663 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
665 $url = common_local_url('subscriptions',
666 array('nickname' => $user->nickname,
668 $xs = new XMLStringer();
669 $xs->elementStart('span', 'tag');
670 $xs->element('a', array('href' => $url,
673 $xs->elementEnd('span');
674 return $xs->getString();
680 function common_relative_profile($sender, $nickname, $dt=null)
682 // Try to find profiles this profile is subscribed to that have this nickname
683 $recipient = new Profile();
684 // XXX: use a join instead of a subquery
685 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
686 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
687 if ($recipient->find(true)) {
688 // XXX: should probably differentiate between profiles with
689 // the same name by date of most recent update
692 // Try to find profiles that listen to this profile and that have this nickname
693 $recipient = new Profile();
694 // XXX: use a join instead of a subquery
695 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
696 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
697 if ($recipient->find(true)) {
698 // XXX: should probably differentiate between profiles with
699 // the same name by date of most recent update
702 // If this is a local user, try to find a local user with that nickname.
703 $sender = User::staticGet($sender->id);
705 $recipient_user = User::staticGet('nickname', $nickname);
706 if ($recipient_user) {
707 return $recipient_user->getProfile();
710 // Otherwise, no links. @messages from local users to remote users,
711 // or from remote users to other remote users, are just
712 // outside our ability to make intelligent guesses about
716 function common_local_url($action, $args=null, $params=null, $fragment=null)
718 static $sensitive = array('login', 'register', 'passwordsettings',
719 'twittersettings', 'finishopenidlogin',
720 'finishaddopenid', 'api');
723 $path = $r->build($action, $args, $params, $fragment);
725 $ssl = in_array($action, $sensitive);
727 if (common_config('site','fancy')) {
728 $url = common_path(mb_substr($path, 1), $ssl);
730 if (mb_strpos($path, '/index.php') === 0) {
731 $url = common_path(mb_substr($path, 1), $ssl);
733 $url = common_path('index.php'.$path, $ssl);
739 function common_path($relative, $ssl=false)
741 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
743 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
744 || common_config('site', 'ssl') === 'always') {
746 if (is_string(common_config('site', 'sslserver')) &&
747 mb_strlen(common_config('site', 'sslserver')) > 0) {
748 $serverpart = common_config('site', 'sslserver');
750 $serverpart = common_config('site', 'server');
754 $serverpart = common_config('site', 'server');
757 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
760 function common_date_string($dt)
762 // XXX: do some sexy date formatting
763 // return date(DATE_RFC822, $dt);
768 if ($now < $t) { // that shouldn't happen!
769 return common_exact_date($dt);
770 } else if ($diff < 60) {
771 return _('a few seconds ago');
772 } else if ($diff < 92) {
773 return _('about a minute ago');
774 } else if ($diff < 3300) {
775 return sprintf(_('about %d minutes ago'), round($diff/60));
776 } else if ($diff < 5400) {
777 return _('about an hour ago');
778 } else if ($diff < 22 * 3600) {
779 return sprintf(_('about %d hours ago'), round($diff/3600));
780 } else if ($diff < 37 * 3600) {
781 return _('about a day ago');
782 } else if ($diff < 24 * 24 * 3600) {
783 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
784 } else if ($diff < 46 * 24 * 3600) {
785 return _('about a month ago');
786 } else if ($diff < 330 * 24 * 3600) {
787 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
788 } else if ($diff < 480 * 24 * 3600) {
789 return _('about a year ago');
791 return common_exact_date($dt);
795 function common_exact_date($dt)
801 $_utc = new DateTimeZone('UTC');
802 $_siteTz = new DateTimeZone(common_timezone());
805 $dateStr = date('d F Y H:i:s', strtotime($dt));
806 $d = new DateTime($dateStr, $_utc);
807 $d->setTimezone($_siteTz);
808 return $d->format(DATE_RFC850);
811 function common_date_w3dtf($dt)
813 $dateStr = date('d F Y H:i:s', strtotime($dt));
814 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
815 $d->setTimezone(new DateTimeZone(common_timezone()));
816 return $d->format(DATE_W3C);
819 function common_date_rfc2822($dt)
821 $dateStr = date('d F Y H:i:s', strtotime($dt));
822 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
823 $d->setTimezone(new DateTimeZone(common_timezone()));
824 return $d->format('r');
827 function common_date_iso8601($dt)
829 $dateStr = date('d F Y H:i:s', strtotime($dt));
830 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
831 $d->setTimezone(new DateTimeZone(common_timezone()));
832 return $d->format('c');
835 function common_sql_now()
837 return common_sql_date(time());
840 function common_sql_date($datetime)
842 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
845 function common_redirect($url, $code=307)
847 static $status = array(301 => "Moved Permanently",
850 307 => "Temporary Redirect");
852 header('HTTP/1.1 '.$code.' '.$status[$code]);
853 header("Location: $url");
855 $xo = new XMLOutputter();
857 '-//W3C//DTD XHTML 1.0 Strict//EN',
858 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
859 $xo->element('a', array('href' => $url), $url);
864 function common_broadcast_notice($notice, $remote=false)
866 if (common_config('queue', 'enabled')) {
868 return common_enqueue_notice($notice);
870 return common_real_broadcast($notice, $remote);
874 // Stick the notice on the queue
876 function common_enqueue_notice($notice)
878 $transports = array('omb', 'sms', 'public', 'twitter', 'facebook', 'ping');
880 if (common_config('xmpp', 'enabled'))
882 $transports[] = 'jabber';
885 if (common_config('queue','subsystem') == 'stomp') {
886 common_enqueue_notice_stomp($notice, $transports);
889 common_enqueue_notice_db($notice, $transports);
894 function common_enqueue_notice_stomp($notice, $transports)
896 // use an external message queue system via STOMP
897 require_once("Stomp.php");
899 $server = common_config('queue','stomp_server');
900 $username = common_config('queue', 'stomp_username');
901 $password = common_config('queue', 'stomp_password');
903 $con = new Stomp($server);
905 if (!$con->connect($username, $password)) {
906 common_log(LOG_ERR, 'Failed to connect to queue server');
910 $queue_basename = common_config('queue','queue_basename');
912 foreach ($transports as $transport) {
913 $result = $con->send('/queue/'.$queue_basename.'-'.$transport, // QUEUE
914 $notice->id, // BODY of the message
915 array ('created' => $notice->created));
917 common_log(LOG_ERR, 'Error sending to '.$transport.' queue');
920 common_log(LOG_DEBUG, 'complete remote queueing notice ID = ' . $notice->id . ' for ' . $transport);
923 //send tags as headers, so they can be used as JMS selectors
924 common_log(LOG_DEBUG, 'searching for tags ' . $notice->id);
926 $tag = new Notice_tag();
927 $tag->notice_id = $notice->id;
929 while ($tag->fetch()) {
930 common_log(LOG_DEBUG, 'tag found = ' . $tag->tag);
931 array_push($tags,$tag->tag);
936 $con->send('/topic/laconica.'.$notice->profile_id,
939 'profile_id' => $notice->profile_id,
940 'created' => $notice->created,
941 'tags' => implode($tags,' - ')
944 common_log(LOG_DEBUG, 'sent to personal topic ' . $notice->id);
945 $con->send('/topic/laconica.allusers',
948 'profile_id' => $notice->profile_id,
949 'created' => $notice->created,
950 'tags' => implode($tags,' - ')
953 common_log(LOG_DEBUG, 'sent to catch-all topic ' . $notice->id);
957 function common_enqueue_notice_db($notice, $transports)
959 // in any other case, 'internal'
960 foreach ($transports as $transport) {
961 common_enqueue_notice_transport($notice, $transport);
965 function common_enqueue_notice_transport($notice, $transport)
967 $qi = new Queue_item();
968 $qi->notice_id = $notice->id;
969 $qi->transport = $transport;
970 $qi->created = $notice->created;
971 $result = $qi->insert();
973 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
974 common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
975 throw new ServerException('DB error inserting queue item: ' . $last_error->message);
977 common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
981 function common_real_broadcast($notice, $remote=false)
985 // Make sure we have the OMB stuff
986 require_once(INSTALLDIR.'/lib/omb.php');
987 $success = omb_broadcast_remote_subscribers($notice);
989 common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
993 require_once(INSTALLDIR.'/lib/jabber.php');
994 $success = jabber_broadcast_notice($notice);
996 common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
1000 require_once(INSTALLDIR.'/lib/mail.php');
1001 $success = mail_broadcast_notice_sms($notice);
1003 common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
1007 $success = jabber_public_notice($notice);
1009 common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
1013 $success = broadcast_twitter($notice);
1015 common_log(LOG_ERR, 'Error in Twitter broadcast for notice ' . $notice->id);
1019 // XXX: Do a real-time FB broadcast here?
1021 // XXX: broadcast notices to other IM
1025 function common_broadcast_profile($profile)
1027 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1028 require_once(INSTALLDIR.'/lib/omb.php');
1029 omb_broadcast_profile($profile);
1030 // XXX: Other broadcasts...?
1034 function common_profile_url($nickname)
1036 return common_local_url('showstream', array('nickname' => $nickname));
1039 // Should make up a reasonable root URL
1041 function common_root_url($ssl=false)
1043 return common_path('', $ssl);
1046 // returns $bytes bytes of random data as a hexadecimal string
1047 // "good" here is a goal and not a guarantee
1049 function common_good_rand($bytes)
1051 // XXX: use random.org...?
1052 if (@file_exists('/dev/urandom')) {
1053 return common_urandom($bytes);
1054 } else { // FIXME: this is probably not good enough
1055 return common_mtrand($bytes);
1059 function common_urandom($bytes)
1061 $h = fopen('/dev/urandom', 'rb');
1063 $src = fread($h, $bytes);
1066 for ($i = 0; $i < $bytes; $i++) {
1067 $enc .= sprintf("%02x", (ord($src[$i])));
1072 function common_mtrand($bytes)
1075 for ($i = 0; $i < $bytes; $i++) {
1076 $enc .= sprintf("%02x", mt_rand(0, 255));
1081 function common_set_returnto($url)
1083 common_ensure_session();
1084 $_SESSION['returnto'] = $url;
1087 function common_get_returnto()
1089 common_ensure_session();
1090 return $_SESSION['returnto'];
1093 function common_timestamp()
1095 return date('YmdHis');
1098 function common_ensure_syslog()
1100 static $initialized = false;
1101 if (!$initialized) {
1102 openlog(common_config('syslog', 'appname'), 0, LOG_USER);
1103 $initialized = true;
1107 function common_log($priority, $msg, $filename=null)
1109 $logfile = common_config('site', 'logfile');
1111 $log = fopen($logfile, "a");
1113 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1114 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1115 $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1116 fwrite($log, $output);
1120 common_ensure_syslog();
1121 syslog($priority, $msg);
1125 function common_debug($msg, $filename=null)
1128 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1130 common_log(LOG_DEBUG, $msg);
1134 function common_log_db_error(&$object, $verb, $filename=null)
1136 $objstr = common_log_objstring($object);
1137 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1138 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1141 function common_log_objstring(&$object)
1143 if (is_null($object)) {
1146 $arr = $object->toArray();
1148 foreach ($arr as $k => $v) {
1149 $fields[] = "$k='$v'";
1151 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1155 function common_valid_http_url($url)
1157 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1160 function common_valid_tag($tag)
1162 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1163 return (Validate::email($matches[1]) ||
1164 preg_match('/^([\w-\.]+)$/', $matches[1]));
1169 /* Following functions are copied from MediaWiki GlobalFunctions.php
1170 * and written by Evan Prodromou. */
1172 function common_accept_to_prefs($accept, $def = '*/*')
1174 // No arg means accept anything (per HTTP spec)
1176 return array($def => 1);
1181 $parts = explode(',', $accept);
1183 foreach($parts as $part) {
1184 // FIXME: doesn't deal with params like 'text/html; level=1'
1185 @list($value, $qpart) = explode(';', trim($part));
1187 if(!isset($qpart)) {
1189 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1190 $prefs[$value] = $match[1];
1197 function common_mime_type_match($type, $avail)
1199 if(array_key_exists($type, $avail)) {
1202 $parts = explode('/', $type);
1203 if(array_key_exists($parts[0] . '/*', $avail)) {
1204 return $parts[0] . '/*';
1205 } elseif(array_key_exists('*/*', $avail)) {
1213 function common_negotiate_type($cprefs, $sprefs)
1217 foreach(array_keys($sprefs) as $type) {
1218 $parts = explode('/', $type);
1219 if($parts[1] != '*') {
1220 $ckey = common_mime_type_match($type, $cprefs);
1222 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1227 foreach(array_keys($cprefs) as $type) {
1228 $parts = explode('/', $type);
1229 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1230 $skey = common_mime_type_match($type, $sprefs);
1232 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1238 $besttype = 'text/html';
1240 foreach(array_keys($combine) as $type) {
1241 if($combine[$type] > $bestq) {
1243 $bestq = $combine[$type];
1247 if ('text/html' === $besttype) {
1248 return "text/html; charset=utf-8";
1253 function common_config($main, $sub)
1256 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1259 function common_copy_args($from)
1262 $strip = get_magic_quotes_gpc();
1263 foreach ($from as $k => $v) {
1264 $to[$k] = ($strip) ? stripslashes($v) : $v;
1269 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1270 // This is used before handing a request off to OAuthRequest::from_request.
1271 function common_remove_magic_from_request()
1273 if(get_magic_quotes_gpc()) {
1274 $_POST=array_map('stripslashes',$_POST);
1275 $_GET=array_map('stripslashes',$_GET);
1279 function common_user_uri(&$user)
1281 return common_local_url('userbyid', array('id' => $user->id));
1284 function common_notice_uri(&$notice)
1286 return common_local_url('shownotice',
1287 array('notice' => $notice->id));
1290 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1292 function common_confirmation_code($bits)
1294 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1295 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1296 $chars = ceil($bits/5);
1298 for ($i = 0; $i < $chars; $i++) {
1299 // XXX: convert to string and back
1300 $num = hexdec(common_good_rand(1));
1301 // XXX: randomness is too precious to throw away almost
1302 // 40% of the bits we get!
1303 $code .= $codechars[$num%32];
1308 // convert markup to HTML
1310 function common_markup_to_html($c)
1312 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1313 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1314 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1315 return Markdown($c);
1318 function common_profile_uri($profile)
1323 $user = User::staticGet($profile->id);
1328 $remote = Remote_profile::staticGet($profile->id);
1330 return $remote->uri;
1332 // XXX: this is a very bad profile!
1336 function common_canonical_sms($sms)
1339 preg_replace('/\D/', '', $sms);
1343 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1347 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1351 case E_USER_WARNING:
1352 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1356 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1360 // FIXME: show error page if we're on the Web
1361 /* Don't execute PHP internal error handler */
1365 function common_session_token()
1367 common_ensure_session();
1368 if (!array_key_exists('token', $_SESSION)) {
1369 $_SESSION['token'] = common_good_rand(64);
1371 return $_SESSION['token'];
1374 function common_cache_key($extra)
1376 $base_key = common_config('memcached', 'base');
1378 if (empty($base_key)) {
1379 $base_key = common_keyize(common_config('site', 'name'));
1382 return 'laconica:' . $base_key . ':' . $extra;
1385 function common_keyize($str)
1387 $str = strtolower($str);
1388 $str = preg_replace('/\s/', '_', $str);
1392 function common_memcache()
1394 static $cache = null;
1395 if (!common_config('memcached', 'enabled')) {
1399 $cache = new Memcache();
1400 $servers = common_config('memcached', 'server');
1401 if (is_array($servers)) {
1402 foreach($servers as $server) {
1403 $cache->addServer($server);
1406 $cache->addServer($servers);
1413 function common_compatible_license($from, $to)
1415 // XXX: better compatibility check needed here!
1416 return ($from == $to);
1420 * returns a quoted table name, if required according to config
1422 function common_database_tablename($tablename)
1425 if(common_config('db','quote_identifiers')) {
1426 $tablename = '"'. $tablename .'"';
1428 //table prefixes could be added here later
1432 function common_shorten_url($long_url)
1434 $user = common_current_user();
1436 // common current user does not find a user when called from the XMPP daemon
1437 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1440 $svc = $user->urlshorteningservice;
1443 $curlh = curl_init();
1444 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1445 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
1446 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1450 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1451 $short_url_service = new LilUrl;
1452 $short_url = $short_url_service->shorten($long_url);
1456 $short_url_service = new TightUrl;
1457 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1458 $short_url = $short_url_service->shorten($long_url);
1462 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1463 $short_url_service = new PtitUrl;
1464 $short_url = $short_url_service->shorten($long_url);
1468 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1469 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1473 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1474 $short_url = curl_exec($curlh);
1477 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1478 $short_url = curl_exec($curlh);
1480 case 'metamark.net':
1481 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1482 $short_url = curl_exec($curlh);
1485 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1486 $short_url = curl_exec($curlh);
1497 function common_client_ip()
1499 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1503 if ($_SERVER['HTTP_X_FORWARDED_FOR']) {
1504 if ($_SERVER['HTTP_CLIENT_IP']) {
1505 $proxy = $_SERVER['HTTP_CLIENT_IP'];
1507 $proxy = $_SERVER['REMOTE_ADDR'];
1509 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1511 if ($_SERVER['HTTP_CLIENT_IP']) {
1512 $ip = $_SERVER['HTTP_CLIENT_IP'];
1514 $ip = $_SERVER['REMOTE_ADDR'];
1518 return array($ip, $proxy);