header and logo
*
*/
function yourls_html_logo() {
yourls_do_action( 'pre_html_logo' );
?>
tag
*
* @param string $context Context of the page (stats, index, infos, ...)
* @param string $title HTML title of the page
*/
function yourls_html_head( $context = 'index', $title = '' ) {
yourls_do_action( 'pre_html_head', $context, $title );
// All components to false, except when specified true
$share = $insert = $tablesorter = $tabs = $cal = $charts = false;
// Load components as needed
switch ( $context ) {
case 'infos':
$share = $tabs = $charts = true;
break;
case 'bookmark':
$share = $insert = $tablesorter = true;
break;
case 'index':
$insert = $tablesorter = $cal = $share = true;
break;
case 'plugins':
case 'tools':
$tablesorter = true;
break;
case 'install':
case 'login':
case 'new':
case 'upgrade':
break;
}
// Force no cache for all admin pages
if( yourls_is_admin() && !headers_sent() ) {
header( 'Expires: Thu, 23 Mar 1972 07:00:00 GMT' );
header( 'Last-Modified: ' . gmdate( 'D, d M Y H:i:s' ) . ' GMT' );
header( 'Cache-Control: no-cache, must-revalidate, max-age=0' );
header( 'Pragma: no-cache' );
yourls_content_type_header( yourls_apply_filter( 'html_head_content-type', 'text/html' ) );
yourls_do_action( 'admin_headers', $context, $title );
}
// Store page context in global object
global $ydb;
$ydb->context = $context;
// Body class
$bodyclass = yourls_apply_filter( 'bodyclass', '' );
$bodyclass .= ( yourls_is_mobile_device() ? 'mobile' : 'desktop' );
// Page title
$_title = 'YOURLS — Your Own URL Shortener | ' . yourls_link();
$title = $title ? $title . " « " . $_title : $_title;
$title = yourls_apply_filter( 'html_title', $title, $context );
?>
>
num_queries ), $ydb->num_queries );
?>
';
echo join( "\n", $ydb->debug_log );
echo '';
} ?>
context ); ?>
'Text displayed'
* @param string $selected optional 'value' from the $options array that will be highlighted
* @param boolean $display false (default) to return, true to echo
* @return string HTML content of the select element
*/
function yourls_html_select( $name, $options, $selected = '', $display = false ) {
$html = "\n";
foreach( $options as $value => $text ) {
$html .= "' . yourls__( 'Your short link' ) . '';
if ( $share_title == '' )
$share_title = '' . yourls__( 'Quick Share' ) . ' ';
// Allow plugins to short-circuit the whole function
$pre = yourls_apply_filter( 'shunt_share_box', false );
if ( false !== $pre )
return $pre;
$text = ( $text ? '"'.$text.'" ' : '' );
$title = ( $title ? "$title " : '' );
$share = yourls_esc_textarea( $title.$text.$shorturl );
$count = 140 - strlen( $share );
$hidden = ( $hidden ? 'style="display:none;"' : '' );
// Allow plugins to filter all data
$data = compact( 'longurl', 'shorturl', 'title', 'text', 'shortlink_title', 'share_title', 'share', 'count', 'hidden' );
$data = yourls_apply_filter( 'share_box_data', $data );
extract( $data );
$_share = rawurlencode( $share );
$_url = rawurlencode( $shorturl );
?>
$title" );
echo yourls_apply_filter( 'die_message', "$message
" );
// Hook into 'yourls_die' to add more elements or messages to that page
yourls_do_action( 'yourls_die' );
if( !yourls_did_action( 'html_footer' ) ) {
yourls_html_footer();
}
die();
}
/**
* Return an "Edit" row for the main table
*
* @param string $keyword Keyword to edit
* @return string HTML of the edit row
*/
function yourls_table_edit_row( $keyword ) {
$keyword = yourls_sanitize_string( $keyword );
$id = yourls_string2htmlid( $keyword ); // used as HTML #id
$url = yourls_get_keyword_longurl( $keyword );
$title = htmlspecialchars( yourls_get_keyword_title( $keyword ) );
$safe_url = yourls_esc_attr( rawurldecode( $url ) );
$safe_title = yourls_esc_attr( $title );
// Make strings sprintf() safe: '%' -> '%%'
$safe_url = str_replace( '%', '%%', $safe_url );
$safe_title = str_replace( '%', '%%', $safe_title );
$www = yourls_link();
$nonce = yourls_create_nonce( 'edit-save_'.$id );
if( $url ) {
$return = <<%s :%s : $www%s :
RETURN;
$return = sprintf( $return, yourls__( 'Long URL' ), yourls__( 'Short URL' ), yourls__( 'Title' ), yourls__( 'Save' ), yourls__( 'Save new values' ), yourls__( 'Cancel' ), yourls__( 'Cancel editing' ) );
} else {
$return = '' . yourls__( 'Error, URL not found' ) . ' ';
}
$return = yourls_apply_filter( 'table_edit_row', $return, $keyword, $url, $title );
return $return;
}
/**
* Return an "Add" row for the main table
*
* @return string HTML of the edit row
*/
function yourls_table_add_row( $keyword, $url, $title = '', $ip, $clicks, $timestamp ) {
$keyword = yourls_sanitize_string( $keyword );
$id = yourls_string2htmlid( $keyword ); // used as HTML #id
$shorturl = yourls_link( $keyword );
$statlink = yourls_statlink( $keyword );
$delete_link = yourls_nonce_url( 'delete-link_'.$id,
yourls_add_query_arg( array( 'id' => $id, 'action' => 'delete', 'keyword' => $keyword ), yourls_admin_url( 'admin-ajax.php' ) )
);
$edit_link = yourls_nonce_url( 'edit-link_'.$id,
yourls_add_query_arg( array( 'id' => $id, 'action' => 'edit', 'keyword' => $keyword ), yourls_admin_url( 'admin-ajax.php' ) )
);
// Action link buttons: the array
$actions = array(
'stats' => array(
'href' => $statlink,
'id' => "statlink-$id",
'title' => yourls_esc_attr__( 'Stats' ),
'anchor' => yourls__( 'Stats' ),
),
'share' => array(
'href' => '',
'id' => "share-button-$id",
'title' => yourls_esc_attr__( 'Share' ),
'anchor' => yourls__( 'Share' ),
'onclick' => "toggle_share('$id');return false;",
),
'edit' => array(
'href' => $edit_link,
'id' => "edit-button-$id",
'title' => yourls_esc_attr__( 'Edit' ),
'anchor' => yourls__( 'Edit' ),
'onclick' => "edit_link_display('$id');return false;",
),
'delete' => array(
'href' => $delete_link,
'id' => "delete-button-$id",
'title' => yourls_esc_attr__( 'Delete' ),
'anchor' => yourls__( 'Delete' ),
'onclick' => "remove_link('$id');return false;",
)
);
$actions = yourls_apply_filter( 'table_add_row_action_array', $actions );
// Action link buttons: the HTML
$action_links = '';
foreach( $actions as $key => $action ) {
$onclick = isset( $action['onclick'] ) ? 'onclick="' . $action['onclick'] . '"' : '' ;
$action_links .= sprintf( '%s ',
$action['href'], $action['id'], $action['title'], 'button button_'.$key, $onclick, $action['anchor']
);
}
$action_links = yourls_apply_filter( 'action_links', $action_links, $keyword, $url, $ip, $clicks, $timestamp );
if( ! $title )
$title = $url;
$protocol_warning = '';
if( ! in_array( yourls_get_protocol( $url ) , array( 'http://', 'https://' ) ) )
$protocol_warning = yourls_apply_filter( 'add_row_protocol_warning', '★ ' );
// Row cells: the array
$cells = array(
'keyword' => array(
'template' => '%keyword_html% ',
'shorturl' => yourls_esc_url( $shorturl ),
'keyword_html' => yourls_esc_html( $keyword ),
),
'url' => array(
'template' => '%title_html% %warning%%long_url_html% ',
'long_url' => yourls_esc_url( $url ),
'title_attr' => yourls_esc_attr( $title ),
'title_html' => yourls_esc_html( yourls_trim_long_string( $title ) ),
'long_url_html' => yourls_esc_html( yourls_trim_long_string( $url ) ),
'warning' => $protocol_warning,
),
'timestamp' => array(
'template' => '%date%',
'date' => date( 'M d, Y H:i', $timestamp +( YOURLS_HOURS_OFFSET * 3600 ) ),
),
'ip' => array(
'template' => '%ip%',
'ip' => $ip,
),
'clicks' => array(
'template' => '%clicks%',
'clicks' => yourls_number_format_i18n( $clicks, 0, '', '' ),
),
'actions' => array(
'template' => '%actions% ',
'actions' => $action_links,
'id' => $id,
'keyword' => $keyword,
),
);
$cells = yourls_apply_filter( 'table_add_row_cell_array', $cells, $keyword, $url, $title, $ip, $clicks, $timestamp );
// Row cells: the HTML. Replace every %stuff% in 'template' with 'stuff' value.
$row = "";
foreach( $cells as $cell_id => $elements ) {
$callback = new yourls_table_add_row_callback( $elements );
$row .= sprintf( '', $cell_id, $cell_id . '-' . $id );
$row .= preg_replace_callback( '/%([^%]+)?%/', array( $callback, 'callback' ), $elements['template'] );
// For the record, in PHP 5.3+ we don't need to introduce a class in order to pass additional parameters
// to the callback function. Instead, we would have used the 'use' keyword :
// $row .= preg_replace_callback( '/%([^%]+)?%/', function( $match ) use ( $elements ) { return $elements[ $match[1] ]; }, $elements['template'] );
$row .= ' ';
}
$row .= " ";
$row = yourls_apply_filter( 'table_add_row', $row, $keyword, $url, $title, $ip, $clicks, $timestamp );
return $row;
}
/**
* Callback class for yourls_table_add_row
*
* See comment about PHP 5.3+ in yourls_table_add_row()
*
* @since 1.7
*/
class yourls_table_add_row_callback {
private $elements;
function __construct($elements) {
$this->elements = $elements;
}
function callback( $matches ) {
return $this->elements[ $matches[1] ];
}
}
/**
* Echo the main table head
*
*/
function yourls_table_head() {
$start = ''."\n";
echo yourls_apply_filter( 'table_head_start', $start );
$cells = yourls_apply_filter( 'table_head_cells', array(
'shorturl' => yourls__( 'Short URL' ),
'longurl' => yourls__( 'Original URL' ),
'date' => yourls__( 'Date' ),
'ip' => yourls__( 'IP' ),
'clicks' => yourls__( 'Clicks' ),
'actions' => yourls__( 'Actions' )
) );
foreach( $cells as $k => $v ) {
echo "$v \n";
}
$end = " \n";
echo yourls_apply_filter( 'table_head_end', $end );
}
/**
* Echo the tbody start tag
*
*/
function yourls_table_tbody_start() {
echo yourls_apply_filter( 'table_tbody_start', '' );
}
/**
* Echo the tbody end tag
*
*/
function yourls_table_tbody_end() {
echo yourls_apply_filter( 'table_tbody_end', ' ' );
}
/**
* Echo the table start tag
*
*/
function yourls_table_end() {
echo yourls_apply_filter( 'table_end', '
' );
}
/**
* Echo HTML tag for a link
*
*/
function yourls_html_link( $href, $title = '', $element = '' ) {
if( !$title )
$title = $href;
if( $element )
$element = sprintf( 'id="%s"', yourls_esc_attr( $element ) );
$link = sprintf( '%s ', yourls_esc_url( $href ), $element, yourls_esc_html( $title ) );
echo yourls_apply_filter( 'html_link', $link );
}
/**
* Display the login screen. Nothing past this point.
*
*/
function yourls_login_screen( $error_msg = '' ) {
yourls_html_head( 'login' );
$action = ( isset( $_GET['action'] ) && $_GET['action'] == 'logout' ? '?' : '' );
yourls_html_logo();
?>
%s'), YOURLS_USER ) . ' (' . yourls__( 'Logout' ) . ' )' );
} else {
$logout_link = yourls_apply_filter( 'logout_link', '' );
}
$help_link = yourls_apply_filter( 'help_link', '' . yourls__( 'Help' ) . ' ' );
$admin_links = array();
$admin_sublinks = array();
$admin_links['admin'] = array(
'url' => yourls_admin_url( 'index.php' ),
'title' => yourls__( 'Go to the admin interface' ),
'anchor' => yourls__( 'Admin interface' )
);
if( yourls_is_admin() ) {
$admin_links['tools'] = array(
'url' => yourls_admin_url( 'tools.php' ),
'anchor' => yourls__( 'Tools' )
);
$admin_links['plugins'] = array(
'url' => yourls_admin_url( 'plugins.php' ),
'anchor' => yourls__( 'Manage Plugins' )
);
$admin_sublinks['plugins'] = yourls_list_plugin_admin_pages();
}
$admin_links = yourls_apply_filter( 'admin_links', $admin_links );
$admin_sublinks = yourls_apply_filter( 'admin_sublinks', $admin_sublinks );
// Now output menu
echo '\n";
yourls_do_action( 'admin_notices' );
yourls_do_action( 'admin_notice' ); // because I never remember if it's 'notices' or 'notice'
/*
To display a notice:
$message = "OMG, dude, I mean!
" );
yourls_add_action( 'admin_notices', create_function( '', "echo '$message';" ) );
*/
}
/**
* Wrapper function to display admin notices
*
*/
function yourls_add_notice( $message, $style = 'notice' ) {
// Escape single quotes in $message to avoid breaking the anonymous function
$message = yourls_notice_box( strtr( $message, array( "'" => "\'" ) ), $style );
yourls_add_action( 'admin_notices', create_function( '', "echo '$message';" ) );
}
/**
* Return a formatted notice
*
*/
function yourls_notice_box( $message, $style = 'notice' ) {
return <<
$message
HTML;
}
/**
* Display a page
*
*/
function yourls_page( $page ) {
$include = YOURLS_ABSPATH . "/pages/$page.php";
if( !file_exists( $include ) ) {
yourls_die( "Page '$page' not found", 'Not found', 404 );
}
yourls_do_action( 'pre_page', $page );
include_once( $include );
yourls_do_action( 'post_page', $page );
die();
}
/**
* Display the language attributes for the HTML tag.
*
* Builds up a set of html attributes containing the text direction and language
* information for the page. Stolen from WP.
*
* @since 1.6
*/
function yourls_html_language_attributes() {
$attributes = array();
$output = '';
$attributes[] = ( yourls_is_rtl() ? 'dir="rtl"' : 'dir="ltr"' );
$doctype = yourls_apply_filter( 'html_language_attributes_doctype', 'html' );
// Experimental: get HTML lang from locale. Should work. Convert fr_FR -> fr-FR
if ( $lang = str_replace( '_', '-', yourls_get_locale() ) ) {
if( $doctype == 'xhtml' ) {
$attributes[] = "xml:lang=\"$lang\"";
} else {
$attributes[] = "lang=\"$lang\"";
}
}
$output = implode( ' ', $attributes );
$output = yourls_apply_filter( 'html_language_attributes', $output );
echo $output;
}
/**
* Output translated strings used by the Javascript calendar
*
* @since 1.6
*/
function yourls_l10n_calendar_strings() {
echo "\n\n";
// Dummy returns, to initialize l10n strings used in the calendar
yourls__( 'Today' );
yourls__( 'Close' );
}
/**
* Display a notice if there is a newer version of YOURLS available
*
* @since 1.7
*/
function yourls_new_core_version_notice() {
yourls_debug_log( 'Check for new version: ' . ( yourls_maybe_check_core_version() ? 'yes' : 'no' ) );
$checks = yourls_get_option( 'core_version_checks' );
if( isset( $checks->last_result->latest ) AND version_compare( $checks->last_result->latest, YOURLS_VERSION, '>' ) ) {
$msg = yourls_s( 'YOURLS version %s is available. Please update!', 'http://yourls.org/download', $checks->last_result->latest );
yourls_add_notice( $msg );
}
}
/**
* Send a filerable content type header
*
* @since 1.7
* @param string $type content type ('text/html', 'application/json', ...)
* @return bool whether header was sent
*/
function yourls_content_type_header( $type ) {
yourls_do_action( 'content_type_header', $type );
if( !headers_sent() ) {
$charset = yourls_apply_filter( 'content_type_header_charset', 'utf-8' );
header( "Content-Type: $type; charset=$charset" );
return true;
}
return false;
}
/**
* Get search text from query string variables search_protocol, search_slashes and search
*
* Some servers don't like query strings containing "(ht|f)tp(s)://". A javascript bit
* explodes the search text into protocol, slashes and the rest (see JS function
* split_search_text_before_search()) and this function glues pieces back together
* See issue https://github.com/YOURLS/YOURLS/issues/1576
*
* @since 1.7
* @return string Search string
*/
function yourls_get_search_text() {
$search = '';
if( isset( $_GET['search_protocol'] ) )
$search .= $_GET['search_protocol'];
if( isset( $_GET['search_slashes'] ) )
$search .= $_GET['search_slashes'];
if( isset( $_GET['search'] ) )
$search .= $_GET['search'];
return htmlspecialchars( trim( $search ) );
}
/**
* Display or return HTML for a bookmarklet link
*
* @since 1.7.1
* @param string $href bookmarklet link (presumably minified code with "javascript:" scheme)
* @param string $anchor link anchor
* @param bool $echo true to display, false to return the HTML
* @return string the HTML for a bookmarklet link
*/
function yourls_bookmarklet_link( $href, $anchor, $echo = true ) {
$alert = yourls_esc_attr__( 'Drag to your toolbar!' );
$link = << $anchor
LINK;
if( $echo )
echo $link;
return $link;
}