includes/functions.php

   1 <?php
   2 /*
   3  * YOURLS
   4  * Function library
   5  */
   6
   7 /**
   8  * Determine the allowed character set in short URLs
   9  *
  10  */
  11 function yourls_get_shorturl_charset() {
  12         static $charset = null;
  13         if( $charset !== null )
  14                 return $charset;
  15
  16         if( !defined('YOURLS_URL_CONVERT') ) {
  17                 $charset = '0123456789abcdefghijklmnopqrstuvwxyz';
  18         } else {
  19                 switch( YOURLS_URL_CONVERT ) {
  20                         case 36:
  21                                 $charset = '0123456789abcdefghijklmnopqrstuvwxyz';
  22                                 break;
  23                         case 62:
  24                         case 64: // just because some people get this wrong in their config.php
  25                                 $charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
  26                                 break;
  27                 }
  28         }
  29
  30         $charset = yourls_apply_filter( 'get_shorturl_charset', $charset );
  31         return $charset;
  32 }
  33
  34 /**
  35  * Make an optimized regexp pattern from a string of characters
  36  *
  37  */
  38 function yourls_make_regexp_pattern( $string ) {
  39         $pattern = preg_quote( $string, '-' ); // add - as an escaped characters -- this is fixed in PHP 5.3
  40         // TODO: replace char sequences by smart sequences such as 0-9, a-z, A-Z ... ?
  41         return $pattern;
  42 }
  43
  44 /**
  45  * Is a URL a short URL? Accept either 'http://sho.rt/abc' or 'abc'
  46  *
  47  */
  48 function yourls_is_shorturl( $shorturl ) {
  49         // TODO: make sure this function evolves with the feature set.
  50
  51         $is_short = false;
  52
  53         // Is $shorturl a URL (http://sho.rt/abc) or a keyword (abc) ?
  54         if( yourls_get_protocol( $shorturl ) ) {
  55                 $keyword = yourls_get_relative_url( $shorturl );
  56         } else {
  57                 $keyword = $shorturl;
  58         }
  59
  60         // Check if it's a valid && used keyword
  61         if( $keyword && $keyword == yourls_sanitize_string( $keyword ) && yourls_keyword_is_taken( $keyword ) ) {
  62                 $is_short = true;
  63         }
  64
  65         return yourls_apply_filter( 'is_shorturl', $is_short, $shorturl );
  66 }
  67
  68 /**
  69  * Check to see if a given keyword is reserved (ie reserved URL or an existing page). Returns bool
  70  *
  71  */
  72 function yourls_keyword_is_reserved( $keyword ) {
  73         global $yourls_reserved_URL;
  74         $keyword = yourls_sanitize_keyword( $keyword );
  75         $reserved = false;
  76
  77         if ( in_array( $keyword, $yourls_reserved_URL)
  78                 or file_exists( YOURLS_ABSPATH ."/pages/$keyword.php" )
  79                 or is_dir( YOURLS_ABSPATH ."/$keyword" )
  80         )
  81                 $reserved = true;
  82
  83         return yourls_apply_filter( 'keyword_is_reserved', $reserved, $keyword );
  84 }
  85
  86 /**
  87  * Function: Get client IP Address. Returns a DB safe string.
  88  *
  89  */
  90 function yourls_get_IP() {
  91         $ip = '';
  92
  93         // Precedence: if set, X-Forwarded-For > HTTP_X_FORWARDED_FOR > HTTP_CLIENT_IP > HTTP_VIA > REMOTE_ADDR
  94         $headers = array( 'X-Forwarded-For', 'HTTP_X_FORWARDED_FOR', 'HTTP_CLIENT_IP', 'HTTP_VIA', 'REMOTE_ADDR' );
  95         foreach( $headers as $header ) {
  96                 if ( !empty( $_SERVER[ $header ] ) ) {
  97                         $ip = $_SERVER[ $header ];
  98                         break;
  99                 }
 100         }
 101
 102         // headers can contain multiple IPs (X-Forwarded-For = client, proxy1, proxy2). Take first one.
 103         if ( strpos( $ip, ',' ) !== false )
 104                 $ip = substr( $ip, 0, strpos( $ip, ',' ) );
 105
 106         return yourls_apply_filter( 'get_IP', yourls_sanitize_ip( $ip ) );
 107 }
 108
 109 /**
 110  * Get next id a new link will have if no custom keyword provided
 111  *
 112  */
 113 function yourls_get_next_decimal() {
 114         return yourls_apply_filter( 'get_next_decimal', (int)yourls_get_option( 'next_id' ) );
 115 }
 116
 117 /**
 118  * Update id for next link with no custom keyword
 119  *
 120  */
 121 function yourls_update_next_decimal( $int = '' ) {
 122         $int = ( $int == '' ) ? yourls_get_next_decimal() + 1 : (int)$int ;
 123         $update = yourls_update_option( 'next_id', $int );
 124         yourls_do_action( 'update_next_decimal', $int, $update );
 125         return $update;
 126 }
 127
 128 /**
 129  * Delete a link in the DB
 130  *
 131  */
 132 function yourls_delete_link_by_keyword( $keyword ) {
 133         global $ydb;
 134
 135         $table = YOURLS_DB_TABLE_URL;
 136         $keyword = yourls_sanitize_string( $keyword );
 137         $delete = $ydb->query("DELETE FROM `$table` WHERE `keyword` = '$keyword';");
 138         yourls_do_action( 'delete_link', $keyword, $delete );
 139         return $delete;
 140 }
 141
 142 /**
 143  * SQL query to insert a new link in the DB. Returns boolean for success or failure of the inserting
 144  *
 145  */
 146 function yourls_insert_link_in_db( $url, $keyword, $title = '' ) {
 147         global $ydb;
 148
 149         $url     = yourls_escape( yourls_sanitize_url( $url ) );
 150         $keyword = yourls_escape( yourls_sanitize_keyword( $keyword ) );
 151         $title   = yourls_escape( yourls_sanitize_title( $title ) );
 152
 153         $table = YOURLS_DB_TABLE_URL;
 154         $timestamp = date('Y-m-d H:i:s');
 155         $ip = yourls_get_IP();
 156         $insert = $ydb->query("INSERT INTO `$table` (`keyword`, `url`, `title`, `timestamp`, `ip`, `clicks`) VALUES('$keyword', '$url', '$title', '$timestamp', '$ip', 0);");
 157
 158         yourls_do_action( 'insert_link', (bool)$insert, $url, $keyword, $title, $timestamp, $ip );
 159
 160         return (bool)$insert;
 161 }
 162
 163 /**
 164  * Check if a URL already exists in the DB. Return NULL (doesn't exist) or an object with URL informations.
 165  *
 166  */
 167 function yourls_url_exists( $url ) {
 168         // Allow plugins to short-circuit the whole function
 169         $pre = yourls_apply_filter( 'shunt_url_exists', false, $url );
 170         if ( false !== $pre )
 171                 return $pre;
 172
 173         global $ydb;
 174         $table = YOURLS_DB_TABLE_URL;
 175         $strip_url = stripslashes($url);
 176         $url_exists = $ydb->get_row("SELECT * FROM `$table` WHERE `url` = '".$strip_url."';");
 177
 178         return yourls_apply_filter( 'url_exists', $url_exists, $url );
 179 }
 180
 181 /**
 182  * Add a new link in the DB, either with custom keyword, or find one
 183  *
 184  */
 185 function yourls_add_new_link( $url, $keyword = '', $title = '' ) {
 186         // Allow plugins to short-circuit the whole function
 187         $pre = yourls_apply_filter( 'shunt_add_new_link', false, $url, $keyword, $title );
 188         if ( false !== $pre )
 189                 return $pre;
 190
 191         $url = yourls_encodeURI( $url );
 192         $url = yourls_escape( yourls_sanitize_url( $url ) );
 193         if ( !$url || $url == 'http://' || $url == 'https://' ) {
 194                 $return['status']    = 'fail';
 195                 $return['code']      = 'error:nourl';
 196                 $return['message']   = yourls__( 'Missing or malformed URL' );
 197                 $return['errorCode'] = '400';
 198                 return yourls_apply_filter( 'add_new_link_fail_nourl', $return, $url, $keyword, $title );
 199         }
 200
 201         // Prevent DB flood
 202         $ip = yourls_get_IP();
 203         yourls_check_IP_flood( $ip );
 204
 205         // Prevent internal redirection loops: cannot shorten a shortened URL
 206         if( yourls_get_relative_url( $url ) ) {
 207                 if( yourls_is_shorturl( $url ) ) {
 208                         $return['status']    = 'fail';
 209                         $return['code']      = 'error:noloop';
 210                         $return['message']   = yourls__( 'URL is a short URL' );
 211                         $return['errorCode'] = '400';
 212                         return yourls_apply_filter( 'add_new_link_fail_noloop', $return, $url, $keyword, $title );
 213                 }
 214         }
 215
 216         yourls_do_action( 'pre_add_new_link', $url, $keyword, $title );
 217
 218         $strip_url = stripslashes( $url );
 219         $return = array();
 220
 221         // duplicates allowed or new URL => store it
 222         if( yourls_allow_duplicate_longurls() || !( $url_exists = yourls_url_exists( $url ) ) ) {
 223
 224                 if( isset( $title ) && !empty( $title ) ) {
 225                         $title = yourls_sanitize_title( $title );
 226                 } else {
 227                         $title = yourls_get_remote_title( $url );
 228                 }
 229                 $title = yourls_apply_filter( 'add_new_title', $title, $url, $keyword );
 230
 231                 // Custom keyword provided
 232                 if ( $keyword ) {
 233
 234                         yourls_do_action( 'add_new_link_custom_keyword', $url, $keyword, $title );
 235
 236                         $keyword = yourls_escape( yourls_sanitize_string( $keyword ) );
 237                         $keyword = yourls_apply_filter( 'custom_keyword', $keyword, $url, $title );
 238                         if ( !yourls_keyword_is_free( $keyword ) ) {
 239                                 // This shorturl either reserved or taken already
 240                                 $return['status']  = 'fail';
 241                                 $return['code']    = 'error:keyword';
 242                                 $return['message'] = yourls_s( 'Short URL %s already exists in database or is reserved', $keyword );
 243                         } else {
 244                                 // all clear, store !
 245                                 yourls_insert_link_in_db( $url, $keyword, $title );
 246                                 $return['url']      = array('keyword' => $keyword, 'url' => $strip_url, 'title' => $title, 'date' => date('Y-m-d H:i:s'), 'ip' => $ip );
 247                                 $return['status']   = 'success';
 248                                 $return['message']  = /* //translators: eg "http://someurl/ added to DB" */ yourls_s( '%s added to database', yourls_trim_long_string( $strip_url ) );
 249                                 $return['title']    = $title;
 250                                 $return['html']     = yourls_table_add_row( $keyword, $url, $title, $ip, 0, time() );
 251                                 $return['shorturl'] = YOURLS_SITE .'/'. $keyword;
 252                         }
 253
 254                 // Create random keyword
 255                 } else {
 256
 257                         yourls_do_action( 'add_new_link_create_keyword', $url, $keyword, $title );
 258
 259                         $timestamp = date( 'Y-m-d H:i:s' );
 260                         $id = yourls_get_next_decimal();
 261                         $ok = false;
 262                         do {
 263                                 $keyword = yourls_int2string( $id );
 264                                 $keyword = yourls_apply_filter( 'random_keyword', $keyword, $url, $title );
 265                                 if ( yourls_keyword_is_free($keyword) ) {
 266                                         if( @yourls_insert_link_in_db( $url, $keyword, $title ) ){
 267                                                 // everything ok, populate needed vars
 268                                                 $return['url']      = array('keyword' => $keyword, 'url' => $strip_url, 'title' => $title, 'date' => $timestamp, 'ip' => $ip );
 269                                                 $return['status']   = 'success';
 270                                                 $return['message']  = /* //translators: eg "http://someurl/ added to DB" */ yourls_s( '%s added to database', yourls_trim_long_string( $strip_url ) );
 271                                                 $return['title']    = $title;
 272                                                 $return['html']     = yourls_table_add_row( $keyword, $url, $title, $ip, 0, time() );
 273                                                 $return['shorturl'] = YOURLS_SITE .'/'. $keyword;
 274                                         }else{
 275                                                 // database error, couldnt store result
 276                                                 $return['status']   = 'fail';
 277                                                 $return['code']     = 'error:db';
 278                                                 $return['message']  = yourls_s( 'Error saving url to database' );
 279                                         }
 280                                         $ok = true;
 281                                 }
 282                                 $id++;
 283                         } while ( !$ok );
 284                         @yourls_update_next_decimal( $id );
 285                 }
 286
 287         // URL was already stored
 288         } else {
 289
 290                 yourls_do_action( 'add_new_link_already_stored', $url, $keyword, $title );
 291
 292                 $return['status']   = 'fail';
 293                 $return['code']     = 'error:url';
 294                 $return['url']      = array( 'keyword' => $url_exists->keyword, 'url' => $strip_url, 'title' => $url_exists->title, 'date' => $url_exists->timestamp, 'ip' => $url_exists->ip, 'clicks' => $url_exists->clicks );
 295                 $return['message']  = /* //translators: eg "http://someurl/ already exists" */ yourls_s( '%s already exists in database', yourls_trim_long_string( $strip_url ) );
 296                 $return['title']    = $url_exists->title;
 297                 $return['shorturl'] = YOURLS_SITE .'/'. $url_exists->keyword;
 298         }
 299
 300         yourls_do_action( 'post_add_new_link', $url, $keyword, $title );
 301
 302         $return['statusCode'] = 200; // regardless of result, this is still a valid request
 303         return yourls_apply_filter( 'add_new_link', $return, $url, $keyword, $title );
 304 }
 305
 306
 307 /**
 308  * Edit a link
 309  *
 310  */
 311 function yourls_edit_link( $url, $keyword, $newkeyword='', $title='' ) {
 312         global $ydb;
 313
 314         $table = YOURLS_DB_TABLE_URL;
 315         $url = yourls_escape (yourls_sanitize_url( $url ) );
 316         $keyword = yourls_escape( yourls_sanitize_string( $keyword ) );
 317         $title = yourls_escape( yourls_sanitize_title( $title ) );
 318         $newkeyword = yourls_escape( yourls_sanitize_string( $newkeyword ) );
 319         $strip_url = stripslashes( $url );
 320         $strip_title = stripslashes( $title );
 321         $old_url = $ydb->get_var( "SELECT `url` FROM `$table` WHERE `keyword` = '$keyword';" );
 322
 323         // Check if new URL is not here already
 324         if ( $old_url != $url && !yourls_allow_duplicate_longurls() ) {
 325                 $new_url_already_there = intval($ydb->get_var("SELECT COUNT(keyword) FROM `$table` WHERE `url` = '$strip_url';"));
 326         } else {
 327                 $new_url_already_there = false;
 328         }
 329
 330         // Check if the new keyword is not here already
 331         if ( $newkeyword != $keyword ) {
 332                 $keyword_is_ok = yourls_keyword_is_free( $newkeyword );
 333         } else {
 334                 $keyword_is_ok = true;
 335         }
 336
 337         yourls_do_action( 'pre_edit_link', $url, $keyword, $newkeyword, $new_url_already_there, $keyword_is_ok );
 338
 339         // All clear, update
 340         if ( ( !$new_url_already_there || yourls_allow_duplicate_longurls() ) && $keyword_is_ok ) {
 341                         $update_url = $ydb->query( "UPDATE `$table` SET `url` = '$url', `keyword` = '$newkeyword', `title` = '$title' WHERE `keyword` = '$keyword';" );
 342                 if( $update_url ) {
 343                         $return['url']     = array( 'keyword' => $newkeyword, 'shorturl' => YOURLS_SITE.'/'.$newkeyword, 'url' => $strip_url, 'display_url' => yourls_trim_long_string( $strip_url ), 'title' => $strip_title, 'display_title' => yourls_trim_long_string( $strip_title ) );
 344                         $return['status']  = 'success';
 345                         $return['message'] = yourls__( 'Link updated in database' );
 346                 } else {
 347                         $return['status']  = 'fail';
 348                         $return['message'] = /* //translators: "Error updating http://someurl/ (Shorturl: http://sho.rt/blah)" */ yourls_s( 'Error updating %s (Short URL: %s)', yourls_trim_long_string( $strip_url ), $keyword ) ;
 349                 }
 350
 351         // Nope
 352         } else {
 353                 $return['status']  = 'fail';
 354                 $return['message'] = yourls__( 'URL or keyword already exists in database' );
 355         }
 356
 357         return yourls_apply_filter( 'edit_link', $return, $url, $keyword, $newkeyword, $title, $new_url_already_there, $keyword_is_ok );
 358 }
 359
 360 /**
 361  * Update a title link (no checks for duplicates etc..)
 362  *
 363  */
 364 function yourls_edit_link_title( $keyword, $title ) {
 365         global $ydb;
 366
 367         $keyword = yourls_escape( yourls_sanitize_keyword( $keyword ) );
 368         $title = yourls_escape( yourls_sanitize_title( $title ) );
 369
 370         $table = YOURLS_DB_TABLE_URL;
 371         $update = $ydb->query("UPDATE `$table` SET `title` = '$title' WHERE `keyword` = '$keyword';");
 372
 373         return $update;
 374 }
 375
 376
 377 /**
 378  * Check if keyword id is free (ie not already taken, and not reserved). Return bool.
 379  *
 380  */
 381 function yourls_keyword_is_free( $keyword ) {
 382         $free = true;
 383         if ( yourls_keyword_is_reserved( $keyword ) or yourls_keyword_is_taken( $keyword ) )
 384                 $free = false;
 385
 386         return yourls_apply_filter( 'keyword_is_free', $free, $keyword );
 387 }
 388
 389 /**
 390  * Check if a keyword is taken (ie there is already a short URL with this id). Return bool.
 391  *
 392  */
 393 function yourls_keyword_is_taken( $keyword ) {
 394
 395         // Allow plugins to short-circuit the whole function
 396         $pre = yourls_apply_filter( 'shunt_keyword_is_taken', false, $keyword );
 397         if ( false !== $pre )
 398                 return $pre;
 399
 400         global $ydb;
 401         $keyword = yourls_sanitize_keyword( $keyword );
 402         $taken = false;
 403         $table = YOURLS_DB_TABLE_URL;
 404         $already_exists = $ydb->get_var( "SELECT COUNT(`keyword`) FROM `$table` WHERE `keyword` = '$keyword';" );
 405         if ( $already_exists )
 406                 $taken = true;
 407
 408         return yourls_apply_filter( 'keyword_is_taken', $taken, $keyword );
 409 }
 410
 411
 412 /**
 413  * Connect to DB
 414  *
 415  */
 416 function yourls_db_connect() {
 417         global $ydb;
 418
 419         if (   !defined( 'YOURLS_DB_USER' )
 420                 or !defined( 'YOURLS_DB_PASS' )
 421                 or !defined( 'YOURLS_DB_NAME' )
 422                 or !defined( 'YOURLS_DB_HOST' )
 423         ) yourls_die ( yourls__( 'Incorrect DB config, or could not connect to DB' ), yourls__( 'Fatal error' ), 503 );
 424
 425         // Are we standalone or in the WordPress environment?
 426         if ( class_exists( 'wpdb', false ) ) {
 427                 /* TODO: should we deprecate this? Follow WP dev in that area */
 428                 $ydb =  new wpdb( YOURLS_DB_USER, YOURLS_DB_PASS, YOURLS_DB_NAME, YOURLS_DB_HOST );
 429         } else {
 430                 yourls_set_DB_driver();
 431         }
 432
 433         // Check if connection attempt raised an error. It seems that only PDO does, though.
 434         if ( $ydb->last_error )
 435                 yourls_die( $ydb->last_error, yourls__( 'Fatal error' ), 503 );
 436
 437         if ( defined( 'YOURLS_DEBUG' ) && YOURLS_DEBUG === true )
 438                 $ydb->show_errors = true;
 439
 440         return $ydb;
 441 }
 442
 443 /**
 444  * Return XML output.
 445  *
 446  */
 447 function yourls_xml_encode( $array ) {
 448         require_once( YOURLS_INC.'/functions-xml.php' );
 449         $converter= new yourls_array2xml;
 450         return $converter->array2xml( $array );
 451 }
 452
 453 /**
 454  * Return array of all information associated with keyword. Returns false if keyword not found. Set optional $use_cache to false to force fetching from DB
 455  *
 456  */
 457 function yourls_get_keyword_infos( $keyword, $use_cache = true ) {
 458         global $ydb;
 459         $keyword = yourls_sanitize_string( $keyword );
 460
 461         yourls_do_action( 'pre_get_keyword', $keyword, $use_cache );
 462
 463         if( isset( $ydb->infos[$keyword] ) && $use_cache == true ) {
 464                 return yourls_apply_filter( 'get_keyword_infos', $ydb->infos[$keyword], $keyword );
 465         }
 466
 467         yourls_do_action( 'get_keyword_not_cached', $keyword );
 468
 469         $table = YOURLS_DB_TABLE_URL;
 470         $infos = $ydb->get_row( "SELECT * FROM `$table` WHERE `keyword` = '$keyword'" );
 471
 472         if( $infos ) {
 473                 $infos = (array)$infos;
 474                 $ydb->infos[ $keyword ] = $infos;
 475         } else {
 476                 $ydb->infos[ $keyword ] = false;
 477         }
 478
 479         return yourls_apply_filter( 'get_keyword_infos', $ydb->infos[$keyword], $keyword );
 480 }
 481
 482 /**
 483  * Return (string) selected information associated with a keyword. Optional $notfound = string default message if nothing found
 484  *
 485  */
 486 function yourls_get_keyword_info( $keyword, $field, $notfound = false ) {
 487
 488         // Allow plugins to short-circuit the whole function
 489         $pre = yourls_apply_filter( 'shunt_get_keyword_info', false, $keyword, $field, $notfound );
 490         if ( false !== $pre )
 491                 return $pre;
 492
 493         $keyword = yourls_sanitize_string( $keyword );
 494         $infos = yourls_get_keyword_infos( $keyword );
 495
 496         $return = $notfound;
 497         if ( isset( $infos[ $field ] ) && $infos[ $field ] !== false )
 498                 $return = $infos[ $field ];
 499
 500         return yourls_apply_filter( 'get_keyword_info', $return, $keyword, $field, $notfound );
 501 }
 502
 503 /**
 504  * Return title associated with keyword. Optional $notfound = string default message if nothing found
 505  *
 506  */
 507 function yourls_get_keyword_title( $keyword, $notfound = false ) {
 508         return yourls_get_keyword_info( $keyword, 'title', $notfound );
 509 }
 510
 511 /**
 512  * Return long URL associated with keyword. Optional $notfound = string default message if nothing found
 513  *
 514  */
 515 function yourls_get_keyword_longurl( $keyword, $notfound = false ) {
 516         return yourls_get_keyword_info( $keyword, 'url', $notfound );
 517 }
 518
 519 /**
 520  * Return number of clicks on a keyword. Optional $notfound = string default message if nothing found
 521  *
 522  */
 523 function yourls_get_keyword_clicks( $keyword, $notfound = false ) {
 524         return yourls_get_keyword_info( $keyword, 'clicks', $notfound );
 525 }
 526
 527 /**
 528  * Return IP that added a keyword. Optional $notfound = string default message if nothing found
 529  *
 530  */
 531 function yourls_get_keyword_IP( $keyword, $notfound = false ) {
 532         return yourls_get_keyword_info( $keyword, 'ip', $notfound );
 533 }
 534
 535 /**
 536  * Return timestamp associated with a keyword. Optional $notfound = string default message if nothing found
 537  *
 538  */
 539 function yourls_get_keyword_timestamp( $keyword, $notfound = false ) {
 540         return yourls_get_keyword_info( $keyword, 'timestamp', $notfound );
 541 }
 542
 543 /**
 544  * Update click count on a short URL. Return 0/1 for error/success.
 545  *
 546  */
 547 function yourls_update_clicks( $keyword, $clicks = false ) {
 548         // Allow plugins to short-circuit the whole function
 549         $pre = yourls_apply_filter( 'shunt_update_clicks', false, $keyword, $clicks );
 550         if ( false !== $pre )
 551                 return $pre;
 552
 553         global $ydb;
 554         $keyword = yourls_sanitize_string( $keyword );
 555         $table = YOURLS_DB_TABLE_URL;
 556         if ( $clicks !== false && is_int( $clicks ) && $clicks >= 0 )
 557                 $update = $ydb->query( "UPDATE `$table` SET `clicks` = $clicks WHERE `keyword` = '$keyword'" );
 558         else
 559                 $update = $ydb->query( "UPDATE `$table` SET `clicks` = clicks + 1 WHERE `keyword` = '$keyword'" );
 560
 561         yourls_do_action( 'update_clicks', $keyword, $update, $clicks );
 562         return $update;
 563 }
 564
 565 /**
 566  * Return array of stats. (string)$filter is 'bottom', 'last', 'rand' or 'top'. (int)$limit is the number of links to return
 567  *
 568  */
 569 function yourls_get_stats( $filter = 'top', $limit = 10, $start = 0 ) {
 570         global $ydb;
 571
 572         switch( $filter ) {
 573                 case 'bottom':
 574                         $sort_by    = 'clicks';
 575                         $sort_order = 'asc';
 576                         break;
 577                 case 'last':
 578                         $sort_by    = 'timestamp';
 579                         $sort_order = 'desc';
 580                         break;
 581                 case 'rand':
 582                 case 'random':
 583                         $sort_by    = 'RAND()';
 584                         $sort_order = '';
 585                         break;
 586                 case 'top':
 587                 default:
 588                         $sort_by    = 'clicks';
 589                         $sort_order = 'desc';
 590                         break;
 591         }
 592
 593         // Fetch links
 594         $limit = intval( $limit );
 595         $start = intval( $start );
 596         if ( $limit > 0 ) {
 597
 598                 $table_url = YOURLS_DB_TABLE_URL;
 599                 $results = $ydb->get_results( "SELECT * FROM `$table_url` WHERE 1=1 ORDER BY `$sort_by` $sort_order LIMIT $start, $limit;" );
 600
 601                 $return = array();
 602                 $i = 1;
 603
 604                 foreach ( (array)$results as $res ) {
 605                         $return['links']['link_'.$i++] = array(
 606                                 'shorturl' => YOURLS_SITE .'/'. $res->keyword,
 607                                 'url'      => $res->url,
 608                                 'title'    => $res->title,
 609                                 'timestamp'=> $res->timestamp,
 610                                 'ip'       => $res->ip,
 611                                 'clicks'   => $res->clicks,
 612                         );
 613                 }
 614         }
 615
 616         $return['stats'] = yourls_get_db_stats();
 617
 618         $return['statusCode'] = 200;
 619
 620         return yourls_apply_filter( 'get_stats', $return, $filter, $limit, $start );
 621 }
 622
 623 /**
 624  * Return array of stats. (string)$filter is 'bottom', 'last', 'rand' or 'top'. (int)$limit is the number of links to return
 625  *
 626  */
 627 function yourls_get_link_stats( $shorturl ) {
 628         global $ydb;
 629
 630         $table_url = YOURLS_DB_TABLE_URL;
 631         $res = $ydb->get_row( "SELECT * FROM `$table_url` WHERE keyword = '$shorturl';" );
 632         $return = array();
 633
 634         if( !$res ) {
 635                 // non existent link
 636                 $return = array(
 637                         'statusCode' => 404,
 638                         'message'    => 'Error: short URL not found',
 639                 );
 640         } else {
 641                 $return = array(
 642                         'statusCode' => 200,
 643                         'message'    => 'success',
 644                         'link'       => array(
 645                                 'shorturl' => YOURLS_SITE .'/'. $res->keyword,
 646                                 'url'      => $res->url,
 647                                 'title'    => $res->title,
 648                                 'timestamp'=> $res->timestamp,
 649                                 'ip'       => $res->ip,
 650                                 'clicks'   => $res->clicks,
 651                         )
 652                 );
 653         }
 654
 655         return yourls_apply_filter( 'get_link_stats', $return, $shorturl );
 656 }
 657
 658 /**
 659  * Get total number of URLs and sum of clicks. Input: optional "AND WHERE" clause. Returns array
 660  *
 661  */
 662 function yourls_get_db_stats( $where = '' ) {
 663         global $ydb;
 664         $table_url = YOURLS_DB_TABLE_URL;
 665
 666         $totals = $ydb->get_row( "SELECT COUNT(keyword) as count, SUM(clicks) as sum FROM `$table_url` WHERE 1=1 $where" );
 667         $return = array( 'total_links' => $totals->count, 'total_clicks' => $totals->sum );
 668
 669         return yourls_apply_filter( 'get_db_stats', $return, $where );
 670 }
 671
 672 /**
 673  * Get number of SQL queries performed
 674  *
 675  */
 676 function yourls_get_num_queries() {
 677         global $ydb;
 678
 679         return yourls_apply_filter( 'get_num_queries', $ydb->num_queries );
 680 }
 681
 682 /**
 683  * Returns a sanitized a user agent string. Given what I found on http://www.user-agents.org/ it should be OK.
 684  *
 685  */
 686 function yourls_get_user_agent() {
 687         if ( !isset( $_SERVER['HTTP_USER_AGENT'] ) )
 688                 return '-';
 689
 690         $ua = strip_tags( html_entity_decode( $_SERVER['HTTP_USER_AGENT'] ));
 691         $ua = preg_replace('![^0-9a-zA-Z\':., /{}\(\)\[\]\+@&\!\?;_\-=~\*\#]!', '', $ua );
 692
 693         return yourls_apply_filter( 'get_user_agent', substr( $ua, 0, 254 ) );
 694 }
 695
 696 /**
 697  * Redirect to another page
 698  *
 699  */
 700 function yourls_redirect( $location, $code = 301 ) {
 701         yourls_do_action( 'pre_redirect', $location, $code );
 702         $location = yourls_apply_filter( 'redirect_location', $location, $code );
 703         $code     = yourls_apply_filter( 'redirect_code', $code, $location );
 704         // Redirect, either properly if possible, or via Javascript otherwise
 705         if( !headers_sent() ) {
 706                 yourls_status_header( $code );
 707                 header( "Location: $location" );
 708         } else {
 709                 yourls_redirect_javascript( $location );
 710         }
 711         die();
 712 }
 713
 714 /**
 715  * Set HTTP status header
 716  *
 717  */
 718 function yourls_status_header( $code = 200 ) {
 719         if( headers_sent() )
 720                 return;
 721
 722         $protocol = $_SERVER['SERVER_PROTOCOL'];
 723         if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol )
 724                 $protocol = 'HTTP/1.0';
 725
 726         $code = intval( $code );
 727         $desc = yourls_get_HTTP_status( $code );
 728
 729         @header ("$protocol $code $desc"); // This causes problems on IIS and some FastCGI setups
 730         yourls_do_action( 'status_header', $code );
 731 }
 732
 733 /**
 734  * Redirect to another page using Javascript. Set optional (bool)$dontwait to false to force manual redirection (make sure a message has been read by user)
 735  *
 736  */
 737 function yourls_redirect_javascript( $location, $dontwait = true ) {
 738         yourls_do_action( 'pre_redirect_javascript', $location, $dontwait );
 739         $location = yourls_apply_filter( 'redirect_javascript', $location, $dontwait );
 740         if( $dontwait ) {
 741                 $message = yourls_s( 'if you are not redirected after 10 seconds, please <a href="%s">click here</a>', $location );
 742                 echo <<<REDIR
 743                 <script type="text/javascript">
 744                 window.location="$location";
 745                 </script>
 746                 <small>($message)</small>
 747 REDIR;
 748         } else {
 749                 echo '<p>' . yourls_s( 'Please <a href="%s">click here</a>', $location ) . '</p>';
 750         }
 751         yourls_do_action( 'post_redirect_javascript', $location );
 752 }
 753
 754 /**
 755  * Return a HTTP status code
 756  *
 757  */
 758 function yourls_get_HTTP_status( $code ) {
 759         $code = intval( $code );
 760         $headers_desc = array(
 761                 100 => 'Continue',
 762                 101 => 'Switching Protocols',
 763                 102 => 'Processing',
 764
 765                 200 => 'OK',
 766                 201 => 'Created',
 767                 202 => 'Accepted',
 768                 203 => 'Non-Authoritative Information',
 769                 204 => 'No Content',
 770                 205 => 'Reset Content',
 771                 206 => 'Partial Content',
 772                 207 => 'Multi-Status',
 773                 226 => 'IM Used',
 774
 775                 300 => 'Multiple Choices',
 776                 301 => 'Moved Permanently',
 777                 302 => 'Found',
 778                 303 => 'See Other',
 779                 304 => 'Not Modified',
 780                 305 => 'Use Proxy',
 781                 306 => 'Reserved',
 782                 307 => 'Temporary Redirect',
 783
 784                 400 => 'Bad Request',
 785                 401 => 'Unauthorized',
 786                 402 => 'Payment Required',
 787                 403 => 'Forbidden',
 788                 404 => 'Not Found',
 789                 405 => 'Method Not Allowed',
 790                 406 => 'Not Acceptable',
 791                 407 => 'Proxy Authentication Required',
 792                 408 => 'Request Timeout',
 793                 409 => 'Conflict',
 794                 410 => 'Gone',
 795                 411 => 'Length Required',
 796                 412 => 'Precondition Failed',
 797                 413 => 'Request Entity Too Large',
 798                 414 => 'Request-URI Too Long',
 799                 415 => 'Unsupported Media Type',
 800                 416 => 'Requested Range Not Satisfiable',
 801                 417 => 'Expectation Failed',
 802                 422 => 'Unprocessable Entity',
 803                 423 => 'Locked',
 804                 424 => 'Failed Dependency',
 805                 426 => 'Upgrade Required',
 806
 807                 500 => 'Internal Server Error',
 808                 501 => 'Not Implemented',
 809                 502 => 'Bad Gateway',
 810                 503 => 'Service Unavailable',
 811                 504 => 'Gateway Timeout',
 812                 505 => 'HTTP Version Not Supported',
 813                 506 => 'Variant Also Negotiates',
 814                 507 => 'Insufficient Storage',
 815                 510 => 'Not Extended'
 816         );
 817
 818         if ( isset( $headers_desc[$code] ) )
 819                 return $headers_desc[$code];
 820         else
 821                 return '';
 822 }
 823
 824
 825 /**
 826  * Log a redirect (for stats)
 827  *
 828  */
 829 function yourls_log_redirect( $keyword ) {
 830         // Allow plugins to short-circuit the whole function
 831         $pre = yourls_apply_filter( 'shunt_log_redirect', false, $keyword );
 832         if ( false !== $pre )
 833                 return $pre;
 834
 835         if ( !yourls_do_log_redirect() )
 836                 return true;
 837
 838         global $ydb;
 839         $table = YOURLS_DB_TABLE_LOG;
 840
 841         $keyword = yourls_sanitize_string( $keyword );
 842         $referrer = ( isset( $_SERVER['HTTP_REFERER'] ) ? yourls_sanitize_url( $_SERVER['HTTP_REFERER'] ) : 'direct' );
 843         $ua = yourls_get_user_agent();
 844         $ip = yourls_get_IP();
 845         $location = yourls_geo_ip_to_countrycode( $ip );
 846
 847         return $ydb->query( "INSERT INTO `$table` (click_time, shorturl, referrer, user_agent, ip_address, country_code) VALUES (NOW(), '$keyword', '$referrer', '$ua', '$ip', '$location')" );
 848 }
 849
 850 /**
 851  * Check if we want to not log redirects (for stats)
 852  *
 853  */
 854 function yourls_do_log_redirect() {
 855         return ( !defined( 'YOURLS_NOSTATS' ) || YOURLS_NOSTATS != true );
 856 }
 857
 858 /**
 859  * Converts an IP to a 2 letter country code, using GeoIP database if available in includes/geo/
 860  *
 861  * @since 1.4
 862  * @param string $ip IP or, if empty string, will be current user IP
 863  * @param string $defaut Default string to return if IP doesn't resolve to a country (malformed, private IP...)
 864  * @return string 2 letter country code (eg 'US') or $default
 865  */
 866 function yourls_geo_ip_to_countrycode( $ip = '', $default = '' ) {
 867         // Allow plugins to short-circuit the Geo IP API
 868         $location = yourls_apply_filter( 'shunt_geo_ip_to_countrycode', false, $ip, $default ); // at this point $ip can be '', check if your plugin hooks in here
 869         if ( false !== $location )
 870                 return $location;
 871
 872         if ( $ip == '' )
 873                 $ip = yourls_get_IP();
 874
 875         // Use IPv4 or IPv6 DB & functions
 876         if( false === filter_var( $ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6 ) ) {
 877                 $db   = 'GeoIP.dat';
 878                 $func = 'geoip_country_code_by_addr';
 879         } else {
 880                 $db   = 'GeoIPv6.dat';
 881                 $func = 'geoip_country_code_by_addr_v6';
 882         }
 883
 884         if ( !file_exists( YOURLS_INC . '/geo/' . $db ) || !file_exists( YOURLS_INC .'/geo/geoip.inc' ) )
 885                 return $default;
 886
 887         require_once( YOURLS_INC . '/geo/geoip.inc' );
 888         $gi = geoip_open( YOURLS_INC . '/geo/' . $db, GEOIP_STANDARD );
 889         try {
 890                 $location = call_user_func( $func, $gi, $ip );
 891         } catch ( Exception $e ) {
 892                 $location = '';
 893         }
 894         geoip_close( $gi );
 895
 896         if( '' == $location )
 897                 $location = $default;
 898
 899         return yourls_apply_filter( 'geo_ip_to_countrycode', $location, $ip, $default );
 900 }
 901
 902 /**
 903  * Converts a 2 letter country code to long name (ie AU -> Australia)
 904  *
 905  */
 906 function yourls_geo_countrycode_to_countryname( $code ) {
 907         // Allow plugins to short-circuit the Geo IP API
 908         $country = yourls_apply_filter( 'shunt_geo_countrycode_to_countryname', false, $code );
 909         if ( false !== $country )
 910                 return $country;
 911
 912         // Load the Geo class if not already done
 913         if( !class_exists( 'GeoIP', false ) ) {
 914                 $temp = yourls_geo_ip_to_countrycode( '127.0.0.1' );
 915         }
 916
 917         if( class_exists( 'GeoIP', false ) ) {
 918                 $geo  = new GeoIP;
 919                 $id   = $geo->GEOIP_COUNTRY_CODE_TO_NUMBER[ $code ];
 920                 $long = $geo->GEOIP_COUNTRY_NAMES[ $id ];
 921                 return $long;
 922         } else {
 923                 return false;
 924         }
 925 }
 926
 927 /**
 928  * Return flag URL from 2 letter country code
 929  *
 930  */
 931 function yourls_geo_get_flag( $code ) {
 932         if( file_exists( YOURLS_INC.'/geo/flags/flag_'.strtolower($code).'.gif' ) ) {
 933                 $img = yourls_match_current_protocol( YOURLS_SITE.'/includes/geo/flags/flag_'.( strtolower( $code ) ).'.gif' );
 934         } else {
 935                 $img = false;
 936         }
 937         return yourls_apply_filter( 'geo_get_flag', $img, $code );
 938 }
 939
 940
 941 /**
 942  * Check if an upgrade is needed
 943  *
 944  */
 945 function yourls_upgrade_is_needed() {
 946         // check YOURLS_DB_VERSION exist && match values stored in YOURLS_DB_TABLE_OPTIONS
 947         list( $currentver, $currentsql ) = yourls_get_current_version_from_sql();
 948         if( $currentsql < YOURLS_DB_VERSION )
 949                 return true;
 950
 951         return false;
 952 }
 953
 954 /**
 955  * Get current version & db version as stored in the options DB. Prior to 1.4 there's no option table.
 956  *
 957  */
 958 function yourls_get_current_version_from_sql() {
 959         $currentver = yourls_get_option( 'version' );
 960         $currentsql = yourls_get_option( 'db_version' );
 961
 962         // Values if version is 1.3
 963         if( !$currentver )
 964                 $currentver = '1.3';
 965         if( !$currentsql )
 966                 $currentsql = '100';
 967
 968         return array( $currentver, $currentsql);
 969 }
 970
 971 /**
 972  * Read an option from DB (or from cache if available). Return value or $default if not found
 973  *
 974  * Pretty much stolen from WordPress
 975  *
 976  * @since 1.4
 977  * @param string $option Option name. Expected to not be SQL-escaped.
 978  * @param mixed $default Optional value to return if option doesn't exist. Default false.
 979  * @return mixed Value set for the option.
 980  */
 981 function yourls_get_option( $option_name, $default = false ) {
 982         global $ydb;
 983
 984         // Allow plugins to short-circuit options
 985         $pre = yourls_apply_filter( 'shunt_option_'.$option_name, false );
 986         if ( false !== $pre )
 987                 return $pre;
 988
 989         // If option not cached already, get its value from the DB
 990         if ( !isset( $ydb->option[$option_name] ) ) {
 991                 $table = YOURLS_DB_TABLE_OPTIONS;
 992                 $option_name = yourls_escape( $option_name );
 993                 $row = $ydb->get_row( "SELECT `option_value` FROM `$table` WHERE `option_name` = '$option_name' LIMIT 1" );
 994                 if ( is_object( $row) ) { // Has to be get_row instead of get_var because of funkiness with 0, false, null values
 995                         $value = $row->option_value;
 996                 } else { // option does not exist, so we must cache its non-existence
 997                         $value = $default;
 998                 }
 999                 $ydb->option[ $option_name ] = yourls_maybe_unserialize( $value );
1000         }
1001
1002         return yourls_apply_filter( 'get_option_'.$option_name, $ydb->option[$option_name] );
1003 }
1004
1005 /**
1006  * Read all options from DB at once
1007  *
1008  * The goal is to read all option at once and then populate array $ydb->option, to prevent further
1009  * SQL queries if we need to read an option value later.
1010  * It's also a simple check whether YOURLS is installed or not (no option = assuming not installed)
1011  *
1012  * @since 1.4
1013  */
1014 function yourls_get_all_options() {
1015         global $ydb;
1016
1017         // Allow plugins to short-circuit all options. (Note: regular plugins are loaded after all options)
1018         $pre = yourls_apply_filter( 'shunt_all_options', false );
1019         if ( false !== $pre )
1020                 return $pre;
1021
1022         $table = YOURLS_DB_TABLE_OPTIONS;
1023
1024         $allopt = $ydb->get_results( "SELECT `option_name`, `option_value` FROM `$table` WHERE 1=1" );
1025
1026         foreach( (array)$allopt as $option ) {
1027                 $ydb->option[ $option->option_name ] = yourls_maybe_unserialize( $option->option_value );
1028         }
1029
1030         if( property_exists( $ydb, 'option' ) ) {
1031                 $ydb->option = yourls_apply_filter( 'get_all_options', $ydb->option );
1032                 $ydb->installed = true;
1033         } else {
1034                 // Zero option found: assume YOURLS is not installed
1035                 $ydb->installed = false;
1036         }
1037 }
1038
1039 /**
1040  * Update (add if doesn't exist) an option to DB
1041  *
1042  * Pretty much stolen from WordPress
1043  *
1044  * @since 1.4
1045  * @param string $option Option name. Expected to not be SQL-escaped.
1046  * @param mixed $newvalue Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
1047  * @return bool False if value was not updated, true otherwise.
1048  */
1049 function yourls_update_option( $option_name, $newvalue ) {
1050         global $ydb;
1051         $table = YOURLS_DB_TABLE_OPTIONS;
1052
1053         $safe_option_name = yourls_escape( $option_name );
1054
1055         $oldvalue = yourls_get_option( $safe_option_name );
1056
1057         // If the new and old values are the same, no need to update.
1058         if ( $newvalue === $oldvalue )
1059                 return false;
1060
1061         if ( false === $oldvalue ) {
1062                 yourls_add_option( $option_name, $newvalue );
1063                 return true;
1064         }
1065
1066         $_newvalue = yourls_escape( yourls_maybe_serialize( $newvalue ) );
1067
1068         yourls_do_action( 'update_option', $option_name, $oldvalue, $newvalue );
1069
1070         $ydb->query( "UPDATE `$table` SET `option_value` = '$_newvalue' WHERE `option_name` = '$option_name'" );
1071
1072         if ( $ydb->rows_affected == 1 ) {
1073                 $ydb->option[ $option_name ] = $newvalue;
1074                 return true;
1075         }
1076         return false;
1077 }
1078
1079 /**
1080  * Add an option to the DB
1081  *
1082  * Pretty much stolen from WordPress
1083  *
1084  * @since 1.4
1085  * @param string $option Name of option to add. Expected to not be SQL-escaped.
1086  * @param mixed $value Optional option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
1087  * @return bool False if option was not added and true otherwise.
1088  */
1089 function yourls_add_option( $name, $value = '' ) {
1090         global $ydb;
1091         $table = YOURLS_DB_TABLE_OPTIONS;
1092         $safe_name = yourls_escape( $name );
1093
1094         // Make sure the option doesn't already exist
1095         if ( false !== yourls_get_option( $safe_name ) )
1096                 return false;
1097
1098         $_value = yourls_escape( yourls_maybe_serialize( $value ) );
1099
1100         yourls_do_action( 'add_option', $safe_name, $_value );
1101
1102         $ydb->query( "INSERT INTO `$table` (`option_name`, `option_value`) VALUES ('$name', '$_value')" );
1103         $ydb->option[ $name ] = $value;
1104         return true;
1105 }
1106
1107
1108 /**
1109  * Delete an option from the DB
1110  *
1111  * Pretty much stolen from WordPress
1112  *
1113  * @since 1.4
1114  * @param string $option Option name to delete. Expected to not be SQL-escaped.
1115  * @return bool True, if option is successfully deleted. False on failure.
1116  */
1117 function yourls_delete_option( $name ) {
1118         global $ydb;
1119         $table = YOURLS_DB_TABLE_OPTIONS;
1120         $name = yourls_escape( $name );
1121
1122         // Get the ID, if no ID then return
1123         $option = $ydb->get_row( "SELECT option_id FROM `$table` WHERE `option_name` = '$name'" );
1124         if ( is_null( $option ) || !$option->option_id )
1125                 return false;
1126
1127         yourls_do_action( 'delete_option', $name );
1128
1129         $ydb->query( "DELETE FROM `$table` WHERE `option_name` = '$name'" );
1130         unset( $ydb->option[ $name ] );
1131         return true;
1132 }
1133
1134
1135 /**
1136  * Serialize data if needed. Stolen from WordPress
1137  *
1138  * @since 1.4
1139  * @param mixed $data Data that might be serialized.
1140  * @return mixed A scalar data
1141  */
1142 function yourls_maybe_serialize( $data ) {
1143         if ( is_array( $data ) || is_object( $data ) )
1144                 return serialize( $data );
1145
1146         if ( yourls_is_serialized( $data, false ) )
1147                 return serialize( $data );
1148
1149         return $data;
1150 }
1151
1152 /**
1153  * Check value to find if it was serialized. Stolen from WordPress
1154  *
1155  * @since 1.4
1156  * @param mixed $data Value to check to see if was serialized.
1157  * @param bool $strict Optional. Whether to be strict about the end of the string. Defaults true.
1158  * @return bool False if not serialized and true if it was.
1159  */
1160 function yourls_is_serialized( $data, $strict = true ) {
1161         // if it isn't a string, it isn't serialized
1162         if ( ! is_string( $data ) )
1163                 return false;
1164         $data = trim( $data );
1165          if ( 'N;' == $data )
1166                 return true;
1167         $length = strlen( $data );
1168         if ( $length < 4 )
1169                 return false;
1170         if ( ':' !== $data[1] )
1171                 return false;
1172         if ( $strict ) {
1173                 $lastc = $data[ $length - 1 ];
1174                 if ( ';' !== $lastc && '}' !== $lastc )
1175                         return false;
1176         } else {
1177                 $semicolon = strpos( $data, ';' );
1178                 $brace   = strpos( $data, '}' );
1179                 // Either ; or } must exist.
1180                 if ( false === $semicolon && false === $brace )
1181                         return false;
1182                 // But neither must be in the first X characters.
1183                 if ( false !== $semicolon && $semicolon < 3 )
1184                         return false;
1185                 if ( false !== $brace && $brace < 4 )
1186                         return false;
1187         }
1188         $token = $data[0];
1189         switch ( $token ) {
1190                 case 's' :
1191                         if ( $strict ) {
1192                                 if ( '"' !== $data[ $length - 2 ] )
1193                                         return false;
1194                         } elseif ( false === strpos( $data, '"' ) ) {
1195                                 return false;
1196                         }
1197                         // or else fall through
1198                 case 'a' :
1199                 case 'O' :
1200                         return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data );
1201                 case 'b' :
1202                 case 'i' :
1203                 case 'd' :
1204                         $end = $strict ? '$' : '';
1205                         return (bool) preg_match( "/^{$token}:[0-9.E-]+;$end/", $data );
1206         }
1207         return false;
1208 }
1209
1210 /**
1211  * Unserialize value only if it was serialized. Stolen from WP
1212  *
1213  * @since 1.4
1214  * @param string $original Maybe unserialized original, if is needed.
1215  * @return mixed Unserialized data can be any type.
1216  */
1217 function yourls_maybe_unserialize( $original ) {
1218         if ( yourls_is_serialized( $original ) ) // don't attempt to unserialize data that wasn't serialized going in
1219                 return @unserialize( $original );
1220         return $original;
1221 }
1222
1223 /**
1224  * Determine if the current page is private
1225  *
1226  */
1227 function yourls_is_private() {
1228         $private = false;
1229
1230         if ( defined('YOURLS_PRIVATE') && YOURLS_PRIVATE == true ) {
1231
1232                 // Allow overruling for particular pages:
1233
1234                 // API
1235                 if( yourls_is_API() ) {
1236                         if( !defined('YOURLS_PRIVATE_API') || YOURLS_PRIVATE_API != false )
1237                                 $private = true;
1238
1239                 // Infos
1240                 } elseif( yourls_is_infos() ) {
1241                         if( !defined('YOURLS_PRIVATE_INFOS') || YOURLS_PRIVATE_INFOS !== false )
1242                                 $private = true;
1243
1244                 // Others
1245                 } else {
1246                         $private = true;
1247                 }
1248
1249         }
1250
1251         return yourls_apply_filter( 'is_private', $private );
1252 }
1253
1254 /**
1255  * Show login form if required
1256  *
1257  */
1258 function yourls_maybe_require_auth() {
1259         if( yourls_is_private() ) {
1260                 yourls_do_action( 'require_auth' );
1261                 require_once( YOURLS_INC.'/auth.php' );
1262         } else {
1263                 yourls_do_action( 'require_no_auth' );
1264         }
1265 }
1266
1267 /**
1268  * Allow several short URLs for the same long URL ?
1269  *
1270  */
1271 function yourls_allow_duplicate_longurls() {
1272         // special treatment if API to check for WordPress plugin requests
1273         if( yourls_is_API() ) {
1274                 if ( isset($_REQUEST['source']) && $_REQUEST['source'] == 'plugin' )
1275                         return false;
1276         }
1277         return ( defined( 'YOURLS_UNIQUE_URLS' ) && YOURLS_UNIQUE_URLS == false );
1278 }
1279
1280 /**
1281  * @deprecated Return list of all shorturls associated to the same long URL. Returns NULL or array of keywords.
1282  *
1283  */
1284 function yourls_get_duplicate_keywords( $longurl ) {
1285         yourls_deprecated_function( __FUNCTION__, 1.7, 'yourls_get_longurl_keywords' );
1286         if( !yourls_allow_duplicate_longurls() )
1287                 return NULL;
1288         return yourls_apply_filter( 'get_duplicate_keywords', yourls_get_longurl_keywords ( $longurl ), $longurl );
1289 }
1290
1291 /**
1292  * Return array of keywords that redirect to the submitted long URL
1293  *
1294  * @since 1.7
1295  * @param string $longurl long url
1296  * @param string $sort Optional ORDER BY order (can be 'keyword', 'title', 'timestamp' or'clicks')
1297  * @param string $order Optional SORT order (can be 'ASC' or 'DESC')
1298  * @return array array of keywords
1299  */
1300 function yourls_get_longurl_keywords( $longurl, $sort = 'none', $order = 'ASC' ) {
1301         global $ydb;
1302         $longurl = yourls_escape( yourls_sanitize_url( $longurl ) );
1303         $table   = YOURLS_DB_TABLE_URL;
1304         $query   = "SELECT `keyword` FROM `$table` WHERE `url` = '$longurl'";
1305
1306         // Ensure sort is a column in database (@TODO: update verification array if database changes)
1307         if ( in_array( $sort, array('keyword','title','timestamp','clicks') ) ) {
1308                 $query .= " ORDER BY '".$sort."'";
1309                 if ( in_array( $order, array( 'ASC','DESC' ) ) ) {
1310                         $query .= " ".$order;
1311                 }
1312         }
1313         return yourls_apply_filter( 'get_longurl_keywords', $ydb->get_col( $query ), $longurl );
1314 }
1315
1316 /**
1317  * Check if an IP shortens URL too fast to prevent DB flood. Return true, or die.
1318  *
1319  */
1320 function yourls_check_IP_flood( $ip = '' ) {
1321
1322         // Allow plugins to short-circuit the whole function
1323         $pre = yourls_apply_filter( 'shunt_check_IP_flood', false, $ip );
1324         if ( false !== $pre )
1325                 return $pre;
1326
1327         yourls_do_action( 'pre_check_ip_flood', $ip ); // at this point $ip can be '', check it if your plugin hooks in here
1328
1329         // Raise white flag if installing or if no flood delay defined
1330         if(
1331                 ( defined('YOURLS_FLOOD_DELAY_SECONDS') && YOURLS_FLOOD_DELAY_SECONDS === 0 ) ||
1332                 !defined('YOURLS_FLOOD_DELAY_SECONDS') ||
1333                 yourls_is_installing()
1334         )
1335                 return true;
1336
1337         // Don't throttle logged in users
1338         if( yourls_is_private() ) {
1339                  if( yourls_is_valid_user() === true )
1340                         return true;
1341         }
1342
1343         // Don't throttle whitelist IPs
1344         if( defined( 'YOURLS_FLOOD_IP_WHITELIST' ) && YOURLS_FLOOD_IP_WHITELIST ) {
1345                 $whitelist_ips = explode( ',', YOURLS_FLOOD_IP_WHITELIST );
1346                 foreach( (array)$whitelist_ips as $whitelist_ip ) {
1347                         $whitelist_ip = trim( $whitelist_ip );
1348                         if ( $whitelist_ip == $ip )
1349                                 return true;
1350                 }
1351         }
1352
1353         $ip = ( $ip ? yourls_sanitize_ip( $ip ) : yourls_get_IP() );
1354
1355         yourls_do_action( 'check_ip_flood', $ip );
1356
1357         global $ydb;
1358         $table = YOURLS_DB_TABLE_URL;
1359
1360         $lasttime = $ydb->get_var( "SELECT `timestamp` FROM $table WHERE `ip` = '$ip' ORDER BY `timestamp` DESC LIMIT 1" );
1361         if( $lasttime ) {
1362                 $now = date( 'U' );
1363                 $then = date( 'U', strtotime( $lasttime ) );
1364                 if( ( $now - $then ) <= YOURLS_FLOOD_DELAY_SECONDS ) {
1365                         // Flood!
1366                         yourls_do_action( 'ip_flood', $ip, $now - $then );
1367                         yourls_die( yourls__( 'Too many URLs added too fast. Slow down please.' ), yourls__( 'Forbidden' ), 403 );
1368                 }
1369         }
1370
1371         return true;
1372 }
1373
1374 /**
1375  * Check if YOURLS is installing
1376  *
1377  * @return bool
1378  * @since 1.6
1379  */
1380 function yourls_is_installing() {
1381         $installing = defined( 'YOURLS_INSTALLING' ) && YOURLS_INSTALLING == true;
1382         return yourls_apply_filter( 'is_installing', $installing );
1383 }
1384
1385 /**
1386  * Check if YOURLS is upgrading
1387  *
1388  * @return bool
1389  * @since 1.6
1390  */
1391 function yourls_is_upgrading() {
1392         $upgrading = defined( 'YOURLS_UPGRADING' ) && YOURLS_UPGRADING == true;
1393         return yourls_apply_filter( 'is_upgrading', $upgrading );
1394 }
1395
1396
1397 /**
1398  * Check if YOURLS is installed
1399  *
1400  * Checks property $ydb->installed that is created by yourls_get_all_options()
1401  *
1402  * See inline comment for updating from 1.3 or prior.
1403  *
1404  */
1405 function yourls_is_installed() {
1406         global $ydb;
1407         $is_installed = ( property_exists( $ydb, 'installed' ) && $ydb->installed == true );
1408         return yourls_apply_filter( 'is_installed', $is_installed );
1409
1410         /* Note: this test won't work on YOURLS 1.3 or older (Aug 2009...)
1411            Should someone complain that they cannot upgrade directly from
1412            1.3 to 1.7: first, laugh at them, then ask them to install 1.6 first.
1413         */
1414 }
1415
1416 /**
1417  * Generate random string of (int)$length length and type $type (see function for details)
1418  *
1419  */
1420 function yourls_rnd_string ( $length = 5, $type = 0, $charlist = '' ) {
1421         $str = '';
1422         $length = intval( $length );
1423
1424         // define possible characters
1425         switch ( $type ) {
1426
1427                 // custom char list, or comply to charset as defined in config
1428                 case '0':
1429                         $possible = $charlist ? $charlist : yourls_get_shorturl_charset() ;
1430                         break;
1431
1432                 // no vowels to make no offending word, no 0/1/o/l to avoid confusion between letters & digits. Perfect for passwords.
1433                 case '1':
1434                         $possible = "23456789bcdfghjkmnpqrstvwxyz";
1435                         break;
1436
1437                 // Same, with lower + upper
1438                 case '2':
1439                         $possible = "23456789bcdfghjkmnpqrstvwxyzBCDFGHJKMNPQRSTVWXYZ";
1440                         break;
1441
1442                 // all letters, lowercase
1443                 case '3':
1444                         $possible = "abcdefghijklmnopqrstuvwxyz";
1445                         break;
1446
1447                 // all letters, lowercase + uppercase
1448                 case '4':
1449                         $possible = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
1450                         break;
1451
1452                 // all digits & letters lowercase
1453                 case '5':
1454                         $possible = "0123456789abcdefghijklmnopqrstuvwxyz";
1455                         break;
1456
1457                 // all digits & letters lowercase + uppercase
1458                 case '6':
1459                         $possible = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
1460                         break;
1461
1462         }
1463
1464         $i = 0;
1465         while ($i < $length) {
1466                 $str .= substr( $possible, mt_rand( 0, strlen( $possible )-1 ), 1 );
1467                 $i++;
1468         }
1469
1470         return yourls_apply_filter( 'rnd_string', $str, $length, $type, $charlist );
1471 }
1472
1473 /**
1474  * Return salted string
1475  *
1476  */
1477 function yourls_salt( $string ) {
1478         $salt = defined('YOURLS_COOKIEKEY') ? YOURLS_COOKIEKEY : md5(__FILE__) ;
1479         return yourls_apply_filter( 'yourls_salt', md5 ($string . $salt), $string );
1480 }
1481
1482 /**
1483  * Add a query var to a URL and return URL. Completely stolen from WP.
1484  *
1485  * Works with one of these parameter patterns:
1486  *     array( 'var' => 'value' )
1487  *     array( 'var' => 'value' ), $url
1488  *     'var', 'value'
1489  *     'var', 'value', $url
1490  * If $url omitted, uses $_SERVER['REQUEST_URI']
1491  *
1492  */
1493 function yourls_add_query_arg() {
1494         $ret = '';
1495         if ( is_array( func_get_arg(0) ) ) {
1496                 if ( @func_num_args() < 2 || false === @func_get_arg( 1 ) )
1497                         $uri = $_SERVER['REQUEST_URI'];
1498                 else
1499                         $uri = @func_get_arg( 1 );
1500         } else {
1501                 if ( @func_num_args() < 3 || false === @func_get_arg( 2 ) )
1502                         $uri = $_SERVER['REQUEST_URI'];
1503                 else
1504                         $uri = @func_get_arg( 2 );
1505         }
1506
1507         $uri = str_replace( '&amp;', '&', $uri );
1508
1509
1510         if ( $frag = strstr( $uri, '#' ) )
1511                 $uri = substr( $uri, 0, -strlen( $frag ) );
1512         else
1513                 $frag = '';
1514
1515         if ( preg_match( '|^https?://|i', $uri, $matches ) ) {
1516                 $protocol = $matches[0];
1517                 $uri = substr( $uri, strlen( $protocol ) );
1518         } else {
1519                 $protocol = '';
1520         }
1521
1522         if ( strpos( $uri, '?' ) !== false ) {
1523                 $parts = explode( '?', $uri, 2 );
1524                 if ( 1 == count( $parts ) ) {
1525                         $base = '?';
1526                         $query = $parts[0];
1527                 } else {
1528                         $base = $parts[0] . '?';
1529                         $query = $parts[1];
1530                 }
1531         } elseif ( !empty( $protocol ) || strpos( $uri, '=' ) === false ) {
1532                 $base = $uri . '?';
1533                 $query = '';
1534         } else {
1535                 $base = '';
1536                 $query = $uri;
1537         }
1538
1539         parse_str( $query, $qs );
1540         $qs = yourls_urlencode_deep( $qs ); // this re-URL-encodes things that were already in the query string
1541         if ( is_array( func_get_arg( 0 ) ) ) {
1542                 $kayvees = func_get_arg( 0 );
1543                 $qs = array_merge( $qs, $kayvees );
1544         } else {
1545                 $qs[func_get_arg( 0 )] = func_get_arg( 1 );
1546         }
1547
1548         foreach ( (array) $qs as $k => $v ) {
1549                 if ( $v === false )
1550                         unset( $qs[$k] );
1551         }
1552
1553         $ret = http_build_query( $qs );
1554         $ret = trim( $ret, '?' );
1555         $ret = preg_replace( '#=(&|$)#', '$1', $ret );
1556         $ret = $protocol . $base . $ret . $frag;
1557         $ret = rtrim( $ret, '?' );
1558         return $ret;
1559 }
1560
1561 /**
1562  * Navigates through an array and encodes the values to be used in a URL. Stolen from WP, used in yourls_add_query_arg()
1563  *
1564  */
1565 function yourls_urlencode_deep( $value ) {
1566         $value = is_array( $value ) ? array_map( 'yourls_urlencode_deep', $value ) : urlencode( $value );
1567         return $value;
1568 }
1569
1570 /**
1571  * Remove arg from query. Opposite of yourls_add_query_arg. Stolen from WP.
1572  *
1573  */
1574 function yourls_remove_query_arg( $key, $query = false ) {
1575         if ( is_array( $key ) ) { // removing multiple keys
1576                 foreach ( $key as $k )
1577                         $query = yourls_add_query_arg( $k, false, $query );
1578                 return $query;
1579         }
1580         return yourls_add_query_arg( $key, false, $query );
1581 }
1582
1583 /**
1584  * Return a time-dependent string for nonce creation
1585  *
1586  */
1587 function yourls_tick() {
1588         return ceil( time() / YOURLS_NONCE_LIFE );
1589 }
1590
1591 /**
1592  * Create a time limited, action limited and user limited token
1593  *
1594  */
1595 function yourls_create_nonce( $action, $user = false ) {
1596         if( false == $user )
1597                 $user = defined( 'YOURLS_USER' ) ? YOURLS_USER : '-1';
1598         $tick = yourls_tick();
1599         return substr( yourls_salt($tick . $action . $user), 0, 10 );
1600 }
1601
1602 /**
1603  * Create a nonce field for inclusion into a form
1604  *
1605  */
1606 function yourls_nonce_field( $action, $name = 'nonce', $user = false, $echo = true ) {
1607         $field = '<input type="hidden" id="'.$name.'" name="'.$name.'" value="'.yourls_create_nonce( $action, $user ).'" />';
1608         if( $echo )
1609                 echo $field."\n";
1610         return $field;
1611 }
1612
1613 /**
1614  * Add a nonce to a URL. If URL omitted, adds nonce to current URL
1615  *
1616  */
1617 function yourls_nonce_url( $action, $url = false, $name = 'nonce', $user = false ) {
1618         $nonce = yourls_create_nonce( $action, $user );
1619         return yourls_add_query_arg( $name, $nonce, $url );
1620 }
1621
1622 /**
1623  * Check validity of a nonce (ie time span, user and action match).
1624  *
1625  * Returns true if valid, dies otherwise (yourls_die() or die($return) if defined)
1626  * if $nonce is false or unspecified, it will use $_REQUEST['nonce']
1627  *
1628  */
1629 function yourls_verify_nonce( $action, $nonce = false, $user = false, $return = '' ) {
1630         // get user
1631         if( false == $user )
1632                 $user = defined( 'YOURLS_USER' ) ? YOURLS_USER : '-1';
1633
1634         // get current nonce value
1635         if( false == $nonce && isset( $_REQUEST['nonce'] ) )
1636                 $nonce = $_REQUEST['nonce'];
1637
1638         // what nonce should be
1639         $valid = yourls_create_nonce( $action, $user );
1640
1641         if( $nonce == $valid ) {
1642                 return true;
1643         } else {
1644                 if( $return )
1645                         die( $return );
1646                 yourls_die( yourls__( 'Unauthorized action or expired link' ), yourls__( 'Error' ), 403 );
1647         }
1648 }
1649
1650 /**
1651  * Converts keyword into short link (prepend with YOURLS base URL)
1652  *
1653  */
1654 function yourls_link( $keyword = '' ) {
1655         $link = YOURLS_SITE . '/' . yourls_sanitize_keyword( $keyword );
1656         return yourls_apply_filter( 'yourls_link', $link, $keyword );
1657 }
1658
1659 /**
1660  * Converts keyword into stat link (prepend with YOURLS base URL, append +)
1661  *
1662  */
1663 function yourls_statlink( $keyword = '' ) {
1664         $link = YOURLS_SITE . '/' . yourls_sanitize_keyword( $keyword ) . '+';
1665         if( yourls_is_ssl() )
1666                 $link = str_replace( 'http://', 'https://', $link );
1667         return yourls_apply_filter( 'yourls_statlink', $link, $keyword );
1668 }
1669
1670 /**
1671  * Check if we're in API mode. Returns bool
1672  *
1673  */
1674 function yourls_is_API() {
1675         if ( defined( 'YOURLS_API' ) && YOURLS_API == true )
1676                 return true;
1677         return false;
1678 }
1679
1680 /**
1681  * Check if we're in Ajax mode. Returns bool
1682  *
1683  */
1684 function yourls_is_Ajax() {
1685         if ( defined( 'YOURLS_AJAX' ) && YOURLS_AJAX == true )
1686                 return true;
1687         return false;
1688 }
1689
1690 /**
1691  * Check if we're in GO mode (yourls-go.php). Returns bool
1692  *
1693  */
1694 function yourls_is_GO() {
1695         if ( defined( 'YOURLS_GO' ) && YOURLS_GO == true )
1696                 return true;
1697         return false;
1698 }
1699
1700 /**
1701  * Check if we're displaying stats infos (yourls-infos.php). Returns bool
1702  *
1703  */
1704 function yourls_is_infos() {
1705         if ( defined( 'YOURLS_INFOS' ) && YOURLS_INFOS == true )
1706                 return true;
1707         return false;
1708 }
1709
1710 /**
1711  * Check if we'll need interface display function (ie not API or redirection)
1712  *
1713  */
1714 function yourls_has_interface() {
1715         if( yourls_is_API() or yourls_is_GO() )
1716                 return false;
1717         return true;
1718 }
1719
1720 /**
1721  * Check if we're in the admin area. Returns bool
1722  *
1723  */
1724 function yourls_is_admin() {
1725         if ( defined( 'YOURLS_ADMIN' ) && YOURLS_ADMIN == true )
1726                 return true;
1727         return false;
1728 }
1729
1730 /**
1731  * Check if the server seems to be running on Windows. Not exactly sure how reliable this is.
1732  *
1733  */
1734 function yourls_is_windows() {
1735         return defined( 'DIRECTORY_SEPARATOR' ) && DIRECTORY_SEPARATOR == '\\';
1736 }
1737
1738 /**
1739  * Check if SSL is required. Returns bool.
1740  *
1741  */
1742 function yourls_needs_ssl() {
1743         if ( defined('YOURLS_ADMIN_SSL') && YOURLS_ADMIN_SSL == true )
1744                 return true;
1745         return false;
1746 }
1747
1748 /**
1749  * Return admin link, with SSL preference if applicable.
1750  *
1751  */
1752 function yourls_admin_url( $page = '' ) {
1753         $admin = YOURLS_SITE . '/admin/' . $page;
1754         if( yourls_is_ssl() or yourls_needs_ssl() )
1755                 $admin = str_replace('http://', 'https://', $admin);
1756         return yourls_apply_filter( 'admin_url', $admin, $page );
1757 }
1758
1759 /**
1760  * Return YOURLS_SITE or URL under YOURLS setup, with SSL preference
1761  *
1762  */
1763 function yourls_site_url( $echo = true, $url = '' ) {
1764         $url = yourls_get_relative_url( $url );
1765         $url = trim( YOURLS_SITE . '/' . $url, '/' );
1766
1767         // Do not enforce (checking yourls_need_ssl() ) but check current usage so it won't force SSL on non-admin pages
1768         if( yourls_is_ssl() )
1769                 $url = str_replace( 'http://', 'https://', $url );
1770         $url = yourls_apply_filter( 'site_url', $url );
1771         if( $echo )
1772                 echo $url;
1773         return $url;
1774 }
1775
1776 /**
1777  * Check if SSL is used, returns bool. Stolen from WP.
1778  *
1779  */
1780 function yourls_is_ssl() {
1781         $is_ssl = false;
1782         if ( isset( $_SERVER['HTTPS'] ) ) {
1783                 if ( 'on' == strtolower( $_SERVER['HTTPS'] ) )
1784                         $is_ssl = true;
1785                 if ( '1' == $_SERVER['HTTPS'] )
1786                         $is_ssl = true;
1787         } elseif ( isset( $_SERVER['SERVER_PORT'] ) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
1788                 $is_ssl = true;
1789         }
1790         return yourls_apply_filter( 'is_ssl', $is_ssl );
1791 }
1792
1793 /**
1794  * Get a remote page title
1795  *
1796  * This function returns a string: either the page title as defined in HTML, or the URL if not found
1797  * The function tries to convert funky characters found in titles to UTF8, from the detected charset.
1798  * Charset in use is guessed from HTML meta tag, or if not found, from server's 'content-type' response.
1799  *
1800  * @param string $url URL
1801  * @return string Title (sanitized) or the URL if no title found
1802  */
1803 function yourls_get_remote_title( $url ) {
1804         // Allow plugins to short-circuit the whole function
1805         $pre = yourls_apply_filter( 'shunt_get_remote_title', false, $url );
1806         if ( false !== $pre )
1807                 return $pre;
1808
1809         $url = yourls_sanitize_url( $url );
1810
1811         // Only deal with http(s)://
1812         if( !in_array( yourls_get_protocol( $url ), array( 'http://', 'https://' ) ) )
1813                 return $url;
1814
1815         $title = $charset = false;
1816
1817         $response = yourls_http_get( $url ); // can be a Request object or an error string
1818         if( is_string( $response ) ) {
1819                 return $url;
1820         }
1821
1822         // Page content. No content? Return the URL
1823         $content = $response->body;
1824         if( !$content )
1825                 return $url;
1826
1827         // look for <title>. No title found? Return the URL
1828         if ( preg_match('/<title>(.*?)<\/title>/is', $content, $found ) ) {
1829                 $title = $found[1];
1830                 unset( $found );
1831         }
1832         if( !$title )
1833                 return $url;
1834
1835         // Now we have a title. We'll try to get proper utf8 from it.
1836
1837         // Get charset as (and if) defined by the HTML meta tag. We should match
1838         // <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
1839         // or <meta charset='utf-8'> and all possible variations: see https://gist.github.com/ozh/7951236
1840         if ( preg_match( '/<meta[^>]*charset\s*=["\' ]*([a-zA-Z0-9\-_]+)/is', $content, $found ) ) {
1841                 $charset = $found[1];
1842                 unset( $found );
1843         } else {
1844                 // No charset found in HTML. Get charset as (and if) defined by the server response
1845                 $_charset = current( $response->headers->getValues( 'content-type' ) );
1846                 if( preg_match( '/charset=(\S+)/', $_charset, $found ) ) {
1847                         $charset = trim( $found[1], ';' );
1848                         unset( $found );
1849                 }
1850         }
1851
1852         // Conversion to utf-8 if what we have is not utf8 already
1853         if( strtolower( $charset ) != 'utf-8' && function_exists( 'mb_convert_encoding' ) ) {
1854                 // We use @ to remove warnings because mb_ functions are easily bitching about illegal chars
1855                 if( $charset ) {
1856                         $title = @mb_convert_encoding( $title, 'UTF-8', $charset );
1857                 } else {
1858                         $title = @mb_convert_encoding( $title, 'UTF-8' );
1859                 }
1860         }
1861
1862         // Remove HTML entities
1863         $title = html_entity_decode( $title, ENT_QUOTES, 'UTF-8' );
1864
1865         // Strip out evil things
1866         $title = yourls_sanitize_title( $title );
1867
1868         return yourls_apply_filter( 'get_remote_title', $title, $url );
1869 }
1870
1871 /**
1872  * Quick UA check for mobile devices. Return boolean.
1873  *
1874  */
1875 function yourls_is_mobile_device() {
1876         // Strings searched
1877         $mobiles = array(
1878                 'android', 'blackberry', 'blazer',
1879                 'compal', 'elaine', 'fennec', 'hiptop',
1880                 'iemobile', 'iphone', 'ipod', 'ipad',
1881                 'iris', 'kindle', 'opera mobi', 'opera mini',
1882                 'palm', 'phone', 'pocket', 'psp', 'symbian',
1883                 'treo', 'wap', 'windows ce', 'windows phone'
1884         );
1885
1886         // Current user-agent
1887         $current = strtolower( $_SERVER['HTTP_USER_AGENT'] );
1888
1889         // Check and return
1890         $is_mobile = ( str_replace( $mobiles, '', $current ) != $current );
1891         return yourls_apply_filter( 'is_mobile_device', $is_mobile );
1892 }
1893
1894 /**
1895  * Get request in YOURLS base (eg in 'http://site.com/yourls/abcd' get 'abdc')
1896  *
1897  */
1898 function yourls_get_request() {
1899         // Allow plugins to short-circuit the whole function
1900         $pre = yourls_apply_filter( 'shunt_get_request', false );
1901         if ( false !== $pre )
1902                 return $pre;
1903
1904         static $request = null;
1905
1906         yourls_do_action( 'pre_get_request', $request );
1907
1908         if( $request !== null )
1909                 return $request;
1910
1911         // Ignore protocol & www. prefix
1912         $root = str_replace( array( 'https://', 'http://', 'https://www.', 'http://www.' ), '', YOURLS_SITE );
1913         // Case insensitive comparison of the YOURLS root to match both http://Sho.rt/blah and http://sho.rt/blah
1914         $request = preg_replace( "!$root/!i", '', $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], 1 );
1915
1916         // Unless request looks like a full URL (ie request is a simple keyword) strip query string
1917         if( !preg_match( "@^[a-zA-Z]+://.+@", $request ) ) {
1918                 $request = current( explode( '?', $request ) );
1919         }
1920
1921         return yourls_apply_filter( 'get_request', $request );
1922 }
1923
1924 /**
1925  * Change protocol to match current scheme used (http or https)
1926  *
1927  */
1928 function yourls_match_current_protocol( $url, $normal = 'http://', $ssl = 'https://' ) {
1929         if( yourls_is_ssl() )
1930                 $url = str_replace( $normal, $ssl, $url );
1931         return yourls_apply_filter( 'match_current_protocol', $url );
1932 }
1933
1934 /**
1935  * Fix $_SERVER['REQUEST_URI'] variable for various setups. Stolen from WP.
1936  *
1937  */
1938 function yourls_fix_request_uri() {
1939
1940         $default_server_values = array(
1941                 'SERVER_SOFTWARE' => '',
1942                 'REQUEST_URI' => '',
1943         );
1944         $_SERVER = array_merge( $default_server_values, $_SERVER );
1945
1946         // Fix for IIS when running with PHP ISAPI
1947         if ( empty( $_SERVER['REQUEST_URI'] ) || ( php_sapi_name() != 'cgi-fcgi' && preg_match( '/^Microsoft-IIS\//', $_SERVER['SERVER_SOFTWARE'] ) ) ) {
1948
1949                 // IIS Mod-Rewrite
1950                 if ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] ) ) {
1951                         $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_ORIGINAL_URL'];
1952                 }
1953                 // IIS Isapi_Rewrite
1954                 else if ( isset( $_SERVER['HTTP_X_REWRITE_URL'] ) ) {
1955                         $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_REWRITE_URL'];
1956                 } else {
1957                         // Use ORIG_PATH_INFO if there is no PATH_INFO
1958                         if ( !isset( $_SERVER['PATH_INFO'] ) && isset( $_SERVER['ORIG_PATH_INFO'] ) )
1959                                 $_SERVER['PATH_INFO'] = $_SERVER['ORIG_PATH_INFO'];
1960
1961                         // Some IIS + PHP configurations puts the script-name in the path-info (No need to append it twice)
1962                         if ( isset( $_SERVER['PATH_INFO'] ) ) {
1963                                 if ( $_SERVER['PATH_INFO'] == $_SERVER['SCRIPT_NAME'] )
1964                                         $_SERVER['REQUEST_URI'] = $_SERVER['PATH_INFO'];
1965                                 else
1966                                         $_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME'] . $_SERVER['PATH_INFO'];
1967                         }
1968
1969                         // Append the query string if it exists and isn't null
1970                         if ( ! empty( $_SERVER['QUERY_STRING'] ) ) {
1971                                 $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING'];
1972                         }
1973                 }
1974         }
1975 }
1976
1977 /**
1978  * Shutdown function, runs just before PHP shuts down execution. Stolen from WP
1979  *
1980  */
1981 function yourls_shutdown() {
1982         yourls_do_action( 'shutdown' );
1983 }
1984
1985 /**
1986  * Auto detect custom favicon in /user directory, fallback to YOURLS favicon, and echo/return its URL
1987  *
1988  */
1989 function yourls_favicon( $echo = true ) {
1990         static $favicon = null;
1991         if( $favicon !== null )
1992                 return $favicon;
1993
1994         $custom = null;
1995         // search for favicon.(gif|ico|png|jpg|svg)
1996         foreach( array( 'gif', 'ico', 'png', 'jpg', 'svg' ) as $ext ) {
1997                 if( file_exists( YOURLS_USERDIR. '/favicon.' . $ext ) ) {
1998                         $custom = 'favicon.' . $ext;
1999                         break;
2000                 }
2001         }
2002
2003         if( $custom ) {
2004                 $favicon = yourls_site_url( false, YOURLS_USERURL . '/' . $custom );
2005         } else {
2006                 $favicon = yourls_site_url( false ) . '/images/favicon.gif';
2007         }
2008         if( $echo )
2009                 echo $favicon;
2010         return $favicon;
2011 }
2012
2013 /**
2014  * Check for maintenance mode. If yes, die. See yourls_maintenance_mode(). Stolen from WP.
2015  *
2016  */
2017 function yourls_check_maintenance_mode() {
2018
2019         $file = YOURLS_ABSPATH . '/.maintenance' ;
2020         if ( !file_exists( $file ) || yourls_is_upgrading() || yourls_is_installing() )
2021                 return;
2022
2023         global $maintenance_start;
2024
2025         include_once( $file );
2026         // If the $maintenance_start timestamp is older than 10 minutes, don't die.
2027         if ( ( time() - $maintenance_start ) >= 600 )
2028                 return;
2029
2030         // Use any /user/maintenance.php file
2031         if( file_exists( YOURLS_USERDIR.'/maintenance.php' ) ) {
2032                 include_once( YOURLS_USERDIR.'/maintenance.php' );
2033                 die();
2034         }
2035
2036         // https://www.youtube.com/watch?v=Xw-m4jEY-Ns
2037         $title   = yourls__( 'Service temporarily unavailable' );
2038         $message = yourls__( 'Our service is currently undergoing scheduled maintenance.' ) . "</p>\n<p>" .
2039         yourls__( 'Things should not last very long, thank you for your patience and please excuse the inconvenience' );
2040         yourls_die( $message, $title , 503 );
2041
2042 }
2043
2044 /**
2045  * Return current admin page, or null if not an admin page
2046  *
2047  * @return mixed string if admin page, null if not an admin page
2048  * @since 1.6
2049  */
2050 function yourls_current_admin_page() {
2051         if( yourls_is_admin() ) {
2052                 $current = substr( yourls_get_request(), 6 );
2053                 if( $current === false )
2054                         $current = 'index.php'; // if current page is http://sho.rt/admin/ instead of http://sho.rt/admin/index.php
2055
2056                 return $current;
2057         }
2058         return null;
2059 }
2060
2061 /**
2062  * Check if a URL protocol is allowed
2063  *
2064  * Checks a URL against a list of whitelisted protocols. Protocols must be defined with
2065  * their complete scheme name, ie 'stuff:' or 'stuff://' (for instance, 'mailto:' is a valid
2066  * protocol, 'mailto://' isn't, and 'http:' with no double slashed isn't either
2067  *
2068  * @since 1.6
2069  *
2070  * @param string $url URL to be check
2071  * @param array $protocols Optional. Array of protocols, defaults to global $yourls_allowedprotocols
2072  * @return boolean true if protocol allowed, false otherwise
2073  */
2074 function yourls_is_allowed_protocol( $url, $protocols = array() ) {
2075         if( ! $protocols ) {
2076                 global $yourls_allowedprotocols;
2077                 $protocols = $yourls_allowedprotocols;
2078         }
2079
2080         $protocol = yourls_get_protocol( $url );
2081         return yourls_apply_filter( 'is_allowed_protocol', in_array( $protocol, $protocols ), $url, $protocols );
2082 }
2083
2084 /**
2085  * Get protocol from a URL (eg mailto:, http:// ...)
2086  *
2087  * @since 1.6
2088  *
2089  * @param string $url URL to be check
2090  * @return string Protocol, with slash slash if applicable. Empty string if no protocol
2091  */
2092 function yourls_get_protocol( $url ) {
2093         preg_match( '!^[a-zA-Z0-9\+\.-]+:(//)?!', $url, $matches );
2094         /*
2095         http://en.wikipedia.org/wiki/URI_scheme#Generic_syntax
2096         The scheme name consists of a sequence of characters beginning with a letter and followed by any
2097         combination of letters, digits, plus ("+"), period ("."), or hyphen ("-"). Although schemes are
2098         case-insensitive, the canonical form is lowercase and documents that specify schemes must do so
2099         with lowercase letters. It is followed by a colon (":").
2100         */
2101         $protocol = ( isset( $matches[0] ) ? $matches[0] : '' );
2102         return yourls_apply_filter( 'get_protocol', $protocol, $url );
2103 }
2104
2105 /**
2106  * Get relative URL (eg 'abc' from 'http://sho.rt/abc')
2107  *
2108  * Treat indifferently http & https. If a URL isn't relative to the YOURLS install, return it as is
2109  * or return empty string if $strict is true
2110  *
2111  * @since 1.6
2112  * @param string $url URL to relativize
2113  * @param bool $strict if true and if URL isn't relative to YOURLS install, return empty string
2114  * @return string URL
2115  */
2116 function yourls_get_relative_url( $url, $strict = true ) {
2117         $url = yourls_sanitize_url( $url );
2118
2119         // Remove protocols to make it easier
2120         $noproto_url  = str_replace( 'https:', 'http:', $url );
2121         $noproto_site = str_replace( 'https:', 'http:', YOURLS_SITE );
2122
2123         // Trim URL from YOURLS root URL : if no modification made, URL wasn't relative
2124         $_url = str_replace( $noproto_site . '/', '', $noproto_url );
2125         if( $_url == $noproto_url )
2126                 $_url = ( $strict ? '' : $url );
2127
2128         return yourls_apply_filter( 'get_relative_url', $_url, $url );
2129 }
2130
2131 /**
2132  * Marks a function as deprecated and informs when it has been used. Stolen from WP.
2133  *
2134  * There is a hook deprecated_function that will be called that can be used
2135  * to get the backtrace up to what file and function called the deprecated
2136  * function.
2137  *
2138  * The current behavior is to trigger a user error if YOURLS_DEBUG is true.
2139  *
2140  * This function is to be used in every function that is deprecated.
2141  *
2142  * @since 1.6
2143  * @uses yourls_do_action() Calls 'deprecated_function' and passes the function name, what to use instead,
2144  *   and the version the function was deprecated in.
2145  * @uses yourls_apply_filters() Calls 'deprecated_function_trigger_error' and expects boolean value of true to do
2146  *   trigger or false to not trigger error.
2147  *
2148  * @param string $function The function that was called
2149  * @param string $version The version of WordPress that deprecated the function
2150  * @param string $replacement Optional. The function that should have been called
2151  */
2152 function yourls_deprecated_function( $function, $version, $replacement = null ) {
2153
2154         yourls_do_action( 'deprecated_function', $function, $replacement, $version );
2155
2156         // Allow plugin to filter the output error trigger
2157         if ( YOURLS_DEBUG && yourls_apply_filters( 'deprecated_function_trigger_error', true ) ) {
2158                 if ( ! is_null( $replacement ) )
2159                         trigger_error( sprintf( yourls__('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $function, $version, $replacement ) );
2160                 else
2161                         trigger_error( sprintf( yourls__('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
2162         }
2163 }
2164
2165 /**
2166  * Return the value if not an empty string
2167  *
2168  * Used with array_filter(), to remove empty keys but not keys with value 0 or false
2169  *
2170  * @since 1.6
2171  * @param mixed $val Value to test against ''
2172  * @return bool True if not an empty string
2173  */
2174 function yourls_return_if_not_empty_string( $val ) {
2175         return( $val !== '' );
2176 }