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