8 * Determine the allowed character set in short URLs
11 function yourls_get_shorturl_charset() {
12 static $charset = null;
13 if( $charset !== null )
16 if( !defined('YOURLS_URL_CONVERT') ) {
17 $charset = '0123456789abcdefghijklmnopqrstuvwxyz';
19 switch( YOURLS_URL_CONVERT ) {
21 $charset = '0123456789abcdefghijklmnopqrstuvwxyz';
24 case 64: // just because some people get this wrong in their config.php
25 $charset = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
30 $charset = yourls_apply_filter( 'get_shorturl_charset', $charset );
35 * Make an optimized regexp pattern from a string of characters
38 function yourls_make_regexp_pattern( $string ) {
39 $pattern = preg_quote( $string, '-' ); // add - as an escaped characters -- this is fixed in PHP 5.3
40 // TODO: replace char sequences by smart sequences such as 0-9, a-z, A-Z ... ?
45 * Is a URL a short URL?
48 function yourls_is_shorturl( $shorturl ) {
49 // TODO: make sure this function evolves with the feature set.
52 $keyword = yourls_get_relative_url( $shorturl ); // accept either 'http://ozh.in/abc' or 'abc'
53 if( $keyword && $keyword == yourls_sanitize_string( $keyword ) && yourls_keyword_is_taken( $keyword ) ) {
57 return yourls_apply_filter( 'is_shorturl', $is_short, $shorturl );
61 * Check to see if a given keyword is reserved (ie reserved URL or an existing page). Returns bool
64 function yourls_keyword_is_reserved( $keyword ) {
65 global $yourls_reserved_URL;
66 $keyword = yourls_sanitize_keyword( $keyword );
69 if ( in_array( $keyword, $yourls_reserved_URL)
70 or file_exists( YOURLS_ABSPATH ."/pages/$keyword.php" )
71 or is_dir( YOURLS_ABSPATH ."/$keyword" )
75 return yourls_apply_filter( 'keyword_is_reserved', $reserved, $keyword );
79 * Function: Get client IP Address. Returns a DB safe string.
82 function yourls_get_IP() {
83 // Precedence: if set, X-Forwarded-For > HTTP_X_FORWARDED_FOR > HTTP_CLIENT_IP > HTTP_VIA > REMOTE_ADDR
84 $headers = array( 'X-Forwarded-For', 'HTTP_X_FORWARDED_FOR', 'HTTP_CLIENT_IP', 'HTTP_VIA', 'REMOTE_ADDR' );
85 foreach( $headers as $header ) {
86 if ( !empty( $_SERVER[ $header ] ) ) {
87 $ip = $_SERVER[ $header ];
92 // headers can contain multiple IPs (X-Forwarded-For = client, proxy1, proxy2). Take first one.
93 if ( strpos( $ip, ',' ) !== false )
94 $ip = substr( $ip, 0, strpos( $ip, ',' ) );
96 return yourls_apply_filter( 'get_IP', yourls_sanitize_ip( $ip ) );
100 * Get next id a new link will have if no custom keyword provided
103 function yourls_get_next_decimal() {
104 return yourls_apply_filter( 'get_next_decimal', (int)yourls_get_option( 'next_id' ) );
108 * Update id for next link with no custom keyword
111 function yourls_update_next_decimal( $int = '' ) {
112 $int = ( $int == '' ) ? yourls_get_next_decimal() + 1 : (int)$int ;
113 $update = yourls_update_option( 'next_id', $int );
114 yourls_do_action( 'update_next_decimal', $int, $update );
119 * Delete a link in the DB
122 function yourls_delete_link_by_keyword( $keyword ) {
125 $table = YOURLS_DB_TABLE_URL;
126 $keyword = yourls_sanitize_string( $keyword );
127 $delete = $ydb->query("DELETE FROM `$table` WHERE `keyword` = '$keyword';");
128 yourls_do_action( 'delete_link', $keyword, $delete );
133 * SQL query to insert a new link in the DB. Returns boolean for success or failure of the inserting
136 function yourls_insert_link_in_db( $url, $keyword, $title = '' ) {
139 $url = yourls_escape( yourls_sanitize_url( $url ) );
140 $keyword = yourls_escape( yourls_sanitize_keyword( $keyword ) );
141 $title = yourls_escape( yourls_sanitize_title( $title ) );
143 $table = YOURLS_DB_TABLE_URL;
144 $timestamp = date('Y-m-d H:i:s');
145 $ip = yourls_get_IP();
146 $insert = $ydb->query("INSERT INTO `$table` (`keyword`, `url`, `title`, `timestamp`, `ip`, `clicks`) VALUES('$keyword', '$url', '$title', '$timestamp', '$ip', 0);");
148 yourls_do_action( 'insert_link', (bool)$insert, $url, $keyword, $title, $timestamp, $ip );
150 return (bool)$insert;
154 * Check if a URL already exists in the DB. Return NULL (doesn't exist) or an object with URL informations.
157 function yourls_url_exists( $url ) {
158 // Allow plugins to short-circuit the whole function
159 $pre = yourls_apply_filter( 'shunt_url_exists', false, $url );
160 if ( false !== $pre )
164 $table = YOURLS_DB_TABLE_URL;
165 $strip_url = stripslashes($url);
166 $url_exists = $ydb->get_row("SELECT * FROM `$table` WHERE `url` = '".$strip_url."';");
168 return yourls_apply_filter( 'url_exists', $url_exists, $url );
172 * Add a new link in the DB, either with custom keyword, or find one
175 function yourls_add_new_link( $url, $keyword = '', $title = '' ) {
178 // Allow plugins to short-circuit the whole function
179 $pre = yourls_apply_filter( 'shunt_add_new_link', false, $url, $keyword, $title );
180 if ( false !== $pre )
183 $url = yourls_encodeURI( $url );
184 $url = yourls_escape( yourls_sanitize_url( $url ) );
185 if ( !$url || $url == 'http://' || $url == 'https://' ) {
186 $return['status'] = 'fail';
187 $return['code'] = 'error:nourl';
188 $return['message'] = yourls__( 'Missing or malformed URL' );
189 $return['errorCode'] = '400';
190 return yourls_apply_filter( 'add_new_link_fail_nourl', $return, $url, $keyword, $title );
194 $ip = yourls_get_IP();
195 yourls_check_IP_flood( $ip );
197 // Prevent internal redirection loops: cannot shorten a shortened URL
198 if( yourls_get_relative_url( $url ) ) {
199 if( yourls_is_shorturl( $url ) ) {
200 $return['status'] = 'fail';
201 $return['code'] = 'error:noloop';
202 $return['message'] = yourls__( 'URL is a short URL' );
203 $return['errorCode'] = '400';
204 return yourls_apply_filter( 'add_new_link_fail_noloop', $return, $url, $keyword, $title );
208 yourls_do_action( 'pre_add_new_link', $url, $keyword, $title );
210 $strip_url = stripslashes( $url );
213 // duplicates allowed or new URL => store it
214 if( yourls_allow_duplicate_longurls() || !( $url_exists = yourls_url_exists( $url ) ) ) {
216 if( isset( $title ) && !empty( $title ) ) {
217 $title = yourls_sanitize_title( $title );
219 $title = yourls_get_remote_title( $url );
221 $title = yourls_apply_filter( 'add_new_title', $title, $url, $keyword );
223 // Custom keyword provided
226 yourls_do_action( 'add_new_link_custom_keyword', $url, $keyword, $title );
228 $keyword = yourls_escape( yourls_sanitize_string( $keyword ) );
229 $keyword = yourls_apply_filter( 'custom_keyword', $keyword, $url, $title );
230 if ( !yourls_keyword_is_free( $keyword ) ) {
231 // This shorturl either reserved or taken already
232 $return['status'] = 'fail';
233 $return['code'] = 'error:keyword';
234 $return['message'] = yourls_s( 'Short URL %s already exists in database or is reserved', $keyword );
236 // all clear, store !
237 yourls_insert_link_in_db( $url, $keyword, $title );
238 $return['url'] = array('keyword' => $keyword, 'url' => $strip_url, 'title' => $title, 'date' => date('Y-m-d H:i:s'), 'ip' => $ip );
239 $return['status'] = 'success';
240 $return['message'] = /* //translators: eg "http://someurl/ added to DB" */ yourls_s( '%s added to database', yourls_trim_long_string( $strip_url ) );
241 $return['title'] = $title;
242 $return['html'] = yourls_table_add_row( $keyword, $url, $title, $ip, 0, time() );
243 $return['shorturl'] = YOURLS_SITE .'/'. $keyword;
246 // Create random keyword
249 yourls_do_action( 'add_new_link_create_keyword', $url, $keyword, $title );
251 $timestamp = date( 'Y-m-d H:i:s' );
252 $id = yourls_get_next_decimal();
255 $keyword = yourls_int2string( $id );
256 $keyword = yourls_apply_filter( 'random_keyword', $keyword, $url, $title );
257 $free = yourls_keyword_is_free($keyword);
258 $add_url = @yourls_insert_link_in_db( $url, $keyword, $title );
259 $ok = ($free && $add_url);
260 if ( $ok === false && $add_url === 1 ) {
261 // we stored something, but shouldn't have (ie reserved id)
262 $delete = yourls_delete_link_by_keyword( $keyword );
263 $return['extra_info'] .= '(deleted '.$keyword.')';
265 // everything ok, populate needed vars
266 $return['url'] = array('keyword' => $keyword, 'url' => $strip_url, 'title' => $title, 'date' => $timestamp, 'ip' => $ip );
267 $return['status'] = 'success';
268 $return['message'] = /* //translators: eg "http://someurl/ added to DB" */ yourls_s( '%s added to database', yourls_trim_long_string( $strip_url ) );
269 $return['title'] = $title;
270 $return['html'] = yourls_table_add_row( $keyword, $url, $title, $ip, 0, time() );
271 $return['shorturl'] = YOURLS_SITE .'/'. $keyword;
275 @yourls_update_next_decimal( $id );
278 // URL was already stored
281 yourls_do_action( 'add_new_link_already_stored', $url, $keyword, $title );
283 $return['status'] = 'fail';
284 $return['code'] = 'error:url';
285 $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 );
286 $return['message'] = /* //translators: eg "http://someurl/ already exists" */ yourls_s( '%s already exists in database', yourls_trim_long_string( $strip_url ) );
287 $return['title'] = $url_exists->title;
288 $return['shorturl'] = YOURLS_SITE .'/'. $url_exists->keyword;
291 yourls_do_action( 'post_add_new_link', $url, $keyword, $title );
293 $return['statusCode'] = 200; // regardless of result, this is still a valid request
294 return yourls_apply_filter( 'add_new_link', $return, $url, $keyword, $title );
302 function yourls_edit_link( $url, $keyword, $newkeyword='', $title='' ) {
305 $table = YOURLS_DB_TABLE_URL;
306 $url = yourls_escape (yourls_sanitize_url( $url ) );
307 $keyword = yourls_escape( yourls_sanitize_string( $keyword ) );
308 $title = yourls_escape( yourls_sanitize_title( $title ) );
309 $newkeyword = yourls_escape( yourls_sanitize_string( $newkeyword ) );
310 $strip_url = stripslashes( $url );
311 $strip_title = stripslashes( $title );
312 $old_url = $ydb->get_var( "SELECT `url` FROM `$table` WHERE `keyword` = '$keyword';" );
314 // Check if new URL is not here already
315 if ( $old_url != $url && !yourls_allow_duplicate_longurls() ) {
316 $new_url_already_there = intval($ydb->get_var("SELECT COUNT(keyword) FROM `$table` WHERE `url` = '$strip_url';"));
318 $new_url_already_there = false;
321 // Check if the new keyword is not here already
322 if ( $newkeyword != $keyword ) {
323 $keyword_is_ok = yourls_keyword_is_free( $newkeyword );
325 $keyword_is_ok = true;
328 yourls_do_action( 'pre_edit_link', $url, $keyword, $newkeyword, $new_url_already_there, $keyword_is_ok );
331 if ( ( !$new_url_already_there || yourls_allow_duplicate_longurls() ) && $keyword_is_ok ) {
332 $update_url = $ydb->query( "UPDATE `$table` SET `url` = '$url', `keyword` = '$newkeyword', `title` = '$title' WHERE `keyword` = '$keyword';" );
334 $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 ) );
335 $return['status'] = 'success';
336 $return['message'] = yourls__( 'Link updated in database' );
338 $return['status'] = 'fail';
339 $return['message'] = /* //translators: "Error updating http://someurl/ (Shorturl: http://sho.rt/blah)" */ yourls_s( 'Error updating %s (Short URL: %s)', yourls_trim_long_string( $strip_url ), $keyword ) ;
344 $return['status'] = 'fail';
345 $return['message'] = yourls__( 'URL or keyword already exists in database' );
348 return yourls_apply_filter( 'edit_link', $return, $url, $keyword, $newkeyword, $title, $new_url_already_there, $keyword_is_ok );
352 * Update a title link (no checks for duplicates etc..)
355 function yourls_edit_link_title( $keyword, $title ) {
358 $keyword = yourls_escape( yourls_sanitize_keyword( $keyword ) );
359 $title = yourls_escape( yourls_sanitize_title( $title ) );
361 $table = YOURLS_DB_TABLE_URL;
362 $update = $ydb->query("UPDATE `$table` SET `title` = '$title' WHERE `keyword` = '$keyword';");
369 * Check if keyword id is free (ie not already taken, and not reserved). Return bool.
372 function yourls_keyword_is_free( $keyword ) {
374 if ( yourls_keyword_is_reserved( $keyword ) or yourls_keyword_is_taken( $keyword ) )
377 return yourls_apply_filter( 'keyword_is_free', $free, $keyword );
381 * Check if a keyword is taken (ie there is already a short URL with this id). Return bool.
384 function yourls_keyword_is_taken( $keyword ) {
386 // Allow plugins to short-circuit the whole function
387 $pre = yourls_apply_filter( 'shunt_keyword_is_taken', false, $keyword );
388 if ( false !== $pre )
392 $keyword = yourls_sanitize_keyword( $keyword );
394 $table = YOURLS_DB_TABLE_URL;
395 $already_exists = $ydb->get_var( "SELECT COUNT(`keyword`) FROM `$table` WHERE `keyword` = '$keyword';" );
396 if ( $already_exists )
399 return yourls_apply_filter( 'keyword_is_taken', $taken, $keyword );
407 function yourls_db_connect() {
410 if ( !defined( 'YOURLS_DB_USER' )
411 or !defined( 'YOURLS_DB_PASS' )
412 or !defined( 'YOURLS_DB_NAME' )
413 or !defined( 'YOURLS_DB_HOST' )
414 ) yourls_die ( yourls__( 'Incorrect DB config, or could not connect to DB' ), yourls__( 'Fatal error' ), 503 );
416 // Are we standalone or in the WordPress environment?
417 if ( class_exists( 'wpdb', false ) ) {
418 /* TODO: should we deprecate this? Follow WP dev in that area */
419 $ydb = new wpdb( YOURLS_DB_USER, YOURLS_DB_PASS, YOURLS_DB_NAME, YOURLS_DB_HOST );
421 yourls_set_DB_driver();
424 if ( $ydb->last_error )
425 yourls_die( $ydb->last_error, yourls__( 'Fatal error' ), 503 );
427 if ( defined( 'YOURLS_DEBUG' ) && YOURLS_DEBUG === true )
428 $ydb->show_errors = true;
437 function yourls_xml_encode( $array ) {
438 require_once( YOURLS_INC.'/functions-xml.php' );
439 $converter= new yourls_array2xml;
440 return $converter->array2xml( $array );
444 * 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
447 function yourls_get_keyword_infos( $keyword, $use_cache = true ) {
449 $keyword = yourls_sanitize_string( $keyword );
451 yourls_do_action( 'pre_get_keyword', $keyword, $use_cache );
453 if( isset( $ydb->infos[$keyword] ) && $use_cache == true ) {
454 return yourls_apply_filter( 'get_keyword_infos', $ydb->infos[$keyword], $keyword );
457 yourls_do_action( 'get_keyword_not_cached', $keyword );
459 $table = YOURLS_DB_TABLE_URL;
460 $infos = $ydb->get_row( "SELECT * FROM `$table` WHERE `keyword` = '$keyword'" );
463 $infos = (array)$infos;
464 $ydb->infos[ $keyword ] = $infos;
466 $ydb->infos[ $keyword ] = false;
469 return yourls_apply_filter( 'get_keyword_infos', $ydb->infos[$keyword], $keyword );
473 * Return (string) selected information associated with a keyword. Optional $notfound = string default message if nothing found
476 function yourls_get_keyword_info( $keyword, $field, $notfound = false ) {
478 // Allow plugins to short-circuit the whole function
479 $pre = yourls_apply_filter( 'shunt_get_keyword_info', false, $keyword, $field, $notfound );
480 if ( false !== $pre )
483 $keyword = yourls_sanitize_string( $keyword );
484 $infos = yourls_get_keyword_infos( $keyword );
487 if ( isset( $infos[ $field ] ) && $infos[ $field ] !== false )
488 $return = $infos[ $field ];
490 return yourls_apply_filter( 'get_keyword_info', $return, $keyword, $field, $notfound );
494 * Return title associated with keyword. Optional $notfound = string default message if nothing found
497 function yourls_get_keyword_title( $keyword, $notfound = false ) {
498 return yourls_get_keyword_info( $keyword, 'title', $notfound );
502 * Return long URL associated with keyword. Optional $notfound = string default message if nothing found
505 function yourls_get_keyword_longurl( $keyword, $notfound = false ) {
506 return yourls_get_keyword_info( $keyword, 'url', $notfound );
510 * Return number of clicks on a keyword. Optional $notfound = string default message if nothing found
513 function yourls_get_keyword_clicks( $keyword, $notfound = false ) {
514 return yourls_get_keyword_info( $keyword, 'clicks', $notfound );
518 * Return IP that added a keyword. Optional $notfound = string default message if nothing found
521 function yourls_get_keyword_IP( $keyword, $notfound = false ) {
522 return yourls_get_keyword_info( $keyword, 'ip', $notfound );
526 * Return timestamp associated with a keyword. Optional $notfound = string default message if nothing found
529 function yourls_get_keyword_timestamp( $keyword, $notfound = false ) {
530 return yourls_get_keyword_info( $keyword, 'timestamp', $notfound );
534 * Update click count on a short URL. Return 0/1 for error/success.
537 function yourls_update_clicks( $keyword, $clicks = false ) {
538 // Allow plugins to short-circuit the whole function
539 $pre = yourls_apply_filter( 'shunt_update_clicks', false, $keyword, $clicks );
540 if ( false !== $pre )
544 $keyword = yourls_sanitize_string( $keyword );
545 $table = YOURLS_DB_TABLE_URL;
546 if ( $clicks !== false && is_int( $clicks ) && $clicks >= 0 )
547 $update = $ydb->query( "UPDATE `$table` SET `clicks` = $clicks WHERE `keyword` = '$keyword'" );
549 $update = $ydb->query( "UPDATE `$table` SET `clicks` = clicks + 1 WHERE `keyword` = '$keyword'" );
551 yourls_do_action( 'update_clicks', $keyword, $update, $clicks );
556 * Return array of stats. (string)$filter is 'bottom', 'last', 'rand' or 'top'. (int)$limit is the number of links to return
559 function yourls_get_stats( $filter = 'top', $limit = 10, $start = 0 ) {
568 $sort_by = 'timestamp';
569 $sort_order = 'desc';
579 $sort_order = 'desc';
584 $limit = intval( $limit );
585 $start = intval( $start );
588 $table_url = YOURLS_DB_TABLE_URL;
589 $results = $ydb->get_results( "SELECT * FROM `$table_url` WHERE 1=1 ORDER BY `$sort_by` $sort_order LIMIT $start, $limit;" );
594 foreach ( (array)$results as $res ) {
595 $return['links']['link_'.$i++] = array(
596 'shorturl' => YOURLS_SITE .'/'. $res->keyword,
598 'title' => $res->title,
599 'timestamp'=> $res->timestamp,
601 'clicks' => $res->clicks,
606 $return['stats'] = yourls_get_db_stats();
608 $return['statusCode'] = 200;
610 return yourls_apply_filter( 'get_stats', $return, $filter, $limit, $start );
614 * Return array of stats. (string)$filter is 'bottom', 'last', 'rand' or 'top'. (int)$limit is the number of links to return
617 function yourls_get_link_stats( $shorturl ) {
620 $table_url = YOURLS_DB_TABLE_URL;
621 $res = $ydb->get_row( "SELECT * FROM `$table_url` WHERE keyword = '$shorturl';" );
628 'message' => 'Error: short URL not found',
633 'message' => 'success',
635 'shorturl' => YOURLS_SITE .'/'. $res->keyword,
637 'title' => $res->title,
638 'timestamp'=> $res->timestamp,
640 'clicks' => $res->clicks,
645 return yourls_apply_filter( 'get_link_stats', $return, $shorturl );
649 * Get total number of URLs and sum of clicks. Input: optional "AND WHERE" clause. Returns array
652 function yourls_get_db_stats( $where = '' ) {
654 $table_url = YOURLS_DB_TABLE_URL;
656 $totals = $ydb->get_row( "SELECT COUNT(keyword) as count, SUM(clicks) as sum FROM `$table_url` WHERE 1=1 $where" );
657 $return = array( 'total_links' => $totals->count, 'total_clicks' => $totals->sum );
659 return yourls_apply_filter( 'get_db_stats', $return, $where );
663 * Get number of SQL queries performed
666 function yourls_get_num_queries() {
669 return yourls_apply_filter( 'get_num_queries', $ydb->num_queries );
673 * Returns a sanitized a user agent string. Given what I found on http://www.user-agents.org/ it should be OK.
676 function yourls_get_user_agent() {
677 if ( !isset( $_SERVER['HTTP_USER_AGENT'] ) )
680 $ua = strip_tags( html_entity_decode( $_SERVER['HTTP_USER_AGENT'] ));
681 $ua = preg_replace('![^0-9a-zA-Z\':., /{}\(\)\[\]\+@&\!\?;_\-=~\*\#]!', '', $ua );
683 return yourls_apply_filter( 'get_user_agent', substr( $ua, 0, 254 ) );
687 * Redirect to another page
690 function yourls_redirect( $location, $code = 301 ) {
691 yourls_do_action( 'pre_redirect', $location, $code );
692 $location = yourls_apply_filter( 'redirect_location', $location, $code );
693 $code = yourls_apply_filter( 'redirect_code', $code, $location );
694 // Redirect, either properly if possible, or via Javascript otherwise
695 if( !headers_sent() ) {
696 yourls_status_header( $code );
697 header( "Location: $location" );
699 yourls_redirect_javascript( $location );
705 * Set HTTP status header
708 function yourls_status_header( $code = 200 ) {
712 $protocol = $_SERVER["SERVER_PROTOCOL"];
713 if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol )
714 $protocol = 'HTTP/1.0';
716 $code = intval( $code );
717 $desc = yourls_get_HTTP_status( $code );
719 @header ("$protocol $code $desc"); // This causes problems on IIS and some FastCGI setups
720 yourls_do_action( 'status_header', $code );
724 * 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)
727 function yourls_redirect_javascript( $location, $dontwait = true ) {
728 yourls_do_action( 'pre_redirect_javascript', $location, $dontwait );
729 $location = yourls_apply_filter( 'redirect_javascript', $location, $dontwait );
731 $message = yourls_s( 'if you are not redirected after 10 seconds, please <a href="%s">click here</a>', $location );
733 <script type="text/javascript">
734 window.location="$location";
736 <small>($message)</small>
739 echo '<p>' . yourls_s( 'Please <a href="%s">click here</a>', $location ) . '</p>';
741 yourls_do_action( 'post_redirect_javascript', $location );
745 * Return a HTTP status code
748 function yourls_get_HTTP_status( $code ) {
749 $code = intval( $code );
750 $headers_desc = array(
752 101 => 'Switching Protocols',
758 203 => 'Non-Authoritative Information',
760 205 => 'Reset Content',
761 206 => 'Partial Content',
762 207 => 'Multi-Status',
765 300 => 'Multiple Choices',
766 301 => 'Moved Permanently',
769 304 => 'Not Modified',
772 307 => 'Temporary Redirect',
774 400 => 'Bad Request',
775 401 => 'Unauthorized',
776 402 => 'Payment Required',
779 405 => 'Method Not Allowed',
780 406 => 'Not Acceptable',
781 407 => 'Proxy Authentication Required',
782 408 => 'Request Timeout',
785 411 => 'Length Required',
786 412 => 'Precondition Failed',
787 413 => 'Request Entity Too Large',
788 414 => 'Request-URI Too Long',
789 415 => 'Unsupported Media Type',
790 416 => 'Requested Range Not Satisfiable',
791 417 => 'Expectation Failed',
792 422 => 'Unprocessable Entity',
794 424 => 'Failed Dependency',
795 426 => 'Upgrade Required',
797 500 => 'Internal Server Error',
798 501 => 'Not Implemented',
799 502 => 'Bad Gateway',
800 503 => 'Service Unavailable',
801 504 => 'Gateway Timeout',
802 505 => 'HTTP Version Not Supported',
803 506 => 'Variant Also Negotiates',
804 507 => 'Insufficient Storage',
805 510 => 'Not Extended'
808 if ( isset( $headers_desc[$code] ) )
809 return $headers_desc[$code];
816 * Log a redirect (for stats)
819 function yourls_log_redirect( $keyword ) {
820 // Allow plugins to short-circuit the whole function
821 $pre = yourls_apply_filter( 'shunt_log_redirect', false, $keyword );
822 if ( false !== $pre )
825 if ( !yourls_do_log_redirect() )
829 $table = YOURLS_DB_TABLE_LOG;
831 $keyword = yourls_sanitize_string( $keyword );
832 $referrer = ( isset( $_SERVER['HTTP_REFERER'] ) ? yourls_sanitize_url( $_SERVER['HTTP_REFERER'] ) : 'direct' );
833 $ua = yourls_get_user_agent();
834 $ip = yourls_get_IP();
835 $location = yourls_geo_ip_to_countrycode( $ip );
837 return $ydb->query( "INSERT INTO `$table` (click_time, shorturl, referrer, user_agent, ip_address, country_code) VALUES (NOW(), '$keyword', '$referrer', '$ua', '$ip', '$location')" );
841 * Check if we want to not log redirects (for stats)
844 function yourls_do_log_redirect() {
845 return ( !defined( 'YOURLS_NOSTATS' ) || YOURLS_NOSTATS != true );
849 * Converts an IP to a 2 letter country code, using GeoIP database if available in includes/geo/
852 function yourls_geo_ip_to_countrycode( $ip = '', $default = '' ) {
853 // Allow plugins to short-circuit the Geo IP API
854 $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
855 if ( false !== $location )
858 if ( !file_exists( YOURLS_INC.'/geo/GeoIP.dat') || !file_exists( YOURLS_INC.'/geo/geoip.inc') )
862 $ip = yourls_get_IP();
864 require_once( YOURLS_INC.'/geo/geoip.inc') ;
865 $gi = geoip_open( YOURLS_INC.'/geo/GeoIP.dat', GEOIP_STANDARD);
866 $location = geoip_country_code_by_addr($gi, $ip);
869 return yourls_apply_filter( 'geo_ip_to_countrycode', $location, $ip, $default );
873 * Converts a 2 letter country code to long name (ie AU -> Australia)
876 function yourls_geo_countrycode_to_countryname( $code ) {
877 // Allow plugins to short-circuit the Geo IP API
878 $country = yourls_apply_filter( 'shunt_geo_countrycode_to_countryname', false, $code );
879 if ( false !== $country )
882 // Load the Geo class if not already done
883 if( !class_exists( 'GeoIP', false ) ) {
884 $temp = yourls_geo_ip_to_countrycode( '127.0.0.1' );
887 if( class_exists( 'GeoIP', false ) ) {
889 $id = $geo->GEOIP_COUNTRY_CODE_TO_NUMBER[ $code ];
890 $long = $geo->GEOIP_COUNTRY_NAMES[ $id ];
898 * Return flag URL from 2 letter country code
901 function yourls_geo_get_flag( $code ) {
902 if( file_exists( YOURLS_INC.'/geo/flags/flag_'.strtolower($code).'.gif' ) ) {
903 $img = yourls_match_current_protocol( YOURLS_SITE.'/includes/geo/flags/flag_'.( strtolower( $code ) ).'.gif' );
907 return yourls_apply_filter( 'geo_get_flag', $img, $code );
912 * Check if an upgrade is needed
915 function yourls_upgrade_is_needed() {
916 // check YOURLS_DB_VERSION exist && match values stored in YOURLS_DB_TABLE_OPTIONS
917 list( $currentver, $currentsql ) = yourls_get_current_version_from_sql();
918 if( $currentsql < YOURLS_DB_VERSION )
925 * Get current version & db version as stored in the options DB. Prior to 1.4 there's no option table.
928 function yourls_get_current_version_from_sql() {
929 $currentver = yourls_get_option( 'version' );
930 $currentsql = yourls_get_option( 'db_version' );
932 // Values if version is 1.3
938 return array( $currentver, $currentsql);
942 * Read an option from DB (or from cache if available). Return value or $default if not found
945 function yourls_get_option( $option_name, $default = false ) {
948 // Allow plugins to short-circuit options
949 $pre = yourls_apply_filter( 'shunt_option_'.$option_name, false );
950 if ( false !== $pre )
953 // If option not cached already, get its value from the DB
954 if ( !isset( $ydb->option[$option_name] ) ) {
955 $table = YOURLS_DB_TABLE_OPTIONS;
956 $option_name = yourls_escape( $option_name );
957 $row = $ydb->get_row( "SELECT `option_value` FROM `$table` WHERE `option_name` = '$option_name' LIMIT 1" );
958 if ( is_object( $row) ) { // Has to be get_row instead of get_var because of funkiness with 0, false, null values
959 $value = $row->option_value;
960 } else { // option does not exist, so we must cache its non-existence
963 $ydb->option[ $option_name ] = yourls_maybe_unserialize( $value );
966 return yourls_apply_filter( 'get_option_'.$option_name, $ydb->option[$option_name] );
970 * Read all options from DB at once
973 function yourls_get_all_options() {
976 // Allow plugins to short-circuit all options. (Note: regular plugins are loaded after all options)
977 $pre = yourls_apply_filter( 'shunt_all_options', false );
978 if ( false !== $pre )
981 $table = YOURLS_DB_TABLE_OPTIONS;
983 $allopt = $ydb->get_results( "SELECT `option_name`, `option_value` FROM `$table` WHERE 1=1" );
985 foreach( (array)$allopt as $option ) {
986 $ydb->option[$option->option_name] = yourls_maybe_unserialize( $option->option_value );
989 $ydb->option = yourls_apply_filter( 'get_all_options', $ydb->option );
993 * Update (add if doesn't exist) an option to DB
996 function yourls_update_option( $option_name, $newvalue ) {
998 $table = YOURLS_DB_TABLE_OPTIONS;
1000 $safe_option_name = yourls_escape( $option_name );
1002 $oldvalue = yourls_get_option( $safe_option_name );
1004 // If the new and old values are the same, no need to update.
1005 if ( $newvalue === $oldvalue )
1008 if ( false === $oldvalue ) {
1009 yourls_add_option( $option_name, $newvalue );
1013 $_newvalue = yourls_escape( yourls_maybe_serialize( $newvalue ) );
1015 yourls_do_action( 'update_option', $option_name, $oldvalue, $newvalue );
1017 $ydb->query( "UPDATE `$table` SET `option_value` = '$_newvalue' WHERE `option_name` = '$option_name'" );
1019 if ( $ydb->rows_affected == 1 ) {
1020 $ydb->option[ $option_name ] = $newvalue;
1027 * Add an option to the DB
1030 function yourls_add_option( $name, $value = '' ) {
1032 $table = YOURLS_DB_TABLE_OPTIONS;
1033 $safe_name = yourls_escape( $name );
1035 // Make sure the option doesn't already exist
1036 if ( false !== yourls_get_option( $safe_name ) )
1039 $_value = yourls_escape( yourls_maybe_serialize( $value ) );
1041 yourls_do_action( 'add_option', $safe_name, $_value );
1043 $ydb->query( "INSERT INTO `$table` (`option_name`, `option_value`) VALUES ('$name', '$_value')" );
1044 $ydb->option[ $name ] = $value;
1050 * Delete an option from the DB
1053 function yourls_delete_option( $name ) {
1055 $table = YOURLS_DB_TABLE_OPTIONS;
1056 $name = yourls_escape( $name );
1058 // Get the ID, if no ID then return
1059 $option = $ydb->get_row( "SELECT option_id FROM `$table` WHERE `option_name` = '$name'" );
1060 if ( is_null( $option ) || !$option->option_id )
1063 yourls_do_action( 'delete_option', $option_name );
1065 $ydb->query( "DELETE FROM `$table` WHERE `option_name` = '$name'" );
1072 * Serialize data if needed. Stolen from WordPress
1075 function yourls_maybe_serialize( $data ) {
1076 if ( is_array( $data ) || is_object( $data ) )
1077 return serialize( $data );
1079 if ( yourls_is_serialized( $data ) )
1080 return serialize( $data );
1086 * Check value to find if it was serialized. Stolen from WordPress
1089 function yourls_is_serialized( $data ) {
1090 // if it isn't a string, it isn't serialized
1091 if ( !is_string( $data ) )
1093 $data = trim( $data );
1094 if ( 'N;' == $data )
1096 if ( !preg_match( '/^([adObis]):/', $data, $badions ) )
1098 switch ( $badions[1] ) {
1102 if ( preg_match( "/^{$badions[1]}:[0-9]+:.*[;}]\$/s", $data ) )
1108 if ( preg_match( "/^{$badions[1]}:[0-9.E-]+;\$/", $data ) )
1116 * Unserialize value only if it was serialized. Stolen from WP
1119 function yourls_maybe_unserialize( $original ) {
1120 if ( yourls_is_serialized( $original ) ) // don't attempt to unserialize data that wasn't serialized going in
1121 return @unserialize( $original );
1126 * Determine if the current page is private
1129 function yourls_is_private() {
1132 if ( defined('YOURLS_PRIVATE') && YOURLS_PRIVATE == true ) {
1134 // Allow overruling for particular pages:
1137 if( yourls_is_API() ) {
1138 if( !defined('YOURLS_PRIVATE_API') || YOURLS_PRIVATE_API != false )
1142 } elseif( yourls_is_infos() ) {
1143 if( !defined('YOURLS_PRIVATE_INFOS') || YOURLS_PRIVATE_INFOS !== false )
1153 return yourls_apply_filter( 'is_private', $private );
1157 * Show login form if required
1160 function yourls_maybe_require_auth() {
1161 if( yourls_is_private() ) {
1162 yourls_do_action( 'require_auth' );
1163 require_once( YOURLS_INC.'/auth.php' );
1165 yourls_do_action( 'require_no_auth' );
1170 * Allow several short URLs for the same long URL ?
1173 function yourls_allow_duplicate_longurls() {
1174 // special treatment if API to check for WordPress plugin requests
1175 if( yourls_is_API() ) {
1176 if ( isset($_REQUEST['source']) && $_REQUEST['source'] == 'plugin' )
1179 return ( defined( 'YOURLS_UNIQUE_URLS' ) && YOURLS_UNIQUE_URLS == false );
1183 * Return list of all shorturls associated to the same long URL. Returns NULL or array of keywords.
1186 function yourls_get_duplicate_keywords( $longurl ) {
1187 if( !yourls_allow_duplicate_longurls() )
1191 $longurl = yourls_escape( yourls_sanitize_url($longurl) );
1192 $table = YOURLS_DB_TABLE_URL;
1194 $return = $ydb->get_col( "SELECT `keyword` FROM `$table` WHERE `url` = '$longurl'" );
1195 return yourls_apply_filter( 'get_duplicate_keywords', $return, $longurl );
1199 * Check if an IP shortens URL too fast to prevent DB flood. Return true, or die.
1202 function yourls_check_IP_flood( $ip = '' ) {
1204 // Allow plugins to short-circuit the whole function
1205 $pre = yourls_apply_filter( 'shunt_check_IP_flood', false, $ip );
1206 if ( false !== $pre )
1209 yourls_do_action( 'pre_check_ip_flood', $ip ); // at this point $ip can be '', check it if your plugin hooks in here
1212 ( defined('YOURLS_FLOOD_DELAY_SECONDS') && YOURLS_FLOOD_DELAY_SECONDS === 0 ) ||
1213 !defined('YOURLS_FLOOD_DELAY_SECONDS')
1217 $ip = ( $ip ? yourls_sanitize_ip( $ip ) : yourls_get_IP() );
1219 // Don't throttle whitelist IPs
1220 if( defined( 'YOURLS_FLOOD_IP_WHITELIST' ) && YOURLS_FLOOD_IP_WHITELIST ) {
1221 $whitelist_ips = explode( ',', YOURLS_FLOOD_IP_WHITELIST );
1222 foreach( (array)$whitelist_ips as $whitelist_ip ) {
1223 $whitelist_ip = trim( $whitelist_ip );
1224 if ( $whitelist_ip == $ip )
1229 // Don't throttle logged in users
1230 if( yourls_is_private() ) {
1231 if( yourls_is_valid_user() === true )
1235 yourls_do_action( 'check_ip_flood', $ip );
1238 $table = YOURLS_DB_TABLE_URL;
1240 $lasttime = $ydb->get_var( "SELECT `timestamp` FROM $table WHERE `ip` = '$ip' ORDER BY `timestamp` DESC LIMIT 1" );
1243 $then = date( 'U', strtotime( $lasttime ) );
1244 if( ( $now - $then ) <= YOURLS_FLOOD_DELAY_SECONDS ) {
1246 yourls_do_action( 'ip_flood', $ip, $now - $then );
1247 yourls_die( yourls__( 'Too many URLs added too fast. Slow down please.' ), yourls__( 'Forbidden' ), 403 );
1255 * Check if YOURLS is installing
1260 function yourls_is_installing() {
1261 $installing = defined( 'YOURLS_INSTALLING' ) && YOURLS_INSTALLING == true;
1262 return yourls_apply_filter( 'is_installing', $installing );
1266 * Check if YOURLS is upgrading
1271 function yourls_is_upgrading() {
1272 $upgrading = defined( 'YOURLS_UPGRADING' ) && YOURLS_UPGRADING == true;
1273 return yourls_apply_filter( 'is_upgrading', $upgrading );
1278 * Check if YOURLS is installed
1281 function yourls_is_installed() {
1282 static $is_installed = false;
1283 if ( $is_installed === false ) {
1284 $check_14 = $check_13 = false;
1286 if( defined('YOURLS_DB_TABLE_NEXTDEC') )
1287 $check_13 = $ydb->get_var('SELECT `next_id` FROM '.YOURLS_DB_TABLE_NEXTDEC);
1288 $check_14 = yourls_get_option( 'version' );
1289 $is_installed = $check_13 || $check_14;
1291 return yourls_apply_filter( 'is_installed', $is_installed );
1295 * Generate random string of (int)$length length and type $type (see function for details)
1298 function yourls_rnd_string ( $length = 5, $type = 0, $charlist = '' ) {
1300 $length = intval( $length );
1302 // define possible characters
1305 // custom char list, or comply to charset as defined in config
1307 $possible = $charlist ? $charlist : yourls_get_shorturl_charset() ;
1310 // no vowels to make no offending word, no 0/1/o/l to avoid confusion between letters & digits. Perfect for passwords.
1312 $possible = "23456789bcdfghjkmnpqrstvwxyz";
1315 // Same, with lower + upper
1317 $possible = "23456789bcdfghjkmnpqrstvwxyzBCDFGHJKMNPQRSTVWXYZ";
1320 // all letters, lowercase
1322 $possible = "abcdefghijklmnopqrstuvwxyz";
1325 // all letters, lowercase + uppercase
1327 $possible = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
1330 // all digits & letters lowercase
1332 $possible = "0123456789abcdefghijklmnopqrstuvwxyz";
1335 // all digits & letters lowercase + uppercase
1337 $possible = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
1343 while ($i < $length) {
1344 $str .= substr($possible, mt_rand(0, strlen($possible)-1), 1);
1348 return yourls_apply_filter( 'rnd_string', $str, $length, $type, $charlist );
1352 * Return salted string
1355 function yourls_salt( $string ) {
1356 $salt = defined('YOURLS_COOKIEKEY') ? YOURLS_COOKIEKEY : md5(__FILE__) ;
1357 return yourls_apply_filter( 'yourls_salt', md5 ($string . $salt), $string );
1361 * Add a query var to a URL and return URL. Completely stolen from WP.
1363 * Works with one of these parameter patterns:
1364 * array( 'var' => 'value' )
1365 * array( 'var' => 'value' ), $url
1367 * 'var', 'value', $url
1368 * If $url ommited, uses $_SERVER['REQUEST_URI']
1371 function yourls_add_query_arg() {
1373 if ( is_array( func_get_arg(0) ) ) {
1374 if ( @func_num_args() < 2 || false === @func_get_arg( 1 ) )
1375 $uri = $_SERVER['REQUEST_URI'];
1377 $uri = @func_get_arg( 1 );
1379 if ( @func_num_args() < 3 || false === @func_get_arg( 2 ) )
1380 $uri = $_SERVER['REQUEST_URI'];
1382 $uri = @func_get_arg( 2 );
1385 $uri = str_replace( '&', '&', $uri );
1388 if ( $frag = strstr( $uri, '#' ) )
1389 $uri = substr( $uri, 0, -strlen( $frag ) );
1393 if ( preg_match( '|^https?://|i', $uri, $matches ) ) {
1394 $protocol = $matches[0];
1395 $uri = substr( $uri, strlen( $protocol ) );
1400 if ( strpos( $uri, '?' ) !== false ) {
1401 $parts = explode( '?', $uri, 2 );
1402 if ( 1 == count( $parts ) ) {
1406 $base = $parts[0] . '?';
1409 } elseif ( !empty( $protocol ) || strpos( $uri, '=' ) === false ) {
1417 parse_str( $query, $qs );
1418 $qs = yourls_urlencode_deep( $qs ); // this re-URL-encodes things that were already in the query string
1419 if ( is_array( func_get_arg( 0 ) ) ) {
1420 $kayvees = func_get_arg( 0 );
1421 $qs = array_merge( $qs, $kayvees );
1423 $qs[func_get_arg( 0 )] = func_get_arg( 1 );
1426 foreach ( (array) $qs as $k => $v ) {
1431 $ret = http_build_query( $qs );
1432 $ret = trim( $ret, '?' );
1433 $ret = preg_replace( '#=(&|$)#', '$1', $ret );
1434 $ret = $protocol . $base . $ret . $frag;
1435 $ret = rtrim( $ret, '?' );
1440 * Navigates through an array and encodes the values to be used in a URL. Stolen from WP, used in yourls_add_query_arg()
1443 function yourls_urlencode_deep( $value ) {
1444 $value = is_array( $value ) ? array_map( 'yourls_urlencode_deep', $value ) : urlencode( $value );
1449 * Remove arg from query. Opposite of yourls_add_query_arg. Stolen from WP.
1452 function yourls_remove_query_arg( $key, $query = false ) {
1453 if ( is_array( $key ) ) { // removing multiple keys
1454 foreach ( $key as $k )
1455 $query = yourls_add_query_arg( $k, false, $query );
1458 return yourls_add_query_arg( $key, false, $query );
1462 * Return a time-dependent string for nonce creation
1465 function yourls_tick() {
1466 return ceil( time() / YOURLS_NONCE_LIFE );
1470 * Create a time limited, action limited and user limited token
1473 function yourls_create_nonce( $action, $user = false ) {
1474 if( false == $user )
1475 $user = defined( 'YOURLS_USER' ) ? YOURLS_USER : '-1';
1476 $tick = yourls_tick();
1477 return substr( yourls_salt($tick . $action . $user), 0, 10 );
1481 * Create a nonce field for inclusion into a form
1484 function yourls_nonce_field( $action, $name = 'nonce', $user = false, $echo = true ) {
1485 $field = '<input type="hidden" id="'.$name.'" name="'.$name.'" value="'.yourls_create_nonce( $action, $user ).'" />';
1492 * Add a nonce to a URL. If URL omitted, adds nonce to current URL
1495 function yourls_nonce_url( $action, $url = false, $name = 'nonce', $user = false ) {
1496 $nonce = yourls_create_nonce( $action, $user );
1497 return yourls_add_query_arg( $name, $nonce, $url );
1501 * Check validity of a nonce (ie time span, user and action match).
1503 * Returns true if valid, dies otherwise (yourls_die() or die($return) if defined)
1504 * if $nonce is false or unspecified, it will use $_REQUEST['nonce']
1507 function yourls_verify_nonce( $action, $nonce = false, $user = false, $return = '' ) {
1509 if( false == $user )
1510 $user = defined( 'YOURLS_USER' ) ? YOURLS_USER : '-1';
1512 // get current nonce value
1513 if( false == $nonce && isset( $_REQUEST['nonce'] ) )
1514 $nonce = $_REQUEST['nonce'];
1516 // what nonce should be
1517 $valid = yourls_create_nonce( $action, $user );
1519 if( $nonce == $valid ) {
1524 yourls_die( yourls__( 'Unauthorized action or expired link' ), yourls__( 'Error' ), 403 );
1529 * Converts keyword into short link (prepend with YOURLS base URL)
1532 function yourls_link( $keyword = '' ) {
1533 $link = YOURLS_SITE . '/' . yourls_sanitize_keyword( $keyword );
1534 return yourls_apply_filter( 'yourls_link', $link, $keyword );
1538 * Converts keyword into stat link (prepend with YOURLS base URL, append +)
1541 function yourls_statlink( $keyword = '' ) {
1542 $link = YOURLS_SITE . '/' . yourls_sanitize_keyword( $keyword ) . '+';
1543 if( yourls_is_ssl() )
1544 $link = str_replace( 'http://', 'https://', $link );
1545 return yourls_apply_filter( 'yourls_statlink', $link, $keyword );
1549 * Check if we're in API mode. Returns bool
1552 function yourls_is_API() {
1553 if ( defined( 'YOURLS_API' ) && YOURLS_API == true )
1559 * Check if we're in Ajax mode. Returns bool
1562 function yourls_is_Ajax() {
1563 if ( defined( 'YOURLS_AJAX' ) && YOURLS_AJAX == true )
1569 * Check if we're in GO mode (yourls-go.php). Returns bool
1572 function yourls_is_GO() {
1573 if ( defined( 'YOURLS_GO' ) && YOURLS_GO == true )
1579 * Check if we're displaying stats infos (yourls-infos.php). Returns bool
1582 function yourls_is_infos() {
1583 if ( defined( 'YOURLS_INFOS' ) && YOURLS_INFOS == true )
1589 * Check if we'll need interface display function (ie not API or redirection)
1592 function yourls_has_interface() {
1593 if( yourls_is_API() or yourls_is_GO() )
1599 * Check if we're in the admin area. Returns bool
1602 function yourls_is_admin() {
1603 if ( defined( 'YOURLS_ADMIN' ) && YOURLS_ADMIN == true )
1609 * Check if the server seems to be running on Windows. Not exactly sure how reliable this is.
1612 function yourls_is_windows() {
1613 return defined( 'DIRECTORY_SEPARATOR' ) && DIRECTORY_SEPARATOR == '\\';
1617 * Check if SSL is required. Returns bool.
1620 function yourls_needs_ssl() {
1621 if ( defined('YOURLS_ADMIN_SSL') && YOURLS_ADMIN_SSL == true )
1627 * Return admin link, with SSL preference if applicable.
1630 function yourls_admin_url( $page = '' ) {
1631 $admin = YOURLS_SITE . '/admin/' . $page;
1632 if( yourls_is_ssl() or yourls_needs_ssl() )
1633 $admin = str_replace('http://', 'https://', $admin);
1634 return yourls_apply_filter( 'admin_url', $admin, $page );
1638 * Return YOURLS_SITE or URL under YOURLS setup, with SSL preference
1641 function yourls_site_url( $echo = true, $url = '' ) {
1642 $url = yourls_get_relative_url( $url );
1643 $url = trim( YOURLS_SITE . '/' . $url, '/' );
1645 // Do not enforce (checking yourls_need_ssl() ) but check current usage so it won't force SSL on non-admin pages
1646 if( yourls_is_ssl() )
1647 $url = str_replace( 'http://', 'https://', $url );
1648 $url = yourls_apply_filter( 'site_url', $url );
1655 * Check if SSL is used, returns bool. Stolen from WP.
1658 function yourls_is_ssl() {
1660 if ( isset( $_SERVER['HTTPS'] ) ) {
1661 if ( 'on' == strtolower( $_SERVER['HTTPS'] ) )
1663 if ( '1' == $_SERVER['HTTPS'] )
1665 } elseif ( isset( $_SERVER['SERVER_PORT'] ) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
1668 return yourls_apply_filter( 'is_ssl', $is_ssl );
1673 * Get a remote page <title>, return a string (either title or url)
1676 function yourls_get_remote_title( $url ) {
1677 // Allow plugins to short-circuit the whole function
1678 $pre = yourls_apply_filter( 'shunt_get_remote_title', false, $url );
1679 if ( false !== $pre )
1682 require_once( YOURLS_INC.'/functions-http.php' );
1684 $url = yourls_sanitize_url( $url );
1686 $title = $charset = false;
1688 $content = yourls_get_remote_content( $url );
1690 // If false, return url as title.
1691 // Todo: improve this with temporary title when shorturl_meta available?
1692 if( false === $content )
1695 if( $content !== false ) {
1697 if ( preg_match('/<title>(.*?)<\/title>/is', $content, $found ) ) {
1703 // <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
1704 if ( preg_match('/<meta[^>]*?charset=([^>]*?)\/?>/is', $content, $found ) ) {
1705 $charset = trim($found[1], '"\' ');
1710 // if title not found, guess if returned content was actually an error message
1711 if( $title == false && strpos( $content, 'Error' ) === 0 ) {
1715 if( $title == false )
1719 if( !yourls_seems_utf8( $title ) )
1720 $title = utf8_encode( $title );
1723 // Charset conversion. We use @ to remove warnings (mb_ functions are easily bitching about illegal chars)
1724 if( function_exists( 'mb_convert_encoding' ) ) {
1726 $title = @mb_convert_encoding( $title, 'UTF-8', $charset );
1728 $title = @mb_convert_encoding( $title, 'UTF-8' );
1732 // Remove HTML entities
1733 $title = html_entity_decode( $title, ENT_QUOTES, 'UTF-8' );
1735 // Strip out evil things
1736 $title = yourls_sanitize_title( $title );
1738 return yourls_apply_filter( 'get_remote_title', $title, $url );
1742 * Quick UA check for mobile devices. Return boolean.
1745 function yourls_is_mobile_device() {
1748 'android', 'blackberry', 'blazer',
1749 'compal', 'elaine', 'fennec', 'hiptop',
1750 'iemobile', 'iphone', 'ipod', 'ipad',
1751 'iris', 'kindle', 'opera mobi', 'opera mini',
1752 'palm', 'phone', 'pocket', 'psp', 'symbian',
1753 'treo', 'wap', 'windows ce', 'windows phone'
1756 // Current user-agent
1757 $current = strtolower( $_SERVER['HTTP_USER_AGENT'] );
1760 $is_mobile = ( str_replace( $mobiles, '', $current ) != $current );
1761 return yourls_apply_filter( 'is_mobile_device', $is_mobile );
1765 * Get request in YOURLS base (eg in 'http://site.com/yourls/abcd' get 'abdc')
1768 function yourls_get_request() {
1769 // Allow plugins to short-circuit the whole function
1770 $pre = yourls_apply_filter( 'shunt_get_request', false );
1771 if ( false !== $pre )
1774 static $request = null;
1776 yourls_do_action( 'pre_get_request', $request );
1778 if( $request !== null )
1781 // Ignore protocol & www. prefix
1782 $root = str_replace( array( 'https://', 'http://', 'https://www.', 'http://www.' ), '', YOURLS_SITE );
1783 // Case insensitive comparison of the YOURLS root to match both http://Sho.rt/blah and http://sho.rt/blah
1784 $request = preg_replace( "!$root/!i", '', $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], 1 );
1786 // Unless request looks like a full URL (ie request is a simple keyword) strip query string
1787 if( !preg_match( "@^[a-zA-Z]+://.+@", $request ) ) {
1788 $request = current( explode( '?', $request ) );
1791 return yourls_apply_filter( 'get_request', $request );
1795 * Change protocol to match current scheme used (http or https)
1798 function yourls_match_current_protocol( $url, $normal = 'http', $ssl = 'https' ) {
1799 if( yourls_is_ssl() )
1800 $url = str_replace( $normal, $ssl, $url );
1801 return yourls_apply_filter( 'match_current_protocol', $url );
1805 * Fix $_SERVER['REQUEST_URI'] variable for various setups. Stolen from WP.
1808 function yourls_fix_request_uri() {
1810 $default_server_values = array(
1811 'SERVER_SOFTWARE' => '',
1812 'REQUEST_URI' => '',
1814 $_SERVER = array_merge( $default_server_values, $_SERVER );
1816 // Fix for IIS when running with PHP ISAPI
1817 if ( empty( $_SERVER['REQUEST_URI'] ) || ( php_sapi_name() != 'cgi-fcgi' && preg_match( '/^Microsoft-IIS\//', $_SERVER['SERVER_SOFTWARE'] ) ) ) {
1820 if ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] ) ) {
1821 $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_ORIGINAL_URL'];
1823 // IIS Isapi_Rewrite
1824 else if ( isset( $_SERVER['HTTP_X_REWRITE_URL'] ) ) {
1825 $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_REWRITE_URL'];
1827 // Use ORIG_PATH_INFO if there is no PATH_INFO
1828 if ( !isset( $_SERVER['PATH_INFO'] ) && isset( $_SERVER['ORIG_PATH_INFO'] ) )
1829 $_SERVER['PATH_INFO'] = $_SERVER['ORIG_PATH_INFO'];
1831 // Some IIS + PHP configurations puts the script-name in the path-info (No need to append it twice)
1832 if ( isset( $_SERVER['PATH_INFO'] ) ) {
1833 if ( $_SERVER['PATH_INFO'] == $_SERVER['SCRIPT_NAME'] )
1834 $_SERVER['REQUEST_URI'] = $_SERVER['PATH_INFO'];
1836 $_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME'] . $_SERVER['PATH_INFO'];
1839 // Append the query string if it exists and isn't null
1840 if ( ! empty( $_SERVER['QUERY_STRING'] ) ) {
1841 $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING'];
1848 * Shutdown function, runs just before PHP shuts down execution. Stolen from WP
1851 function yourls_shutdown() {
1852 yourls_do_action( 'shutdown' );
1856 * Auto detect custom favicon in /user directory, fallback to YOURLS favicon, and echo/return its URL
1859 function yourls_favicon( $echo = true ) {
1860 static $favicon = null;
1861 if( $favicon !== null )
1865 // search for favicon.(gif|ico|png|jpg|svg)
1866 foreach( array( 'gif', 'ico', 'png', 'jpg', 'svg' ) as $ext ) {
1867 if( file_exists( YOURLS_USERDIR. '/favicon.' . $ext ) ) {
1868 $custom = 'favicon.' . $ext;
1874 $favicon = yourls_site_url( false, YOURLS_USERURL . '/' . $custom );
1876 $favicon = yourls_site_url( false ) . '/images/favicon.gif';
1884 * Check for maintenance mode. If yes, die. See yourls_maintenance_mode(). Stolen from WP.
1887 function yourls_check_maintenance_mode() {
1889 $file = YOURLS_ABSPATH . '/.maintenance' ;
1890 if ( !file_exists( $file ) || yourls_is_upgrading() || yourls_is_installing() )
1893 global $maintenance_start;
1896 // If the $maintenance_start timestamp is older than 10 minutes, don't die.
1897 if ( ( time() - $maintenance_start ) >= 600 )
1900 // Use any /user/maintenance.php file
1901 if( file_exists( YOURLS_USERDIR.'/maintenance.php' ) ) {
1902 include( YOURLS_USERDIR.'/maintenance.php' );
1906 // https://www.youtube.com/watch?v=Xw-m4jEY-Ns
1907 $title = yourls__( 'Service temporarily unavailable' );
1908 $message = yourls__( 'Our service is currently undergoing scheduled maintenance.' ) . "</p>\n<p>" .
1909 yourls__( 'Things should not last very long, thank you for your patience and please excuse the inconvenience' );
1910 yourls_die( $message, $title , 503 );
1915 * Return current admin page, or null if not an admin page
1917 * @return mixed string if admin page, null if not an admin page
1920 function yourls_current_admin_page() {
1921 if( yourls_is_admin() ) {
1922 $current = substr( yourls_get_request(), 6 );
1923 if( $current === false )
1924 $current = 'index.php'; // if current page is http://sho.rt/admin/ instead of http://sho.rt/admin/index.php
1932 * Check if a URL protocol is allowed
1934 * Checks a URL against a list of whitelisted protocols. Protocols must be defined with
1935 * their complete scheme name, ie 'stuff:' or 'stuff://' (for instance, 'mailto:' is a valid
1936 * protocol, 'mailto://' isn't, and 'http:' with no double slashed isn't either
1940 * @param string $url URL to be check
1941 * @param array $protocols Optional. Array of protocols, defaults to global $yourls_allowedprotocols
1942 * @return boolean true if protocol allowed, false otherwise
1944 function yourls_is_allowed_protocol( $url, $protocols = array() ) {
1945 if( ! $protocols ) {
1946 global $yourls_allowedprotocols;
1947 $protocols = $yourls_allowedprotocols;
1950 $protocol = yourls_get_protocol( $url );
1951 return yourls_apply_filter( 'is_allowed_protocol', in_array( $protocol, $protocols ), $url, $protocols );
1955 * Get protocol from a URL (eg mailto:, http:// ...)
1959 * @param string $url URL to be check
1960 * @return string Protocol, with slash slash if applicable. Empty string if no protocol
1962 function yourls_get_protocol( $url ) {
1963 preg_match( '!^[a-zA-Z0-9\+\.-]+:(//)?!', $url, $matches );
1965 http://en.wikipedia.org/wiki/URI_scheme#Generic_syntax
1966 The scheme name consists of a sequence of characters beginning with a letter and followed by any
1967 combination of letters, digits, plus ("+"), period ("."), or hyphen ("-"). Although schemes are
1968 case-insensitive, the canonical form is lowercase and documents that specify schemes must do so
1969 with lowercase letters. It is followed by a colon (":").
1971 $protocol = ( isset( $matches[0] ) ? $matches[0] : '' );
1972 return yourls_apply_filter( 'get_protocol', $protocol, $url );
1976 * Get relative URL (eg 'abc' from 'http://sho.rt/abc')
1978 * Treat indifferently http & https. If a URL isn't relative to the YOURLS install, return it as is
1979 * or return empty string if $strict is true
1982 * @param string $url URL to relativize
1983 * @param bool $strict if true and if URL isn't relative to YOURLS install, return empty string
1984 * @return string URL
1986 function yourls_get_relative_url( $url, $strict = true ) {
1987 $url = yourls_sanitize_url( $url );
1989 // Remove protocols to make it easier
1990 $noproto_url = str_replace( 'https:', 'http:', $url );
1991 $noproto_site = str_replace( 'https:', 'http:', YOURLS_SITE );
1993 // Trim URL from YOURLS root URL : if no modification made, URL wasn't relative
1994 $_url = str_replace( $noproto_site . '/', '', $noproto_url );
1995 if( $_url == $noproto_url )
1996 $_url = ( $strict ? '' : $url );
1998 return yourls_apply_filter( 'get_relative_url', $_url, $url );
2002 * Marks a function as deprecated and informs when it has been used. Stolen from WP.
2004 * There is a hook deprecated_function that will be called that can be used
2005 * to get the backtrace up to what file and function called the deprecated
2008 * The current behavior is to trigger a user error if YOURLS_DEBUG is true.
2010 * This function is to be used in every function that is deprecated.
2013 * @uses yourls_do_action() Calls 'deprecated_function' and passes the function name, what to use instead,
2014 * and the version the function was deprecated in.
2015 * @uses yourls_apply_filters() Calls 'deprecated_function_trigger_error' and expects boolean value of true to do
2016 * trigger or false to not trigger error.
2018 * @param string $function The function that was called
2019 * @param string $version The version of WordPress that deprecated the function
2020 * @param string $replacement Optional. The function that should have been called
2022 function yourls_deprecated_function( $function, $version, $replacement = null ) {
2024 yourls_do_action( 'deprecated_function', $function, $replacement, $version );
2026 // Allow plugin to filter the output error trigger
2027 if ( YOURLS_DEBUG && yourls_apply_filters( 'deprecated_function_trigger_error', true ) ) {
2028 if ( ! is_null( $replacement ) )
2029 trigger_error( sprintf( yourls__('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $function, $version, $replacement ) );
2031 trigger_error( sprintf( yourls__('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
2036 * Return the value if not an empty string
2038 * Used with array_filter(), to remove empty keys but not keys with value 0 or false
2041 * @param mixed $val Value to test against ''
2042 * @return bool True if not an empty string
2044 function yourls_return_if_not_empty_string( $val ) {
2045 return( $val !== '' );