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