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