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
417 '(?:https?|ftps?|mms|rtsp|gopher|news|nntp|telnet|wais|file|prospero|webcal|irc)://'.
419 '(?:mailto|aim|tel|xmpp):'.
422 '(?:(?: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
424 '(?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,6}|'. //IPv6
425 '(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,5}|'.
426 '(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,4}|'.
427 '(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,3}|'.
428 '(?:[0-9a-f]{1,4}:){1,5}(?::[0-9a-f]{1,4}){1,2}|'.
429 '(?:[0-9a-f]{1,4}:){1,6}(?::[0-9a-f]{1,4}){1,1}|'.
430 '(?:(?:[0-9a-f]{1,4}:){1,7}|:):|'.
431 ':(?::[0-9a-f]{1,4}){1,7}|'.
432 '(?:(?:(?:[0-9a-f]{1,4}:){6})(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3})|'.
433 '(?:(?:[0-9a-f]{1,4}:){5}[0-9a-f]{1,4}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3})|'.
434 '(?:[0-9a-f]{1,4}:){5}:[0-9a-f]{1,4}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
435 '(?:[0-9a-f]{1,4}:){1,1}(?::[0-9a-f]{1,4}){1,4}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
436 '(?:[0-9a-f]{1,4}:){1,2}(?::[0-9a-f]{1,4}){1,3}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
437 '(?:[0-9a-f]{1,4}:){1,3}(?::[0-9a-f]{1,4}){1,2}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
438 '(?:[0-9a-f]{1,4}:){1,4}(?::[0-9a-f]{1,4}){1,1}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
439 '(?:(?:[0-9a-f]{1,4}:){1,5}|:):(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|'.
440 ':(?::[0-9a-f]{1,4}){1,5}:(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)(?:\.(?:25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}'.
442 '(?:[^.\s/:]+\.)+'. //DNS
443 '(?:museum|travel|onion|[a-z]{2,4})'.
449 $callback_helper = curry(callback_helper, 3);
450 return preg_replace_callback($regex, $callback_helper($callback,$notice_id) ,$text);
453 function callback_helper($callback, $notice_id, $matches) {
454 if(empty($notice_id)){
455 return $callback($matches[1],$notice_id);
457 return $callback($matches[1]);
461 function curry($func, $arity) {
462 return create_function('', "
463 \$args = func_get_args();
464 if(count(\$args) >= $arity)
465 return call_user_func_array('$func', \$args);
466 \$args = var_export(\$args, 1);
467 return create_function('','
468 \$a = func_get_args();
469 \$z = ' . \$args . ';
470 \$a = array_merge(\$z,\$a);
471 return call_user_func_array(\'$func\', \$a);
476 function common_linkify($url) {
477 // It comes in special'd, so we unspecial it before passing to the stringifying
479 $url = htmlspecialchars_decode($url);
481 $canon = File_redirection::_canonUrl($url);
483 $longurl_data = File_redirection::where($url);
484 if (is_array($longurl_data)) {
485 $longurl = $longurl_data['url'];
486 } elseif (is_string($longurl_data)) {
487 $longurl = $longurl_data;
489 throw new ServerException("Can't linkify url '$url'");
492 $attrs = array('href' => $canon, 'rel' => 'external');
494 $is_attachment = false;
495 $attachment_id = null;
498 // Check to see whether there's a filename associated with this URL.
499 // If there is, it's an upload and qualifies as an attachment
501 $localfile = File::staticGet('url', $longurl);
503 if (!empty($localfile)) {
504 if (isset($localfile->filename)) {
505 $is_attachment = true;
506 $attachment_id = $localfile->id;
510 // if this URL is an attachment, then we set class='attachment' and id='attahcment-ID'
511 // where ID is the id of the attachment for the given URL.
513 // we need a better test telling what can be shown as an attachment
514 // we're currently picking up oembeds only.
515 // I think the best option is another file_view table in the db
516 // and associated dbobject.
518 $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'";
520 $file->query($query);
523 if (!empty($file->file_id)) {
524 $is_attachment = true;
525 $attachment_id = $file->file_id;
527 $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'";
529 $file2->query($query);
532 if (!empty($file2)) {
538 if ($is_attachment) {
539 $attrs['class'] = 'attachment';
541 $attrs['class'] = 'attachment thumbnail';
543 $attrs['id'] = "attachment-{$attachment_id}";
546 return XMLStringer::estring('a', $attrs, $url);
549 function common_shorten_links($text)
551 if (mb_strlen($text) <= 140) return $text;
552 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
555 function common_xml_safe_str($str)
557 // Neutralize control codes and surrogates
558 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
561 function common_tag_link($tag)
563 $canonical = common_canonical_tag($tag);
564 $url = common_local_url('tag', array('tag' => $canonical));
565 $xs = new XMLStringer();
566 $xs->elementStart('span', 'tag');
567 $xs->element('a', array('href' => $url,
570 $xs->elementEnd('span');
571 return $xs->getString();
574 function common_canonical_tag($tag)
576 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
577 return str_replace(array('-', '_', '.'), '', $tag);
580 function common_valid_profile_tag($str)
582 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
585 function common_at_link($sender_id, $nickname)
587 $sender = Profile::staticGet($sender_id);
588 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
590 $user = User::staticGet('id', $recipient->id);
592 $url = common_local_url('userbyid', array('id' => $user->id));
594 $url = $recipient->profileurl;
596 $xs = new XMLStringer(false);
597 $attrs = array('href' => $url,
599 if (!empty($recipient->fullname)) {
600 $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
602 $xs->elementStart('span', 'vcard');
603 $xs->elementStart('a', $attrs);
604 $xs->element('span', 'fn nickname', $nickname);
605 $xs->elementEnd('a');
606 $xs->elementEnd('span');
607 return $xs->getString();
613 function common_group_link($sender_id, $nickname)
615 $sender = Profile::staticGet($sender_id);
616 $group = User_group::getForNickname($nickname);
617 if ($group && $sender->isMember($group)) {
618 $attrs = array('href' => $group->permalink(),
620 if (!empty($group->fullname)) {
621 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
623 $xs = new XMLStringer();
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_at_hash_link($sender_id, $tag)
637 $user = User::staticGet($sender_id);
641 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
643 $url = common_local_url('subscriptions',
644 array('nickname' => $user->nickname,
646 $xs = new XMLStringer();
647 $xs->elementStart('span', 'tag');
648 $xs->element('a', array('href' => $url,
651 $xs->elementEnd('span');
652 return $xs->getString();
658 function common_relative_profile($sender, $nickname, $dt=null)
660 // Try to find profiles this profile is subscribed to that have this nickname
661 $recipient = new Profile();
662 // XXX: use a join instead of a subquery
663 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
664 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
665 if ($recipient->find(true)) {
666 // XXX: should probably differentiate between profiles with
667 // the same name by date of most recent update
670 // Try to find profiles that listen to this profile and that have this nickname
671 $recipient = new Profile();
672 // XXX: use a join instead of a subquery
673 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
674 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
675 if ($recipient->find(true)) {
676 // XXX: should probably differentiate between profiles with
677 // the same name by date of most recent update
680 // If this is a local user, try to find a local user with that nickname.
681 $sender = User::staticGet($sender->id);
683 $recipient_user = User::staticGet('nickname', $nickname);
684 if ($recipient_user) {
685 return $recipient_user->getProfile();
688 // Otherwise, no links. @messages from local users to remote users,
689 // or from remote users to other remote users, are just
690 // outside our ability to make intelligent guesses about
694 function common_local_url($action, $args=null, $params=null, $fragment=null)
696 static $sensitive = array('login', 'register', 'passwordsettings',
697 'twittersettings', 'finishopenidlogin',
698 'finishaddopenid', 'api');
701 $path = $r->build($action, $args, $params, $fragment);
703 $ssl = in_array($action, $sensitive);
705 if (common_config('site','fancy')) {
706 $url = common_path(mb_substr($path, 1), $ssl);
708 if (mb_strpos($path, '/index.php') === 0) {
709 $url = common_path(mb_substr($path, 1), $ssl);
711 $url = common_path('index.php'.$path, $ssl);
717 function common_path($relative, $ssl=false)
719 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
721 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
722 || common_config('site', 'ssl') === 'always') {
724 if (is_string(common_config('site', 'sslserver')) &&
725 mb_strlen(common_config('site', 'sslserver')) > 0) {
726 $serverpart = common_config('site', 'sslserver');
728 $serverpart = common_config('site', 'server');
732 $serverpart = common_config('site', 'server');
735 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
738 function common_date_string($dt)
740 // XXX: do some sexy date formatting
741 // return date(DATE_RFC822, $dt);
746 if ($now < $t) { // that shouldn't happen!
747 return common_exact_date($dt);
748 } else if ($diff < 60) {
749 return _('a few seconds ago');
750 } else if ($diff < 92) {
751 return _('about a minute ago');
752 } else if ($diff < 3300) {
753 return sprintf(_('about %d minutes ago'), round($diff/60));
754 } else if ($diff < 5400) {
755 return _('about an hour ago');
756 } else if ($diff < 22 * 3600) {
757 return sprintf(_('about %d hours ago'), round($diff/3600));
758 } else if ($diff < 37 * 3600) {
759 return _('about a day ago');
760 } else if ($diff < 24 * 24 * 3600) {
761 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
762 } else if ($diff < 46 * 24 * 3600) {
763 return _('about a month ago');
764 } else if ($diff < 330 * 24 * 3600) {
765 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
766 } else if ($diff < 480 * 24 * 3600) {
767 return _('about a year ago');
769 return common_exact_date($dt);
773 function common_exact_date($dt)
779 $_utc = new DateTimeZone('UTC');
780 $_siteTz = new DateTimeZone(common_timezone());
783 $dateStr = date('d F Y H:i:s', strtotime($dt));
784 $d = new DateTime($dateStr, $_utc);
785 $d->setTimezone($_siteTz);
786 return $d->format(DATE_RFC850);
789 function common_date_w3dtf($dt)
791 $dateStr = date('d F Y H:i:s', strtotime($dt));
792 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
793 $d->setTimezone(new DateTimeZone(common_timezone()));
794 return $d->format(DATE_W3C);
797 function common_date_rfc2822($dt)
799 $dateStr = date('d F Y H:i:s', strtotime($dt));
800 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
801 $d->setTimezone(new DateTimeZone(common_timezone()));
802 return $d->format('r');
805 function common_date_iso8601($dt)
807 $dateStr = date('d F Y H:i:s', strtotime($dt));
808 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
809 $d->setTimezone(new DateTimeZone(common_timezone()));
810 return $d->format('c');
813 function common_sql_now()
815 return common_sql_date(time());
818 function common_sql_date($datetime)
820 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
823 function common_redirect($url, $code=307)
825 static $status = array(301 => "Moved Permanently",
828 307 => "Temporary Redirect");
830 header('HTTP/1.1 '.$code.' '.$status[$code]);
831 header("Location: $url");
833 $xo = new XMLOutputter();
835 '-//W3C//DTD XHTML 1.0 Strict//EN',
836 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
837 $xo->element('a', array('href' => $url), $url);
842 function common_broadcast_notice($notice, $remote=false)
844 return common_enqueue_notice($notice);
847 // Stick the notice on the queue
849 function common_enqueue_notice($notice)
851 static $localTransports = array('omb',
855 static $allTransports = array('sms');
857 $transports = $allTransports;
859 $xmpp = common_config('xmpp', 'enabled');
862 $transports[] = 'jabber';
865 if ($notice->is_local == Notice::LOCAL_PUBLIC ||
866 $notice->is_local == Notice::LOCAL_NONPUBLIC) {
867 $transports = array_merge($transports, $localTransports);
869 $transports[] = 'public';
873 $qm = QueueManager::get();
875 foreach ($transports as $transport)
877 $qm->enqueue($notice, $transport);
883 function common_broadcast_profile($profile)
885 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
886 require_once(INSTALLDIR.'/lib/omb.php');
887 omb_broadcast_profile($profile);
888 // XXX: Other broadcasts...?
892 function common_profile_url($nickname)
894 return common_local_url('showstream', array('nickname' => $nickname));
897 // Should make up a reasonable root URL
899 function common_root_url($ssl=false)
901 return common_path('', $ssl);
904 // returns $bytes bytes of random data as a hexadecimal string
905 // "good" here is a goal and not a guarantee
907 function common_good_rand($bytes)
909 // XXX: use random.org...?
910 if (@file_exists('/dev/urandom')) {
911 return common_urandom($bytes);
912 } else { // FIXME: this is probably not good enough
913 return common_mtrand($bytes);
917 function common_urandom($bytes)
919 $h = fopen('/dev/urandom', 'rb');
921 $src = fread($h, $bytes);
924 for ($i = 0; $i < $bytes; $i++) {
925 $enc .= sprintf("%02x", (ord($src[$i])));
930 function common_mtrand($bytes)
933 for ($i = 0; $i < $bytes; $i++) {
934 $enc .= sprintf("%02x", mt_rand(0, 255));
939 function common_set_returnto($url)
941 common_ensure_session();
942 $_SESSION['returnto'] = $url;
945 function common_get_returnto()
947 common_ensure_session();
948 return $_SESSION['returnto'];
951 function common_timestamp()
953 return date('YmdHis');
956 function common_ensure_syslog()
958 static $initialized = false;
960 openlog(common_config('syslog', 'appname'), 0,
961 common_config('syslog', 'facility'));
966 function common_log_line($priority, $msg)
968 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
969 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
970 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
973 function common_log($priority, $msg, $filename=null)
975 $logfile = common_config('site', 'logfile');
977 $log = fopen($logfile, "a");
979 $output = common_log_line($priority, $msg);
980 fwrite($log, $output);
984 common_ensure_syslog();
985 syslog($priority, $msg);
989 function common_debug($msg, $filename=null)
992 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
994 common_log(LOG_DEBUG, $msg);
998 function common_log_db_error(&$object, $verb, $filename=null)
1000 $objstr = common_log_objstring($object);
1001 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1002 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1005 function common_log_objstring(&$object)
1007 if (is_null($object)) {
1010 if (!($object instanceof DB_DataObject)) {
1013 $arr = $object->toArray();
1015 foreach ($arr as $k => $v) {
1016 $fields[] = "$k='$v'";
1018 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1022 function common_valid_http_url($url)
1024 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1027 function common_valid_tag($tag)
1029 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1030 return (Validate::email($matches[1]) ||
1031 preg_match('/^([\w-\.]+)$/', $matches[1]));
1036 /* Following functions are copied from MediaWiki GlobalFunctions.php
1037 * and written by Evan Prodromou. */
1039 function common_accept_to_prefs($accept, $def = '*/*')
1041 // No arg means accept anything (per HTTP spec)
1043 return array($def => 1);
1048 $parts = explode(',', $accept);
1050 foreach($parts as $part) {
1051 // FIXME: doesn't deal with params like 'text/html; level=1'
1052 @list($value, $qpart) = explode(';', trim($part));
1054 if(!isset($qpart)) {
1056 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1057 $prefs[$value] = $match[1];
1064 function common_mime_type_match($type, $avail)
1066 if(array_key_exists($type, $avail)) {
1069 $parts = explode('/', $type);
1070 if(array_key_exists($parts[0] . '/*', $avail)) {
1071 return $parts[0] . '/*';
1072 } elseif(array_key_exists('*/*', $avail)) {
1080 function common_negotiate_type($cprefs, $sprefs)
1084 foreach(array_keys($sprefs) as $type) {
1085 $parts = explode('/', $type);
1086 if($parts[1] != '*') {
1087 $ckey = common_mime_type_match($type, $cprefs);
1089 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1094 foreach(array_keys($cprefs) as $type) {
1095 $parts = explode('/', $type);
1096 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1097 $skey = common_mime_type_match($type, $sprefs);
1099 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1105 $besttype = 'text/html';
1107 foreach(array_keys($combine) as $type) {
1108 if($combine[$type] > $bestq) {
1110 $bestq = $combine[$type];
1114 if ('text/html' === $besttype) {
1115 return "text/html; charset=utf-8";
1120 function common_config($main, $sub)
1123 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1126 function common_copy_args($from)
1129 $strip = get_magic_quotes_gpc();
1130 foreach ($from as $k => $v) {
1131 $to[$k] = ($strip) ? stripslashes($v) : $v;
1136 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1137 // This is used before handing a request off to OAuthRequest::from_request.
1138 function common_remove_magic_from_request()
1140 if(get_magic_quotes_gpc()) {
1141 $_POST=array_map('stripslashes',$_POST);
1142 $_GET=array_map('stripslashes',$_GET);
1146 function common_user_uri(&$user)
1148 return common_local_url('userbyid', array('id' => $user->id));
1151 function common_notice_uri(&$notice)
1153 return common_local_url('shownotice',
1154 array('notice' => $notice->id));
1157 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1159 function common_confirmation_code($bits)
1161 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1162 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1163 $chars = ceil($bits/5);
1165 for ($i = 0; $i < $chars; $i++) {
1166 // XXX: convert to string and back
1167 $num = hexdec(common_good_rand(1));
1168 // XXX: randomness is too precious to throw away almost
1169 // 40% of the bits we get!
1170 $code .= $codechars[$num%32];
1175 // convert markup to HTML
1177 function common_markup_to_html($c)
1179 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1180 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1181 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1182 return Markdown($c);
1185 function common_profile_uri($profile)
1190 $user = User::staticGet($profile->id);
1195 $remote = Remote_profile::staticGet($profile->id);
1197 return $remote->uri;
1199 // XXX: this is a very bad profile!
1203 function common_canonical_sms($sms)
1206 preg_replace('/\D/', '', $sms);
1210 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1215 case E_COMPILE_ERROR:
1219 case E_RECOVERABLE_ERROR:
1220 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1225 case E_COMPILE_WARNING:
1226 case E_CORE_WARNING:
1227 case E_USER_WARNING:
1228 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1233 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1238 case E_USER_DEPRECATED:
1239 // XXX: config variable to log this stuff, too
1243 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1248 // FIXME: show error page if we're on the Web
1249 /* Don't execute PHP internal error handler */
1253 function common_session_token()
1255 common_ensure_session();
1256 if (!array_key_exists('token', $_SESSION)) {
1257 $_SESSION['token'] = common_good_rand(64);
1259 return $_SESSION['token'];
1262 function common_cache_key($extra)
1264 $base_key = common_config('memcached', 'base');
1266 if (empty($base_key)) {
1267 $base_key = common_keyize(common_config('site', 'name'));
1270 return 'laconica:' . $base_key . ':' . $extra;
1273 function common_keyize($str)
1275 $str = strtolower($str);
1276 $str = preg_replace('/\s/', '_', $str);
1280 function common_memcache()
1282 static $cache = null;
1283 if (!common_config('memcached', 'enabled')) {
1287 $cache = new Memcache();
1288 $servers = common_config('memcached', 'server');
1289 if (is_array($servers)) {
1290 foreach($servers as $server) {
1291 $cache->addServer($server);
1294 $cache->addServer($servers);
1301 function common_compatible_license($from, $to)
1303 // XXX: better compatibility check needed here!
1304 return ($from == $to);
1308 * returns a quoted table name, if required according to config
1310 function common_database_tablename($tablename)
1313 if(common_config('db','quote_identifiers')) {
1314 $tablename = '"'. $tablename .'"';
1316 //table prefixes could be added here later
1320 function common_shorten_url($long_url)
1322 $user = common_current_user();
1324 // common current user does not find a user when called from the XMPP daemon
1325 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1328 $svc = $user->urlshorteningservice;
1331 $curlh = curl_init();
1332 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1333 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
1334 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1338 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1339 $short_url_service = new LilUrl;
1340 $short_url = $short_url_service->shorten($long_url);
1344 $short_url_service = new TightUrl;
1345 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1346 $short_url = $short_url_service->shorten($long_url);
1350 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1351 $short_url_service = new PtitUrl;
1352 $short_url = $short_url_service->shorten($long_url);
1356 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1357 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1361 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1362 $short_url = curl_exec($curlh);
1365 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1366 $short_url = curl_exec($curlh);
1368 case 'metamark.net':
1369 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1370 $short_url = curl_exec($curlh);
1373 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1374 $short_url = curl_exec($curlh);
1385 function common_client_ip()
1387 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1391 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1392 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1393 $proxy = $_SERVER['HTTP_CLIENT_IP'];
1395 $proxy = $_SERVER['REMOTE_ADDR'];
1397 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1400 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1401 $ip = $_SERVER['HTTP_CLIENT_IP'];
1403 $ip = $_SERVER['REMOTE_ADDR'];
1407 return array($proxy, $ip);