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