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