includes/functions-formatting.php

   1 <?php
   2 /*
   3  * YOURLS
   4  * Function library for anything related to formatting / validating / sanitizing
   5  */
   6
   7 /**
   8  * Convert an integer (1337) to a string (3jk).
   9  *
  10  */
  11 function yourls_int2string( $num, $chars = null ) {
  12         if( $chars == null )
  13                 $chars = yourls_get_shorturl_charset();
  14         $string = '';
  15         $len = strlen( $chars );
  16         while( $num >= $len ) {
  17                 $mod = bcmod( $num, $len );
  18                 $num = bcdiv( $num, $len );
  19                 $string = $chars[ $mod ] . $string;
  20         }
  21         $string = $chars[ intval( $num ) ] . $string;
  22
  23         return yourls_apply_filter( 'int2string', $string, $num, $chars );
  24 }
  25
  26 /**
  27  * Convert a string (3jk) to an integer (1337)
  28  *
  29  */
  30 function yourls_string2int( $string, $chars = null ) {
  31         if( $chars == null )
  32                 $chars = yourls_get_shorturl_charset();
  33         $integer = 0;
  34         $string = strrev( $string  );
  35         $baselen = strlen( $chars );
  36         $inputlen = strlen( $string );
  37         for ($i = 0; $i < $inputlen; $i++) {
  38                 $index = strpos( $chars, $string[$i] );
  39                 $integer = bcadd( $integer, bcmul( $index, bcpow( $baselen, $i ) ) );
  40         }
  41
  42         return yourls_apply_filter( 'string2int', $integer, $string, $chars );
  43 }
  44
  45 /**
  46  * Return a unique(ish) hash for a string to be used as a valid HTML id
  47  *
  48  */
  49 function yourls_string2htmlid( $string ) {
  50         return yourls_apply_filter( 'string2htmlid', 'y'.abs( crc32( $string ) ) );
  51 }
  52
  53 /**
  54  * Make sure a link keyword (ie "1fv" as in "http://sho.rt/1fv") is valid.
  55  *
  56  */
  57 function yourls_sanitize_string( $string ) {
  58         // make a regexp pattern with the shorturl charset, and remove everything but this
  59         $pattern = yourls_make_regexp_pattern( yourls_get_shorturl_charset() );
  60         $valid = substr( preg_replace( '![^'.$pattern.']!', '', $string ), 0, 199 );
  61
  62         return yourls_apply_filter( 'sanitize_string', $valid, $string );
  63 }
  64
  65 /**
  66  * Alias function. I was always getting it wrong.
  67  *
  68  */
  69 function yourls_sanitize_keyword( $keyword ) {
  70         return yourls_sanitize_string( $keyword );
  71 }
  72
  73 /**
  74  * Sanitize a page title. No HTML per W3C http://www.w3.org/TR/html401/struct/global.html#h-7.4.2
  75  *
  76  *
  77  * @since 1.5
  78  * @param string $unsafe_title  Title, potentially unsafe
  79  * @param string $fallback      Optional fallback if after sanitization nothing remains
  80  * @return string               Safe title
  81  */
  82 function yourls_sanitize_title( $unsafe_title, $fallback = '' ) {
  83         $title = $unsafe_title;
  84         $title = strip_tags( $title );
  85         $title = preg_replace( "/\s+/", ' ', trim( $title ) );
  86
  87     if ( '' === $title || false === $title ) {
  88         $title = $fallback;
  89     }
  90
  91         return yourls_apply_filter( 'sanitize_title', $title, $unsafe_title, $fallback );
  92 }
  93
  94 /**
  95  * A few sanity checks on the URL. Used for redirection or DB. For display purpose, see yourls_esc_url()
  96  *
  97  * @param string $unsafe_url unsafe URL
  98  * @param array $protocols Optional allowed protocols, default to global $yourls_allowedprotocols
  99  * @return string Safe URL
 100  */
 101 function yourls_sanitize_url( $unsafe_url, $protocols = array() ) {
 102         $url = yourls_esc_url( $unsafe_url, 'redirection', $protocols );
 103         return yourls_apply_filter( 'sanitize_url', $url, $unsafe_url );
 104 }
 105
 106 /**
 107  * Perform a replacement while a string is found, eg $subject = '%0%0%0DDD', $search ='%0D' -> $result =''
 108  *
 109  * Stolen from WP's _deep_replace
 110  *
 111  */
 112 function yourls_deep_replace( $search, $subject ){
 113         $found = true;
 114         while($found) {
 115                 $found = false;
 116                 foreach( (array) $search as $val ) {
 117                         while( strpos( $subject, $val ) !== false ) {
 118                                 $found = true;
 119                                 $subject = str_replace( $val, '', $subject );
 120                         }
 121                 }
 122         }
 123
 124         return $subject;
 125 }
 126
 127 /**
 128  * Make sure an integer is a valid integer (PHP's intval() limits to too small numbers)
 129  *
 130  */
 131 function yourls_sanitize_int( $in ) {
 132         return ( substr( preg_replace( '/[^0-9]/', '', strval( $in ) ), 0, 20 ) );
 133 }
 134
 135 /**
 136  * Escape a string or an array of strings before DB usage. ALWAYS escape before using in a SQL query. Thanks.
 137  *
 138  * @param string|array $data string or array of strings to be escaped
 139  * @return string|array escaped data
 140  */
 141 function yourls_escape( $data ) {
 142         if( is_array( $data ) ) {
 143                 foreach( $data as $k => $v ) {
 144                         if( is_array( $v ) ) {
 145                                 $data[ $k ] = yourls_escape( $v );
 146                         } else {
 147                                 $data[ $k ] = yourls_escape_real( $v );
 148                         }
 149                 }
 150         } else {
 151                 $data = yourls_escape_real( $data );
 152         }
 153
 154         return $data;
 155 }
 156
 157 /**
 158  * "Real" escape. This function should NOT be called directly. Use yourls_escape() instead.
 159  *
 160  * This function uses a "real" escape if possible, using PDO, MySQL or MySQLi functions,
 161  * with a fallback to a "simple" addslashes
 162  * If you're implementing a custom DB engine or a custom cache system, you can define an
 163  * escape function using filter 'custom_escape_real'
 164  *
 165  * @since 1.7
 166  * @param string $a string to be escaped
 167  * @return string escaped string
 168  */
 169 function yourls_escape_real( $string ) {
 170         global $ydb;
 171         if( isset( $ydb ) && ( $ydb instanceof ezSQLcore ) )
 172                 return $ydb->escape( $string );
 173
 174         // YOURLS DB classes have been bypassed by a custom DB engine or a custom cache layer
 175         return yourls_apply_filter( 'custom_escape_real', addslashes( $string ), $string );
 176 }
 177
 178 /**
 179  * Sanitize an IP address
 180  *
 181  */
 182 function yourls_sanitize_ip( $ip ) {
 183         return preg_replace( '/[^0-9a-fA-F:., ]/', '', $ip );
 184 }
 185
 186 /**
 187  * Make sure a date is m(m)/d(d)/yyyy, return false otherwise
 188  *
 189  */
 190 function yourls_sanitize_date( $date ) {
 191         if( !preg_match( '!^\d{1,2}/\d{1,2}/\d{4}$!' , $date ) ) {
 192                 return false;
 193         }
 194         return $date;
 195 }
 196
 197 /**
 198  * Sanitize a date for SQL search. Return false if malformed input.
 199  *
 200  */
 201 function yourls_sanitize_date_for_sql( $date ) {
 202         if( !yourls_sanitize_date( $date ) )
 203                 return false;
 204         return date( 'Y-m-d', strtotime( $date ) );
 205 }
 206
 207 /**
 208  * Return trimmed string
 209  *
 210  */
 211 function yourls_trim_long_string( $string, $length = 60, $append = '[...]' ) {
 212         $newstring = $string;
 213         if( function_exists( 'mb_substr' ) ) {
 214                 if ( mb_strlen( $newstring ) > $length ) {
 215                         $newstring = mb_substr( $newstring, 0, $length - mb_strlen( $append ), 'UTF-8' ) . $append;
 216                 }
 217         } else {
 218                 if ( strlen( $newstring ) > $length ) {
 219                         $newstring = substr( $newstring, 0, $length - strlen( $append ) ) . $append;
 220                 }
 221         }
 222         return yourls_apply_filter( 'trim_long_string', $newstring, $string, $length, $append );
 223 }
 224
 225 /**
 226  * Sanitize a version number (1.4.1-whatever -> 1.4.1)
 227  *
 228  */
 229 function yourls_sanitize_version( $ver ) {
 230         return preg_replace( '/[^0-9.]/', '', $ver );
 231 }
 232
 233 /**
 234  * Sanitize a filename (no Win32 stuff)
 235  *
 236  */
 237 function yourls_sanitize_filename( $file ) {
 238         $file = str_replace( '\\', '/', $file ); // sanitize for Win32 installs
 239         $file = preg_replace( '|/+|' ,'/', $file ); // remove any duplicate slash
 240         return $file;
 241 }
 242
 243 /**
 244  * Check if a string seems to be UTF-8. Stolen from WP.
 245  *
 246  */
 247 function yourls_seems_utf8( $str ) {
 248         $length = strlen( $str );
 249         for ( $i=0; $i < $length; $i++ ) {
 250                 $c = ord( $str[ $i ] );
 251                 if ( $c < 0x80 ) $n = 0; # 0bbbbbbb
 252                 elseif (($c & 0xE0) == 0xC0) $n=1; # 110bbbbb
 253                 elseif (($c & 0xF0) == 0xE0) $n=2; # 1110bbbb
 254                 elseif (($c & 0xF8) == 0xF0) $n=3; # 11110bbb
 255                 elseif (($c & 0xFC) == 0xF8) $n=4; # 111110bb
 256                 elseif (($c & 0xFE) == 0xFC) $n=5; # 1111110b
 257                 else return false; # Does not match any model
 258                 for ($j=0; $j<$n; $j++) { # n bytes matching 10bbbbbb follow ?
 259                         if ((++$i == $length) || ((ord($str[$i]) & 0xC0) != 0x80))
 260                                 return false;
 261                 }
 262         }
 263         return true;
 264 }
 265
 266 /**
 267  * Checks for invalid UTF8 in a string. Stolen from WP
 268  *
 269  * @since 1.6
 270  *
 271  * @param string $string The text which is to be checked.
 272  * @param boolean $strip Optional. Whether to attempt to strip out invalid UTF8. Default is false.
 273  * @return string The checked text.
 274  */
 275 function yourls_check_invalid_utf8( $string, $strip = false ) {
 276         $string = (string) $string;
 277
 278         if ( 0 === strlen( $string ) ) {
 279                 return '';
 280         }
 281
 282         // Check for support for utf8 in the installed PCRE library once and store the result in a static
 283         static $utf8_pcre;
 284         if ( !isset( $utf8_pcre ) ) {
 285                 $utf8_pcre = @preg_match( '/^./u', 'a' );
 286         }
 287         // We can't demand utf8 in the PCRE installation, so just return the string in those cases
 288         if ( !$utf8_pcre ) {
 289                 return $string;
 290         }
 291
 292         // preg_match fails when it encounters invalid UTF8 in $string
 293         if ( 1 === @preg_match( '/^./us', $string ) ) {
 294                 return $string;
 295         }
 296
 297         // Attempt to strip the bad chars if requested (not recommended)
 298         if ( $strip && function_exists( 'iconv' ) ) {
 299                 return iconv( 'utf-8', 'utf-8', $string );
 300         }
 301
 302         return '';
 303 }
 304
 305 /**
 306  * Converts a number of special characters into their HTML entities. Stolen from WP.
 307  *
 308  * Specifically deals with: &, <, >, ", and '.
 309  *
 310  * $quote_style can be set to ENT_COMPAT to encode " to
 311  * &quot;, or ENT_QUOTES to do both. Default is ENT_NOQUOTES where no quotes are encoded.
 312  *
 313  * @since 1.6
 314  *
 315  * @param string $string The text which is to be encoded.
 316  * @param mixed $quote_style Optional. Converts double quotes if set to ENT_COMPAT, both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. Also compatible with old values; converting single quotes if set to 'single', double if set to 'double' or both if otherwise set. Default is ENT_NOQUOTES.
 317  * @param boolean $double_encode Optional. Whether to encode existing html entities. Default is false.
 318  * @return string The encoded text with HTML entities.
 319  */
 320 function yourls_specialchars( $string, $quote_style = ENT_NOQUOTES, $double_encode = false ) {
 321         $string = (string) $string;
 322
 323         if ( 0 === strlen( $string ) )
 324                 return '';
 325
 326         // Don't bother if there are no specialchars - saves some processing
 327         if ( ! preg_match( '/[&<>"\']/', $string ) )
 328                 return $string;
 329
 330         // Account for the previous behaviour of the function when the $quote_style is not an accepted value
 331         if ( empty( $quote_style ) )
 332                 $quote_style = ENT_NOQUOTES;
 333         elseif ( ! in_array( $quote_style, array( 0, 2, 3, 'single', 'double' ), true ) )
 334                 $quote_style = ENT_QUOTES;
 335
 336         $charset = 'UTF-8';
 337
 338         $_quote_style = $quote_style;
 339
 340         if ( $quote_style === 'double' ) {
 341                 $quote_style = ENT_COMPAT;
 342                 $_quote_style = ENT_COMPAT;
 343         } elseif ( $quote_style === 'single' ) {
 344                 $quote_style = ENT_NOQUOTES;
 345         }
 346
 347         // Handle double encoding ourselves
 348         if ( $double_encode ) {
 349                 $string = @htmlspecialchars( $string, $quote_style, $charset );
 350         } else {
 351                 // Decode &amp; into &
 352                 $string = yourls_specialchars_decode( $string, $_quote_style );
 353
 354                 // Guarantee every &entity; is valid or re-encode the &
 355                 $string = yourls_kses_normalize_entities( $string );
 356
 357                 // Now re-encode everything except &entity;
 358                 $string = preg_split( '/(&#?x?[0-9a-z]+;)/i', $string, -1, PREG_SPLIT_DELIM_CAPTURE );
 359
 360                 for ( $i = 0; $i < count( $string ); $i += 2 )
 361                         $string[$i] = @htmlspecialchars( $string[$i], $quote_style, $charset );
 362
 363                 $string = implode( '', $string );
 364         }
 365
 366         // Backwards compatibility
 367         if ( 'single' === $_quote_style )
 368                 $string = str_replace( "'", '&#039;', $string );
 369
 370         return $string;
 371 }
 372
 373 /**
 374  * Converts a number of HTML entities into their special characters. Stolen from WP.
 375  *
 376  * Specifically deals with: &, <, >, ", and '.
 377  *
 378  * $quote_style can be set to ENT_COMPAT to decode " entities,
 379  * or ENT_QUOTES to do both " and '. Default is ENT_NOQUOTES where no quotes are decoded.
 380  *
 381  * @since 1.6
 382  *
 383  * @param string $string The text which is to be decoded.
 384  * @param mixed $quote_style Optional. Converts double quotes if set to ENT_COMPAT, both single and double if set to ENT_QUOTES or none if set to ENT_NOQUOTES. Also compatible with old _wp_specialchars() values; converting single quotes if set to 'single', double if set to 'double' or both if otherwise set. Default is ENT_NOQUOTES.
 385  * @return string The decoded text without HTML entities.
 386  */
 387 function yourls_specialchars_decode( $string, $quote_style = ENT_NOQUOTES ) {
 388         $string = (string) $string;
 389
 390         if ( 0 === strlen( $string ) ) {
 391                 return '';
 392         }
 393
 394         // Don't bother if there are no entities - saves a lot of processing
 395         if ( strpos( $string, '&' ) === false ) {
 396                 return $string;
 397         }
 398
 399         // Match the previous behaviour of _wp_specialchars() when the $quote_style is not an accepted value
 400         if ( empty( $quote_style ) ) {
 401                 $quote_style = ENT_NOQUOTES;
 402         } elseif ( !in_array( $quote_style, array( 0, 2, 3, 'single', 'double' ), true ) ) {
 403                 $quote_style = ENT_QUOTES;
 404         }
 405
 406         // More complete than get_html_translation_table( HTML_SPECIALCHARS )
 407         $single = array( '&#039;'  => '\'', '&#x27;' => '\'' );
 408         $single_preg = array( '/&#0*39;/'  => '&#039;', '/&#x0*27;/i' => '&#x27;' );
 409         $double = array( '&quot;' => '"', '&#034;'  => '"', '&#x22;' => '"' );
 410         $double_preg = array( '/&#0*34;/'  => '&#034;', '/&#x0*22;/i' => '&#x22;' );
 411         $others = array( '&lt;'   => '<', '&#060;'  => '<', '&gt;'   => '>', '&#062;'  => '>', '&amp;'  => '&', '&#038;'  => '&', '&#x26;' => '&' );
 412         $others_preg = array( '/&#0*60;/'  => '&#060;', '/&#0*62;/'  => '&#062;', '/&#0*38;/'  => '&#038;', '/&#x0*26;/i' => '&#x26;' );
 413
 414         if ( $quote_style === ENT_QUOTES ) {
 415                 $translation = array_merge( $single, $double, $others );
 416                 $translation_preg = array_merge( $single_preg, $double_preg, $others_preg );
 417         } elseif ( $quote_style === ENT_COMPAT || $quote_style === 'double' ) {
 418                 $translation = array_merge( $double, $others );
 419                 $translation_preg = array_merge( $double_preg, $others_preg );
 420         } elseif ( $quote_style === 'single' ) {
 421                 $translation = array_merge( $single, $others );
 422                 $translation_preg = array_merge( $single_preg, $others_preg );
 423         } elseif ( $quote_style === ENT_NOQUOTES ) {
 424                 $translation = $others;
 425                 $translation_preg = $others_preg;
 426         }
 427
 428         // Remove zero padding on numeric entities
 429         $string = preg_replace( array_keys( $translation_preg ), array_values( $translation_preg ), $string );
 430
 431         // Replace characters according to translation table
 432         return strtr( $string, $translation );
 433 }
 434
 435
 436 /**
 437  * Escaping for HTML blocks. Stolen from WP
 438  *
 439  * @since 1.6
 440  *
 441  * @param string $text
 442  * @return string
 443  */
 444 function yourls_esc_html( $text ) {
 445         $safe_text = yourls_check_invalid_utf8( $text );
 446         $safe_text = yourls_specialchars( $safe_text, ENT_QUOTES );
 447         return yourls_apply_filter( 'esc_html', $safe_text, $text );
 448 }
 449
 450 /**
 451  * Escaping for HTML attributes.  Stolen from WP
 452  *
 453  * @since 1.6
 454  *
 455  * @param string $text
 456  * @return string
 457  */
 458 function yourls_esc_attr( $text ) {
 459         $safe_text = yourls_check_invalid_utf8( $text );
 460         $safe_text = yourls_specialchars( $safe_text, ENT_QUOTES );
 461         return yourls_apply_filter( 'esc_attr', $safe_text, $text );
 462 }
 463
 464 /**
 465  * Checks and cleans a URL before printing it. Stolen from WP.
 466  *
 467  * A number of characters are removed from the URL. If the URL is for displaying
 468  * (the default behaviour) ampersands are also replaced.
 469  *
 470  * @since 1.6
 471  *
 472  * @param string $url The URL to be cleaned.
 473  * @param string $context 'display' or something else. Use yourls_sanitize_url() for database or redirection usage.
 474  * @param array $protocols Optional. Array of allowed protocols, defaults to global $yourls_allowedprotocols
 475  * @return string The cleaned $url
 476  */
 477 function yourls_esc_url( $url, $context = 'display', $protocols = array() ) {
 478         // make sure there's only one 'http://' at the beginning (prevents pasting a URL right after the default 'http://')
 479         $url = str_replace(
 480                 array( 'http://http://', 'http://https://' ),
 481                 array( 'http://',        'https://'        ),
 482                 $url
 483         );
 484
 485         if ( '' == $url )
 486                 return $url;
 487
 488         // make sure there's a protocol, add http:// if not
 489         if ( ! yourls_get_protocol( $url ) )
 490                 $url = 'http://'.$url;
 491
 492         $original_url = $url;
 493
 494         // force scheme and domain to lowercase - see issues 591 and 1630
 495     $url = yourls_lowercase_scheme_domain( $url );
 496
 497         $url = preg_replace( '|[^a-z0-9-~+_.?#=!&;,/:%@$\|*\'()\\x80-\\xff]|i', '', $url );
 498         // Previous regexp in YOURLS was '|[^a-z0-9-~+_.?\[\]\^#=!&;,/:%@$\|*`\'<>"()\\x80-\\xff\{\}]|i'
 499         // TODO: check if that was it too destructive
 500         $strip = array( '%0d', '%0a', '%0D', '%0A' );
 501         $url = yourls_deep_replace( $strip, $url );
 502         $url = str_replace( ';//', '://', $url );
 503
 504         // Replace ampersands and single quotes only when displaying.
 505         if ( 'display' == $context ) {
 506                 $url = yourls_kses_normalize_entities( $url );
 507                 $url = str_replace( '&amp;', '&#038;', $url );
 508                 $url = str_replace( "'", '&#039;', $url );
 509         }
 510
 511         if ( ! is_array( $protocols ) or ! $protocols ) {
 512                 global $yourls_allowedprotocols;
 513                 $protocols = yourls_apply_filter( 'esc_url_protocols', $yourls_allowedprotocols );
 514                 // Note: $yourls_allowedprotocols is also globally filterable in functions-kses.php/yourls_kses_init()
 515         }
 516
 517         if ( !yourls_is_allowed_protocol( $url, $protocols ) )
 518                 return '';
 519
 520         // I didn't use KSES function kses_bad_protocol() because it doesn't work the way I liked (returns //blah from illegal://blah)
 521
 522         return yourls_apply_filter( 'esc_url', $url, $original_url, $context );
 523 }
 524
 525
 526 /**
 527  * Lowercase scheme and domain of an URI - see issues 591, 1630, 1889
 528  *
 529  * This function is trickier than what seems to be needed at first
 530  *
 531  * First, we need to handle several URI types: http://example.com, mailto:ozh@ozh.ozh, facetime:user@example.com, and so on, see
 532  * yourls_kses_allowed_protocols() in functions-kses.php
 533  * The general rule is that the scheme ("stuff://" or "stuff:") is case insensitive and should be lowercase. But then, depending on the
 534  * scheme, parts of what follows the scheme may or may not be case sensitive.
 535  *
 536  * Second, simply using parse_url() and its opposite http_build_url() (see functions-compat.php) is a pretty unsafe process:
 537  *  - parse_url() can easily trip up on malformed or weird URLs
 538  *  - exploding a URL with parse_url(), lowercasing some stuff, and glueing things back with http_build_url() does not handle well
 539  *    "stuff:"-like URI [1] and can result in URLs ending modified [2][3]. We don't want to *validate* URI, we just want to lowercase
 540  *    what is supposed to be lowercased.
 541  *
 542  * So, to be conservative, this functions:
 543  *  - lowercases the scheme
 544  *  - does not lowercase anything else on "stuff:" URI
 545  *  - tries to lowercase only scheme and domain of "stuff://" URI
 546  *
 547  * [1] http_build_url(parse_url("mailto:ozh")) == "mailto:///ozh"
 548  * [2] http_build_url(parse_url("http://blah#omg")) == "http://blah/#omg"
 549  * [3] http_build_url(parse_url("http://blah?#")) == "http://blah/"
 550  *
 551  * @since 1.7.1
 552  * @param string $url URL
 553  * @return string URL with lowercase scheme and protocol
 554  */
 555 function yourls_lowercase_scheme_domain( $url ) {
 556     $scheme = yourls_get_protocol( $url );
 557
 558     if( false == $scheme ) {
 559         // Scheme not found, malformed URL? Something else? Not sure.
 560         return $url;
 561     }
 562
 563     // Case 1 : scheme like "stuff://" (eg "http://example.com/" or "ssh://joe@joe.com")
 564     if( substr( $scheme, -2, 2 ) == '//' ) {
 565
 566         $parts = parse_url( $url );
 567
 568         // Most likely malformed stuff, could not parse : we'll just lowercase the scheme and leave the rest untouched
 569         if( false == $parts ) {
 570             $url = str_replace( $scheme, strtolower( $scheme ), $url );
 571
 572         // URL seems parsable, let's do the best we can
 573         } else {
 574
 575             $lower = array();
 576
 577             $lower['scheme'] = strtolower( $parts['scheme'] );
 578
 579             if( isset( $parts['host'] ) ) {
 580                 $lower['host'] = strtolower( $parts['host'] );
 581             } else {
 582                 $parts['host'] = '***';
 583             }
 584
 585             // We're not going to glue back things that could be modified in the process
 586             unset( $parts['path'] );
 587             unset( $parts['query'] );
 588             unset( $parts['fragment'] );
 589
 590             // original beginning of the URL and its lowercase-where-needed counterpart
 591             // We trim the / after the domain to avoid avoid "http://example.com" being reconstructed as "http://example.com/"
 592             $partial_original_url       = trim( http_build_url( $parts ), '/' );
 593             $partial_lower_original_url = trim( http_build_url( $parts, $lower ), '/' );
 594
 595             $url = str_replace( $partial_original_url , $partial_lower_original_url, $url );
 596
 597         }
 598
 599     // Case 2 : scheme like "stuff:" (eg "mailto:joe@joe.com" or "bitcoin:15p1o8vnWqNkJBJGgwafNgR1GCCd6EGtQR?amount=1&label=Ozh")
 600     // In this case, we only lowercase the scheme, because depending on it, things after should or should not be lowercased
 601     } else {
 602
 603         $url = str_replace( $scheme, strtolower( $scheme ), $url );
 604
 605     }
 606
 607     return $url;
 608 }
 609
 610
 611 /**
 612  * Escape single quotes, htmlspecialchar " < > &, and fix line endings. Stolen from WP.
 613  *
 614  * Escapes text strings for echoing in JS. It is intended to be used for inline JS
 615  * (in a tag attribute, for example onclick="..."). Note that the strings have to
 616  * be in single quotes. The filter 'js_escape' is also applied here.
 617  *
 618  * @since 1.6
 619  *
 620  * @param string $text The text to be escaped.
 621  * @return string Escaped text.
 622  */
 623 function yourls_esc_js( $text ) {
 624         $safe_text = yourls_check_invalid_utf8( $text );
 625         $safe_text = yourls_specialchars( $safe_text, ENT_COMPAT );
 626         $safe_text = preg_replace( '/&#(x)?0*(?(1)27|39);?/i', "'", stripslashes( $safe_text ) );
 627         $safe_text = str_replace( "\r", '', $safe_text );
 628         $safe_text = str_replace( "\n", '\\n', addslashes( $safe_text ) );
 629         return yourls_apply_filter( 'esc_js', $safe_text, $text );
 630 }
 631
 632 /**
 633  * Escaping for textarea values. Stolen from WP.
 634  *
 635  * @since 1.6
 636  *
 637  * @param string $text
 638  * @return string
 639  */
 640 function yourls_esc_textarea( $text ) {
 641         $safe_text = htmlspecialchars( $text, ENT_QUOTES );
 642         return yourls_apply_filter( 'esc_textarea', $safe_text, $text );
 643 }
 644
 645
 646 /**
 647 * PHP emulation of JS's encodeURI
 648 *
 649 * @link https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/encodeURI
 650 * @param $url
 651 * @return string
 652 */
 653 function yourls_encodeURI( $url ) {
 654         // Decode URL all the way
 655         $result = yourls_rawurldecode_while_encoded( $url );
 656         // Encode once
 657         $result = strtr( rawurlencode( $result ), array (
 658         '%3B' => ';', '%2C' => ',', '%2F' => '/', '%3F' => '?', '%3A' => ':', '%40' => '@',
 659                 '%26' => '&', '%3D' => '=', '%2B' => '+', '%24' => '$', '%21' => '!', '%2A' => '*',
 660                 '%27' => '\'', '%28' => '(', '%29' => ')', '%23' => '#',
 661     ) );
 662         // @TODO:
 663         // Known limit: this will most likely break IDN URLs such as http://www.académie-française.fr/
 664         // To fully support IDN URLs, advocate use of a plugin.
 665         return yourls_apply_filter( 'encodeURI', $result, $url );
 666 }
 667
 668 /**
 669  * Adds backslashes before letters and before a number at the start of a string. Stolen from WP.
 670  *
 671  * @since 1.6
 672  *
 673  * @param string $string Value to which backslashes will be added.
 674  * @return string String with backslashes inserted.
 675  */
 676 function yourls_backslashit($string) {
 677     $string = preg_replace('/^([0-9])/', '\\\\\\\\\1', $string);
 678     $string = preg_replace('/([a-z])/i', '\\\\\1', $string);
 679     return $string;
 680 }
 681
 682 /**
 683  * Check if a string seems to be urlencoded
 684  *
 685  * We use rawurlencode instead of urlencode to avoid messing with '+'
 686  *
 687  * @since 1.7
 688  * @param string $string
 689  * @return bool
 690  */
 691 function yourls_is_rawurlencoded( $string ) {
 692         return rawurldecode( $string ) != $string;
 693 }
 694
 695 /**
 696  * rawurldecode a string till it's not encoded anymore
 697  *
 698  * Deals with multiple encoding (eg "%2521" => "%21" => "!").
 699  * See https://github.com/YOURLS/YOURLS/issues/1303
 700  *
 701  * @since 1.7
 702  * @param string $string
 703  * @return string
 704  */
 705 function yourls_rawurldecode_while_encoded( $string ) {
 706         $string = rawurldecode( $string );
 707         if( yourls_is_rawurlencoded( $string ) ) {
 708                 $string = yourls_rawurldecode_while_encoded( $string );
 709         }
 710         return $string;
 711 }
 712
 713 /**
 714  * Converts readable Javascript code into a valid bookmarklet link
 715  *
 716  * Uses https://github.com/ozh/bookmarkletgen
 717  *
 718  * @since 1.7.1
 719  * @param  string $code  Javascript code
 720  * @return string        Bookmarklet link
 721  */
 722 function yourls_make_bookmarklet( $code ) {
 723     if ( !class_exists( 'BookmarkletGen', false ) ) {
 724         require_once YOURLS_INC . '/BookmarkletGen/BookmarkletGen.php';
 725     }
 726
 727     $book = new BookmarkletGen;
 728     return $book->crunch( $code );
 729 }