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