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 or !class_exists( 'ezSQL_mysql' )
415 ) yourls_die ( yourls__( 'DB config missing, or could not find DB class' ), yourls__( 'Fatal error' ), 503 );
417 // Are we standalone or in the WordPress environment?
418 if ( class_exists( 'wpdb' ) ) {
419 $ydb = new wpdb( YOURLS_DB_USER, YOURLS_DB_PASS, YOURLS_DB_NAME, YOURLS_DB_HOST );
421 $ydb = new ezSQL_mysql( YOURLS_DB_USER, YOURLS_DB_PASS, YOURLS_DB_NAME, YOURLS_DB_HOST );
423 if ( $ydb->last_error )
424 yourls_die( $ydb->last_error, yourls__( 'Fatal error' ), 503 );
426 if ( defined( 'YOURLS_DEBUG' ) && YOURLS_DEBUG === true )
427 $ydb->show_errors = true;
436 function yourls_xml_encode( $array ) {
437 require_once( YOURLS_INC.'/functions-xml.php' );
438 $converter= new yourls_array2xml;
439 return $converter->array2xml( $array );
443 * 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
446 function yourls_get_keyword_infos( $keyword, $use_cache = true ) {
448 $keyword = yourls_sanitize_string( $keyword );
450 yourls_do_action( 'pre_get_keyword', $keyword, $use_cache );
452 if( isset( $ydb->infos[$keyword] ) && $use_cache == true ) {
453 return yourls_apply_filter( 'get_keyword_infos', $ydb->infos[$keyword], $keyword );
456 yourls_do_action( 'get_keyword_not_cached', $keyword );
458 $table = YOURLS_DB_TABLE_URL;
459 $infos = $ydb->get_row( "SELECT * FROM `$table` WHERE `keyword` = '$keyword'" );
462 $infos = (array)$infos;
463 $ydb->infos[ $keyword ] = $infos;
465 $ydb->infos[ $keyword ] = false;
468 return yourls_apply_filter( 'get_keyword_infos', $ydb->infos[$keyword], $keyword );
472 * Return (string) selected information associated with a keyword. Optional $notfound = string default message if nothing found
475 function yourls_get_keyword_info( $keyword, $field, $notfound = false ) {
477 // Allow plugins to short-circuit the whole function
478 $pre = yourls_apply_filter( 'shunt_get_keyword_info', false, $keyword, $field, $notfound );
479 if ( false !== $pre )
482 $keyword = yourls_sanitize_string( $keyword );
483 $infos = yourls_get_keyword_infos( $keyword );
486 if ( isset( $infos[ $field ] ) && $infos[ $field ] !== false )
487 $return = $infos[ $field ];
489 return yourls_apply_filter( 'get_keyword_info', $return, $keyword, $field, $notfound );
493 * Return title associated with keyword. Optional $notfound = string default message if nothing found
496 function yourls_get_keyword_title( $keyword, $notfound = false ) {
497 return yourls_get_keyword_info( $keyword, 'title', $notfound );
501 * Return long URL associated with keyword. Optional $notfound = string default message if nothing found
504 function yourls_get_keyword_longurl( $keyword, $notfound = false ) {
505 return yourls_get_keyword_info( $keyword, 'url', $notfound );
509 * Return number of clicks on a keyword. Optional $notfound = string default message if nothing found
512 function yourls_get_keyword_clicks( $keyword, $notfound = false ) {
513 return yourls_get_keyword_info( $keyword, 'clicks', $notfound );
517 * Return IP that added a keyword. Optional $notfound = string default message if nothing found
520 function yourls_get_keyword_IP( $keyword, $notfound = false ) {
521 return yourls_get_keyword_info( $keyword, 'ip', $notfound );
525 * Return timestamp associated with a keyword. Optional $notfound = string default message if nothing found
528 function yourls_get_keyword_timestamp( $keyword, $notfound = false ) {
529 return yourls_get_keyword_info( $keyword, 'timestamp', $notfound );
533 * Update click count on a short URL. Return 0/1 for error/success.
536 function yourls_update_clicks( $keyword, $clicks = false ) {
537 // Allow plugins to short-circuit the whole function
538 $pre = yourls_apply_filter( 'shunt_update_clicks', false, $keyword, $clicks );
539 if ( false !== $pre )
543 $keyword = yourls_sanitize_string( $keyword );
544 $table = YOURLS_DB_TABLE_URL;
545 if ( $clicks !== false && is_int( $clicks ) && $clicks >= 0 )
546 $update = $ydb->query( "UPDATE `$table` SET `clicks` = $clicks WHERE `keyword` = '$keyword'" );
548 $update = $ydb->query( "UPDATE `$table` SET `clicks` = clicks + 1 WHERE `keyword` = '$keyword'" );
550 yourls_do_action( 'update_clicks', $keyword, $update, $clicks );
555 * Return array of stats. (string)$filter is 'bottom', 'last', 'rand' or 'top'. (int)$limit is the number of links to return
558 function yourls_get_stats( $filter = 'top', $limit = 10, $start = 0 ) {
567 $sort_by = 'timestamp';
568 $sort_order = 'desc';
578 $sort_order = 'desc';
583 $limit = intval( $limit );
584 $start = intval( $start );
587 $table_url = YOURLS_DB_TABLE_URL;
588 $results = $ydb->get_results( "SELECT * FROM `$table_url` WHERE 1=1 ORDER BY `$sort_by` $sort_order LIMIT $start, $limit;" );
593 foreach ( (array)$results as $res ) {
594 $return['links']['link_'.$i++] = array(
595 'shorturl' => YOURLS_SITE .'/'. $res->keyword,
597 'title' => $res->title,
598 'timestamp'=> $res->timestamp,
600 'clicks' => $res->clicks,
605 $return['stats'] = yourls_get_db_stats();
607 $return['statusCode'] = 200;
609 return yourls_apply_filter( 'get_stats', $return, $filter, $limit, $start );
613 * Return array of stats. (string)$filter is 'bottom', 'last', 'rand' or 'top'. (int)$limit is the number of links to return
616 function yourls_get_link_stats( $shorturl ) {
619 $table_url = YOURLS_DB_TABLE_URL;
620 $res = $ydb->get_row( "SELECT * FROM `$table_url` WHERE keyword = '$shorturl';" );
627 'message' => 'Error: short URL not found',
632 'message' => 'success',
634 'shorturl' => YOURLS_SITE .'/'. $res->keyword,
636 'title' => $res->title,
637 'timestamp'=> $res->timestamp,
639 'clicks' => $res->clicks,
644 return yourls_apply_filter( 'get_link_stats', $return, $shorturl );
648 * Get total number of URLs and sum of clicks. Input: optional "AND WHERE" clause. Returns array
651 function yourls_get_db_stats( $where = '' ) {
653 $table_url = YOURLS_DB_TABLE_URL;
655 $totals = $ydb->get_row( "SELECT COUNT(keyword) as count, SUM(clicks) as sum FROM `$table_url` WHERE 1=1 $where" );
656 $return = array( 'total_links' => $totals->count, 'total_clicks' => $totals->sum );
658 return yourls_apply_filter( 'get_db_stats', $return, $where );
662 * Get number of SQL queries performed
665 function yourls_get_num_queries() {
668 return yourls_apply_filter( 'get_num_queries', $ydb->num_queries );
672 * Returns a sanitized a user agent string. Given what I found on http://www.user-agents.org/ it should be OK.
675 function yourls_get_user_agent() {
676 if ( !isset( $_SERVER['HTTP_USER_AGENT'] ) )
679 $ua = strip_tags( html_entity_decode( $_SERVER['HTTP_USER_AGENT'] ));
680 $ua = preg_replace('![^0-9a-zA-Z\':., /{}\(\)\[\]\+@&\!\?;_\-=~\*\#]!', '', $ua );
682 return yourls_apply_filter( 'get_user_agent', substr( $ua, 0, 254 ) );
686 * Redirect to another page
689 function yourls_redirect( $location, $code = 301 ) {
690 yourls_do_action( 'pre_redirect', $location, $code );
691 $location = yourls_apply_filter( 'redirect_location', $location, $code );
692 $code = yourls_apply_filter( 'redirect_code', $code, $location );
693 // Redirect, either properly if possible, or via Javascript otherwise
694 if( !headers_sent() ) {
695 yourls_status_header( $code );
696 header( "Location: $location" );
698 yourls_redirect_javascript( $location );
704 * Set HTTP status header
707 function yourls_status_header( $code = 200 ) {
711 $protocol = $_SERVER["SERVER_PROTOCOL"];
712 if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol )
713 $protocol = 'HTTP/1.0';
715 $code = intval( $code );
716 $desc = yourls_get_HTTP_status( $code );
718 @header ("$protocol $code $desc"); // This causes problems on IIS and some FastCGI setups
719 yourls_do_action( 'status_header', $code );
723 * 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)
726 function yourls_redirect_javascript( $location, $dontwait = true ) {
727 yourls_do_action( 'pre_redirect_javascript', $location, $dontwait );
728 $location = yourls_apply_filter( 'redirect_javascript', $location, $dontwait );
730 $message = yourls_s( 'if you are not redirected after 10 seconds, please <a href="%s">click here</a>', $location );
732 <script type="text/javascript">
733 window.location="$location";
735 <small>($message)</small>
738 echo '<p>' . yourls_s( 'Please <a href="%s">click here</a>', $location ) . '</p>';
740 yourls_do_action( 'post_redirect_javascript', $location );
744 * Return a HTTP status code
747 function yourls_get_HTTP_status( $code ) {
748 $code = intval( $code );
749 $headers_desc = array(
751 101 => 'Switching Protocols',
757 203 => 'Non-Authoritative Information',
759 205 => 'Reset Content',
760 206 => 'Partial Content',
761 207 => 'Multi-Status',
764 300 => 'Multiple Choices',
765 301 => 'Moved Permanently',
768 304 => 'Not Modified',
771 307 => 'Temporary Redirect',
773 400 => 'Bad Request',
774 401 => 'Unauthorized',
775 402 => 'Payment Required',
778 405 => 'Method Not Allowed',
779 406 => 'Not Acceptable',
780 407 => 'Proxy Authentication Required',
781 408 => 'Request Timeout',
784 411 => 'Length Required',
785 412 => 'Precondition Failed',
786 413 => 'Request Entity Too Large',
787 414 => 'Request-URI Too Long',
788 415 => 'Unsupported Media Type',
789 416 => 'Requested Range Not Satisfiable',
790 417 => 'Expectation Failed',
791 422 => 'Unprocessable Entity',
793 424 => 'Failed Dependency',
794 426 => 'Upgrade Required',
796 500 => 'Internal Server Error',
797 501 => 'Not Implemented',
798 502 => 'Bad Gateway',
799 503 => 'Service Unavailable',
800 504 => 'Gateway Timeout',
801 505 => 'HTTP Version Not Supported',
802 506 => 'Variant Also Negotiates',
803 507 => 'Insufficient Storage',
804 510 => 'Not Extended'
807 if ( isset( $headers_desc[$code] ) )
808 return $headers_desc[$code];
815 * Log a redirect (for stats)
818 function yourls_log_redirect( $keyword ) {
819 // Allow plugins to short-circuit the whole function
820 $pre = yourls_apply_filter( 'shunt_log_redirect', false, $keyword );
821 if ( false !== $pre )
824 if ( !yourls_do_log_redirect() )
828 $table = YOURLS_DB_TABLE_LOG;
830 $keyword = yourls_sanitize_string( $keyword );
831 $referrer = ( isset( $_SERVER['HTTP_REFERER'] ) ? yourls_sanitize_url( $_SERVER['HTTP_REFERER'] ) : 'direct' );
832 $ua = yourls_get_user_agent();
833 $ip = yourls_get_IP();
834 $location = yourls_geo_ip_to_countrycode( $ip );
836 return $ydb->query( "INSERT INTO `$table` (click_time, shorturl, referrer, user_agent, ip_address, country_code) VALUES (NOW(), '$keyword', '$referrer', '$ua', '$ip', '$location')" );
840 * Check if we want to not log redirects (for stats)
843 function yourls_do_log_redirect() {
844 return ( !defined( 'YOURLS_NOSTATS' ) || YOURLS_NOSTATS != true );
848 * Converts an IP to a 2 letter country code, using GeoIP database if available in includes/geo/
851 function yourls_geo_ip_to_countrycode( $ip = '', $default = '' ) {
852 // Allow plugins to short-circuit the Geo IP API
853 $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
854 if ( false !== $location )
857 if ( !file_exists( YOURLS_INC.'/geo/GeoIP.dat') || !file_exists( YOURLS_INC.'/geo/geoip.inc') )
861 $ip = yourls_get_IP();
863 require_once( YOURLS_INC.'/geo/geoip.inc') ;
864 $gi = geoip_open( YOURLS_INC.'/geo/GeoIP.dat', GEOIP_STANDARD);
865 $location = geoip_country_code_by_addr($gi, $ip);
868 return yourls_apply_filter( 'geo_ip_to_countrycode', $location, $ip, $default );
872 * Converts a 2 letter country code to long name (ie AU -> Australia)
875 function yourls_geo_countrycode_to_countryname( $code ) {
876 // Allow plugins to short-circuit the Geo IP API
877 $country = yourls_apply_filter( 'shunt_geo_countrycode_to_countryname', false, $code );
878 if ( false !== $country )
881 // Load the Geo class if not already done
882 if( !class_exists( 'GeoIP' ) ) {
883 $temp = yourls_geo_ip_to_countrycode( '127.0.0.1' );
886 if( class_exists( 'GeoIP' ) ) {
888 $id = $geo->GEOIP_COUNTRY_CODE_TO_NUMBER[ $code ];
889 $long = $geo->GEOIP_COUNTRY_NAMES[ $id ];
897 * Return flag URL from 2 letter country code
900 function yourls_geo_get_flag( $code ) {
901 if( file_exists( YOURLS_INC.'/geo/flags/flag_'.strtolower($code).'.gif' ) ) {
902 $img = yourls_match_current_protocol( YOURLS_SITE.'/includes/geo/flags/flag_'.( strtolower( $code ) ).'.gif' );
906 return yourls_apply_filter( 'geo_get_flag', $img, $code );
911 * Check if an upgrade is needed
914 function yourls_upgrade_is_needed() {
915 // check YOURLS_DB_VERSION exist && match values stored in YOURLS_DB_TABLE_OPTIONS
916 list( $currentver, $currentsql ) = yourls_get_current_version_from_sql();
917 if( $currentsql < YOURLS_DB_VERSION )
924 * Get current version & db version as stored in the options DB. Prior to 1.4 there's no option table.
927 function yourls_get_current_version_from_sql() {
928 $currentver = yourls_get_option( 'version' );
929 $currentsql = yourls_get_option( 'db_version' );
931 // Values if version is 1.3
937 return array( $currentver, $currentsql);
941 * Read an option from DB (or from cache if available). Return value or $default if not found
944 function yourls_get_option( $option_name, $default = false ) {
947 // Allow plugins to short-circuit options
948 $pre = yourls_apply_filter( 'shunt_option_'.$option_name, false );
949 if ( false !== $pre )
952 // If option not cached already, get its value from the DB
953 if ( !isset( $ydb->option[$option_name] ) ) {
954 $table = YOURLS_DB_TABLE_OPTIONS;
955 $option_name = yourls_escape( $option_name );
956 $row = $ydb->get_row( "SELECT `option_value` FROM `$table` WHERE `option_name` = '$option_name' LIMIT 1" );
957 if ( is_object( $row) ) { // Has to be get_row instead of get_var because of funkiness with 0, false, null values
958 $value = $row->option_value;
959 } else { // option does not exist, so we must cache its non-existence
962 $ydb->option[ $option_name ] = yourls_maybe_unserialize( $value );
965 return yourls_apply_filter( 'get_option_'.$option_name, $ydb->option[$option_name] );
969 * Read all options from DB at once
972 function yourls_get_all_options() {
975 // Allow plugins to short-circuit all options. (Note: regular plugins are loaded after all options)
976 $pre = yourls_apply_filter( 'shunt_all_options', false );
977 if ( false !== $pre )
980 $table = YOURLS_DB_TABLE_OPTIONS;
982 $allopt = $ydb->get_results( "SELECT `option_name`, `option_value` FROM `$table` WHERE 1=1" );
984 foreach( (array)$allopt as $option ) {
985 $ydb->option[$option->option_name] = yourls_maybe_unserialize( $option->option_value );
988 $ydb->option = yourls_apply_filter( 'get_all_options', $ydb->option );
992 * Update (add if doesn't exist) an option to DB
995 function yourls_update_option( $option_name, $newvalue ) {
997 $table = YOURLS_DB_TABLE_OPTIONS;
999 $safe_option_name = yourls_escape( $option_name );
1001 $oldvalue = yourls_get_option( $safe_option_name );
1003 // If the new and old values are the same, no need to update.
1004 if ( $newvalue === $oldvalue )
1007 if ( false === $oldvalue ) {
1008 yourls_add_option( $option_name, $newvalue );
1012 $_newvalue = yourls_escape( yourls_maybe_serialize( $newvalue ) );
1014 yourls_do_action( 'update_option', $option_name, $oldvalue, $newvalue );
1016 $ydb->query( "UPDATE `$table` SET `option_value` = '$_newvalue' WHERE `option_name` = '$option_name'" );
1018 if ( $ydb->rows_affected == 1 ) {
1019 $ydb->option[ $option_name ] = $newvalue;
1026 * Add an option to the DB
1029 function yourls_add_option( $name, $value = '' ) {
1031 $table = YOURLS_DB_TABLE_OPTIONS;
1032 $safe_name = yourls_escape( $name );
1034 // Make sure the option doesn't already exist
1035 if ( false !== yourls_get_option( $safe_name ) )
1038 $_value = yourls_escape( yourls_maybe_serialize( $value ) );
1040 yourls_do_action( 'add_option', $safe_name, $_value );
1042 $ydb->query( "INSERT INTO `$table` (`option_name`, `option_value`) VALUES ('$name', '$_value')" );
1043 $ydb->option[ $name ] = $value;
1049 * Delete an option from the DB
1052 function yourls_delete_option( $name ) {
1054 $table = YOURLS_DB_TABLE_OPTIONS;
1055 $name = yourls_escape( $name );
1057 // Get the ID, if no ID then return
1058 $option = $ydb->get_row( "SELECT option_id FROM `$table` WHERE `option_name` = '$name'" );
1059 if ( is_null( $option ) || !$option->option_id )
1062 yourls_do_action( 'delete_option', $option_name );
1064 $ydb->query( "DELETE FROM `$table` WHERE `option_name` = '$name'" );
1071 * Serialize data if needed. Stolen from WordPress
1074 function yourls_maybe_serialize( $data ) {
1075 if ( is_array( $data ) || is_object( $data ) )
1076 return serialize( $data );
1078 if ( yourls_is_serialized( $data ) )
1079 return serialize( $data );
1085 * Check value to find if it was serialized. Stolen from WordPress
1088 function yourls_is_serialized( $data ) {
1089 // if it isn't a string, it isn't serialized
1090 if ( !is_string( $data ) )
1092 $data = trim( $data );
1093 if ( 'N;' == $data )
1095 if ( !preg_match( '/^([adObis]):/', $data, $badions ) )
1097 switch ( $badions[1] ) {
1101 if ( preg_match( "/^{$badions[1]}:[0-9]+:.*[;}]\$/s", $data ) )
1107 if ( preg_match( "/^{$badions[1]}:[0-9.E-]+;\$/", $data ) )
1115 * Unserialize value only if it was serialized. Stolen from WP
1118 function yourls_maybe_unserialize( $original ) {
1119 if ( yourls_is_serialized( $original ) ) // don't attempt to unserialize data that wasn't serialized going in
1120 return @unserialize( $original );
1125 * Determine if the current page is private
1128 function yourls_is_private() {
1131 if ( defined('YOURLS_PRIVATE') && YOURLS_PRIVATE == true ) {
1133 // Allow overruling for particular pages:
1136 if( yourls_is_API() ) {
1137 if( !defined('YOURLS_PRIVATE_API') || YOURLS_PRIVATE_API != false )
1141 } elseif( yourls_is_infos() ) {
1142 if( !defined('YOURLS_PRIVATE_INFOS') || YOURLS_PRIVATE_INFOS !== false )
1152 return yourls_apply_filter( 'is_private', $private );
1156 * Show login form if required
1159 function yourls_maybe_require_auth() {
1160 if( yourls_is_private() )
1161 require_once( YOURLS_INC.'/auth.php' );
1165 * Allow several short URLs for the same long URL ?
1168 function yourls_allow_duplicate_longurls() {
1169 // special treatment if API to check for WordPress plugin requests
1170 if( yourls_is_API() ) {
1171 if ( isset($_REQUEST['source']) && $_REQUEST['source'] == 'plugin' )
1174 return ( defined( 'YOURLS_UNIQUE_URLS' ) && YOURLS_UNIQUE_URLS == false );
1178 * Return list of all shorturls associated to the same long URL. Returns NULL or array of keywords.
1181 function yourls_get_duplicate_keywords( $longurl ) {
1182 if( !yourls_allow_duplicate_longurls() )
1186 $longurl = yourls_escape( yourls_sanitize_url($longurl) );
1187 $table = YOURLS_DB_TABLE_URL;
1189 $return = $ydb->get_col( "SELECT `keyword` FROM `$table` WHERE `url` = '$longurl'" );
1190 return yourls_apply_filter( 'get_duplicate_keywords', $return, $longurl );
1194 * Check if an IP shortens URL too fast to prevent DB flood. Return true, or die.
1197 function yourls_check_IP_flood( $ip = '' ) {
1199 // Allow plugins to short-circuit the whole function
1200 $pre = yourls_apply_filter( 'shunt_check_IP_flood', false, $ip );
1201 if ( false !== $pre )
1204 yourls_do_action( 'pre_check_ip_flood', $ip ); // at this point $ip can be '', check it if your plugin hooks in here
1207 ( defined('YOURLS_FLOOD_DELAY_SECONDS') && YOURLS_FLOOD_DELAY_SECONDS === 0 ) ||
1208 !defined('YOURLS_FLOOD_DELAY_SECONDS')
1212 $ip = ( $ip ? yourls_sanitize_ip( $ip ) : yourls_get_IP() );
1214 // Don't throttle whitelist IPs
1215 if( defined( 'YOURLS_FLOOD_IP_WHITELIST' ) && YOURLS_FLOOD_IP_WHITELIST ) {
1216 $whitelist_ips = explode( ',', YOURLS_FLOOD_IP_WHITELIST );
1217 foreach( (array)$whitelist_ips as $whitelist_ip ) {
1218 $whitelist_ip = trim( $whitelist_ip );
1219 if ( $whitelist_ip == $ip )
1224 // Don't throttle logged in users
1225 if( yourls_is_private() ) {
1226 if( yourls_is_valid_user() === true )
1230 yourls_do_action( 'check_ip_flood', $ip );
1233 $table = YOURLS_DB_TABLE_URL;
1235 $lasttime = $ydb->get_var( "SELECT `timestamp` FROM $table WHERE `ip` = '$ip' ORDER BY `timestamp` DESC LIMIT 1" );
1238 $then = date( 'U', strtotime( $lasttime ) );
1239 if( ( $now - $then ) <= YOURLS_FLOOD_DELAY_SECONDS ) {
1241 yourls_do_action( 'ip_flood', $ip, $now - $then );
1242 yourls_die( yourls__( 'Too many URLs added too fast. Slow down please.' ), yourls__( 'Forbidden' ), 403 );
1250 * Check if YOURLS is installing
1255 function yourls_is_installing() {
1256 $installing = defined( 'YOURLS_INSTALLING' ) && YOURLS_INSTALLING == true;
1257 return yourls_apply_filter( 'is_installing', $installing );
1261 * Check if YOURLS is upgrading
1266 function yourls_is_upgrading() {
1267 $upgrading = defined( 'YOURLS_UPGRADING' ) && YOURLS_UPGRADING == true;
1268 return yourls_apply_filter( 'is_upgrading', $upgrading );
1273 * Check if YOURLS is installed
1276 function yourls_is_installed() {
1277 static $is_installed = false;
1278 if ( $is_installed === false ) {
1279 $check_14 = $check_13 = false;
1281 if( defined('YOURLS_DB_TABLE_NEXTDEC') )
1282 $check_13 = $ydb->get_var('SELECT `next_id` FROM '.YOURLS_DB_TABLE_NEXTDEC);
1283 $check_14 = yourls_get_option( 'version' );
1284 $is_installed = $check_13 || $check_14;
1286 return yourls_apply_filter( 'is_installed', $is_installed );
1290 * Generate random string of (int)$length length and type $type (see function for details)
1293 function yourls_rnd_string ( $length = 5, $type = 0, $charlist = '' ) {
1295 $length = intval( $length );
1297 // define possible characters
1300 // custom char list, or comply to charset as defined in config
1302 $possible = $charlist ? $charlist : yourls_get_shorturl_charset() ;
1305 // no vowels to make no offending word, no 0/1/o/l to avoid confusion between letters & digits. Perfect for passwords.
1307 $possible = "23456789bcdfghjkmnpqrstvwxyz";
1310 // Same, with lower + upper
1312 $possible = "23456789bcdfghjkmnpqrstvwxyzBCDFGHJKMNPQRSTVWXYZ";
1315 // all letters, lowercase
1317 $possible = "abcdefghijklmnopqrstuvwxyz";
1320 // all letters, lowercase + uppercase
1322 $possible = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
1325 // all digits & letters lowercase
1327 $possible = "0123456789abcdefghijklmnopqrstuvwxyz";
1330 // all digits & letters lowercase + uppercase
1332 $possible = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
1338 while ($i < $length) {
1339 $str .= substr($possible, mt_rand(0, strlen($possible)-1), 1);
1343 return yourls_apply_filter( 'rnd_string', $str, $length, $type, $charlist );
1347 * Return salted string
1350 function yourls_salt( $string ) {
1351 $salt = defined('YOURLS_COOKIEKEY') ? YOURLS_COOKIEKEY : md5(__FILE__) ;
1352 return yourls_apply_filter( 'yourls_salt', md5 ($string . $salt), $string );
1356 * Add a query var to a URL and return URL. Completely stolen from WP.
1358 * Works with one of these parameter patterns:
1359 * array( 'var' => 'value' )
1360 * array( 'var' => 'value' ), $url
1362 * 'var', 'value', $url
1363 * If $url ommited, uses $_SERVER['REQUEST_URI']
1366 function yourls_add_query_arg() {
1368 if ( is_array( func_get_arg(0) ) ) {
1369 if ( @func_num_args() < 2 || false === @func_get_arg( 1 ) )
1370 $uri = $_SERVER['REQUEST_URI'];
1372 $uri = @func_get_arg( 1 );
1374 if ( @func_num_args() < 3 || false === @func_get_arg( 2 ) )
1375 $uri = $_SERVER['REQUEST_URI'];
1377 $uri = @func_get_arg( 2 );
1380 $uri = str_replace( '&', '&', $uri );
1383 if ( $frag = strstr( $uri, '#' ) )
1384 $uri = substr( $uri, 0, -strlen( $frag ) );
1388 if ( preg_match( '|^https?://|i', $uri, $matches ) ) {
1389 $protocol = $matches[0];
1390 $uri = substr( $uri, strlen( $protocol ) );
1395 if ( strpos( $uri, '?' ) !== false ) {
1396 $parts = explode( '?', $uri, 2 );
1397 if ( 1 == count( $parts ) ) {
1401 $base = $parts[0] . '?';
1404 } elseif ( !empty( $protocol ) || strpos( $uri, '=' ) === false ) {
1412 parse_str( $query, $qs );
1413 $qs = yourls_urlencode_deep( $qs ); // this re-URL-encodes things that were already in the query string
1414 if ( is_array( func_get_arg( 0 ) ) ) {
1415 $kayvees = func_get_arg( 0 );
1416 $qs = array_merge( $qs, $kayvees );
1418 $qs[func_get_arg( 0 )] = func_get_arg( 1 );
1421 foreach ( (array) $qs as $k => $v ) {
1426 $ret = http_build_query( $qs );
1427 $ret = trim( $ret, '?' );
1428 $ret = preg_replace( '#=(&|$)#', '$1', $ret );
1429 $ret = $protocol . $base . $ret . $frag;
1430 $ret = rtrim( $ret, '?' );
1435 * Navigates through an array and encodes the values to be used in a URL. Stolen from WP, used in yourls_add_query_arg()
1438 function yourls_urlencode_deep( $value ) {
1439 $value = is_array( $value ) ? array_map( 'yourls_urlencode_deep', $value ) : urlencode( $value );
1444 * Remove arg from query. Opposite of yourls_add_query_arg. Stolen from WP.
1447 function yourls_remove_query_arg( $key, $query = false ) {
1448 if ( is_array( $key ) ) { // removing multiple keys
1449 foreach ( $key as $k )
1450 $query = yourls_add_query_arg( $k, false, $query );
1453 return yourls_add_query_arg( $key, false, $query );
1457 * Return a time-dependent string for nonce creation
1460 function yourls_tick() {
1461 return ceil( time() / YOURLS_NONCE_LIFE );
1465 * Create a time limited, action limited and user limited token
1468 function yourls_create_nonce( $action, $user = false ) {
1469 if( false == $user )
1470 $user = defined( 'YOURLS_USER' ) ? YOURLS_USER : '-1';
1471 $tick = yourls_tick();
1472 return substr( yourls_salt($tick . $action . $user), 0, 10 );
1476 * Create a nonce field for inclusion into a form
1479 function yourls_nonce_field( $action, $name = 'nonce', $user = false, $echo = true ) {
1480 $field = '<input type="hidden" id="'.$name.'" name="'.$name.'" value="'.yourls_create_nonce( $action, $user ).'" />';
1487 * Add a nonce to a URL. If URL omitted, adds nonce to current URL
1490 function yourls_nonce_url( $action, $url = false, $name = 'nonce', $user = false ) {
1491 $nonce = yourls_create_nonce( $action, $user );
1492 return yourls_add_query_arg( $name, $nonce, $url );
1496 * Check validity of a nonce (ie time span, user and action match).
1498 * Returns true if valid, dies otherwise (yourls_die() or die($return) if defined)
1499 * if $nonce is false or unspecified, it will use $_REQUEST['nonce']
1502 function yourls_verify_nonce( $action, $nonce = false, $user = false, $return = '' ) {
1504 if( false == $user )
1505 $user = defined( 'YOURLS_USER' ) ? YOURLS_USER : '-1';
1507 // get current nonce value
1508 if( false == $nonce && isset( $_REQUEST['nonce'] ) )
1509 $nonce = $_REQUEST['nonce'];
1511 // what nonce should be
1512 $valid = yourls_create_nonce( $action, $user );
1514 if( $nonce == $valid ) {
1519 yourls_die( yourls__( 'Unauthorized action or expired link' ), yourls__( 'Error' ), 403 );
1524 * Converts keyword into short link (prepend with YOURLS base URL)
1527 function yourls_link( $keyword = '' ) {
1528 $link = YOURLS_SITE . '/' . yourls_sanitize_keyword( $keyword );
1529 return yourls_apply_filter( 'yourls_link', $link, $keyword );
1533 * Converts keyword into stat link (prepend with YOURLS base URL, append +)
1536 function yourls_statlink( $keyword = '' ) {
1537 $link = YOURLS_SITE . '/' . yourls_sanitize_keyword( $keyword ) . '+';
1538 if( yourls_is_ssl() )
1539 $link = str_replace( 'http://', 'https://', $link );
1540 return yourls_apply_filter( 'yourls_statlink', $link, $keyword );
1544 * Check if we're in API mode. Returns bool
1547 function yourls_is_API() {
1548 if ( defined( 'YOURLS_API' ) && YOURLS_API == true )
1554 * Check if we're in Ajax mode. Returns bool
1557 function yourls_is_Ajax() {
1558 if ( defined( 'YOURLS_AJAX' ) && YOURLS_AJAX == true )
1564 * Check if we're in GO mode (yourls-go.php). Returns bool
1567 function yourls_is_GO() {
1568 if ( defined( 'YOURLS_GO' ) && YOURLS_GO == true )
1574 * Check if we're displaying stats infos (yourls-infos.php). Returns bool
1577 function yourls_is_infos() {
1578 if ( defined( 'YOURLS_INFOS' ) && YOURLS_INFOS == true )
1584 * Check if we'll need interface display function (ie not API or redirection)
1587 function yourls_has_interface() {
1588 if( yourls_is_API() or yourls_is_GO() )
1594 * Check if we're in the admin area. Returns bool
1597 function yourls_is_admin() {
1598 if ( defined( 'YOURLS_ADMIN' ) && YOURLS_ADMIN == true )
1604 * Check if the server seems to be running on Windows. Not exactly sure how reliable this is.
1607 function yourls_is_windows() {
1608 return defined( 'DIRECTORY_SEPARATOR' ) && DIRECTORY_SEPARATOR == '\\';
1612 * Check if SSL is required. Returns bool.
1615 function yourls_needs_ssl() {
1616 if ( defined('YOURLS_ADMIN_SSL') && YOURLS_ADMIN_SSL == true )
1622 * Return admin link, with SSL preference if applicable.
1625 function yourls_admin_url( $page = '' ) {
1626 $admin = YOURLS_SITE . '/admin/' . $page;
1627 if( yourls_is_ssl() or yourls_needs_ssl() )
1628 $admin = str_replace('http://', 'https://', $admin);
1629 return yourls_apply_filter( 'admin_url', $admin, $page );
1633 * Return YOURLS_SITE or URL under YOURLS setup, with SSL preference
1636 function yourls_site_url( $echo = true, $url = '' ) {
1637 $url = yourls_get_relative_url( $url );
1638 $url = trim( YOURLS_SITE . '/' . $url, '/' );
1640 // Do not enforce (checking yourls_need_ssl() ) but check current usage so it won't force SSL on non-admin pages
1641 if( yourls_is_ssl() )
1642 $url = str_replace( 'http://', 'https://', $url );
1643 $url = yourls_apply_filter( 'site_url', $url );
1650 * Check if SSL is used, returns bool. Stolen from WP.
1653 function yourls_is_ssl() {
1655 if ( isset( $_SERVER['HTTPS'] ) ) {
1656 if ( 'on' == strtolower( $_SERVER['HTTPS'] ) )
1658 if ( '1' == $_SERVER['HTTPS'] )
1660 } elseif ( isset( $_SERVER['SERVER_PORT'] ) && ( '443' == $_SERVER['SERVER_PORT'] ) ) {
1663 return yourls_apply_filter( 'is_ssl', $is_ssl );
1668 * Get a remote page <title>, return a string (either title or url)
1671 function yourls_get_remote_title( $url ) {
1672 // Allow plugins to short-circuit the whole function
1673 $pre = yourls_apply_filter( 'shunt_get_remote_title', false, $url );
1674 if ( false !== $pre )
1677 require_once( YOURLS_INC.'/functions-http.php' );
1679 $url = yourls_sanitize_url( $url );
1681 $title = $charset = false;
1683 $content = yourls_get_remote_content( $url );
1685 // If false, return url as title.
1686 // Todo: improve this with temporary title when shorturl_meta available?
1687 if( false === $content )
1690 if( $content !== false ) {
1692 if ( preg_match('/<title>(.*?)<\/title>/is', $content, $found ) ) {
1698 // <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
1699 if ( preg_match('/<meta[^>]*?charset=([^>]*?)\/?>/is', $content, $found ) ) {
1700 $charset = trim($found[1], '"\' ');
1705 // if title not found, guess if returned content was actually an error message
1706 if( $title == false && strpos( $content, 'Error' ) === 0 ) {
1710 if( $title == false )
1714 if( !yourls_seems_utf8( $title ) )
1715 $title = utf8_encode( $title );
1718 // Charset conversion. We use @ to remove warnings (mb_ functions are easily bitching about illegal chars)
1719 if( function_exists( 'mb_convert_encoding' ) ) {
1721 $title = @mb_convert_encoding( $title, 'UTF-8', $charset );
1723 $title = @mb_convert_encoding( $title, 'UTF-8' );
1727 // Remove HTML entities
1728 $title = html_entity_decode( $title, ENT_QUOTES, 'UTF-8' );
1730 // Strip out evil things
1731 $title = yourls_sanitize_title( $title );
1733 return yourls_apply_filter( 'get_remote_title', $title, $url );
1737 * Quick UA check for mobile devices. Return boolean.
1740 function yourls_is_mobile_device() {
1743 'android', 'blackberry', 'blazer',
1744 'compal', 'elaine', 'fennec', 'hiptop',
1745 'iemobile', 'iphone', 'ipod', 'ipad',
1746 'iris', 'kindle', 'opera mobi', 'opera mini',
1747 'palm', 'phone', 'pocket', 'psp', 'symbian',
1748 'treo', 'wap', 'windows ce', 'windows phone'
1751 // Current user-agent
1752 $current = strtolower( $_SERVER['HTTP_USER_AGENT'] );
1755 $is_mobile = ( str_replace( $mobiles, '', $current ) != $current );
1756 return yourls_apply_filter( 'is_mobile_device', $is_mobile );
1760 * Get request in YOURLS base (eg in 'http://site.com/yourls/abcd' get 'abdc')
1763 function yourls_get_request() {
1764 // Allow plugins to short-circuit the whole function
1765 $pre = yourls_apply_filter( 'shunt_get_request', false );
1766 if ( false !== $pre )
1769 static $request = null;
1771 yourls_do_action( 'pre_get_request', $request );
1773 if( $request !== null )
1776 // Ignore protocol & www. prefix
1777 $root = str_replace( array( 'https://', 'http://', 'https://www.', 'http://www.' ), '', YOURLS_SITE );
1778 // Case insensitive comparison of the YOURLS root to match both http://Sho.rt/blah and http://sho.rt/blah
1779 $request = preg_replace( "!$root/!i", '', $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], 1 );
1781 // Unless request looks like a full URL (ie request is a simple keyword) strip query string
1782 if( !preg_match( "@^[a-zA-Z]+://.+@", $request ) ) {
1783 $request = current( explode( '?', $request ) );
1786 return yourls_apply_filter( 'get_request', $request );
1790 * Change protocol to match current scheme used (http or https)
1793 function yourls_match_current_protocol( $url, $normal = 'http', $ssl = 'https' ) {
1794 if( yourls_is_ssl() )
1795 $url = str_replace( $normal, $ssl, $url );
1796 return yourls_apply_filter( 'match_current_protocol', $url );
1800 * Fix $_SERVER['REQUEST_URI'] variable for various setups. Stolen from WP.
1803 function yourls_fix_request_uri() {
1805 $default_server_values = array(
1806 'SERVER_SOFTWARE' => '',
1807 'REQUEST_URI' => '',
1809 $_SERVER = array_merge( $default_server_values, $_SERVER );
1811 // Fix for IIS when running with PHP ISAPI
1812 if ( empty( $_SERVER['REQUEST_URI'] ) || ( php_sapi_name() != 'cgi-fcgi' && preg_match( '/^Microsoft-IIS\//', $_SERVER['SERVER_SOFTWARE'] ) ) ) {
1815 if ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] ) ) {
1816 $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_ORIGINAL_URL'];
1818 // IIS Isapi_Rewrite
1819 else if ( isset( $_SERVER['HTTP_X_REWRITE_URL'] ) ) {
1820 $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_REWRITE_URL'];
1822 // Use ORIG_PATH_INFO if there is no PATH_INFO
1823 if ( !isset( $_SERVER['PATH_INFO'] ) && isset( $_SERVER['ORIG_PATH_INFO'] ) )
1824 $_SERVER['PATH_INFO'] = $_SERVER['ORIG_PATH_INFO'];
1826 // Some IIS + PHP configurations puts the script-name in the path-info (No need to append it twice)
1827 if ( isset( $_SERVER['PATH_INFO'] ) ) {
1828 if ( $_SERVER['PATH_INFO'] == $_SERVER['SCRIPT_NAME'] )
1829 $_SERVER['REQUEST_URI'] = $_SERVER['PATH_INFO'];
1831 $_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME'] . $_SERVER['PATH_INFO'];
1834 // Append the query string if it exists and isn't null
1835 if ( ! empty( $_SERVER['QUERY_STRING'] ) ) {
1836 $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING'];
1843 * Shutdown function, runs just before PHP shuts down execution. Stolen from WP
1846 function yourls_shutdown() {
1847 yourls_do_action( 'shutdown' );
1851 * Auto detect custom favicon in /user directory, fallback to YOURLS favicon, and echo/return its URL
1854 function yourls_favicon( $echo = true ) {
1855 static $favicon = null;
1856 if( $favicon !== null )
1860 // search for favicon.(gif|ico|png|jpg|svg)
1861 foreach( array( 'gif', 'ico', 'png', 'jpg', 'svg' ) as $ext ) {
1862 if( file_exists( YOURLS_USERDIR. '/favicon.' . $ext ) ) {
1863 $custom = 'favicon.' . $ext;
1869 $favicon = yourls_site_url( false, YOURLS_USERURL . '/' . $custom );
1871 $favicon = yourls_site_url( false ) . '/images/favicon.gif';
1879 * Check for maintenance mode. If yes, die. See yourls_maintenance_mode(). Stolen from WP.
1882 function yourls_check_maintenance_mode() {
1884 $file = YOURLS_ABSPATH . '/.maintenance' ;
1885 if ( !file_exists( $file ) || yourls_is_upgrading() || yourls_is_installing() )
1888 global $maintenance_start;
1891 // If the $maintenance_start timestamp is older than 10 minutes, don't die.
1892 if ( ( time() - $maintenance_start ) >= 600 )
1895 // Use any /user/maintenance.php file
1896 if( file_exists( YOURLS_USERDIR.'/maintenance.php' ) ) {
1897 include( YOURLS_USERDIR.'/maintenance.php' );
1901 // https://www.youtube.com/watch?v=Xw-m4jEY-Ns
1902 $title = yourls__( 'Service temporarily unavailable' );
1903 $message = yourls__( 'Our service is currently undergoing scheduled maintenance.' ) . "</p>\n<p>" .
1904 yourls__( 'Things should not last very long, thank you for your patience and please excuse the inconvenience' );
1905 yourls_die( $message, $title , 503 );
1910 * Return current admin page, or null if not an admin page
1912 * @return mixed string if admin page, null if not an admin page
1915 function yourls_current_admin_page() {
1916 if( yourls_is_admin() ) {
1917 $current = substr( yourls_get_request(), 6 );
1918 if( $current === false )
1919 $current = 'index.php'; // if current page is http://sho.rt/admin/ instead of http://sho.rt/admin/index.php
1927 * Check if a URL protocol is allowed
1929 * Checks a URL against a list of whitelisted protocols. Protocols must be defined with
1930 * their complete scheme name, ie 'stuff:' or 'stuff://' (for instance, 'mailto:' is a valid
1931 * protocol, 'mailto://' isn't, and 'http:' with no double slashed isn't either
1935 * @param string $url URL to be check
1936 * @param array $protocols Optional. Array of protocols, defaults to global $yourls_allowedprotocols
1937 * @return boolean true if protocol allowed, false otherwise
1939 function yourls_is_allowed_protocol( $url, $protocols = array() ) {
1940 if( ! $protocols ) {
1941 global $yourls_allowedprotocols;
1942 $protocols = $yourls_allowedprotocols;
1945 $protocol = yourls_get_protocol( $url );
1946 return yourls_apply_filter( 'is_allowed_protocol', in_array( $protocol, $protocols ), $url, $protocols );
1950 * Get protocol from a URL (eg mailto:, http:// ...)
1954 * @param string $url URL to be check
1955 * @return string Protocol, with slash slash if applicable. Empty string if no protocol
1957 function yourls_get_protocol( $url ) {
1958 preg_match( '!^[a-zA-Z0-9\+\.-]+:(//)?!', $url, $matches );
1960 http://en.wikipedia.org/wiki/URI_scheme#Generic_syntax
1961 The scheme name consists of a sequence of characters beginning with a letter and followed by any
1962 combination of letters, digits, plus ("+"), period ("."), or hyphen ("-"). Although schemes are
1963 case-insensitive, the canonical form is lowercase and documents that specify schemes must do so
1964 with lowercase letters. It is followed by a colon (":").
1966 $protocol = ( isset( $matches[0] ) ? $matches[0] : '' );
1967 return yourls_apply_filter( 'get_protocol', $protocol, $url );
1971 * Get relative URL (eg 'abc' from 'http://sho.rt/abc')
1973 * Treat indifferently http & https. If a URL isn't relative to the YOURLS install, return it as is
1974 * or return empty string if $strict is true
1977 * @param string $url URL to relativize
1978 * @param bool $strict if true and if URL isn't relative to YOURLS install, return empty string
1979 * @return string URL
1981 function yourls_get_relative_url( $url, $strict = true ) {
1982 $url = yourls_sanitize_url( $url );
1984 // Remove protocols to make it easier
1985 $noproto_url = str_replace( 'https:', 'http:', $url );
1986 $noproto_site = str_replace( 'https:', 'http:', YOURLS_SITE );
1988 // Trim URL from YOURLS root URL : if no modification made, URL wasn't relative
1989 $_url = str_replace( $noproto_site . '/', '', $noproto_url );
1990 if( $_url == $noproto_url )
1991 $_url = ( $strict ? '' : $url );
1993 return yourls_apply_filter( 'get_relative_url', $_url, $url );
1997 * Marks a function as deprecated and informs when it has been used. Stolen from WP.
1999 * There is a hook deprecated_function that will be called that can be used
2000 * to get the backtrace up to what file and function called the deprecated
2003 * The current behavior is to trigger a user error if YOURLS_DEBUG is true.
2005 * This function is to be used in every function that is deprecated.
2008 * @uses yourls_do_action() Calls 'deprecated_function' and passes the function name, what to use instead,
2009 * and the version the function was deprecated in.
2010 * @uses yourls_apply_filters() Calls 'deprecated_function_trigger_error' and expects boolean value of true to do
2011 * trigger or false to not trigger error.
2013 * @param string $function The function that was called
2014 * @param string $version The version of WordPress that deprecated the function
2015 * @param string $replacement Optional. The function that should have been called
2017 function yourls_deprecated_function( $function, $version, $replacement = null ) {
2019 yourls_do_action( 'deprecated_function', $function, $replacement, $version );
2021 // Allow plugin to filter the output error trigger
2022 if ( YOURLS_DEBUG && yourls_apply_filters( 'deprecated_function_trigger_error', true ) ) {
2023 if ( ! is_null( $replacement ) )
2024 trigger_error( sprintf( yourls__('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $function, $version, $replacement ) );
2026 trigger_error( sprintf( yourls__('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $function, $version ) );
2031 * Return the value if not an empty string
2033 * Used with array_filter(), to remove empty keys but not keys with value 0 or false
2036 * @param mixed $val Value to test against ''
2037 * @return bool True if not an empty string
2039 function yourls_return_if_not_empty_string( $val ) {
2040 return( $val !== '' );