7 // Determine the allowed character set in short URLs
\r
8 function yourls_get_shorturl_charset() {
\r
9 static $charset = null;
\r
10 if( $charset !== null )
\r
13 if( !defined('YOURLS_URL_CONVERT') ) {
\r
14 $charset = '0123456789abcdefghijklmnopqrstuvwxyz';
\r
16 switch( YOURLS_URL_CONVERT ) {
\r
18 $charset = '0123456789abcdefghijklmnopqrstuvwxyz';
\r
21 case 64: // just because some people get this wrong in their config.php
\r
22 $charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
\r
27 $charset = yourls_apply_filter( 'get_shorturl_charset', $charset );
\r
31 // Make an optimized regexp pattern from a string of characters
\r
32 function yourls_make_regexp_pattern( $string ) {
\r
33 $pattern = preg_quote( $string, '-' ); // add - as an escaped characters -- this is fixed in PHP 5.3
\r
34 // TODO: replace char sequences by smart sequences such as 0-9, a-z, A-Z ... ?
\r
38 // Is an URL a short URL?
\r
39 function yourls_is_shorturl( $shorturl ) {
\r
40 // TODO: make sure this function evolves with the feature set.
\r
43 $keyword = preg_replace( '!^'.YOURLS_SITE.'/!', '', $shorturl ); // accept either 'http://ozh.in/abc' or 'abc'
\r
44 if( $keyword && $keyword == yourls_sanitize_string( $keyword ) && yourls_keyword_is_taken( $keyword ) ) {
\r
48 return yourls_apply_filter( 'is_shorturl', $is_short, $shorturl );
\r
51 // Check to see if a given keyword is reserved (ie reserved URL or an existing page)
\r
53 function yourls_keyword_is_reserved( $keyword ) {
\r
54 global $yourls_reserved_URL;
\r
55 $keyword = yourls_sanitize_keyword( $keyword );
\r
58 if ( in_array( $keyword, $yourls_reserved_URL)
\r
59 or file_exists( YOURLS_ABSPATH ."/pages/$keyword.php" )
\r
60 or is_dir( YOURLS_ABSPATH ."/$keyword" )
\r
64 return yourls_apply_filter( 'keyword_is_reserved', $reserved, $keyword );
\r
67 // Function: Get client IP Address. Returns a DB safe string.
\r
68 function yourls_get_IP() {
\r
69 // Precedence: if set, X-Forwarded-For > HTTP_X_FORWARDED_FOR > HTTP_CLIENT_IP > HTTP_VIA > REMOTE_ADDR
\r
70 $headers = array( 'X-Forwarded-For', 'HTTP_X_FORWARDED_FOR', 'HTTP_CLIENT_IP', 'HTTP_VIA', 'REMOTE_ADDR' );
\r
71 foreach( $headers as $header ) {
\r
72 if ( !empty( $_SERVER[ $header ] ) ) {
\r
73 $ip = $_SERVER[ $header ];
\r
78 // headers can contain multiple IPs (X-Forwarded-For = client, proxy1, proxy2). Take first one.
\r
79 if ( strpos( $ip, ',' ) !== false )
\r
80 $ip = substr( $ip, 0, strpos( $ip, ',' ) );
\r
82 return yourls_apply_filter( 'get_IP', yourls_sanitize_ip( $ip ) );
\r
85 // Get next id a new link will have if no custom keyword provided
\r
86 function yourls_get_next_decimal() {
\r
87 return yourls_apply_filter( 'get_next_decimal', (int)yourls_get_option( 'next_id' ) );
\r
90 // Update id for next link with no custom keyword
\r
91 function yourls_update_next_decimal( $int = '' ) {
\r
92 $int = ( $int == '' ) ? yourls_get_next_decimal() + 1 : (int)$int ;
\r
93 $update = yourls_update_option( 'next_id', $int );
\r
94 yourls_do_action( 'update_next_decimal', $int, $update );
\r
98 // Delete a link in the DB
\r
99 function yourls_delete_link_by_keyword( $keyword ) {
\r
102 $table = YOURLS_DB_TABLE_URL;
\r
103 $keyword = yourls_sanitize_string( $keyword );
\r
104 $delete = $ydb->query("DELETE FROM `$table` WHERE `keyword` = '$keyword';");
\r
105 yourls_do_action( 'delete_link', $keyword, $delete );
\r
109 // SQL query to insert a new link in the DB. Returns boolean for success or failure of the inserting
\r
110 function yourls_insert_link_in_db( $url, $keyword, $title = '' ) {
\r
113 $url = addslashes( yourls_sanitize_url( $url ) );
\r
114 $keyword = addslashes( yourls_sanitize_keyword( $keyword ) );
\r
115 $title = addslashes( yourls_sanitize_title( $title ) );
\r
117 $table = YOURLS_DB_TABLE_URL;
\r
118 $timestamp = date('Y-m-d H:i:s');
\r
119 $ip = yourls_get_IP();
\r
120 $insert = $ydb->query("INSERT INTO `$table` (`keyword`, `url`, `title`, `timestamp`, `ip`, `clicks`) VALUES('$keyword', '$url', '$title', '$timestamp', '$ip', 0);");
\r
122 yourls_do_action( 'insert_link', (bool)$insert, $url, $keyword, $title, $timestamp, $ip );
\r
124 return (bool)$insert;
\r
127 // Check if a URL already exists in the DB. Return NULL (doesn't exist) or an object with URL informations.
\r
128 function yourls_url_exists( $url ) {
\r
129 // Allow plugins to short-circuit the whole function
\r
130 $pre = yourls_apply_filter( 'shunt_url_exists', false, $url );
\r
131 if ( false !== $pre )
\r
135 $table = YOURLS_DB_TABLE_URL;
\r
136 $strip_url = stripslashes($url);
\r
137 $url_exists = $ydb->get_row("SELECT * FROM `$table` WHERE `url` = '".$strip_url."';");
\r
139 return yourls_apply_filter( 'url_exists', $url_exists, $url );
\r
142 // Add a new link in the DB, either with custom keyword, or find one
\r
143 function yourls_add_new_link( $url, $keyword = '', $title = '' ) {
\r
146 // Allow plugins to short-circuit the whole function
\r
147 $pre = yourls_apply_filter( 'shunt_add_new_link', false, $url, $keyword, $title );
\r
148 if ( false !== $pre )
\r
151 if ( !$url || $url == 'http://' || $url == 'https://' ) {
\r
152 $return['status'] = 'fail';
\r
153 $return['code'] = 'error:nourl';
\r
154 $return['message'] = 'Missing URL input';
\r
155 $return['errorCode'] = '400';
\r
156 return yourls_apply_filter( 'add_new_link_fail_nourl', $return, $url, $keyword, $title );
\r
159 // Prevent DB flood
\r
160 $ip = yourls_get_IP();
\r
161 yourls_check_IP_flood( $ip );
\r
163 // Prevent internal redirection loops: cannot shorten a shortened URL
\r
164 $url = yourls_escape( yourls_sanitize_url( $url ) );
\r
165 if( preg_match( '!^'.YOURLS_SITE.'/!', $url ) ) {
\r
166 if( yourls_is_shorturl( $url ) ) {
\r
167 $return['status'] = 'fail';
\r
168 $return['code'] = 'error:noloop';
\r
169 $return['message'] = 'URL is a short URL';
\r
170 $return['errorCode'] = '400';
\r
171 return yourls_apply_filter( 'add_new_link_fail_noloop', $return, $url, $keyword, $title );
\r
175 yourls_do_action( 'pre_add_new_link', $url, $keyword, $title );
\r
177 $strip_url = stripslashes( $url );
\r
180 // duplicates allowed or new URL => store it
\r
181 if( yourls_allow_duplicate_longurls() || !( $url_exists = yourls_url_exists( $url ) ) ) {
\r
183 if( isset( $title ) && !empty( $title ) ) {
\r
184 $title = yourls_sanitize_title( $title );
\r
186 $title = yourls_get_remote_title( $url );
\r
188 $title = yourls_apply_filter( 'add_new_title', $title, $url, $keyword );
\r
190 // Custom keyword provided
\r
193 yourls_do_action( 'add_new_link_custom_keyword', $url, $keyword, $title );
\r
195 $keyword = yourls_escape( yourls_sanitize_string( $keyword ) );
\r
196 $keyword = yourls_apply_filter( 'custom_keyword', $keyword, $url, $title );
\r
197 if ( !yourls_keyword_is_free( $keyword ) ) {
\r
198 // This shorturl either reserved or taken already
\r
199 $return['status'] = 'fail';
\r
200 $return['code'] = 'error:keyword';
\r
201 $return['message'] = 'Short URL '.$keyword.' already exists in database or is reserved';
\r
203 // all clear, store !
\r
204 yourls_insert_link_in_db( $url, $keyword, $title );
\r
205 $return['url'] = array('keyword' => $keyword, 'url' => $strip_url, 'title' => $title, 'date' => date('Y-m-d H:i:s'), 'ip' => $ip );
\r
206 $return['status'] = 'success';
\r
207 $return['message'] = yourls_trim_long_string( $strip_url ).' added to database';
\r
208 $return['title'] = $title;
\r
209 $return['html'] = yourls_table_add_row( $keyword, $url, $title, $ip, 0, time() );
\r
210 $return['shorturl'] = YOURLS_SITE .'/'. $keyword;
\r
213 // Create random keyword
\r
216 yourls_do_action( 'add_new_link_create_keyword', $url, $keyword, $title );
\r
218 $timestamp = date( 'Y-m-d H:i:s' );
\r
219 $id = yourls_get_next_decimal();
\r
222 $keyword = yourls_int2string( $id );
\r
223 $keyword = yourls_apply_filter( 'random_keyword', $keyword, $url, $title );
\r
224 $free = yourls_keyword_is_free($keyword);
\r
225 $add_url = @yourls_insert_link_in_db( $url, $keyword, $title );
\r
226 $ok = ($free && $add_url);
\r
227 if ( $ok === false && $add_url === 1 ) {
\r
228 // we stored something, but shouldn't have (ie reserved id)
\r
229 $delete = yourls_delete_link_by_keyword( $keyword );
\r
230 $return['extra_info'] .= '(deleted '.$keyword.')';
\r
232 // everything ok, populate needed vars
\r
233 $return['url'] = array('keyword' => $keyword, 'url' => $strip_url, 'title' => $title, 'date' => $timestamp, 'ip' => $ip );
\r
234 $return['status'] = 'success';
\r
235 $return['message'] = yourls_trim_long_string( $strip_url ).' added to database';
\r
236 $return['title'] = $title;
\r
237 $return['html'] = yourls_table_add_row( $keyword, $url, $title, $ip, 0, time() );
\r
238 $return['shorturl'] = YOURLS_SITE .'/'. $keyword;
\r
242 @yourls_update_next_decimal( $id );
\r
245 // URL was already stored
\r
248 yourls_do_action( 'add_new_link_already_stored', $url, $keyword, $title );
\r
250 $return['status'] = 'fail';
\r
251 $return['code'] = 'error:url';
\r
252 $return['url'] = array( 'keyword' => $url_exists->keyword, 'url' => $strip_url, 'title' => $url_exists->title, 'date' => $url_exists->timestamp, 'ip' => $url_exists->ip, 'clicks' => $url_exists->clicks );
\r
253 $return['message'] = yourls_trim_long_string( $strip_url ).' already exists in database';
\r
254 $return['title'] = $url_exists->title;
\r
255 $return['shorturl'] = YOURLS_SITE .'/'. $url_exists->keyword;
\r
258 yourls_do_action( 'post_add_new_link', $url, $keyword, $title );
\r
260 $return['statusCode'] = 200; // regardless of result, this is still a valid request
\r
261 return yourls_apply_filter( 'add_new_link', $return, $url, $keyword, $title );
\r
266 function yourls_edit_link( $url, $keyword, $newkeyword='', $title='' ) {
\r
269 $table = YOURLS_DB_TABLE_URL;
\r
270 $url = yourls_escape (yourls_sanitize_url( $url ) );
\r
271 $keyword = yourls_escape( yourls_sanitize_string( $keyword ) );
\r
272 $title = yourls_escape( yourls_sanitize_title( $title ) );
\r
273 $newkeyword = yourls_escape( yourls_sanitize_string( $newkeyword ) );
\r
274 $strip_url = stripslashes( $url );
\r
275 $strip_title = stripslashes( $title );
\r
276 $old_url = $ydb->get_var( "SELECT `url` FROM `$table` WHERE `keyword` = '$keyword';" );
\r
278 // Check if new URL is not here already
\r
279 if ( $old_url != $url && !yourls_allow_duplicate_longurls() ) {
\r
280 $new_url_already_there = intval($ydb->get_var("SELECT COUNT(keyword) FROM `$table` WHERE `url` = '$strip_url';"));
\r
282 $new_url_already_there = false;
\r
285 // Check if the new keyword is not here already
\r
286 if ( $newkeyword != $keyword ) {
\r
287 $keyword_is_ok = yourls_keyword_is_free( $newkeyword );
\r
289 $keyword_is_ok = true;
\r
292 yourls_do_action( 'pre_edit_link', $url, $keyword, $newkeyword, $new_url_already_there, $keyword_is_ok );
\r
294 // All clear, update
\r
295 if ( ( !$new_url_already_there || yourls_allow_duplicate_longurls() ) && $keyword_is_ok ) {
\r
296 $update_url = $ydb->query( "UPDATE `$table` SET `url` = '$url', `keyword` = '$newkeyword', `title` = '$title' WHERE `keyword` = '$keyword';" );
\r
297 if( $update_url ) {
\r
298 $return['url'] = array( 'keyword' => $newkeyword, 'shorturl' => YOURLS_SITE.'/'.$newkeyword, 'url' => $strip_url, 'display_url' => yourls_trim_long_string( $strip_url ), 'title' => $strip_title, 'display_title' => yourls_trim_long_string( $strip_title ) );
\r
299 $return['status'] = 'success';
\r
300 $return['message'] = 'Link updated in database';
\r
302 $return['status'] = 'fail';
\r
303 $return['message'] = 'Error updating '. yourls_trim_long_string( $strip_url ).' (Short URL: '.$keyword.') to database';
\r
308 $return['status'] = 'fail';
\r
309 $return['message'] = 'URL or keyword already exists in database';
\r
312 return yourls_apply_filter( 'edit_link', $return, $url, $keyword, $newkeyword, $title, $new_url_already_there, $keyword_is_ok );
\r
315 // Update a title link (no checks for duplicates etc..)
\r
316 function yourls_edit_link_title( $keyword, $title ) {
\r
319 $keyword = yourls_escape( yourls_sanitize_keyword( $keyword ) );
\r
320 $title = yourls_escape( yourls_sanitize_title( $title ) );
\r
322 $table = YOURLS_DB_TABLE_URL;
\r
323 $update = $ydb->query("UPDATE `$table` SET `title` = '$title' WHERE `keyword` = '$keyword';");
\r
329 // Check if keyword id is free (ie not already taken, and not reserved). Return bool.
\r
330 function yourls_keyword_is_free( $keyword ) {
\r
332 if ( yourls_keyword_is_reserved( $keyword ) or yourls_keyword_is_taken( $keyword ) )
\r
335 return yourls_apply_filter( 'keyword_is_free', $free, $keyword );
\r
338 // Check if a keyword is taken (ie there is already a short URL with this id). Return bool.
\r
339 function yourls_keyword_is_taken( $keyword ) {
\r
341 $keyword = yourls_sanitize_keyword( $keyword );
\r
343 $table = YOURLS_DB_TABLE_URL;
\r
344 $already_exists = $ydb->get_var( "SELECT COUNT(`keyword`) FROM `$table` WHERE `keyword` = '$keyword';" );
\r
345 if ( $already_exists )
\r
348 return yourls_apply_filter( 'keyword_is_taken', $taken, $keyword );
\r
353 function yourls_db_connect() {
\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 ) yourls_die ( 'DB config missing, or could not find DB class', 'Fatal error', 503 );
\r
363 // Are we standalone or in the WordPress environment?
\r
364 if ( class_exists( 'wpdb' ) ) {
\r
365 $ydb = new wpdb( YOURLS_DB_USER, YOURLS_DB_PASS, YOURLS_DB_NAME, YOURLS_DB_HOST );
\r
367 $ydb = new ezSQL_mysql( YOURLS_DB_USER, YOURLS_DB_PASS, YOURLS_DB_NAME, YOURLS_DB_HOST );
\r
369 if ( $ydb->last_error )
\r
370 yourls_die( $ydb->last_error, 'Fatal error', 503 );
\r
372 if ( defined( 'YOURLS_DEBUG' ) && YOURLS_DEBUG === true )
\r
373 $ydb->show_errors = true;
\r
378 // Return XML output.
\r
379 function yourls_xml_encode( $array ) {
\r
380 require_once( YOURLS_INC.'/functions-xml.php' );
\r
381 $converter= new yourls_array2xml;
\r
382 return $converter->array2xml( $array );
\r
385 // 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
386 function yourls_get_keyword_infos( $keyword, $use_cache = true ) {
\r
388 $keyword = yourls_sanitize_string( $keyword );
\r
390 yourls_do_action( 'pre_get_keyword', $keyword, $use_cache );
\r
392 if( isset( $ydb->infos[$keyword] ) && $use_cache == true ) {
\r
393 return yourls_apply_filter( 'get_keyword_infos', $ydb->infos[$keyword], $keyword );
\r
396 yourls_do_action( 'get_keyword_not_cached', $keyword );
\r
398 $table = YOURLS_DB_TABLE_URL;
\r
399 $infos = $ydb->get_row( "SELECT * FROM `$table` WHERE `keyword` = '$keyword'" );
\r
402 $infos = (array)$infos;
\r
403 $ydb->infos[ $keyword ] = $infos;
\r
405 $ydb->infos[ $keyword ] = false;
\r
408 return yourls_apply_filter( 'get_keyword_infos', $ydb->infos[$keyword], $keyword );
\r
411 // Return (string) selected information associated with a keyword. Optional $notfound = string default message if nothing found
\r
412 function yourls_get_keyword_info( $keyword, $field, $notfound = false ) {
\r
414 // Allow plugins to short-circuit the whole function
\r
415 $pre = yourls_apply_filter( 'shunt_get_keyword_info', false, $keyword, $field, $notfound );
\r
416 if ( false !== $pre )
\r
419 $keyword = yourls_sanitize_string( $keyword );
\r
420 $infos = yourls_get_keyword_infos( $keyword );
\r
422 $return = $notfound;
\r
423 if ( isset( $infos[ $field ] ) && $infos[ $field ] !== false )
\r
424 $return = $infos[ $field ];
\r
426 return yourls_apply_filter( 'get_keyword_info', $return, $keyword, $field, $notfound );
\r
429 // Return title associated with keyword. Optional $notfound = string default message if nothing found
\r
430 function yourls_get_keyword_title( $keyword, $notfound = false ) {
\r
431 return yourls_get_keyword_info( $keyword, 'title', $notfound );
\r
434 // Return long URL associated with keyword. Optional $notfound = string default message if nothing found
\r
435 function yourls_get_keyword_longurl( $keyword, $notfound = false ) {
\r
436 return yourls_get_keyword_info( $keyword, 'url', $notfound );
\r
439 // Return number of clicks on a keyword. Optional $notfound = string default message if nothing found
\r
440 function yourls_get_keyword_clicks( $keyword, $notfound = false ) {
\r
441 return yourls_get_keyword_info( $keyword, 'clicks', $notfound );
\r
444 // Return IP that added a keyword. Optional $notfound = string default message if nothing found
\r
445 function yourls_get_keyword_IP( $keyword, $notfound = false ) {
\r
446 return yourls_get_keyword_info( $keyword, 'ip', $notfound );
\r
449 // Return timestamp associated with a keyword. Optional $notfound = string default message if nothing found
\r
450 function yourls_get_keyword_timestamp( $keyword, $notfound = false ) {
\r
451 return yourls_get_keyword_info( $keyword, 'timestamp', $notfound );
\r
454 // Update click count on a short URL. Return 0/1 for error/success.
\r
455 function yourls_update_clicks( $keyword, $clicks = false ) {
\r
456 // Allow plugins to short-circuit the whole function
\r
457 $pre = yourls_apply_filter( 'shunt_update_clicks', false, $keyword, $clicks );
\r
458 if ( false !== $pre )
\r
462 $keyword = yourls_sanitize_string( $keyword );
\r
463 $table = YOURLS_DB_TABLE_URL;
\r
464 if ( $clicks !== false && is_int( $clicks ) && $clicks >= 0 )
\r
465 $update = $ydb->query( "UPDATE `$table` SET `clicks` = $clicks WHERE `keyword` = '$keyword'" );
\r
467 $update = $ydb->query( "UPDATE `$table` SET `clicks` = clicks + 1 WHERE `keyword` = '$keyword'" );
\r
469 yourls_do_action( 'update_clicks', $keyword, $update, $clicks );
\r
473 // Return array of stats. (string)$filter is 'bottom', 'last', 'rand' or 'top'. (int)$limit is the number of links to return
\r
474 function yourls_get_stats( $filter = 'top', $limit = 10, $start = 0 ) {
\r
477 switch( $filter ) {
\r
479 $sort_by = 'clicks';
\r
480 $sort_order = 'asc';
\r
483 $sort_by = 'timestamp';
\r
484 $sort_order = 'desc';
\r
488 $sort_by = 'RAND()';
\r
493 $sort_by = 'clicks';
\r
494 $sort_order = 'desc';
\r
499 $limit = intval( $limit );
\r
500 $start = intval( $start );
\r
501 if ( $limit > 0 ) {
\r
503 $table_url = YOURLS_DB_TABLE_URL;
\r
504 $results = $ydb->get_results( "SELECT * FROM `$table_url` WHERE 1=1 ORDER BY `$sort_by` $sort_order LIMIT $start, $limit;" );
\r
509 foreach ( (array)$results as $res ) {
\r
510 $return['links']['link_'.$i++] = array(
\r
511 'shorturl' => YOURLS_SITE .'/'. $res->keyword,
\r
512 'url' => $res->url,
\r
513 'title' => $res->title,
\r
514 'timestamp'=> $res->timestamp,
\r
516 'clicks' => $res->clicks,
\r
521 $return['stats'] = yourls_get_db_stats();
\r
523 $return['statusCode'] = 200;
\r
525 return yourls_apply_filter( 'get_stats', $return, $filter, $limit, $start );
\r
528 // Return array of stats. (string)$filter is 'bottom', 'last', 'rand' or 'top'. (int)$limit is the number of links to return
\r
529 function yourls_get_link_stats( $shorturl ) {
\r
532 $table_url = YOURLS_DB_TABLE_URL;
\r
533 $res = $ydb->get_row( "SELECT * FROM `$table_url` WHERE keyword = '$shorturl';" );
\r
537 // non existent link
\r
539 'statusCode' => 404,
\r
540 'message' => 'Error: short URL not found',
\r
544 'statusCode' => 200,
\r
545 'message' => 'success',
\r
547 'shorturl' => YOURLS_SITE .'/'. $res->keyword,
\r
548 'url' => $res->url,
\r
549 'title' => $res->title,
\r
550 'timestamp'=> $res->timestamp,
\r
552 'clicks' => $res->clicks,
\r
557 return yourls_apply_filter( 'get_link_stats', $return, $shorturl );
\r
560 // Return array for API stat requests
\r
561 function yourls_api_stats( $filter = 'top', $limit = 10, $start = 0 ) {
\r
562 $return = yourls_get_stats( $filter, $limit, $start );
\r
563 $return['simple'] = 'Need either XML or JSON format for stats';
\r
564 $return['message'] = 'success';
\r
565 return yourls_apply_filter( 'api_stats', $return, $filter, $limit, $start );
\r
568 // Return array for counts of shorturls and clicks
\r
569 function yourls_api_db_stats() {
\r
570 $return = yourls_get_db_stats();
\r
571 $return['simple'] = 'Need either XML or JSON format for stats';
\r
572 $return['message'] = 'success';
\r
573 return yourls_apply_filter( 'api_db_stats', $return );
\r
576 // Return array for API stat requests
\r
577 function yourls_api_url_stats( $shorturl ) {
\r
578 $keyword = str_replace( YOURLS_SITE . '/' , '', $shorturl ); // accept either 'http://ozh.in/abc' or 'abc'
\r
579 $keyword = yourls_sanitize_string( $keyword );
\r
581 $return = yourls_get_link_stats( $keyword );
\r
582 $return['simple'] = 'Need either XML or JSON format for stats';
\r
583 return yourls_apply_filter( 'api_url_stats', $return, $shorturl );
\r
586 // Expand short url to long url
\r
587 function yourls_api_expand( $shorturl ) {
\r
588 $keyword = str_replace( YOURLS_SITE . '/' , '', $shorturl ); // accept either 'http://ozh.in/abc' or 'abc'
\r
589 $keyword = yourls_sanitize_string( $keyword );
\r
591 $longurl = yourls_get_keyword_longurl( $keyword );
\r
595 'keyword' => $keyword,
\r
596 'shorturl' => YOURLS_SITE . "/$keyword",
\r
597 'longurl' => $longurl,
\r
598 'simple' => $longurl,
\r
599 'message' => 'success',
\r
600 'statusCode' => 200,
\r
604 'keyword' => $keyword,
\r
605 'simple' => 'not found',
\r
606 'message' => 'Error: short URL not found',
\r
607 'errorCode' => 404,
\r
611 return yourls_apply_filter( 'api_expand', $return, $shorturl );
\r
615 // Get total number of URLs and sum of clicks. Input: optional "AND WHERE" clause. Returns array
\r
616 function yourls_get_db_stats( $where = '' ) {
\r
618 $table_url = YOURLS_DB_TABLE_URL;
\r
620 $totals = $ydb->get_row( "SELECT COUNT(keyword) as count, SUM(clicks) as sum FROM `$table_url` WHERE 1=1 $where" );
\r
621 $return = array( 'total_links' => $totals->count, 'total_clicks' => $totals->sum );
\r
623 return yourls_apply_filter( 'get_db_stats', $return, $where );
\r
626 // Return API result. Dies after this
\r
627 function yourls_api_output( $mode, $return ) {
\r
628 if( isset( $return['simple'] ) ) {
\r
629 $simple = $return['simple'];
\r
630 unset( $return['simple'] );
\r
633 yourls_do_action( 'pre_api_output', $mode, $return );
\r
637 header( 'Content-type: application/javascript' );
\r
638 echo $return['callback'] . '(' . json_encode( $return ) . ')';
\r
642 header( 'Content-type: application/json' );
\r
643 echo json_encode( $return );
\r
647 header( 'Content-type: application/xml' );
\r
648 echo yourls_xml_encode( $return );
\r
653 if( isset( $simple ) )
\r
658 yourls_do_action( 'api_output', $mode, $return );
\r
663 // Get number of SQL queries performed
\r
664 function yourls_get_num_queries() {
\r
667 return yourls_apply_filter( 'get_num_queries', $ydb->num_queries );
\r
670 // Returns a sanitized a user agent string. Given what I found on http://www.user-agents.org/ it should be OK.
\r
671 function yourls_get_user_agent() {
\r
672 if ( !isset( $_SERVER['HTTP_USER_AGENT'] ) )
\r
675 $ua = strip_tags( html_entity_decode( $_SERVER['HTTP_USER_AGENT'] ));
\r
676 $ua = preg_replace('![^0-9a-zA-Z\':., /{}\(\)\[\]\+@&\!\?;_\-=~\*\#]!', '', $ua );
\r
678 return yourls_apply_filter( 'get_user_agent', substr( $ua, 0, 254 ) );
\r
681 // Redirect to another page
\r
682 function yourls_redirect( $location, $code = 301 ) {
\r
683 yourls_do_action( 'pre_redirect', $location, $code );
\r
684 $location = yourls_apply_filter( 'redirect', $location, $code );
\r
685 // Redirect, either properly if possible, or via Javascript otherwise
\r
686 if( !headers_sent() ) {
\r
687 yourls_status_header( $code );
\r
688 header( "Location: $location" );
\r
690 yourls_redirect_javascript( $location );
\r
695 // Set HTTP status header
\r
696 function yourls_status_header( $code = 200 ) {
\r
697 if( headers_sent() )
\r
700 $protocol = $_SERVER["SERVER_PROTOCOL"];
\r
701 if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol )
\r
702 $protocol = 'HTTP/1.0';
\r
704 $code = intval( $code );
\r
705 $desc = yourls_get_HTTP_status( $code );
\r
707 @header ("$protocol $code $desc"); // This causes problems on IIS and some FastCGI setups
\r
708 yourls_do_action( 'status_header', $code );
\r
711 // 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
712 function yourls_redirect_javascript( $location, $dontwait = true ) {
\r
713 yourls_do_action( 'pre_redirect_javascript', $location, $dontwait );
\r
714 $location = yourls_apply_filter( 'redirect_javascript', $location, $dontwait );
\r
717 <script type="text/javascript">
\r
718 window.location="$location";
\r
720 <small>(if you are not redirected after 10 seconds, please <a href="$location">click here</a>)</small>
\r
724 <p>Please <a href="$location">click here</a></p>
\r
727 yourls_do_action( 'post_redirect_javascript', $location );
\r
730 // Return a HTTP status code
\r
731 function yourls_get_HTTP_status( $code ) {
\r
732 $code = intval( $code );
\r
733 $headers_desc = array(
\r
735 101 => 'Switching Protocols',
\r
736 102 => 'Processing',
\r
741 203 => 'Non-Authoritative Information',
\r
742 204 => 'No Content',
\r
743 205 => 'Reset Content',
\r
744 206 => 'Partial Content',
\r
745 207 => 'Multi-Status',
\r
748 300 => 'Multiple Choices',
\r
749 301 => 'Moved Permanently',
\r
751 303 => 'See Other',
\r
752 304 => 'Not Modified',
\r
753 305 => 'Use Proxy',
\r
755 307 => 'Temporary Redirect',
\r
757 400 => 'Bad Request',
\r
758 401 => 'Unauthorized',
\r
759 402 => 'Payment Required',
\r
760 403 => 'Forbidden',
\r
761 404 => 'Not Found',
\r
762 405 => 'Method Not Allowed',
\r
763 406 => 'Not Acceptable',
\r
764 407 => 'Proxy Authentication Required',
\r
765 408 => 'Request Timeout',
\r
768 411 => 'Length Required',
\r
769 412 => 'Precondition Failed',
\r
770 413 => 'Request Entity Too Large',
\r
771 414 => 'Request-URI Too Long',
\r
772 415 => 'Unsupported Media Type',
\r
773 416 => 'Requested Range Not Satisfiable',
\r
774 417 => 'Expectation Failed',
\r
775 422 => 'Unprocessable Entity',
\r
777 424 => 'Failed Dependency',
\r
778 426 => 'Upgrade Required',
\r
780 500 => 'Internal Server Error',
\r
781 501 => 'Not Implemented',
\r
782 502 => 'Bad Gateway',
\r
783 503 => 'Service Unavailable',
\r
784 504 => 'Gateway Timeout',
\r
785 505 => 'HTTP Version Not Supported',
\r
786 506 => 'Variant Also Negotiates',
\r
787 507 => 'Insufficient Storage',
\r
788 510 => 'Not Extended'
\r
791 if ( isset( $headers_desc[$code] ) )
\r
792 return $headers_desc[$code];
\r
798 // Log a redirect (for stats)
\r
799 function yourls_log_redirect( $keyword ) {
\r
800 // Allow plugins to short-circuit the whole function
\r
801 $pre = yourls_apply_filter( 'shunt_log_redirect', false, $keyword );
\r
802 if ( false !== $pre )
\r
805 if ( !yourls_do_log_redirect() )
\r
809 $table = YOURLS_DB_TABLE_LOG;
\r
811 $keyword = yourls_sanitize_string( $keyword );
\r
812 $referrer = ( isset( $_SERVER['HTTP_REFERER'] ) ? yourls_sanitize_url( $_SERVER['HTTP_REFERER'] ) : 'direct' );
\r
813 $ua = yourls_get_user_agent();
\r
814 $ip = yourls_get_IP();
\r
815 $location = yourls_geo_ip_to_countrycode( $ip );
\r
817 return $ydb->query( "INSERT INTO `$table` (click_time, shorturl, referrer, user_agent, ip_address, country_code) VALUES (NOW(), '$keyword', '$referrer', '$ua', '$ip', '$location')" );
\r
820 // Check if we want to not log redirects (for stats)
\r
821 function yourls_do_log_redirect() {
\r
822 return ( !defined( 'YOURLS_NOSTATS' ) || YOURLS_NOSTATS != true );
\r
825 // Converts an IP to a 2 letter country code, using GeoIP database if available in includes/geo/
\r
826 function yourls_geo_ip_to_countrycode( $ip = '', $default = '' ) {
\r
827 // Allow plugins to short-circuit the Geo IP API
\r
828 $location = yourls_apply_filter( 'shunt_geo_ip_to_countrycode', false, $ip, $default ); // at this point $ip can be '', check if your plugin hooks in here
\r
829 if ( false !== $location )
\r
832 if ( !file_exists( YOURLS_INC.'/geo/GeoIP.dat') || !file_exists( YOURLS_INC.'/geo/geoip.inc') )
\r
836 $ip = yourls_get_IP();
\r
838 require_once( YOURLS_INC.'/geo/geoip.inc') ;
\r
839 $gi = geoip_open( YOURLS_INC.'/geo/GeoIP.dat', GEOIP_STANDARD);
\r
840 $location = geoip_country_code_by_addr($gi, $ip);
\r
843 return yourls_apply_filter( 'geo_ip_to_countrycode', $location, $ip, $default );
\r
846 // Converts a 2 letter country code to long name (ie AU -> Australia)
\r
847 function yourls_geo_countrycode_to_countryname( $code ) {
\r
848 // Allow plugins to short-circuit the Geo IP API
\r
849 $country = yourls_apply_filter( 'shunt_geo_countrycode_to_countryname', false, $code );
\r
850 if ( false !== $country )
\r
853 // Load the Geo class if not already done
\r
854 if( !class_exists( 'GeoIP' ) ) {
\r
855 $temp = yourls_geo_ip_to_countrycode( '127.0.0.1' );
\r
858 if( class_exists( 'GeoIP' ) ) {
\r
860 $id = $geo->GEOIP_COUNTRY_CODE_TO_NUMBER[ $code ];
\r
861 $long = $geo->GEOIP_COUNTRY_NAMES[ $id ];
\r
868 // Return flag URL from 2 letter country code
\r
869 function yourls_geo_get_flag( $code ) {
\r
870 if( file_exists( YOURLS_INC.'/geo/flags/flag_'.strtolower($code).'.gif' ) ) {
\r
871 $img = yourls_match_current_protocol( YOURLS_SITE.'/includes/geo/flags/flag_'.( strtolower( $code ) ).'.gif' );
\r
875 return yourls_apply_filter( 'geo_get_flag', $img, $code );
\r
879 // Check if an upgrade is needed
\r
880 function yourls_upgrade_is_needed() {
\r
881 // check YOURLS_DB_VERSION exist && match values stored in YOURLS_DB_TABLE_OPTIONS
\r
882 list( $currentver, $currentsql ) = yourls_get_current_version_from_sql();
\r
883 if( $currentsql < YOURLS_DB_VERSION )
\r
889 // Get current version & db version as stored in the options DB. Prior to 1.4 there's no option table.
\r
890 function yourls_get_current_version_from_sql() {
\r
891 $currentver = yourls_get_option( 'version' );
\r
892 $currentsql = yourls_get_option( 'db_version' );
\r
894 // Values if version is 1.3
\r
896 $currentver = '1.3';
\r
898 $currentsql = '100';
\r
900 return array( $currentver, $currentsql);
\r
903 // Read an option from DB (or from cache if available). Return value or $default if not found
\r
904 function yourls_get_option( $option_name, $default = false ) {
\r
907 // Allow plugins to short-circuit options
\r
908 $pre = yourls_apply_filter( 'shunt_option_'.$option_name, false );
\r
909 if ( false !== $pre )
\r
912 // If option not cached already, get its value from the DB
\r
913 if ( !isset( $ydb->option[$option_name] ) ) {
\r
914 $table = YOURLS_DB_TABLE_OPTIONS;
\r
915 $option_name = yourls_escape( $option_name );
\r
916 $row = $ydb->get_row( "SELECT `option_value` FROM `$table` WHERE `option_name` = '$option_name' LIMIT 1" );
\r
917 if ( is_object( $row) ) { // Has to be get_row instead of get_var because of funkiness with 0, false, null values
\r
918 $value = $row->option_value;
\r
919 } else { // option does not exist, so we must cache its non-existence
\r
922 $ydb->option[ $option_name ] = yourls_maybe_unserialize( $value );
\r
925 return yourls_apply_filter( 'get_option_'.$option_name, $ydb->option[$option_name] );
\r
928 // Read all options from DB at once
\r
929 function yourls_get_all_options() {
\r
932 // Allow plugins to short-circuit all options. (Note: regular plugins are loaded after all options)
\r
933 $pre = yourls_apply_filter( 'shunt_all_options', false );
\r
934 if ( false !== $pre )
\r
937 $table = YOURLS_DB_TABLE_OPTIONS;
\r
939 $allopt = $ydb->get_results( "SELECT `option_name`, `option_value` FROM `$table` WHERE 1=1" );
\r
941 foreach( (array)$allopt as $option ) {
\r
942 $ydb->option[$option->option_name] = yourls_maybe_unserialize( $option->option_value );
\r
945 $ydb->option = yourls_apply_filter( 'get_all_options', $ydb->option );
\r
948 // Update (add if doesn't exist) an option to DB
\r
949 function yourls_update_option( $option_name, $newvalue ) {
\r
951 $table = YOURLS_DB_TABLE_OPTIONS;
\r
953 $safe_option_name = yourls_escape( $option_name );
\r
955 $oldvalue = yourls_get_option( $safe_option_name );
\r
957 // If the new and old values are the same, no need to update.
\r
958 if ( $newvalue === $oldvalue )
\r
961 if ( false === $oldvalue ) {
\r
962 yourls_add_option( $option_name, $newvalue );
\r
966 $_newvalue = yourls_escape( yourls_maybe_serialize( $newvalue ) );
\r
968 yourls_do_action( 'update_option', $option_name, $oldvalue, $newvalue );
\r
970 $ydb->query( "UPDATE `$table` SET `option_value` = '$_newvalue' WHERE `option_name` = '$option_name'" );
\r
972 if ( $ydb->rows_affected == 1 ) {
\r
973 $ydb->option[ $option_name ] = $newvalue;
\r
979 // Add an option to the DB
\r
980 function yourls_add_option( $name, $value = '' ) {
\r
982 $table = YOURLS_DB_TABLE_OPTIONS;
\r
983 $safe_name = yourls_escape( $name );
\r
985 // Make sure the option doesn't already exist
\r
986 if ( false !== yourls_get_option( $safe_name ) )
\r
989 $_value = yourls_escape( yourls_maybe_serialize( $value ) );
\r
991 yourls_do_action( 'add_option', $safe_name, $_value );
\r
993 $ydb->query( "INSERT INTO `$table` (`option_name`, `option_value`) VALUES ('$name', '$_value')" );
\r
994 $ydb->option[ $name ] = $value;
\r
999 // Delete an option from the DB
\r
1000 function yourls_delete_option( $name ) {
\r
1002 $table = YOURLS_DB_TABLE_OPTIONS;
\r
1003 $name = yourls_escape( $name );
\r
1005 // Get the ID, if no ID then return
\r
1006 $option = $ydb->get_row( "SELECT option_id FROM `$table` WHERE `option_name` = '$name'" );
\r
1007 if ( is_null( $option ) || !$option->option_id )
\r
1010 yourls_do_action( 'delete_option', $option_name );
\r
1012 $ydb->query( "DELETE FROM `$table` WHERE `option_name` = '$name'" );
\r
1018 // Serialize data if needed. Stolen from WordPress
\r
1019 function yourls_maybe_serialize( $data ) {
\r
1020 if ( is_array( $data ) || is_object( $data ) )
\r
1021 return serialize( $data );
\r
1023 if ( yourls_is_serialized( $data ) )
\r
1024 return serialize( $data );
\r
1029 // Check value to find if it was serialized. Stolen from WordPress
\r
1030 function yourls_is_serialized( $data ) {
\r
1031 // if it isn't a string, it isn't serialized
\r
1032 if ( !is_string( $data ) )
\r
1034 $data = trim( $data );
\r
1035 if ( 'N;' == $data )
\r
1037 if ( !preg_match( '/^([adObis]):/', $data, $badions ) )
\r
1039 switch ( $badions[1] ) {
\r
1043 if ( preg_match( "/^{$badions[1]}:[0-9]+:.*[;}]\$/s", $data ) )
\r
1049 if ( preg_match( "/^{$badions[1]}:[0-9.E-]+;\$/", $data ) )
\r
1056 // Unserialize value only if it was serialized. Stolen from WP
\r
1057 function yourls_maybe_unserialize( $original ) {
\r
1058 if ( yourls_is_serialized( $original ) ) // don't attempt to unserialize data that wasn't serialized going in
\r
1059 return @unserialize( $original );
\r
1063 // Determine if the current page is private
\r
1064 function yourls_is_private() {
\r
1067 if ( defined('YOURLS_PRIVATE') && YOURLS_PRIVATE == true ) {
\r
1069 // Allow overruling for particular pages:
\r
1072 if( yourls_is_API() ) {
\r
1073 if( !defined('YOURLS_PRIVATE_API') || YOURLS_PRIVATE_API != false )
\r
1077 } elseif( yourls_is_infos() ) {
\r
1078 if( !defined('YOURLS_PRIVATE_INFOS') || YOURLS_PRIVATE_INFOS !== false )
\r
1088 return yourls_apply_filter( 'is_private', $private );
\r
1091 // Show login form if required
\r
1092 function yourls_maybe_require_auth() {
\r
1093 if( yourls_is_private() )
\r
1094 require_once( YOURLS_INC.'/auth.php' );
\r
1097 // Allow several short URLs for the same long URL ?
\r
1098 function yourls_allow_duplicate_longurls() {
\r
1099 // special treatment if API to check for WordPress plugin requests
\r
1100 if( yourls_is_API() ) {
\r
1101 if ( isset($_REQUEST['source']) && $_REQUEST['source'] == 'plugin' )
\r
1104 return ( defined( 'YOURLS_UNIQUE_URLS' ) && YOURLS_UNIQUE_URLS == false );
\r
1107 // Return list of all shorturls associated to the same long URL. Returns NULL or array of keywords.
\r
1108 function yourls_get_duplicate_keywords( $longurl ) {
\r
1109 if( !yourls_allow_duplicate_longurls() )
\r
1113 $longurl = yourls_escape( yourls_sanitize_url($longurl) );
\r
1114 $table = YOURLS_DB_TABLE_URL;
\r
1116 $return = $ydb->get_col( "SELECT `keyword` FROM `$table` WHERE `url` = '$longurl'" );
\r
1117 return yourls_apply_filter( 'get_duplicate_keywords', $return, $longurl );
\r
1120 // Check if an IP shortens URL too fast to prevent DB flood. Return true, or die.
\r
1121 function yourls_check_IP_flood( $ip = '' ) {
\r
1123 // Allow plugins to short-circuit the whole function
\r
1124 $pre = yourls_apply_filter( 'shunt_check_IP_flood', false, $ip );
\r
1125 if ( false !== $pre )
\r
1128 yourls_do_action( 'pre_check_ip_flood', $ip ); // at this point $ip can be '', check it if your plugin hooks in here
\r
1131 ( defined('YOURLS_FLOOD_DELAY_SECONDS') && YOURLS_FLOOD_DELAY_SECONDS === 0 ) ||
\r
1132 !defined('YOURLS_FLOOD_DELAY_SECONDS')
\r
1136 $ip = ( $ip ? yourls_sanitize_ip( $ip ) : yourls_get_IP() );
\r
1138 // Don't throttle whitelist IPs
\r
1139 if( defined( 'YOURLS_FLOOD_IP_WHITELIST' ) && YOURLS_FLOOD_IP_WHITELIST ) {
\r
1140 $whitelist_ips = explode( ',', YOURLS_FLOOD_IP_WHITELIST );
\r
1141 foreach( (array)$whitelist_ips as $whitelist_ip ) {
\r
1142 $whitelist_ip = trim( $whitelist_ip );
\r
1143 if ( $whitelist_ip == $ip )
\r
1148 // Don't throttle logged in users
\r
1149 if( yourls_is_private() ) {
\r
1150 if( yourls_is_valid_user() === true )
\r
1154 yourls_do_action( 'check_ip_flood', $ip );
\r
1157 $table = YOURLS_DB_TABLE_URL;
\r
1159 $lasttime = $ydb->get_var( "SELECT `timestamp` FROM $table WHERE `ip` = '$ip' ORDER BY `timestamp` DESC LIMIT 1" );
\r
1161 $now = date( 'U' );
\r
1162 $then = date( 'U', strtotime( $lasttime ) );
\r
1163 if( ( $now - $then ) <= YOURLS_FLOOD_DELAY_SECONDS ) {
\r
1165 yourls_do_action( 'ip_flood', $ip, $now - $then );
\r
1166 yourls_die( 'Too many URLs added too fast. Slow down please.', 'Forbidden', 403 );
\r
1173 // Check if YOURLS is installed
\r
1174 function yourls_is_installed() {
\r
1175 static $is_installed = false;
\r
1176 if ( $is_installed === false ) {
\r
1177 $check_14 = $check_13 = false;
\r
1179 if( defined('YOURLS_DB_TABLE_NEXTDEC') )
\r
1180 $check_13 = $ydb->get_var('SELECT `next_id` FROM '.YOURLS_DB_TABLE_NEXTDEC);
\r
1181 $check_14 = yourls_get_option( 'version' );
\r
1182 $is_installed = $check_13 || $check_14;
\r
1184 return yourls_apply_filter( 'is_installed', $is_installed );
\r
1187 // Generate random string of (int)$length length and type $type (see function for details)
\r
1188 function yourls_rnd_string ( $length = 5, $type = 0, $charlist = '' ) {
\r
1190 $length = intval( $length );
\r
1192 // define possible characters
\r
1193 switch ( $type ) {
\r
1195 // custom char list, or comply to charset as defined in config
\r
1197 $possible = $charlist ? $charlist : yourls_get_shorturl_charset() ;
\r
1200 // no vowels to make no offending word, no 0/1/o/l to avoid confusion between letters & digits. Perfect for passwords.
\r
1202 $possible = "23456789bcdfghjkmnpqrstvwxyz";
\r
1205 // Same, with lower + upper
\r
1207 $possible = "23456789bcdfghjkmnpqrstvwxyzBCDFGHJKMNPQRSTVWXYZ";
\r
1210 // all letters, lowercase
\r
1212 $possible = "abcdefghijklmnopqrstuvwxyz";
\r
1215 // all letters, lowercase + uppercase
\r
1217 $possible = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
\r
1220 // all digits & letters lowercase
\r
1222 $possible = "0123456789abcdefghijklmnopqrstuvwxyz";
\r
1225 // all digits & letters lowercase + uppercase
\r
1227 $possible = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
\r
1233 while ($i < $length) {
\r
1234 $str .= substr($possible, mt_rand(0, strlen($possible)-1), 1);
\r
1238 return yourls_apply_filter( 'rnd_string', $str, $length, $type, $charlist );
\r
1241 // Return salted string
\r
1242 function yourls_salt( $string ) {
\r
1243 $salt = defined('YOURLS_COOKIEKEY') ? YOURLS_COOKIEKEY : md5(__FILE__) ;
\r
1244 return yourls_apply_filter( 'yourls_salt', md5 ($string . $salt), $string );
\r
1247 // Add a query var to a URL and return URL. Completely stolen from WP.
\r
1248 // Works with one of these parameter patterns:
\r
1249 // array( 'var' => 'value' )
\r
1250 // array( 'var' => 'value' ), $url
\r
1252 // 'var', 'value', $url
\r
1253 // If $url ommited, uses $_SERVER['REQUEST_URI']
\r
1254 function yourls_add_query_arg() {
\r
1256 if ( is_array( func_get_arg(0) ) ) {
\r
1257 if ( @func_num_args() < 2 || false === @func_get_arg( 1 ) )
\r
1258 $uri = $_SERVER['REQUEST_URI'];
\r
1260 $uri = @func_get_arg( 1 );
\r
1262 if ( @func_num_args() < 3 || false === @func_get_arg( 2 ) )
\r
1263 $uri = $_SERVER['REQUEST_URI'];
\r
1265 $uri = @func_get_arg( 2 );
\r
1268 $uri = str_replace( '&', '&', $uri );
\r
1271 if ( $frag = strstr( $uri, '#' ) )
\r
1272 $uri = substr( $uri, 0, -strlen( $frag ) );
\r
1276 if ( preg_match( '|^https?://|i', $uri, $matches ) ) {
\r
1277 $protocol = $matches[0];
\r
1278 $uri = substr( $uri, strlen( $protocol ) );
\r
1283 if ( strpos( $uri, '?' ) !== false ) {
\r
1284 $parts = explode( '?', $uri, 2 );
\r
1285 if ( 1 == count( $parts ) ) {
\r
1287 $query = $parts[0];
\r
1289 $base = $parts[0] . '?';
\r
1290 $query = $parts[1];
\r
1292 } elseif ( !empty( $protocol ) || strpos( $uri, '=' ) === false ) {
\r
1293 $base = $uri . '?';
\r
1300 parse_str( $query, $qs );
\r
1301 $qs = yourls_urlencode_deep( $qs ); // this re-URL-encodes things that were already in the query string
\r
1302 if ( is_array( func_get_arg( 0 ) ) ) {
\r
1303 $kayvees = func_get_arg( 0 );
\r
1304 $qs = array_merge( $qs, $kayvees );
\r
1306 $qs[func_get_arg( 0 )] = func_get_arg( 1 );
\r
1309 foreach ( (array) $qs as $k => $v ) {
\r
1310 if ( $v === false )
\r
1314 $ret = http_build_query( $qs );
\r
1315 $ret = trim( $ret, '?' );
\r
1316 $ret = preg_replace( '#=(&|$)#', '$1', $ret );
\r
1317 $ret = $protocol . $base . $ret . $frag;
\r
1318 $ret = rtrim( $ret, '?' );
\r
1322 // Navigates through an array and encodes the values to be used in a URL. Stolen from WP, used in yourls_add_query_arg()
\r
1323 function yourls_urlencode_deep( $value ) {
\r
1324 $value = is_array( $value ) ? array_map( 'yourls_urlencode_deep', $value ) : urlencode( $value );
\r
1328 // Remove arg from query. Opposite of yourls_add_query_arg. Stolen from WP.
\r
1329 function yourls_remove_query_arg( $key, $query = false ) {
\r
1330 if ( is_array( $key ) ) { // removing multiple keys
\r
1331 foreach ( $key as $k )
\r
1332 $query = yourls_add_query_arg( $k, false, $query );
\r
1335 return yourls_add_query_arg( $key, false, $query );
\r
1338 // Return a time-dependent string for nonce creation
\r
1339 function yourls_tick() {
\r
1340 return ceil( time() / YOURLS_NONCE_LIFE );
\r
1343 // Create a time limited, action limited and user limited token
\r
1344 function yourls_create_nonce( $action, $user = false ) {
\r
1345 if( false == $user )
\r
1346 $user = defined( 'YOURLS_USER' ) ? YOURLS_USER : '-1';
\r
1347 $tick = yourls_tick();
\r
1348 return substr( yourls_salt($tick . $action . $user), 0, 10 );
\r
1351 // Create a nonce field for inclusion into a form
\r
1352 function yourls_nonce_field( $action, $name = 'nonce', $user = false, $echo = true ) {
\r
1353 $field = '<input type="hidden" id="'.$name.'" name="'.$name.'" value="'.yourls_create_nonce( $action, $user ).'" />';
\r
1359 // Add a nonce to a URL. If URL omitted, adds nonce to current URL
\r
1360 function yourls_nonce_url( $action, $url = false, $name = 'nonce', $user = false ) {
\r
1361 $nonce = yourls_create_nonce( $action, $user );
\r
1362 return yourls_add_query_arg( $name, $nonce, $url );
\r
1365 // Check validity of a nonce (ie time span, user and action match).
\r
1366 // Returns true if valid, dies otherwise (yourls_die() or die($return) if defined)
\r
1367 // if $nonce is false or unspecified, it will use $_REQUEST['nonce']
\r
1368 function yourls_verify_nonce( $action, $nonce = false, $user = false, $return = '' ) {
\r
1370 if( false == $user )
\r
1371 $user = defined( 'YOURLS_USER' ) ? YOURLS_USER : '-1';
\r
1373 // get current nonce value
\r
1374 if( false == $nonce && isset( $_REQUEST['nonce'] ) )
\r
1375 $nonce = $_REQUEST['nonce'];
\r
1377 // what nonce should be
\r
1378 $valid = yourls_create_nonce( $action, $user );
\r
1380 if( $nonce == $valid ) {
\r
1385 yourls_die( 'Unauthorized action or expired link', 'Error', 403 );
\r
1389 // Converts keyword into short link (prepend with YOURLS base URL)
\r
1390 function yourls_link( $keyword = '' ) {
\r
1391 $link = YOURLS_SITE . '/' . yourls_sanitize_keyword( $keyword );
\r
1392 return yourls_apply_filter( 'yourls_link', $link, $keyword );
\r
1395 // Converts keyword into stat link (prepend with YOURLS base URL, append +)
\r
1396 function yourls_statlink( $keyword = '' ) {
\r
1397 $link = YOURLS_SITE . '/' . yourls_sanitize_keyword( $keyword ) . '+';
\r
1398 return yourls_apply_filter( 'yourls_statlink', $link, $keyword );
\r
1401 // Check if we're in API mode. Returns bool
\r
1402 function yourls_is_API() {
\r
1403 if ( defined( 'YOURLS_API' ) && YOURLS_API == true )
\r
1408 // Check if we're in Ajax mode. Returns bool
\r
1409 function yourls_is_Ajax() {
\r
1410 if ( defined( 'YOURLS_AJAX' ) && YOURLS_AJAX == true )
\r
1415 // Check if we're in GO mode (yourls-go.php). Returns bool
\r
1416 function yourls_is_GO() {
\r
1417 if ( defined( 'YOURLS_GO' ) && YOURLS_GO == true )
\r
1422 // Check if we're displaying stats infos (yourls-infos.php). Returns bool
\r
1423 function yourls_is_infos() {
\r
1424 if ( defined( 'YOURLS_INFOS' ) && YOURLS_INFOS == true )
\r
1429 // Check if we'll need interface display function (ie not API or redirection)
\r
1430 function yourls_has_interface() {
\r
1431 if( yourls_is_API() or yourls_is_GO() )
\r
1436 // Check if we're in the admin area. Returns bool
\r
1437 function yourls_is_admin() {
\r
1438 if ( defined( 'YOURLS_ADMIN' ) && YOURLS_ADMIN == true )
\r
1443 // Check if the server seems to be running on Windows. Not exactly sure how reliable this is.
\r
1444 function yourls_is_windows() {
\r
1445 return defined( 'DIRECTORY_SEPARATOR' ) && DIRECTORY_SEPARATOR == '\\';
\r
1448 // Check if SSL is required. Returns bool.
\r
1449 function yourls_needs_ssl() {
\r
1450 if ( defined('YOURLS_ADMIN_SSL') && YOURLS_ADMIN_SSL == true )
\r
1455 // Return admin link, with SSL preference if applicable.
\r
1456 function yourls_admin_url( $page = '' ) {
\r
1457 $admin = YOURLS_SITE . '/admin/' . $page;
\r
1458 if( yourls_is_ssl() or yourls_needs_ssl() )
\r
1459 $admin = str_replace('http://', 'https://', $admin);
\r
1460 return yourls_apply_filter( 'admin_url', $admin, $page );
\r
1463 // Return YOURLS_SITE or URL under YOURLS setup, with SSL preference
\r
1464 function yourls_site_url( $echo = true, $url = '' ) {
\r
1466 $url = YOURLS_SITE;
\r
1468 // make $url relative to YOURLS base in case a full URL has been provided. Will break if user mixes https/http.
\r
1469 $url = str_replace( YOURLS_SITE, '', $url );
\r
1470 $url = YOURLS_SITE . '/' . ltrim( $url, '/' );
\r
1472 // Do not enforce (checking yourls_need_ssl() ) but check current usage so it won't force SSL on non-admin pages
\r
1473 if( yourls_is_ssl() )
\r
1474 $url = str_replace( 'http://', 'https://', $url );
\r
1475 $url = yourls_apply_filter( 'site_url', $url );
\r
1481 // Check if SSL is used, returns bool. Stolen from WP.
\r
1482 function yourls_is_ssl() {
\r
1484 if ( isset( $_SERVER['HTTPS'] ) ) {
\r
1485 if ( 'on' == strtolower( $_SERVER['HTTPS'] ) )
\r
1487 if ( '1' == $_SERVER['HTTPS'] )
\r
1489 } elseif ( isset( $_SERVER['SERVER_PORT'] ) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
\r
1492 return yourls_apply_filter( 'is_ssl', $is_ssl );
\r
1496 // Get a remote page <title>, return a string (either title or url)
\r
1497 function yourls_get_remote_title( $url ) {
\r
1498 // Allow plugins to short-circuit the whole function
\r
1499 $pre = yourls_apply_filter( 'shunt_get_remote_title', false, $url );
\r
1500 if ( false !== $pre )
\r
1503 require_once( YOURLS_INC.'/functions-http.php' );
\r
1505 $url = yourls_sanitize_url( $url );
\r
1507 $title = $charset = false;
\r
1509 $content = yourls_get_remote_content( $url );
\r
1511 // If false, return url as title.
\r
1512 // Todo: improve this with temporary title when shorturl_meta available?
\r
1513 if( false === $content )
\r
1516 if( $content !== false ) {
\r
1517 // look for <title>
\r
1518 if ( preg_match('/<title>(.*?)<\/title>/is', $content, $found ) ) {
\r
1519 $title = $found[1];
\r
1523 // look for charset
\r
1524 // <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
\r
1525 if ( preg_match('/<meta[^>]*?charset=([^>]*?)\/?>/is', $content, $found ) ) {
\r
1526 $charset = trim($found[1], '"\' ');
\r
1531 // if title not found, guess if returned content was actually an error message
\r
1532 if( $title == false && strpos( $content, 'Error' ) === 0 ) {
\r
1533 $title = $content;
\r
1536 if( $title == false )
\r
1540 if( !yourls_seems_utf8( $title ) )
\r
1541 $title = utf8_encode( $title );
\r
1544 // Charset conversion. We use @ to remove warnings (mb_ functions are easily bitching about illegal chars)
\r
1545 if( function_exists( 'mb_convert_encoding' ) ) {
\r
1547 $title = @mb_convert_encoding( $title, 'UTF-8', $charset );
\r
1549 $title = @mb_convert_encoding( $title, 'UTF-8' );
\r
1553 // Remove HTML entities
\r
1554 $title = html_entity_decode( $title, ENT_QUOTES, 'UTF-8' );
\r
1556 // Strip out evil things
\r
1557 $title = yourls_sanitize_title( $title );
\r
1559 return yourls_apply_filter( 'get_remote_title', $title, $url );
\r
1562 // Check for maintenance mode that will shortcut everything
\r
1563 function yourls_check_maintenance_mode() {
\r
1565 // TODO: all cases that always display the sites (is_admin but not is_ajax?)
\r
1569 // first case: /user/maintenance.php file
\r
1570 if( file_exists( YOURLS_USERDIR.'/maintenance.php' ) ) {
\r
1571 include( YOURLS_USERDIR.'/maintenance.php' );
\r
1575 // second case: option in DB
\r
1576 if( yourls_get_option( 'maintenance_mode' ) !== false ) {
\r
1577 require_once( YOURLS_INC.'/functions-html.php' );
\r
1578 $title = 'Service temporarily unavailable';
\r
1579 $message = 'Our service is currently undergoing scheduled maintenance.</p>
\r
1580 <p>Things should not last very long, thank you for your patience and please excuse the inconvenience';
\r
1581 yourls_die( $message, $title , 503 );
\r
1586 // Toggle maintenance mode
\r
1587 function yourls_maintenance_mode( $maintenance = true ) {
\r
1588 yourls_update_option( 'maintenance_mode', (bool)$maintenance );
\r
1591 // Quick UA check for mobile devices. Return boolean.
\r
1592 function yourls_is_mobile_device() {
\r
1593 // Strings searched
\r
1595 'android', 'blackberry', 'blazer',
\r
1596 'compal', 'elaine', 'fennec', 'hiptop',
\r
1597 'iemobile', 'iphone', 'ipod', 'ipad',
\r
1598 'iris', 'kindle', 'opera mobi', 'opera mini',
\r
1599 'palm', 'phone', 'pocket', 'psp', 'symbian',
\r
1600 'treo', 'wap', 'windows ce', 'windows phone'
\r
1603 // Current user-agent
\r
1604 $current = strtolower( $_SERVER['HTTP_USER_AGENT'] );
\r
1606 // Check and return
\r
1607 $is_mobile = ( str_replace( $mobiles, '', $current ) != $current );
\r
1608 return yourls_apply_filter( 'is_mobile_device', $is_mobile );
\r
1611 // Get request in YOURLS base (eg in 'http://site.com/yourls/abcd' get 'abdc')
\r
1612 function yourls_get_request() {
\r
1613 // Allow plugins to short-circuit the whole function
\r
1614 $pre = yourls_apply_filter( 'shunt_get_request', false );
\r
1615 if ( false !== $pre )
\r
1618 yourls_do_action( 'pre_get_request' );
\r
1620 // Ignore protocol & www. prefix
\r
1621 $root = str_replace( array( 'https://', 'http://', 'https://www.', 'http://www.' ), '', YOURLS_SITE );
\r
1622 // Case insensitive comparison of the YOURLS root to match both http://Sho.rt/blah and http://sho.rt/blah
\r
1623 $request = preg_replace( "!$root/!i", '', $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
\r
1625 // Unless request looks like a full URL (ie request is a simple keyword) strip query string
\r
1626 if( !preg_match( "@^[a-zA-Z]+://.+@", $request ) ) {
\r
1627 $request = current( explode( '?', $request ) );
\r
1630 return yourls_apply_filter( 'get_request', $request );
\r
1633 // Change protocol to match current scheme used (http or https)
\r
1634 function yourls_match_current_protocol( $url, $normal = 'http', $ssl = 'https' ) {
\r
1635 if( yourls_is_ssl() )
\r
1636 $url = str_replace( $normal, $ssl, $url );
\r
1637 return yourls_apply_filter( 'match_current_protocol', $url );
\r
1640 // Fix $_SERVER['REQUEST_URI'] variable for various setups. Stolen from WP.
\r
1641 function yourls_fix_request_uri() {
\r
1643 $default_server_values = array(
\r
1644 'SERVER_SOFTWARE' => '',
\r
1645 'REQUEST_URI' => '',
\r
1647 $_SERVER = array_merge( $default_server_values, $_SERVER );
\r
1649 // Fix for IIS when running with PHP ISAPI
\r
1650 if ( empty( $_SERVER['REQUEST_URI'] ) || ( php_sapi_name() != 'cgi-fcgi' && preg_match( '/^Microsoft-IIS\//', $_SERVER['SERVER_SOFTWARE'] ) ) ) {
\r
1652 // IIS Mod-Rewrite
\r
1653 if ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] ) ) {
\r
1654 $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_ORIGINAL_URL'];
\r
1656 // IIS Isapi_Rewrite
\r
1657 else if ( isset( $_SERVER['HTTP_X_REWRITE_URL'] ) ) {
\r
1658 $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_REWRITE_URL'];
\r
1660 // Use ORIG_PATH_INFO if there is no PATH_INFO
\r
1661 if ( !isset( $_SERVER['PATH_INFO'] ) && isset( $_SERVER['ORIG_PATH_INFO'] ) )
\r
1662 $_SERVER['PATH_INFO'] = $_SERVER['ORIG_PATH_INFO'];
\r
1664 // Some IIS + PHP configurations puts the script-name in the path-info (No need to append it twice)
\r
1665 if ( isset( $_SERVER['PATH_INFO'] ) ) {
\r
1666 if ( $_SERVER['PATH_INFO'] == $_SERVER['SCRIPT_NAME'] )
\r
1667 $_SERVER['REQUEST_URI'] = $_SERVER['PATH_INFO'];
\r
1669 $_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME'] . $_SERVER['PATH_INFO'];
\r
1672 // Append the query string if it exists and isn't null
\r
1673 if ( ! empty( $_SERVER['QUERY_STRING'] ) ) {
\r
1674 $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING'];
\r
1680 // Shutdown function, runs just before PHP shuts down execution. Stolen from WP
\r
1681 function yourls_shutdown() {
\r
1682 yourls_do_action( 'shutdown' );
\r
1685 // Auto detect custom favicon in /user directory, fallback to YOURLS favicon, and echo/return its URL
\r
1686 function yourls_favicon( $echo = true ) {
\r
1687 static $favicon = null;
\r
1688 if( $favicon !== null )
\r
1692 // search for favicon.(gif|ico|png|jpg|svg)
\r
1693 foreach( array( 'gif', 'ico', 'png', 'jpg', 'svg' ) as $ext ) {
\r
1694 if( file_exists( YOURLS_USERDIR. '/favicon.' . $ext ) ) {
\r
1695 $custom = 'favicon.' . $ext;
\r
1701 $favicon = yourls_site_url( false, YOURLS_USERURL . '/' . $custom );
\r
1703 $favicon = yourls_site_url( false ) . '/images/favicon.gif';
\r