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})'.
448 preg_match_all($regex, $text, $matches);
449 // Then clean up what the regex left behind
451 foreach($matches[1] as $url) {
452 // Call user specified func
453 if (empty($notice_id)) {
454 $modified_url = call_user_func($callback, $url);
456 $modified_url = call_user_func($callback, array($url, $notice_id));
460 $start = mb_strpos($text, $url, $offset);
461 $text = mb_substr($text, 0, $start).$modified_url.mb_substr($text, $start + mb_strlen($url), mb_strlen($text));
462 $offset = $start + mb_strlen($modified_url);
468 function common_linkify($url) {
469 // It comes in special'd, so we unspecial it before passing to the stringifying
471 $url = htmlspecialchars_decode($url);
473 $canon = File_redirection::_canonUrl($url);
475 $longurl_data = File_redirection::where($url);
476 if (is_array($longurl_data)) {
477 $longurl = $longurl_data['url'];
478 } elseif (is_string($longurl_data)) {
479 $longurl = $longurl_data;
481 throw new ServerException("Can't linkify url '$url'");
484 $attrs = array('href' => $canon, 'rel' => 'external');
486 $is_attachment = false;
487 $attachment_id = null;
490 // Check to see whether there's a filename associated with this URL.
491 // If there is, it's an upload and qualifies as an attachment
493 $localfile = File::staticGet('url', $longurl);
495 if (!empty($localfile)) {
496 if (isset($localfile->filename)) {
497 $is_attachment = true;
498 $attachment_id = $localfile->id;
502 // if this URL is an attachment, then we set class='attachment' and id='attahcment-ID'
503 // where ID is the id of the attachment for the given URL.
505 // we need a better test telling what can be shown as an attachment
506 // we're currently picking up oembeds only.
507 // I think the best option is another file_view table in the db
508 // and associated dbobject.
510 $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'";
512 $file->query($query);
515 if (!empty($file->file_id)) {
516 $is_attachment = true;
517 $attachment_id = $file->file_id;
519 $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'";
521 $file2->query($query);
524 if (!empty($file2)) {
530 if ($is_attachment) {
531 $attrs['class'] = 'attachment';
533 $attrs['class'] = 'attachment thumbnail';
535 $attrs['id'] = "attachment-{$attachment_id}";
538 return XMLStringer::estring('a', $attrs, $url);
541 function common_shorten_links($text)
543 if (mb_strlen($text) <= 140) return $text;
544 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
547 function common_xml_safe_str($str)
549 // Neutralize control codes and surrogates
550 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
553 function common_tag_link($tag)
555 $canonical = common_canonical_tag($tag);
556 $url = common_local_url('tag', array('tag' => $canonical));
557 $xs = new XMLStringer();
558 $xs->elementStart('span', 'tag');
559 $xs->element('a', array('href' => $url,
562 $xs->elementEnd('span');
563 return $xs->getString();
566 function common_canonical_tag($tag)
568 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
569 return str_replace(array('-', '_', '.'), '', $tag);
572 function common_valid_profile_tag($str)
574 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
577 function common_at_link($sender_id, $nickname)
579 $sender = Profile::staticGet($sender_id);
580 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
582 $user = User::staticGet('id', $recipient->id);
584 $url = common_local_url('userbyid', array('id' => $user->id));
586 $url = $recipient->profileurl;
588 $xs = new XMLStringer(false);
589 $attrs = array('href' => $url,
591 if (!empty($recipient->fullname)) {
592 $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
594 $xs->elementStart('span', 'vcard');
595 $xs->elementStart('a', $attrs);
596 $xs->element('span', 'fn nickname', $nickname);
597 $xs->elementEnd('a');
598 $xs->elementEnd('span');
599 return $xs->getString();
605 function common_group_link($sender_id, $nickname)
607 $sender = Profile::staticGet($sender_id);
608 $group = User_group::getForNickname($nickname);
609 if ($group && $sender->isMember($group)) {
610 $attrs = array('href' => $group->permalink(),
612 if (!empty($group->fullname)) {
613 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
615 $xs = new XMLStringer();
616 $xs->elementStart('span', 'vcard');
617 $xs->elementStart('a', $attrs);
618 $xs->element('span', 'fn nickname', $nickname);
619 $xs->elementEnd('a');
620 $xs->elementEnd('span');
621 return $xs->getString();
627 function common_at_hash_link($sender_id, $tag)
629 $user = User::staticGet($sender_id);
633 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
635 $url = common_local_url('subscriptions',
636 array('nickname' => $user->nickname,
638 $xs = new XMLStringer();
639 $xs->elementStart('span', 'tag');
640 $xs->element('a', array('href' => $url,
643 $xs->elementEnd('span');
644 return $xs->getString();
650 function common_relative_profile($sender, $nickname, $dt=null)
652 // Try to find profiles this profile is subscribed to that have this nickname
653 $recipient = new Profile();
654 // XXX: use a join instead of a subquery
655 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
656 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
657 if ($recipient->find(true)) {
658 // XXX: should probably differentiate between profiles with
659 // the same name by date of most recent update
662 // Try to find profiles that listen to this profile and that have this nickname
663 $recipient = new Profile();
664 // XXX: use a join instead of a subquery
665 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = 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 // If this is a local user, try to find a local user with that nickname.
673 $sender = User::staticGet($sender->id);
675 $recipient_user = User::staticGet('nickname', $nickname);
676 if ($recipient_user) {
677 return $recipient_user->getProfile();
680 // Otherwise, no links. @messages from local users to remote users,
681 // or from remote users to other remote users, are just
682 // outside our ability to make intelligent guesses about
686 function common_local_url($action, $args=null, $params=null, $fragment=null)
688 static $sensitive = array('login', 'register', 'passwordsettings',
689 'twittersettings', 'finishopenidlogin',
690 'finishaddopenid', 'api');
693 $path = $r->build($action, $args, $params, $fragment);
695 $ssl = in_array($action, $sensitive);
697 if (common_config('site','fancy')) {
698 $url = common_path(mb_substr($path, 1), $ssl);
700 if (mb_strpos($path, '/index.php') === 0) {
701 $url = common_path(mb_substr($path, 1), $ssl);
703 $url = common_path('index.php'.$path, $ssl);
709 function common_path($relative, $ssl=false)
711 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
713 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
714 || common_config('site', 'ssl') === 'always') {
716 if (is_string(common_config('site', 'sslserver')) &&
717 mb_strlen(common_config('site', 'sslserver')) > 0) {
718 $serverpart = common_config('site', 'sslserver');
720 $serverpart = common_config('site', 'server');
724 $serverpart = common_config('site', 'server');
727 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
730 function common_date_string($dt)
732 // XXX: do some sexy date formatting
733 // return date(DATE_RFC822, $dt);
738 if ($now < $t) { // that shouldn't happen!
739 return common_exact_date($dt);
740 } else if ($diff < 60) {
741 return _('a few seconds ago');
742 } else if ($diff < 92) {
743 return _('about a minute ago');
744 } else if ($diff < 3300) {
745 return sprintf(_('about %d minutes ago'), round($diff/60));
746 } else if ($diff < 5400) {
747 return _('about an hour ago');
748 } else if ($diff < 22 * 3600) {
749 return sprintf(_('about %d hours ago'), round($diff/3600));
750 } else if ($diff < 37 * 3600) {
751 return _('about a day ago');
752 } else if ($diff < 24 * 24 * 3600) {
753 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
754 } else if ($diff < 46 * 24 * 3600) {
755 return _('about a month ago');
756 } else if ($diff < 330 * 24 * 3600) {
757 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
758 } else if ($diff < 480 * 24 * 3600) {
759 return _('about a year ago');
761 return common_exact_date($dt);
765 function common_exact_date($dt)
771 $_utc = new DateTimeZone('UTC');
772 $_siteTz = new DateTimeZone(common_timezone());
775 $dateStr = date('d F Y H:i:s', strtotime($dt));
776 $d = new DateTime($dateStr, $_utc);
777 $d->setTimezone($_siteTz);
778 return $d->format(DATE_RFC850);
781 function common_date_w3dtf($dt)
783 $dateStr = date('d F Y H:i:s', strtotime($dt));
784 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
785 $d->setTimezone(new DateTimeZone(common_timezone()));
786 return $d->format(DATE_W3C);
789 function common_date_rfc2822($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('r');
797 function common_date_iso8601($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('c');
805 function common_sql_now()
807 return common_sql_date(time());
810 function common_sql_date($datetime)
812 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
815 function common_redirect($url, $code=307)
817 static $status = array(301 => "Moved Permanently",
820 307 => "Temporary Redirect");
822 header('HTTP/1.1 '.$code.' '.$status[$code]);
823 header("Location: $url");
825 $xo = new XMLOutputter();
827 '-//W3C//DTD XHTML 1.0 Strict//EN',
828 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
829 $xo->element('a', array('href' => $url), $url);
834 function common_broadcast_notice($notice, $remote=false)
836 return common_enqueue_notice($notice);
839 // Stick the notice on the queue
841 function common_enqueue_notice($notice)
843 static $localTransports = array('omb',
847 static $allTransports = array('sms');
849 $transports = $allTransports;
851 $xmpp = common_config('xmpp', 'enabled');
854 $transports[] = 'jabber';
857 if ($notice->is_local == Notice::LOCAL_PUBLIC ||
858 $notice->is_local == Notice::LOCAL_NONPUBLIC) {
859 $transports = array_merge($transports, $localTransports);
861 $transports[] = 'public';
865 $qm = QueueManager::get();
867 foreach ($transports as $transport)
869 $qm->enqueue($notice, $transport);
875 function common_broadcast_profile($profile)
877 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
878 require_once(INSTALLDIR.'/lib/omb.php');
879 omb_broadcast_profile($profile);
880 // XXX: Other broadcasts...?
884 function common_profile_url($nickname)
886 return common_local_url('showstream', array('nickname' => $nickname));
889 // Should make up a reasonable root URL
891 function common_root_url($ssl=false)
893 return common_path('', $ssl);
896 // returns $bytes bytes of random data as a hexadecimal string
897 // "good" here is a goal and not a guarantee
899 function common_good_rand($bytes)
901 // XXX: use random.org...?
902 if (@file_exists('/dev/urandom')) {
903 return common_urandom($bytes);
904 } else { // FIXME: this is probably not good enough
905 return common_mtrand($bytes);
909 function common_urandom($bytes)
911 $h = fopen('/dev/urandom', 'rb');
913 $src = fread($h, $bytes);
916 for ($i = 0; $i < $bytes; $i++) {
917 $enc .= sprintf("%02x", (ord($src[$i])));
922 function common_mtrand($bytes)
925 for ($i = 0; $i < $bytes; $i++) {
926 $enc .= sprintf("%02x", mt_rand(0, 255));
931 function common_set_returnto($url)
933 common_ensure_session();
934 $_SESSION['returnto'] = $url;
937 function common_get_returnto()
939 common_ensure_session();
940 return $_SESSION['returnto'];
943 function common_timestamp()
945 return date('YmdHis');
948 function common_ensure_syslog()
950 static $initialized = false;
952 openlog(common_config('syslog', 'appname'), 0,
953 common_config('syslog', 'facility'));
958 function common_log_line($priority, $msg)
960 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
961 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
962 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
965 function common_log($priority, $msg, $filename=null)
967 $logfile = common_config('site', 'logfile');
969 $log = fopen($logfile, "a");
971 $output = common_log_line($priority, $msg);
972 fwrite($log, $output);
976 common_ensure_syslog();
977 syslog($priority, $msg);
981 function common_debug($msg, $filename=null)
984 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
986 common_log(LOG_DEBUG, $msg);
990 function common_log_db_error(&$object, $verb, $filename=null)
992 $objstr = common_log_objstring($object);
993 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
994 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
997 function common_log_objstring(&$object)
999 if (is_null($object)) {
1002 if (!($object instanceof DB_DataObject)) {
1005 $arr = $object->toArray();
1007 foreach ($arr as $k => $v) {
1008 $fields[] = "$k='$v'";
1010 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1014 function common_valid_http_url($url)
1016 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1019 function common_valid_tag($tag)
1021 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1022 return (Validate::email($matches[1]) ||
1023 preg_match('/^([\w-\.]+)$/', $matches[1]));
1028 /* Following functions are copied from MediaWiki GlobalFunctions.php
1029 * and written by Evan Prodromou. */
1031 function common_accept_to_prefs($accept, $def = '*/*')
1033 // No arg means accept anything (per HTTP spec)
1035 return array($def => 1);
1040 $parts = explode(',', $accept);
1042 foreach($parts as $part) {
1043 // FIXME: doesn't deal with params like 'text/html; level=1'
1044 @list($value, $qpart) = explode(';', trim($part));
1046 if(!isset($qpart)) {
1048 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1049 $prefs[$value] = $match[1];
1056 function common_mime_type_match($type, $avail)
1058 if(array_key_exists($type, $avail)) {
1061 $parts = explode('/', $type);
1062 if(array_key_exists($parts[0] . '/*', $avail)) {
1063 return $parts[0] . '/*';
1064 } elseif(array_key_exists('*/*', $avail)) {
1072 function common_negotiate_type($cprefs, $sprefs)
1076 foreach(array_keys($sprefs) as $type) {
1077 $parts = explode('/', $type);
1078 if($parts[1] != '*') {
1079 $ckey = common_mime_type_match($type, $cprefs);
1081 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1086 foreach(array_keys($cprefs) as $type) {
1087 $parts = explode('/', $type);
1088 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1089 $skey = common_mime_type_match($type, $sprefs);
1091 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1097 $besttype = 'text/html';
1099 foreach(array_keys($combine) as $type) {
1100 if($combine[$type] > $bestq) {
1102 $bestq = $combine[$type];
1106 if ('text/html' === $besttype) {
1107 return "text/html; charset=utf-8";
1112 function common_config($main, $sub)
1115 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1118 function common_copy_args($from)
1121 $strip = get_magic_quotes_gpc();
1122 foreach ($from as $k => $v) {
1123 $to[$k] = ($strip) ? stripslashes($v) : $v;
1128 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1129 // This is used before handing a request off to OAuthRequest::from_request.
1130 function common_remove_magic_from_request()
1132 if(get_magic_quotes_gpc()) {
1133 $_POST=array_map('stripslashes',$_POST);
1134 $_GET=array_map('stripslashes',$_GET);
1138 function common_user_uri(&$user)
1140 return common_local_url('userbyid', array('id' => $user->id));
1143 function common_notice_uri(&$notice)
1145 return common_local_url('shownotice',
1146 array('notice' => $notice->id));
1149 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1151 function common_confirmation_code($bits)
1153 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1154 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1155 $chars = ceil($bits/5);
1157 for ($i = 0; $i < $chars; $i++) {
1158 // XXX: convert to string and back
1159 $num = hexdec(common_good_rand(1));
1160 // XXX: randomness is too precious to throw away almost
1161 // 40% of the bits we get!
1162 $code .= $codechars[$num%32];
1167 // convert markup to HTML
1169 function common_markup_to_html($c)
1171 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1172 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1173 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1174 return Markdown($c);
1177 function common_profile_uri($profile)
1182 $user = User::staticGet($profile->id);
1187 $remote = Remote_profile::staticGet($profile->id);
1189 return $remote->uri;
1191 // XXX: this is a very bad profile!
1195 function common_canonical_sms($sms)
1198 preg_replace('/\D/', '', $sms);
1202 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1207 case E_COMPILE_ERROR:
1211 case E_RECOVERABLE_ERROR:
1212 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1217 case E_COMPILE_WARNING:
1218 case E_CORE_WARNING:
1219 case E_USER_WARNING:
1220 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1225 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1230 case E_USER_DEPRECATED:
1231 // XXX: config variable to log this stuff, too
1235 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1240 // FIXME: show error page if we're on the Web
1241 /* Don't execute PHP internal error handler */
1245 function common_session_token()
1247 common_ensure_session();
1248 if (!array_key_exists('token', $_SESSION)) {
1249 $_SESSION['token'] = common_good_rand(64);
1251 return $_SESSION['token'];
1254 function common_cache_key($extra)
1256 $base_key = common_config('memcached', 'base');
1258 if (empty($base_key)) {
1259 $base_key = common_keyize(common_config('site', 'name'));
1262 return 'laconica:' . $base_key . ':' . $extra;
1265 function common_keyize($str)
1267 $str = strtolower($str);
1268 $str = preg_replace('/\s/', '_', $str);
1272 function common_memcache()
1274 static $cache = null;
1275 if (!common_config('memcached', 'enabled')) {
1279 $cache = new Memcache();
1280 $servers = common_config('memcached', 'server');
1281 if (is_array($servers)) {
1282 foreach($servers as $server) {
1283 $cache->addServer($server);
1286 $cache->addServer($servers);
1293 function common_compatible_license($from, $to)
1295 // XXX: better compatibility check needed here!
1296 return ($from == $to);
1300 * returns a quoted table name, if required according to config
1302 function common_database_tablename($tablename)
1305 if(common_config('db','quote_identifiers')) {
1306 $tablename = '"'. $tablename .'"';
1308 //table prefixes could be added here later
1312 function common_shorten_url($long_url)
1314 $user = common_current_user();
1316 // common current user does not find a user when called from the XMPP daemon
1317 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1320 $svc = $user->urlshorteningservice;
1323 $curlh = curl_init();
1324 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1325 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
1326 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1330 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1331 $short_url_service = new LilUrl;
1332 $short_url = $short_url_service->shorten($long_url);
1336 $short_url_service = new TightUrl;
1337 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1338 $short_url = $short_url_service->shorten($long_url);
1342 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1343 $short_url_service = new PtitUrl;
1344 $short_url = $short_url_service->shorten($long_url);
1348 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1349 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1353 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1354 $short_url = curl_exec($curlh);
1357 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1358 $short_url = curl_exec($curlh);
1360 case 'metamark.net':
1361 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1362 $short_url = curl_exec($curlh);
1365 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1366 $short_url = curl_exec($curlh);
1377 function common_client_ip()
1379 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1383 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1384 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1385 $proxy = $_SERVER['HTTP_CLIENT_IP'];
1387 $proxy = $_SERVER['REMOTE_ADDR'];
1389 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1392 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1393 $ip = $_SERVER['HTTP_CLIENT_IP'];
1395 $ip = $_SERVER['REMOTE_ADDR'];
1399 return array($proxy, $ip);