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