3 * Laconica - a distributed open-source microblogging tool
4 * Copyright (C) 2008, Controlez-Vous, 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, HTML, user, files) */
24 function common_server_error($msg, $code=500) {
25 static $status = array(500 => 'Internal Server Error',
26 501 => 'Not Implemented',
28 503 => 'Service Unavailable',
29 504 => 'Gateway Timeout',
30 505 => 'HTTP Version Not Supported');
32 if (!array_key_exists($code, $status)) {
36 $status_string = $status[$code];
38 header('HTTP/1.1 '.$code.' '.$status_string);
39 header('Content-type: text/plain');
47 function common_user_error($msg, $code=400) {
48 static $status = array(400 => 'Bad Request',
49 401 => 'Unauthorized',
50 402 => 'Payment Required',
53 405 => 'Method Not Allowed',
54 406 => 'Not Acceptable',
55 407 => 'Proxy Authentication Required',
56 408 => 'Request Timeout',
59 411 => 'Length Required',
60 412 => 'Precondition Failed',
61 413 => 'Request Entity Too Large',
62 414 => 'Request-URI Too Long',
63 415 => 'Unsupported Media Type',
64 416 => 'Requested Range Not Satisfiable',
65 417 => 'Expectation Failed');
67 if (!array_key_exists($code, $status)) {
71 $status_string = $status[$code];
73 header('HTTP/1.1 '.$code.' '.$status_string);
75 common_show_header('Error');
76 common_element('div', array('class' => 'error'), $msg);
82 # Start an HTML element
83 function common_element_start($tag, $attrs=NULL) {
85 $xw->startElement($tag);
86 if (is_array($attrs)) {
87 foreach ($attrs as $name => $value) {
88 $xw->writeAttribute($name, $value);
90 } else if (is_string($attrs)) {
91 $xw->writeAttribute('class', $attrs);
95 function common_element_end($tag) {
96 static $empty_tag = array('base', 'meta', 'link', 'hr',
97 'br', 'param', 'img', 'area',
100 # XXX: check namespace
101 if (in_array($tag, $empty_tag)) {
104 $xw->fullEndElement();
108 function common_element($tag, $attrs=NULL, $content=NULL) {
109 common_element_start($tag, $attrs);
111 if (!is_null($content)) {
114 common_element_end($tag);
117 function common_start_xml($doc=NULL, $public=NULL, $system=NULL, $indent=true) {
119 $xw = new XMLWriter();
120 $xw->openURI('php://output');
121 $xw->setIndent($indent);
122 $xw->startDocument('1.0', 'UTF-8');
124 $xw->writeDTD($doc, $public, $system);
128 function common_end_xml() {
134 function common_init_locale($language=null) {
136 $language = common_language();
138 putenv('LANGUAGE='.$language);
139 putenv('LANG='.$language);
140 return setlocale(LC_ALL, $language . ".utf8",
142 $language . ".utf-8",
143 $language . ".UTF-8",
147 function common_init_language() {
148 mb_internal_encoding('UTF-8');
149 $language = common_language();
150 # So we don't have to make people install the gettext locales
151 $locale_set = common_init_locale($language);
152 bindtextdomain("laconica", common_config('site','locale_path'));
153 bind_textdomain_codeset("laconica", "UTF-8");
154 textdomain("laconica");
155 setlocale(LC_CTYPE, 'C');
157 common_log(LOG_INFO,'Language requested:'.$language.' - locale could not be set:',__FILE__);
161 define('PAGE_TYPE_PREFS', 'text/html,application/xhtml+xml,application/xml;q=0.3,text/xml;q=0.2');
163 function common_show_header($pagetitle, $callable=NULL, $data=NULL, $headercall=NULL) {
169 common_element_start('head');
170 common_element('title', NULL,
171 $pagetitle . " - " . $config['site']['name']);
172 common_element('link', array('rel' => 'stylesheet',
173 'type' => 'text/css',
174 'href' => theme_path('display.css') . '?version=' . LACONICA_VERSION,
175 'media' => 'screen, projection, tv'));
176 foreach (array(6,7) as $ver) {
177 if (file_exists(theme_file('ie'.$ver.'.css'))) {
178 # Yes, IE people should be put in jail.
179 $xw->writeComment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
180 'href="'.theme_path('ie'.$ver.'.css').'?version='.LACONICA_VERSION.'" /><![endif]');
184 common_element('script', array('type' => 'text/javascript',
185 'src' => common_path('js/jquery.min.js')),
187 common_element('script', array('type' => 'text/javascript',
188 'src' => common_path('js/jquery.form.js')),
190 common_element('script', array('type' => 'text/javascript',
191 'src' => common_path('js/xbImportNode.js')),
193 common_element('script', array('type' => 'text/javascript',
194 'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
196 common_element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
197 'href' => common_local_url('opensearch', array('type' => 'people')),
198 'title' => common_config('site', 'name').' People Search'));
200 common_element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
201 'href' => common_local_url('opensearch', array('type' => 'notice')),
202 'title' => common_config('site', 'name').' Notice Search'));
206 call_user_func($callable, $data);
208 call_user_func($callable);
211 common_element_end('head');
212 common_element_start('body');
213 common_element_start('div', array('id' => 'wrap'));
214 common_element_start('div', array('id' => 'header'));
216 if ((isset($config['site']['logo']) && is_string($config['site']['logo']) && (strlen($config['site']['logo']) > 0))
217 || file_exists(theme_file('logo.png')))
219 common_element_start('a', array('href' => common_local_url('public')));
220 common_element('img', array('src' => isset($config['site']['logo']) ?
221 ($config['site']['logo']) : theme_path('logo.png'),
222 'alt' => $config['site']['name'],
224 common_element_end('a');
226 common_element_start('p', array('id' => 'branding'));
227 common_element('a', array('href' => common_local_url('public')),
228 $config['site']['name']);
229 common_element_end('p');
232 common_element('h1', 'pagetitle', $pagetitle);
236 call_user_func($headercall, $data);
238 call_user_func($headercall);
241 common_element_end('div');
242 common_element_start('div', array('id' => 'content'));
245 function common_start_html($type=NULL, $indent=true) {
248 $httpaccept = isset($_SERVER['HTTP_ACCEPT']) ? $_SERVER['HTTP_ACCEPT'] : NULL;
250 # XXX: allow content negotiation for RDF, RSS, or XRDS
252 $type = common_negotiate_type(common_accept_to_prefs($httpaccept),
253 common_accept_to_prefs(PAGE_TYPE_PREFS));
256 common_user_error(_('This page is not available in a media type you accept'), 406);
261 header('Content-Type: '.$type);
263 common_start_xml('html',
264 '-//W3C//DTD XHTML 1.0 Strict//EN',
265 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd', $indent);
267 # FIXME: correct language for interface
269 $language = common_language();
271 common_element_start('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
272 'xml:lang' => $language,
273 'lang' => $language));
276 function common_show_footer() {
278 common_element_end('div'); # content div
280 common_element_start('div', array('id' => 'footer'));
281 common_element_start('div', 'laconica');
282 if (common_config('site', 'broughtby')) {
283 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
285 $instr = _('**%%site.name%%** is a microblogging service. ');
287 $instr .= sprintf(_('It runs the [Laconica](http://laconi.ca/) microblogging software, version %s, available under the [GNU Affero General Public License](http://www.fsf.org/licensing/licenses/agpl-3.0.html).'), LACONICA_VERSION);
288 $output = common_markup_to_html($instr);
290 common_element_end('div');
291 common_element('img', array('id' => 'cc',
292 'src' => $config['license']['image'],
293 'alt' => $config['license']['title']));
294 common_element_start('p');
295 common_text(_('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
296 common_element('a', array('class' => 'license',
298 'href' => $config['license']['url']),
299 $config['license']['title']);
300 common_text(_('. Contributors should be attributed by full name or nickname.'));
301 common_element_end('p');
302 common_element_end('div');
303 common_element_end('div');
304 common_element_end('body');
305 common_element_end('html');
309 function common_text($txt) {
314 function common_raw($xml) {
319 function common_nav_menu() {
320 $user = common_current_user();
321 common_element_start('ul', array('id' => 'nav'));
323 common_menu_item(common_local_url('all', array('nickname' => $user->nickname)),
326 common_menu_item(common_local_url('peoplesearch'), _('Search'));
328 common_menu_item(common_local_url('profilesettings'),
330 common_menu_item(common_local_url('invite'),
332 common_menu_item(common_local_url('logout'),
335 common_menu_item(common_local_url('login'), _('Login'));
336 if (!common_config('site', 'closed')) {
337 common_menu_item(common_local_url('register'), _('Register'));
339 common_menu_item(common_local_url('openidlogin'), _('OpenID'));
341 common_menu_item(common_local_url('doc', array('title' => 'help')),
343 common_element_end('ul');
346 function common_foot_menu() {
347 common_element_start('ul', array('id' => 'nav_sub'));
348 common_menu_item(common_local_url('doc', array('title' => 'help')),
350 common_menu_item(common_local_url('doc', array('title' => 'about')),
352 common_menu_item(common_local_url('doc', array('title' => 'faq')),
354 common_menu_item(common_local_url('doc', array('title' => 'privacy')),
356 common_menu_item(common_local_url('doc', array('title' => 'source')),
358 common_menu_item(common_local_url('doc', array('title' => 'contact')),
360 common_element_end('ul');
363 function common_menu_item($url, $text, $title=NULL, $is_selected=false) {
366 $lattrs['class'] = 'current';
368 common_element_start('li', $lattrs);
369 $attrs['href'] = $url;
371 $attrs['title'] = $title;
373 common_element('a', $attrs, $text);
374 common_element_end('li');
377 function common_input($id, $label, $value=NULL,$instructions=NULL) {
378 common_element_start('p');
379 common_element('label', array('for' => $id), $label);
380 $attrs = array('name' => $id,
382 'class' => 'input_text',
385 $attrs['value'] = htmlspecialchars($value);
387 common_element('input', $attrs);
389 common_element('span', 'input_instructions', $instructions);
391 common_element_end('p');
394 function common_checkbox($id, $label, $checked=false, $instructions=NULL, $value='true', $disabled=false)
396 common_element_start('p');
397 $attrs = array('name' => $id,
398 'type' => 'checkbox',
399 'class' => 'checkbox',
402 $attrs['value'] = htmlspecialchars($value);
405 $attrs['checked'] = 'checked';
408 $attrs['disabled'] = 'true';
410 common_element('input', $attrs);
412 common_element('label', array('class' => 'checkbox_label', 'for' => $id), $label);
415 common_element('span', 'input_instructions', $instructions);
417 common_element_end('p');
420 function common_dropdown($id, $label, $content, $instructions=NULL, $blank_select=FALSE, $selected=NULL) {
421 common_element_start('p');
422 common_element('label', array('for' => $id), $label);
423 common_element_start('select', array('id' => $id, 'name' => $id));
425 common_element('option', array('value' => ''));
427 foreach ($content as $value => $option) {
428 if ($value == $selected) {
429 common_element('option', array('value' => $value, 'selected' => $value), $option);
431 common_element('option', array('value' => $value), $option);
434 common_element_end('select');
436 common_element('span', 'input_instructions', $instructions);
438 common_element_end('p');
440 function common_hidden($id, $value) {
441 common_element('input', array('name' => $id,
447 function common_password($id, $label, $instructions=NULL) {
448 common_element_start('p');
449 common_element('label', array('for' => $id), $label);
450 $attrs = array('name' => $id,
451 'type' => 'password',
452 'class' => 'password',
454 common_element('input', $attrs);
456 common_element('span', 'input_instructions', $instructions);
458 common_element_end('p');
461 function common_submit($id, $label, $cls='submit') {
463 common_element_start('p');
464 common_element('input', array('type' => 'submit',
469 common_element_end('p');
472 function common_textarea($id, $label, $content=NULL, $instructions=NULL) {
473 common_element_start('p');
474 common_element('label', array('for' => $id), $label);
475 common_element('textarea', array('rows' => 3,
479 ($content) ? $content : '');
481 common_element('span', 'input_instructions', $instructions);
483 common_element_end('p');
486 function common_timezone() {
487 if (common_logged_in()) {
488 $user = common_current_user();
489 if ($user->timezone) {
490 return $user->timezone;
495 return $config['site']['timezone'];
498 function common_language() {
500 // If there is a user logged in and they've set a language preference
501 // then return that one...
502 if (common_logged_in()) {
503 $user = common_current_user();
504 $user_language = $user->language;
506 return $user_language;
509 // Otherwise, find the best match for the languages requested by the
511 $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : NULL;
512 if (!empty($httplang)) {
513 $language = client_prefered_language($httplang);
518 // Finally, if none of the above worked, use the site's default...
519 return common_config('site', 'language');
521 # salted, hashed passwords are stored in the DB
523 function common_munge_password($password, $id) {
524 return md5($password . $id);
527 # check if a username exists and has matching password
528 function common_check_user($nickname, $password) {
529 # NEVER allow blank passwords, even if they match the DB
530 if (mb_strlen($password) == 0) {
533 $user = User::staticGet('nickname', $nickname);
534 if (is_null($user)) {
537 if (0 == strcmp(common_munge_password($password, $user->id),
546 # is the current user logged in?
547 function common_logged_in() {
548 return (!is_null(common_current_user()));
551 function common_have_session() {
552 return (0 != strcmp(session_id(), ''));
555 function common_ensure_session() {
556 if (!common_have_session()) {
561 # Three kinds of arguments:
566 # Initialize to false; set to NULL if none found
570 function common_set_user($user) {
574 if (is_null($user) && common_have_session()) {
576 unset($_SESSION['userid']);
578 } else if (is_string($user)) {
580 $user = User::staticGet('nickname', $nickname);
581 } else if (!($user instanceof User)) {
586 common_ensure_session();
587 $_SESSION['userid'] = $user->id;
594 function common_set_cookie($key, $value, $expiration=0) {
595 $path = common_config('site', 'path');
596 $server = common_config('site', 'server');
598 if ($path && ($path != '/')) {
599 $cookiepath = '/' . $path . '/';
603 return setcookie($key,
610 define('REMEMBERME', 'rememberme');
611 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60); # 30 days
613 function common_rememberme($user=NULL) {
615 $user = common_current_user();
617 common_debug('No current user to remember', __FILE__);
622 $rm = new Remember_me();
624 $rm->code = common_good_rand(16);
625 $rm->user_id = $user->id;
627 # Wrap the insert in some good ol' fashioned transaction code
631 $result = $rm->insert();
634 common_log_db_error($rm, 'INSERT', __FILE__);
635 common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
639 $rm->query('COMMIT');
641 common_debug('Inserted rememberme record (' . $rm->code . ', ' . $rm->user_id . '); result = ' . $result . '.', __FILE__);
643 $cookieval = $rm->user_id . ':' . $rm->code;
645 common_log(LOG_INFO, 'adding rememberme cookie "' . $cookieval . '" for ' . $user->nickname);
647 common_set_cookie(REMEMBERME, $cookieval, time() + REMEMBERME_EXPIRY);
652 function common_remembered_user() {
656 $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : NULL;
662 list($id, $code) = explode(':', $packed);
664 if (!$id || !$code) {
665 common_log(LOG_WARNING, 'Malformed rememberme cookie: ' . $packed);
670 $rm = Remember_me::staticGet($code);
673 common_log(LOG_WARNING, 'No such remember code: ' . $code);
678 if ($rm->user_id != $id) {
679 common_log(LOG_WARNING, 'Rememberme code for wrong user: ' . $rm->user_id . ' != ' . $id);
684 $user = User::staticGet($rm->user_id);
687 common_log(LOG_WARNING, 'No such user for rememberme: ' . $rm->user_id);
693 $result = $rm->delete();
696 common_log_db_error($rm, 'DELETE', __FILE__);
697 common_log(LOG_WARNING, 'Could not delete rememberme: ' . $code);
702 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
704 common_set_user($user);
705 common_real_login(false);
707 # We issue a new cookie, so they can log in
708 # automatically again after this session
710 common_rememberme($user);
715 # must be called with a valid user!
717 function common_forgetme() {
718 common_set_cookie(REMEMBERME, '', 0);
721 # who is the current user?
722 function common_current_user() {
725 if ($_cur === false) {
727 if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
728 common_ensure_session();
729 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
731 $_cur = User::staticGet($id);
736 # that didn't work; try to remember; will init $_cur to NULL on failure
737 $_cur = common_remembered_user();
740 common_debug("Got User " . $_cur->nickname);
741 common_debug("Faking session on remembered user");
742 # XXX: Is this necessary?
743 $_SESSION['userid'] = $_cur->id;
750 # Logins that are 'remembered' aren't 'real' -- they're subject to
751 # cookie-stealing. So, we don't let them do certain things. New reg,
752 # OpenID, and password logins _are_ real.
754 function common_real_login($real=true) {
755 common_ensure_session();
756 $_SESSION['real_login'] = $real;
759 function common_is_real_login() {
760 return common_logged_in() && $_SESSION['real_login'];
763 # get canonical version of nickname for comparison
764 function common_canonical_nickname($nickname) {
765 # XXX: UTF-8 canonicalization (like combining chars)
766 return strtolower($nickname);
769 # get canonical version of email for comparison
770 function common_canonical_email($email) {
771 # XXX: canonicalize UTF-8
772 # XXX: lcase the domain part
776 define('URL_REGEX', '^|[ \t\r\n])((ftp|http|https|gopher|mailto|news|nntp|telnet|wais|file|prospero|aim|webcal):(([A-Za-z0-9$_.+!*(),;/?:@&~=-])|%[A-Fa-f0-9]{2}){2,}(#([a-zA-Z0-9][a-zA-Z0-9$_.+!*(),;/?:@&~=%-]*))?([A-Za-z0-9$_+!*();/?:~-]))');
778 function common_render_content($text, $notice) {
779 $r = common_render_text($text);
780 $id = $notice->profile_id;
781 $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
782 $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
783 $r = preg_replace('/(^|\s+)@#([A-Za-z0-9]{1,64})/e', "'\\1@#'.common_at_hash_link($id, '\\2')", $r);
787 function common_render_text($text) {
788 $r = htmlspecialchars($text);
790 $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
791 $r = preg_replace_callback('@https?://[^\]>\s]+@', 'common_render_uri_thingy', $r);
792 $r = preg_replace('/(^|\s+)#([A-Za-z0-9_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
797 function common_render_uri_thingy($matches) {
801 # Some heuristics for extracting URIs from surrounding punctuation
802 # Strip from trailing text...
803 if (preg_match('/^(.*)([,.:"\']+)$/', $uri, $matches)) {
805 $trailer = $matches[2];
809 ']' => '[', # technically disallowed in URIs, but used in Java docs
810 ')' => '(', # far too frequent in Wikipedia and MSDN
812 $final = substr($uri, -1, 1);
813 if (isset($pairs[$final])) {
814 $openers = substr_count($uri, $pairs[$final]);
815 $closers = substr_count($uri, $final);
816 if ($closers > $openers) {
817 // Assume the paren was opened outside the URI
818 $uri = substr($uri, 0, -1);
819 $trailer = $final . $trailer;
822 if ($longurl = common_longurl($uri)) {
823 $longurl = htmlentities($longurl, ENT_QUOTES, 'UTF-8');
824 $title = " title='$longurl'";
828 return '<a href="' . $uri . '"' . $title . ' class="extlink">' . $uri . '</a>' . $trailer;
831 function common_longurl($short_url) {
832 $long_url = common_shorten_link($short_url, true);
833 if ($long_url === $short_url) return false;
837 function common_longurl2($uri) {
838 $uri_e = urlencode($uri);
839 $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
840 if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
841 return stripslashes($longurl['long_url']);
844 function common_shorten_links($text) {
845 if (mb_strlen($text) <= 140) return $text;
846 static $cache = array();
847 if (isset($cache[$text])) return $cache[$text];
848 // \s = not a horizontal whitespace character (since PHP 5.2.4)
849 return $cache[$text] = preg_replace('@https?://[^)\]>\s]+@e', "common_shorten_link('\\0')", $text);
852 function common_shorten_link($url, $reverse = false) {
853 static $url_cache = array();
854 if ($reverse) return isset($url_cache[$url]) ? $url_cache[$url] : $url;
856 $user = common_current_user();
858 $curlh = curl_init();
859 curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
860 curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
861 curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
863 switch($user->urlshorteningservice) {
865 $short_url_service = new LilUrl;
866 $short_url = $short_url_service->shorten($url);
870 $short_url_service = new TightUrl;
871 $short_url = $short_url_service->shorten($url);
875 $short_url_service = new PtitUrl;
876 $short_url = $short_url_service->shorten($url);
880 curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($url));
881 $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
885 curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($url));
886 $short_url = curl_exec($curlh);
889 curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($url));
890 $short_url = curl_exec($curlh);
893 curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($url));
894 $short_url = curl_exec($curlh);
897 curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($url));
898 $short_url = curl_exec($curlh);
907 $url_cache[(string)$short_url] = $url;
908 return (string)$short_url;
913 function common_xml_safe_str($str) {
914 $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
916 // Replace control, formatting, and surrogate characters with '*', ala Twitter
917 return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
920 function common_tag_link($tag) {
921 $canonical = common_canonical_tag($tag);
922 $url = common_local_url('tag', array('tag' => $canonical));
923 return '<a href="' . htmlspecialchars($url) . '" rel="tag" class="hashlink">' . htmlspecialchars($tag) . '</a>';
926 function common_canonical_tag($tag) {
927 return strtolower(str_replace(array('-', '_', '.'), '', $tag));
930 function common_valid_profile_tag($str) {
931 return preg_match('/^[A-Za-z0-9_\-\.]{1,64}$/', $str);
934 function common_at_link($sender_id, $nickname) {
935 $sender = Profile::staticGet($sender_id);
936 $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
938 return '<span class="vcard"><a class="fn nickname url" rel="reply" href="'.htmlspecialchars($recipient->profileurl).'" class="atlink">'.$nickname.'</a></span>';
940 return '<span class="vcard"> <span class="fn nickname">'.$nickname.'</span> </span>';
944 function common_at_hash_link($sender_id, $tag) {
945 $user = User::staticGet($sender_id);
949 $tagged = Profile_tag::getTagged($user->id, common_canonical_tag($tag));
951 $url = common_local_url('subscriptions',
952 array('nickname' => $user->nickname,
954 return '<a href="'.htmlspecialchars($url).'" class="atlink">'.$tag.'</a>';
960 function common_relative_profile($sender, $nickname, $dt=NULL) {
961 # Try to find profiles this profile is subscribed to that have this nickname
962 $recipient = new Profile();
963 # XXX: use a join instead of a subquery
964 $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
965 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
966 if ($recipient->find(TRUE)) {
967 # XXX: should probably differentiate between profiles with
968 # the same name by date of most recent update
971 # Try to find profiles that listen to this profile and that have this nickname
972 $recipient = new Profile();
973 # XXX: use a join instead of a subquery
974 $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
975 $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
976 if ($recipient->find(TRUE)) {
977 # XXX: should probably differentiate between profiles with
978 # the same name by date of most recent update
981 # If this is a local user, try to find a local user with that nickname.
982 $sender = User::staticGet($sender->id);
984 $recipient_user = User::staticGet('nickname', $nickname);
985 if ($recipient_user) {
986 return $recipient_user->getProfile();
989 # Otherwise, no links. @messages from local users to remote users,
990 # or from remote users to other remote users, are just
991 # outside our ability to make intelligent guesses about
995 // where should the avatar go for this user?
997 function common_avatar_filename($id, $extension, $size=NULL, $extra=NULL) {
1001 return $id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
1003 return $id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
1007 function common_avatar_path($filename) {
1009 return INSTALLDIR . '/avatar/' . $filename;
1012 function common_avatar_url($filename) {
1013 return common_path('avatar/'.$filename);
1016 function common_avatar_display_url($avatar) {
1017 $server = common_config('avatar', 'server');
1019 return 'http://'.$server.'/'.$avatar->filename;
1021 return $avatar->url;
1025 function common_default_avatar($size) {
1026 static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
1027 AVATAR_STREAM_SIZE => 'stream',
1028 AVATAR_MINI_SIZE => 'mini');
1029 return theme_path('default-avatar-'.$sizenames[$size].'.png');
1032 function common_local_url($action, $args=NULL, $fragment=NULL) {
1034 if (common_config('site','fancy')) {
1035 $url = common_fancy_url($action, $args);
1037 $url = common_simple_url($action, $args);
1039 if (!is_null($fragment)) {
1040 $url .= '#'.$fragment;
1045 function common_fancy_url($action, $args=NULL) {
1046 switch (strtolower($action)) {
1048 if ($args && isset($args['page'])) {
1049 return common_path('?page=' . $args['page']);
1051 return common_path('');
1054 if ($args && isset($args['page'])) {
1055 return common_path('featured?page=' . $args['page']);
1057 return common_path('featured');
1060 if ($args && isset($args['page'])) {
1061 return common_path('favorited?page=' . $args['page']);
1063 return common_path('favorited');
1066 return common_path('rss');
1068 return common_path("api/statuses/public_timeline.atom");
1070 return common_path('xrds');
1072 return common_path('featuredrss');
1073 case 'favoritedrss':
1074 return common_path('favoritedrss');
1076 if ($args && $args['type']) {
1077 return common_path('opensearch/'.$args['type']);
1079 return common_path('opensearch/people');
1082 return common_path('doc/'.$args['title']);
1088 return common_path('main/'.$action);
1090 return common_path('main/tagother?id='.$args['id']);
1092 if ($args && $args['code']) {
1093 return common_path('main/register/'.$args['code']);
1095 return common_path('main/register');
1097 case 'remotesubscribe':
1098 if ($args && $args['nickname']) {
1099 return common_path('main/remote?nickname=' . $args['nickname']);
1101 return common_path('main/remote');
1104 return common_path($args['nickname'].'/nudge');
1106 return common_path('main/openid');
1107 case 'profilesettings':
1108 return common_path('settings/profile');
1109 case 'emailsettings':
1110 return common_path('settings/email');
1111 case 'openidsettings':
1112 return common_path('settings/openid');
1114 return common_path('settings/sms');
1115 case 'twittersettings':
1116 return common_path('settings/twitter');
1117 case 'othersettings':
1118 return common_path('settings/other');
1119 case 'deleteprofile':
1120 return common_path('settings/delete');
1122 if ($args && $args['replyto']) {
1123 return common_path('notice/new?replyto='.$args['replyto']);
1125 return common_path('notice/new');
1128 return common_path('notice/'.$args['notice']);
1129 case 'deletenotice':
1130 if ($args && $args['notice']) {
1131 return common_path('notice/delete/'.$args['notice']);
1133 return common_path('notice/delete');
1135 case 'microsummary':
1138 return common_path($args['nickname'].'/'.$action);
1143 if ($args && isset($args['page'])) {
1144 return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
1146 return common_path($args['nickname'].'/'.$action);
1148 case 'subscriptions':
1150 $nickname = $args['nickname'];
1151 unset($args['nickname']);
1152 if (isset($args['tag'])) {
1153 $tag = $args['tag'];
1154 unset($args['tag']);
1156 $params = http_build_query($args);
1158 return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : '') . '?' . $params);
1160 return common_path($nickname.'/'.$action . (($tag) ? '/' . $tag : ''));
1163 return common_path($args['nickname'].'/all/rss');
1165 return common_path($args['nickname'].'/replies/rss');
1167 if (isset($args['limit']))
1168 return common_path($args['nickname'].'/rss?limit=' . $args['limit']);
1169 return common_path($args['nickname'].'/rss');
1171 if ($args && isset($args['page'])) {
1172 return common_path($args['nickname'].'?page=' . $args['page']);
1174 return common_path($args['nickname']);
1177 case 'usertimeline':
1178 return common_path("api/statuses/user_timeline/".$args['nickname'].".atom");
1179 case 'confirmaddress':
1180 return common_path('main/confirmaddress/'.$args['code']);
1182 return common_path('user/'.$args['id']);
1183 case 'recoverpassword':
1184 $path = 'main/recoverpassword';
1185 if ($args['code']) {
1186 $path .= '/' . $args['code'];
1188 return common_path($path);
1190 return common_path('settings/im');
1191 case 'peoplesearch':
1192 return common_path('search/people' . (($args) ? ('?' . http_build_query($args)) : ''));
1193 case 'noticesearch':
1194 return common_path('search/notice' . (($args) ? ('?' . http_build_query($args)) : ''));
1195 case 'noticesearchrss':
1196 return common_path('search/notice/rss' . (($args) ? ('?' . http_build_query($args)) : ''));
1197 case 'avatarbynickname':
1198 return common_path($args['nickname'].'/avatar/'.$args['size']);
1200 if (isset($args['tag']) && $args['tag']) {
1201 $path = 'tag/' . $args['tag'];
1202 unset($args['tag']);
1206 return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
1208 $path = 'peopletag/' . $args['tag'];
1209 unset($args['tag']);
1210 return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
1212 return common_path('tags' . (($args) ? ('?' . http_build_query($args)) : ''));
1214 return common_path('main/favor');
1216 return common_path('main/disfavor');
1217 case 'showfavorites':
1218 if ($args && isset($args['page'])) {
1219 return common_path($args['nickname'].'/favorites?page=' . $args['page']);
1221 return common_path($args['nickname'].'/favorites');
1223 case 'favoritesrss':
1224 return common_path($args['nickname'].'/favorites/rss');
1226 return common_path('message/' . $args['message']);
1228 return common_path('message/new' . (($args) ? ('?' . http_build_query($args)) : ''));
1230 # XXX: do fancy URLs for all the API methods
1231 switch (strtolower($args['apiaction'])) {
1233 switch (strtolower($args['method'])) {
1234 case 'user_timeline.rss':
1235 return common_path('api/statuses/user_timeline/'.$args['argument'].'.rss');
1236 case 'user_timeline.atom':
1237 return common_path('api/statuses/user_timeline/'.$args['argument'].'.atom');
1238 case 'user_timeline.json':
1239 return common_path('api/statuses/user_timeline/'.$args['argument'].'.json');
1240 case 'user_timeline.xml':
1241 return common_path('api/statuses/user_timeline/'.$args['argument'].'.xml');
1242 default: return common_simple_url($action, $args);
1244 default: return common_simple_url($action, $args);
1247 if ($args && isset($args['seconds'])) {
1248 return common_path('main/sup?seconds='.$args['seconds']);
1250 return common_path('main/sup');
1253 return common_simple_url($action, $args);
1257 function common_simple_url($action, $args=NULL) {
1259 /* XXX: pretty URLs */
1262 foreach ($args as $key => $value) {
1263 $extra .= "&${key}=${value}";
1266 return common_path("index.php?action=${action}${extra}");
1269 function common_path($relative) {
1271 $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
1272 return "http://".$config['site']['server'].'/'.$pathpart.$relative;
1275 function common_date_string($dt) {
1276 // XXX: do some sexy date formatting
1277 // return date(DATE_RFC822, $dt);
1278 $t = strtotime($dt);
1282 if ($now < $t) { # that shouldn't happen!
1283 return common_exact_date($dt);
1284 } else if ($diff < 60) {
1285 return _('a few seconds ago');
1286 } else if ($diff < 92) {
1287 return _('about a minute ago');
1288 } else if ($diff < 3300) {
1289 return sprintf(_('about %d minutes ago'), round($diff/60));
1290 } else if ($diff < 5400) {
1291 return _('about an hour ago');
1292 } else if ($diff < 22 * 3600) {
1293 return sprintf(_('about %d hours ago'), round($diff/3600));
1294 } else if ($diff < 37 * 3600) {
1295 return _('about a day ago');
1296 } else if ($diff < 24 * 24 * 3600) {
1297 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
1298 } else if ($diff < 46 * 24 * 3600) {
1299 return _('about a month ago');
1300 } else if ($diff < 330 * 24 * 3600) {
1301 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
1302 } else if ($diff < 480 * 24 * 3600) {
1303 return _('about a year ago');
1305 return common_exact_date($dt);
1309 function common_exact_date($dt) {
1314 $_utc = new DateTimeZone('UTC');
1315 $_siteTz = new DateTimeZone(common_timezone());
1318 $dateStr = date('d F Y H:i:s', strtotime($dt));
1319 $d = new DateTime($dateStr, $_utc);
1320 $d->setTimezone($_siteTz);
1321 return $d->format(DATE_RFC850);
1324 function common_date_w3dtf($dt) {
1325 $dateStr = date('d F Y H:i:s', strtotime($dt));
1326 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1327 $d->setTimezone(new DateTimeZone(common_timezone()));
1328 return $d->format(DATE_W3C);
1331 function common_date_rfc2822($dt) {
1332 $dateStr = date('d F Y H:i:s', strtotime($dt));
1333 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1334 $d->setTimezone(new DateTimeZone(common_timezone()));
1335 return $d->format('r');
1338 function common_date_iso8601($dt) {
1339 $dateStr = date('d F Y H:i:s', strtotime($dt));
1340 $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1341 $d->setTimezone(new DateTimeZone(common_timezone()));
1342 return $d->format('c');
1345 function common_sql_now() {
1346 return strftime('%Y-%m-%d %H:%M:%S', time());
1349 function common_redirect($url, $code=307) {
1350 static $status = array(301 => "Moved Permanently",
1353 307 => "Temporary Redirect");
1354 header("Status: ${code} $status[$code]");
1355 header("Location: $url");
1357 common_start_xml('a',
1358 '-//W3C//DTD XHTML 1.0 Strict//EN',
1359 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1360 common_element('a', array('href' => $url), $url);
1365 function common_save_replies($notice) {
1366 # Alternative reply format
1368 if (preg_match('/^T ([A-Z0-9]{1,64}) /', $notice->content, $match)) {
1371 # extract all @messages
1372 $cnt = preg_match_all('/(?:^|\s)@([a-z0-9]{1,64})/', $notice->content, $match);
1376 if ($cnt || $tname) {
1377 # XXX: is there another way to make an array copy?
1378 $names = ($tname) ? array_unique(array_merge(array(strtolower($tname)), $match[1])) : array_unique($match[1]);
1381 $sender = Profile::staticGet($notice->profile_id);
1385 # store replied only for first @ (what user/notice what the reply directed,
1386 # we assume first @ is it)
1388 for ($i=0; $i<count($names); $i++) {
1389 $nickname = $names[$i];
1390 $recipient = common_relative_profile($sender, $nickname, $notice->created);
1394 if ($i == 0 && ($recipient->id != $sender->id) && !$notice->reply_to) { # Don't save reply to self
1395 $reply_for = $recipient;
1396 $recipient_notice = $reply_for->getCurrentNotice();
1397 if ($recipient_notice) {
1398 $orig = clone($notice);
1399 $notice->reply_to = $recipient_notice->id;
1400 $notice->update($orig);
1403 $reply = new Reply();
1404 $reply->notice_id = $notice->id;
1405 $reply->profile_id = $recipient->id;
1406 $id = $reply->insert();
1408 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1409 common_log(LOG_ERR, 'DB error inserting reply: ' . $last_error->message);
1410 common_server_error(sprintf(_('DB error inserting reply: %s'), $last_error->message));
1413 $replied[$recipient->id] = 1;
1417 # Hash format replies, too
1418 $cnt = preg_match_all('/(?:^|\s)@#([a-z0-9]{1,64})/', $notice->content, $match);
1420 foreach ($match[1] as $tag) {
1421 $tagged = Profile_tag::getTagged($sender->id, $tag);
1422 foreach ($tagged as $t) {
1423 if (!$replied[$t->id]) {
1424 $reply = new Reply();
1425 $reply->notice_id = $notice->id;
1426 $reply->profile_id = $t->id;
1427 $id = $reply->insert();
1429 common_log_db_error($reply, 'INSERT', __FILE__);
1438 function common_broadcast_notice($notice, $remote=false) {
1440 // Check to see if notice should go to Twitter
1441 $flink = Foreign_link::getByUserID($notice->profile_id, 1); // 1 == Twitter
1442 if (($flink->noticesync & FOREIGN_NOTICE_SEND) == FOREIGN_NOTICE_SEND) {
1444 // If it's not a Twitter-style reply, or if the user WANTS to send replies...
1446 if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
1447 (($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) == FOREIGN_NOTICE_SEND_REPLY)) {
1449 $result = common_twitter_broadcast($notice, $flink);
1452 common_debug('Unable to send notice: ' . $notice->id . ' to Twitter.', __FILE__);
1457 if (common_config('queue', 'enabled')) {
1459 return common_enqueue_notice($notice);
1461 return common_real_broadcast($notice, $remote);
1465 function common_twitter_broadcast($notice, $flink) {
1468 $fuser = $flink->getForeignUser();
1469 $twitter_user = $fuser->nickname;
1470 $twitter_password = $flink->credentials;
1471 $uri = 'http://www.twitter.com/statuses/update.json';
1473 // XXX: Hack to get around PHP cURL's use of @ being a a meta character
1474 $statustxt = preg_replace('/^@/', ' @', $notice->content);
1477 CURLOPT_USERPWD => "$twitter_user:$twitter_password",
1478 CURLOPT_POST => true,
1479 CURLOPT_POSTFIELDS => array(
1480 'status' => $statustxt,
1481 'source' => $config['integration']['source']
1483 CURLOPT_RETURNTRANSFER => true,
1484 CURLOPT_FAILONERROR => true,
1485 CURLOPT_HEADER => false,
1486 CURLOPT_FOLLOWLOCATION => true,
1487 CURLOPT_USERAGENT => "Laconica",
1488 CURLOPT_CONNECTTIMEOUT => 120, // XXX: Scary!!!! How long should this be?
1489 CURLOPT_TIMEOUT => 120
1492 $ch = curl_init($uri);
1493 curl_setopt_array($ch, $options);
1494 $data = curl_exec($ch);
1495 $errmsg = curl_error($ch);
1498 common_debug("cURL error: $errmsg - trying to send notice for $twitter_user.",
1506 common_debug("No data returned by Twitter's API trying to send update for $twitter_user",
1511 // Twitter should return a status
1512 $status = json_decode($data);
1515 common_debug("Unexpected data returned by Twitter API trying to send update for $twitter_user",
1523 # Stick the notice on the queue
1525 function common_enqueue_notice($notice) {
1526 foreach (array('jabber', 'omb', 'sms', 'public') as $transport) {
1527 $qi = new Queue_item();
1528 $qi->notice_id = $notice->id;
1529 $qi->transport = $transport;
1530 $qi->created = $notice->created;
1531 $result = $qi->insert();
1533 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1534 common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
1537 common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
1542 function common_dequeue_notice($notice) {
1543 $qi = Queue_item::staticGet($notice->id);
1545 $result = $qi->delete();
1547 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1548 common_log(LOG_ERR, 'DB error deleting queue item: ' . $last_error->message);
1551 common_log(LOG_DEBUG, 'complete dequeueing notice ID = ' . $notice->id);
1558 function common_real_broadcast($notice, $remote=false) {
1561 # Make sure we have the OMB stuff
1562 require_once(INSTALLDIR.'/lib/omb.php');
1563 $success = omb_broadcast_remote_subscribers($notice);
1565 common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
1569 require_once(INSTALLDIR.'/lib/jabber.php');
1570 $success = jabber_broadcast_notice($notice);
1572 common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
1576 require_once(INSTALLDIR.'/lib/mail.php');
1577 $success = mail_broadcast_notice_sms($notice);
1579 common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
1583 $success = jabber_public_notice($notice);
1585 common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
1588 // XXX: broadcast notices to other IM
1592 function common_broadcast_profile($profile) {
1593 // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1594 require_once(INSTALLDIR.'/lib/omb.php');
1595 omb_broadcast_profile($profile);
1596 // XXX: Other broadcasts...?
1600 function common_profile_url($nickname) {
1601 return common_local_url('showstream', array('nickname' => $nickname));
1604 # Don't call if nobody's logged in
1606 function common_notice_form($action=NULL, $content=NULL) {
1607 $user = common_current_user();
1608 assert(!is_null($user));
1609 common_element_start('form', array('id' => 'status_form',
1611 'action' => common_local_url('newnotice')));
1612 common_element_start('p');
1613 common_element('label', array('for' => 'status_textarea',
1614 'id' => 'status_label'),
1615 sprintf(_('What\'s up, %s?'), $user->nickname));
1616 common_element('span', array('id' => 'counter', 'class' => 'counter'), '140');
1617 common_element('textarea', array('id' => 'status_textarea',
1620 'name' => 'status_textarea'),
1621 ($content) ? $content : '');
1622 common_hidden('token', common_session_token());
1624 common_hidden('returnto', $action);
1627 common_hidden('inreplyto', 'false');
1628 common_element('input', array('id' => 'status_submit',
1629 'name' => 'status_submit',
1631 'value' => _('Send')));
1632 common_element_end('p');
1633 common_element_end('form');
1636 # Should make up a reasonable root URL
1638 function common_root_url() {
1639 return common_path('');
1642 # returns $bytes bytes of random data as a hexadecimal string
1643 # "good" here is a goal and not a guarantee
1645 function common_good_rand($bytes) {
1646 # XXX: use random.org...?
1647 if (file_exists('/dev/urandom')) {
1648 return common_urandom($bytes);
1649 } else { # FIXME: this is probably not good enough
1650 return common_mtrand($bytes);
1654 function common_urandom($bytes) {
1655 $h = fopen('/dev/urandom', 'rb');
1657 $src = fread($h, $bytes);
1660 for ($i = 0; $i < $bytes; $i++) {
1661 $enc .= sprintf("%02x", (ord($src[$i])));
1666 function common_mtrand($bytes) {
1668 for ($i = 0; $i < $bytes; $i++) {
1669 $enc .= sprintf("%02x", mt_rand(0, 255));
1674 function common_set_returnto($url) {
1675 common_ensure_session();
1676 $_SESSION['returnto'] = $url;
1679 function common_get_returnto() {
1680 common_ensure_session();
1681 return $_SESSION['returnto'];
1684 function common_timestamp() {
1685 return date('YmdHis');
1688 function common_ensure_syslog() {
1689 static $initialized = false;
1690 if (!$initialized) {
1692 openlog($config['syslog']['appname'], 0, LOG_USER);
1693 $initialized = true;
1697 function common_log($priority, $msg, $filename=NULL) {
1698 $logfile = common_config('site', 'logfile');
1700 $log = fopen($logfile, "a");
1702 static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1703 'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1704 $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1705 fwrite($log, $output);
1709 common_ensure_syslog();
1710 syslog($priority, $msg);
1714 function common_debug($msg, $filename=NULL) {
1716 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1718 common_log(LOG_DEBUG, $msg);
1722 function common_log_db_error(&$object, $verb, $filename=NULL) {
1723 $objstr = common_log_objstring($object);
1724 $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1725 common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1728 function common_log_objstring(&$object) {
1729 if (is_null($object)) {
1732 $arr = $object->toArray();
1734 foreach ($arr as $k => $v) {
1735 $fields[] = "$k='$v'";
1737 $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1741 function common_valid_http_url($url) {
1742 return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1745 function common_valid_tag($tag) {
1746 if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1747 return (Validate::email($matches[1]) ||
1748 preg_match('/^([\w-\.]+)$/', $matches[1]));
1753 # Does a little before-after block for next/prev page
1755 function common_pagination($have_before, $have_after, $page, $action, $args=NULL) {
1757 if ($have_before || $have_after) {
1758 common_element_start('div', array('id' => 'pagination'));
1759 common_element_start('ul', array('id' => 'nav_pagination'));
1763 $pargs = array('page' => $page-1);
1764 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
1766 common_element_start('li', 'before');
1767 common_element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'prev'),
1769 common_element_end('li');
1773 $pargs = array('page' => $page+1);
1774 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
1775 common_element_start('li', 'after');
1776 common_element('a', array('href' => common_local_url($action, $newargs), 'rel' => 'next'),
1778 common_element_end('li');
1781 if ($have_before || $have_after) {
1782 common_element_end('ul');
1783 common_element_end('div');
1787 /* Following functions are copied from MediaWiki GlobalFunctions.php
1788 * and written by Evan Prodromou. */
1790 function common_accept_to_prefs($accept, $def = '*/*') {
1791 # No arg means accept anything (per HTTP spec)
1793 return array($def => 1);
1798 $parts = explode(',', $accept);
1800 foreach($parts as $part) {
1801 # FIXME: doesn't deal with params like 'text/html; level=1'
1802 @list($value, $qpart) = explode(';', $part);
1804 if(!isset($qpart)) {
1806 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1807 $prefs[$value] = $match[1];
1814 function common_mime_type_match($type, $avail) {
1815 if(array_key_exists($type, $avail)) {
1818 $parts = explode('/', $type);
1819 if(array_key_exists($parts[0] . '/*', $avail)) {
1820 return $parts[0] . '/*';
1821 } elseif(array_key_exists('*/*', $avail)) {
1829 function common_negotiate_type($cprefs, $sprefs) {
1832 foreach(array_keys($sprefs) as $type) {
1833 $parts = explode('/', $type);
1834 if($parts[1] != '*') {
1835 $ckey = common_mime_type_match($type, $cprefs);
1837 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1842 foreach(array_keys($cprefs) as $type) {
1843 $parts = explode('/', $type);
1844 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1845 $skey = common_mime_type_match($type, $sprefs);
1847 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1853 $besttype = "text/html";
1855 foreach(array_keys($combine) as $type) {
1856 if($combine[$type] > $bestq) {
1858 $bestq = $combine[$type];
1865 function common_config($main, $sub) {
1867 return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1870 function common_copy_args($from) {
1872 $strip = get_magic_quotes_gpc();
1873 foreach ($from as $k => $v) {
1874 $to[$k] = ($strip) ? stripslashes($v) : $v;
1879 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1880 // This is used before handing a request off to OAuthRequest::from_request.
1881 function common_remove_magic_from_request() {
1882 if(get_magic_quotes_gpc()) {
1883 $_POST=array_map('stripslashes',$_POST);
1884 $_GET=array_map('stripslashes',$_GET);
1888 function common_user_uri(&$user) {
1889 return common_local_url('userbyid', array('id' => $user->id));
1892 function common_notice_uri(&$notice) {
1893 return common_local_url('shownotice',
1894 array('notice' => $notice->id));
1897 # 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1899 function common_confirmation_code($bits) {
1900 # 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1901 static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1902 $chars = ceil($bits/5);
1904 for ($i = 0; $i < $chars; $i++) {
1905 # XXX: convert to string and back
1906 $num = hexdec(common_good_rand(1));
1907 # XXX: randomness is too precious to throw away almost
1908 # 40% of the bits we get!
1909 $code .= $codechars[$num%32];
1914 # convert markup to HTML
1916 function common_markup_to_html($c) {
1917 $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1918 $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1919 $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1920 return Markdown($c);
1923 function common_profile_avatar_url($profile, $size=AVATAR_PROFILE_SIZE) {
1924 $avatar = $profile->getAvatar($size);
1926 return common_avatar_display_url($avatar);
1928 return common_default_avatar($size);
1932 function common_profile_uri($profile) {
1936 $user = User::staticGet($profile->id);
1941 $remote = Remote_profile::staticGet($profile->id);
1943 return $remote->uri;
1945 # XXX: this is a very bad profile!
1949 function common_canonical_sms($sms) {
1951 preg_replace('/\D/', '', $sms);
1955 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
1958 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1962 case E_USER_WARNING:
1963 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1967 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1971 # FIXME: show error page if we're on the Web
1972 /* Don't execute PHP internal error handler */
1976 function common_session_token() {
1977 common_ensure_session();
1978 if (!array_key_exists('token', $_SESSION)) {
1979 $_SESSION['token'] = common_good_rand(64);
1981 return $_SESSION['token'];
1984 function common_disfavor_form($notice) {
1985 common_element_start('form', array('id' => 'disfavor-' . $notice->id,
1987 'class' => 'disfavor',
1988 'action' => common_local_url('disfavor')));
1990 common_element('input', array('type' => 'hidden',
1991 'name' => 'token-'. $notice->id,
1992 'id' => 'token-'. $notice->id,
1994 'value' => common_session_token()));
1996 common_element('input', array('type' => 'hidden',
1998 'id' => 'notice-n'. $notice->id,
1999 'class' => 'notice',
2000 'value' => $notice->id));
2002 common_element('input', array('type' => 'submit',
2003 'id' => 'disfavor-submit-' . $notice->id,
2004 'name' => 'disfavor-submit-' . $notice->id,
2005 'class' => 'disfavor',
2006 'value' => 'Disfavor favorite',
2007 'title' => 'Remove this message from favorites'));
2008 common_element_end('form');
2011 function common_favor_form($notice) {
2012 common_element_start('form', array('id' => 'favor-' . $notice->id,
2015 'action' => common_local_url('favor')));
2017 common_element('input', array('type' => 'hidden',
2018 'name' => 'token-'. $notice->id,
2019 'id' => 'token-'. $notice->id,
2021 'value' => common_session_token()));
2023 common_element('input', array('type' => 'hidden',
2025 'id' => 'notice-n'. $notice->id,
2026 'class' => 'notice',
2027 'value' => $notice->id));
2029 common_element('input', array('type' => 'submit',
2030 'id' => 'favor-submit-' . $notice->id,
2031 'name' => 'favor-submit-' . $notice->id,
2033 'value' => 'Add to favorites',
2034 'title' => 'Add this message to favorites'));
2035 common_element_end('form');
2038 function common_nudge_form($profile) {
2039 common_element_start('form', array('id' => 'nudge', 'method' => 'post',
2040 'action' => common_local_url('nudge', array('nickname' => $profile->nickname))));
2041 common_hidden('token', common_session_token());
2042 common_element('input', array('type' => 'submit',
2043 'class' => 'submit',
2044 'value' => _('Send a nudge')));
2045 common_element_end('form');
2047 function common_nudge_response() {
2048 common_element('p', array('id' => 'nudge_response'), _('Nudge sent!'));
2051 function common_subscribe_form($profile) {
2052 common_element_start('form', array('id' => 'subscribe-' . $profile->nickname,
2054 'class' => 'subscribe',
2055 'action' => common_local_url('subscribe')));
2056 common_hidden('token', common_session_token());
2057 common_element('input', array('id' => 'subscribeto-' . $profile->nickname,
2058 'name' => 'subscribeto',
2060 'value' => $profile->nickname));
2061 common_element('input', array('type' => 'submit',
2062 'class' => 'submit',
2063 'value' => _('Subscribe')));
2064 common_element_end('form');
2067 function common_unsubscribe_form($profile) {
2068 common_element_start('form', array('id' => 'unsubscribe-' . $profile->nickname,
2070 'class' => 'unsubscribe',
2071 'action' => common_local_url('unsubscribe')));
2072 common_hidden('token', common_session_token());
2073 common_element('input', array('id' => 'unsubscribeto-' . $profile->id,
2074 'name' => 'unsubscribeto',
2076 'value' => $profile->id));
2077 common_element('input', array('type' => 'submit',
2078 'class' => 'submit',
2079 'value' => _('Unsubscribe')));
2080 common_element_end('form');
2083 // XXX: Refactor this code
2084 function common_profile_new_message_nudge ($cur, $profile) {
2085 $user = User::staticGet('id', $profile->id);
2087 if ($cur && $cur->id != $user->id && $cur->mutuallySubscribed($user)) {
2088 common_element_start('li', array('id' => 'profile_send_a_new_message'));
2089 common_element('a', array('href' => common_local_url('newmessage', array('to' => $user->id))),
2090 _('Send a message'));
2091 common_element_end('li');
2093 if ($user->email && $user->emailnotifynudge) {
2094 common_element_start('li', array('id' => 'profile_nudge'));
2095 common_nudge_form($user);
2096 common_element_end('li');
2101 function common_cache_key($extra) {
2102 return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
2105 function common_keyize($str) {
2106 $str = strtolower($str);
2107 $str = preg_replace('/\s/', '_', $str);
2111 function common_message_form($content, $user, $to) {
2113 common_element_start('form', array('id' => 'message_form',
2115 'action' => common_local_url('newmessage')));
2117 $mutual_users = $user->mutuallySubscribedUsers();
2121 while ($mutual_users->fetch()) {
2122 if ($mutual_users->id != $user->id) {
2123 $mutual[$mutual_users->id] = $mutual_users->nickname;
2127 $mutual_users->free();
2128 unset($mutual_users);
2130 common_dropdown('to', _('To'), $mutual, NULL, FALSE, $to->id);
2132 common_element_start('p');
2134 common_element('textarea', array('id' => 'message_content',
2137 'name' => 'content'),
2138 ($content) ? $content : '');
2140 common_element('input', array('id' => 'message_send',
2141 'name' => 'message_send',
2143 'value' => _('Send')));
2145 common_hidden('token', common_session_token());
2147 common_element_end('p');
2148 common_element_end('form');
2151 function common_memcache() {
2152 static $cache = NULL;
2153 if (!common_config('memcached', 'enabled')) {
2157 $cache = new Memcache();
2158 $servers = common_config('memcached', 'server');
2159 if (is_array($servers)) {
2160 foreach($servers as $server) {
2161 $cache->addServer($server);
2164 $cache->addServer($servers);
2171 function common_compatible_license($from, $to) {
2172 # XXX: better compatibility check needed here!
2173 return ($from == $to);