]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/util.php
more ajax coming (un-sub)
[quix0rs-gnu-social.git] / lib / util.php
1 <?php
2 /*
3  * Laconica - a distributed open-source microblogging tool
4  * Copyright (C) 2008, Controlez-Vous, Inc.
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 /* XXX: break up into separate modules (HTTP, HTML, user, files) */
21
22 # Show a server error
23
24 function common_server_error($msg, $code=500) {
25         static $status = array(500 => 'Internal Server Error',
26                                                    501 => 'Not Implemented',
27                                                    502 => 'Bad Gateway',
28                                                    503 => 'Service Unavailable',
29                                                    504 => 'Gateway Timeout',
30                                                    505 => 'HTTP Version Not Supported');
31
32         if (!array_key_exists($code, $status)) {
33                 $code = 500;
34         }
35
36         $status_string = $status[$code];
37
38         header('HTTP/1.1 '.$code.' '.$status_string);
39         header('Content-type: text/plain');
40
41         print $msg;
42         print "\n";
43         exit();
44 }
45
46 # Show a user error
47 function common_user_error($msg, $code=400) {
48         static $status = array(400 => 'Bad Request',
49                                                    401 => 'Unauthorized',
50                                                    402 => 'Payment Required',
51                                                    403 => 'Forbidden',
52                                                    404 => 'Not Found',
53                                                    405 => 'Method Not Allowed',
54                                                    406 => 'Not Acceptable',
55                                                    407 => 'Proxy Authentication Required',
56                                                    408 => 'Request Timeout',
57                                                    409 => 'Conflict',
58                                                    410 => 'Gone',
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');
66
67         if (!array_key_exists($code, $status)) {
68                 $code = 400;
69         }
70
71         $status_string = $status[$code];
72
73         header('HTTP/1.1 '.$code.' '.$status_string);
74
75         common_show_header('Error');
76         common_element('div', array('class' => 'error'), $msg);
77         common_show_footer();
78 }
79
80 $xw = null;
81
82 # Start an HTML element
83 function common_element_start($tag, $attrs=NULL) {
84         global $xw;
85         $xw->startElement($tag);
86         if (is_array($attrs)) {
87                 foreach ($attrs as $name => $value) {
88                         $xw->writeAttribute($name, $value);
89                 }
90         } else if (is_string($attrs)) {
91                 $xw->writeAttribute('class', $attrs);
92         }
93 }
94
95 function common_element_end($tag) {
96         static $empty_tag = array('base', 'meta', 'link', 'hr',
97                                                           'br', 'param', 'img', 'area',
98                                                           'input', 'col');
99         global $xw;
100         # XXX: check namespace
101         if (in_array($tag, $empty_tag)) {
102                 $xw->endElement();
103         } else {
104                 $xw->fullEndElement();
105         }
106 }
107
108 function common_element($tag, $attrs=NULL, $content=NULL) {
109         common_element_start($tag, $attrs);
110         global $xw;
111         if (!is_null($content)) {
112                 $xw->text($content);
113         }
114         common_element_end($tag);
115 }
116
117 function common_start_xml($doc=NULL, $public=NULL, $system=NULL) {
118         global $xw;
119         $xw = new XMLWriter();
120         $xw->openURI('php://output');
121         $xw->setIndent(true);
122         $xw->startDocument('1.0', 'UTF-8');
123         if ($doc) {
124                 $xw->writeDTD($doc, $public, $system);
125         }
126 }
127
128 function common_end_xml() {
129         global $xw;
130         $xw->endDocument();
131         $xw->flush();
132 }
133
134 function common_init_language() {
135         mb_internal_encoding('UTF-8');
136         $language = common_language();
137         # So we don't have to make people install the gettext locales
138         putenv('LANGUAGE='.$language);
139         putenv('LANG='.$language);
140         $locale_set = setlocale(LC_ALL, $language . ".utf8",
141                                                         $language . ".UTF8",
142                                                         $language . ".utf-8",
143                                                         $language . ".UTF-8",
144                                                         $language);
145         bindtextdomain("laconica", common_config('site','locale_path'));
146         bind_textdomain_codeset("laconica", "UTF-8");
147         textdomain("laconica");
148         setlocale(LC_CTYPE, 'C');
149         if(!$locale_set) {
150                 common_log(LOG_INFO,'Language requested:'.$language.' - locale could not be set:',__FILE__);
151         }
152 }
153
154 define('PAGE_TYPE_PREFS', 'text/html,application/xhtml+xml,application/xml;q=0.3,text/xml;q=0.2');
155
156 function common_show_header($pagetitle, $callable=NULL, $data=NULL, $headercall=NULL) {
157         
158         global $config, $xw;
159
160         common_start_html();
161         
162         common_element_start('head');
163         common_element('title', NULL,
164                                    $pagetitle . " - " . $config['site']['name']);
165         common_element('link', array('rel' => 'stylesheet',
166                                                                  'type' => 'text/css',
167                                                                  'href' => theme_path('display.css') . '?version=' . LACONICA_VERSION,
168                                                                  'media' => 'screen, projection, tv'));
169         foreach (array(6,7) as $ver) {
170                 if (file_exists(theme_file('ie'.$ver.'.css'))) {
171                         # Yes, IE people should be put in jail.
172                         $xw->writeComment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
173                                                           'href="'.theme_path('ie'.$ver.'.css').'?version='.LACONICA_VERSION.'" /><![endif]');
174                 }
175         }
176
177         common_element('script', array('type' => 'text/javascript',
178                                                                    'src' => common_path('js/jquery.min.js')),
179                                    ' ');
180         common_element('script', array('type' => 'text/javascript',
181                                                                    'src' => common_path('js/jquery.form.js')),
182                                    ' ');
183         common_element('script', array('type' => 'text/javascript',
184                                                                    'src' => common_path('js/xbImportNode.js')),
185                                    ' ');
186         common_element('script', array('type' => 'text/javascript',
187                                                                    'src' => common_path('js/util.js?version='.LACONICA_VERSION)),
188                                    ' ');
189         common_element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
190                                         'href' =>  common_local_url('opensearch', array('type' => 'people')),
191                                         'title' => common_config('site', 'name').' People Search'));
192
193         common_element('link', array('rel' => 'search', 'type' => 'application/opensearchdescription+xml',
194                                         'href' =>  common_local_url('opensearch', array('type' => 'notice')),
195                                         'title' => common_config('site', 'name').' Notice Search'));
196
197         if ($callable) {
198                 if ($data) {
199                         call_user_func($callable, $data);
200                 } else {
201                         call_user_func($callable);
202                 }
203         }
204         common_element_end('head');
205         common_element_start('body');
206         common_element_start('div', array('id' => 'wrap'));
207         common_element_start('div', array('id' => 'header'));
208         common_nav_menu();
209         if ((isset($config['site']['logo']) && is_string($config['site']['logo']) && (strlen($config['site']['logo']) > 0))
210                 || file_exists(theme_file('logo.png')))
211         {
212                 common_element_start('a', array('href' => common_local_url('public')));
213                 common_element('img', array('src' => isset($config['site']['logo']) ?
214                                                                         ($config['site']['logo']) : theme_path('logo.png'),
215                                                                         'alt' => $config['site']['name'],
216                                                                         'id' => 'logo'));
217                 common_element_end('a');
218         } else {
219                 common_element_start('p', array('id' => 'branding'));
220                 common_element('a', array('href' => common_local_url('public')),
221                                            $config['site']['name']);
222                 common_element_end('p');
223         }
224
225         common_element('h1', 'pagetitle', $pagetitle);
226
227         if ($headercall) {
228                 if ($data) {
229                         call_user_func($headercall, $data);
230                 } else {
231                         call_user_func($headercall);
232                 }
233         }
234         common_element_end('div');
235         common_element_start('div', array('id' => 'content'));
236 }
237
238 function common_start_html($type=NULL) {
239         
240         if (!$type) {
241                 $httpaccept = isset($_SERVER['HTTP_ACCEPT']) ? $_SERVER['HTTP_ACCEPT'] : NULL;
242                 
243                 # XXX: allow content negotiation for RDF, RSS, or XRDS
244                 
245                 $type = common_negotiate_type(common_accept_to_prefs($httpaccept),
246                                                                           common_accept_to_prefs(PAGE_TYPE_PREFS));
247                 
248                 if (!$type) {
249                         common_user_error(_('This page is not available in a media type you accept'), 406);
250                         exit(0);
251                 }
252         }
253         
254         header('Content-Type: '.$type);
255
256         common_start_xml('html',
257                                          '-//W3C//DTD XHTML 1.0 Strict//EN',
258                                          'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
259
260         # FIXME: correct language for interface
261
262         $language = common_language();
263
264         common_element_start('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
265                                                                            'xml:lang' => $language,
266                                                                            'lang' => $language));
267 }
268
269 function common_show_footer() {
270         global $xw, $config;
271         common_element_end('div'); # content div
272         common_foot_menu();
273         common_element_start('div', array('id' => 'footer'));
274         common_element_start('div', 'laconica');
275         if (common_config('site', 'broughtby')) {
276                 $instr = _('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
277         } else {
278                 $instr = _('**%%site.name%%** is a microblogging service. ');
279         }
280         $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);
281     $output = common_markup_to_html($instr);
282     common_raw($output);
283         common_element_end('div');
284         common_element('img', array('id' => 'cc',
285                                                                 'src' => $config['license']['image'],
286                                                                 'alt' => $config['license']['title']));
287         common_element_start('p');
288         common_text(_('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
289         common_element('a', array('class' => 'license',
290                                                           'rel' => 'license',
291                                                           'href' => $config['license']['url']),
292                                    $config['license']['title']);
293         common_text(_('. Contributors should be attributed by full name or nickname.'));
294         common_element_end('p');
295         common_element_end('div');
296         common_element_end('div');
297         common_element_end('body');
298         common_element_end('html');
299         common_end_xml();
300 }
301
302 function common_text($txt) {
303         global $xw;
304         $xw->text($txt);
305 }
306
307 function common_raw($xml) {
308         global $xw;
309         $xw->writeRaw($xml);
310 }
311
312 function common_nav_menu() {
313         $user = common_current_user();
314         common_element_start('ul', array('id' => 'nav'));
315         if ($user) {
316                 common_menu_item(common_local_url('all', array('nickname' => $user->nickname)),
317                                                  _('Home'));
318         }
319         common_menu_item(common_local_url('peoplesearch'), _('Search'));
320         if ($user) {
321                 common_menu_item(common_local_url('profilesettings'),
322                                                  _('Settings'));
323                 common_menu_item(common_local_url('invite'),
324                                                  _('Invite'));
325                 common_menu_item(common_local_url('logout'),
326                                                  _('Logout'));
327         } else {
328                 common_menu_item(common_local_url('login'), _('Login'));
329                 if (!common_config('site', 'closed')) {
330                         common_menu_item(common_local_url('register'), _('Register'));
331                 }
332                 common_menu_item(common_local_url('openidlogin'), _('OpenID'));
333         }
334         common_element_end('ul');
335 }
336
337 function common_foot_menu() {
338         common_element_start('ul', array('id' => 'nav_sub'));
339         common_menu_item(common_local_url('doc', array('title' => 'help')),
340                                          _('Help'));
341         common_menu_item(common_local_url('doc', array('title' => 'about')),
342                                          _('About'));
343         common_menu_item(common_local_url('doc', array('title' => 'faq')),
344                                          _('FAQ'));
345         common_menu_item(common_local_url('doc', array('title' => 'privacy')),
346                                          _('Privacy'));
347         common_menu_item(common_local_url('doc', array('title' => 'source')),
348                                          _('Source'));
349         common_menu_item(common_local_url('doc', array('title' => 'contact')),
350                                          _('Contact'));
351         common_element_end('ul');
352 }
353
354 function common_menu_item($url, $text, $title=NULL, $is_selected=false) {
355         $lattrs = array();
356         if ($is_selected) {
357                 $lattrs['class'] = 'current';
358         }
359         common_element_start('li', $lattrs);
360         $attrs['href'] = $url;
361         if ($title) {
362                 $attrs['title'] = $title;
363         }
364         common_element('a', $attrs, $text);
365         common_element_end('li');
366 }
367
368 function common_input($id, $label, $value=NULL,$instructions=NULL) {
369         common_element_start('p');
370         common_element('label', array('for' => $id), $label);
371         $attrs = array('name' => $id,
372                                    'type' => 'text',
373                                    'class' => 'input_text',
374                                    'id' => $id);
375         if ($value) {
376                 $attrs['value'] = htmlspecialchars($value);
377         }
378         common_element('input', $attrs);
379         if ($instructions) {
380                 common_element('span', 'input_instructions', $instructions);
381         }
382         common_element_end('p');
383 }
384
385 function common_checkbox($id, $label, $checked=false, $instructions=NULL, $value='true', $disabled=false)
386 {
387         common_element_start('p');
388         $attrs = array('name' => $id,
389                                    'type' => 'checkbox',
390                                    'class' => 'checkbox',
391                                    'id' => $id);
392         if ($value) {
393                 $attrs['value'] = htmlspecialchars($value);
394         }
395         if ($checked) {
396                 $attrs['checked'] = 'checked';
397         }
398         if ($disabled) {
399                 $attrs['disabled'] = 'true';
400         }
401         common_element('input', $attrs);
402         # XXX: use a <label>
403         common_text(' ');
404         common_element('span', 'checkbox_label', $label);
405         common_text(' ');
406         if ($instructions) {
407                 common_element('span', 'input_instructions', $instructions);
408         }
409         common_element_end('p');
410 }
411
412 function common_dropdown($id, $label, $content, $instructions=NULL, $blank_select=FALSE, $selected=NULL) {
413         common_element_start('p');
414         common_element('label', array('for' => $id), $label);
415         common_element_start('select', array('id' => $id, 'name' => $id));
416         if ($blank_select) {
417                 common_element('option', array('value' => ''));
418         }
419         foreach ($content as $value => $option) {
420                 if ($value == $selected) {
421                         common_element('option', array('value' => $value, 'selected' => $value), $option);
422                 } else {
423                         common_element('option', array('value' => $value), $option);
424                 }
425         }
426         common_element_end('select');
427         if ($instructions) {
428                 common_element('span', 'input_instructions', $instructions);
429         }
430         common_element_end('p');
431 }
432 function common_hidden($id, $value) {
433         common_element('input', array('name' => $id,
434                                                                   'type' => 'hidden',
435                                                                   'id' => $id,
436                                                                   'value' => $value));
437 }
438
439 function common_password($id, $label, $instructions=NULL) {
440         common_element_start('p');
441         common_element('label', array('for' => $id), $label);
442         $attrs = array('name' => $id,
443                                    'type' => 'password',
444                                    'class' => 'password',
445                                    'id' => $id);
446         common_element('input', $attrs);
447         if ($instructions) {
448                 common_element('span', 'input_instructions', $instructions);
449         }
450         common_element_end('p');
451 }
452
453 function common_submit($id, $label, $cls='submit') {
454         global $xw;
455         common_element_start('p');
456         common_element('input', array('type' => 'submit',
457                                                                   'id' => $id,
458                                                                   'name' => $id,
459                                                                   'class' => $cls,
460                                                                   'value' => $label));
461         common_element_end('p');
462 }
463
464 function common_textarea($id, $label, $content=NULL, $instructions=NULL) {
465         common_element_start('p');
466         common_element('label', array('for' => $id), $label);
467         common_element('textarea', array('rows' => 3,
468                                                                          'cols' => 40,
469                                                                          'name' => $id,
470                                                                          'id' => $id),
471                                    ($content) ? $content : '');
472         if ($instructions) {
473                 common_element('span', 'input_instructions', $instructions);
474         }
475         common_element_end('p');
476 }
477
478 function common_timezone() {
479         if (common_logged_in()) {
480                 $user = common_current_user();
481                 if ($user->timezone) {
482                         return $user->timezone;
483                 }
484         }
485
486         global $config;
487         return $config['site']['timezone'];
488 }
489
490 function common_language() {
491
492         // If there is a user logged in and they've set a language preference
493         // then return that one...
494         if (common_logged_in()) {
495                 $user = common_current_user();
496                 $user_language = $user->language;
497                 if ($user_language)
498                         return $user_language;
499         }
500
501         // Otherwise, find the best match for the languages requested by the
502         // user's browser...
503         $httplang = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : NULL;
504         if (!empty($httplang)) {
505                 $language = client_prefered_language($httplang);
506                 if ($language)
507                         return $language;
508         }
509
510         // Finally, if none of the above worked, use the site's default...
511         return common_config('site', 'language');
512 }
513 # salted, hashed passwords are stored in the DB
514
515 function common_munge_password($password, $id) {
516         return md5($password . $id);
517 }
518
519 # check if a username exists and has matching password
520 function common_check_user($nickname, $password) {
521         # NEVER allow blank passwords, even if they match the DB
522         if (mb_strlen($password) == 0) {
523                 return false;
524         }
525         $user = User::staticGet('nickname', $nickname);
526         if (is_null($user)) {
527                 return false;
528         } else {
529                 if (0 == strcmp(common_munge_password($password, $user->id),
530                                                 $user->password)) {
531                         return $user;
532                 } else {
533                         return false;
534                 }
535         }
536 }
537
538 # is the current user logged in?
539 function common_logged_in() {
540         return (!is_null(common_current_user()));
541 }
542
543 function common_have_session() {
544         return (0 != strcmp(session_id(), ''));
545 }
546
547 function common_ensure_session() {
548         if (!common_have_session()) {
549                 @session_start();
550         }
551 }
552
553 # Three kinds of arguments:
554 # 1) a user object
555 # 2) a nickname
556 # 3) NULL to clear
557
558 function common_set_user($user) {
559         if (is_null($user) && common_have_session()) {
560                 unset($_SESSION['userid']);
561                 return true;
562         } else if (is_string($user)) {
563                 $nickname = $user;
564                 $user = User::staticGet('nickname', $nickname);
565         } else if (!($user instanceof User)) {
566                 return false;
567         }
568
569         if ($user) {
570                 common_ensure_session();
571                 $_SESSION['userid'] = $user->id;
572                 return $user;
573         }
574         return false;
575 }
576
577 function common_set_cookie($key, $value, $expiration=0) {
578         $path = common_config('site', 'path');
579         $server = common_config('site', 'server');
580
581         if ($path && ($path != '/')) {
582                 $cookiepath = '/' . $path . '/';
583         } else {
584                 $cookiepath = '/';
585         }
586         return setcookie($key,
587                          $value,
588                                  $expiration,
589                                          $cookiepath,
590                                      $server);
591 }
592
593 define('REMEMBERME', 'rememberme');
594 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60);
595
596 function common_rememberme($user=NULL) {
597         if (!$user) {
598                 $user = common_current_user();
599                 if (!$user) {
600                         common_debug('No current user to remember', __FILE__);
601                         return false;
602                 }
603         }
604         $rm = new Remember_me();
605         $rm->code = common_good_rand(16);
606         $rm->user_id = $user->id;
607         $result = $rm->insert();
608         if (!$result) {
609                 common_log_db_error($rm, 'INSERT', __FILE__);
610                 common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
611                 return false;
612         }
613         common_log(LOG_INFO, 'adding rememberme cookie for ' . $user->nickname);
614         common_set_cookie(REMEMBERME,
615                                           implode(':', array($rm->user_id, $rm->code)),
616                                           time() + REMEMBERME_EXPIRY);
617         return true;
618 }
619
620 function common_remembered_user() {
621         $user = NULL;
622         # Try to remember
623         $packed = isset($_COOKIE[REMEMBERME]) ? $_COOKIE[REMEMBERME] : '';
624         if ($packed) {
625                 list($id, $code) = explode(':', $packed);
626                 if ($id && $code) {
627                         $rm = Remember_me::staticGet($code);
628                         if ($rm && ($rm->user_id == $id)) {
629                                 $user = User::staticGet($rm->user_id);
630                                 if ($user) {
631                                         # successful!
632                                         $result = $rm->delete();
633                                         if (!$result) {
634                                                 common_log_db_error($rm, 'DELETE', __FILE__);
635                                                 $user = NULL;
636                                         } else {
637                                                 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
638                                                 common_set_user($user->nickname);
639                                                 common_real_login(false);
640                                                 # We issue a new cookie, so they can log in
641                                                 # automatically again after this session
642                                                 common_rememberme($user);
643                                         }
644                                 }
645                         }
646                 }
647         }
648         return $user;
649 }
650
651 # must be called with a valid user!
652
653 function common_forgetme() {
654         common_set_cookie(REMEMBERME, '', 0);
655 }
656
657 # who is the current user?
658 function common_current_user() {
659         if (isset($_REQUEST[session_name()]) || (isset($_SESSION['userid']) && $_SESSION['userid'])) {
660                 common_ensure_session();
661                 $id = isset($_SESSION['userid']) ? $_SESSION['userid'] : false;
662                 if ($id) {
663                         # note: this should cache
664                         $user = User::staticGet($id);
665                         return $user;
666                 }
667         }
668         # that didn't work; try to remember
669         $user = common_remembered_user();
670         if ($user) {
671                 common_debug("Got User " . $user->nickname);
672             common_debug("Faking session on remembered user");
673             $_SESSION['userid'] = $user->id;
674         }
675         return $user;
676 }
677
678 # Logins that are 'remembered' aren't 'real' -- they're subject to
679 # cookie-stealing. So, we don't let them do certain things. New reg,
680 # OpenID, and password logins _are_ real.
681
682 function common_real_login($real=true) {
683         common_ensure_session();
684         $_SESSION['real_login'] = $real;
685 }
686
687 function common_is_real_login() {
688         return common_logged_in() && $_SESSION['real_login'];
689 }
690
691 # get canonical version of nickname for comparison
692 function common_canonical_nickname($nickname) {
693         # XXX: UTF-8 canonicalization (like combining chars)
694         return strtolower($nickname);
695 }
696
697 # get canonical version of email for comparison
698 function common_canonical_email($email) {
699         # XXX: canonicalize UTF-8
700         # XXX: lcase the domain part
701         return $email;
702 }
703
704 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$_+!*();/?:~-]))');
705
706 function common_render_content($text, $notice) {
707         $r = common_render_text($text);
708         $id = $notice->profile_id;
709         $r = preg_replace('/(^|\s+)@([A-Za-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
710         $r = preg_replace('/^T ([A-Z0-9]{1,64}) /e', "'T '.common_at_link($id, '\\1').' '", $r);
711         return $r;
712 }
713
714 function common_render_text($text) {
715         $r = htmlspecialchars($text);
716
717         $r = preg_replace('/[\x{0}-\x{8}\x{b}-\x{c}\x{e}-\x{19}]/', '', $r);
718         $r = preg_replace_callback('@https?://[^\]>\s]+@', 'common_render_uri_thingy', $r);
719         $r = preg_replace('/(^|\s+)#([A-Za-z0-9_\-\.]{1,64})/e', "'\\1#'.common_tag_link('\\2')", $r);
720         # XXX: machine tags
721         return $r;
722 }
723
724 function common_render_uri_thingy($matches) {
725         $uri = $matches[0];
726         $trailer = '';
727
728         # Some heuristics for extracting URIs from surrounding punctuation
729         # Strip from trailing text...
730         if (preg_match('/^(.*)([,.:"\']+)$/', $uri, $matches)) {
731                 $uri = $matches[1];
732                 $trailer = $matches[2];
733         }
734
735         $pairs = array(
736                 ']' => '[', # technically disallowed in URIs, but used in Java docs
737                 ')' => '(', # far too frequent in Wikipedia and MSDN
738         );
739         $final = substr($uri, -1, 1);
740         if (isset($pairs[$final])) {
741                 $openers = substr_count($uri, $pairs[$final]);
742                 $closers = substr_count($uri, $final);
743                 if ($closers > $openers) {
744                         // Assume the paren was opened outside the URI
745                         $uri = substr($uri, 0, -1);
746                         $trailer = $final . $trailer;
747                 }
748         }
749         if ($longurl = common_longurl($uri)) {
750                 $longurl = htmlentities($longurl, ENT_QUOTES, 'UTF-8');
751                 $title = " title='$longurl'";
752         }
753         else $title = '';
754         
755         return '<a href="' . $uri . '"' . $title . ' class="extlink">' . $uri . '</a>' . $trailer;
756 }
757
758 function common_longurl($uri)  {
759         $uri_e = urlencode($uri);
760         $longurl = unserialize(file_get_contents("http://api.longurl.org/v1/expand?format=php&url=$uri_e"));
761         if (empty($longurl['long_url']) || $uri === $longurl['long_url']) return false;
762         return stripslashes($longurl['long_url']);
763 }
764
765 function common_shorten_links($text) {
766     // \s = not a horizontal whitespace character (since PHP 5.2.4)
767         // RYM this should prevent * preceded URLs from being processed but it its a char
768 //      $r = preg_replace('@[^*](https?://[^)\]>\s]+)@e', "common_shorten_link('\\1')", $r);
769         return preg_replace('@https?://[^)\]>\s]+@e', "common_shorten_link('\\0')", $text);
770 }
771
772 function common_shorten_link($long_url) {
773         
774         $user = common_current_user();
775         
776         $curlh = curl_init();
777         curl_setopt($curlh, CURLOPT_CONNECTTIMEOUT, 20); // # seconds to wait
778         curl_setopt($curlh, CURLOPT_USERAGENT, 'Laconica');
779         curl_setopt($curlh, CURLOPT_RETURNTRANSFER, true);
780         
781         switch($user->urlshorteningservice) {
782         case 'ur1.ca':
783             $short_url_service = new LilUrl;
784             $short_url = $short_url_service->shorten($long_url);
785             break;
786             
787         case '2tu.us':
788             $short_url_service = new TightUrl;
789             $short_url = $short_url_service->shorten($long_url);
790             break;
791             
792         case 'ptiturl.com':
793             $short_url_service = new PtitUrl;
794             $short_url = $short_url_service->shorten($long_url);
795             break;
796
797         case 'bit.ly':
798                         curl_setopt($curlh, CURLOPT_URL, 'http://bit.ly/api?method=shorten&long_url='.urlencode($long_url));
799                         $short_url = current(json_decode(curl_exec($curlh))->results)->hashUrl;
800             break;
801
802                 case 'is.gd':
803                         curl_setopt($curlh, CURLOPT_URL, 'http://is.gd/api.php?longurl='.urlencode($long_url));
804                         $short_url = curl_exec($curlh);
805                         break;
806                 case 'snipr.com':
807                         curl_setopt($curlh, CURLOPT_URL, 'http://snipr.com/site/snip?r=simple&link='.urlencode($long_url));
808                         $short_url = curl_exec($curlh);
809                         break;
810                 case 'metamark.net':
811                         curl_setopt($curlh, CURLOPT_URL, 'http://metamark.net/api/rest/simple?long_url='.urlencode($long_url));
812                         $short_url = curl_exec($curlh);
813                         break;
814                 case 'tinyurl.com':
815                         curl_setopt($curlh, CURLOPT_URL, 'http://tinyurl.com/api-create.php?url='.urlencode($long_url));
816                         $short_url = curl_exec($curlh);
817                         break;
818                 default:
819                         $short_url = false;
820         }
821         
822         curl_close($curlh);
823         
824         if ($short_url) {
825                 return $short_url;
826         }
827         return $long_url;
828 }
829
830 function common_xml_safe_str($str) {
831         $xmlStr = htmlentities(iconv('UTF-8', 'UTF-8//IGNORE', $str), ENT_NOQUOTES, 'UTF-8');
832         
833         // Replace control, formatting, and surrogate characters with '*', ala Twitter
834         return preg_replace('/[\p{Cc}\p{Cf}\p{Cs}]/u', '*', $str);
835 }
836
837 function common_tag_link($tag) {
838         $canonical = common_canonical_tag($tag);
839         $url = common_local_url('tag', array('tag' => $canonical));
840         return '<a href="' . htmlspecialchars($url) . '" rel="tag" class="hashlink">' . htmlspecialchars($tag) . '</a>';
841 }
842
843 function common_canonical_tag($tag) {  
844         return strtolower(str_replace(array('-', '_', '.'), '', $tag));
845 }
846
847 function common_at_link($sender_id, $nickname) {
848         $sender = Profile::staticGet($sender_id);
849         $recipient = common_relative_profile($sender, common_canonical_nickname($nickname));
850         if ($recipient) {
851                 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink">'.$nickname.'</a>';
852         } else {
853                 return $nickname;
854         }
855 }
856
857 function common_relative_profile($sender, $nickname, $dt=NULL) {
858         # Try to find profiles this profile is subscribed to that have this nickname
859         $recipient = new Profile();
860         # XXX: use a join instead of a subquery
861         $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender->id.' and subscribed = id)', 'AND');
862         $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
863         if ($recipient->find(TRUE)) {
864                 # XXX: should probably differentiate between profiles with
865                 # the same name by date of most recent update
866                 return $recipient;
867         }
868         # Try to find profiles that listen to this profile and that have this nickname
869         $recipient = new Profile();
870         # XXX: use a join instead of a subquery
871         $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender->id.' and subscriber = id)', 'AND');
872         $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
873         if ($recipient->find(TRUE)) {
874                 # XXX: should probably differentiate between profiles with
875                 # the same name by date of most recent update
876                 return $recipient;
877         }
878         # If this is a local user, try to find a local user with that nickname.
879         $sender = User::staticGet($sender->id);
880         if ($sender) {
881                 $recipient_user = User::staticGet('nickname', $nickname);
882                 if ($recipient_user) {
883                         return $recipient_user->getProfile();
884                 }
885         }
886         # Otherwise, no links. @messages from local users to remote users,
887         # or from remote users to other remote users, are just
888         # outside our ability to make intelligent guesses about
889         return NULL;
890 }
891
892 // where should the avatar go for this user?
893
894 function common_avatar_filename($id, $extension, $size=NULL, $extra=NULL) {
895         global $config;
896
897         if ($size) {
898                 return $id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
899         } else {
900                 return $id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
901         }
902 }
903
904 function common_avatar_path($filename) {
905         global $config;
906         return INSTALLDIR . '/avatar/' . $filename;
907 }
908
909 function common_avatar_url($filename) {
910         return common_path('avatar/'.$filename);
911 }
912
913 function common_avatar_display_url($avatar) {
914         $server = common_config('avatar', 'server');
915         if ($server) {
916                 return 'http://'.$server.'/'.$avatar->filename;
917         } else {
918                 return $avatar->url;
919         }
920 }
921
922 function common_default_avatar($size) {
923         static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
924                                                           AVATAR_STREAM_SIZE => 'stream',
925                                                           AVATAR_MINI_SIZE => 'mini');
926         return theme_path('default-avatar-'.$sizenames[$size].'.png');
927 }
928
929 function common_local_url($action, $args=NULL, $fragment=NULL) {
930         $url = NULL;
931         if (common_config('site','fancy')) {
932                 $url = common_fancy_url($action, $args);
933         } else {
934                 $url = common_simple_url($action, $args);
935         }
936         if (!is_null($fragment)) {
937                 $url .= '#'.$fragment;
938         }
939         return $url;
940 }
941
942 function common_fancy_url($action, $args=NULL) {
943         switch (strtolower($action)) {
944          case 'public':
945                 if ($args && isset($args['page'])) {
946                         return common_path('?page=' . $args['page']);
947                 } else {
948                         return common_path('');
949                 }
950          case 'featured':
951                 if ($args && isset($args['page'])) {
952                         return common_path('featured?page=' . $args['page']);
953                 } else {
954                         return common_path('featured');
955                 }
956          case 'favorited':
957                 if ($args && isset($args['page'])) {
958                         return common_path('favorited?page=' . $args['page']);
959                 } else {
960                         return common_path('favorited');
961                 }
962          case 'publicrss':
963                 return common_path('rss');
964          case 'publicxrds':
965                 return common_path('xrds');
966          case 'featuredrss':
967                 return common_path('featuredrss');
968          case 'favoritedrss':
969                 return common_path('favoritedrss');
970          case 'opensearch':
971                 if ($args && $args['type']) {
972                         return common_path('opensearch/'.$args['type']);
973                 } else {
974                         return common_path('opensearch/people');
975                 }
976          case 'doc':
977                 return common_path('doc/'.$args['title']);
978          case 'login':
979          case 'logout':
980          case 'subscribe':
981          case 'unsubscribe':
982          case 'invite':
983                 return common_path('main/'.$action);
984          case 'register':
985                 if ($args && $args['code']) {
986                         return common_path('main/register/'.$args['code']);
987                 } else {
988                         return common_path('main/register');
989                 }
990          case 'remotesubscribe':
991                 if ($args && $args['nickname']) {
992                         return common_path('main/remote?nickname=' . $args['nickname']);
993                 } else {
994                         return common_path('main/remote');
995                 }
996          case 'nudge':
997                 return common_path($args['nickname'].'/nudge');
998          case 'openidlogin':
999                 return common_path('main/openid');
1000          case 'profilesettings':
1001                 return common_path('settings/profile');
1002          case 'emailsettings':
1003                 return common_path('settings/email');
1004          case 'openidsettings':
1005                 return common_path('settings/openid');
1006          case 'smssettings':
1007                 return common_path('settings/sms');
1008          case 'twittersettings':
1009                 return common_path('settings/twitter');
1010          case 'othersettings':
1011                 return common_path('settings/other');
1012          case 'newnotice':
1013                 if ($args && $args['replyto']) {
1014                         return common_path('notice/new?replyto='.$args['replyto']);
1015                 } else {
1016                         return common_path('notice/new');
1017                 }
1018          case 'shownotice':
1019                 return common_path('notice/'.$args['notice']);
1020          case 'deletenotice':
1021                 if ($args && $args['notice']) {
1022                         return common_path('notice/delete/'.$args['notice']);
1023                 } else {
1024                         return common_path('notice/delete');
1025                 }
1026          case 'xrds':
1027          case 'foaf':
1028                 return common_path($args['nickname'].'/'.$action);
1029          case 'all':
1030          case 'replies':
1031          case 'inbox':
1032          case 'outbox':
1033                 if ($args && isset($args['page'])) {
1034                         return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
1035                 } else {
1036                         return common_path($args['nickname'].'/'.$action);
1037                 }
1038          case 'subscriptions':
1039          case 'subscribers':
1040                 $nickname = $args['nickname'];
1041                 unset($args['nickname']);
1042                 $params = http_build_query($args);
1043                 if ($params) {
1044                         return common_path($nickname.'/'.$action . '?' . $params);
1045                 } else {
1046                         return common_path($nickname.'/'.$action);
1047                 }
1048          case 'allrss':
1049                 return common_path($args['nickname'].'/all/rss');
1050          case 'repliesrss':
1051                 return common_path($args['nickname'].'/replies/rss');
1052          case 'userrss':
1053                 return common_path($args['nickname'].'/rss');
1054          case 'showstream':
1055                 if ($args && isset($args['page'])) {
1056                         return common_path($args['nickname'].'?page=' . $args['page']);
1057                 } else {
1058                         return common_path($args['nickname']);
1059                 }
1060
1061          case 'usertimeline':
1062                 return common_path("api/statuses/user_timeline/".$args['nickname'].".atom");
1063          case 'confirmaddress':
1064                 return common_path('main/confirmaddress/'.$args['code']);
1065          case 'userbyid':
1066                 return common_path('user/'.$args['id']);
1067          case 'recoverpassword':
1068             $path = 'main/recoverpassword';
1069             if ($args['code']) {
1070                 $path .= '/' . $args['code'];
1071                 }
1072             return common_path($path);
1073          case 'imsettings':
1074                 return common_path('settings/im');
1075          case 'peoplesearch':
1076                 return common_path('search/people' . (($args) ? ('?' . http_build_query($args)) : ''));
1077          case 'noticesearch':
1078                 return common_path('search/notice' . (($args) ? ('?' . http_build_query($args)) : ''));
1079          case 'noticesearchrss':
1080                 return common_path('search/notice/rss' . (($args) ? ('?' . http_build_query($args)) : ''));
1081          case 'avatarbynickname':
1082                 return common_path($args['nickname'].'/avatar/'.$args['size']);
1083          case 'tag':
1084             if (isset($args['tag']) && $args['tag']) {
1085                         $path = 'tag/' . $args['tag'];
1086                         unset($args['tag']);
1087                 } else {
1088                         $path = 'tags';
1089                 }
1090                 return common_path($path . (($args) ? ('?' . http_build_query($args)) : ''));
1091          case 'tags':
1092                 return common_path('tags' . (($args) ? ('?' . http_build_query($args)) : ''));
1093          case 'favor':
1094                 return common_path('main/favor');
1095          case 'disfavor':
1096                 return common_path('main/disfavor');
1097          case 'showfavorites':
1098                 if ($args && isset($args['page'])) {
1099                         return common_path($args['nickname'].'/favorites?page=' . $args['page']);
1100                 } else {
1101                         return common_path($args['nickname'].'/favorites');
1102                 }
1103          case 'favoritesrss':
1104                 return common_path($args['nickname'].'/favorites/rss');
1105          case 'showmessage':
1106                 return common_path('message/' . $args['message']);
1107          case 'newmessage':
1108                 return common_path('message/new' . (($args) ? ('?' . http_build_query($args)) : ''));
1109          case 'api':
1110                 # XXX: do fancy URLs for all the API methods
1111                 switch (strtolower($args['apiaction'])) {
1112                  case 'statuses':
1113                         switch (strtolower($args['method'])) {
1114                          case 'user_timeline.rss':
1115                                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.rss');
1116                          case 'user_timeline.atom':
1117                                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.rss');
1118                          case 'user_timeline.rss':
1119                                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.rss');
1120                          case 'user_timeline.atom':
1121                                 return common_path('api/statuses/user_timeline/'.$args['argument'].'.rss');
1122                          default: return common_simple_url($action, $args);
1123                         }
1124                  default: return common_simple_url($action, $args);
1125                 }
1126          case 'sup':
1127                 if ($args && isset($args['seconds'])) {
1128                         return common_path('main/sup?seconds='.$args['seconds']);
1129                 } else {
1130                         return common_path('main/sup');
1131                 }
1132          default:
1133                 return common_simple_url($action, $args);
1134         }
1135 }
1136
1137 function common_simple_url($action, $args=NULL) {
1138         global $config;
1139         /* XXX: pretty URLs */
1140         $extra = '';
1141         if ($args) {
1142                 foreach ($args as $key => $value) {
1143                         $extra .= "&${key}=${value}";
1144                 }
1145         }
1146         return common_path("index.php?action=${action}${extra}");
1147 }
1148
1149 function common_path($relative) {
1150         global $config;
1151         $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
1152         return "http://".$config['site']['server'].'/'.$pathpart.$relative;
1153 }
1154
1155 function common_date_string($dt) {
1156         // XXX: do some sexy date formatting
1157         // return date(DATE_RFC822, $dt);
1158         $t = strtotime($dt);
1159         $now = time();
1160         $diff = $now - $t;
1161
1162         if ($now < $t) { # that shouldn't happen!
1163                 return common_exact_date($dt);
1164         } else if ($diff < 60) {
1165                 return _('a few seconds ago');
1166         } else if ($diff < 92) {
1167                 return _('about a minute ago');
1168         } else if ($diff < 3300) {
1169                 return sprintf(_('about %d minutes ago'), round($diff/60));
1170         } else if ($diff < 5400) {
1171                 return _('about an hour ago');
1172         } else if ($diff < 22 * 3600) {
1173                 return sprintf(_('about %d hours ago'), round($diff/3600));
1174         } else if ($diff < 37 * 3600) {
1175                 return _('about a day ago');
1176         } else if ($diff < 24 * 24 * 3600) {
1177                 return sprintf(_('about %d days ago'), round($diff/(24*3600)));
1178         } else if ($diff < 46 * 24 * 3600) {
1179                 return _('about a month ago');
1180         } else if ($diff < 330 * 24 * 3600) {
1181                 return sprintf(_('about %d months ago'), round($diff/(30*24*3600)));
1182         } else if ($diff < 480 * 24 * 3600) {
1183                 return _('about a year ago');
1184         } else {
1185                 return common_exact_date($dt);
1186         }
1187 }
1188
1189 function common_exact_date($dt) {
1190     static $_utc;
1191     static $_siteTz;
1192
1193     if (!$_utc) {
1194         $_utc = new DateTimeZone('UTC');
1195         $_siteTz = new DateTimeZone(common_timezone());
1196     }
1197
1198         $dateStr = date('d F Y H:i:s', strtotime($dt));
1199         $d = new DateTime($dateStr, $_utc);
1200         $d->setTimezone($_siteTz);
1201         return $d->format(DATE_RFC850);
1202 }
1203
1204 function common_date_w3dtf($dt) {
1205         $dateStr = date('d F Y H:i:s', strtotime($dt));
1206         $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1207         $d->setTimezone(new DateTimeZone(common_timezone()));
1208         return $d->format(DATE_W3C);
1209 }
1210
1211 function common_date_rfc2822($dt) {
1212         $dateStr = date('d F Y H:i:s', strtotime($dt));
1213         $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1214         $d->setTimezone(new DateTimeZone(common_timezone()));
1215         return $d->format('r');
1216 }
1217
1218 function common_date_iso8601($dt) {
1219         $dateStr = date('d F Y H:i:s', strtotime($dt));
1220         $d = new DateTime($dateStr, new DateTimeZone('UTC'));
1221         $d->setTimezone(new DateTimeZone(common_timezone()));
1222         return $d->format('c');
1223 }
1224
1225 function common_sql_now() {
1226         return strftime('%Y-%m-%d %H:%M:%S', time());
1227 }
1228
1229 function common_redirect($url, $code=307) {
1230         static $status = array(301 => "Moved Permanently",
1231                                                    302 => "Found",
1232                                                    303 => "See Other",
1233                                                    307 => "Temporary Redirect");
1234         header("Status: ${code} $status[$code]");
1235         header("Location: $url");
1236
1237         common_start_xml('a',
1238                                          '-//W3C//DTD XHTML 1.0 Strict//EN',
1239                                          'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
1240         common_element('a', array('href' => $url), $url);
1241         common_end_xml();
1242     exit;
1243 }
1244
1245 function common_save_replies($notice) {
1246         # Alternative reply format
1247         $tname = false;
1248         if (preg_match('/^T ([A-Z0-9]{1,64}) /', $notice->content, $match)) {
1249                 $tname = $match[1];
1250         }
1251         # extract all @messages
1252         $cnt = preg_match_all('/(?:^|\s)@([a-z0-9]{1,64})/', $notice->content, $match);
1253         if (!$cnt && !$tname) {
1254                 return true;
1255         }
1256         # XXX: is there another way to make an array copy?
1257         $names = ($tname) ? array_unique(array_merge(array(strtolower($tname)), $match[1])) : array_unique($match[1]);
1258         $sender = Profile::staticGet($notice->profile_id);
1259         # store replied only for first @ (what user/notice what the reply directed,
1260         # we assume first @ is it)
1261         for ($i=0; $i<count($names); $i++) {
1262                 $nickname = $names[$i];
1263                 $recipient = common_relative_profile($sender, $nickname, $notice->created);
1264                 if (!$recipient) {
1265                         continue;
1266                 }
1267                 if ($i == 0 && ($recipient->id != $sender->id) && !$notice->reply_to) { # Don't save reply to self
1268                         $reply_for = $recipient;
1269                         $recipient_notice = $reply_for->getCurrentNotice();
1270                         if ($recipient_notice) {
1271                                 $orig = clone($notice);
1272                                 $notice->reply_to = $recipient_notice->id;
1273                                 $notice->update($orig);
1274                         }
1275                 }
1276                 $reply = new Reply();
1277                 $reply->notice_id = $notice->id;
1278                 $reply->profile_id = $recipient->id;
1279                 $id = $reply->insert();
1280                 if (!$id) {
1281                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1282                         common_log(LOG_ERR, 'DB error inserting reply: ' . $last_error->message);
1283                         common_server_error(sprintf(_('DB error inserting reply: %s'), $last_error->message));
1284                         return;
1285                 }
1286         }
1287 }
1288
1289 function common_broadcast_notice($notice, $remote=false) {
1290
1291         // Check to see if notice should go to Twitter
1292         $flink = Foreign_link::getByUserID($notice->profile_id, 1); // 1 == Twitter
1293         if (($flink->noticesync & FOREIGN_NOTICE_SEND) == FOREIGN_NOTICE_SEND) {
1294
1295                 // If it's not a Twitter-style reply, or if the user WANTS to send replies...
1296
1297                 if (!preg_match('/^@[a-zA-Z0-9_]{1,15}\b/u', $notice->content) ||
1298                         (($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) == FOREIGN_NOTICE_SEND_REPLY)) {
1299
1300                         $result = common_twitter_broadcast($notice, $flink);
1301
1302                         if (!$result) {
1303                                 common_debug('Unable to send notice: ' . $notice->id . ' to Twitter.', __FILE__);
1304                         }
1305                 }
1306         }
1307
1308         if (common_config('queue', 'enabled')) {
1309                 # Do it later!
1310                 return common_enqueue_notice($notice);
1311         } else {
1312                 return common_real_broadcast($notice, $remote);
1313         }
1314 }
1315
1316 function common_twitter_broadcast($notice, $flink) {
1317         global $config;
1318         $success = true;
1319         $fuser = $flink->getForeignUser();
1320         $twitter_user = $fuser->nickname;
1321         $twitter_password = $flink->credentials;
1322         $uri = 'http://www.twitter.com/statuses/update.json';
1323
1324         // XXX: Hack to get around PHP cURL's use of @ being a a meta character
1325         $statustxt = preg_replace('/^@/', ' @', $notice->content);
1326
1327         $options = array(
1328                 CURLOPT_USERPWD                 => "$twitter_user:$twitter_password",
1329                 CURLOPT_POST                    => true,
1330                 CURLOPT_POSTFIELDS              => array(
1331                                                                         'status'        => $statustxt,
1332                                                                         'source'        => $config['integration']['source']
1333                                                                         ),
1334                 CURLOPT_RETURNTRANSFER  => true,
1335                 CURLOPT_FAILONERROR             => true,
1336                 CURLOPT_HEADER                  => false,
1337                 CURLOPT_FOLLOWLOCATION  => true,
1338                 CURLOPT_USERAGENT               => "Laconica",
1339                 CURLOPT_CONNECTTIMEOUT  => 120,  // XXX: Scary!!!! How long should this be?
1340                 CURLOPT_TIMEOUT                 => 120
1341         );
1342
1343         $ch = curl_init($uri);
1344     curl_setopt_array($ch, $options);
1345     $data = curl_exec($ch);
1346     $errmsg = curl_error($ch);
1347
1348         if ($errmsg) {
1349                 common_debug("cURL error: $errmsg - trying to send notice for $twitter_user.",
1350                         __FILE__);
1351                 $success = false;
1352         }
1353
1354         curl_close($ch);
1355
1356         if (!$data) {
1357                 common_debug("No data returned by Twitter's API trying to send update for $twitter_user",
1358                         __FILE__);
1359                 $success = false;
1360         }
1361
1362         // Twitter should return a status
1363         $status = json_decode($data);
1364
1365         if (!$status->id) {
1366                 common_debug("Unexpected data returned by Twitter API trying to send update for $twitter_user",
1367                         __FILE__);
1368                 $success = false;
1369         }
1370
1371         return $success;
1372 }
1373
1374 # Stick the notice on the queue
1375
1376 function common_enqueue_notice($notice) {
1377         foreach (array('jabber', 'omb', 'sms', 'public') as $transport) {
1378                 $qi = new Queue_item();
1379                 $qi->notice_id = $notice->id;
1380                 $qi->transport = $transport;
1381                 $qi->created = $notice->created;
1382         $result = $qi->insert();
1383                 if (!$result) {
1384                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1385                         common_log(LOG_ERR, 'DB error inserting queue item: ' . $last_error->message);
1386                         return false;
1387                 }
1388                 common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id . ' for ' . $transport);
1389         }
1390         return $result;
1391 }
1392
1393 function common_dequeue_notice($notice) {
1394         $qi = Queue_item::staticGet($notice->id);
1395         if ($qi) {
1396                 $result = $qi->delete();
1397                 if (!$result) {
1398                     $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1399                     common_log(LOG_ERR, 'DB error deleting queue item: ' . $last_error->message);
1400                     return false;
1401                 }
1402                 common_log(LOG_DEBUG, 'complete dequeueing notice ID = ' . $notice->id);
1403                 return $result;
1404         } else {
1405             return false;
1406         }
1407 }
1408
1409 function common_real_broadcast($notice, $remote=false) {
1410         $success = true;
1411         if (!$remote) {
1412                 # Make sure we have the OMB stuff
1413                 require_once(INSTALLDIR.'/lib/omb.php');
1414                 $success = omb_broadcast_remote_subscribers($notice);
1415                 if (!$success) {
1416                         common_log(LOG_ERR, 'Error in OMB broadcast for notice ' . $notice->id);
1417                 }
1418         }
1419         if ($success) {
1420                 require_once(INSTALLDIR.'/lib/jabber.php');
1421                 $success = jabber_broadcast_notice($notice);
1422                 if (!$success) {
1423                         common_log(LOG_ERR, 'Error in jabber broadcast for notice ' . $notice->id);
1424                 }
1425         }
1426         if ($success) {
1427                 require_once(INSTALLDIR.'/lib/mail.php');
1428                 $success = mail_broadcast_notice_sms($notice);
1429                 if (!$success) {
1430                         common_log(LOG_ERR, 'Error in sms broadcast for notice ' . $notice->id);
1431                 }
1432         }
1433         if ($success) {
1434                 $success = jabber_public_notice($notice);
1435                 if (!$success) {
1436                         common_log(LOG_ERR, 'Error in public broadcast for notice ' . $notice->id);
1437                 }
1438         }
1439         // XXX: broadcast notices to other IM
1440         return $success;
1441 }
1442
1443 function common_broadcast_profile($profile) {
1444         // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
1445         require_once(INSTALLDIR.'/lib/omb.php');
1446         omb_broadcast_profile($profile);
1447         // XXX: Other broadcasts...?
1448         return true;
1449 }
1450
1451 function common_profile_url($nickname) {
1452         return common_local_url('showstream', array('nickname' => $nickname));
1453 }
1454
1455 # Don't call if nobody's logged in
1456
1457 function common_notice_form($action=NULL, $content=NULL) {
1458         $user = common_current_user();
1459         assert(!is_null($user));
1460         common_element_start('form', array('id' => 'status_form',
1461                                                                            'method' => 'post',
1462                                                                            'action' => common_local_url('newnotice')));
1463         common_element_start('p');
1464         common_element('label', array('for' => 'status_textarea',
1465                                                                   'id' => 'status_label'),
1466                                    sprintf(_('What\'s up, %s?'), $user->nickname));
1467     common_element('span', array('id' => 'counter', 'class' => 'counter'), '140');
1468         common_element('textarea', array('id' => 'status_textarea',
1469                                                                          'cols' => 60,
1470                                                                          'rows' => 3,
1471                                                                          'name' => 'status_textarea'),
1472                                    ($content) ? $content : '');
1473         common_hidden('token', common_session_token());
1474         if ($action) {
1475                 common_hidden('returnto', $action);
1476         }
1477         # set by JavaScript
1478         common_hidden('inreplyto', 'false');
1479         common_element('input', array('id' => 'status_submit',
1480                                                                   'name' => 'status_submit',
1481                                                                   'type' => 'submit',
1482                                                                   'value' => _('Send')));
1483         common_element_end('p');
1484         common_element_end('form');
1485 }
1486
1487 # Should make up a reasonable root URL
1488
1489 function common_root_url() {
1490         return common_path('');
1491 }
1492
1493 # returns $bytes bytes of random data as a hexadecimal string
1494 # "good" here is a goal and not a guarantee
1495
1496 function common_good_rand($bytes) {
1497         # XXX: use random.org...?
1498         if (file_exists('/dev/urandom')) {
1499                 return common_urandom($bytes);
1500         } else { # FIXME: this is probably not good enough
1501                 return common_mtrand($bytes);
1502         }
1503 }
1504
1505 function common_urandom($bytes) {
1506         $h = fopen('/dev/urandom', 'rb');
1507         # should not block
1508         $src = fread($h, $bytes);
1509         fclose($h);
1510         $enc = '';
1511         for ($i = 0; $i < $bytes; $i++) {
1512                 $enc .= sprintf("%02x", (ord($src[$i])));
1513         }
1514         return $enc;
1515 }
1516
1517 function common_mtrand($bytes) {
1518         $enc = '';
1519         for ($i = 0; $i < $bytes; $i++) {
1520                 $enc .= sprintf("%02x", mt_rand(0, 255));
1521         }
1522         return $enc;
1523 }
1524
1525 function common_set_returnto($url) {
1526         common_ensure_session();
1527         $_SESSION['returnto'] = $url;
1528 }
1529
1530 function common_get_returnto() {
1531         common_ensure_session();
1532         return $_SESSION['returnto'];
1533 }
1534
1535 function common_timestamp() {
1536         return date('YmdHis');
1537 }
1538
1539 function common_ensure_syslog() {
1540         static $initialized = false;
1541         if (!$initialized) {
1542                 global $config;
1543                 openlog($config['syslog']['appname'], 0, LOG_USER);
1544                 $initialized = true;
1545         }
1546 }
1547
1548 function common_log($priority, $msg, $filename=NULL) {
1549         $logfile = common_config('site', 'logfile');
1550         if ($logfile) {
1551                 $log = fopen($logfile, "a");
1552                 if ($log) {
1553                         static $syslog_priorities = array('LOG_EMERG', 'LOG_ALERT', 'LOG_CRIT', 'LOG_ERR',
1554                                                                                           'LOG_WARNING', 'LOG_NOTICE', 'LOG_INFO', 'LOG_DEBUG');
1555                         $output = date('Y-m-d H:i:s') . ' ' . $syslog_priorities[$priority] . ': ' . $msg . "\n";
1556                         fwrite($log, $output);
1557                         fclose($log);
1558                 }
1559         } else {
1560                 common_ensure_syslog();
1561                 syslog($priority, $msg);
1562         }
1563 }
1564
1565 function common_debug($msg, $filename=NULL) {
1566         if ($filename) {
1567                 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1568         } else {
1569                 common_log(LOG_DEBUG, $msg);
1570         }
1571 }
1572
1573 function common_log_db_error(&$object, $verb, $filename=NULL) {
1574         $objstr = common_log_objstring($object);
1575         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1576         common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1577 }
1578
1579 function common_log_objstring(&$object) {
1580         if (is_null($object)) {
1581                 return "NULL";
1582         }
1583         $arr = $object->toArray();
1584         $fields = array();
1585         foreach ($arr as $k => $v) {
1586                 $fields[] = "$k='$v'";
1587         }
1588         $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1589         return $objstring;
1590 }
1591
1592 function common_valid_http_url($url) {
1593         return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1594 }
1595
1596 function common_valid_tag($tag) {
1597         if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1598                 return (Validate::email($matches[1]) ||
1599                                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1600         }
1601         return false;
1602 }
1603
1604 # Does a little before-after block for next/prev page
1605
1606 function common_pagination($have_before, $have_after, $page, $action, $args=NULL) {
1607
1608         if ($have_before || $have_after) {
1609                 common_element_start('div', array('id' => 'pagination'));
1610                 common_element_start('ul', array('id' => 'nav_pagination'));
1611         }
1612
1613         if ($have_before) {
1614                 $pargs = array('page' => $page-1);
1615                 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
1616
1617                 common_element_start('li', 'before');
1618                 common_element('a', array('href' => common_local_url($action, $newargs)),
1619                                            _('« After'));
1620                 common_element_end('li');
1621         }
1622
1623         if ($have_after) {
1624                 $pargs = array('page' => $page+1);
1625                 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
1626                 common_element_start('li', 'after');
1627                 common_element('a', array('href' => common_local_url($action, $newargs)),
1628                                                    _('Before Â»'));
1629                 common_element_end('li');
1630         }
1631
1632         if ($have_before || $have_after) {
1633                 common_element_end('ul');
1634                 common_element_end('div');
1635         }
1636 }
1637
1638 /* Following functions are copied from MediaWiki GlobalFunctions.php
1639  * and written by Evan Prodromou. */
1640
1641 function common_accept_to_prefs($accept, $def = '*/*') {
1642         # No arg means accept anything (per HTTP spec)
1643         if(!$accept) {
1644                 return array($def => 1);
1645         }
1646
1647         $prefs = array();
1648
1649         $parts = explode(',', $accept);
1650
1651         foreach($parts as $part) {
1652                 # FIXME: doesn't deal with params like 'text/html; level=1'
1653                 @list($value, $qpart) = explode(';', $part);
1654                 $match = array();
1655                 if(!isset($qpart)) {
1656                         $prefs[$value] = 1;
1657                 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1658                         $prefs[$value] = $match[1];
1659                 }
1660         }
1661
1662         return $prefs;
1663 }
1664
1665 function common_mime_type_match($type, $avail) {
1666         if(array_key_exists($type, $avail)) {
1667                 return $type;
1668         } else {
1669                 $parts = explode('/', $type);
1670                 if(array_key_exists($parts[0] . '/*', $avail)) {
1671                         return $parts[0] . '/*';
1672                 } elseif(array_key_exists('*/*', $avail)) {
1673                         return '*/*';
1674                 } else {
1675                         return NULL;
1676                 }
1677         }
1678 }
1679
1680 function common_negotiate_type($cprefs, $sprefs) {
1681         $combine = array();
1682
1683         foreach(array_keys($sprefs) as $type) {
1684                 $parts = explode('/', $type);
1685                 if($parts[1] != '*') {
1686                         $ckey = common_mime_type_match($type, $cprefs);
1687                         if($ckey) {
1688                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1689                         }
1690                 }
1691         }
1692
1693         foreach(array_keys($cprefs) as $type) {
1694                 $parts = explode('/', $type);
1695                 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1696                         $skey = common_mime_type_match($type, $sprefs);
1697                         if($skey) {
1698                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1699                         }
1700                 }
1701         }
1702
1703         $bestq = 0;
1704         $besttype = "text/html";
1705
1706         foreach(array_keys($combine) as $type) {
1707                 if($combine[$type] > $bestq) {
1708                         $besttype = $type;
1709                         $bestq = $combine[$type];
1710                 }
1711         }
1712
1713         return $besttype;
1714 }
1715
1716 function common_config($main, $sub) {
1717         global $config;
1718         return isset($config[$main][$sub]) ? $config[$main][$sub] : false;
1719 }
1720
1721 function common_copy_args($from) {
1722         $to = array();
1723         $strip = get_magic_quotes_gpc();
1724         foreach ($from as $k => $v) {
1725                 $to[$k] = ($strip) ? stripslashes($v) : $v;
1726         }
1727         return $to;
1728 }
1729
1730 // Neutralise the evil effects of magic_quotes_gpc in the current request.
1731 // This is used before handing a request off to OAuthRequest::from_request.
1732 function common_remove_magic_from_request() {
1733         if(get_magic_quotes_gpc()) {
1734                 $_POST=array_map('stripslashes',$_POST);
1735                 $_GET=array_map('stripslashes',$_GET);
1736         }
1737 }
1738
1739 function common_user_uri(&$user) {
1740         return common_local_url('userbyid', array('id' => $user->id));
1741 }
1742
1743 function common_notice_uri(&$notice) {
1744         return common_local_url('shownotice',
1745                 array('notice' => $notice->id));
1746 }
1747
1748 # 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1749
1750 function common_confirmation_code($bits) {
1751         # 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1752         static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1753         $chars = ceil($bits/5);
1754         $code = '';
1755         for ($i = 0; $i < $chars; $i++) {
1756                 # XXX: convert to string and back
1757                 $num = hexdec(common_good_rand(1));
1758                 # XXX: randomness is too precious to throw away almost
1759                 # 40% of the bits we get!
1760                 $code .= $codechars[$num%32];
1761         }
1762         return $code;
1763 }
1764
1765 # convert markup to HTML
1766
1767 function common_markup_to_html($c) {
1768         $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1769         $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1770         $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1771         return Markdown($c);
1772 }
1773
1774 function common_profile_avatar_url($profile, $size=AVATAR_PROFILE_SIZE) {
1775         $avatar = $profile->getAvatar($size);
1776         if ($avatar) {
1777                 return common_avatar_display_url($avatar);
1778         } else {
1779                 return common_default_avatar($size);
1780         }
1781 }
1782
1783 function common_profile_uri($profile) {
1784         if (!$profile) {
1785                 return NULL;
1786         }
1787         $user = User::staticGet($profile->id);
1788         if ($user) {
1789                 return $user->uri;
1790         }
1791
1792         $remote = Remote_profile::staticGet($profile->id);
1793         if ($remote) {
1794                 return $remote->uri;
1795         }
1796         # XXX: this is a very bad profile!
1797         return NULL;
1798 }
1799
1800 function common_canonical_sms($sms) {
1801         # strip non-digits
1802         preg_replace('/\D/', '', $sms);
1803         return $sms;
1804 }
1805
1806 function common_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
1807     switch ($errno) {
1808      case E_USER_ERROR:
1809                 common_log(LOG_ERR, "[$errno] $errstr ($errfile:$errline)");
1810                 exit(1);
1811                 break;
1812
1813          case E_USER_WARNING:
1814                 common_log(LOG_WARNING, "[$errno] $errstr ($errfile:$errline)");
1815                 break;
1816
1817      case E_USER_NOTICE:
1818                 common_log(LOG_NOTICE, "[$errno] $errstr ($errfile:$errline)");
1819                 break;
1820     }
1821
1822         # FIXME: show error page if we're on the Web
1823     /* Don't execute PHP internal error handler */
1824     return true;
1825 }
1826
1827 function common_session_token() {
1828         common_ensure_session();
1829         if (!array_key_exists('token', $_SESSION)) {
1830                 $_SESSION['token'] = common_good_rand(64);
1831         }
1832         return $_SESSION['token'];
1833 }
1834
1835 function common_disfavor_form($notice) {
1836         common_element_start('form', array('id' => 'disfavor-' . $notice->id,
1837                                                                            'method' => 'post',
1838                                                                            'class' => 'disfavor',
1839                                                                            'action' => common_local_url('disfavor')));
1840
1841         common_element('input', array('type' => 'hidden',
1842                                                                   'name' => 'token-'. $notice->id,
1843                                                                   'id' => 'token-'. $notice->id,
1844                                                                   'class' => 'token',
1845                                                                   'value' => common_session_token()));
1846
1847         common_element('input', array('type' => 'hidden',
1848                                                                   'name' => 'notice',
1849                                                                   'id' => 'notice-n'. $notice->id,
1850                                                                   'class' => 'notice',
1851                                                                   'value' => $notice->id));
1852
1853         common_element('input', array('type' => 'submit',
1854                                                                   'id' => 'disfavor-submit-' . $notice->id,
1855                                                                   'name' => 'disfavor-submit-' . $notice->id,
1856                                                                   'class' => 'disfavor',
1857                                                                   'value' => 'Disfavor favorite',
1858                                                                   'title' => 'Remove this message from favorites'));
1859         common_element_end('form');
1860 }
1861
1862 function common_favor_form($notice) {
1863         common_element_start('form', array('id' => 'favor-' . $notice->id,
1864                                                                            'method' => 'post',
1865                                                                            'class' => 'favor',
1866                                                                            'action' => common_local_url('favor')));
1867
1868         common_element('input', array('type' => 'hidden',
1869                                                                   'name' => 'token-'. $notice->id,
1870                                                                   'id' => 'token-'. $notice->id,
1871                                                                   'class' => 'token',
1872                                                                   'value' => common_session_token()));
1873
1874         common_element('input', array('type' => 'hidden',
1875                                                                   'name' => 'notice',
1876                                                                   'id' => 'notice-n'. $notice->id,
1877                                                                   'class' => 'notice',
1878                                                                   'value' => $notice->id));
1879         
1880         common_element('input', array('type' => 'submit',
1881                                                                   'id' => 'favor-submit-' . $notice->id,
1882                                                                   'name' => 'favor-submit-' . $notice->id,
1883                                                                   'class' => 'favor',
1884                                                                   'value' => 'Add to favorites',
1885                                                                   'title' => 'Add this message to favorites'));
1886         common_element_end('form');
1887 }
1888
1889 function common_nudge_form($profile) {
1890         common_element_start('form', array('id' => 'nudge', 'method' => 'post',
1891                                                                            'action' => common_local_url('nudge', array('nickname' => $profile->nickname))));
1892         common_hidden('token', common_session_token());
1893         common_element('input', array('type' => 'submit',
1894                                                                   'class' => 'submit',
1895                                                                   'value' => _('Send a nudge')));
1896         common_element_end('form');
1897 }
1898
1899 function common_subscribe_response() {
1900         common_element('p', array('id' => 'subscribe_response'), _('Subscribed'));
1901 }
1902
1903 function common_unsubscribe_response() {
1904         common_element('p', array('id' => 'unsubscribe_response'), _('Unsubscribed'));
1905 }
1906
1907 function common_nudge_response() {
1908         common_element('p', array('id' => 'nudge_response'), _('Nudge sent!'));
1909 }
1910
1911 function common_cache_key($extra) {
1912         return 'laconica:' . common_keyize(common_config('site', 'name')) . ':' . $extra;
1913 }
1914
1915 function common_keyize($str) {
1916         $str = strtolower($str);
1917         $str = preg_replace('/\s/', '_', $str);
1918         return $str;
1919 }
1920
1921 function common_message_form($content, $user, $to) {
1922         
1923         common_element_start('form', array('id' => 'message_form',
1924                                                                            'method' => 'post',
1925                                                                            'action' => common_local_url('newmessage')));
1926         
1927         $mutual_users = $user->mutuallySubscribedUsers();
1928         
1929         $mutual = array();
1930         
1931         while ($mutual_users->fetch()) {
1932                 if ($mutual_users->id != $user->id) {
1933                         $mutual[$mutual_users->id] = $mutual_users->nickname;
1934                 }
1935         }
1936         
1937         $mutual_users->free();
1938         unset($mutual_users);
1939         
1940         common_dropdown('to', _('To'), $mutual, NULL, FALSE, $to->id);
1941         
1942         common_element_start('p');
1943         
1944         common_element('textarea', array('id' => 'message_content',
1945                                                                          'cols' => 60,
1946                                                                          'rows' => 3,
1947                                                                          'name' => 'content'),
1948                                    ($content) ? $content : '');
1949         
1950         common_element('input', array('id' => 'message_send',
1951                                                                   'name' => 'message_send',
1952                                                                   'type' => 'submit',
1953                                                                   'value' => _('Send')));
1954         
1955         common_hidden('token', common_session_token());
1956         
1957         common_element_end('p');
1958         common_element_end('form');
1959 }
1960
1961 function common_memcache() {
1962         static $cache = NULL;
1963         if (!common_config('memcached', 'enabled')) {
1964                 return NULL;
1965         } else {
1966                 if (!$cache) {
1967                         $cache = new Memcache();
1968                         $servers = common_config('memcached', 'server');
1969                         if (is_array($servers)) {
1970                                 foreach($servers as $server) {
1971                                         $cache->addServer($server);
1972                                 }
1973                         } else {
1974                                 $cache->addServer($servers);
1975                         }
1976                 }
1977                 return $cache;
1978         }
1979 }