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