includes/functions-html.php

   1 <?php
   2
   3 /**
   4  * Display <h1> header and logo
   5  *
   6  */
   7 function yourls_html_logo() {
   8         yourls_do_action( 'pre_html_logo' );
   9         ?>
  10         <h1>
  11                 <a href="<?php echo yourls_admin_url( 'index.php' ) ?>" title="YOURLS"><span>YOURLS</span>: <span>Y</span>our <span>O</span>wn <span>URL</span> <span>S</span>hortener<br/>
  12                 <img src="<?php yourls_site_url(); ?>/images/yourls-logo.png" alt="YOURLS" title="YOURLS" border="0" style="border: 0px;" /></a>
  13         </h1>
  14         <?php
  15         yourls_do_action( 'html_logo' );
  16 }
  17
  18 /**
  19  * Display HTML head and <body> tag
  20  *
  21  * @param string $context Context of the page (stats, index, infos, ...)
  22  * @param string $title HTML title of the page
  23  */
  24 function yourls_html_head( $context = 'index', $title = '' ) {
  25
  26         yourls_do_action( 'pre_html_head', $context, $title );
  27
  28         // All components to false, except when specified true
  29         $share = $insert = $tablesorter = $tabs = $cal = $charts = false;
  30
  31         // Load components as needed
  32         switch ( $context ) {
  33                 case 'infos':
  34                         $share = $tabs = $charts = true;
  35                         break;
  36
  37                 case 'bookmark':
  38                         $share = $insert = $tablesorter = true;
  39                         break;
  40
  41                 case 'index':
  42                         $insert = $tablesorter = $cal = $share = true;
  43                         break;
  44
  45                 case 'plugins':
  46                 case 'tools':
  47                         $tablesorter = true;
  48                         break;
  49
  50                 case 'install':
  51                 case 'login':
  52                 case 'new':
  53                 case 'upgrade':
  54                         break;
  55         }
  56
  57         // Force no cache for all admin pages
  58         if( yourls_is_admin() && !headers_sent() ) {
  59                 header( 'Expires: Thu, 23 Mar 1972 07:00:00 GMT' );
  60                 header( 'Last-Modified: ' . gmdate( 'D, d M Y H:i:s' ) . ' GMT' );
  61                 header( 'Cache-Control: no-cache, must-revalidate, max-age=0' );
  62                 header( 'Pragma: no-cache' );
  63                 yourls_content_type_header( yourls_apply_filter( 'html_head_content-type', 'text/html' ) );
  64                 yourls_do_action( 'admin_headers', $context, $title );
  65         }
  66
  67         // Store page context in global object
  68         global $ydb;
  69         $ydb->context = $context;
  70
  71         // Body class
  72         $bodyclass = yourls_apply_filter( 'bodyclass', '' );
  73         $bodyclass .= ( yourls_is_mobile_device() ? 'mobile' : 'desktop' );
  74
  75         // Page title
  76         $_title = 'YOURLS &mdash; Your Own URL Shortener | ' . yourls_link();
  77         $title = $title ? $title . " &laquo; " . $_title : $_title;
  78         $title = yourls_apply_filter( 'html_title', $title, $context );
  79
  80         ?>
  81 <!DOCTYPE html>
  82 <html <?php yourls_html_language_attributes(); ?>>
  83 <head>
  84         <title><?php echo $title ?></title>
  85         <link rel="shortcut icon" href="<?php yourls_favicon(); ?>" />
  86         <meta http-equiv="Content-Type" content="<?php echo yourls_apply_filter( 'html_head_meta_content-type', 'text/html; charset=utf-8' ); ?>" />
  87         <meta name="generator" content="YOURLS <?php echo YOURLS_VERSION ?>" />
  88         <meta name="description" content="YOURLS &raquo; Your Own URL Shortener' | <?php yourls_site_url(); ?>" />
  89     <meta name="referrer" content="always" />
  90         <script src="<?php yourls_site_url(); ?>/js/jquery-1.9.1.min.js?v=<?php echo YOURLS_VERSION; ?>" type="text/javascript"></script>
  91         <script src="<?php yourls_site_url(); ?>/js/common.js?v=<?php echo YOURLS_VERSION; ?>" type="text/javascript"></script>
  92         <script src="<?php yourls_site_url(); ?>/js/jquery.notifybar.js?v=<?php echo YOURLS_VERSION; ?>" type="text/javascript"></script>
  93         <link rel="stylesheet" href="<?php yourls_site_url(); ?>/css/style.css?v=<?php echo YOURLS_VERSION; ?>" type="text/css" media="screen" />
  94         <?php if ( $tabs ) { ?>
  95                 <link rel="stylesheet" href="<?php yourls_site_url(); ?>/css/infos.css?v=<?php echo YOURLS_VERSION; ?>" type="text/css" media="screen" />
  96                 <script src="<?php yourls_site_url(); ?>/js/infos.js?v=<?php echo YOURLS_VERSION; ?>" type="text/javascript"></script>
  97         <?php } ?>
  98         <?php if ( $tablesorter ) { ?>
  99                 <link rel="stylesheet" href="<?php yourls_site_url(); ?>/css/tablesorter.css?v=<?php echo YOURLS_VERSION; ?>" type="text/css" media="screen" />
 100                 <script src="<?php yourls_site_url(); ?>/js/jquery.tablesorter.min.js?v=<?php echo YOURLS_VERSION; ?>" type="text/javascript"></script>
 101         <?php } ?>
 102         <?php if ( $insert ) { ?>
 103                 <script src="<?php yourls_site_url(); ?>/js/insert.js?v=<?php echo YOURLS_VERSION; ?>" type="text/javascript"></script>
 104         <?php } ?>
 105         <?php if ( $share ) { ?>
 106                 <link rel="stylesheet" href="<?php yourls_site_url(); ?>/css/share.css?v=<?php echo YOURLS_VERSION; ?>" type="text/css" media="screen" />
 107                 <script src="<?php yourls_site_url(); ?>/js/share.js?v=<?php echo YOURLS_VERSION; ?>" type="text/javascript"></script>
 108                 <script src="<?php yourls_site_url(); ?>/js/jquery.zclip.min.js?v=<?php echo YOURLS_VERSION; ?>" type="text/javascript"></script>
 109         <?php } ?>
 110         <?php if ( $cal ) { ?>
 111                 <link rel="stylesheet" href="<?php yourls_site_url(); ?>/css/cal.css?v=<?php echo YOURLS_VERSION; ?>" type="text/css" media="screen" />
 112                 <?php yourls_l10n_calendar_strings(); ?>
 113                 <script src="<?php yourls_site_url(); ?>/js/jquery.cal.js?v=<?php echo YOURLS_VERSION; ?>" type="text/javascript"></script>
 114         <?php } ?>
 115         <?php if ( $charts ) { ?>
 116                         <script type="text/javascript" src="https://www.google.com/jsapi"></script>
 117                         <script type="text/javascript">
 118                                          google.load('visualization', '1.0', {'packages':['corechart', 'geochart']});
 119                         </script>
 120         <?php } ?>
 121         <script type="text/javascript">
 122         //<![CDATA[
 123                 var ajaxurl  = '<?php echo yourls_admin_url( 'admin-ajax.php' ); ?>';
 124                 var zclipurl = '<?php yourls_site_url(); ?>/js/ZeroClipboard.swf';
 125         //]]>
 126         </script>
 127         <?php yourls_do_action( 'html_head', $context ); ?>
 128 </head>
 129 <body class="<?php echo $context; ?> <?php echo $bodyclass; ?>">
 130 <div id="wrap">
 131         <?php
 132 }
 133
 134 /**
 135  * Display HTML footer (including closing body & html tags)
 136  *
 137  */
 138 function yourls_html_footer() {
 139         global $ydb;
 140
 141         $num_queries = sprintf( yourls_n( '1 query', '%s queries', $ydb->num_queries ), $ydb->num_queries );
 142         ?>
 143         </div> <?php // wrap ?>
 144         <div id="footer"><p>
 145                 <?php
 146                 $footer  = yourls_s( 'Powered by %s', '<a href="http://yourls.org/" title="YOURLS">YOURLS</a> v ' . YOURLS_VERSION );
 147                 $footer .= ' &ndash; '.$num_queries;
 148                 echo yourls_apply_filter( 'html_footer_text', $footer );
 149                 ?>
 150         </p></div>
 151         <?php if( defined( 'YOURLS_DEBUG' ) && YOURLS_DEBUG == true ) {
 152                 echo '<div style="text-align:left"><pre>';
 153                 echo join( "\n", $ydb->debug_log );
 154                 echo '</div>';
 155         } ?>
 156         <?php yourls_do_action( 'html_footer', $ydb->context ); ?>
 157         </body>
 158         </html>
 159         <?php
 160 }
 161
 162 /**
 163  * Display "Add new URL" box
 164  *
 165  * @param string $url URL to prefill the input with
 166  * @param string $keyword Keyword to prefill the input with
 167  */
 168 function yourls_html_addnew( $url = '', $keyword = '' ) {
 169         ?>
 170         <div id="new_url">
 171                 <div>
 172                         <form id="new_url_form" action="" method="get">
 173                                 <div><strong><?php yourls_e( 'Enter the URL' ); ?></strong>:<input type="text" id="add-url" name="url" value="<?php echo $url; ?>" class="text" size="80" placeholder="http://" />
 174                                 <?php yourls_e( 'Optional '); ?> : <strong><?php yourls_e('Custom short URL'); ?></strong>:<input type="text" id="add-keyword" name="keyword" value="<?php echo $keyword; ?>" class="text" size="8" />
 175                                 <?php yourls_nonce_field( 'add_url', 'nonce-add' ); ?>
 176                                 <input type="button" id="add-button" name="add-button" value="<?php yourls_e( 'Shorten The URL' ); ?>" class="button" onclick="add_link();" /></div>
 177                         </form>
 178                         <div id="feedback" style="display:none"></div>
 179                 </div>
 180                 <?php yourls_do_action( 'html_addnew' ); ?>
 181         </div>
 182         <?php
 183 }
 184
 185 /**
 186  * Display main table's footer
 187  *
 188  * The $param array is defined in /admin/index.php, check the yourls_html_tfooter() call
 189  *
 190  * @param array $params Array of all required parameters
 191  * @return string Result
 192  */
 193 function yourls_html_tfooter( $params = array() ) {
 194         extract( $params ); // extract $search_text, $page, $search_in ...
 195         ?>
 196         <tfoot>
 197                 <tr>
 198                         <th colspan="6">
 199                         <div id="filter_form">
 200                                 <form action="" method="get">
 201                                         <div id="filter_options">
 202                                                 <?php
 203
 204                                                 // First search control: text to search
 205                                                 $_input = '<input type="text" name="search" class="text" size="12" value="' . yourls_esc_attr( $search_text ) . '" />';
 206                                                 $_options = array(
 207                             'all'     => yourls__( 'All fields' ),
 208                                                         'keyword' => yourls__( 'Short URL' ),
 209                                                         'url'     => yourls__( 'URL' ),
 210                                                         'title'   => yourls__( 'Title' ),
 211                                                         'ip'      => yourls__( 'IP' ),
 212                                                 );
 213                                                 $_select = yourls_html_select( 'search_in', $_options, $search_in );
 214                                                 /* //translators: "Search for <input field with text to search> in <select dropdown with URL, title...>" */
 215                                                 yourls_se( 'Search for %1$s in %2$s', $_input , $_select );
 216                                                 echo "&ndash;\n";
 217
 218                                                 // Second search control: order by
 219                                                 $_options = array(
 220                                                         'keyword'      => yourls__( 'Short URL' ),
 221                                                         'url'          => yourls__( 'URL' ),
 222                                                         'timestamp'    => yourls__( 'Date' ),
 223                                                         'ip'           => yourls__( 'IP' ),
 224                                                         'clicks'       => yourls__( 'Clicks' ),
 225                                                 );
 226                                                 $_select = yourls_html_select( 'sort_by', $_options, $sort_by );
 227                                                 $sort_order = isset( $sort_order ) ? $sort_order : 'desc' ;
 228                                                 $_options = array(
 229                                                         'asc'  => yourls__( 'Ascending' ),
 230                                                         'desc' => yourls__( 'Descending' ),
 231                                                 );
 232                                                 $_select2 = yourls_html_select( 'sort_order', $_options, $sort_order );
 233                                                 /* //translators: "Order by <criteria dropdown (date, clicks...)> in <order dropdown (Descending or Ascending)>" */
 234                                                 yourls_se( 'Order by %1$s %2$s', $_select , $_select2 );
 235                                                 echo "&ndash;\n";
 236
 237                                                 // Third search control: Show XX rows
 238                                                 /* //translators: "Show <text field> rows" */
 239                                                 yourls_se( 'Show %s rows',  '<input type="text" name="perpage" class="text" size="2" value="' . $perpage . '" />' );
 240                                                 echo "<br/>\n";
 241
 242                                                 // Fourth search control: Show links with more than XX clicks
 243                                                 $_options = array(
 244                                                         'more' => yourls__( 'more' ),
 245                                                         'less' => yourls__( 'less' ),
 246                                                 );
 247                                                 $_select = yourls_html_select( 'click_filter', $_options, $click_filter );
 248                                                 $_input  = '<input type="text" name="click_limit" class="text" size="4" value="' . $click_limit . '" /> ';
 249                                                 /* //translators: "Show links with <more/less> than <text field> clicks" */
 250                                                 yourls_se( 'Show links with %1$s than %2$s clicks', $_select, $_input );
 251                                                 echo "<br/>\n";
 252
 253                                                 // Fifth search control: Show links created before/after/between ...
 254                                                 $_options = array(
 255                                                         'before'  => yourls__('before'),
 256                                                         'after'   => yourls__('after'),
 257                                                         'between' => yourls__('between'),
 258                                                 );
 259                                                 $_select = yourls_html_select( 'date_filter', $_options, $date_filter );
 260                                                 $_input  = '<input type="text" name="date_first" id="date_first" class="text" size="12" value="' . $date_first . '" />';
 261                                                 $_and    = '<span id="date_and"' . ( $date_filter === 'between' ? ' style="display:inline"' : '' ) . '> &amp; </span>';
 262                                                 $_input2 = '<input type="text" name="date_second" id="date_second" class="text" size="12" value="' . $date_second . '"' . ( $date_filter === 'between' ? ' style="display:inline"' : '' ) . '/>';
 263                                                 /* //translators: "Show links created <before/after/between> <date input> <"and" if applicable> <date input if applicable>" */
 264                                                 yourls_se( 'Show links created %1$s %2$s %3$s %4$s', $_select, $_input, $_and, $_input2 );
 265                                                 ?>
 266
 267                                                 <div id="filter_buttons">
 268                                                         <input type="submit" id="submit-sort" value="<?php yourls_e('Search'); ?>" class="button primary" />
 269                                                         &nbsp;
 270                                                         <input type="button" id="submit-clear-filter" value="<?php yourls_e('Clear'); ?>" class="button" onclick="window.parent.location.href = 'index.php'" />
 271                                                 </div>
 272
 273                                         </div>
 274                                 </form>
 275                         </div>
 276
 277                         <?php
 278                         // Remove empty keys from the $params array so it doesn't clutter the pagination links
 279                         $params = array_filter( $params, 'yourls_return_if_not_empty_string' ); // remove empty keys
 280
 281                         if( isset( $search_text ) ) {
 282                                 $params['search'] = $search_text;
 283                                 unset( $params['search_text'] );
 284                         }
 285                         ?>
 286
 287                         <div id="pagination">
 288                                 <span class="navigation">
 289                                 <?php if( $total_pages > 1 ) { ?>
 290                                         <span class="nav_total"><?php echo sprintf( yourls_n( '1 page', '%s pages', $total_pages ), $total_pages ); ?></span>
 291                                         <?php
 292                                         $base_page = yourls_admin_url( 'index.php' );
 293                                         // Pagination offsets: min( max ( zomg! ) );
 294                                         $p_start = max(  min( $total_pages - 4, $page - 2 ), 1 );
 295                                         $p_end = min( max( 5, $page + 2 ), $total_pages );
 296                                         if( $p_start >= 2 ) {
 297                                                 $link = yourls_add_query_arg( array_merge( $params, array( 'page' => 1 ) ), $base_page );
 298                                                 echo '<span class="nav_link nav_first"><a href="' . $link . '" title="' . yourls_esc_attr__('Go to First Page') . '">' . yourls__( '&laquo; First' ) . '</a></span>';
 299                                                 echo '<span class="nav_link nav_prev"></span>';
 300                                         }
 301                                         for( $i = $p_start ; $i <= $p_end; $i++ ) {
 302                                                 if( $i == $page ) {
 303                                                         echo "<span class='nav_link nav_current'>$i</span>";
 304                                                 } else {
 305                                                         $link = yourls_add_query_arg( array_merge( $params, array( 'page' => $i ) ), $base_page );
 306                                                         echo '<span class="nav_link nav_goto"><a href="' . $link . '" title="' . sprintf( yourls_esc_attr( 'Page %s' ), $i ) .'">'.$i.'</a></span>';
 307                                                 }
 308                                         }
 309                                         if( ( $p_end ) < $total_pages ) {
 310                                                 $link = yourls_add_query_arg( array_merge( $params, array( 'page' => $total_pages ) ), $base_page );
 311                                                 echo '<span class="nav_link nav_next"></span>';
 312                                                 echo '<span class="nav_link nav_last"><a href="' . $link . '" title="' . yourls_esc_attr__('Go to First Page') . '">' . yourls__( 'Last &raquo;' ) . '</a></span>';
 313                                         }
 314                                         ?>
 315                                 <?php } ?>
 316                                 </span>
 317                         </div>
 318                         </th>
 319                 </tr>
 320                 <?php yourls_do_action( 'html_tfooter' ); ?>
 321         </tfoot>
 322         <?php
 323 }
 324
 325 /**
 326  * Return a select box
 327  *
 328  * @since 1.6
 329  *
 330  * @param string $name HTML 'name' (also use as the HTML 'id')
 331  * @param array $options array of 'value' => 'Text displayed'
 332  * @param string $selected optional 'value' from the $options array that will be highlighted
 333  * @param boolean $display false (default) to return, true to echo
 334  * @return string HTML content of the select element
 335  */
 336 function yourls_html_select( $name, $options, $selected = '', $display = false ) {
 337         $html = "<select name='$name' id='$name' size='1'>\n";
 338         foreach( $options as $value => $text ) {
 339                 $html .= "<option value='$value' ";
 340                 $html .= $selected == $value ? ' selected="selected"' : '';
 341                 $html .= ">$text</option>\n";
 342         }
 343         $html .= "</select>\n";
 344         $html  = yourls_apply_filter( 'html_select', $html, $name, $options, $selected, $display );
 345         if( $display )
 346                 echo $html;
 347         return $html;
 348 }
 349
 350 /**
 351  * Display the Quick Share box
 352  *
 353  */
 354 function yourls_share_box( $longurl, $shorturl, $title = '', $text='', $shortlink_title = '', $share_title = '', $hidden = false ) {
 355         if ( $shortlink_title == '' )
 356                 $shortlink_title = '<h2>' . yourls__( 'Your short link' ) . '</h2>';
 357         if ( $share_title == '' )
 358                 $share_title = '<h2>' . yourls__( 'Quick Share' ) . '</h2>';
 359
 360         // Allow plugins to short-circuit the whole function
 361         $pre = yourls_apply_filter( 'shunt_share_box', false );
 362         if ( false !== $pre )
 363                 return $pre;
 364
 365         $text   = ( $text ? '"'.$text.'" ' : '' );
 366         $title  = ( $title ? "$title " : '' );
 367         $share  = yourls_esc_textarea( $title.$text.$shorturl );
 368         $count  = 140 - strlen( $share );
 369         $hidden = ( $hidden ? 'style="display:none;"' : '' );
 370
 371         // Allow plugins to filter all data
 372         $data = compact( 'longurl', 'shorturl', 'title', 'text', 'shortlink_title', 'share_title', 'share', 'count', 'hidden' );
 373         $data = yourls_apply_filter( 'share_box_data', $data );
 374         extract( $data );
 375
 376         $_share = rawurlencode( $share );
 377         $_url   = rawurlencode( $shorturl );
 378         ?>
 379
 380         <div id="shareboxes" <?php echo $hidden; ?>>
 381
 382                 <?php yourls_do_action( 'shareboxes_before', $longurl, $shorturl, $title, $text ); ?>
 383
 384                 <div id="copybox" class="share">
 385                 <?php echo $shortlink_title; ?>
 386                         <p><input id="copylink" class="text" size="32" value="<?php echo yourls_esc_url( $shorturl ); ?>" /></p>
 387                         <p><small><?php yourls_e( 'Long link' ); ?>: <a id="origlink" href="<?php echo yourls_esc_url( $longurl ); ?>"><?php echo yourls_esc_url( $longurl ); ?></a></small>
 388                         <?php if( yourls_do_log_redirect() ) { ?>
 389                         <br/><small><?php yourls_e( 'Stats' ); ?>: <a id="statlink" href="<?php echo yourls_esc_url( $shorturl ); ?>+"><?php echo yourls_esc_url( $shorturl ); ?>+</a></small>
 390                         <input type="hidden" id="titlelink" value="<?php echo yourls_esc_attr( $title ); ?>" />
 391                         <?php } ?>
 392                         </p>
 393                 </div>
 394
 395                 <?php yourls_do_action( 'shareboxes_middle', $longurl, $shorturl, $title, $text ); ?>
 396
 397                 <div id="sharebox" class="share">
 398                         <?php echo $share_title; ?>
 399                         <div id="tweet">
 400                                 <span id="charcount" class="hide-if-no-js"><?php echo $count; ?></span>
 401                                 <textarea id="tweet_body"><?php echo $share; ?></textarea>
 402                         </div>
 403                         <p id="share_links"><?php yourls_e( 'Share with' ); ?>
 404                                 <a id="share_tw" href="http://twitter.com/home?status=<?php echo $_share; ?>" title="<?php yourls_e( 'Tweet this!' ); ?>" onclick="share('tw');return false">Twitter</a>
 405                                 <a id="share_fb" href="http://www.facebook.com/share.php?u=<?php echo $_url; ?>" title="<?php yourls_e( 'Share on Facebook' ); ?>" onclick="share('fb');return false;">Facebook</a>
 406                                 <a id="share_ff" href="http://friendfeed.com/share/bookmarklet/frame#title=<?php echo $_share; ?>" title="<?php yourls_e( 'Share on Friendfeed' ); ?>" onclick="share('ff');return false;">FriendFeed</a>
 407                                 <?php
 408                                 yourls_do_action( 'share_links', $longurl, $shorturl, $title, $text );
 409                                 // Note: on the main admin page, there are no parameters passed to the sharebox when it's drawn.
 410                                 ?>
 411                         </p>
 412                 </div>
 413
 414                 <?php yourls_do_action( 'shareboxes_after', $longurl, $shorturl, $title, $text ); ?>
 415
 416         </div>
 417
 418         <?php
 419 }
 420
 421 /**
 422  * Die die die
 423  *
 424  */
 425 function yourls_die( $message = '', $title = '', $header_code = 200 ) {
 426     yourls_do_action( 'pre_yourls_die', $message, $title, $header_code );
 427
 428         yourls_status_header( $header_code );
 429
 430         if( !yourls_did_action( 'html_head' ) ) {
 431                 yourls_html_head();
 432                 yourls_html_logo();
 433         }
 434         echo yourls_apply_filter( 'die_title', "<h2>$title</h2>" );
 435         echo yourls_apply_filter( 'die_message', "<p>$message</p>" );
 436     // Hook into 'yourls_die' to add more elements or messages to that page
 437         yourls_do_action( 'yourls_die' );
 438         if( !yourls_did_action( 'html_footer' ) ) {
 439                 yourls_html_footer();
 440         }
 441         die();
 442 }
 443
 444 /**
 445  * Return an "Edit" row for the main table
 446  *
 447  * @param string $keyword Keyword to edit
 448  * @return string HTML of the edit row
 449  */
 450 function yourls_table_edit_row( $keyword ) {
 451         $keyword = yourls_sanitize_string( $keyword );
 452         $id = yourls_string2htmlid( $keyword ); // used as HTML #id
 453         $url = yourls_get_keyword_longurl( $keyword );
 454         $title = htmlspecialchars( yourls_get_keyword_title( $keyword ) );
 455         $safe_url = yourls_esc_attr( rawurldecode( $url ) );
 456         $safe_title = yourls_esc_attr( $title );
 457
 458     // Make strings sprintf() safe: '%' -> '%%'
 459     $safe_url = str_replace( '%', '%%', $safe_url );
 460     $safe_title = str_replace( '%', '%%', $safe_title );
 461
 462         $www = yourls_link();
 463
 464         $nonce = yourls_create_nonce( 'edit-save_'.$id );
 465
 466         if( $url ) {
 467                 $return = <<<RETURN
 468 <tr id="edit-$id" class="edit-row"><td colspan="5" class="edit-row"><strong>%s</strong>:<input type="text" id="edit-url-$id" name="edit-url-$id" value="$safe_url" class="text" size="70" /><br/><strong>%s</strong>: $www<input type="text" id="edit-keyword-$id" name="edit-keyword-$id" value="$keyword" class="text" size="10" /><br/><strong>%s</strong>: <input type="text" id="edit-title-$id" name="edit-title-$id" value="$safe_title" class="text" size="60" /></td><td colspan="1"><input type="button" id="edit-submit-$id" name="edit-submit-$id" value="%s" title="%s" class="button" onclick="edit_link_save('$id');" />&nbsp;<input type="button" id="edit-close-$id" name="edit-close-$id" value="%s" title="%s" class="button" onclick="edit_link_hide('$id');" /><input type="hidden" id="old_keyword_$id" value="$keyword"/><input type="hidden" id="nonce_$id" value="$nonce"/></td></tr>
 469 RETURN;
 470                 $return = sprintf( $return, yourls__( 'Long URL' ), yourls__( 'Short URL' ), yourls__( 'Title' ), yourls__( 'Save' ), yourls__( 'Save new values' ), yourls__( 'Cancel' ), yourls__( 'Cancel editing' ) );
 471         } else {
 472                 $return = '<tr class="edit-row notfound"><td colspan="6" class="edit-row notfound">' . yourls__( 'Error, URL not found' ) . '</td></tr>';
 473         }
 474
 475         $return = yourls_apply_filter( 'table_edit_row', $return, $keyword, $url, $title );
 476
 477         return $return;
 478 }
 479
 480 /**
 481  * Return an "Add" row for the main table
 482  *
 483  * @return string HTML of the edit row
 484  */
 485 function yourls_table_add_row( $keyword, $url, $title = '', $ip, $clicks, $timestamp ) {
 486         $keyword  = yourls_sanitize_string( $keyword );
 487         $id       = yourls_string2htmlid( $keyword ); // used as HTML #id
 488         $shorturl = yourls_link( $keyword );
 489
 490         $statlink = yourls_statlink( $keyword );
 491
 492         $delete_link = yourls_nonce_url( 'delete-link_'.$id,
 493                 yourls_add_query_arg( array( 'id' => $id, 'action' => 'delete', 'keyword' => $keyword ), yourls_admin_url( 'admin-ajax.php' ) )
 494         );
 495
 496         $edit_link = yourls_nonce_url( 'edit-link_'.$id,
 497                 yourls_add_query_arg( array( 'id' => $id, 'action' => 'edit', 'keyword' => $keyword ), yourls_admin_url( 'admin-ajax.php' ) )
 498         );
 499
 500         // Action link buttons: the array
 501         $actions = array(
 502                 'stats' => array(
 503                         'href'    => $statlink,
 504                         'id'      => "statlink-$id",
 505                         'title'   => yourls_esc_attr__( 'Stats' ),
 506                         'anchor'  => yourls__( 'Stats' ),
 507                 ),
 508                 'share' => array(
 509                         'href'    => '',
 510                         'id'      => "share-button-$id",
 511                         'title'   => yourls_esc_attr__( 'Share' ),
 512                         'anchor'  => yourls__( 'Share' ),
 513                         'onclick' => "toggle_share('$id');return false;",
 514                 ),
 515                 'edit' => array(
 516                         'href'    => $edit_link,
 517                         'id'      => "edit-button-$id",
 518                         'title'   => yourls_esc_attr__( 'Edit' ),
 519                         'anchor'  => yourls__( 'Edit' ),
 520                         'onclick' => "edit_link_display('$id');return false;",
 521                 ),
 522                 'delete' => array(
 523                         'href'    => $delete_link,
 524                         'id'      => "delete-button-$id",
 525                         'title'   => yourls_esc_attr__( 'Delete' ),
 526                         'anchor'  => yourls__( 'Delete' ),
 527                         'onclick' => "remove_link('$id');return false;",
 528                 )
 529         );
 530         $actions = yourls_apply_filter( 'table_add_row_action_array', $actions );
 531
 532         // Action link buttons: the HTML
 533         $action_links = '';
 534         foreach( $actions as $key => $action ) {
 535                 $onclick = isset( $action['onclick'] ) ? 'onclick="' . $action['onclick'] . '"' : '' ;
 536                 $action_links .= sprintf( '<a href="%s" id="%s" title="%s" class="%s" %s>%s</a>',
 537                         $action['href'], $action['id'], $action['title'], 'button button_'.$key, $onclick, $action['anchor']
 538                 );
 539         }
 540         $action_links = yourls_apply_filter( 'action_links', $action_links, $keyword, $url, $ip, $clicks, $timestamp );
 541
 542         if( ! $title )
 543                 $title = $url;
 544
 545         $protocol_warning = '';
 546         if( ! in_array( yourls_get_protocol( $url ) , array( 'http://', 'https://' ) ) )
 547                 $protocol_warning = yourls_apply_filter( 'add_row_protocol_warning', '<span class="warning" title="' . yourls__( 'Not a common link' ) . '">&#9733;</span>' );
 548
 549         // Row cells: the array
 550         $cells = array(
 551                 'keyword' => array(
 552                         'template'      => '<a href="%shorturl%">%keyword_html%</a>',
 553                         'shorturl'      => yourls_esc_url( $shorturl ),
 554                         'keyword_html'  => yourls_esc_html( $keyword ),
 555                 ),
 556                 'url' => array(
 557                         'template'      => '<a href="%long_url%" title="%title_attr%">%title_html%</a><br/><small>%warning%<a href="%long_url%">%long_url_html%</a></small>',
 558                         'long_url'      => yourls_esc_url( $url ),
 559                         'title_attr'    => yourls_esc_attr( $title ),
 560                         'title_html'    => yourls_esc_html( yourls_trim_long_string( $title ) ),
 561                         'long_url_html' => yourls_esc_html( yourls_trim_long_string( $url ) ),
 562                         'warning'       => $protocol_warning,
 563                 ),
 564                 'timestamp' => array(
 565                         'template' => '%date%',
 566                         'date'     => date( 'M d, Y H:i', $timestamp +( YOURLS_HOURS_OFFSET * 3600 ) ),
 567                 ),
 568                 'ip' => array(
 569                         'template' => '%ip%',
 570                         'ip'       => $ip,
 571                 ),
 572                 'clicks' => array(
 573                         'template' => '%clicks%',
 574                         'clicks'   => yourls_number_format_i18n( $clicks, 0, '', '' ),
 575                 ),
 576                 'actions' => array(
 577                         'template' => '%actions% <input type="hidden" id="keyword_%id%" value="%keyword%"/>',
 578                         'actions'  => $action_links,
 579                         'id'       => $id,
 580                         'keyword'  => $keyword,
 581                 ),
 582         );
 583         $cells = yourls_apply_filter( 'table_add_row_cell_array', $cells, $keyword, $url, $title, $ip, $clicks, $timestamp );
 584
 585         // Row cells: the HTML. Replace every %stuff% in 'template' with 'stuff' value.
 586         $row = "<tr id=\"id-$id\">";
 587         foreach( $cells as $cell_id => $elements ) {
 588                 $callback = new yourls_table_add_row_callback( $elements );
 589                 $row .= sprintf( '<td class="%s" id="%s">', $cell_id, $cell_id . '-' . $id );
 590                 $row .= preg_replace_callback( '/%([^%]+)?%/', array( $callback, 'callback' ), $elements['template'] );
 591                 // For the record, in PHP 5.3+ we don't need to introduce a class in order to pass additional parameters
 592                 // to the callback function. Instead, we would have used the 'use' keyword :
 593                 // $row .= preg_replace_callback( '/%([^%]+)?%/', function( $match ) use ( $elements ) { return $elements[ $match[1] ]; }, $elements['template'] );
 594
 595                 $row .= '</td>';
 596         }
 597         $row .= "</tr>";
 598         $row  = yourls_apply_filter( 'table_add_row', $row, $keyword, $url, $title, $ip, $clicks, $timestamp );
 599
 600         return $row;
 601 }
 602
 603 /**
 604  * Callback class for yourls_table_add_row
 605  *
 606  * See comment about PHP 5.3+ in yourls_table_add_row()
 607  *
 608  * @since 1.7
 609  */
 610 class yourls_table_add_row_callback {
 611     private $elements;
 612
 613     function __construct($elements) {
 614                 $this->elements = $elements;
 615         }
 616
 617     function callback( $matches ) {
 618                 return $this->elements[ $matches[1] ];
 619     }
 620 }
 621
 622
 623 /**
 624  * Echo the main table head
 625  *
 626  */
 627 function yourls_table_head() {
 628         $start = '<table id="main_table" class="tblSorter" cellpadding="0" cellspacing="1"><thead><tr>'."\n";
 629         echo yourls_apply_filter( 'table_head_start', $start );
 630
 631         $cells = yourls_apply_filter( 'table_head_cells', array(
 632                 'shorturl' => yourls__( 'Short URL' ),
 633                 'longurl'  => yourls__( 'Original URL' ),
 634                 'date'     => yourls__( 'Date' ),
 635                 'ip'       => yourls__( 'IP' ),
 636                 'clicks'   => yourls__( 'Clicks' ),
 637                 'actions'  => yourls__( 'Actions' )
 638         ) );
 639         foreach( $cells as $k => $v ) {
 640                 echo "<th id='main_table_head_$k'>$v</th>\n";
 641         }
 642
 643         $end = "</tr></thead>\n";
 644         echo yourls_apply_filter( 'table_head_end', $end );
 645 }
 646
 647 /**
 648  * Echo the tbody start tag
 649  *
 650  */
 651 function yourls_table_tbody_start() {
 652         echo yourls_apply_filter( 'table_tbody_start', '<tbody>' );
 653 }
 654
 655 /**
 656  * Echo the tbody end tag
 657  *
 658  */
 659 function yourls_table_tbody_end() {
 660         echo yourls_apply_filter( 'table_tbody_end', '</tbody>' );
 661 }
 662
 663 /**
 664  * Echo the table start tag
 665  *
 666  */
 667 function yourls_table_end() {
 668         echo yourls_apply_filter( 'table_end', '</table>' );
 669 }
 670
 671 /**
 672  * Echo HTML tag for a link
 673  *
 674  */
 675 function yourls_html_link( $href, $title = '', $element = '' ) {
 676         if( !$title )
 677                 $title = $href;
 678         if( $element )
 679                 $element = sprintf( 'id="%s"', yourls_esc_attr( $element ) );
 680         $link = sprintf( '<a href="%s" %s>%s</a>', yourls_esc_url( $href ), $element, yourls_esc_html( $title ) );
 681         echo yourls_apply_filter( 'html_link', $link );
 682 }
 683
 684 /**
 685  * Display the login screen. Nothing past this point.
 686  *
 687  */
 688 function yourls_login_screen( $error_msg = '' ) {
 689         yourls_html_head( 'login' );
 690
 691         $action = ( isset( $_GET['action'] ) && $_GET['action'] == 'logout' ? '?' : '' );
 692
 693         yourls_html_logo();
 694         ?>
 695         <div id="login">
 696                 <form method="post" action="<?php echo $action; ?>"> <?php // reset any QUERY parameters ?>
 697                         <?php
 698                                 if( !empty( $error_msg ) ) {
 699                                         echo '<p class="error">'.$error_msg.'</p>';
 700                                 }
 701                         ?>
 702                         <p>
 703                                 <label for="username"><?php yourls_e( 'Username' ); ?></label><br />
 704                                 <input type="text" id="username" name="username" size="30" class="text" />
 705                         </p>
 706                         <p>
 707                                 <label for="password"><?php yourls_e( 'Password' ); ?></label><br />
 708                                 <input type="password" id="password" name="password" size="30" class="text" />
 709                         </p>
 710                         <p style="text-align: right;">
 711                                 <input type="submit" id="submit" name="submit" value="<?php yourls_e( 'Login' ); ?>" class="button" />
 712                         </p>
 713                 </form>
 714                 <script type="text/javascript">$('#username').focus();</script>
 715         </div>
 716         <?php
 717         yourls_html_footer();
 718         die();
 719 }
 720
 721 /**
 722  * Display the admin menu
 723  *
 724  */
 725 function yourls_html_menu() {
 726
 727         // Build menu links
 728         if( defined( 'YOURLS_USER' ) ) {
 729                 $logout_link = yourls_apply_filter( 'logout_link', sprintf( yourls__('Hello <strong>%s</strong>'), YOURLS_USER ) . ' (<a href="?action=logout" title="' . yourls_esc_attr__( 'Logout' ) . '">' . yourls__( 'Logout' ) . '</a>)' );
 730         } else {
 731                 $logout_link = yourls_apply_filter( 'logout_link', '' );
 732         }
 733         $help_link   = yourls_apply_filter( 'help_link',   '<a href="' . yourls_site_url( false ) .'/readme.html">' . yourls__( 'Help' ) . '</a>' );
 734
 735         $admin_links    = array();
 736         $admin_sublinks = array();
 737
 738         $admin_links['admin'] = array(
 739                 'url'    => yourls_admin_url( 'index.php' ),
 740                 'title'  => yourls__( 'Go to the admin interface' ),
 741                 'anchor' => yourls__( 'Admin interface' )
 742         );
 743
 744         if( yourls_is_admin() ) {
 745                 $admin_links['tools'] = array(
 746                         'url'    => yourls_admin_url( 'tools.php' ),
 747                         'anchor' => yourls__( 'Tools' )
 748                 );
 749                 $admin_links['plugins'] = array(
 750                         'url'    => yourls_admin_url( 'plugins.php' ),
 751                         'anchor' => yourls__( 'Manage Plugins' )
 752                 );
 753                 $admin_sublinks['plugins'] = yourls_list_plugin_admin_pages();
 754         }
 755
 756         $admin_links    = yourls_apply_filter( 'admin_links',    $admin_links );
 757         $admin_sublinks = yourls_apply_filter( 'admin_sublinks', $admin_sublinks );
 758
 759         // Now output menu
 760         echo '<ul id="admin_menu">'."\n";
 761         if ( yourls_is_private() && !empty( $logout_link ) )
 762                 echo '<li id="admin_menu_logout_link">' . $logout_link .'</li>';
 763
 764         foreach( (array)$admin_links as $link => $ar ) {
 765                 if( isset( $ar['url'] ) ) {
 766                         $anchor = isset( $ar['anchor'] ) ? $ar['anchor'] : $link;
 767                         $title  = isset( $ar['title'] ) ? 'title="' . $ar['title'] . '"' : '';
 768                         printf( '<li id="admin_menu_%s_link" class="admin_menu_toplevel"><a href="%s" %s>%s</a>', $link, $ar['url'], $title, $anchor );
 769                 }
 770                 // Output submenu if any. TODO: clean up, too many code duplicated here
 771                 if( isset( $admin_sublinks[$link] ) ) {
 772                         echo "<ul>\n";
 773                         foreach( $admin_sublinks[$link] as $link => $ar ) {
 774                                 if( isset( $ar['url'] ) ) {
 775                                         $anchor = isset( $ar['anchor'] ) ? $ar['anchor'] : $link;
 776                                         $title  = isset( $ar['title'] ) ? 'title="' . $ar['title'] . '"' : '';
 777                                         printf( '<li id="admin_menu_%s_link" class="admin_menu_sublevel admin_menu_sublevel_%s"><a href="%s" %s>%s</a>', $link, $link, $ar['url'], $title, $anchor );
 778                                 }
 779                         }
 780                         echo "</ul>\n";
 781                 }
 782         }
 783
 784         if ( isset( $help_link ) )
 785                 echo '<li id="admin_menu_help_link">' . $help_link .'</li>';
 786
 787         yourls_do_action( 'admin_menu' );
 788         echo "</ul>\n";
 789         yourls_do_action( 'admin_notices' );
 790         yourls_do_action( 'admin_notice' ); // because I never remember if it's 'notices' or 'notice'
 791         /*
 792         To display a notice:
 793         $message = "<div>OMG, dude, I mean!</div>" );
 794         yourls_add_action( 'admin_notices', create_function( '', "echo '$message';" ) );
 795         */
 796 }
 797
 798 /**
 799  * Wrapper function to display admin notices
 800  *
 801  */
 802 function yourls_add_notice( $message, $style = 'notice' ) {
 803         // Escape single quotes in $message to avoid breaking the anonymous function
 804         $message = yourls_notice_box( strtr( $message, array( "'" => "\'" ) ), $style );
 805         yourls_add_action( 'admin_notices', create_function( '', "echo '$message';" ) );
 806 }
 807
 808 /**
 809  * Return a formatted notice
 810  *
 811  */
 812 function yourls_notice_box( $message, $style = 'notice' ) {
 813         return <<<HTML
 814         <div class="$style">
 815         <p>$message</p>
 816         </div>
 817 HTML;
 818 }
 819
 820 /**
 821  * Display a page
 822  *
 823  */
 824 function yourls_page( $page ) {
 825         $include = YOURLS_ABSPATH . "/pages/$page.php";
 826         if( !file_exists( $include ) ) {
 827                 yourls_die( "Page '$page' not found", 'Not found', 404 );
 828         }
 829         yourls_do_action( 'pre_page', $page );
 830         include_once( $include );
 831         yourls_do_action( 'post_page', $page );
 832         die();
 833 }
 834
 835 /**
 836  * Display the language attributes for the HTML tag.
 837  *
 838  * Builds up a set of html attributes containing the text direction and language
 839  * information for the page. Stolen from WP.
 840  *
 841  * @since 1.6
 842  */
 843 function yourls_html_language_attributes() {
 844         $attributes = array();
 845         $output = '';
 846
 847         $attributes[] = ( yourls_is_rtl() ? 'dir="rtl"' : 'dir="ltr"' );
 848
 849         $doctype = yourls_apply_filter( 'html_language_attributes_doctype', 'html' );
 850         // Experimental: get HTML lang from locale. Should work. Convert fr_FR -> fr-FR
 851         if ( $lang = str_replace( '_', '-', yourls_get_locale() ) ) {
 852                 if( $doctype == 'xhtml' ) {
 853                         $attributes[] = "xml:lang=\"$lang\"";
 854                 } else {
 855                         $attributes[] = "lang=\"$lang\"";
 856                 }
 857         }
 858
 859         $output = implode( ' ', $attributes );
 860         $output = yourls_apply_filter( 'html_language_attributes', $output );
 861         echo $output;
 862 }
 863
 864 /**
 865  * Output translated strings used by the Javascript calendar
 866  *
 867  * @since 1.6
 868  */
 869 function yourls_l10n_calendar_strings() {
 870         echo "\n<script>\n";
 871         echo "var l10n_cal_month = " . json_encode( array_values( yourls_l10n_months() ) ) . ";\n";
 872         echo "var l10n_cal_days = " . json_encode( array_values( yourls_l10n_weekday_initial() ) ) . ";\n";
 873         echo "var l10n_cal_today = \"" . yourls_esc_js( yourls__( 'Today' ) ) . "\";\n";
 874         echo "var l10n_cal_close = \"" . yourls_esc_js( yourls__( 'Close' ) ) . "\";\n";
 875         echo "</script>\n";
 876
 877         // Dummy returns, to initialize l10n strings used in the calendar
 878         yourls__( 'Today' );
 879         yourls__( 'Close' );
 880 }
 881
 882
 883 /**
 884  * Display a notice if there is a newer version of YOURLS available
 885  *
 886  * @since 1.7
 887  */
 888 function yourls_new_core_version_notice() {
 889
 890         yourls_debug_log( 'Check for new version: ' . ( yourls_maybe_check_core_version() ? 'yes' : 'no' ) );
 891
 892         $checks = yourls_get_option( 'core_version_checks' );
 893
 894         if( isset( $checks->last_result->latest ) AND version_compare( $checks->last_result->latest, YOURLS_VERSION, '>' ) ) {
 895                 $msg = yourls_s( '<a href="%s">YOURLS version %s</a> is available. Please update!', 'http://yourls.org/download', $checks->last_result->latest );
 896                 yourls_add_notice( $msg );
 897         }
 898 }
 899
 900 /**
 901  * Send a filerable content type header
 902  *
 903  * @since 1.7
 904  * @param string $type content type ('text/html', 'application/json', ...)
 905  * @return bool whether header was sent
 906  */
 907 function yourls_content_type_header( $type ) {
 908     yourls_do_action( 'content_type_header', $type );
 909         if( !headers_sent() ) {
 910                 $charset = yourls_apply_filter( 'content_type_header_charset', 'utf-8' );
 911                 header( "Content-Type: $type; charset=$charset" );
 912                 return true;
 913         }
 914         return false;
 915 }
 916
 917 /**
 918  * Get search text from query string variables search_protocol, search_slashes and search
 919  *
 920  * Some servers don't like query strings containing "(ht|f)tp(s)://". A javascript bit
 921  * explodes the search text into protocol, slashes and the rest (see JS function
 922  * split_search_text_before_search()) and this function glues pieces back together
 923  * See issue https://github.com/YOURLS/YOURLS/issues/1576
 924  *
 925  * @since 1.7
 926  * @return string Search string
 927  */
 928 function yourls_get_search_text() {
 929         $search = '';
 930         if( isset( $_GET['search_protocol'] ) )
 931                 $search .= $_GET['search_protocol'];
 932         if( isset( $_GET['search_slashes'] ) )
 933                 $search .= $_GET['search_slashes'];
 934         if( isset( $_GET['search'] ) )
 935                 $search .= $_GET['search'];
 936
 937         return htmlspecialchars( trim( $search ) );
 938 }
 939
 940 /**
 941  * Display or return HTML for a bookmarklet link
 942  *
 943  * @since 1.7.1
 944  * @param string $href    bookmarklet link (presumably minified code with "javascript:" scheme)
 945  * @param string $anchor  link anchor
 946  * @param bool   $echo    true to display, false to return the HTML
 947  * @return string         the HTML for a bookmarklet link
 948  */
 949 function yourls_bookmarklet_link( $href, $anchor, $echo = true ) {
 950     $alert = yourls_esc_attr__( 'Drag to your toolbar!' );
 951     $link = <<<LINK
 952     <a href="$href" class="bookmarklet" onclick="alert('$alert');return false;">$anchor</a>
 953 LINK;
 954
 955     if( $echo )
 956         echo $link;
 957     return $link;
 958 }
 959