includes/functions.php

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