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) || $user === false) {
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 Session::setSaveHandler();
151 if (!isset($_SESSION['started'])) {
152 $_SESSION['started'] = time();
154 common_log(LOG_WARNING, 'Session cookie "' . $_COOKIE[session_name()] . '" ' .
155 ' is set but started value is null');
161 // Three kinds of arguments:
166 // Initialize to false; set to null if none found
170 function common_set_user($user)
175 if (is_null($user) && common_have_session()) {
177 unset($_SESSION['userid']);
179 } else if (is_string($user)) {
181 $user = User::staticGet('nickname', $nickname);
182 } else if (!($user instanceof User)) {
187 common_ensure_session();
188 $_SESSION['userid'] = $user->id;
195 function common_set_cookie($key, $value, $expiration=0)
197 $path = common_config('site', 'path');
198 $server = common_config('site', 'server');
200 if ($path && ($path != '/')) {
201 $cookiepath = '/' . $path . '/';
205 return setcookie($key,
212 define('REMEMBERME', 'rememberme');
213 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); // 30 days
215 function common_rememberme($user=null)
218 $user = common_current_user();
220 common_debug('No current user to remember', __FILE__);
225 $rm = new Remember_me();
227 $rm->code = common_good_rand(16);
228 $rm->user_id = $user->id;
230 // Wrap the insert in some good ol' fashioned transaction code
234 $result = $rm->insert();
237 common_log_db_error($rm, 'INSERT', __FILE__);
238 common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
242 $rm->query('COMMIT');
244 common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
246 $cookieval = $rm->user_id . ':' . $rm->code;
248 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
250 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
255 function common_remembered_user()
260 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : null;
266 list($id, $code) = explode(':', $packed);
268 if (!$id || !$code) {
269 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
274 $rm = Remember_me::staticGet($code);
277 common_log(LOG_WARNING, 'No such remember code: ' . $code);
282 if ($rm->user_id != $id) {
283 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
288 $user = User::staticGet($rm->user_id);
291 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
297 $result = $rm->delete();
300 common_log_db_error($rm, 'DELETE', __FILE__);
301 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
306 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
308 common_set_user($user);
309 common_real_login(false);
311 // We issue a new cookie, so they can log in
312 // automatically again after this session
314 common_rememberme($user);
319 // must be called with a valid user!
321 function common_forgetme()
323 common_set_cookie(REMEMBERME, '', 0);
326 // who is the current user?
327 function common_current_user()
331 if (!_have_config()) {
335 if ($_cur === false) {
337 if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
338 common_ensure_session();
339 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
341 $_cur = User::staticGet($id);
346 // that didn't work; try to remember; will init $_cur to null on failure
347 $_cur = common_remembered_user();
350 common_debug("Got User " . $_cur->nickname);
351 common_debug("Faking session on remembered user");
352 // XXX: Is this necessary?
353 $_SESSION['userid'] = $_cur->id;
360 // Logins that are 'remembered' aren't 'real' -- they're subject to
361 // cookie-stealing. So, we don't let them do certain things. New reg,
362 // OpenID, and password logins _are_ real.
364 function common_real_login($real=true)
366 common_ensure_session();
367 $_SESSION['real_login'] = $real;
370 function common_is_real_login()
372 return common_logged_in() && $_SESSION['real_login'];
375 // get canonical version of nickname for comparison
376 function common_canonical_nickname($nickname)
378 // XXX: UTF-8 canonicalization (like combining chars)
379 return strtolower($nickname);
382 // get canonical version of email for comparison
383 function common_canonical_email($email)
385 // XXX: canonicalize UTF-8
386 // XXX: lcase the domain part
390 function common_render_content($text, $notice)
392 $r = common_render_text($text);
393 $id = $notice->profile_id;
394 $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
395 $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
396 $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
397 $r = preg_replace('/(^|\s)!([A-Za-z0-9]{1,64})/e', "'\\1!'.common_group_link($id, '\\2')", $r);
401 function common_render_text($text)
403 $r = htmlspecialchars($text);
405 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
406 $r = common_replace_urls_callback($r, 'common_linkify');
407 $r = preg_replace('/(^|\(|\[|\s+)#([\pL\pN_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
412 function common_replace_urls_callback($text, $callback, $notice_id = null) {
413 // Start off with a regex
415 '(?:^|[\s\(\)\[\]\{\}]+)'.
418 '(?:'. //Known protocols
420 '(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://'.
422 '(?:mailto|aim|tel|xmpp):'.
425 '|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)'. //IPv4
427 '(?:(?:(?:[0-9A-Fa-f]{1,4}:){7}(?:(?:[0-9A-Fa-f]{1,4})|:))|(?:(?:[0-9A-Fa-f]{1,4}:){6}(?::|(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})|(?::[0-9A-Fa-f]{1,4})))|(?:(?:[0-9A-Fa-f]{1,4}:){5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){4}(?::[0-9A-Fa-f]{1,4}){0,1}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){3}(?::[0-9A-Fa-f]{1,4}){0,2}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:){2}(?::[0-9A-Fa-f]{1,4}){0,3}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:[0-9A-Fa-f]{1,4}:)(?::[0-9A-Fa-f]{1,4}){0,4}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?::(?::[0-9A-Fa-f]{1,4}){0,5}(?:(?::(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|(?:(?::[0-9A-Fa-f]{1,4}){1,2})))|(?:(?:(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})))'.
429 '\S+\.(?:museum|travel|onion|local|[a-z]{2,4})'.
434 '/[^\s\(\)\[\]\{\}]*'.
439 return preg_replace_callback($regex, curry(callback_helper,$callback,$notice_id) ,$text);
442 function callback_helper($matches, $callback, $notice_id) {
443 $pos = strpos($matches[0],$matches[1]);
444 $left = substr($matches[0],0,$pos);
445 $right = substr($matches[0],$pos+strlen($matches[1]));
447 if(empty($notice_id)){
448 $result = call_user_func_array($callback,$matches[1]);
450 $result = call_user_func_array($callback, array($matches[1],$notice_id) );
452 return $left . $result . $right;
455 function curry($fn) {
456 //TODO switch to a PHP 5.3 function closure based approach if PHP 5.3 is used
457 $args = func_get_args();
459 $id = uniqid('_partial');
460 $GLOBALS[$id] = array($fn, $args);
461 return create_function(
464 $args = func_get_args();
465 return call_user_func_array(
466 $GLOBALS["'.$id.'"][0],
469 $GLOBALS["'.$id.'"][1]));
473 function common_linkify($url) {
474 // It comes in special'd, so we unspecial it before passing to the stringifying
476 $url = htmlspecialchars_decode($url);
478 if(strpos($url, '@')!==false && strpos($url, ':')===false){
479 //url is an email address without the mailto: protocol
480 return XMLStringer::estring('a', array('href' => "mailto:$url", 'rel' => 'external'), $url);
483 $canon = File_redirection::_canonUrl($url);
485 $longurl_data = File_redirection::where($url);
486 if (is_array($longurl_data)) {
487 $longurl = $longurl_data['url'];
488 } elseif (is_string($longurl_data)) {
489 $longurl = $longurl_data;
491 throw new ServerException("Can't linkify url '$url'");
494 $attrs = array('href' => $canon, 'rel' => 'external');
496 $is_attachment = false;
497 $attachment_id = null;
500 // Check to see whether there's a filename associated with this URL.
501 // If there is, it's an upload and qualifies as an attachment
503 $localfile = File::staticGet('url', $longurl);
505 if (!empty($localfile)) {
506 if (isset($localfile->filename)) {
507 $is_attachment = true;
508 $attachment_id = $localfile->id;
512 // if this URL is an attachment, then we set class='attachment' and id='attahcment-ID'
513 // where ID is the id of the attachment for the given URL.
515 // we need a better test telling what can be shown as an attachment
516 // we're currently picking up oembeds only.
517 // I think the best option is another file_view table in the db
518 // and associated dbobject.
520 $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'";
522 $file->query($query);
525 if (!empty($file->file_id)) {
526 $is_attachment = true;
527 $attachment_id = $file->file_id;
529 $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'";
531 $file2->query($query);
534 if (!empty($file2)) {
540 if ($is_attachment) {
541 $attrs['class'] = 'attachment';
543 $attrs['class'] = 'attachment thumbnail';
545 $attrs['id'] = "attachment-{$attachment_id}";
548 return XMLStringer::estring('a', $attrs, $url);
551 function common_shorten_links($text)
553 if (mb_strlen($text) <= 140) return $text;
554 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
557 function common_xml_safe_str($str)
559 // Neutralize control codes and surrogates
560 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
563 function common_tag_link($tag)
565 $canonical = common_canonical_tag($tag);
566 $url = common_local_url('tag', array('tag' => $canonical));
567 $xs = new XMLStringer();
568 $xs->elementStart('span', 'tag');
569 $xs->element('a', array('href' => $url,
572 $xs->elementEnd('span');
573 return $xs->getString();
576 function common_canonical_tag($tag)
578 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
579 return str_replace(array('-', '_', '.'), '', $tag);
582 function common_valid_profile_tag($str)
584 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
587 function common_at_link($sender_id, $nickname)
589 $sender = Profile::staticGet($sender_id);
590 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
592 $user = User::staticGet('id', $recipient->id);
594 $url = common_local_url('userbyid', array('id' => $user->id));
596 $url = $recipient->profileurl;
598 $xs = new XMLStringer(false);
599 $attrs = array('href' => $url,
601 if (!empty($recipient->fullname)) {
602 $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
604 $xs->elementStart('span', 'vcard');
605 $xs->elementStart('a', $attrs);
606 $xs->element('span', 'fn nickname', $nickname);
607 $xs->elementEnd('a');
608 $xs->elementEnd('span');
609 return $xs->getString();
615 function common_group_link($sender_id, $nickname)
617 $sender = Profile::staticGet($sender_id);
618 $group = User_group::getForNickname($nickname);
619 if ($group && $sender->isMember($group)) {
620 $attrs = array('href' => $group->permalink(),
622 if (!empty($group->fullname)) {
623 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
625 $xs = new XMLStringer();
626 $xs->elementStart('span', 'vcard');
627 $xs->elementStart('a', $attrs);
628 $xs->element('span', 'fn nickname', $nickname);
629 $xs->elementEnd('a');
630 $xs->elementEnd('span');
631 return $xs->getString();
637 function common_at_hash_link($sender_id, $tag)
639 $user = User::staticGet($sender_id);
643 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
645 $url = common_local_url('subscriptions',
646 array('nickname' => $user->nickname,
648 $xs = new XMLStringer();
649 $xs->elementStart('span', 'tag');
650 $xs->element('a', array('href' => $url,
653 $xs->elementEnd('span');
654 return $xs->getString();
660 function common_relative_profile($sender, $nickname, $dt=null)
662 // Try to find profiles this profile is subscribed to that have this nickname
663 $recipient = new Profile();
664 // XXX: use a join instead of a subquery
665 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
666 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
667 if ($recipient->find(true)) {
668 // XXX: should probably differentiate between profiles with
669 // the same name by date of most recent update
672 // Try to find profiles that listen to this profile and that have this nickname
673 $recipient = new Profile();
674 // XXX: use a join instead of a subquery
675 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
676 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
677 if ($recipient->find(true)) {
678 // XXX: should probably differentiate between profiles with
679 // the same name by date of most recent update
682 // If this is a local user, try to find a local user with that nickname.
683 $sender = User::staticGet($sender->id);
685 $recipient_user = User::staticGet('nickname', $nickname);
686 if ($recipient_user) {
687 return $recipient_user->getProfile();
690 // Otherwise, no links. @messages from local users to remote users,
691 // or from remote users to other remote users, are just
692 // outside our ability to make intelligent guesses about
696 function common_local_url($action, $args=null, $params=null, $fragment=null)
698 static $sensitive = array('login', 'register', 'passwordsettings',
699 'twittersettings', 'finishopenidlogin',
700 'finishaddopenid', 'api');
703 $path = $r->build($action, $args, $params, $fragment);
705 $ssl = in_array($action, $sensitive);
707 if (common_config('site','fancy')) {
708 $url = common_path(mb_substr($path, 1), $ssl);
710 if (mb_strpos($path, '/index.php') === 0) {
711 $url = common_path(mb_substr($path, 1), $ssl);
713 $url = common_path('index.php'.$path, $ssl);
719 function common_path($relative, $ssl=false)
721 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
723 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
724 || common_config('site', 'ssl') === 'always') {
726 if (is_string(common_config('site', 'sslserver')) &&
727 mb_strlen(common_config('site', 'sslserver')) > 0) {
728 $serverpart = common_config('site', 'sslserver');
730 $serverpart = common_config('site', 'server');
734 $serverpart = common_config('site', 'server');
737 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
740 function common_date_string($dt)
742 // XXX: do some sexy date formatting
743 // return date(DATE_RFC822, $dt);
748 if ($now < $t) { // that shouldn't happen!
749 return common_exact_date($dt);
750 } else if ($diff < 60) {
751 return _('a few seconds ago');
752 } else if ($diff < 92) {
753 return _('about a minute ago');
754 } else if ($diff < 3300) {
755 return sprintf(_('about %d minutes ago'), round($diff/60));
756 } else if ($diff < 5400) {
757 return _('about an hour ago');
758 } else if ($diff < 22 * 3600) {
759 return sprintf(_('about %d hours ago'), round($diff/3600));
760 } else if ($diff < 37 * 3600) {
761 return _('about a day ago');
762 } else if ($diff < 24 * 24 * 3600) {
763 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
764 } else if ($diff < 46 * 24 * 3600) {
765 return _('about a month ago');
766 } else if ($diff < 330 * 24 * 3600) {
767 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
768 } else if ($diff < 480 * 24 * 3600) {
769 return _('about a year ago');
771 return common_exact_date($dt);
775 function common_exact_date($dt)
781 $_utc = new DateTimeZone('UTC');
782 $_siteTz = new DateTimeZone(common_timezone());
785 $dateStr = date('d F Y H:i:s', strtotime($dt));
786 $d = new DateTime($dateStr, $_utc);
787 $d->setTimezone($_siteTz);
788 return $d->format(DATE_RFC850);
791 function common_date_w3dtf($dt)
793 $dateStr = date('d F Y H:i:s', strtotime($dt));
794 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
795 $d->setTimezone(new DateTimeZone(common_timezone()));
796 return $d->format(DATE_W3C);
799 function common_date_rfc2822($dt)
801 $dateStr = date('d F Y H:i:s', strtotime($dt));
802 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
803 $d->setTimezone(new DateTimeZone(common_timezone()));
804 return $d->format('r');
807 function common_date_iso8601($dt)
809 $dateStr = date('d F Y H:i:s', strtotime($dt));
810 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
811 $d->setTimezone(new DateTimeZone(common_timezone()));
812 return $d->format('c');
815 function common_sql_now()
817 return common_sql_date(time());
820 function common_sql_date($datetime)
822 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
825 function common_redirect($url, $code=307)
827 static $status = array(301 => "Moved Permanently",
830 307 => "Temporary Redirect");
832 header('HTTP/1.1 '.$code.' '.$status[$code]);
833 header("Location: $url");
835 $xo = new XMLOutputter();
837 '-//W3C//DTD XHTML 1.0 Strict//EN',
838 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
839 $xo->element('a', array('href' => $url), $url);
844 function common_broadcast_notice($notice, $remote=false)
846 return common_enqueue_notice($notice);
849 // Stick the notice on the queue
851 function common_enqueue_notice($notice)
853 static $localTransports = array('omb',
857 static $allTransports = array('sms');
859 $transports = $allTransports;
861 $xmpp = common_config('xmpp', 'enabled');
864 $transports[] = 'jabber';
867 if ($notice->is_local == Notice::LOCAL_PUBLIC ||
868 $notice->is_local == Notice::LOCAL_NONPUBLIC) {
869 $transports = array_merge($transports, $localTransports);
871 $transports[] = 'public';
875 $qm = QueueManager::get();
877 foreach ($transports as $transport)
879 $qm->enqueue($notice, $transport);
885 function common_broadcast_profile($profile)
887 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
888 require_once(INSTALLDIR.'/lib/omb.php');
889 omb_broadcast_profile($profile);
890 // XXX: Other broadcasts...?
894 function common_profile_url($nickname)
896 return common_local_url('showstream', array('nickname' => $nickname));
899 // Should make up a reasonable root URL
901 function common_root_url($ssl=false)
903 return common_path('', $ssl);
906 // returns $bytes bytes of random data as a hexadecimal string
907 // "good" here is a goal and not a guarantee
909 function common_good_rand($bytes)
911 // XXX: use random.org...?
912 if (@file_exists('/dev/urandom')) {
913 return common_urandom($bytes);
914 } else { // FIXME: this is probably not good enough
915 return common_mtrand($bytes);
919 function common_urandom($bytes)
921 $h = fopen('/dev/urandom', 'rb');
923 $src = fread($h, $bytes);
926 for ($i = 0; $i < $bytes; $i++) {
927 $enc .= sprintf("%02x", (ord($src[$i])));
932 function common_mtrand($bytes)
935 for ($i = 0; $i < $bytes; $i++) {
936 $enc .= sprintf("%02x", mt_rand(0, 255));
941 function common_set_returnto($url)
943 common_ensure_session();
944 $_SESSION['returnto'] = $url;
947 function common_get_returnto()
949 common_ensure_session();
950 return $_SESSION['returnto'];
953 function common_timestamp()
955 return date('YmdHis');
958 function common_ensure_syslog()
960 static $initialized = false;
962 openlog(common_config('syslog', 'appname'), 0,
963 common_config('syslog', 'facility'));
968 function common_log_line($priority, $msg)
970 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
971 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
972 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
975 function common_log($priority, $msg, $filename=null)
977 $logfile = common_config('site', 'logfile');
979 $log = fopen($logfile, "a");
981 $output = common_log_line($priority, $msg);
982 fwrite($log, $output);
986 common_ensure_syslog();
987 syslog($priority, $msg);
991 function common_debug($msg, $filename=null)
994 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
996 common_log(LOG_DEBUG, $msg);
1000 function common_log_db_error(&$object, $verb, $filename=null)
1002 $objstr = common_log_objstring($object);
1003 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1004 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1007 function common_log_objstring(&$object)
1009 if (is_null($object)) {
1012 if (!($object instanceof DB_DataObject)) {
1015 $arr = $object->toArray();
1017 foreach ($arr as $k => $v) {
1018 $fields[] = "$k='$v'";
1020 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1024 function common_valid_http_url($url)
1026 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1029 function common_valid_tag($tag)
1031 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1032 return (Validate::email($matches[1]) ||
1033 preg_match('/^([\w-\.]+)$/', $matches[1]));
1038 /* Following functions are copied from MediaWiki GlobalFunctions.php
1039 * and written by Evan Prodromou. */
1041 function common_accept_to_prefs($accept, $def = '*/*')
1043 // No arg means accept anything (per HTTP spec)
1045 return array($def => 1);
1050 $parts = explode(',', $accept);
1052 foreach($parts as $part) {
1053 // FIXME: doesn't deal with params like 'text/html; level=1'
1054 @list($value, $qpart) = explode(';', trim($part));
1056 if(!isset($qpart)) {
1058 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1059 $prefs[$value] = $match[1];
1066 function common_mime_type_match($type, $avail)
1068 if(array_key_exists($type, $avail)) {
1071 $parts = explode('/', $type);
1072 if(array_key_exists($parts[0] . '/*', $avail)) {
1073 return $parts[0] . '/*';
1074 } elseif(array_key_exists('*/*', $avail)) {
1082 function common_negotiate_type($cprefs, $sprefs)
1086 foreach(array_keys($sprefs) as $type) {
1087 $parts = explode('/', $type);
1088 if($parts[1] != '*') {
1089 $ckey = common_mime_type_match($type, $cprefs);
1091 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1096 foreach(array_keys($cprefs) as $type) {
1097 $parts = explode('/', $type);
1098 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1099 $skey = common_mime_type_match($type, $sprefs);
1101 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1107 $besttype = 'text/html';
1109 foreach(array_keys($combine) as $type) {
1110 if($combine[$type] > $bestq) {
1112 $bestq = $combine[$type];
1116 if ('text/html' === $besttype) {
1117 return "text/html; charset=utf-8";
1122 function common_config($main, $sub)
1125 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1128 function common_copy_args($from)
1131 $strip = get_magic_quotes_gpc();
1132 foreach ($from as $k => $v) {
1133 $to[$k] = ($strip) ? stripslashes($v) : $v;
1138 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1139 // This is used before handing a request off to OAuthRequest::from_request.
1140 function common_remove_magic_from_request()
1142 if(get_magic_quotes_gpc()) {
1143 $_POST=array_map('stripslashes',$_POST);
1144 $_GET=array_map('stripslashes',$_GET);
1148 function common_user_uri(&$user)
1150 return common_local_url('userbyid', array('id' => $user->id));
1153 function common_notice_uri(&$notice)
1155 return common_local_url('shownotice',
1156 array('notice' => $notice->id));
1159 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1161 function common_confirmation_code($bits)
1163 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1164 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1165 $chars = ceil($bits/5);
1167 for ($i = 0; $i < $chars; $i++) {
1168 // XXX: convert to string and back
1169 $num = hexdec(common_good_rand(1));
1170 // XXX: randomness is too precious to throw away almost
1171 // 40% of the bits we get!
1172 $code .= $codechars[$num%32];
1177 // convert markup to HTML
1179 function common_markup_to_html($c)
1181 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1182 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1183 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1184 return Markdown($c);
1187 function common_profile_uri($profile)
1192 $user = User::staticGet($profile->id);
1197 $remote = Remote_profile::staticGet($profile->id);
1199 return $remote->uri;
1201 // XXX: this is a very bad profile!
1205 function common_canonical_sms($sms)
1208 preg_replace('/\D/', '', $sms);
1212 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1217 case E_COMPILE_ERROR:
1221 case E_RECOVERABLE_ERROR:
1222 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1227 case E_COMPILE_WARNING:
1228 case E_CORE_WARNING:
1229 case E_USER_WARNING:
1230 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1235 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1240 case E_USER_DEPRECATED:
1241 // XXX: config variable to log this stuff, too
1245 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1250 // FIXME: show error page if we're on the Web
1251 /* Don't execute PHP internal error handler */
1255 function common_session_token()
1257 common_ensure_session();
1258 if (!array_key_exists('token', $_SESSION)) {
1259 $_SESSION['token'] = common_good_rand(64);
1261 return $_SESSION['token'];
1264 function common_cache_key($extra)
1266 $base_key = common_config('memcached', 'base');
1268 if (empty($base_key)) {
1269 $base_key = common_keyize(common_config('site', 'name'));
1272 return 'laconica:' . $base_key . ':' . $extra;
1275 function common_keyize($str)
1277 $str = strtolower($str);
1278 $str = preg_replace('/\s/', '_', $str);
1282 function common_memcache()
1284 static $cache = null;
1285 if (!common_config('memcached', 'enabled')) {
1289 $cache = new Memcache();
1290 $servers = common_config('memcached', 'server');
1291 if (is_array($servers)) {
1292 foreach($servers as $server) {
1293 $cache->addServer($server);
1296 $cache->addServer($servers);
1303 function common_compatible_license($from, $to)
1305 // XXX: better compatibility check needed here!
1306 return ($from == $to);
1310 * returns a quoted table name, if required according to config
1312 function common_database_tablename($tablename)
1315 if(common_config('db','quote_identifiers')) {
1316 $tablename = '"'. $tablename .'"';
1318 //table prefixes could be added here later
1322 function common_shorten_url($long_url)
1324 $user = common_current_user();
1326 // common current user does not find a user when called from the XMPP daemon
1327 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1330 $svc = $user->urlshorteningservice;
1333 $curlh = curl_init();
1334 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1335 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
1336 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1340 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1341 $short_url_service = new LilUrl;
1342 $short_url = $short_url_service->shorten($long_url);
1346 $short_url_service = new TightUrl;
1347 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1348 $short_url = $short_url_service->shorten($long_url);
1352 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1353 $short_url_service = new PtitUrl;
1354 $short_url = $short_url_service->shorten($long_url);
1358 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1359 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1363 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1364 $short_url = curl_exec($curlh);
1367 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1368 $short_url = curl_exec($curlh);
1370 case 'metamark.net':
1371 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1372 $short_url = curl_exec($curlh);
1375 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1376 $short_url = curl_exec($curlh);
1387 function common_client_ip()
1389 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1393 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1394 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1395 $proxy = $_SERVER['HTTP_CLIENT_IP'];
1397 $proxy = $_SERVER['REMOTE_ADDR'];
1399 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1402 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1403 $ip = $_SERVER['HTTP_CLIENT_IP'];
1405 $ip = $_SERVER['REMOTE_ADDR'];
1409 return array($proxy, $ip);