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):'.
424 '(?:museum|travel|[a-z]{2,4})'.
428 preg_match_all($regex, $text, $matches);
430 // Then clean up what the regex left behind
432 foreach($matches[0] as $orig_url) {
433 $url = htmlspecialchars_decode($orig_url);
435 // Make sure we didn't pick up an email address
436 if (preg_match('#^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$#i', $url)) continue;
438 // Remove surrounding punctuation
439 $url = trim($url, '.?!,;:\'"`([<');
441 // Remove surrounding parens and the like
442 preg_match('/[)\]>]+$/', $url, $trailing);
443 if (isset($trailing[0])) {
444 preg_match_all('/[(\[<]/', $url, $opened);
445 preg_match_all('/[)\]>]/', $url, $closed);
446 $unopened = count($closed[0]) - count($opened[0]);
448 // Make sure not to take off more closing parens than there are at the end
449 $unopened = ($unopened > mb_strlen($trailing[0])) ? mb_strlen($trailing[0]):$unopened;
451 $url = ($unopened > 0) ? mb_substr($url, 0, $unopened * -1):$url;
454 // Remove trailing punctuation again (in case there were some inside parens)
455 $url = rtrim($url, '.?!,;:\'"`');
457 // Make sure we didn't capture part of the next sentence
458 preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
460 // Were the parts capitalized any?
461 $last_part = (mb_strtolower($url_parts[2]) !== $url_parts[2]) ? true:false;
462 $prev_part = (mb_strtolower($url_parts[1]) !== $url_parts[1]) ? true:false;
464 // If the first part wasn't cap'd but the last part was, we captured too much
465 if ((!$prev_part && $last_part)) {
466 $url = mb_substr($url, 0 , mb_strpos($url, '.'.$url_parts['2'], 0));
469 // Capture the new TLD
470 preg_match('#((?:[^.\s/]+\.)+)(museum|travel|[a-z]{2,4})#i', $url, $url_parts);
472 $tlds = array('ac', 'ad', 'ae', 'aero', 'af', 'ag', 'ai', 'al', 'am', 'an', 'ao', 'aq', 'ar', 'arpa', 'as', 'asia', 'at', 'au', 'aw', 'ax', 'az', 'ba', 'bb', 'bd', 'be', 'bf', 'bg', 'bh', 'bi', 'biz', 'bj', 'bm', 'bn', 'bo', 'br', 'bs', 'bt', 'bv', 'bw', 'by', 'bz', 'ca', 'cat', 'cc', 'cd', 'cf', 'cg', 'ch', 'ci', 'ck', 'cl', 'cm', 'cn', 'co', 'com', 'coop', 'cr', 'cu', 'cv', 'cx', 'cy', 'cz', 'de', 'dj', 'dk', 'dm', 'do', 'dz', 'ec', 'edu', 'ee', 'eg', 'er', 'es', 'et', 'eu', 'fi', 'fj', 'fk', 'fm', 'fo', 'fr', 'ga', 'gb', 'gd', 'ge', 'gf', 'gg', 'gh', 'gi', 'gl', 'gm', 'gn', 'gov', 'gp', 'gq', 'gr', 'gs', 'gt', 'gu', 'gw', 'gy', 'hk', 'hm', 'hn', 'hr', 'ht', 'hu', 'id', 'ie', 'il', 'im', 'in', 'info', 'int', 'io', 'iq', 'ir', 'is', 'it', 'je', 'jm', 'jo', 'jobs', 'jp', 'ke', 'kg', 'kh', 'ki', 'km', 'kn', 'kp', 'kr', 'kw', 'ky', 'kz', 'la', 'lb', 'lc', 'li', 'lk', 'lr', 'ls', 'lt', 'lu', 'lv', 'ly', 'ma', 'mc', 'md', 'me', 'mg', 'mh', 'mil', 'mk', 'ml', 'mm', 'mn', 'mo', 'mobi', 'mp', 'mq', 'mr', 'ms', 'mt', 'mu', 'museum', 'mv', 'mw', 'mx', 'my', 'mz', 'na', 'name', 'nc', 'ne', 'net', 'nf', 'ng', 'ni', 'nl', 'no', 'np', 'nr', 'nu', 'nz', 'om', 'org', 'pa', 'pe', 'pf', 'pg', 'ph', 'pk', 'pl', 'pm', 'pn', 'pr', 'pro', 'ps', 'pt', 'pw', 'py', 'qa', 're', 'ro', 'rs', 'ru', 'rw', 'sa', 'sb', 'sc', 'sd', 'se', 'sg', 'sh', 'si', 'sj', 'sk', 'sl', 'sm', 'sn', 'so', 'sr', 'st', 'su', 'sv', 'sy', 'sz', 'tc', 'td', 'tel', 'tf', 'tg', 'th', 'tj', 'tk', 'tl', 'tm', 'tn', 'to', 'tp', 'tr', 'travel', 'tt', 'tv', 'tw', 'tz', 'ua', 'ug', 'uk', 'us', 'uy', 'uz', 'va', 'vc', 've', 'vg', 'vi', 'vn', 'vu', 'wf', 'ws', 'ye', 'yt', 'yu', 'za', 'zm', 'zw');
474 if (!in_array($url_parts[2], $tlds)) continue;
476 // Make sure we didn't capture a hash tag
477 if (strpos($url, '#') === 0) continue;
479 // Put the url back the way we found it.
480 $url = (mb_strpos($orig_url, htmlspecialchars($url)) === FALSE) ? $url:htmlspecialchars($url);
482 // Call user specified func
483 if (empty($notice_id)) {
484 $modified_url = call_user_func($callback, $url);
486 $modified_url = call_user_func($callback, array($url, $notice_id));
490 $start = mb_strpos($text, $url, $offset);
491 $text = mb_substr($text, 0, $start).$modified_url.mb_substr($text, $start + mb_strlen($url), mb_strlen($text));
492 $offset = $start + mb_strlen($modified_url);
498 function common_linkify($url) {
499 // It comes in special'd, so we unspecial it before passing to the stringifying
501 $url = htmlspecialchars_decode($url);
503 $canon = File_redirection::_canonUrl($url);
505 $longurl_data = File_redirection::where($url);
506 if (is_array($longurl_data)) {
507 $longurl = $longurl_data['url'];
508 } elseif (is_string($longurl_data)) {
509 $longurl = $longurl_data;
511 throw new ServerException("Can't linkify url '$url'");
514 $attrs = array('href' => $canon, 'rel' => 'external');
516 $is_attachment = false;
517 $attachment_id = null;
520 // Check to see whether there's a filename associated with this URL.
521 // If there is, it's an upload and qualifies as an attachment
523 $localfile = File::staticGet('url', $longurl);
525 if (!empty($localfile)) {
526 if (isset($localfile->filename)) {
527 $is_attachment = true;
528 $attachment_id = $localfile->id;
532 // if this URL is an attachment, then we set class='attachment' and id='attahcment-ID'
533 // where ID is the id of the attachment for the given URL.
535 // we need a better test telling what can be shown as an attachment
536 // we're currently picking up oembeds only.
537 // I think the best option is another file_view table in the db
538 // and associated dbobject.
540 $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'";
542 $file->query($query);
545 if (!empty($file->file_id)) {
546 $is_attachment = true;
547 $attachment_id = $file->file_id;
549 $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'";
551 $file2->query($query);
554 if (!empty($file2)) {
560 if ($is_attachment) {
561 $attrs['class'] = 'attachment';
563 $attrs['class'] = 'attachment thumbnail';
565 $attrs['id'] = "attachment-{$attachment_id}";
568 return XMLStringer::estring('a', $attrs, $url);
571 function common_shorten_links($text)
573 if (mb_strlen($text) <= 140) return $text;
574 return common_replace_urls_callback($text, array('File_redirection', 'makeShort'));
577 function common_xml_safe_str($str)
579 // Neutralize control codes and surrogates
580 return preg_replace('/[\p{Cc}\p{Cs}]/u', '*', $str);
583 function common_tag_link($tag)
585 $canonical = common_canonical_tag($tag);
586 $url = common_local_url('tag', array('tag' => $canonical));
587 $xs = new XMLStringer();
588 $xs->elementStart('span', 'tag');
589 $xs->element('a', array('href' => $url,
592 $xs->elementEnd('span');
593 return $xs->getString();
596 function common_canonical_tag($tag)
598 $tag = mb_convert_case($tag, MB_CASE_LOWER, "UTF-8");
599 return str_replace(array('-', '_', '.'), '', $tag);
602 function common_valid_profile_tag($str)
604 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
607 function common_at_link($sender_id, $nickname)
609 $sender = Profile::staticGet($sender_id);
610 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
612 $user = User::staticGet('id', $recipient->id);
614 $url = common_local_url('userbyid', array('id' => $user->id));
616 $url = $recipient->profileurl;
618 $xs = new XMLStringer(false);
619 $attrs = array('href' => $url,
621 if (!empty($recipient->fullname)) {
622 $attrs['title'] = $recipient->fullname . ' (' . $recipient->nickname . ')';
624 $xs->elementStart('span', 'vcard');
625 $xs->elementStart('a', $attrs);
626 $xs->element('span', 'fn nickname', $nickname);
627 $xs->elementEnd('a');
628 $xs->elementEnd('span');
629 return $xs->getString();
635 function common_group_link($sender_id, $nickname)
637 $sender = Profile::staticGet($sender_id);
638 $group = User_group::getForNickname($nickname);
639 if ($group && $sender->isMember($group)) {
640 $attrs = array('href' => $group->permalink(),
642 if (!empty($group->fullname)) {
643 $attrs['title'] = $group->fullname . ' (' . $group->nickname . ')';
645 $xs = new XMLStringer();
646 $xs->elementStart('span', 'vcard');
647 $xs->elementStart('a', $attrs);
648 $xs->element('span', 'fn nickname', $nickname);
649 $xs->elementEnd('a');
650 $xs->elementEnd('span');
651 return $xs->getString();
657 function common_at_hash_link($sender_id, $tag)
659 $user = User::staticGet($sender_id);
663 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
665 $url = common_local_url('subscriptions',
666 array('nickname' => $user->nickname,
668 $xs = new XMLStringer();
669 $xs->elementStart('span', 'tag');
670 $xs->element('a', array('href' => $url,
673 $xs->elementEnd('span');
674 return $xs->getString();
680 function common_relative_profile($sender, $nickname, $dt=null)
682 // Try to find profiles this profile is subscribed to that have this nickname
683 $recipient = new Profile();
684 // XXX: use a join instead of a subquery
685 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
686 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
687 if ($recipient->find(true)) {
688 // XXX: should probably differentiate between profiles with
689 // the same name by date of most recent update
692 // Try to find profiles that listen to this profile and that have this nickname
693 $recipient = new Profile();
694 // XXX: use a join instead of a subquery
695 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
696 $recipient->whereAdd("nickname = '" . trim($nickname) . "'", 'AND');
697 if ($recipient->find(true)) {
698 // XXX: should probably differentiate between profiles with
699 // the same name by date of most recent update
702 // If this is a local user, try to find a local user with that nickname.
703 $sender = User::staticGet($sender->id);
705 $recipient_user = User::staticGet('nickname', $nickname);
706 if ($recipient_user) {
707 return $recipient_user->getProfile();
710 // Otherwise, no links. @messages from local users to remote users,
711 // or from remote users to other remote users, are just
712 // outside our ability to make intelligent guesses about
716 function common_local_url($action, $args=null, $params=null, $fragment=null)
719 $path = $r->build($action, $args, $params, $fragment);
721 $ssl = common_is_sensitive($action);
723 if (common_config('site','fancy')) {
724 $url = common_path(mb_substr($path, 1), $ssl);
726 if (mb_strpos($path, '/index.php') === 0) {
727 $url = common_path(mb_substr($path, 1), $ssl);
729 $url = common_path('index.php'.$path, $ssl);
735 function common_is_sensitive($action)
737 static $sensitive = array('login', 'register', 'passwordsettings',
738 'twittersettings', 'finishopenidlogin',
739 'finishaddopenid', 'api');
742 if (Event::handle('SensitiveAction', array($action, &$ssl))) {
743 $ssl = in_array($action, $sensitive);
749 function common_path($relative, $ssl=false)
751 $pathpart = (common_config('site', 'path')) ? common_config('site', 'path')."/" : '';
753 if (($ssl && (common_config('site', 'ssl') === 'sometimes'))
754 || common_config('site', 'ssl') === 'always') {
756 if (is_string(common_config('site', 'sslserver')) &&
757 mb_strlen(common_config('site', 'sslserver')) > 0) {
758 $serverpart = common_config('site', 'sslserver');
760 $serverpart = common_config('site', 'server');
764 $serverpart = common_config('site', 'server');
767 return $proto.'://'.$serverpart.'/'.$pathpart.$relative;
770 function common_date_string($dt)
772 // XXX: do some sexy date formatting
773 // return date(DATE_RFC822, $dt);
778 if ($now < $t) { // that shouldn't happen!
779 return common_exact_date($dt);
780 } else if ($diff < 60) {
781 return _('a few seconds ago');
782 } else if ($diff < 92) {
783 return _('about a minute ago');
784 } else if ($diff < 3300) {
785 return sprintf(_('about %d minutes ago'), round($diff/60));
786 } else if ($diff < 5400) {
787 return _('about an hour ago');
788 } else if ($diff < 22 * 3600) {
789 return sprintf(_('about %d hours ago'), round($diff/3600));
790 } else if ($diff < 37 * 3600) {
791 return _('about a day ago');
792 } else if ($diff < 24 * 24 * 3600) {
793 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
794 } else if ($diff < 46 * 24 * 3600) {
795 return _('about a month ago');
796 } else if ($diff < 330 * 24 * 3600) {
797 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
798 } else if ($diff < 480 * 24 * 3600) {
799 return _('about a year ago');
801 return common_exact_date($dt);
805 function common_exact_date($dt)
811 $_utc = new DateTimeZone('UTC');
812 $_siteTz = new DateTimeZone(common_timezone());
815 $dateStr = date('d F Y H:i:s', strtotime($dt));
816 $d = new DateTime($dateStr, $_utc);
817 $d->setTimezone($_siteTz);
818 return $d->format(DATE_RFC850);
821 function common_date_w3dtf($dt)
823 $dateStr = date('d F Y H:i:s', strtotime($dt));
824 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
825 $d->setTimezone(new DateTimeZone(common_timezone()));
826 return $d->format(DATE_W3C);
829 function common_date_rfc2822($dt)
831 $dateStr = date('d F Y H:i:s', strtotime($dt));
832 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
833 $d->setTimezone(new DateTimeZone(common_timezone()));
834 return $d->format('r');
837 function common_date_iso8601($dt)
839 $dateStr = date('d F Y H:i:s', strtotime($dt));
840 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
841 $d->setTimezone(new DateTimeZone(common_timezone()));
842 return $d->format('c');
845 function common_sql_now()
847 return common_sql_date(time());
850 function common_sql_date($datetime)
852 return strftime('%Y-%m-%d %H:%M:%S', $datetime);
855 function common_redirect($url, $code=307)
857 static $status = array(301 => "Moved Permanently",
860 307 => "Temporary Redirect");
862 header('HTTP/1.1 '.$code.' '.$status[$code]);
863 header("Location: $url");
865 $xo = new XMLOutputter();
867 '-//W3C//DTD XHTML 1.0 Strict//EN',
868 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
869 $xo->element('a', array('href' => $url), $url);
874 function common_broadcast_notice($notice, $remote=false)
876 return common_enqueue_notice($notice);
879 // Stick the notice on the queue
881 function common_enqueue_notice($notice)
883 static $localTransports = array('omb',
887 static $allTransports = array('sms');
889 $transports = $allTransports;
891 $xmpp = common_config('xmpp', 'enabled');
894 $transports[] = 'jabber';
897 if ($notice->is_local == NOTICE_LOCAL_PUBLIC ||
898 $notice->is_local == NOTICE_LOCAL_NONPUBLIC) {
899 $transports = array_merge($transports, $localTransports);
901 $transports[] = 'public';
905 $qm = QueueManager::get();
907 foreach ($transports as $transport)
909 $qm->enqueue($notice, $transport);
915 function common_broadcast_profile($profile)
917 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
918 require_once(INSTALLDIR.'/lib/omb.php');
919 omb_broadcast_profile($profile);
920 // XXX: Other broadcasts...?
924 function common_profile_url($nickname)
926 return common_local_url('showstream', array('nickname' => $nickname));
929 // Should make up a reasonable root URL
931 function common_root_url($ssl=false)
933 return common_path('', $ssl);
936 // returns $bytes bytes of random data as a hexadecimal string
937 // "good" here is a goal and not a guarantee
939 function common_good_rand($bytes)
941 // XXX: use random.org...?
942 if (@file_exists('/dev/urandom')) {
943 return common_urandom($bytes);
944 } else { // FIXME: this is probably not good enough
945 return common_mtrand($bytes);
949 function common_urandom($bytes)
951 $h = fopen('/dev/urandom', 'rb');
953 $src = fread($h, $bytes);
956 for ($i = 0; $i < $bytes; $i++) {
957 $enc .= sprintf("%02x", (ord($src[$i])));
962 function common_mtrand($bytes)
965 for ($i = 0; $i < $bytes; $i++) {
966 $enc .= sprintf("%02x", mt_rand(0, 255));
971 function common_set_returnto($url)
973 common_ensure_session();
974 $_SESSION['returnto'] = $url;
977 function common_get_returnto()
979 common_ensure_session();
980 return $_SESSION['returnto'];
983 function common_timestamp()
985 return date('YmdHis');
988 function common_ensure_syslog()
990 static $initialized = false;
992 openlog(common_config('syslog', 'appname'), 0,
993 common_config('syslog', 'facility'));
998 function common_log_line($priority, $msg)
1000 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1001 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1002 return date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1005 function common_log($priority, $msg, $filename=null)
1007 $logfile = common_config('site', 'logfile');
1009 $log = fopen($logfile, "a");
1011 $output = common_log_line($priority, $msg);
1012 fwrite($log, $output);
1016 common_ensure_syslog();
1017 syslog($priority, $msg);
1021 function common_debug($msg, $filename=null)
1024 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1026 common_log(LOG_DEBUG, $msg);
1030 function common_log_db_error(&$object, $verb, $filename=null)
1032 $objstr = common_log_objstring($object);
1033 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1034 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1037 function common_log_objstring(&$object)
1039 if (is_null($object)) {
1042 if (!($object instanceof DB_DataObject)) {
1045 $arr = $object->toArray();
1047 foreach ($arr as $k => $v) {
1048 $fields[] = "$k='$v'";
1050 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1054 function common_valid_http_url($url)
1056 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1059 function common_valid_tag($tag)
1061 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1062 return (Validate::email($matches[1]) ||
1063 preg_match('/^([\w-\.]+)$/', $matches[1]));
1068 /* Following functions are copied from MediaWiki GlobalFunctions.php
1069 * and written by Evan Prodromou. */
1071 function common_accept_to_prefs($accept, $def = '*/*')
1073 // No arg means accept anything (per HTTP spec)
1075 return array($def => 1);
1080 $parts = explode(',', $accept);
1082 foreach($parts as $part) {
1083 // FIXME: doesn't deal with params like 'text/html; level=1'
1084 @list($value, $qpart) = explode(';', trim($part));
1086 if(!isset($qpart)) {
1088 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1089 $prefs[$value] = $match[1];
1096 function common_mime_type_match($type, $avail)
1098 if(array_key_exists($type, $avail)) {
1101 $parts = explode('/', $type);
1102 if(array_key_exists($parts[0] . '/*', $avail)) {
1103 return $parts[0] . '/*';
1104 } elseif(array_key_exists('*/*', $avail)) {
1112 function common_negotiate_type($cprefs, $sprefs)
1116 foreach(array_keys($sprefs) as $type) {
1117 $parts = explode('/', $type);
1118 if($parts[1] != '*') {
1119 $ckey = common_mime_type_match($type, $cprefs);
1121 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1126 foreach(array_keys($cprefs) as $type) {
1127 $parts = explode('/', $type);
1128 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1129 $skey = common_mime_type_match($type, $sprefs);
1131 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1137 $besttype = 'text/html';
1139 foreach(array_keys($combine) as $type) {
1140 if($combine[$type] > $bestq) {
1142 $bestq = $combine[$type];
1146 if ('text/html' === $besttype) {
1147 return "text/html; charset=utf-8";
1152 function common_config($main, $sub)
1155 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1158 function common_copy_args($from)
1161 $strip = get_magic_quotes_gpc();
1162 foreach ($from as $k => $v) {
1163 $to[$k] = ($strip) ? stripslashes($v) : $v;
1168 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1169 // This is used before handing a request off to OAuthRequest::from_request.
1170 function common_remove_magic_from_request()
1172 if(get_magic_quotes_gpc()) {
1173 $_POST=array_map('stripslashes',$_POST);
1174 $_GET=array_map('stripslashes',$_GET);
1178 function common_user_uri(&$user)
1180 return common_local_url('userbyid', array('id' => $user->id));
1183 function common_notice_uri(&$notice)
1185 return common_local_url('shownotice',
1186 array('notice' => $notice->id));
1189 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1191 function common_confirmation_code($bits)
1193 // 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1194 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1195 $chars = ceil($bits/5);
1197 for ($i = 0; $i < $chars; $i++) {
1198 // XXX: convert to string and back
1199 $num = hexdec(common_good_rand(1));
1200 // XXX: randomness is too precious to throw away almost
1201 // 40% of the bits we get!
1202 $code .= $codechars[$num%32];
1207 // convert markup to HTML
1209 function common_markup_to_html($c)
1211 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1212 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1213 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1214 return Markdown($c);
1217 function common_profile_uri($profile)
1222 $user = User::staticGet($profile->id);
1227 $remote = Remote_profile::staticGet($profile->id);
1229 return $remote->uri;
1231 // XXX: this is a very bad profile!
1235 function common_canonical_sms($sms)
1238 preg_replace('/\D/', '', $sms);
1242 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext)
1247 case E_COMPILE_ERROR:
1251 case E_RECOVERABLE_ERROR:
1252 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [ABORT]");
1257 case E_COMPILE_WARNING:
1258 case E_CORE_WARNING:
1259 case E_USER_WARNING:
1260 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1265 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1270 case E_USER_DEPRECATED:
1271 // XXX: config variable to log this stuff, too
1275 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline) [UNKNOWN LEVEL, die()'ing]");
1280 // FIXME: show error page if we're on the Web
1281 /* Don't execute PHP internal error handler */
1285 function common_session_token()
1287 common_ensure_session();
1288 if (!array_key_exists('token', $_SESSION)) {
1289 $_SESSION['token'] = common_good_rand(64);
1291 return $_SESSION['token'];
1294 function common_cache_key($extra)
1296 $base_key = common_config('memcached', 'base');
1298 if (empty($base_key)) {
1299 $base_key = common_keyize(common_config('site', 'name'));
1302 return 'laconica:' . $base_key . ':' . $extra;
1305 function common_keyize($str)
1307 $str = strtolower($str);
1308 $str = preg_replace('/\s/', '_', $str);
1312 function common_memcache()
1314 static $cache = null;
1315 if (!common_config('memcached', 'enabled')) {
1319 $cache = new Memcache();
1320 $servers = common_config('memcached', 'server');
1321 if (is_array($servers)) {
1322 foreach($servers as $server) {
1323 $cache->addServer($server);
1326 $cache->addServer($servers);
1333 function common_compatible_license($from, $to)
1335 // XXX: better compatibility check needed here!
1336 return ($from == $to);
1340 * returns a quoted table name, if required according to config
1342 function common_database_tablename($tablename)
1345 if(common_config('db','quote_identifiers')) {
1346 $tablename = '"'. $tablename .'"';
1348 //table prefixes could be added here later
1352 function common_shorten_url($long_url)
1354 $user = common_current_user();
1356 // common current user does not find a user when called from the XMPP daemon
1357 // therefore we'll set one here fix, so that XMPP given URLs may be shortened
1360 $svc = $user->urlshorteningservice;
1363 $curlh = curl_init();
1364 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
1365 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
1366 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
1370 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1371 $short_url_service = new LilUrl;
1372 $short_url = $short_url_service->shorten($long_url);
1376 $short_url_service = new TightUrl;
1377 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1378 $short_url = $short_url_service->shorten($long_url);
1382 require_once INSTALLDIR.'/lib/Shorturl_api.php';
1383 $short_url_service = new PtitUrl;
1384 $short_url = $short_url_service->shorten($long_url);
1388 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
1389 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
1393 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
1394 $short_url = curl_exec($curlh);
1397 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
1398 $short_url = curl_exec($curlh);
1400 case 'metamark.net':
1401 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
1402 $short_url = curl_exec($curlh);
1405 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
1406 $short_url = curl_exec($curlh);
1417 function common_client_ip()
1419 if (!isset($_SERVER) || !array_key_exists('REQUEST_METHOD', $_SERVER)) {
1423 if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)) {
1424 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1425 $proxy = $_SERVER['HTTP_CLIENT_IP'];
1427 $proxy = $_SERVER['REMOTE_ADDR'];
1429 $ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
1432 if (array_key_exists('HTTP_CLIENT_IP', $_SERVER)) {
1433 $ip = $_SERVER['HTTP_CLIENT_IP'];
1435 $ip = $_SERVER['REMOTE_ADDR'];
1439 return array($proxy, $ip);