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 ($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 define('PAGE_TYPE_PREFS', 'text/html,application/xhtml+xml,application/xml;q=0.3,text/xml;q=0.2');
 135
 136 function common_show_header($pagetitle, $callable=NULL, $data=NULL, $headercall=NULL) {
 137         global $config, $xw;
 138
 139         $httpaccept = isset($_SERVER['HTTP_ACCEPT']) ? $_SERVER['HTTP_ACCEPT'] : NULL;
 140
 141         # XXX: allow content negotiation for RDF, RSS, or XRDS
 142
 143         $type = common_negotiate_type(common_accept_to_prefs($httpaccept),
 144                                                                   common_accept_to_prefs(PAGE_TYPE_PREFS));
 145
 146         if (!$type) {
 147                 common_user_error(_t('This page is not available in a media type you accept'), 406);
 148                 exit(0);
 149         }
 150
 151         header('Content-Type: '.$type);
 152
 153         common_start_xml('html',
 154                                          '-//W3C//DTD XHTML 1.0 Strict//EN',
 155                                          'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 156
 157         # FIXME: correct language for interface
 158
 159         common_element_start('html', array('xmlns' => 'http://www.w3.org/1999/xhtml',
 160                                                                            'xml:lang' => 'en',
 161                                                                            'lang' => 'en'));
 162
 163         common_element_start('head');
 164         common_element('title', NULL,
 165                                    $pagetitle . " - " . $config['site']['name']);
 166         common_element('link', array('rel' => 'stylesheet',
 167                                                                  'type' => 'text/css',
 168                                                                  'href' => theme_path('display.css'),
 169                                                                  'media' => 'screen, projection, tv'));
 170         foreach (array(6,7) as $ver) {
 171                 if (file_exists(theme_file('ie'.$ver.'.css'))) {
 172                         # Yes, IE people should be put in jail.
 173                         $xw->writeComment('[if lte IE '.$ver.']><link rel="stylesheet" type="text/css" '.
 174                                                           'href="'.theme_path('ie'.$ver.'.css').'" /><![endif]');
 175                 }
 176         }
 177
 178         common_element('script', array('type' => 'text/javascript',
 179                                                                    'src' => common_path('js/jquery.min.js')),
 180                                    ' ');
 181         common_element('script', array('type' => 'text/javascript',
 182                                                                    'src' => common_path('js/util.js')),
 183                                    ' ');
 184
 185         if ($callable) {
 186                 if ($data) {
 187                         call_user_func($callable, $data);
 188                 } else {
 189                         call_user_func($callable);
 190                 }
 191         }
 192         common_element_end('head');
 193         common_element_start('body');
 194         common_element_start('div', array('id' => 'wrap'));
 195         common_element_start('div', array('id' => 'header'));
 196         common_nav_menu();
 197         if ((is_string($config['site']['logo']) && (strlen($config['site']['logo']) > 0))
 198                 || file_exists(theme_file('logo.png')))
 199         {
 200                 common_element_start('a', array('href' => common_local_url('public')));
 201                 common_element('img', array('src' => ($config['site']['logo']) ?
 202                                                                         ($config['site']['logo']) : theme_path('logo.png'),
 203                                                                         'alt' => $config['site']['name'],
 204                                                                         'id' => 'logo'));
 205                 common_element_end('a');
 206         } else {
 207                 common_element_start('p', array('id' => 'branding'));
 208                 common_element('a', array('href' => common_local_url('public')),
 209                                            $config['site']['name']);
 210                 common_element_end('p');
 211         }
 212
 213         common_element('h1', 'pagetitle', $pagetitle);
 214
 215         if ($headercall) {
 216                 if ($data) {
 217                         call_user_func($headercall, $data);
 218                 } else {
 219                         call_user_func($headercall);
 220                 }
 221         }
 222         common_element_end('div');
 223         common_element_start('div', array('id' => 'content'));
 224 }
 225
 226 function common_show_footer() {
 227         global $xw, $config;
 228         common_element_end('div'); # content div
 229         common_foot_menu();
 230         common_element_start('div', array('id' => 'footer'));
 231         common_element_start('div', 'laconica');
 232         if (common_config('site', 'broughtby')) {
 233                 $instr = _t('**%%site.name%%** is a microblogging service brought to you by [%%site.broughtby%%](%%site.broughtbyurl%%). ');
 234         } else {
 235                 $instr = _t('**%%site.name%%** is a microblogging service. ');
 236         }
 237         $instr .= _t('It runs the [Laconica](http://laconi.ca/) ' .
 238                          'microblogging software, version ' . LACONICA_VERSION . ', ' .
 239                          'available under the ' .
 240                          '[GNU Affero General Public License]' .
 241                          '(http://www.fsf.org/licensing/licenses/agpl-3.0.html).');
 242     $output = common_markup_to_html($instr);
 243     common_raw($output);
 244         common_element_end('div');
 245         common_element('img', array('id' => 'cc',
 246                                                                 'src' => $config['license']['image'],
 247                                                                 'alt' => $config['license']['title']));
 248         common_element_start('p');
 249         common_text(_t('Unless otherwise specified, contents of this site are copyright by the contributors and available under the '));
 250         common_element('a', array('class' => 'license',
 251                                                           'rel' => 'license',
 252                                                           href => $config['license']['url']),
 253                                    $config['license']['title']);
 254         common_text(_t('. Contributors should be attributed by full name or nickname.'));
 255         common_element_end('p');
 256         common_element_end('div');
 257         common_element_end('div');
 258         common_element_end('body');
 259         common_element_end('html');
 260         common_end_xml();
 261 }
 262
 263 function common_text($txt) {
 264         global $xw;
 265         $xw->text($txt);
 266 }
 267
 268 function common_raw($xml) {
 269         global $xw;
 270         $xw->writeRaw($xml);
 271 }
 272
 273 function common_nav_menu() {
 274         $user = common_current_user();
 275         common_element_start('ul', array('id' => 'nav'));
 276         if ($user) {
 277                 common_menu_item(common_local_url('all', array('nickname' => $user->nickname)),
 278                                                  _t('Home'));
 279         }
 280         common_menu_item(common_local_url('public'), _t('Public'));
 281         common_menu_item(common_local_url('doc', array('title' => 'help')),
 282                                          _t('Help'));
 283         if ($user) {
 284                 common_menu_item(common_local_url('profilesettings'),
 285                                                  _t('Settings'));
 286                 common_menu_item(common_local_url('logout'),
 287                                                  _t('Logout'));
 288         } else {
 289                 common_menu_item(common_local_url('login'), _t('Login'));
 290                 common_menu_item(common_local_url('register'), _t('Register'));
 291                 common_menu_item(common_local_url('openidlogin'), _t('OpenID'));
 292         }
 293         common_element_end('ul');
 294 }
 295
 296 function common_foot_menu() {
 297         common_element_start('ul', array('id' => 'nav_sub'));
 298         common_menu_item(common_local_url('doc', array('title' => 'about')),
 299                                          _t('About'));
 300         common_menu_item(common_local_url('doc', array('title' => 'faq')),
 301                                          _t('FAQ'));
 302         common_menu_item(common_local_url('doc', array('title' => 'privacy')),
 303                                          _t('Privacy'));
 304         common_menu_item(common_local_url('doc', array('title' => 'source')),
 305                                          _t('Source'));
 306         common_menu_item(common_local_url('doc', array('title' => 'contact')),
 307                                          _t('Contact'));
 308         common_element_end('ul');
 309 }
 310
 311 function common_menu_item($url, $text, $title=NULL, $is_selected=false) {
 312         $lattrs = array();
 313         if ($is_selected) {
 314                 $lattrs['class'] = 'current';
 315         }
 316         common_element_start('li', $lattrs);
 317         $attrs['href'] = $url;
 318         if ($title) {
 319                 $attrs['title'] = $title;
 320         }
 321         common_element('a', $attrs, $text);
 322         common_element_end('li');
 323 }
 324
 325 function common_input($id, $label, $value=NULL,$instructions=NULL) {
 326         common_element_start('p');
 327         common_element('label', array('for' => $id), $label);
 328         $attrs = array('name' => $id,
 329                                    'type' => 'text',
 330                                    'class' => 'input_text',
 331                                    'id' => $id);
 332         if ($value) {
 333                 $attrs['value'] = htmlspecialchars($value);
 334         }
 335         common_element('input', $attrs);
 336         if ($instructions) {
 337                 common_element('span', 'input_instructions', $instructions);
 338         }
 339         common_element_end('p');
 340 }
 341
 342 function common_checkbox($id, $label, $checked=false, $instructions=NULL, $value='true')
 343 {
 344         common_element_start('p');
 345         $attrs = array('name' => $id,
 346                                    'type' => 'checkbox',
 347                                    'class' => 'checkbox',
 348                                    'id' => $id);
 349         if ($value) {
 350                 $attrs['value'] = htmlspecialchars($value);
 351         }
 352         if ($checked) {
 353                 $attrs['checked'] = 'checked';
 354         }
 355         common_element('input', $attrs);
 356         # XXX: use a <label>
 357         common_text(' ');
 358         common_element('span', 'checkbox_label', $label);
 359         common_text(' ');
 360         if ($instructions) {
 361                 common_element('span', 'input_instructions', $instructions);
 362         }
 363         common_element_end('p');
 364 }
 365
 366 function common_hidden($id, $value) {
 367         common_element('input', array('name' => $id,
 368                                                                   'type' => 'hidden',
 369                                                                   'id' => $id,
 370                                                                   'value' => $value));
 371 }
 372
 373 function common_password($id, $label, $instructions=NULL) {
 374         common_element_start('p');
 375         common_element('label', array('for' => $id), $label);
 376         $attrs = array('name' => $id,
 377                                    'type' => 'password',
 378                                    'class' => 'password',
 379                                    'id' => $id);
 380         common_element('input', $attrs);
 381         if ($instructions) {
 382                 common_element('span', 'input_instructions', $instructions);
 383         }
 384         common_element_end('p');
 385 }
 386
 387 function common_submit($id, $label) {
 388         global $xw;
 389         common_element_start('p');
 390         common_element('input', array('type' => 'submit',
 391                                                                   'id' => $id,
 392                                                                   'name' => $id,
 393                                                                   'class' => 'submit',
 394                                                                   'value' => $label));
 395         common_element_end('p');
 396 }
 397
 398 function common_textarea($id, $label, $content=NULL, $instructions=NULL) {
 399         common_element_start('p');
 400         common_element('label', array('for' => $id), $label);
 401         common_element('textarea', array('rows' => 3,
 402                                                                          'cols' => 40,
 403                                                                          'name' => $id,
 404                                                                          'id' => $id),
 405                                    ($content) ? $content : '');
 406         if ($instructions) {
 407                 common_element('span', 'input_instructions', $instructions);
 408         }
 409         common_element_end('p');
 410 }
 411
 412 # salted, hashed passwords are stored in the DB
 413
 414 function common_munge_password($password, $id) {
 415         return md5($password . $id);
 416 }
 417
 418 # check if a username exists and has matching password
 419 function common_check_user($nickname, $password) {
 420         $user = User::staticGet('nickname', $nickname);
 421         if (is_null($user)) {
 422                 return false;
 423         } else {
 424                 if (0 == strcmp(common_munge_password($password, $user->id),
 425                                                 $user->password)) {
 426                         return $user;
 427                 } else {
 428                         return false;
 429                 }
 430         }
 431 }
 432
 433 # is the current user logged in?
 434 function common_logged_in() {
 435         return (!is_null(common_current_user()));
 436 }
 437
 438 function common_have_session() {
 439         return (0 != strcmp(session_id(), ''));
 440 }
 441
 442 function common_ensure_session() {
 443         if (!common_have_session()) {
 444                 @session_start();
 445         }
 446 }
 447
 448 # Three kinds of arguments:
 449 # 1) a user object
 450 # 2) a nickname
 451 # 3) NULL to clear
 452
 453 function common_set_user($user) {
 454         if (is_null($user) && common_have_session()) {
 455                 unset($_SESSION['userid']);
 456                 return true;
 457         } else if (is_string($user)) {
 458                 $nickname = $user;
 459                 $user = User::staticGet('nickname', $nickname);
 460         } else if (!($user instanceof User)) {
 461                 return false;
 462         }
 463
 464         if ($user) {
 465                 common_ensure_session();
 466                 $_SESSION['userid'] = $user->id;
 467                 return $user;
 468         }
 469         return false;
 470 }
 471
 472 function common_set_cookie($key, $value, $expiration=0) {
 473         $path = common_config('site', 'path');
 474         $server = common_config('site', 'server');
 475
 476         if ($path && ($path != '/')) {
 477                 $cookiepath = '/' . $path . '/';
 478         } else {
 479                 $cookiepath = '/';
 480         }
 481         return setcookie($key,
 482                          $value,
 483                                  $expiration,
 484                                          $cookiepath,
 485                                      $server);
 486 }
 487
 488 define('REMEMBERME', 'rememberme');
 489 define('REMEMBERME_EXPIRY', 30 * 24 * 60 * 60);
 490
 491 function common_rememberme($user=NULL) {
 492         if (!$user) {
 493                 $user = common_current_user();
 494                 if (!$user) {
 495                         common_debug('No current user to remember', __FILE__);
 496                         return false;
 497                 }
 498         }
 499         $rm = new Remember_me();
 500         $rm->code = common_good_rand(16);
 501         $rm->user_id = $user->id;
 502         $result = $rm->insert();
 503         if (!$result) {
 504                 common_log_db_error($rm, 'INSERT', __FILE__);
 505                 common_debug('Error adding rememberme record for ' . $user->nickname, __FILE__);
 506                 return false;
 507         }
 508         common_log(LOG_INFO, 'adding rememberme cookie for ' . $user->nickname);
 509         common_set_cookie(REMEMBERME,
 510                                           implode(':', array($rm->user_id, $rm->code)),
 511                                           time() + REMEMBERME_EXPIRY);
 512         return true;
 513 }
 514
 515 function common_remembered_user() {
 516         $user = NULL;
 517         # Try to remember
 518         $packed = $_COOKIE[REMEMBERME];
 519         if ($packed) {
 520                 list($id, $code) = explode(':', $packed);
 521                 if ($id && $code) {
 522                         $rm = Remember_me::staticGet($code);
 523                         if ($rm && ($rm->user_id == $id)) {
 524                                 $user = User::staticGet($rm->user_id);
 525                                 if ($user) {
 526                                         # successful!
 527                                         $result = $rm->delete();
 528                                         if (!$result) {
 529                                                 common_log_db_error($rm, 'DELETE', __FILE__);
 530                                                 $user = NULL;
 531                                         } else {
 532                                                 common_log(LOG_INFO, 'logging in ' . $user->nickname . ' using rememberme code ' . $rm->code);
 533                                                 common_set_user($user->nickname);
 534                                                 common_real_login(false);
 535                                                 # We issue a new cookie, so they can log in
 536                                                 # automatically again after this session
 537                                                 common_rememberme($user);
 538                                         }
 539                                 }
 540                         }
 541                 }
 542         }
 543         return $user;
 544 }
 545
 546 # must be called with a valid user!
 547
 548 function common_forgetme() {
 549         common_set_cookie(REMEMBERME, '', 0);
 550 }
 551
 552 # who is the current user?
 553 function common_current_user() {
 554         if ($_REQUEST[session_name()]) {
 555                 common_ensure_session();
 556                 $id = $_SESSION['userid'];
 557                 if ($id) {
 558                         # note: this should cache
 559                         $user = User::staticGet($id);
 560                         return $user;
 561                 }
 562         }
 563         # that didn't work; try to remember
 564         $user = common_remembered_user();
 565         return $user;
 566 }
 567
 568 # Logins that are 'remembered' aren't 'real' -- they're subject to
 569 # cookie-stealing. So, we don't let them do certain things. New reg,
 570 # OpenID, and password logins _are_ real.
 571
 572 function common_real_login($real=true) {
 573         common_ensure_session();
 574         $_SESSION['real_login'] = $real;
 575 }
 576
 577 function common_is_real_login() {
 578         return common_logged_in() && $_SESSION['real_login'];
 579 }
 580
 581 # get canonical version of nickname for comparison
 582 function common_canonical_nickname($nickname) {
 583         # XXX: UTF-8 canonicalization (like combining chars)
 584         return strtolower($nickname);
 585 }
 586
 587 # get canonical version of email for comparison
 588 function common_canonical_email($email) {
 589         # XXX: canonicalize UTF-8
 590         # XXX: lcase the domain part
 591         return $email;
 592 }
 593
 594 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$_+!*();/?:~-]))');
 595
 596 function common_render_content($text, $notice) {
 597         $r = htmlspecialchars($text);
 598         $id = $notice->profile_id;
 599         $r = preg_replace('@https?://\S+@', '<a href="\0" class="extlink">\0</a>', $r);
 600         $r = preg_replace('/(^|\s+)@([a-z0-9]{1,64})/e', "'\\1@'.common_at_link($id, '\\2')", $r);
 601         # XXX: # tags
 602         # XXX: machine tags
 603         return $r;
 604 }
 605
 606 function common_at_link($sender_id, $nickname) {
 607         $sender = Profile::staticGet($sender_id);
 608         $recipient = common_relative_profile($sender, $nickname);
 609         if ($recipient) {
 610                 return '<a href="'.htmlspecialchars($recipient->profileurl).'" class="atlink">'.$nickname.'</a>';
 611         } else {
 612                 return $nickname;
 613         }
 614 }
 615
 616 function common_relative_profile($sender, $nickname, $dt=NULL) {
 617         # Try to find profiles this profile is subscribed to that have this nickname
 618         $recipient = new Profile();
 619         # XXX: use a join instead of a subquery
 620         $recipient->whereAdd('EXISTS (SELECT subscribed from subscription where subscriber = '.$sender_id.' and subscribed = id)', 'AND');
 621         $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 622         if ($recipient->find(TRUE)) {
 623                 # XXX: should probably differentiate between profiles with
 624                 # the same name by date of most recent update
 625                 return $recipient;
 626         }
 627         # Try to find profiles that listen to this profile and that have this nickname
 628         $recipient = new Profile();
 629         # XXX: use a join instead of a subquery
 630         $recipient->whereAdd('EXISTS (SELECT subscriber from subscription where subscribed = '.$sender_id.' and subscriber = id)', 'AND');
 631         $recipient->whereAdd('nickname = "' . trim($nickname) . '"', 'AND');
 632         if ($recipient->find(TRUE)) {
 633                 # XXX: should probably differentiate between profiles with
 634                 # the same name by date of most recent update
 635                 return $recipient;
 636         }
 637         # If this is a local user, try to find a local user with that nickname.
 638         $sender = User::staticGet($sender->id);
 639         if ($sender) {
 640                 $recipient_user = User::staticGet('nickname', $nickname);
 641                 if ($recipient_user) {
 642                         return $recipient_user->getProfile();
 643                 }
 644         }
 645         # Otherwise, no links. @messages from local users to remote users,
 646         # or from remote users to other remote users, are just
 647         # outside our ability to make intelligent guesses about
 648         return NULL;
 649 }
 650
 651 // where should the avatar go for this user?
 652
 653 function common_avatar_filename($id, $extension, $size=NULL, $extra=NULL) {
 654         global $config;
 655
 656         if ($size) {
 657                 return $id . '-' . $size . (($extra) ? ('-' . $extra) : '') . $extension;
 658         } else {
 659                 return $id . '-original' . (($extra) ? ('-' . $extra) : '') . $extension;
 660         }
 661 }
 662
 663 function common_avatar_path($filename) {
 664         global $config;
 665         return INSTALLDIR . '/avatar/' . $filename;
 666 }
 667
 668 function common_avatar_url($filename) {
 669         return common_path('avatar/'.$filename);
 670 }
 671
 672 function common_avatar_display_url($avatar) {
 673         $server = common_config('avatar', 'server');
 674         if ($server) {
 675                 return 'http://'.$server.'/'.$avatar->filename;
 676         } else {
 677                 return $avatar->url;
 678         }
 679 }
 680
 681 function common_default_avatar($size) {
 682         static $sizenames = array(AVATAR_PROFILE_SIZE => 'profile',
 683                                                           AVATAR_STREAM_SIZE => 'stream',
 684                                                           AVATAR_MINI_SIZE => 'mini');
 685         return theme_path('default-avatar-'.$sizenames[$size].'.png');
 686 }
 687
 688 function common_local_url($action, $args=NULL) {
 689         global $config;
 690         if ($config['site']['fancy']) {
 691                 return common_fancy_url($action, $args);
 692         } else {
 693                 return common_simple_url($action, $args);
 694         }
 695 }
 696
 697 function common_fancy_url($action, $args=NULL) {
 698         switch (strtolower($action)) {
 699          case 'public':
 700                 if ($args && $args['page']) {
 701                         return common_path('?page=' . $args['page']);
 702                 } else {
 703                         return common_path('');
 704                 }
 705          case 'publicrss':
 706                 return common_path('rss');
 707          case 'publicxrds':
 708                 return common_path('xrds');
 709          case 'doc':
 710                 return common_path('doc/'.$args['title']);
 711          case 'login':
 712          case 'logout':
 713          case 'register':
 714          case 'subscribe':
 715          case 'unsubscribe':
 716                 return common_path('main/'.$action);
 717          case 'remotesubscribe':
 718                 if ($args && $args['nickname']) {
 719                         return common_path('main/remote?nickname=' . $args['nickname']);
 720                 } else {
 721                         return common_path('main/remote');
 722                 }
 723          case 'openidlogin':
 724                 return common_path('main/openid');
 725          case 'avatar':
 726          case 'password':
 727                 return common_path('settings/'.$action);
 728          case 'profilesettings':
 729                 return common_path('settings/profile');
 730          case 'openidsettings':
 731                 return common_path('settings/openid');
 732          case 'newnotice':
 733                 if ($args && $args['replyto']) {
 734                         return common_path('notice/new?replyto='.$args['replyto']);
 735                 } else {
 736                         return common_path('notice/new');
 737                 }
 738          case 'shownotice':
 739                 return common_path('notice/'.$args['notice']);
 740          case 'xrds':
 741          case 'foaf':
 742                 return common_path($args['nickname'].'/'.$action);
 743          case 'subscriptions':
 744          case 'subscribers':
 745          case 'all':
 746          case 'replies':
 747                 if ($args && $args['page']) {
 748                         return common_path($args['nickname'].'/'.$action.'?page=' . $args['page']);
 749                 } else {
 750                         return common_path($args['nickname'].'/'.$action);
 751                 }
 752          case 'allrss':
 753                 return common_path($args['nickname'].'/all/rss');
 754          case 'repliesrss':
 755                 return common_path($args['nickname'].'/replies/rss');
 756          case 'userrss':
 757                 return common_path($args['nickname'].'/rss');
 758          case 'showstream':
 759                 if ($args && $args['page']) {
 760                         return common_path($args['nickname'].'?page=' . $args['page']);
 761                 } else {
 762                         return common_path($args['nickname']);
 763                 }
 764          case 'confirmaddress':
 765                 return common_path('main/confirmaddress/'.$args['code']);
 766          case 'userbyid':
 767                 return common_path('user/'.$args['id']);
 768          case 'recoverpassword':
 769             $path = 'main/recoverpassword';
 770             if ($args['code']) {
 771                 $path .= '/' . $args['code'];
 772                 }
 773             return common_path($path);
 774          case 'imsettings':
 775                 return common_path('settings/im');
 776          default:
 777                 return common_simple_url($action, $args);
 778         }
 779 }
 780
 781 function common_simple_url($action, $args=NULL) {
 782         global $config;
 783         /* XXX: pretty URLs */
 784         $extra = '';
 785         if ($args) {
 786                 foreach ($args as $key => $value) {
 787                         $extra .= "&${key}=${value}";
 788                 }
 789         }
 790         return common_path("index.php?action=${action}${extra}");
 791 }
 792
 793 function common_path($relative) {
 794         global $config;
 795         $pathpart = ($config['site']['path']) ? $config['site']['path']."/" : '';
 796         return "http://".$config['site']['server'].'/'.$pathpart.$relative;
 797 }
 798
 799 function common_date_string($dt) {
 800         // XXX: do some sexy date formatting
 801         // return date(DATE_RFC822, $dt);
 802         $t = strtotime($dt);
 803         $now = time();
 804         $diff = $now - $t;
 805
 806         if ($now < $t) { # that shouldn't happen!
 807                 return common_exact_date($dt);
 808         } else if ($diff < 60) {
 809                 return _t('a few seconds ago');
 810         } else if ($diff < 92) {
 811                 return _t('about a minute ago');
 812         } else if ($diff < 3300) {
 813                 return _t('about ') . round($diff/60) . _t(' minutes ago');
 814         } else if ($diff < 5400) {
 815                 return _t('about an hour ago');
 816         } else if ($diff < 22 * 3600) {
 817                 return _t('about ') . round($diff/3600) . _t(' hours ago');
 818         } else if ($diff < 37 * 3600) {
 819                 return _t('about a day ago');
 820         } else if ($diff < 24 * 24 * 3600) {
 821                 return _t('about ') . round($diff/(24*3600)) . _t(' days ago');
 822         } else if ($diff < 46 * 24 * 3600) {
 823                 return _t('about a month ago');
 824         } else if ($diff < 330 * 24 * 3600) {
 825                 return _t('about ') . round($diff/(30*24*3600)) . _t(' months ago');
 826         } else if ($diff < 480 * 24 * 3600) {
 827                 return _t('about a year ago');
 828         } else {
 829                 return common_exact_date($dt);
 830         }
 831 }
 832
 833 function common_exact_date($dt) {
 834         $t = strtotime($dt);
 835         return date(DATE_RFC850, $t);
 836 }
 837
 838 function common_date_w3dtf($dt) {
 839         $t = strtotime($dt);
 840         return date(DATE_W3C, $t);
 841 }
 842
 843 function common_redirect($url, $code=307) {
 844         static $status = array(301 => "Moved Permanently",
 845                                                    302 => "Found",
 846                                                    303 => "See Other",
 847                                                    307 => "Temporary Redirect");
 848         header("Status: ${code} $status[$code]");
 849         header("Location: $url");
 850
 851         common_start_xml('a',
 852                                          '-//W3C//DTD XHTML 1.0 Strict//EN',
 853                                          'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd');
 854         common_element('a', array('href' => $url), $url);
 855         common_end_xml();
 856 }
 857
 858 function common_save_replies($notice) {
 859         # extract all @messages
 860         $cnt = preg_match_all('/(?:^|\s)@([a-z0-9]{1,64})/', $notice->content, $match);
 861         if (!$cnt) {
 862                 return true;
 863         }
 864         $sender = Profile::staticGet($notice->profile_id);
 865         # store replied only for first @ (what user/notice what the reply directed,
 866         # we assume first @ is it)
 867         for ($i=0; $i<count($match[1]); $i++) {
 868                 $nickname = $match[1][$i];
 869                 $recipient = common_relative_profile($sender, $nickname, $notice->created);
 870                 if (!$recipient) {
 871                         continue;
 872                 }
 873                 if ($i == 0) {
 874                         $reply_for = $recipient;
 875                 }
 876                 $reply = new Reply();
 877                 $reply->notice_id = $notice->id;
 878                 $reply->profile_id = $recipient->id;
 879                 if ($reply_for) {
 880 #                       $recipient_notice = $reply_for->getCurrentNotice($notice->created);
 881                         $recipient_notice = $reply_for->getCurrentNotice();
 882                         $reply->replied_id = $recipient_notice->id;
 883                 }
 884                 $id = $reply->insert();
 885                 if (!$id) {
 886                         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 887                         common_log(LOG_ERROR, 'DB error inserting reply: ' . $last_error->message);
 888                         common_server_error('DB error inserting reply: ' . $last_error->message);
 889                         return;
 890                 }
 891         }
 892 }
 893
 894 function common_broadcast_notice($notice, $remote=false) {
 895         if (common_config('queue', 'enabled')) {
 896                 # Do it later!
 897                 return common_enqueue_notice($notice);
 898         } else {
 899                 return common_real_broadcast($notice, $remote);
 900         }
 901 }
 902
 903 # Stick the notice on the queue
 904
 905 function common_enqueue_notice($notice) {
 906         $qi = new Queue_item();
 907         $qi->notice_id = $notice->id;
 908         $qi->created = $notice->created;
 909         $result = $qi->insert();
 910         if (!$result) {
 911             $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
 912             common_log(LOG_ERROR, 'DB error inserting queue item: ' . $last_error->message);
 913             return false;
 914         }
 915         common_log(LOG_DEBUG, 'complete queueing notice ID = ' . $notice->id);
 916         return $result;
 917 }
 918
 919 function common_real_broadcast($notice, $remote=false) {
 920         $success = true;
 921         if (!$remote) {
 922                 # Make sure we have the OMB stuff
 923                 require_once(INSTALLDIR.'/lib/omb.php');
 924                 $success = omb_broadcast_remote_subscribers($notice);
 925                 if (!$success) {
 926                         common_log(LOG_ERROR, 'Error in OMB broadcast for notice ' . $notice->id);
 927                 }
 928         }
 929         if ($success) {
 930                 require_once(INSTALLDIR.'/lib/jabber.php');
 931                 $success = jabber_broadcast_notice($notice);
 932                 if (!$success) {
 933                         common_log(LOG_ERROR, 'Error in jabber broadcast for notice ' . $notice->id);
 934                 }
 935         }
 936         // XXX: broadcast notices to SMS
 937         // XXX: broadcast notices to other IM
 938         return $success;
 939 }
 940
 941 function common_broadcast_profile($profile) {
 942         // XXX: optionally use a queue system like http://code.google.com/p/microapps/wiki/NQDQ
 943         require_once(INSTALLDIR.'/lib/omb.php');
 944         omb_broadcast_profile($profile);
 945         // XXX: Other broadcasts...?
 946         return true;
 947 }
 948
 949 function common_profile_url($nickname) {
 950         return common_local_url('showstream', array('nickname' => $nickname));
 951 }
 952
 953 # Don't call if nobody's logged in
 954
 955 function common_notice_form($action=NULL, $content=NULL) {
 956         $user = common_current_user();
 957         assert(!is_null($user));
 958         common_element_start('form', array('id' => 'status_form',
 959                                                                            'method' => 'post',
 960                                                                            'action' => common_local_url('newnotice')));
 961         common_element_start('p');
 962         common_element('label', array('for' => 'status_textarea',
 963                                                                   'id' => 'status_label'),
 964                                    _t('What\'s up, ').$user->nickname.'?');
 965         common_element('span', array('id' => 'counter', 'class' => 'counter'), '140');
 966         common_element('textarea', array('id' => 'status_textarea',
 967                                                                          'cols' => 60,
 968                                                                          'rows' => 3,
 969                                                                          'name' => 'status_textarea'),
 970                                    ($content) ? $content : '');
 971         if ($action) {
 972                 common_hidden('returnto', $action);
 973         }
 974         common_element('input', array('id' => 'status_submit',
 975                                                                   'name' => 'status_submit',
 976                                                                   'type' => 'submit',
 977                                                                   'value' => _t('Send')));
 978         common_element_end('p');
 979         common_element_end('form');
 980 }
 981
 982 function common_mint_tag($extra) {
 983         global $config;
 984         return
 985           'tag:'.$config['tag']['authority'].','.
 986           $config['tag']['date'].':'.$config['tag']['prefix'].$extra;
 987 }
 988
 989 # Should make up a reasonable root URL
 990
 991 function common_root_url() {
 992         return common_path('');
 993 }
 994
 995 # returns $bytes bytes of random data as a hexadecimal string
 996 # "good" here is a goal and not a guarantee
 997
 998 function common_good_rand($bytes) {
 999         # XXX: use random.org...?
1000         if (file_exists('/dev/urandom')) {
1001                 return common_urandom($bytes);
1002         } else { # FIXME: this is probably not good enough
1003                 return common_mtrand($bytes);
1004         }
1005 }
1006
1007 function common_urandom($bytes) {
1008         $h = fopen('/dev/urandom', 'rb');
1009         # should not block
1010         $src = fread($h, $bytes);
1011         fclose($h);
1012         $enc = '';
1013         for ($i = 0; $i < $bytes; $i++) {
1014                 $enc .= sprintf("%02x", (ord($src[$i])));
1015         }
1016         return $enc;
1017 }
1018
1019 function common_mtrand($bytes) {
1020         $enc = '';
1021         for ($i = 0; $i < $bytes; $i++) {
1022                 $enc .= sprintf("%02x", mt_rand(0, 255));
1023         }
1024         return $enc;
1025 }
1026
1027 function common_set_returnto($url) {
1028         common_ensure_session();
1029         $_SESSION['returnto'] = $url;
1030 }
1031
1032 function common_get_returnto() {
1033         common_ensure_session();
1034         return $_SESSION['returnto'];
1035 }
1036
1037 function common_timestamp() {
1038         return date('YmdHis');
1039 }
1040
1041 // XXX: set up gettext
1042
1043 function _t($str) {
1044         return $str;
1045 }
1046
1047 function common_ensure_syslog() {
1048         static $initialized = false;
1049         if (!$initialized) {
1050                 global $config;
1051                 define_syslog_variables();
1052                 openlog($config['syslog']['appname'], 0, LOG_USER);
1053                 $initialized = true;
1054         }
1055 }
1056
1057 function common_log($priority, $msg, $filename=NULL) {
1058         common_ensure_syslog();
1059         syslog($priority, $msg);
1060 }
1061
1062 function common_debug($msg, $filename=NULL) {
1063         if ($filename) {
1064                 common_log(LOG_DEBUG, basename($filename).' - '.$msg);
1065         } else {
1066                 common_log(LOG_DEBUG, $msg);
1067         }
1068 }
1069
1070 function common_log_db_error(&$object, $verb, $filename=NULL) {
1071         $objstr = common_log_objstring($object);
1072         $last_error = &PEAR::getStaticProperty('DB_DataObject','lastError');
1073         common_log(LOG_ERR, $last_error->message . '(' . $verb . ' on ' . $objstr . ')', $filename);
1074 }
1075
1076 function common_log_objstring(&$object) {
1077         if (is_null($object)) {
1078                 return "NULL";
1079         }
1080         $arr = $object->toArray();
1081         $fields = array();
1082         foreach ($arr as $k => $v) {
1083                 $fields[] = "$k='$v'";
1084         }
1085         $objstring = $object->tableName() . '[' . implode(',', $fields) . ']';
1086         return $objstring;
1087 }
1088
1089 function common_valid_http_url($url) {
1090         return Validate::uri($url, array('allowed_schemes' => array('http', 'https')));
1091 }
1092
1093 function common_valid_tag($tag) {
1094         if (preg_match('/^tag:(.*?),(\d{4}(-\d{2}(-\d{2})?)?):(.*)$/', $tag, $matches)) {
1095                 return (Validate::email($matches[1]) ||
1096                                 preg_match('/^([\w-\.]+)$/', $matches[1]));
1097         }
1098         return false;
1099 }
1100
1101 # Does a little before-after block for next/prev page
1102
1103 function common_pagination($have_before, $have_after, $page, $action, $args=NULL) {
1104
1105         if ($have_before || $have_after) {
1106                 common_element_start('div', array('id' => 'pagination'));
1107                 common_element_start('ul', array('id' => 'nav_pagination'));
1108         }
1109
1110         if ($have_before) {
1111                 $pargs = array('page' => $page-1);
1112                 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
1113
1114                 common_element_start('li', 'before');
1115                 common_element('a', array('href' => common_local_url($action, $newargs)),
1116                                            _t('« After'));
1117                 common_element_end('li');
1118         }
1119
1120         if ($have_after) {
1121                 $pargs = array('page' => $page+1);
1122                 $newargs = ($args) ? array_merge($args,$pargs) : $pargs;
1123                 common_element_start('li', 'after');
1124                 common_element('a', array('href' => common_local_url($action, $newargs)),
1125                                                    _t('Before »'));
1126                 common_element_end('li');
1127         }
1128
1129         if ($have_before || $have_after) {
1130                 common_element_end('ul');
1131                 common_element_end('div');
1132         }
1133 }
1134
1135 /* Following functions are copied from MediaWiki GlobalFunctions.php
1136  * and written by Evan Prodromou. */
1137
1138 function common_accept_to_prefs($accept, $def = '*/*') {
1139         # No arg means accept anything (per HTTP spec)
1140         if(!$accept) {
1141                 return array($def => 1);
1142         }
1143
1144         $prefs = array();
1145
1146         $parts = explode(',', $accept);
1147
1148         foreach($parts as $part) {
1149                 # FIXME: doesn't deal with params like 'text/html; level=1'
1150                 @list($value, $qpart) = explode(';', $part);
1151                 $match = array();
1152                 if(!isset($qpart)) {
1153                         $prefs[$value] = 1;
1154                 } elseif(preg_match('/q\s*=\s*(\d*\.\d+)/', $qpart, $match)) {
1155                         $prefs[$value] = $match[1];
1156                 }
1157         }
1158
1159         return $prefs;
1160 }
1161
1162 function common_mime_type_match($type, $avail) {
1163         if(array_key_exists($type, $avail)) {
1164                 return $type;
1165         } else {
1166                 $parts = explode('/', $type);
1167                 if(array_key_exists($parts[0] . '/*', $avail)) {
1168                         return $parts[0] . '/*';
1169                 } elseif(array_key_exists('*/*', $avail)) {
1170                         return '*/*';
1171                 } else {
1172                         return NULL;
1173                 }
1174         }
1175 }
1176
1177 function common_negotiate_type($cprefs, $sprefs) {
1178         $combine = array();
1179
1180         foreach(array_keys($sprefs) as $type) {
1181                 $parts = explode('/', $type);
1182                 if($parts[1] != '*') {
1183                         $ckey = common_mime_type_match($type, $cprefs);
1184                         if($ckey) {
1185                                 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1186                         }
1187                 }
1188         }
1189
1190         foreach(array_keys($cprefs) as $type) {
1191                 $parts = explode('/', $type);
1192                 if($parts[1] != '*' && !array_key_exists($type, $sprefs)) {
1193                         $skey = common_mime_type_match($type, $sprefs);
1194                         if($skey) {
1195                                 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1196                         }
1197                 }
1198         }
1199
1200         $bestq = 0;
1201         $besttype = "text/html";
1202
1203         foreach(array_keys($combine) as $type) {
1204                 if($combine[$type] > $bestq) {
1205                         $besttype = $type;
1206                         $bestq = $combine[$type];
1207                 }
1208         }
1209
1210         return $besttype;
1211 }
1212
1213 function common_config($main, $sub) {
1214         global $config;
1215         return $config[$main][$sub];
1216 }
1217
1218 function common_copy_args($from) {
1219         $to = array();
1220         $strip = get_magic_quotes_gpc();
1221         foreach ($from as $k => $v) {
1222                 $to[$k] = ($strip) ? stripslashes($v) : $v;
1223         }
1224         return $to;
1225 }
1226
1227 function common_user_uri(&$user) {
1228         return common_local_url('userbyid', array('id' => $user->id));
1229 }
1230
1231 function common_notice_uri(&$notice) {
1232         return common_local_url('shownotice',
1233                 array('notice' => $notice->id));
1234 }
1235
1236 # 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1237
1238 function common_confirmation_code($bits) {
1239         # 36 alphanums - lookalikes (0, O, 1, I) = 32 chars = 5 bits
1240         static $codechars = '23456789ABCDEFGHJKLMNPQRSTUVWXYZ';
1241         $chars = ceil($bits/5);
1242         $code = '';
1243         for ($i = 0; $i < $chars; $i++) {
1244                 # XXX: convert to string and back
1245                 $num = hexdec(common_good_rand(1));
1246                 # XXX: randomness is too precious to throw away almost
1247                 # 40% of the bits we get!
1248                 $code .= $codechars[$num%32];
1249         }
1250         return $code;
1251 }
1252
1253 # convert markup to HTML
1254
1255 function common_markup_to_html($c) {
1256         $c = preg_replace('/%%action.(\w+)%%/e', "common_local_url('\\1')", $c);
1257         $c = preg_replace('/%%doc.(\w+)%%/e', "common_local_url('doc', array('title'=>'\\1'))", $c);
1258         $c = preg_replace('/%%(\w+).(\w+)%%/e', 'common_config(\'\\1\', \'\\2\')', $c);
1259         return Markdown($c);
1260 }