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  */
 862 function yourls_geo_ip_to_countrycode( $ip = '', $default = '' ) {
 863         // Allow plugins to short-circuit the Geo IP API
 864         $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
 865         if ( false !== $location )
 866                 return $location;
 867
 868         if ( !file_exists( YOURLS_INC.'/geo/GeoIP.dat') || !file_exists( YOURLS_INC.'/geo/geoip.inc') )
 869                 return $default;
 870
 871         if ( $ip == '' )
 872                 $ip = yourls_get_IP();
 873
 874         require_once( YOURLS_INC.'/geo/geoip.inc') ;
 875         $gi = geoip_open( YOURLS_INC.'/geo/GeoIP.dat', GEOIP_STANDARD);
 876         $location = geoip_country_code_by_addr($gi, $ip);
 877         geoip_close($gi);
 878
 879         return yourls_apply_filter( 'geo_ip_to_countrycode', $location, $ip, $default );
 880 }
 881
 882 /**
 883  * Converts a 2 letter country code to long name (ie AU -> Australia)
 884  *
 885  */
 886 function yourls_geo_countrycode_to_countryname( $code ) {
 887         // Allow plugins to short-circuit the Geo IP API
 888         $country = yourls_apply_filter( 'shunt_geo_countrycode_to_countryname', false, $code );
 889         if ( false !== $country )
 890                 return $country;
 891
 892         // Load the Geo class if not already done
 893         if( !class_exists( 'GeoIP', false ) ) {
 894                 $temp = yourls_geo_ip_to_countrycode( '127.0.0.1' );
 895         }
 896
 897         if( class_exists( 'GeoIP', false ) ) {
 898                 $geo  = new GeoIP;
 899                 $id   = $geo->GEOIP_COUNTRY_CODE_TO_NUMBER[ $code ];
 900                 $long = $geo->GEOIP_COUNTRY_NAMES[ $id ];
 901                 return $long;
 902         } else {
 903                 return false;
 904         }
 905 }
 906
 907 /**
 908  * Return flag URL from 2 letter country code
 909  *
 910  */
 911 function yourls_geo_get_flag( $code ) {
 912         if( file_exists( YOURLS_INC.'/geo/flags/flag_'.strtolower($code).'.gif' ) ) {
 913                 $img = yourls_match_current_protocol( YOURLS_SITE.'/includes/geo/flags/flag_'.( strtolower( $code ) ).'.gif' );
 914         } else {
 915                 $img = false;
 916         }
 917         return yourls_apply_filter( 'geo_get_flag', $img, $code );
 918 }
 919
 920
 921 /**
 922  * Check if an upgrade is needed
 923  *
 924  */
 925 function yourls_upgrade_is_needed() {
 926         // check YOURLS_DB_VERSION exist && match values stored in YOURLS_DB_TABLE_OPTIONS
 927         list( $currentver, $currentsql ) = yourls_get_current_version_from_sql();
 928         if( $currentsql < YOURLS_DB_VERSION )
 929                 return true;
 930
 931         return false;
 932 }
 933
 934 /**
 935  * Get current version & db version as stored in the options DB. Prior to 1.4 there's no option table.
 936  *
 937  */
 938 function yourls_get_current_version_from_sql() {
 939         $currentver = yourls_get_option( 'version' );
 940         $currentsql = yourls_get_option( 'db_version' );
 941
 942         // Values if version is 1.3
 943         if( !$currentver )
 944                 $currentver = '1.3';
 945         if( !$currentsql )
 946                 $currentsql = '100';
 947
 948         return array( $currentver, $currentsql);
 949 }
 950
 951 /**
 952  * Read an option from DB (or from cache if available). Return value or $default if not found
 953  *
 954  */
 955 function yourls_get_option( $option_name, $default = false ) {
 956         global $ydb;
 957
 958         // Allow plugins to short-circuit options
 959         $pre = yourls_apply_filter( 'shunt_option_'.$option_name, false );
 960         if ( false !== $pre )
 961                 return $pre;
 962
 963         // If option not cached already, get its value from the DB
 964         if ( !isset( $ydb->option[$option_name] ) ) {
 965                 $table = YOURLS_DB_TABLE_OPTIONS;
 966                 $option_name = yourls_escape( $option_name );
 967                 $row = $ydb->get_row( "SELECT `option_value` FROM `$table` WHERE `option_name` = '$option_name' LIMIT 1" );
 968                 if ( is_object( $row) ) { // Has to be get_row instead of get_var because of funkiness with 0, false, null values
 969                         $value = $row->option_value;
 970                 } else { // option does not exist, so we must cache its non-existence
 971                         $value = $default;
 972                 }
 973                 $ydb->option[ $option_name ] = yourls_maybe_unserialize( $value );
 974         }
 975
 976         return yourls_apply_filter( 'get_option_'.$option_name, $ydb->option[$option_name] );
 977 }
 978
 979 /**
 980  * Read all options from DB at once
 981  *
 982  */
 983 function yourls_get_all_options() {
 984         global $ydb;
 985
 986         // Allow plugins to short-circuit all options. (Note: regular plugins are loaded after all options)
 987         $pre = yourls_apply_filter( 'shunt_all_options', false );
 988         if ( false !== $pre )
 989                 return $pre;
 990
 991         $table = YOURLS_DB_TABLE_OPTIONS;
 992
 993         $allopt = $ydb->get_results( "SELECT `option_name`, `option_value` FROM `$table` WHERE 1=1" );
 994
 995         foreach( (array)$allopt as $option ) {
 996                 $ydb->option[ $option->option_name ] = yourls_maybe_unserialize( $option->option_value );
 997         }
 998
 999         if( property_exists( $ydb, 'option' ) ) {
1000                 $ydb->option = yourls_apply_filter( 'get_all_options', $ydb->option );
1001                 $ydb->installed = true;
1002         } else {
1003                 // Zero option found: assume YOURLS is not installed
1004                 $ydb->installed = false;
1005         }
1006 }
1007
1008 /**
1009  * Update (add if doesn't exist) an option to DB
1010  *
1011  */
1012 function yourls_update_option( $option_name, $newvalue ) {
1013         global $ydb;
1014         $table = YOURLS_DB_TABLE_OPTIONS;
1015
1016         $safe_option_name = yourls_escape( $option_name );
1017
1018         $oldvalue = yourls_get_option( $safe_option_name );
1019
1020         // If the new and old values are the same, no need to update.
1021         if ( $newvalue === $oldvalue )
1022                 return false;
1023
1024         if ( false === $oldvalue ) {
1025                 yourls_add_option( $option_name, $newvalue );
1026                 return true;
1027         }
1028
1029         $_newvalue = yourls_escape( yourls_maybe_serialize( $newvalue ) );
1030
1031         yourls_do_action( 'update_option', $option_name, $oldvalue, $newvalue );
1032
1033         $ydb->query( "UPDATE `$table` SET `option_value` = '$_newvalue' WHERE `option_name` = '$option_name'" );
1034
1035         if ( $ydb->rows_affected == 1 ) {
1036                 $ydb->option[ $option_name ] = $newvalue;
1037                 return true;
1038         }
1039         return false;
1040 }
1041
1042 /**
1043  * Add an option to the DB
1044  *
1045  */
1046 function yourls_add_option( $name, $value = '' ) {
1047         global $ydb;
1048         $table = YOURLS_DB_TABLE_OPTIONS;
1049         $safe_name = yourls_escape( $name );
1050
1051         // Make sure the option doesn't already exist
1052         if ( false !== yourls_get_option( $safe_name ) )
1053                 return;
1054
1055         $_value = yourls_escape( yourls_maybe_serialize( $value ) );
1056
1057         yourls_do_action( 'add_option', $safe_name, $_value );
1058
1059         $ydb->query( "INSERT INTO `$table` (`option_name`, `option_value`) VALUES ('$name', '$_value')" );
1060         $ydb->option[ $name ] = $value;
1061         return;
1062 }
1063
1064
1065 /**
1066  * Delete an option from the DB
1067  *
1068  */
1069 function yourls_delete_option( $name ) {
1070         global $ydb;
1071         $table = YOURLS_DB_TABLE_OPTIONS;
1072         $name = yourls_escape( $name );
1073
1074         // Get the ID, if no ID then return
1075         $option = $ydb->get_row( "SELECT option_id FROM `$table` WHERE `option_name` = '$name'" );
1076         if ( is_null( $option ) || !$option->option_id )
1077                 return false;
1078
1079         yourls_do_action( 'delete_option', $name );
1080
1081         $ydb->query( "DELETE FROM `$table` WHERE `option_name` = '$name'" );
1082         return true;
1083 }
1084
1085
1086
1087 /**
1088  * Serialize data if needed. Stolen from WordPress
1089  *
1090  */
1091 function yourls_maybe_serialize( $data ) {
1092         if ( is_array( $data ) || is_object( $data ) )
1093                 return serialize( $data );
1094
1095         if ( yourls_is_serialized( $data ) )
1096                 return serialize( $data );
1097
1098         return $data;
1099 }
1100
1101 /**
1102  * Check value to find if it was serialized. Stolen from WordPress
1103  *
1104  */
1105 function yourls_is_serialized( $data ) {
1106         // if it isn't a string, it isn't serialized
1107         if ( !is_string( $data ) )
1108                 return false;
1109         $data = trim( $data );
1110         if ( 'N;' == $data )
1111                 return true;
1112         if ( !preg_match( '/^([adObis]):/', $data, $badions ) )
1113                 return false;
1114         switch ( $badions[1] ) {
1115                 case 'a' :
1116                 case 'O' :
1117                 case 's' :
1118                         if ( preg_match( "/^{$badions[1]}:[0-9]+:.*[;}]\$/s", $data ) )
1119                                 return true;
1120                         break;
1121                 case 'b' :
1122                 case 'i' :
1123                 case 'd' :
1124                         if ( preg_match( "/^{$badions[1]}:[0-9.E-]+;\$/", $data ) )
1125                                 return true;
1126                         break;
1127         }
1128         return false;
1129 }
1130
1131 /**
1132  * Unserialize value only if it was serialized. Stolen from WP
1133  *
1134  */
1135 function yourls_maybe_unserialize( $original ) {
1136         if ( yourls_is_serialized( $original ) ) // don't attempt to unserialize data that wasn't serialized going in
1137                 return @unserialize( $original );
1138         return $original;
1139 }
1140
1141 /**
1142  * Determine if the current page is private
1143  *
1144  */
1145 function yourls_is_private() {
1146         $private = false;
1147
1148         if ( defined('YOURLS_PRIVATE') && YOURLS_PRIVATE == true ) {
1149
1150                 // Allow overruling for particular pages:
1151
1152                 // API
1153                 if( yourls_is_API() ) {
1154                         if( !defined('YOURLS_PRIVATE_API') || YOURLS_PRIVATE_API != false )
1155                                 $private = true;
1156
1157                 // Infos
1158                 } elseif( yourls_is_infos() ) {
1159                         if( !defined('YOURLS_PRIVATE_INFOS') || YOURLS_PRIVATE_INFOS !== false )
1160                                 $private = true;
1161
1162                 // Others
1163                 } else {
1164                         $private = true;
1165                 }
1166
1167         }
1168
1169         return yourls_apply_filter( 'is_private', $private );
1170 }
1171
1172 /**
1173  * Show login form if required
1174  *
1175  */
1176 function yourls_maybe_require_auth() {
1177         if( yourls_is_private() ) {
1178                 yourls_do_action( 'require_auth' );
1179                 require_once( YOURLS_INC.'/auth.php' );
1180         } else {
1181                 yourls_do_action( 'require_no_auth' );
1182         }
1183 }
1184
1185 /**
1186  * Allow several short URLs for the same long URL ?
1187  *
1188  */
1189 function yourls_allow_duplicate_longurls() {
1190         // special treatment if API to check for WordPress plugin requests
1191         if( yourls_is_API() ) {
1192                 if ( isset($_REQUEST['source']) && $_REQUEST['source'] == 'plugin' )
1193                         return false;
1194         }
1195         return ( defined( 'YOURLS_UNIQUE_URLS' ) && YOURLS_UNIQUE_URLS == false );
1196 }
1197
1198 /**
1199  * Return list of all shorturls associated to the same long URL. Returns NULL or array of keywords.
1200  *
1201  */
1202 function yourls_get_duplicate_keywords( $longurl ) {
1203         if( !yourls_allow_duplicate_longurls() )
1204                 return NULL;
1205
1206         global $ydb;
1207         $longurl = yourls_escape( yourls_sanitize_url($longurl) );
1208         $table = YOURLS_DB_TABLE_URL;
1209
1210         $return = $ydb->get_col( "SELECT `keyword` FROM `$table` WHERE `url` = '$longurl'" );
1211         return yourls_apply_filter( 'get_duplicate_keywords', $return, $longurl );
1212 }
1213
1214 /**
1215  * Check if an IP shortens URL too fast to prevent DB flood. Return true, or die.
1216  *
1217  */
1218 function yourls_check_IP_flood( $ip = '' ) {
1219
1220         // Allow plugins to short-circuit the whole function
1221         $pre = yourls_apply_filter( 'shunt_check_IP_flood', false, $ip );
1222         if ( false !== $pre )
1223                 return $pre;
1224
1225         yourls_do_action( 'pre_check_ip_flood', $ip ); // at this point $ip can be '', check it if your plugin hooks in here
1226
1227         if(
1228                 ( defined('YOURLS_FLOOD_DELAY_SECONDS') && YOURLS_FLOOD_DELAY_SECONDS === 0 ) ||
1229                 !defined('YOURLS_FLOOD_DELAY_SECONDS')
1230         )
1231                 return true;
1232
1233         $ip = ( $ip ? yourls_sanitize_ip( $ip ) : yourls_get_IP() );
1234
1235         // Don't throttle whitelist IPs
1236         if( defined( 'YOURLS_FLOOD_IP_WHITELIST' ) && YOURLS_FLOOD_IP_WHITELIST ) {
1237                 $whitelist_ips = explode( ',', YOURLS_FLOOD_IP_WHITELIST );
1238                 foreach( (array)$whitelist_ips as $whitelist_ip ) {
1239                         $whitelist_ip = trim( $whitelist_ip );
1240                         if ( $whitelist_ip == $ip )
1241                                 return true;
1242                 }
1243         }
1244
1245         // Don't throttle logged in users
1246         if( yourls_is_private() ) {
1247                  if( yourls_is_valid_user() === true )
1248                         return true;
1249         }
1250
1251         yourls_do_action( 'check_ip_flood', $ip );
1252
1253         global $ydb;
1254         $table = YOURLS_DB_TABLE_URL;
1255
1256         $lasttime = $ydb->get_var( "SELECT `timestamp` FROM $table WHERE `ip` = '$ip' ORDER BY `timestamp` DESC LIMIT 1" );
1257         if( $lasttime ) {
1258                 $now = date( 'U' );
1259                 $then = date( 'U', strtotime( $lasttime ) );
1260                 if( ( $now - $then ) <= YOURLS_FLOOD_DELAY_SECONDS ) {
1261                         // Flood!
1262                         yourls_do_action( 'ip_flood', $ip, $now - $then );
1263                         yourls_die( yourls__( 'Too many URLs added too fast. Slow down please.' ), yourls__( 'Forbidden' ), 403 );
1264                 }
1265         }
1266
1267         return true;
1268 }
1269
1270 /**
1271  * Check if YOURLS is installing
1272  *
1273  * @return bool
1274  * @since 1.6
1275  */
1276 function yourls_is_installing() {
1277         $installing = defined( 'YOURLS_INSTALLING' ) && YOURLS_INSTALLING == true;
1278         return yourls_apply_filter( 'is_installing', $installing );
1279 }
1280
1281 /**
1282  * Check if YOURLS is upgrading
1283  *
1284  * @return bool
1285  * @since 1.6
1286  */
1287 function yourls_is_upgrading() {
1288         $upgrading = defined( 'YOURLS_UPGRADING' ) && YOURLS_UPGRADING == true;
1289         return yourls_apply_filter( 'is_upgrading', $upgrading );
1290 }
1291
1292
1293 /**
1294  * Check if YOURLS is installed
1295  *
1296  * Checks property $ydb->installed that is created by yourls_get_all_options()
1297  *
1298  * See inline comment for updating from 1.3 or prior.
1299  *
1300  */
1301 function yourls_is_installed() {
1302         global $ydb;
1303         $is_installed = ( property_exists( $ydb, 'installed' ) && $ydb->installed == true );
1304         return yourls_apply_filter( 'is_installed', $is_installed );
1305
1306         /* Note: this test won't work on YOURLS 1.3 or older (Aug 2009...)
1307            Should someone complain that they cannot upgrade directly from
1308            1.3 to 1.7: first, laugh at them, then ask them to install 1.6 first.
1309         */
1310 }
1311
1312 /**
1313  * Generate random string of (int)$length length and type $type (see function for details)
1314  *
1315  */
1316 function yourls_rnd_string ( $length = 5, $type = 0, $charlist = '' ) {
1317         $str = '';
1318         $length = intval( $length );
1319
1320         // define possible characters
1321         switch ( $type ) {
1322
1323                 // custom char list, or comply to charset as defined in config
1324                 case '0':
1325                         $possible = $charlist ? $charlist : yourls_get_shorturl_charset() ;
1326                         break;
1327
1328                 // no vowels to make no offending word, no 0/1/o/l to avoid confusion between letters & digits. Perfect for passwords.
1329                 case '1':
1330                         $possible = "23456789bcdfghjkmnpqrstvwxyz";
1331                         break;
1332
1333                 // Same, with lower + upper
1334                 case '2':
1335                         $possible = "23456789bcdfghjkmnpqrstvwxyzBCDFGHJKMNPQRSTVWXYZ";
1336                         break;
1337
1338                 // all letters, lowercase
1339                 case '3':
1340                         $possible = "abcdefghijklmnopqrstuvwxyz";
1341                         break;
1342
1343                 // all letters, lowercase + uppercase
1344                 case '4':
1345                         $possible = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
1346                         break;
1347
1348                 // all digits & letters lowercase
1349                 case '5':
1350                         $possible = "0123456789abcdefghijklmnopqrstuvwxyz";
1351                         break;
1352
1353                 // all digits & letters lowercase + uppercase
1354                 case '6':
1355                         $possible = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
1356                         break;
1357
1358         }
1359
1360         $i = 0;
1361         while ($i < $length) {
1362                 $str .= substr( $possible, mt_rand( 0, strlen( $possible )-1 ), 1 );
1363                 $i++;
1364         }
1365
1366         return yourls_apply_filter( 'rnd_string', $str, $length, $type, $charlist );
1367 }
1368
1369 /**
1370  * Return salted string
1371  *
1372  */
1373 function yourls_salt( $string ) {
1374         $salt = defined('YOURLS_COOKIEKEY') ? YOURLS_COOKIEKEY : md5(__FILE__) ;
1375         return yourls_apply_filter( 'yourls_salt', md5 ($string . $salt), $string );
1376 }
1377
1378 /**
1379  * Add a query var to a URL and return URL. Completely stolen from WP.
1380  *
1381  * Works with one of these parameter patterns:
1382  *     array( 'var' => 'value' )
1383  *     array( 'var' => 'value' ), $url
1384  *     'var', 'value'
1385  *     'var', 'value', $url
1386  * If $url omitted, uses $_SERVER['REQUEST_URI']
1387  *
1388  */
1389 function yourls_add_query_arg() {
1390         $ret = '';
1391         if ( is_array( func_get_arg(0) ) ) {
1392                 if ( @func_num_args() < 2 || false === @func_get_arg( 1 ) )
1393                         $uri = $_SERVER['REQUEST_URI'];
1394                 else
1395                         $uri = @func_get_arg( 1 );
1396         } else {
1397                 if ( @func_num_args() < 3 || false === @func_get_arg( 2 ) )
1398                         $uri = $_SERVER['REQUEST_URI'];
1399                 else
1400                         $uri = @func_get_arg( 2 );
1401         }
1402
1403         $uri = str_replace( '&amp;', '&', $uri );
1404
1405
1406         if ( $frag = strstr( $uri, '#' ) )
1407                 $uri = substr( $uri, 0, -strlen( $frag ) );
1408         else
1409                 $frag = '';
1410
1411         if ( preg_match( '|^https?://|i', $uri, $matches ) ) {
1412                 $protocol = $matches[0];
1413                 $uri = substr( $uri, strlen( $protocol ) );
1414         } else {
1415                 $protocol = '';
1416         }
1417
1418         if ( strpos( $uri, '?' ) !== false ) {
1419                 $parts = explode( '?', $uri, 2 );
1420                 if ( 1 == count( $parts ) ) {
1421                         $base = '?';
1422                         $query = $parts[0];
1423                 } else {
1424                         $base = $parts[0] . '?';
1425                         $query = $parts[1];
1426                 }
1427         } elseif ( !empty( $protocol ) || strpos( $uri, '=' ) === false ) {
1428                 $base = $uri . '?';
1429                 $query = '';
1430         } else {
1431                 $base = '';
1432                 $query = $uri;
1433         }
1434
1435         parse_str( $query, $qs );
1436         $qs = yourls_urlencode_deep( $qs ); // this re-URL-encodes things that were already in the query string
1437         if ( is_array( func_get_arg( 0 ) ) ) {
1438                 $kayvees = func_get_arg( 0 );
1439                 $qs = array_merge( $qs, $kayvees );
1440         } else {
1441                 $qs[func_get_arg( 0 )] = func_get_arg( 1 );
1442         }
1443
1444         foreach ( (array) $qs as $k => $v ) {
1445                 if ( $v === false )
1446                         unset( $qs[$k] );
1447         }
1448
1449         $ret = http_build_query( $qs );
1450         $ret = trim( $ret, '?' );
1451         $ret = preg_replace( '#=(&|$)#', '$1', $ret );
1452         $ret = $protocol . $base . $ret . $frag;
1453         $ret = rtrim( $ret, '?' );
1454         return $ret;
1455 }
1456
1457 /**
1458  * Navigates through an array and encodes the values to be used in a URL. Stolen from WP, used in yourls_add_query_arg()
1459  *
1460  */
1461 function yourls_urlencode_deep( $value ) {
1462         $value = is_array( $value ) ? array_map( 'yourls_urlencode_deep', $value ) : urlencode( $value );
1463         return $value;
1464 }
1465
1466 /**
1467  * Remove arg from query. Opposite of yourls_add_query_arg. Stolen from WP.
1468  *
1469  */
1470 function yourls_remove_query_arg( $key, $query = false ) {
1471         if ( is_array( $key ) ) { // removing multiple keys
1472                 foreach ( $key as $k )
1473                         $query = yourls_add_query_arg( $k, false, $query );
1474                 return $query;
1475         }
1476         return yourls_add_query_arg( $key, false, $query );
1477 }
1478
1479 /**
1480  * Return a time-dependent string for nonce creation
1481  *
1482  */
1483 function yourls_tick() {
1484         return ceil( time() / YOURLS_NONCE_LIFE );
1485 }
1486
1487 /**
1488  * Create a time limited, action limited and user limited token
1489  *
1490  */
1491 function yourls_create_nonce( $action, $user = false ) {
1492         if( false == $user )
1493                 $user = defined( 'YOURLS_USER' ) ? YOURLS_USER : '-1';
1494         $tick = yourls_tick();
1495         return substr( yourls_salt($tick . $action . $user), 0, 10 );
1496 }
1497
1498 /**
1499  * Create a nonce field for inclusion into a form
1500  *
1501  */
1502 function yourls_nonce_field( $action, $name = 'nonce', $user = false, $echo = true ) {
1503         $field = '<input type="hidden" id="'.$name.'" name="'.$name.'" value="'.yourls_create_nonce( $action, $user ).'" />';
1504         if( $echo )
1505                 echo $field."\n";
1506         return $field;
1507 }
1508
1509 /**
1510  * Add a nonce to a URL. If URL omitted, adds nonce to current URL
1511  *
1512  */
1513 function yourls_nonce_url( $action, $url = false, $name = 'nonce', $user = false ) {
1514         $nonce = yourls_create_nonce( $action, $user );
1515         return yourls_add_query_arg( $name, $nonce, $url );
1516 }
1517
1518 /**
1519  * Check validity of a nonce (ie time span, user and action match).
1520  *
1521  * Returns true if valid, dies otherwise (yourls_die() or die($return) if defined)
1522  * if $nonce is false or unspecified, it will use $_REQUEST['nonce']
1523  *
1524  */
1525 function yourls_verify_nonce( $action, $nonce = false, $user = false, $return = '' ) {
1526         // get user
1527         if( false == $user )
1528                 $user = defined( 'YOURLS_USER' ) ? YOURLS_USER : '-1';
1529
1530         // get current nonce value
1531         if( false == $nonce && isset( $_REQUEST['nonce'] ) )
1532                 $nonce = $_REQUEST['nonce'];
1533
1534         // what nonce should be
1535         $valid = yourls_create_nonce( $action, $user );
1536
1537         if( $nonce == $valid ) {
1538                 return true;
1539         } else {
1540                 if( $return )
1541                         die( $return );
1542                 yourls_die( yourls__( 'Unauthorized action or expired link' ), yourls__( 'Error' ), 403 );
1543         }
1544 }
1545
1546 /**
1547  * Converts keyword into short link (prepend with YOURLS base URL)
1548  *
1549  */
1550 function yourls_link( $keyword = '' ) {
1551         $link = YOURLS_SITE . '/' . yourls_sanitize_keyword( $keyword );
1552         return yourls_apply_filter( 'yourls_link', $link, $keyword );
1553 }
1554
1555 /**
1556  * Converts keyword into stat link (prepend with YOURLS base URL, append +)
1557  *
1558  */
1559 function yourls_statlink( $keyword = '' ) {
1560         $link = YOURLS_SITE . '/' . yourls_sanitize_keyword( $keyword ) . '+';
1561         if( yourls_is_ssl() )
1562                 $link = str_replace( 'http://', 'https://', $link );
1563         return yourls_apply_filter( 'yourls_statlink', $link, $keyword );
1564 }
1565
1566 /**
1567  * Check if we're in API mode. Returns bool
1568  *
1569  */
1570 function yourls_is_API() {
1571         if ( defined( 'YOURLS_API' ) && YOURLS_API == true )
1572                 return true;
1573         return false;
1574 }
1575
1576 /**
1577  * Check if we're in Ajax mode. Returns bool
1578  *
1579  */
1580 function yourls_is_Ajax() {
1581         if ( defined( 'YOURLS_AJAX' ) && YOURLS_AJAX == true )
1582                 return true;
1583         return false;
1584 }
1585
1586 /**
1587  * Check if we're in GO mode (yourls-go.php). Returns bool
1588  *
1589  */
1590 function yourls_is_GO() {
1591         if ( defined( 'YOURLS_GO' ) && YOURLS_GO == true )
1592                 return true;
1593         return false;
1594 }
1595
1596 /**
1597  * Check if we're displaying stats infos (yourls-infos.php). Returns bool
1598  *
1599  */
1600 function yourls_is_infos() {
1601         if ( defined( 'YOURLS_INFOS' ) && YOURLS_INFOS == true )
1602                 return true;
1603         return false;
1604 }
1605
1606 /**
1607  * Check if we'll need interface display function (ie not API or redirection)
1608  *
1609  */
1610 function yourls_has_interface() {
1611         if( yourls_is_API() or yourls_is_GO() )
1612                 return false;
1613         return true;
1614 }
1615
1616 /**
1617  * Check if we're in the admin area. Returns bool
1618  *
1619  */
1620 function yourls_is_admin() {
1621         if ( defined( 'YOURLS_ADMIN' ) && YOURLS_ADMIN == true )
1622                 return true;
1623         return false;
1624 }
1625
1626 /**
1627  * Check if the server seems to be running on Windows. Not exactly sure how reliable this is.
1628  *
1629  */
1630 function yourls_is_windows() {
1631         return defined( 'DIRECTORY_SEPARATOR' ) && DIRECTORY_SEPARATOR == '\\';
1632 }
1633
1634 /**
1635  * Check if SSL is required. Returns bool.
1636  *
1637  */
1638 function yourls_needs_ssl() {
1639         if ( defined('YOURLS_ADMIN_SSL') && YOURLS_ADMIN_SSL == true )
1640                 return true;
1641         return false;
1642 }
1643
1644 /**
1645  * Return admin link, with SSL preference if applicable.
1646  *
1647  */
1648 function yourls_admin_url( $page = '' ) {
1649         $admin = YOURLS_SITE . '/admin/' . $page;
1650         if( yourls_is_ssl() or yourls_needs_ssl() )
1651                 $admin = str_replace('http://', 'https://', $admin);
1652         return yourls_apply_filter( 'admin_url', $admin, $page );
1653 }
1654
1655 /**
1656  * Return YOURLS_SITE or URL under YOURLS setup, with SSL preference
1657  *
1658  */
1659 function yourls_site_url( $echo = true, $url = '' ) {
1660         $url = yourls_get_relative_url( $url );
1661         $url = trim( YOURLS_SITE . '/' . $url, '/' );
1662
1663         // Do not enforce (checking yourls_need_ssl() ) but check current usage so it won't force SSL on non-admin pages
1664         if( yourls_is_ssl() )
1665                 $url = str_replace( 'http://', 'https://', $url );
1666         $url = yourls_apply_filter( 'site_url', $url );
1667         if( $echo )
1668                 echo $url;
1669         return $url;
1670 }
1671
1672 /**
1673  * Check if SSL is used, returns bool. Stolen from WP.
1674  *
1675  */
1676 function yourls_is_ssl() {
1677         $is_ssl = false;
1678         if ( isset( $_SERVER['HTTPS'] ) ) {
1679                 if ( 'on' == strtolower( $_SERVER['HTTPS'] ) )
1680                         $is_ssl = true;
1681                 if ( '1' == $_SERVER['HTTPS'] )
1682                         $is_ssl = true;
1683         } elseif ( isset( $_SERVER['SERVER_PORT'] ) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
1684                 $is_ssl = true;
1685         }
1686         return yourls_apply_filter( 'is_ssl', $is_ssl );
1687 }
1688
1689
1690 /**
1691  * Get a remote page <title>, return a string (either title or url)
1692  *
1693  */
1694 function yourls_get_remote_title( $url ) {
1695         // Allow plugins to short-circuit the whole function
1696         $pre = yourls_apply_filter( 'shunt_get_remote_title', false, $url );
1697         if ( false !== $pre )
1698                 return $pre;
1699
1700         require_once( YOURLS_INC.'/functions-http.php' );
1701
1702         $url = yourls_sanitize_url( $url );
1703
1704         $title = $charset = false;
1705
1706         $content = yourls_get_remote_content( $url );
1707
1708         // If false, return url as title.
1709         // Todo: improve this with temporary title when shorturl_meta available?
1710         if( false === $content )
1711                 return $url;
1712
1713         if( $content !== false ) {
1714                 // look for <title>
1715                 if ( preg_match('/<title>(.*?)<\/title>/is', $content, $found ) ) {
1716                         $title = $found[1];
1717                         unset( $found );
1718                 }
1719
1720                 // look for charset
1721                 // <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
1722                 if ( preg_match('/<meta[^>]*?charset=([^>]*?)\/?>/is', $content, $found ) ) {
1723                         $charset = trim($found[1], '"\' ');
1724                         unset( $found );
1725                 }
1726         }
1727
1728         // if title not found, guess if returned content was actually an error message
1729         if( $title == false && strpos( $content, 'Error' ) === 0 ) {
1730                 $title = $content;
1731         }
1732
1733         if( $title == false )
1734                 $title = $url;
1735
1736         /*
1737         if( !yourls_seems_utf8( $title ) )
1738                 $title = utf8_encode( $title );
1739         */
1740
1741         // Charset conversion. We use @ to remove warnings (mb_ functions are easily bitching about illegal chars)
1742         if( function_exists( 'mb_convert_encoding' ) ) {
1743                 if( $charset ) {
1744                         $title = @mb_convert_encoding( $title, 'UTF-8', $charset );
1745                 } else {
1746                         $title = @mb_convert_encoding( $title, 'UTF-8' );
1747                 }
1748         }
1749
1750         // Remove HTML entities
1751         $title = html_entity_decode( $title, ENT_QUOTES, 'UTF-8' );
1752
1753         // Strip out evil things
1754         $title = yourls_sanitize_title( $title );
1755
1756         return yourls_apply_filter( 'get_remote_title', $title, $url );
1757 }
1758
1759 /**
1760  * Quick UA check for mobile devices. Return boolean.
1761  *
1762  */
1763 function yourls_is_mobile_device() {
1764         // Strings searched
1765         $mobiles = array(
1766                 'android', 'blackberry', 'blazer',
1767                 'compal', 'elaine', 'fennec', 'hiptop',
1768                 'iemobile', 'iphone', 'ipod', 'ipad',
1769                 'iris', 'kindle', 'opera mobi', 'opera mini',
1770                 'palm', 'phone', 'pocket', 'psp', 'symbian',
1771                 'treo', 'wap', 'windows ce', 'windows phone'
1772         );
1773
1774         // Current user-agent
1775         $current = strtolower( $_SERVER['HTTP_USER_AGENT'] );
1776
1777         // Check and return
1778         $is_mobile = ( str_replace( $mobiles, '', $current ) != $current );
1779         return yourls_apply_filter( 'is_mobile_device', $is_mobile );
1780 }
1781
1782 /**
1783  * Get request in YOURLS base (eg in 'http://site.com/yourls/abcd' get 'abdc')
1784  *
1785  */
1786 function yourls_get_request() {
1787         // Allow plugins to short-circuit the whole function
1788         $pre = yourls_apply_filter( 'shunt_get_request', false );
1789         if ( false !== $pre )
1790                 return $pre;
1791
1792         static $request = null;
1793
1794         yourls_do_action( 'pre_get_request', $request );
1795
1796         if( $request !== null )
1797                 return $request;
1798
1799         // Ignore protocol & www. prefix
1800         $root = str_replace( array( 'https://', 'http://', 'https://www.', 'http://www.' ), '', YOURLS_SITE );
1801         // Case insensitive comparison of the YOURLS root to match both http://Sho.rt/blah and http://sho.rt/blah
1802         $request = preg_replace( "!$root/!i", '', $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], 1 );
1803
1804         // Unless request looks like a full URL (ie request is a simple keyword) strip query string
1805         if( !preg_match( "@^[a-zA-Z]+://.+@", $request ) ) {
1806                 $request = current( explode( '?', $request ) );
1807         }
1808
1809         return yourls_apply_filter( 'get_request', $request );
1810 }
1811
1812 /**
1813  * Change protocol to match current scheme used (http or https)
1814  *
1815  */
1816 function yourls_match_current_protocol( $url, $normal = 'http', $ssl = 'https' ) {
1817         if( yourls_is_ssl() )
1818                 $url = str_replace( $normal, $ssl, $url );
1819         return yourls_apply_filter( 'match_current_protocol', $url );
1820 }
1821
1822 /**
1823  * Fix $_SERVER['REQUEST_URI'] variable for various setups. Stolen from WP.
1824  *
1825  */
1826 function yourls_fix_request_uri() {
1827
1828         $default_server_values = array(
1829                 'SERVER_SOFTWARE' => '',
1830                 'REQUEST_URI' => '',
1831         );
1832         $_SERVER = array_merge( $default_server_values, $_SERVER );
1833
1834         // Fix for IIS when running with PHP ISAPI
1835         if ( empty( $_SERVER['REQUEST_URI'] ) || ( php_sapi_name() != 'cgi-fcgi' && preg_match( '/^Microsoft-IIS\//', $_SERVER['SERVER_SOFTWARE'] ) ) ) {
1836
1837                 // IIS Mod-Rewrite
1838                 if ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] ) ) {
1839                         $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_ORIGINAL_URL'];
1840                 }
1841                 // IIS Isapi_Rewrite
1842                 else if ( isset( $_SERVER['HTTP_X_REWRITE_URL'] ) ) {
1843                         $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_REWRITE_URL'];
1844                 } else {
1845                         // Use ORIG_PATH_INFO if there is no PATH_INFO
1846                         if ( !isset( $_SERVER['PATH_INFO'] ) && isset( $_SERVER['ORIG_PATH_INFO'] ) )
1847                                 $_SERVER['PATH_INFO'] = $_SERVER['ORIG_PATH_INFO'];
1848
1849                         // Some IIS + PHP configurations puts the script-name in the path-info (No need to append it twice)
1850                         if ( isset( $_SERVER['PATH_INFO'] ) ) {
1851                                 if ( $_SERVER['PATH_INFO'] == $_SERVER['SCRIPT_NAME'] )
1852                                         $_SERVER['REQUEST_URI'] = $_SERVER['PATH_INFO'];
1853                                 else
1854                                         $_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME'] . $_SERVER['PATH_INFO'];
1855                         }
1856
1857                         // Append the query string if it exists and isn't null
1858                         if ( ! empty( $_SERVER['QUERY_STRING'] ) ) {
1859                                 $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING'];
1860                         }
1861                 }
1862         }
1863 }
1864
1865 /**
1866  * Shutdown function, runs just before PHP shuts down execution. Stolen from WP
1867  *
1868  */
1869 function yourls_shutdown() {
1870         yourls_do_action( 'shutdown' );
1871 }
1872
1873 /**
1874  * Auto detect custom favicon in /user directory, fallback to YOURLS favicon, and echo/return its URL
1875  *
1876  */
1877 function yourls_favicon( $echo = true ) {
1878         static $favicon = null;
1879         if( $favicon !== null )
1880                 return $favicon;
1881
1882         $custom = null;
1883         // search for favicon.(gif|ico|png|jpg|svg)
1884         foreach( array( 'gif', 'ico', 'png', 'jpg', 'svg' ) as $ext ) {
1885                 if( file_exists( YOURLS_USERDIR. '/favicon.' . $ext ) ) {
1886                         $custom = 'favicon.' . $ext;
1887                         break;
1888                 }
1889         }
1890
1891         if( $custom ) {
1892                 $favicon = yourls_site_url( false, YOURLS_USERURL . '/' . $custom );
1893         } else {
1894                 $favicon = yourls_site_url( false ) . '/images/favicon.gif';
1895         }
1896         if( $echo )
1897                 echo $favicon;
1898         return $favicon;
1899 }
1900
1901 /**
1902  * Check for maintenance mode. If yes, die. See yourls_maintenance_mode(). Stolen from WP.
1903  *
1904  */
1905 function yourls_check_maintenance_mode() {
1906
1907         $file = YOURLS_ABSPATH . '/.maintenance' ;
1908         if ( !file_exists( $file ) || yourls_is_upgrading() || yourls_is_installing() )
1909                 return;
1910
1911         global $maintenance_start;
1912
1913         include( $file );
1914         // If the $maintenance_start timestamp is older than 10 minutes, don't die.
1915         if ( ( time() - $maintenance_start ) >= 600 )
1916                 return;
1917
1918         // Use any /user/maintenance.php file
1919         if( file_exists( YOURLS_USERDIR.'/maintenance.php' ) ) {
1920                 include( YOURLS_USERDIR.'/maintenance.php' );
1921                 die();
1922         }
1923
1924         // https://www.youtube.com/watch?v=Xw-m4jEY-Ns
1925         $title   = yourls__( 'Service temporarily unavailable' );
1926         $message = yourls__( 'Our service is currently undergoing scheduled maintenance.' ) . "</p>\n<p>" .
1927         yourls__( 'Things should not last very long, thank you for your patience and please excuse the inconvenience' );
1928         yourls_die( $message, $title , 503 );
1929
1930 }
1931
1932 /**
1933  * Return current admin page, or null if not an admin page
1934  *
1935  * @return mixed string if admin page, null if not an admin page
1936  * @since 1.6
1937  */
1938 function yourls_current_admin_page() {
1939         if( yourls_is_admin() ) {
1940                 $current = substr( yourls_get_request(), 6 );
1941                 if( $current === false )
1942                         $current = 'index.php'; // if current page is http://sho.rt/admin/ instead of http://sho.rt/admin/index.php
1943
1944                 return $current;
1945         }
1946         return null;
1947 }
1948
1949 /**
1950  * Check if a URL protocol is allowed
1951  *
1952  * Checks a URL against a list of whitelisted protocols. Protocols must be defined with
1953  * their complete scheme name, ie 'stuff:' or 'stuff://' (for instance, 'mailto:' is a valid
1954  * protocol, 'mailto://' isn't, and 'http:' with no double slashed isn't either
1955  *
1956  * @since 1.6
1957  *
1958  * @param string $url URL to be check
1959  * @param array $protocols Optional. Array of protocols, defaults to global $yourls_allowedprotocols
1960  * @return boolean true if protocol allowed, false otherwise
1961  */
1962 function yourls_is_allowed_protocol( $url, $protocols = array() ) {
1963         if( ! $protocols ) {
1964                 global $yourls_allowedprotocols;
1965                 $protocols = $yourls_allowedprotocols;
1966         }
1967
1968         $protocol = yourls_get_protocol( $url );
1969         return yourls_apply_filter( 'is_allowed_protocol', in_array( $protocol, $protocols ), $url, $protocols );
1970 }
1971
1972 /**
1973  * Get protocol from a URL (eg mailto:, http:// ...)
1974  *
1975  * @since 1.6
1976  *
1977  * @param string $url URL to be check
1978  * @return string Protocol, with slash slash if applicable. Empty string if no protocol
1979  */
1980 function yourls_get_protocol( $url ) {
1981         preg_match( '!^[a-zA-Z0-9\+\.-]+:(//)?!', $url, $matches );
1982         /*
1983         http://en.wikipedia.org/wiki/URI_scheme#Generic_syntax
1984         The scheme name consists of a sequence of characters beginning with a letter and followed by any
1985         combination of letters, digits, plus ("+"), period ("."), or hyphen ("-"). Although schemes are
1986         case-insensitive, the canonical form is lowercase and documents that specify schemes must do so
1987         with lowercase letters. It is followed by a colon (":").
1988         */
1989         $protocol = ( isset( $matches[0] ) ? $matches[0] : '' );
1990         return yourls_apply_filter( 'get_protocol', $protocol, $url );
1991 }
1992
1993 /**
1994  * Get relative URL (eg 'abc' from 'http://sho.rt/abc')
1995  *
1996  * Treat indifferently http & https. If a URL isn't relative to the YOURLS install, return it as is
1997  * or return empty string if $strict is true
1998  *
1999  * @since 1.6
2000  * @param string $url URL to relativize
2001  * @param bool $strict if true and if URL isn't relative to YOURLS install, return empty string
2002  * @return string URL
2003  */
2004 function yourls_get_relative_url( $url, $strict = true ) {
2005         $url = yourls_sanitize_url( $url );
2006
2007         // Remove protocols to make it easier
2008         $noproto_url  = str_replace( 'https:', 'http:', $url );
2009         $noproto_site = str_replace( 'https:', 'http:', YOURLS_SITE );
2010
2011         // Trim URL from YOURLS root URL : if no modification made, URL wasn't relative
2012         $_url = str_replace( $noproto_site . '/', '', $noproto_url );
2013         if( $_url == $noproto_url )
2014                 $_url = ( $strict ? '' : $url );
2015
2016         return yourls_apply_filter( 'get_relative_url', $_url, $url );
2017 }
2018
2019 /**
2020  * Marks a function as deprecated and informs when it has been used. Stolen from WP.
2021  *
2022  * There is a hook deprecated_function that will be called that can be used
2023  * to get the backtrace up to what file and function called the deprecated
2024  * function.
2025  *
2026  * The current behavior is to trigger a user error if YOURLS_DEBUG is true.
2027  *
2028  * This function is to be used in every function that is deprecated.
2029  *
2030  * @since 1.6
2031  * @uses yourls_do_action() Calls 'deprecated_function' and passes the function name, what to use instead,
2032  *   and the version the function was deprecated in.
2033  * @uses yourls_apply_filters() Calls 'deprecated_function_trigger_error' and expects boolean value of true to do
2034  *   trigger or false to not trigger error.
2035  *
2036  * @param string $function The function that was called
2037  * @param string $version The version of WordPress that deprecated the function
2038  * @param string $replacement Optional. The function that should have been called
2039  */
2040 function yourls_deprecated_function( $function, $version, $replacement = null ) {
2041
2042         yourls_do_action( 'deprecated_function', $function, $replacement, $version );
2043
2044         // Allow plugin to filter the output error trigger
2045         if ( YOURLS_DEBUG && yourls_apply_filters( 'deprecated_function_trigger_error', true ) ) {
2046                 if ( ! is_null( $replacement ) )
2047                         trigger_error( sprintf( yourls__('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $function, $version, $replacement ) );
2048                 else
2049                         trigger_error( sprintf( yourls__('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
2050         }
2051 }
2052
2053 /**
2054  * Return the value if not an empty string
2055  *
2056  * Used with array_filter(), to remove empty keys but not keys with value 0 or false
2057  *
2058  * @since 1.6
2059  * @param mixed $val Value to test against ''
2060  * @return bool True if not an empty string
2061  */
2062 function yourls_return_if_not_empty_string( $val ) {
2063         return( $val !== '' );
2064 }