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