includes/functions.php

   1 <?php\r
   2 /*\r
   3  * YOURLS\r
   4  * Function library\r
   5  */\r
   6 \r
   7 if (defined('YOURLS_DEBUG') && YOURLS_DEBUG == true) {\r
   8         error_reporting(E_ALL);\r
   9 } else {\r
  10         error_reporting(E_ERROR | E_PARSE);\r
  11 }\r
  12 \r
  13 // function to convert an integer (1337) to a string (3jk). Input integer processed as a string to beat PHP's int max value\r
  14 function yourls_int2string( $id ) {\r
  15         $str = yourls_base2base(trim(strval($id)), 10, YOURLS_URL_CONVERT);\r
  16         if (YOURLS_URL_CONVERT <= 37)\r
  17                 $str = strtolower($str);\r
  18         return $str;\r
  19 }\r
  20 \r
  21 // function to convert a string (3jk) to an integer (1337)\r
  22 function yourls_string2int( $str ) {\r
  23         if (YOURLS_URL_CONVERT <= 37)\r
  24                 $str = strtolower($str);\r
  25         return yourls_base2base(trim($str), YOURLS_URL_CONVERT, 10);\r
  26 }\r
  27 \r
  28 // Make sure a link keyword (ie "1fv" as in "site.com/1fv") is valid.\r
  29 function yourls_sanitize_string($in) {\r
  30         if (YOURLS_URL_CONVERT <= 37)\r
  31                 $in = strtolower($in);\r
  32         return substr(preg_replace('/[^a-zA-Z0-9]/', '', $in), 0, 199);\r
  33 }\r
  34 \r
  35 // A few sanity checks on the URL\r
  36 function yourls_sanitize_url($url) {\r
  37         // make sure there's only one 'http://' at the beginning (prevents pasting a URL right after the default 'http://')\r
  38         $url = str_replace('http://http://', 'http://', $url);\r
  39 \r
  40         // make sure there's a protocol, add http:// if not\r
  41         if ( !preg_match('!^([a-zA-Z]+://)!', $url ) )\r
  42                 $url = 'http://'.$url;\r
  43         \r
  44         $url = yourls_clean_url($url);\r
  45         \r
  46         return substr( $url, 0, 1999 );\r
  47 }\r
  48 \r
  49 // Function to filter all invalid characters from a URL. Stolen from WP's clean_url()\r
  50 function yourls_clean_url( $url ) {\r
  51         $url = preg_replace('|[^a-z0-9-~+_.?#=!&;,/:%@$\|*\'()\\x80-\\xff]|i', '', $url);\r
  52         $strip = array('%0d', '%0a', '%0D', '%0A');\r
  53         $url = yourls_deep_replace($strip, $url);\r
  54         $url = str_replace(';//', '://', $url);\r
  55         \r
  56         return $url;\r
  57 }\r
  58 \r
  59 // Perform a replacement while a string is found, eg $subject = '%0%0%0DDD', $search ='%0D' -> $result =''\r
  60 // Stolen from WP's _deep_replace\r
  61 function yourls_deep_replace($search, $subject){\r
  62         $found = true;\r
  63         while($found) {\r
  64                 $found = false;\r
  65                 foreach( (array) $search as $val ) {\r
  66                         while(strpos($subject, $val) !== false) {\r
  67                                 $found = true;\r
  68                                 $subject = str_replace($val, '', $subject);\r
  69                         }\r
  70                 }\r
  71         }\r
  72         \r
  73         return $subject;\r
  74 }\r
  75 \r
  76 \r
  77 // Make sure an integer is a valid integer (PHP's intval() limits to too small numbers)\r
  78 // TODO FIXME FFS: unused ?\r
  79 function yourls_sanitize_int($in) {\r
  80         return ( substr(preg_replace('/[^0-9]/', '', strval($in) ), 0, 20) );\r
  81 }\r
  82 \r
  83 // Make sure a integer is safe\r
  84 // Note: this is not checking for integers, since integers on 32bits system are way too limited\r
  85 // TODO: find a way to validate as integer\r
  86 function yourls_intval($in) {\r
  87         return mysql_real_escape_string($in);\r
  88 }\r
  89 \r
  90 // Escape a string\r
  91 function yourls_escape( $in ) {\r
  92         return mysql_real_escape_string($in);\r
  93 }\r
  94 \r
  95 // Check to see if a given keyword is reserved (ie reserved URL or an existing page)\r
  96 // Returns bool\r
  97 function yourls_keyword_is_reserved( $keyword ) {\r
  98         global $yourls_reserved_URL;\r
  99         \r
 100         if ( in_array( $keyword, $yourls_reserved_URL)\r
 101                 or file_exists(dirname(dirname(__FILE__))."/pages/$keyword.php")\r
 102                 or is_dir(dirname(dirname(__FILE__))."/$keyword")\r
 103         )\r
 104                 return true;\r
 105         \r
 106         return false;\r
 107 }\r
 108 \r
 109 // Function: Get IP Address. Returns a DB safe string.\r
 110 function yourls_get_IP() {\r
 111         if(!empty($_SERVER['HTTP_CLIENT_IP'])) {\r
 112                 $ip_address = $_SERVER['HTTP_CLIENT_IP'];\r
 113         } else if(!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {\r
 114                 $ip_address = $_SERVER['HTTP_X_FORWARDED_FOR'];\r
 115         } else if(!empty($_SERVER['REMOTE_ADDR'])) {\r
 116                 $ip_address = $_SERVER['REMOTE_ADDR'];\r
 117         } else {\r
 118                 $ip_address = '';\r
 119         }\r
 120         if(strpos($ip_address, ',') !== false) {\r
 121                 $ip_address = explode(',', $ip_address);\r
 122                 $ip_address = $ip_address[0];\r
 123         }\r
 124         \r
 125         $ip_address = yourls_sanitize_ip( $ip_address );\r
 126 \r
 127         return $ip_address;\r
 128 }\r
 129 \r
 130 // Sanitize an IP address\r
 131 function yourls_sanitize_ip( $ip ) {\r
 132         return preg_replace( '/[^0-9a-fA-F:., ]/', '', $ip );\r
 133 }\r
 134 \r
 135 // Add the "Edit" row\r
 136 function yourls_table_edit_row( $keyword ) {\r
 137         global $ydb;\r
 138         \r
 139         $table = YOURLS_DB_TABLE_URL;\r
 140         $keyword = yourls_sanitize_string( $keyword );\r
 141         $id = yourls_string2int( $keyword ); // used as HTML #id\r
 142         $url = $ydb->get_row("SELECT `url` FROM `$table` WHERE `keyword` = '$keyword';");\r
 143         $safe_url = stripslashes( $url->url );\r
 144         $www = YOURLS_SITE;\r
 145         \r
 146         if( $url ) {\r
 147                 $return = <<<RETURN\r
 148 <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" /></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
 149 RETURN;\r
 150         } else {\r
 151                 $return = '<tr><td colspan="6">Error, URL not found</td></tr>';\r
 152         }\r
 153         \r
 154         return $return;\r
 155 }\r
 156 \r
 157 // Add a link row\r
 158 function yourls_table_add_row( $keyword, $url, $ip, $clicks, $timestamp ) {\r
 159         $keyword = yourls_sanitize_string( $keyword );\r
 160         $id = yourls_string2int( $keyword ); // used as HTML #id\r
 161         $date = date( 'M d, Y H:i', $timestamp+( YOURLS_HOURS_OFFSET * 3600) );\r
 162         $clicks = number_format($clicks);\r
 163         $www = YOURLS_SITE;\r
 164         $shorturl = YOURLS_SITE.'/'.$keyword;\r
 165         $display_url = yourls_trim_long_string( $url );\r
 166         $statlink = $shorturl.'+';\r
 167         \r
 168         return <<<ROW\r
 169 <tr id="id-$id"><td id="keyword-$id"><a href="$shorturl">$keyword</a></td><td id="url-$id"><a href="$url" title="$url">$display_url</a></td><td id="timestamp-$id">$date</td><td id="ip-$id">$ip</td><td id="clicks-$id">$clicks</td><td class="actions" id="actions-$id"><a href="$statlink" class="button button_stats">&nbsp;&nbsp;&nbsp;</a>&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');" /><input type="hidden" id="keyword_$id" value="$keyword"/></td></tr>\r
 170 ROW;\r
 171 }\r
 172 \r
 173 // Get next id a new link will have if no custom keyword provided\r
 174 function yourls_get_next_decimal() {\r
 175         return (int)yourls_get_option( 'next_id' );\r
 176 }\r
 177 \r
 178 // Update id for next link with no custom keyword\r
 179 function yourls_update_next_decimal( $int = '' ) {\r
 180         $int = ( $int == '' ) ? yourls_get_next_decimal() + 1 : (int)$int ;\r
 181         return yourls_update_option( 'next_id', $int );\r
 182 }\r
 183 \r
 184 // Delete a link in the DB\r
 185 function yourls_delete_link_by_keyword( $keyword ) {\r
 186         global $ydb;\r
 187 \r
 188         $table = YOURLS_DB_TABLE_URL;\r
 189         $keyword = yourls_sanitize_string( $keyword );\r
 190         return $ydb->query("DELETE FROM `$table` WHERE `keyword` = '$keyword';");\r
 191 }\r
 192 \r
 193 // SQL query to insert a new link in the DB. Needs sanitized data. Returns boolean for success or failure of the inserting\r
 194 function yourls_insert_link_in_db($url, $keyword) {\r
 195         global $ydb;\r
 196 \r
 197         $table = YOURLS_DB_TABLE_URL;\r
 198         $timestamp = date('Y-m-d H:i:s');\r
 199         $ip = yourls_get_IP();\r
 200         $insert = $ydb->query("INSERT INTO `$table` VALUES('$keyword', '$url', '$timestamp', '$ip', 0);");\r
 201         \r
 202         return (bool)$insert;\r
 203 }\r
 204 \r
 205 // Add a new link in the DB, either with custom keyword, or find one\r
 206 function yourls_add_new_link( $url, $keyword = '' ) {\r
 207         global $ydb;\r
 208 \r
 209         if ( !$url || $url == 'http://' || $url == 'https://' ) {\r
 210                 $return['status'] = 'fail';\r
 211                 $return['code'] = 'error:nourl';\r
 212                 $return['message'] = 'Missing URL input';\r
 213                 return $return;\r
 214         }\r
 215 \r
 216         // Prevent DB flood\r
 217         $ip = yourls_get_IP();\r
 218         yourls_check_IP_flood( $ip );\r
 219 \r
 220         $table = YOURLS_DB_TABLE_URL;\r
 221         $url = mysql_real_escape_string( yourls_sanitize_url($url) );\r
 222         $strip_url = stripslashes($url);\r
 223         $url_exists = $ydb->get_row("SELECT keyword,url FROM `$table` WHERE `url` = '".$strip_url."';");\r
 224         $return = array();\r
 225 \r
 226         // New URL : store it -- or: URL exists, but duplicates allowed\r
 227         if( !$url_exists || yourls_allow_duplicate_longurls() ) {\r
 228 \r
 229                 // Custom keyword provided\r
 230                 if ( $keyword ) {\r
 231                         $keyword = mysql_real_escape_string(yourls_sanitize_string($keyword));\r
 232                         if ( !yourls_keyword_is_free($keyword) ) {\r
 233                                 // This shorturl either reserved or taken already\r
 234                                 $return['status'] = 'fail';\r
 235                                 $return['code'] = 'error:keyword';\r
 236                                 $return['message'] = 'Short URL '.$keyword.' already exists in database or is reserved';\r
 237                         } else {\r
 238                                 // all clear, store !\r
 239                                 yourls_insert_link_in_db($url, $keyword);\r
 240                                 $return['url'] = array('keyword' => $keyword, 'url' => $strip_url, 'date' => date('Y-m-d H:i:s'), 'ip' => $ip );\r
 241                                 $return['status'] = 'success';\r
 242                                 $return['message'] = $strip_url.' added to database';\r
 243                                 $return['html'] = yourls_table_add_row( $keyword, $url, $ip, 0, time() );\r
 244                                 $return['shorturl'] = YOURLS_SITE .'/'. $keyword;\r
 245                         }\r
 246 \r
 247                 // Create random keyword        \r
 248                 } else {\r
 249                         $timestamp = date('Y-m-d H:i:s');\r
 250                         $id = yourls_get_next_decimal();\r
 251                         $ok = false;\r
 252                         do {\r
 253                                 $keyword = yourls_int2string( $id );\r
 254                                 $free = yourls_keyword_is_free($keyword);\r
 255                                 $add_url = @yourls_insert_link_in_db($url, $keyword);\r
 256                                 $ok = ($free && $add_url);\r
 257                                 if ( $ok === false && $add_url === 1 ) {\r
 258                                         // we stored something, but shouldn't have (ie reserved id)\r
 259                                         $delete = yourls_delete_link_by_keyword( $keyword );\r
 260                                         $return['extra_info'] .= '(deleted '.$keyword.')';\r
 261                                 } else {\r
 262                                         // everything ok, populate needed vars\r
 263                                         $return['url'] = array('keyword' => $keyword, 'url' => $strip_url, 'date' => $timestamp, 'ip' => $ip );\r
 264                                         $return['status'] = 'success';\r
 265                                         $return['message'] = $strip_url.' added to database';\r
 266                                         $return['html'] = yourls_table_add_row( $keyword, $url, $ip, 0, time() );\r
 267                                         $return['shorturl'] = YOURLS_SITE .'/'. $keyword;\r
 268                                 }\r
 269                                 $id++;\r
 270                         } while (!$ok);\r
 271                         @yourls_update_next_decimal($id);\r
 272                 }\r
 273         } else {\r
 274                 // URL was already stored\r
 275                 $return['status'] = 'fail';\r
 276                 $return['code'] = 'error:url';\r
 277                 $return['message'] = $strip_url.' already exists in database';\r
 278                 $return['shorturl'] = YOURLS_SITE .'/'. $url_exists->keyword;\r
 279         }\r
 280 \r
 281         return $return;\r
 282 }\r
 283 \r
 284 \r
 285 // Edit a link\r
 286 function yourls_edit_link($url, $keyword, $newkeyword='') {\r
 287         global $ydb;\r
 288 \r
 289         $table = YOURLS_DB_TABLE_URL;\r
 290         $url = mysql_real_escape_string(yourls_sanitize_url($url));\r
 291         $keyword = yourls_sanitize_string( $keyword );\r
 292         $newkeyword = yourls_sanitize_string( $newkeyword );\r
 293         $strip_url = stripslashes($url);\r
 294         $old_url = $ydb->get_var("SELECT `url` FROM `$table` WHERE `keyword` = '$keyword';");\r
 295         \r
 296         // Check if new URL is not here already\r
 297         if ($old_url != $url) {\r
 298                 $new_url_already_there = intval($ydb->get_var("SELECT COUNT(keyword) FROM `$table` WHERE `url` = '$strip_url';"));\r
 299         } else {\r
 300                 $new_url_already_there = false;\r
 301         }\r
 302         \r
 303         // Check if the new keyword is not here already\r
 304         if ( $newkeyword != $keyword ) {\r
 305                 $keyword_is_ok = yourls_keyword_is_free( $newkeyword );\r
 306         } else {\r
 307                 $keyword_is_ok = true;\r
 308         }\r
 309         \r
 310         // All clear, update\r
 311         if ( !$new_url_already_there && $keyword_is_ok ) {\r
 312                 $timestamp4screen = date( 'Y M d H:i', time()+( YOURLS_HOURS_OFFSET * 3600) );\r
 313                 $timestamp4db = date('Y-m-d H:i:s', time()+( YOURLS_HOURS_OFFSET * 3600) );\r
 314                 $update_url = $ydb->query("UPDATE `$table` SET `url` = '$url', `timestamp` = '$timestamp4db', `keyword` = '$newkeyword' WHERE `keyword` = '$keyword';");\r
 315                 if( $update_url ) {\r
 316                         $return['url'] = array( 'keyword' => $newkeyword, 'shorturl' => YOURLS_SITE.'/'.$newkeyword, 'url' => $strip_url, 'date' => $timestamp4screen);\r
 317                         $return['status'] = 'success';\r
 318                         $return['message'] = 'Link updated in database';\r
 319                 } else {\r
 320                         $return['status'] = 'fail';\r
 321                         $return['message'] = 'Error updating '.$strip_url.' (Short URL: '.$keyword.') to database';\r
 322                 }\r
 323         \r
 324         // Nope\r
 325         } else {\r
 326                 $return['status'] = 'fail';\r
 327                 $return['message'] = 'URL or keyword already exists in database';\r
 328         }\r
 329         \r
 330         return $return;\r
 331 }\r
 332 \r
 333 \r
 334 // Check if keyword id is free (ie not already taken, and not reserved)\r
 335 function yourls_keyword_is_free( $keyword ) {\r
 336         global $ydb;\r
 337 \r
 338         $table = YOURLS_DB_TABLE_URL;\r
 339         if ( yourls_keyword_is_reserved($keyword) )\r
 340                 return false;\r
 341                 \r
 342         $already_exists = $ydb->get_var("SELECT COUNT(`keyword`) FROM `$table` WHERE `keyword` = '$keyword';");\r
 343         if ( $already_exists )\r
 344                 return false;\r
 345 \r
 346         return true;\r
 347 }\r
 348 \r
 349 \r
 350 // Display a page\r
 351 function yourls_page( $page ) {\r
 352         $include = dirname(dirname(__FILE__))."/pages/$page.php";\r
 353         if (!file_exists($include)) {\r
 354                 yourls_die("Page '$page' not found", 'Not found', 404);\r
 355         }\r
 356         include($include);\r
 357         die();  \r
 358 }\r
 359 \r
 360 // Connect to DB\r
 361 function yourls_db_connect() {\r
 362         global $ydb;\r
 363 \r
 364         if (!defined('YOURLS_DB_USER')\r
 365                 or !defined('YOURLS_DB_PASS')\r
 366                 or !defined('YOURLS_DB_NAME')\r
 367                 or !defined('YOURLS_DB_HOST')\r
 368                 or !class_exists('ezSQL_mysql')\r
 369         ) yourls_die ('DB config missigin, or could not find DB class', 'Fatal error', 503);\r
 370         \r
 371         $ydb =  new ezSQL_mysql(YOURLS_DB_USER, YOURLS_DB_PASS, YOURLS_DB_NAME, YOURLS_DB_HOST);\r
 372         if ( $ydb->last_error )\r
 373                 yourls_die( $ydb->last_error, 'Fatal error', 503 );\r
 374         \r
 375         if ( defined('YOURLS_DEBUG') && YOURLS_DEBUG === true )\r
 376                 $ydb->show_errors = true;\r
 377         \r
 378         // return $ydb;\r
 379 }\r
 380 \r
 381 // Return JSON output. Compatible with PHP prior to 5.2\r
 382 function yourls_json_encode($array) {\r
 383         if (function_exists('json_encode')) {\r
 384                 return json_encode($array);\r
 385         } else {\r
 386                 require_once(dirname(__FILE__).'/functions-json.php');\r
 387                 return yourls_array_to_json($array);\r
 388         }\r
 389 }\r
 390 \r
 391 // Return XML output.\r
 392 function yourls_xml_encode($array) {\r
 393         require_once(dirname(__FILE__).'/functions-xml.php');\r
 394         $converter= new yourls_array2xml;\r
 395         return $converter->array2xml($array);\r
 396 }\r
 397 \r
 398 // 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
 399 function yourls_get_keyword_infos( $keyword, $use_cache = true ) {\r
 400         global $ydb;\r
 401         $keyword = yourls_sanitize_string( $keyword );\r
 402 \r
 403         if( isset( $ydb->infos[$keyword] ) && $use_cache == true ) {\r
 404                 return $ydb->infos[$keyword];\r
 405         }\r
 406         \r
 407         $table = YOURLS_DB_TABLE_URL;\r
 408         $infos = $ydb->get_row("SELECT * FROM `$table` WHERE `keyword` = '$keyword'");\r
 409         \r
 410         if( $infos ) {\r
 411                 $infos = (array)$infos;\r
 412                 $ydb->infos[$keyword] = $infos;\r
 413         } else {\r
 414                 $ydb->infos[$keyword] = false;\r
 415         }\r
 416                 \r
 417         return $ydb->infos[$keyword];\r
 418 }\r
 419 \r
 420 // Return (string) selected information associated with a keyword. Optional $notfound = string default message if nothing found\r
 421 function yourls_get_keyword_info( $keyword, $field, $notfound = false ) {\r
 422         global $ydb;\r
 423         \r
 424         $keyword = yourls_sanitize_string( $keyword );\r
 425         $infos = yourls_get_keyword_infos( $keyword );\r
 426         \r
 427         if ( isset($infos[$field]) && $infos[$field] !== false )\r
 428                 return $infos[$field];\r
 429 \r
 430         return $notfound;       \r
 431 }\r
 432 \r
 433 // Return long URL associated with keyword. Optional $notfound = string default message if nothing found\r
 434 function yourls_get_keyword_longurl( $keyword, $notfound = false ) {\r
 435         return yourls_get_keyword_info( $keyword, 'url', $notfound );\r
 436 }\r
 437 \r
 438 // Return number of clicks on a keyword. Optional $notfound = string default message if nothing found\r
 439 function yourls_get_keyword_clicks( $keyword, $notfound = false ) {\r
 440         return yourls_get_keyword_info( $keyword, 'clicks', $notfound );\r
 441 }\r
 442 \r
 443 // Return IP that added a keyword. Optional $notfound = string default message if nothing found\r
 444 function yourls_get_keyword_IP( $keyword, $notfound = false ) {\r
 445         return yourls_get_keyword_info( $keyword, 'ip', $notfound );\r
 446 }\r
 447 \r
 448 // Return timestamp associated with a keyword. Optional $notfound = string default message if nothing found\r
 449 function yourls_get_keyword_timestamp( $keyword, $notfound = false ) {\r
 450         return yourls_get_keyword_info( $keyword, 'timestamp', $notfound );\r
 451 }\r
 452 \r
 453 // Update click count on a short URL\r
 454 function yourls_update_clicks( $keyword ) {\r
 455         global $ydb;\r
 456         $keyword = yourls_sanitize_string( $keyword );\r
 457         $table = YOURLS_DB_TABLE_URL;\r
 458         return $ydb->query("UPDATE `$table` SET `clicks` = clicks + 1 WHERE `keyword` = '$keyword'");\r
 459 }\r
 460 \r
 461 // Return array of stats. (string)$filter is 'bottom', 'last', 'rand' or 'top'. (int)$limit is the number of links to return\r
 462 function yourls_get_links_stats( $filter = 'top', $limit = 10 ) {\r
 463         global $ydb;\r
 464 \r
 465         switch( $filter ) {\r
 466                 case 'bottom':\r
 467                         $sort_by = 'clicks';\r
 468                         $sort_order = 'asc';\r
 469                         break;\r
 470                 case 'last':\r
 471                         $sort_by = 'timestamp';\r
 472                         $sort_order = 'desc';\r
 473                         break;\r
 474                 case 'rand':\r
 475                 case 'random':\r
 476                         $sort_by = 'RAND()';\r
 477                         $sort_order = '';\r
 478                         break;\r
 479                 case 'top':\r
 480                 default:\r
 481                         $sort_by = 'clicks';\r
 482                         $sort_order = 'desc';\r
 483                         break;\r
 484         }\r
 485         \r
 486         $limit = intval( $limit );\r
 487         if ( $limit == 0 )\r
 488                 $limit = 1;\r
 489         $table_url = YOURLS_DB_TABLE_URL;\r
 490         $results = $ydb->get_results("SELECT * FROM `$table_url` WHERE 1=1 ORDER BY `$sort_by` $sort_order LIMIT 0, $limit;");\r
 491         \r
 492         $return = array();\r
 493         $i = 1;\r
 494         \r
 495         foreach ($results as $res) {\r
 496                 $return['links']['link_'.$i++] = array(\r
 497                         'shorturl' => YOURLS_SITE .'/'. $res->keyword,\r
 498                         'url' => $res->url,\r
 499                         'timestamp' => $res->timestamp,\r
 500                         'ip' => $res->ip,\r
 501                         'clicks' => $res->clicks\r
 502                 );\r
 503         }\r
 504 \r
 505         $return['stats'] = yourls_get_db_stats();\r
 506 \r
 507         return $return;\r
 508 }\r
 509 \r
 510 \r
 511 // Return array for API stat requests\r
 512 function yourls_api_stats( $filter = 'top', $limit = 10 ) {\r
 513         $return = yourls_get_links_stats( $filter, $limit );\r
 514         $return['simple'] = 'Need either XML or JSON format for stats';\r
 515         return $return;\r
 516 }\r
 517 \r
 518 // Expand short url to long url\r
 519 function yourls_api_expand( $shorturl ) {\r
 520         $keyword = str_replace( YOURLS_SITE . '/' , '', $shorturl ); // accept either 'http://ozh.in/abc' or 'abc'\r
 521         $keyword = yourls_sanitize_string( $keyword );\r
 522         \r
 523         $longurl = yourls_get_keyword_longurl( $keyword );\r
 524         \r
 525         return array(\r
 526                 'keyword' => $keyword,\r
 527                 'shorturl' => YOURLS_SITE . "/$keyword",\r
 528                 'longurl' => $longurl,\r
 529                 'simple' => $longurl,\r
 530         );\r
 531 }\r
 532 \r
 533 \r
 534 // Get total number of URLs and sum of clicks. Input: optional "AND WHERE" clause. Returns array\r
 535 function yourls_get_db_stats( $where = '' ) {\r
 536         global $ydb;\r
 537         $table_url = YOURLS_DB_TABLE_URL;\r
 538 \r
 539         $totals = $ydb->get_row("SELECT COUNT(keyword) as count, SUM(clicks) as sum FROM `$table_url` WHERE 1=1 $where");\r
 540         return array( 'total_links' => $totals->count, 'total_clicks' => $totals->sum );\r
 541 }\r
 542 \r
 543 // Return API result. Dies after this\r
 544 function yourls_api_output( $mode, $return ) {\r
 545         $simple = $return['simple'];\r
 546         unset( $return['simple'] );\r
 547         switch ( $mode ) {\r
 548                 case 'json':\r
 549                         header('Content-type: application/json');\r
 550                         echo yourls_json_encode($return);\r
 551                         break;\r
 552                 \r
 553                 case 'xml':\r
 554                         header('Content-type: application/xml');\r
 555                         echo yourls_xml_encode($return);\r
 556                         break;\r
 557                         \r
 558                 case 'simple':\r
 559                 default:\r
 560                         echo $simple;\r
 561                         break;\r
 562         }\r
 563         die();\r
 564 }\r
 565 \r
 566 // Display HTML head and <body> tag\r
 567 function yourls_html_head( $context = 'index' ) {\r
 568         // All components to false, except when specified true\r
 569         $share = $insert = $tablesorter = $tabs = false;\r
 570         // Load components as needed\r
 571         switch ( $context ) {\r
 572                 case 'infos':\r
 573                         $share = $tabs = true;\r
 574                         break;\r
 575                         \r
 576                 case 'bookmark':\r
 577                         $share = $insert = $tablesorter = true;\r
 578                         break;\r
 579                         \r
 580                 case 'index':\r
 581                         $insert = $tablesorter = true;\r
 582                         break;\r
 583                 \r
 584                 case 'install':\r
 585                 case 'login':\r
 586                 case 'new':\r
 587                 case 'tools':\r
 588                 case 'upgrade':\r
 589                         break;\r
 590         }\r
 591         \r
 592         ?>\r
 593 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
 594 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
 595 <head>\r
 596         <title>YOURLS &raquo; Your Own URL Shortener | <?php echo YOURLS_SITE; ?></title>\r
 597         <link rel="icon" type="image/gif" href="<?php echo YOURLS_SITE; ?>/images/favicon.gif" />\r
 598         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />\r
 599         <meta name="copyright" content="Copyright &copy; 2008-<?php echo date('Y'); ?> YOURS" />\r
 600         <meta name="author" content="Ozh Richard, Lester Chan" />\r
 601         <meta name="description" content="Insert URL &laquo; YOURLS &raquo; Your Own URL Shortener' | <?php echo YOURLS_SITE; ?>" />\r
 602         <script src="<?php echo YOURLS_SITE; ?>/js/jquery-1.3.2.min.js" type="text/javascript"></script>\r
 603         <link rel="stylesheet" href="<?php echo YOURLS_SITE; ?>/css/style.css" type="text/css" media="screen" />\r
 604         <?php if ($tabs) { ?>\r
 605                 <link rel="stylesheet" href="<?php echo YOURLS_SITE; ?>/css/infos.css" type="text/css" media="screen" />\r
 606                 <script src="<?php echo YOURLS_SITE; ?>/js/infos.js" type="text/javascript"></script>\r
 607         <?php } ?>\r
 608         <?php if ($tablesorter) { ?>\r
 609                 <link rel="stylesheet" href="<?php echo YOURLS_SITE; ?>/css/tablesorter.css" type="text/css" media="screen" />\r
 610                 <script src="<?php echo YOURLS_SITE; ?>/js/jquery.tablesorter.min.js" type="text/javascript"></script>\r
 611         <?php } ?>\r
 612         <?php if ($insert) { ?>\r
 613                 <script src="<?php echo YOURLS_SITE; ?>/js/insert.js" type="text/javascript"></script>\r
 614         <?php } ?>\r
 615         <?php if ($share) { ?>\r
 616                 <link rel="stylesheet" href="<?php echo YOURLS_SITE; ?>/css/share.css" type="text/css" media="screen" />\r
 617                 <script src="<?php echo YOURLS_SITE; ?>/js/share.js" type="text/javascript"></script>\r
 618         <?php } ?>\r
 619 </head>\r
 620 <body class="<?php echo $context; ?>">\r
 621 <div id="wrap">\r
 622         <?php\r
 623 }\r
 624 \r
 625 // Display HTML footer (including closing body & html tags)\r
 626 function yourls_html_footer() {\r
 627         global $ydb;\r
 628         \r
 629         $num_queries = $ydb->num_queries > 1 ? $ydb->num_queries.' queries' : $ydb->num_queries.' query';\r
 630         ?>\r
 631         </div> <?php // wrap ?>\r
 632         <div id="footer"><p>Powered by <a href="http://yourls.org/" title="YOURLS">YOURLS</a> v<?php echo YOURLS_VERSION; echo ' &ndash; '.$num_queries; ?></p></div>\r
 633         <?php if( defined('YOURLS_DEBUG') && YOURLS_DEBUG == true ) {\r
 634                 echo '<p>'. $ydb->all_queries .'<p>';\r
 635         } ?>\r
 636         </body>\r
 637         </html>\r
 638         <?php\r
 639 }\r
 640 \r
 641 // Display "Add new URL" box\r
 642 function yourls_html_addnew( $url = '', $keyword = '' ) {\r
 643         $url = $url ? $url : 'http://';\r
 644         ?>\r
 645         <div id="new_url">\r
 646                 <div>\r
 647                         <form id="new_url_form" action="" method="get">\r
 648                                 <div><strong>Enter the URL</strong>:<input type="text" id="add-url" name="url" value="<?php echo $url; ?>" class="text" size="80" />\r
 649                                 Optional: <strong>Custom short URL</strong>:<input type="text" id="add-keyword" name="keyword" value="<?php echo $keyword; ?>" maxlength="12" class="text" size="8" />\r
 650                                 <input type="button" id="add-button" name="add-button" value="Shorten The URL" class="button" onclick="add();" /></div>\r
 651                         </form>\r
 652                         <div id="feedback" style="display:none"></div>\r
 653                 </div>\r
 654         </div>\r
 655         <?php\r
 656 }\r
 657 \r
 658 // Display main table's footer\r
 659 function yourls_html_tfooter( $params = array() ) {\r
 660         extract( $params ); // extract $search_text, $page, $search_in_sql ...\r
 661 \r
 662         ?>\r
 663         <tfoot>\r
 664                 <tr>\r
 665                         <th colspan="4" style="text-align: left;">\r
 666                                 <form action="" method="get">\r
 667                                         <div>\r
 668                                                 <div style="float:right;">\r
 669                                                         <input type="submit" id="submit-sort" value="Filter" class="button primary" />\r
 670                                                         &nbsp;\r
 671                                                         <input type="button" id="submit-clear-filter" value="Clear Filter" class="button" onclick="window.parent.location.href = 'index.php'" />\r
 672                                                 </div>\r
 673 \r
 674                                                 Search&nbsp;for&nbsp;\r
 675                                                 <input type="text" name="s_search" class="text" size="20" value="<?php echo $search_text; ?>" />\r
 676                                                 &nbsp;in&nbsp;\r
 677                                                 <select name="s_in" size="1">\r
 678                                                         <!-- <option value="id"<?php if($search_in_sql == 'id') { echo ' selected="selected"'; } ?>>ID</option> -->\r
 679                                                         <option value="url"<?php if($search_in_sql == 'url') { echo ' selected="selected"'; } ?>>URL</option>\r
 680                                                         <option value="ip"<?php if($search_in_sql == 'ip') { echo ' selected="selected"'; } ?>>IP</option>\r
 681                                                 </select>\r
 682                                                 &ndash;&nbsp;Order&nbsp;by&nbsp;\r
 683                                                 <select name="s_by" size="1">\r
 684                                                         <option value="id"<?php if($sort_by_sql == 'id') { echo ' selected="selected"'; } ?>>ID</option>\r
 685                                                         <option value="url"<?php if($sort_by_sql == 'url') { echo ' selected="selected"'; } ?>>URL</option>\r
 686                                                         <option value="timestamp"<?php if($sort_by_sql == 'timestamp') { echo ' selected="selected"'; } ?>>Date</option>\r
 687                                                         <option value="ip"<?php if($sort_by_sql == 'ip') { echo ' selected="selected"'; } ?>>IP</option>\r
 688                                                         <option value="clicks"<?php if($sort_by_sql == 'clicks') { echo ' selected="selected"'; } ?>>Clicks</option>\r
 689                                                 </select>\r
 690                                                 <select name="s_order" size="1">\r
 691                                                         <option value="asc"<?php if($sort_order_sql == 'asc') { echo ' selected="selected"'; } ?>>Ascending</option>\r
 692                                                         <option value="desc"<?php if($sort_order_sql == 'desc') { echo ' selected="selected"'; } ?>>Descending</option>\r
 693                                                 </select>\r
 694                                                 &ndash;&nbsp;Show&nbsp;\r
 695                                                 <input type="text" name="perpage" class="text" size="2" value="<?php echo $perpage; ?>" />&nbsp;rows<br/>\r
 696                                                 \r
 697                                                 Show links with\r
 698                                                 <select name="link_filter" size="1">\r
 699                                                         <option value="more"<?php if($link_filter === 'more') { echo ' selected="selected"'; } ?>>more</option>\r
 700                                                         <option value="less"<?php if($link_filter === 'less') { echo ' selected="selected"'; } ?>>less</option>\r
 701                                                 </select>\r
 702                                                 than\r
 703                                                 <input type="text" name="link_limit" class="text" size="4" value="<?php echo $link_limit; ?>" />clicks\r
 704 \r
 705                                                 \r
 706                                         </div>\r
 707                                 </form>\r
 708                         </th>\r
 709                         <th colspan="3" style="text-align: right;">\r
 710                                 Pages (<?php echo $total_pages; ?>):\r
 711                                 <?php\r
 712                                         if ($page >= 4) {\r
 713                                                 echo '<b><a href="'.$base_page.'?s_by='.$sort_by_sql.'&amp;s_order='.$sort_order_sql.$search_url.'&amp;perpage='.$perpage.'&amp;page=1'.'" title="Go to First Page">&laquo; First</a></b> ... ';\r
 714                                         }\r
 715                                         if($page > 1) {\r
 716                                                 echo ' <b><a href="'.$base_page.'?s_by='.$sort_by_sql.'&amp;s_order='.$sort_order_sql.$search_url.'&amp;perpage='.$perpage.'&amp;page='.($page-1).'" title="&laquo; Go to Page '.($page-1).'">&laquo;</a></b> ';\r
 717                                         }\r
 718                                         for($i = $page - 2 ; $i  <= $page +2; $i++) {\r
 719                                                 if ($i >= 1 && $i <= $total_pages) {\r
 720                                                         if($i == $page) {\r
 721                                                                 echo "<strong>[$i]</strong> ";\r
 722                                                         } else {\r
 723                                                                 echo '<a href="'.$base_page.'?s_by='.$sort_by_sql.'&amp;s_order='.$sort_order_sql.$search_url.'&amp;perpage='.$perpage.'&amp;page='.($i).'" title="Page '.$i.'">'.$i.'</a> ';\r
 724                                                         }\r
 725                                                 }\r
 726                                         }\r
 727                                         if($page < $total_pages) {\r
 728                                                 echo ' <b><a href="'.$base_page.'?s_by='.$sort_by_sql.'&amp;s_order='.$sort_order_sql.$search_url.'&amp;perpage='.$perpage.'&amp;page='.($page+1).'" title="Go to Page '.($page+1).' &raquo;">&raquo;</a></b> ';\r
 729                                         }\r
 730                                         if (($page+2) < $total_pages) {\r
 731                                                 echo ' ... <b><a href="'.$base_page.'?s_by='.$sort_by_sql.'&amp;s_order='.$sort_order_sql.$search_url.'&amp;perpage='.$perpage.'&amp;page='.($total_pages).'" title="Go to Last Page">Last &raquo;</a></b>';\r
 732                                         }\r
 733                                 ?>\r
 734                         </th>\r
 735                 </tr>\r
 736         </tfoot>\r
 737         <?php\r
 738 }\r
 739 \r
 740 // Display the Quick Share box of the tools.php page\r
 741 function yourls_share_box( $longurl, $shorturl, $title='', $text='', $shortlink_title = '<h2>Your short link</h2>', $share_title = '<h2>Quick Share</h2>' ) {\r
 742         $text = ( $text ? '"'.$text.'" ' : '' );\r
 743         $title = ( $title ? "$title " : '' );\r
 744         $share = htmlspecialchars_decode( $title.$text.$shorturl );\r
 745         $_share = rawurlencode( $share );\r
 746         $_url = rawurlencode( $shorturl );\r
 747         $count = 140 - strlen( $share );\r
 748         ?>\r
 749         \r
 750         <div id="shareboxes">\r
 751 \r
 752                 <div id="copybox" class="share">\r
 753                 <?php echo $shortlink_title; ?>\r
 754                         <p><input id="copylink" class="text" size="40" value="<?php echo $shorturl; ?>" /></p>\r
 755                         <p><small>Original link: <a href="<?php echo $longurl; ?>"><?php echo $longurl; ?></a></small></p>\r
 756                 </div>\r
 757 \r
 758                 <div id="sharebox" class="share">\r
 759                         <?php echo $share_title; ?>\r
 760                         <div id="tweet">\r
 761                                 <span id="charcount"><?php echo $count; ?></span>\r
 762                                 <textarea id="tweet_body"><?php echo $share; ?></textarea>\r
 763                         </div>\r
 764                         <p id="share_links">Share with \r
 765                                 <a id="share_tw" href="http://twitter.com/home?status=<?php echo $_share; ?>" title="Tweet this!" onclick="share('tw');return false">Twitter</a>\r
 766                                 <a id="share_fb" href="http://www.facebook.com/share.php?u=<?php echo $_url; ?>" title="Share on Facebook" onclick="share('fb');return false;">Facebook</a>\r
 767                                 <a id="share_ff" href="http://friendfeed.com/share/bookmarklet/frame#title=<?php echo $_share; ?>" title="Share on Friendfeed" onclick="javascript:share('ff');return false;">FriendFeed</a>\r
 768                         </p>\r
 769                         </div>\r
 770                 </div>\r
 771         \r
 772         </div>\r
 773         \r
 774         <?php\r
 775 }\r
 776 \r
 777 // Get number of SQL queries performed\r
 778 function yourls_get_num_queries() {\r
 779         global $ydb;\r
 780 \r
 781         return $ydb->num_queries;\r
 782 }\r
 783 \r
 784 // Compat http_build_query for PHP4\r
 785 if (!function_exists('http_build_query')) {\r
 786         function http_build_query($data, $prefix=null, $sep=null) {\r
 787                 return yourls_http_build_query($data, $prefix, $sep);\r
 788         }\r
 789 }\r
 790 \r
 791 // from php.net (modified by Mark Jaquith to behave like the native PHP5 function)\r
 792 function yourls_http_build_query($data, $prefix=null, $sep=null, $key='', $urlencode=true) {\r
 793         $ret = array();\r
 794 \r
 795         foreach ( (array) $data as $k => $v ) {\r
 796                 if ( $urlencode)\r
 797                         $k = urlencode($k);\r
 798                 if ( is_int($k) && $prefix != null )\r
 799                         $k = $prefix.$k;\r
 800                 if ( !empty($key) )\r
 801                         $k = $key . '%5B' . $k . '%5D';\r
 802                 if ( $v === NULL )\r
 803                         continue;\r
 804                 elseif ( $v === FALSE )\r
 805                         $v = '0';\r
 806 \r
 807                 if ( is_array($v) || is_object($v) )\r
 808                         array_push($ret,yourls_http_build_query($v, '', $sep, $k, $urlencode));\r
 809                 elseif ( $urlencode )\r
 810                         array_push($ret, $k.'='.urlencode($v));\r
 811                 else\r
 812                         array_push($ret, $k.'='.$v);\r
 813         }\r
 814 \r
 815         if ( NULL === $sep )\r
 816                 $sep = ini_get('arg_separator.output');\r
 817 \r
 818         return implode($sep, $ret);\r
 819 }\r
 820 \r
 821 // Returns a sanitized a user agent string. Given what I found on http://www.user-agents.org/ it should be OK.\r
 822 function yourls_get_user_agent() {\r
 823         if ( !isset( $_SERVER['HTTP_USER_AGENT'] ) )\r
 824                 return '-';\r
 825         \r
 826         $ua = strip_tags( html_entity_decode( $_SERVER['HTTP_USER_AGENT'] ));\r
 827         $ua = preg_replace('![^0-9a-zA-Z\':., /{}\(\)\[\]\+@&\!\?;_\-=~\*\#]!', '', $ua );\r
 828                 \r
 829         return substr( $ua, 0, 254 );\r
 830 }\r
 831 \r
 832 // Redirect to another page\r
 833 function yourls_redirect( $location, $code = 301 ) {\r
 834         // Anti fool check: cannot redirect to the URL we currently are on\r
 835         if( preg_replace('!^[^:]+://!', '', $location) != $_SERVER["SERVER_NAME"].$_SERVER['REQUEST_URI'] ) {\r
 836                 yourls_status_header( $code );\r
 837                 header("Location: $location");\r
 838                 die();\r
 839         }\r
 840 }\r
 841 \r
 842 // Set HTTP status header\r
 843 function yourls_status_header( $code = 200 ) {\r
 844         if( headers_sent() )\r
 845                 return;\r
 846                 \r
 847         $protocol = $_SERVER["SERVER_PROTOCOL"];\r
 848         if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol )\r
 849                 $protocol = 'HTTP/1.0';\r
 850 \r
 851         $code = intval( $code );\r
 852         $desc = yourls_get_HTTP_status($code);\r
 853 \r
 854         @header ("$protocol $code $desc"); // This causes problems on IIS and some FastCGI setups\r
 855 }\r
 856 \r
 857 // 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
 858 function yourls_redirect_javascript( $location, $dontwait = true ) {\r
 859         if( $dontwait ) {\r
 860         echo <<<REDIR\r
 861         <script type="text/javascript">\r
 862         window.location="$location";\r
 863         </script>\r
 864         <small>(if you are not redirected after 10 seconds, please <a href="$location">click here</a>)</small>\r
 865 REDIR;\r
 866         } else {\r
 867         echo <<<MANUAL\r
 868         <p>Please <a href="$location">click here</a></p>\r
 869 MANUAL;\r
 870         }\r
 871 }\r
 872 \r
 873 // Return a HTTP status code\r
 874 function yourls_get_HTTP_status( $code ) {\r
 875         $code = intval( $code );\r
 876         $headers_desc = array(\r
 877                 100 => 'Continue',\r
 878                 101 => 'Switching Protocols',\r
 879                 102 => 'Processing',\r
 880 \r
 881                 200 => 'OK',\r
 882                 201 => 'Created',\r
 883                 202 => 'Accepted',\r
 884                 203 => 'Non-Authoritative Information',\r
 885                 204 => 'No Content',\r
 886                 205 => 'Reset Content',\r
 887                 206 => 'Partial Content',\r
 888                 207 => 'Multi-Status',\r
 889                 226 => 'IM Used',\r
 890 \r
 891                 300 => 'Multiple Choices',\r
 892                 301 => 'Moved Permanently',\r
 893                 302 => 'Found',\r
 894                 303 => 'See Other',\r
 895                 304 => 'Not Modified',\r
 896                 305 => 'Use Proxy',\r
 897                 306 => 'Reserved',\r
 898                 307 => 'Temporary Redirect',\r
 899 \r
 900                 400 => 'Bad Request',\r
 901                 401 => 'Unauthorized',\r
 902                 402 => 'Payment Required',\r
 903                 403 => 'Forbidden',\r
 904                 404 => 'Not Found',\r
 905                 405 => 'Method Not Allowed',\r
 906                 406 => 'Not Acceptable',\r
 907                 407 => 'Proxy Authentication Required',\r
 908                 408 => 'Request Timeout',\r
 909                 409 => 'Conflict',\r
 910                 410 => 'Gone',\r
 911                 411 => 'Length Required',\r
 912                 412 => 'Precondition Failed',\r
 913                 413 => 'Request Entity Too Large',\r
 914                 414 => 'Request-URI Too Long',\r
 915                 415 => 'Unsupported Media Type',\r
 916                 416 => 'Requested Range Not Satisfiable',\r
 917                 417 => 'Expectation Failed',\r
 918                 422 => 'Unprocessable Entity',\r
 919                 423 => 'Locked',\r
 920                 424 => 'Failed Dependency',\r
 921                 426 => 'Upgrade Required',\r
 922 \r
 923                 500 => 'Internal Server Error',\r
 924                 501 => 'Not Implemented',\r
 925                 502 => 'Bad Gateway',\r
 926                 503 => 'Service Unavailable',\r
 927                 504 => 'Gateway Timeout',\r
 928                 505 => 'HTTP Version Not Supported',\r
 929                 506 => 'Variant Also Negotiates',\r
 930                 507 => 'Insufficient Storage',\r
 931                 510 => 'Not Extended'\r
 932         );\r
 933 \r
 934         if ( isset( $headers_desc[$code] ) )\r
 935                 return $headers_desc[$code];\r
 936         else\r
 937                 return '';\r
 938 }\r
 939 \r
 940 \r
 941 // Log a redirect (for stats)\r
 942 function yourls_log_redirect( $keyword ) {\r
 943         global $ydb;\r
 944         $table = YOURLS_DB_TABLE_LOG;\r
 945         \r
 946         $keyword = yourls_sanitize_string( $keyword );\r
 947         $referrer = ( isset( $_SERVER['HTTP_REFERER'] ) ? yourls_sanitize_url( $_SERVER['HTTP_REFERER'] ) : 'direct' );\r
 948         $ua = yourls_get_user_agent();\r
 949         $ip = yourls_get_IP();\r
 950         $location = yourls_geo_ip_to_countrycode( $ip );\r
 951         \r
 952         return $ydb->query( "INSERT INTO `$table` VALUES ('', NOW(), '$keyword', '$referrer', '$ua', '$ip', '$location')" );\r
 953 }\r
 954 \r
 955 // Converts an IP to a 2 letter country code, using GeoIP database if available in includes/geo/\r
 956 function yourls_geo_ip_to_countrycode( $ip = '', $default = '' ) {\r
 957         if ( !file_exists( dirname(__FILE__).'/geo/GeoIP.dat') || !file_exists( dirname(__FILE__).'/geo/geoip.inc') )\r
 958                 return $default;\r
 959 \r
 960         if ( $ip == '' )\r
 961                 $ip = yourls_get_IP();\r
 962                 \r
 963         require_once( dirname(__FILE__).'/geo/geoip.inc') ;\r
 964         $gi = geoip_open( dirname(__FILE__).'/geo/GeoIP.dat', GEOIP_STANDARD);\r
 965         $location = geoip_country_code_by_addr($gi, $ip);\r
 966         geoip_close($gi);\r
 967 \r
 968         return $location;\r
 969 }\r
 970 \r
 971 // Converts a 2 letter country code to long name (ie AU -> Australia)\r
 972 function yourls_geo_countrycode_to_countryname( $code ) {\r
 973         // Load the Geo class if not already done\r
 974         if( !class_exists('GeoIP') ) {\r
 975                 $temp = yourls_geo_ip_to_countrycode('127.0.0.1');\r
 976         }\r
 977         \r
 978         if( class_exists('GeoIP') ) {\r
 979                 $geo = new GeoIP;\r
 980                 $id = $geo->GEOIP_COUNTRY_CODE_TO_NUMBER[$code];\r
 981                 $long = $geo->GEOIP_COUNTRY_NAMES[$id];\r
 982                 return $long;\r
 983         } else {\r
 984                 return false;\r
 985         }\r
 986 }\r
 987 \r
 988 // Return flag URL from 2 letter country code\r
 989 function yourls_geo_get_flag( $code ) {\r
 990         // Load the Geo class if not already done\r
 991         if( !class_exists('GeoIP') ) {\r
 992                 $temp = yourls_geo_ip_to_countrycode('127.0.0.1');\r
 993         }\r
 994         \r
 995         if( class_exists('GeoIP') ) {\r
 996                 return YOURLS_SITE.'/includes/geo/flags/flag_'.(strtolower($code)).'.gif';\r
 997         } else {\r
 998                 return false;\r
 999         }\r
1000 }\r
1001 \r
1002 \r
1003 // Check if an upgrade is needed\r
1004 function yourls_upgrade_is_needed() {\r
1005         // check YOURLS_VERSION && YOURLS_DB_VERSION exist && match values stored in YOURLS_DB_TABLE_OPTIONS\r
1006         list( $currentver, $currentsql ) = yourls_get_current_version_from_sql();\r
1007 \r
1008         // Using floatval() to get 1.4 from 1.4-alpha\r
1009         if( ( $currentver < floatval( YOURLS_VERSION ) ) || ( $currentsql < floatval( YOURLS_DB_VERSION ) ) )   \r
1010                 return true;\r
1011                 \r
1012         return false;\r
1013 }\r
1014 \r
1015 // Get current version & db version as stored in the options DB. Prior to 1.4 there's no option table.\r
1016 function yourls_get_current_version_from_sql() {\r
1017         $currentver = yourls_get_option( 'version' );\r
1018         $currentsql = yourls_get_option( 'db_version' );\r
1019 \r
1020         // Values if version is 1.3\r
1021         if( !$currentver )\r
1022                 $currentver = '1.3';\r
1023         if( !$currentsql )\r
1024                 $currentsql = '100';\r
1025                 \r
1026         return array( $currentver, $currentsql);\r
1027 }\r
1028 \r
1029 // Read an option from DB (or from cache if available). Return value or $default if not found\r
1030 function yourls_get_option( $option_name, $default = false ) {\r
1031         global $ydb;\r
1032         if ( !isset( $ydb->option[$option_name] ) ) {\r
1033                 $table = YOURLS_DB_TABLE_OPTIONS;\r
1034                 $option_name = yourls_escape( $option_name );\r
1035                 $row = $ydb->get_row( "SELECT `option_value` FROM `$table` WHERE `option_name` = '$option_name' LIMIT 1" );\r
1036                 if ( is_object( $row) ) { // Has to be get_row instead of get_var because of funkiness with 0, false, null values\r
1037                         $value = $row->option_value;\r
1038                 } else { // option does not exist, so we must cache its non-existence\r
1039                         $value = $default;\r
1040                 }\r
1041                 $ydb->option[$option_name] = yourls_maybe_unserialize( $value );\r
1042         }\r
1043 \r
1044         return $ydb->option[$option_name];\r
1045 }\r
1046 \r
1047 // Read all options from DB at once\r
1048 function yourls_get_all_options() {\r
1049         global $ydb;\r
1050         $table = YOURLS_DB_TABLE_OPTIONS;\r
1051         \r
1052         $allopt = $ydb->get_results("SELECT `option_name`, `option_value` FROM `$table` WHERE 1=1");\r
1053         \r
1054         foreach( (array)$allopt as $option ) {\r
1055                 $ydb->option[$option->option_name] = yourls_maybe_unserialize( $option->option_value );\r
1056         }\r
1057 }\r
1058 \r
1059 // Update (add if doesn't exist) an option to DB\r
1060 function yourls_update_option( $option_name, $newvalue ) {\r
1061         global $ydb;\r
1062         $table = YOURLS_DB_TABLE_OPTIONS;\r
1063 \r
1064         $safe_option_name = yourls_escape( $option_name );\r
1065 \r
1066         $oldvalue = yourls_get_option( $safe_option_name );\r
1067 \r
1068         // If the new and old values are the same, no need to update.\r
1069         if ( $newvalue === $oldvalue )\r
1070                 return false;\r
1071 \r
1072         if ( false === $oldvalue ) {\r
1073                 yourls_add_option( $option_name, $newvalue );\r
1074                 return true;\r
1075         }\r
1076 \r
1077         $_newvalue = yourls_escape( yourls_maybe_serialize( $newvalue ) );\r
1078 \r
1079         $ydb->query( "UPDATE `$table` SET `option_value` = '$_newvalue' WHERE `option_name` = '$option_name'");\r
1080 \r
1081         if ( $ydb->rows_affected == 1 ) {\r
1082                 $ydb->option[$option_name] = $newvalue;\r
1083                 return true;\r
1084         }\r
1085         return false;\r
1086 }\r
1087 \r
1088 // Add an option to the DB\r
1089 function yourls_add_option( $name, $value = '' ) {\r
1090         global $ydb;\r
1091         $table = YOURLS_DB_TABLE_OPTIONS;\r
1092         $safe_name = yourls_escape( $name );\r
1093 \r
1094         // Make sure the option doesn't already exist. We can check the 'notoptions' cache before we ask for a db query\r
1095         if ( false !== yourls_get_option( $safe_name ) )\r
1096                 return;\r
1097 \r
1098         $_value = yourls_escape( yourls_maybe_serialize( $value ) );\r
1099 \r
1100         $ydb->query( "INSERT INTO `$table` (`option_name`, `option_value`) VALUES ('$name', '$_value')" );\r
1101         $ydb->option[$name] = $value;\r
1102         return;\r
1103 }\r
1104 \r
1105 \r
1106 // Delete an option from the DB\r
1107 function yourls_delete_option( $name ) {\r
1108         global $ydb;\r
1109         $table = YOURLS_DB_TABLE_OPTIONS;\r
1110         $name = yourls_escape( $name );\r
1111 \r
1112         // Get the ID, if no ID then return\r
1113         $option = $ydb->get_row( "SELECT option_id FROM `$table` WHERE `option_name` = '$name'" );\r
1114         if ( is_null($option) || !$option->option_id )\r
1115                 return false;\r
1116         $ydb->query( "DELETE FROM `$table` WHERE `option_name` = '$name'" );\r
1117         return true;\r
1118 }\r
1119 \r
1120 \r
1121 \r
1122 // Serialize data if needed. Stolen from WordPress\r
1123 function yourls_maybe_serialize( $data ) {\r
1124         if ( is_array( $data ) || is_object( $data ) )\r
1125                 return serialize( $data );\r
1126 \r
1127         if ( yourls_is_serialized( $data ) )\r
1128                 return serialize( $data );\r
1129 \r
1130         return $data;\r
1131 }\r
1132 \r
1133 // Check value to find if it was serialized. Stolen from WordPress\r
1134 function yourls_is_serialized( $data ) {\r
1135         // if it isn't a string, it isn't serialized\r
1136         if ( !is_string( $data ) )\r
1137                 return false;\r
1138         $data = trim( $data );\r
1139         if ( 'N;' == $data )\r
1140                 return true;\r
1141         if ( !preg_match( '/^([adObis]):/', $data, $badions ) )\r
1142                 return false;\r
1143         switch ( $badions[1] ) {\r
1144                 case 'a' :\r
1145                 case 'O' :\r
1146                 case 's' :\r
1147                         if ( preg_match( "/^{$badions[1]}:[0-9]+:.*[;}]\$/s", $data ) )\r
1148                                 return true;\r
1149                         break;\r
1150                 case 'b' :\r
1151                 case 'i' :\r
1152                 case 'd' :\r
1153                         if ( preg_match( "/^{$badions[1]}:[0-9.E-]+;\$/", $data ) )\r
1154                                 return true;\r
1155                         break;\r
1156         }\r
1157         return false;\r
1158 }\r
1159 \r
1160 // Unserialize value only if it was serialized. Stolen from WP\r
1161 function yourls_maybe_unserialize( $original ) {\r
1162         if ( yourls_is_serialized( $original ) ) // don't attempt to unserialize data that wasn't serialized going in\r
1163                 return @unserialize( $original );\r
1164         return $original;\r
1165 }\r
1166 \r
1167 // Determine if the current page is private\r
1168 function yourls_is_private() {\r
1169         if (defined('YOURLS_PRIVATE') && YOURLS_PRIVATE == true) {\r
1170 \r
1171                 // Allow overruling of particular pages\r
1172                 $current = basename( $_SERVER["SCRIPT_NAME"] );\r
1173 \r
1174                 switch( $current ) {\r
1175                 \r
1176                 case 'yourls-api.php':\r
1177                         if( !defined('YOURLS_PRIVATE_API') || YOURLS_PRIVATE_API != false )\r
1178                                 return true;\r
1179                         break;\r
1180                                 \r
1181                 case 'yourls-infos.php':\r
1182                         if( !defined('YOURLS_PRIVATE_INFOS') || YOURLS_PRIVATE_INFOS !== false )\r
1183                                 return true;\r
1184                         break;\r
1185                 \r
1186                 default:\r
1187                         return true;\r
1188                         break;\r
1189                 }\r
1190         }\r
1191         \r
1192         return false;\r
1193 }\r
1194 \r
1195 // Show login form if required\r
1196 function yourls_maybe_require_auth() {\r
1197         if( yourls_is_private() )\r
1198                 require_once( dirname(__FILE__).'/auth.php' );\r
1199 }\r
1200 \r
1201 // Echo HTML tag for a link\r
1202 function yourls_html_link( $href, $title = '', $element = '' ) {\r
1203         if( !$title )\r
1204                 $title = $href;\r
1205         if( $element )\r
1206                 $element = "id='$element'";\r
1207         echo "<a href='$href' $element>$title</a>";\r
1208 }\r
1209 \r
1210 // Return word or words if more than one\r
1211 function yourls_plural( $word, $count=1 ) {\r
1212         return $word . ($count > 1 ? 's' : '');\r
1213 }\r
1214 \r
1215 // Return trimmed string\r
1216 function yourls_trim_long_string( $string, $length = 60, $append = '[...]' ) {\r
1217         if ( strlen( $string ) > $length ) {\r
1218                 $string = substr( $string, 0, $length - strlen( $append ) ) . $append;  \r
1219         }\r
1220         return $string;\r
1221 }\r
1222 \r
1223 // Allow several short URLs for the same long URL ?\r
1224 function yourls_allow_duplicate_longurls() {\r
1225         return ( defined( 'YOURLS_UNIQUE_URLS' ) && YOURLS_UNIQUE_URLS == false );\r
1226 }\r
1227 \r
1228 // Return list of all shorturls associated to the same long URL. Returns NULL or array of keywords.\r
1229 function yourls_get_duplicate_keywords( $longurl ) {\r
1230         if( !yourls_allow_duplicate_longurls() )\r
1231                 return NULL;\r
1232         \r
1233         global $ydb;\r
1234         $longurl = mysql_real_escape_string( yourls_sanitize_url($longurl) );\r
1235         $table = YOURLS_DB_TABLE_URL;\r
1236         \r
1237         return $ydb->get_col( "SELECT `keyword` FROM `$table` WHERE `url` = '$longurl'" );\r
1238 }\r
1239 \r
1240 // Check if an IP shortens URL too fast to prevent DB flood. Return true, or die.\r
1241 function yourls_check_IP_flood( $ip = '' ) {\r
1242         $ip = ( $ip ? yourls_sanitize_ip( $ip ) : yourls_get_IP() );\r
1243 \r
1244         // Don't throttle whitelist IPs\r
1245         if( defined('YOURLS_FLOOD_IP_WHITELIST' && YOURLS_FLOOD_IP_WHITELIST ) ) {\r
1246                 $whitelist_ips = explode( ',', YOURLS_FLOOD_IP_WHITELIST );\r
1247                 foreach( $whitelist_ips as $whitelist_ip ) {\r
1248                         $whitelist_ip = trim( $whitelist_ip );\r
1249                         if ( $whitelist_ip == $ip )\r
1250                                 return true;\r
1251                 }\r
1252         }\r
1253         \r
1254         // Don't throttle logged in users\r
1255         if( yourls_is_private() ) {\r
1256                  if( yourls_is_valid_user() === true )\r
1257                         return true;\r
1258         }\r
1259 \r
1260         global $ydb;\r
1261         $table = YOURLS_DB_TABLE_URL;\r
1262         \r
1263         $lasttime = $ydb->get_var( "SELECT `timestamp` FROM $table WHERE `ip` = '$ip' ORDER BY `timestamp` DESC LIMIT 1" );\r
1264         if( $lasttime ) {\r
1265                 $now = date( 'U' );\r
1266                 $then = date( 'U', strtotime( $lasttime ) );\r
1267                 if( ( $now - $then ) <= YOURLS_FLOOD_DELAY_SECONDS ) {\r
1268                         // Flood!\r
1269                         yourls_die( 'Too many URLs added too fast. Slow down please.', 'Forbidden', 403 );\r
1270                 }\r
1271         }\r
1272         \r
1273         return true;\r
1274 }\r
1275 \r
1276 // Die die die\r
1277 function yourls_die( $message = '', $title = '', $header_code = 200 ) {\r
1278         yourls_status_header( $header_code );\r
1279         \r
1280         yourls_html_head();\r
1281         ?>\r
1282         <h1>\r
1283                 <a href="<?php echo $base_page; ?>" title="YOURLS"><span>YOURLS</span>: <span>Y</span>our <span>O</span>wn <span>URL</span> <span>S</span>hortener<br/>\r
1284                 <img src="<?php echo YOURLS_SITE; ?>/images/yourls-logo.png" alt="YOURLS" title="YOURLS" style="border: 0px;" /></a>\r
1285         </h1>\r
1286         <?php\r
1287         echo "<h2>$title</h2>";\r
1288         echo "<p>$message</p>";\r
1289         yourls_html_footer();\r
1290         die();\r
1291 }