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[ $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 "site.com/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 function yourls_sanitize_title( $unsafe_title ) {
  78         $title = $unsafe_title;
  79         $title = strip_tags( $title );
  80         $title = preg_replace( "/\s+/", ' ', trim( $title ) );
  81         return yourls_apply_filter( 'sanitize_title', $title, $unsafe_title );
  82 }
  83
  84 /**
  85  * A few sanity checks on the URL. Used for redirection or DB. For display purpose, see yourls_esc_url()
  86  *
  87  */
  88 function yourls_sanitize_url( $unsafe_url ) {
  89         $url = yourls_esc_url( $unsafe_url, 'redirection' );
  90         return yourls_apply_filter( 'sanitize_url', $url, $unsafe_url );
  91 }
  92
  93 /**
  94  * Perform a replacement while a string is found, eg $subject = '%0%0%0DDD', $search ='%0D' -> $result =''
  95  *
  96  * Stolen from WP's _deep_replace
  97  *
  98  */
  99 function yourls_deep_replace( $search, $subject ){
 100         $found = true;
 101         while($found) {
 102                 $found = false;
 103                 foreach( (array) $search as $val ) {
 104                         while( strpos( $subject, $val ) !== false ) {
 105                                 $found = true;
 106                                 $subject = str_replace( $val, '', $subject );
 107                         }
 108                 }
 109         }
 110
 111         return $subject;
 112 }
 113
 114 /**
 115  * Make sure an integer is a valid integer (PHP's intval() limits to too small numbers)
 116  *
 117  */
 118 function yourls_sanitize_int( $in ) {
 119         return ( substr( preg_replace( '/[^0-9]/', '', strval( $in ) ), 0, 20 ) );
 120 }
 121
 122 /**
 123  * Make sure a integer is safe
 124  *
 125  * Note: this is not checking for integers, since integers on 32bits system are way too limited
 126  * TODO: find a way to validate as integer
 127  *
 128  */
 129 function yourls_intval( $in ) {
 130         return yourls_escape( $in );
 131 }
 132
 133 /**
 134  * Escape a string
 135  *
 136  */
 137 function yourls_escape( $in ) {
 138         return mysql_real_escape_string( $in );
 139 }
 140
 141 /**
 142  * Sanitize an IP address
 143  *
 144  */
 145 function yourls_sanitize_ip( $ip ) {
 146         return preg_replace( '/[^0-9a-fA-F:., ]/', '', $ip );
 147 }
 148
 149 /**
 150  * Make sure a date is m(m)/d(d)/yyyy, return false otherwise
 151  *
 152  */
 153 function yourls_sanitize_date( $date ) {
 154         if( !preg_match( '!^\d{1,2}/\d{1,2}/\d{4}$!' , $date ) ) {
 155                 return false;
 156         }
 157         return $date;
 158 }
 159
 160 /**
 161  * Sanitize a date for SQL search. Return false if malformed input.
 162  *
 163  */
 164 function yourls_sanitize_date_for_sql( $date ) {
 165         if( !yourls_sanitize_date( $date ) )
 166                 return false;
 167         return date( 'Y-m-d', strtotime( $date ) );
 168 }
 169
 170 /**
 171  * Return word or words if more than one
 172  *
 173  */
 174 function yourls_plural( $word, $count=1 ) {
 175         yourls_deprecated_function( __FUNCTION__, '1.6', 'yourls_n' );
 176         return $word . ($count > 1 ? 's' : '');
 177 }
 178
 179 /**
 180  * Return trimmed string
 181  *
 182  */
 183 function yourls_trim_long_string( $string, $length = 60, $append = '[...]' ) {
 184         $newstring = $string;
 185         if( function_exists( 'mb_substr' ) ) {
 186                 if ( mb_strlen( $newstring ) > $length ) {
 187                         $newstring = mb_substr( $newstring, 0, $length - mb_strlen( $append ), 'UTF-8' ) . $append;
 188                 }
 189         } else {
 190                 if ( strlen( $newstring ) > $length ) {
 191                         $newstring = substr( $newstring, 0, $length - strlen( $append ) ) . $append;
 192                 }
 193         }
 194         return yourls_apply_filter( 'trim_long_string', $newstring, $string, $length, $append );
 195 }
 196
 197 /**
 198  * Sanitize a version number (1.4.1-whatever -> 1.4.1)
 199  *
 200  */
 201 function yourls_sanitize_version( $ver ) {
 202         return preg_replace( '/[^0-9.]/', '', $ver );
 203 }
 204
 205 /**
 206  * Sanitize a filename (no Win32 stuff)
 207  *
 208  */
 209 function yourls_sanitize_filename( $file ) {
 210         $file = str_replace( '\\', '/', $file ); // sanitize for Win32 installs
 211         $file = preg_replace( '|/+|' ,'/', $file ); // remove any duplicate slash
 212         return $file;
 213 }
 214
 215 /**
 216  * Check if a string seems to be UTF-8. Stolen from WP.
 217  *
 218  */
 219 function yourls_seems_utf8( $str ) {
 220         $length = strlen( $str );
 221         for ( $i=0; $i < $length; $i++ ) {
 222                 $c = ord( $str[ $i ] );
 223                 if ( $c < 0x80 ) $n = 0; # 0bbbbbbb
 224                 elseif (($c & 0xE0) == 0xC0) $n=1; # 110bbbbb
 225                 elseif (($c & 0xF0) == 0xE0) $n=2; # 1110bbbb
 226                 elseif (($c & 0xF8) == 0xF0) $n=3; # 11110bbb
 227                 elseif (($c & 0xFC) == 0xF8) $n=4; # 111110bb
 228                 elseif (($c & 0xFE) == 0xFC) $n=5; # 1111110b
 229                 else return false; # Does not match any model
 230                 for ($j=0; $j<$n; $j++) { # n bytes matching 10bbbbbb follow ?
 231                         if ((++$i == $length) || ((ord($str[$i]) & 0xC0) != 0x80))
 232                                 return false;
 233                 }
 234         }
 235         return true;
 236 }
 237
 238 /**
 239  * Checks for invalid UTF8 in a string. Stolen from WP
 240  *
 241  * @since 1.6
 242  *
 243  * @param string $string The text which is to be checked.
 244  * @param boolean $strip Optional. Whether to attempt to strip out invalid UTF8. Default is false.
 245  * @return string The checked text.
 246  */
 247 function yourls_check_invalid_utf8( $string, $strip = false ) {
 248         $string = (string) $string;
 249
 250         if ( 0 === strlen( $string ) ) {
 251                 return '';
 252         }
 253
 254         // Check for support for utf8 in the installed PCRE library once and store the result in a static
 255         static $utf8_pcre;
 256         if ( !isset( $utf8_pcre ) ) {
 257                 $utf8_pcre = @preg_match( '/^./u', 'a' );
 258         }
 259         // We can't demand utf8 in the PCRE installation, so just return the string in those cases
 260         if ( !$utf8_pcre ) {
 261                 return $string;
 262         }
 263
 264         // preg_match fails when it encounters invalid UTF8 in $string
 265         if ( 1 === @preg_match( '/^./us', $string ) ) {
 266                 return $string;
 267         }
 268
 269         // Attempt to strip the bad chars if requested (not recommended)
 270         if ( $strip && function_exists( 'iconv' ) ) {
 271                 return iconv( 'utf-8', 'utf-8', $string );
 272         }
 273
 274         return '';
 275 }
 276
 277 /**
 278  * Converts a number of special characters into their HTML entities. Stolen from WP.
 279  *
 280  * Specifically deals with: &, <, >, ", and '.
 281  *
 282  * $quote_style can be set to ENT_COMPAT to encode " to
 283  * &quot;, or ENT_QUOTES to do both. Default is ENT_NOQUOTES where no quotes are encoded.
 284  *
 285  * @since 1.6
 286  *
 287  * @param string $string The text which is to be encoded.
 288  * @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.
 289  * @param string $charset Optional. The character encoding of the string. Default is false.
 290  * @param boolean $double_encode Optional. Whether to encode existing html entities. Default is false.
 291  * @return string The encoded text with HTML entities.
 292  */
 293 function yourls_specialchars( $string, $quote_style = ENT_NOQUOTES, $double_encode = false ) {
 294         $string = (string) $string;
 295
 296         if ( 0 === strlen( $string ) )
 297                 return '';
 298
 299         // Don't bother if there are no specialchars - saves some processing
 300         if ( ! preg_match( '/[&<>"\']/', $string ) )
 301                 return $string;
 302
 303         // Account for the previous behaviour of the function when the $quote_style is not an accepted value
 304         if ( empty( $quote_style ) )
 305                 $quote_style = ENT_NOQUOTES;
 306         elseif ( ! in_array( $quote_style, array( 0, 2, 3, 'single', 'double' ), true ) )
 307                 $quote_style = ENT_QUOTES;
 308
 309         $charset = 'UTF-8';
 310
 311         $_quote_style = $quote_style;
 312
 313         if ( $quote_style === 'double' ) {
 314                 $quote_style = ENT_COMPAT;
 315                 $_quote_style = ENT_COMPAT;
 316         } elseif ( $quote_style === 'single' ) {
 317                 $quote_style = ENT_NOQUOTES;
 318         }
 319
 320         // Handle double encoding ourselves
 321         if ( $double_encode ) {
 322                 $string = @htmlspecialchars( $string, $quote_style, $charset );
 323         } else {
 324                 // Decode &amp; into &
 325                 $string = yourls_specialchars_decode( $string, $_quote_style );
 326
 327                 // Guarantee every &entity; is valid or re-encode the &
 328                 $string = yourls_kses_normalize_entities( $string );
 329
 330                 // Now re-encode everything except &entity;
 331                 $string = preg_split( '/(&#?x?[0-9a-z]+;)/i', $string, -1, PREG_SPLIT_DELIM_CAPTURE );
 332
 333                 for ( $i = 0; $i < count( $string ); $i += 2 )
 334                         $string[$i] = @htmlspecialchars( $string[$i], $quote_style, $charset );
 335
 336                 $string = implode( '', $string );
 337         }
 338
 339         // Backwards compatibility
 340         if ( 'single' === $_quote_style )
 341                 $string = str_replace( "'", '&#039;', $string );
 342
 343         return $string;
 344 }
 345
 346 /**
 347  * Converts a number of HTML entities into their special characters. Stolen from WP.
 348  *
 349  * Specifically deals with: &, <, >, ", and '.
 350  *
 351  * $quote_style can be set to ENT_COMPAT to decode " entities,
 352  * or ENT_QUOTES to do both " and '. Default is ENT_NOQUOTES where no quotes are decoded.
 353  *
 354  * @since 1.6
 355  *
 356  * @param string $string The text which is to be decoded.
 357  * @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.
 358  * @return string The decoded text without HTML entities.
 359  */
 360 function yourls_specialchars_decode( $string, $quote_style = ENT_NOQUOTES ) {
 361         $string = (string) $string;
 362
 363         if ( 0 === strlen( $string ) ) {
 364                 return '';
 365         }
 366
 367         // Don't bother if there are no entities - saves a lot of processing
 368         if ( strpos( $string, '&' ) === false ) {
 369                 return $string;
 370         }
 371
 372         // Match the previous behaviour of _wp_specialchars() when the $quote_style is not an accepted value
 373         if ( empty( $quote_style ) ) {
 374                 $quote_style = ENT_NOQUOTES;
 375         } elseif ( !in_array( $quote_style, array( 0, 2, 3, 'single', 'double' ), true ) ) {
 376                 $quote_style = ENT_QUOTES;
 377         }
 378
 379         // More complete than get_html_translation_table( HTML_SPECIALCHARS )
 380         $single = array( '&#039;'  => '\'', '&#x27;' => '\'' );
 381         $single_preg = array( '/&#0*39;/'  => '&#039;', '/&#x0*27;/i' => '&#x27;' );
 382         $double = array( '&quot;' => '"', '&#034;'  => '"', '&#x22;' => '"' );
 383         $double_preg = array( '/&#0*34;/'  => '&#034;', '/&#x0*22;/i' => '&#x22;' );
 384         $others = array( '&lt;'   => '<', '&#060;'  => '<', '&gt;'   => '>', '&#062;'  => '>', '&amp;'  => '&', '&#038;'  => '&', '&#x26;' => '&' );
 385         $others_preg = array( '/&#0*60;/'  => '&#060;', '/&#0*62;/'  => '&#062;', '/&#0*38;/'  => '&#038;', '/&#x0*26;/i' => '&#x26;' );
 386
 387         if ( $quote_style === ENT_QUOTES ) {
 388                 $translation = array_merge( $single, $double, $others );
 389                 $translation_preg = array_merge( $single_preg, $double_preg, $others_preg );
 390         } elseif ( $quote_style === ENT_COMPAT || $quote_style === 'double' ) {
 391                 $translation = array_merge( $double, $others );
 392                 $translation_preg = array_merge( $double_preg, $others_preg );
 393         } elseif ( $quote_style === 'single' ) {
 394                 $translation = array_merge( $single, $others );
 395                 $translation_preg = array_merge( $single_preg, $others_preg );
 396         } elseif ( $quote_style === ENT_NOQUOTES ) {
 397                 $translation = $others;
 398                 $translation_preg = $others_preg;
 399         }
 400
 401         // Remove zero padding on numeric entities
 402         $string = preg_replace( array_keys( $translation_preg ), array_values( $translation_preg ), $string );
 403
 404         // Replace characters according to translation table
 405         return strtr( $string, $translation );
 406 }
 407
 408
 409 /**
 410  * Escaping for HTML blocks. Stolen from WP
 411  *
 412  * @since 1.6
 413  *
 414  * @param string $text
 415  * @return string
 416  */
 417 function yourls_esc_html( $text ) {
 418         $safe_text = yourls_check_invalid_utf8( $text );
 419         $safe_text = yourls_specialchars( $safe_text, ENT_QUOTES );
 420         return yourls_apply_filters( 'esc_html', $safe_text, $text );
 421 }
 422
 423 /**
 424  * Escaping for HTML attributes.  Stolen from WP
 425  *
 426  * @since 1.6
 427  *
 428  * @param string $text
 429  * @return string
 430  */
 431 function yourls_esc_attr( $text ) {
 432         $safe_text = yourls_check_invalid_utf8( $text );
 433         $safe_text = yourls_specialchars( $safe_text, ENT_QUOTES );
 434         return yourls_apply_filters( 'esc_attr', $safe_text, $text );
 435 }
 436
 437 /**
 438  * Checks and cleans a URL before printing it. Stolen from WP.
 439  *
 440  * A number of characters are removed from the URL. If the URL is for displaying
 441  * (the default behaviour) ampersands are also replaced.
 442  *
 443  * @since 1.6
 444  *
 445  * @param string $url The URL to be cleaned.
 446  * @param string $context 'display' or something else. Use yourls_sanitize_url() for database or redirection usage.
 447  * @param array $protocols Optional. Array of allowed protocols, defaults to global $yourls_allowedprotocols
 448  * @return string The cleaned $url
 449  */
 450 function yourls_esc_url( $url, $context = 'display', $protocols = array() ) {
 451         // make sure there's only one 'http://' at the beginning (prevents pasting a URL right after the default 'http://')
 452         $url = str_replace(
 453                 array( 'http://http://', 'http://https://' ),
 454                 array( 'http://',        'https://'        ),
 455                 $url
 456         );
 457
 458         if ( '' == $url )
 459                 return $url;
 460
 461         // make sure there's a protocol, add http:// if not
 462         if ( ! yourls_get_protocol( $url ) )
 463                 $url = 'http://'.$url;
 464
 465         // force scheme and domain to lowercase - see issue 591
 466         preg_match( '!^([a-zA-Z]+://([^/]+))(.*)$!', $url, $matches );
 467         if( isset( $matches[1] ) && isset( $matches[3] ) )
 468                 $url = strtolower( $matches[1] ) . $matches[3];
 469
 470         $original_url = $url;
 471
 472         $url = preg_replace( '|[^a-z0-9-~+_.?#=!&;,/:%@$\|*\'()\\x80-\\xff]|i', '', $url );
 473         // Previous regexp in YOURLS was '|[^a-z0-9-~+_.?\[\]\^#=!&;,/:%@$\|*`\'<>"()\\x80-\\xff\{\}]|i'
 474         // TODO: check if that was it too destructive
 475         $strip = array( '%0d', '%0a', '%0D', '%0A' );
 476         $url = yourls_deep_replace( $strip, $url );
 477         $url = str_replace( ';//', '://', $url );
 478
 479         // Replace ampersands and single quotes only when displaying.
 480         if ( 'display' == $context ) {
 481                 $url = yourls_kses_normalize_entities( $url );
 482                 $url = str_replace( '&amp;', '&#038;', $url );
 483                 $url = str_replace( "'", '&#039;', $url );
 484         }
 485
 486         if ( ! is_array( $protocols ) or ! $protocols ) {
 487                 global $yourls_allowedprotocols;
 488                 $protocols = yourls_apply_filter( 'esc_url_protocols', $yourls_allowedprotocols );
 489                 // Note: $yourls_allowedprotocols is also globally filterable in functions-kses.php/yourls_kses_init()
 490         }
 491
 492         if ( !yourls_is_allowed_protocol( $url, $protocols ) )
 493                 return '';
 494
 495         // I didn't use KSES function kses_bad_protocol() because it doesn't work the way I liked (returns //blah from illegal://blah)
 496
 497         $url = substr( $url, 0, 1999 );
 498
 499         return yourls_apply_filter( 'esc_url', $url, $original_url, $context );
 500 }
 501
 502 /**
 503  * Escape single quotes, htmlspecialchar " < > &, and fix line endings. Stolen from WP.
 504  *
 505  * Escapes text strings for echoing in JS. It is intended to be used for inline JS
 506  * (in a tag attribute, for example onclick="..."). Note that the strings have to
 507  * be in single quotes. The filter 'js_escape' is also applied here.
 508  *
 509  * @since 1.6
 510  *
 511  * @param string $text The text to be escaped.
 512  * @return string Escaped text.
 513  */
 514 function yourls_esc_js( $text ) {
 515         $safe_text = yourls_check_invalid_utf8( $text );
 516         $safe_text = yourls_specialchars( $safe_text, ENT_COMPAT );
 517         $safe_text = preg_replace( '/&#(x)?0*(?(1)27|39);?/i', "'", stripslashes( $safe_text ) );
 518         $safe_text = str_replace( "\r", '', $safe_text );
 519         $safe_text = str_replace( "\n", '\\n', addslashes( $safe_text ) );
 520         return yourls_apply_filters( 'esc_js', $safe_text, $text );
 521 }
 522
 523 /**
 524  * Escaping for textarea values. Stolen from WP.
 525  *
 526  * @since 1.6
 527  *
 528  * @param string $text
 529  * @return string
 530  */
 531 function yourls_esc_textarea( $text ) {
 532         $safe_text = htmlspecialchars( $text, ENT_QUOTES );
 533         return yourls_apply_filters( 'esc_textarea', $safe_text, $text );
 534 }
 535
 536
 537 /**
 538 * PHP emulation of JS's encodeURI
 539 *
 540 * @link https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/encodeURI
 541 * @param $url
 542 * @return string
 543 */
 544 function yourls_encodeURI( $url ) {
 545     return strtr( rawurlencode( $url ), array (
 546         '%3B' => ';', '%2C' => ',', '%2F' => '/', '%3F' => '?', '%3A' => ':', '%40' => '@',
 547                 '%26' => '&', '%3D' => '=', '%2B' => '+', '%24' => '$', '%21' => '!', '%2A' => '*',
 548                 '%27' => '\'', '%28' => '(', '%29' => ')', '%23' => '#',
 549     ) );
 550 }
 551
 552 /**
 553  * Adds backslashes before letters and before a number at the start of a string. Stolen from WP.
 554  *
 555  * @since 1.6
 556  *
 557  * @param string $string Value to which backslashes will be added.
 558  * @return string String with backslashes inserted.
 559  */
 560 function yourls_backslashit($string) {
 561     $string = preg_replace('/^([0-9])/', '\\\\\\\\\1', $string);
 562     $string = preg_replace('/([a-z])/i', '\\\\\1', $string);
 563     return $string;
 564 }
 565