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