class-minit.php ➔ minit_add_toc() - Code Metrics - Inspection of "bundled minit, but left disabled for now" - UsabilityDynamics/wp-amd - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — v1.5 ( 5d3331...24344c )

by Andy
created 2016-10-03 18:47 UTC
class-minit.php ➔ minit_add_toc() A

↳ Parent: Project
Complexity

Conditions	4
Paths	3
Size

Total Lines	13
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	4
eloc	7
nc	3
nop	2
dl	0
loc	13
rs	9.2
c	0
b	0
f	0
<?php
/*
Plugin Name: Minit
Plugin URI: https://github.com/kasparsd/minit
GitHub URI: https://github.com/kasparsd/minit
Description: Combine JS and CSS files and serve them from the uploads folder.
Version: 1.2
Author: Kaspars Dambis
Author URI: http://kaspars.net
*/
namespace UsabilityDynamics\AMD {

  $minit_instance = Minit::instance();

  class Minit {

    protected $minit_done = array();
    protected $async_queue = array();

    private function __construct() {

      // called once in header and once in footer
      add_filter( 'print_scripts_array', array( $this, 'init_minit_js' ) );
      add_filter( 'print_styles_array', array( $this, 'init_minit_css' ) );

      // Print external scripts asynchronously in the footer
      add_action( 'wp_print_footer_scripts', array( $this, 'async_init' ), 5 );
      add_action( 'wp_print_footer_scripts', array( $this, 'async_print' ), 20 );

      add_filter( 'script_loader_tag', array( $this, 'script_tag_async' ), 20, 3 );

    }

    public static function instance() {

      static $instance;

      if( !$instance )
        $instance = new Minit();
      

      // By default minit puts everything into footer, which causes issues with dependencies.
      add_filter( 'minit-js-in-footer', '__return_false' );
      
      // We disable all caching. 
      add_filter( 'minit-use-cache', '__return_false' );
      
      // Disable using the in-footer async thing.
      add_filter( 'minit-script-tag-async', '__return_false' );
      
      // Disables caching, although still writes to disk.
      add_filter( 'minit-cache-expiration', function() { return 0; });
      

      return $instance;

    }

    function init_minit_js( $todo ) {


      global $wp_scripts;

      if( did_action( 'get_footer' ) ) {
        return $this->minit_objects( $wp_scripts, $todo, 'js', 'footer' );
      } else {
        return $this->minit_objects( $wp_scripts, $todo, 'js', 'header' );
      }

    }

    function init_minit_css( $todo ) {

      global $wp_styles;

      if( did_action( 'get_footer' ) ) {
        return $this->minit_objects( $wp_styles, $todo, 'css', 'footer' );
      } else {
        return $this->minit_objects( $wp_styles, $todo, 'css', 'header' );
      }

    }

    /**
     * @param $object
     * @param $todo
     * @param $extension
     * @param $where
     * @return array
     */
    function minit_objects( &$object, $todo, $extension, $where ) {

      global $wp_scripts;

      // Don't run if on admin or already processed
      if( is_admin() || empty( $todo ) )
        return $todo;

      if( $where === 'header' && $extension == 'js' ) {
        //die( '<pre>' . print_r( $wp_scripts->groups[], true ) . '</pre>' );
        //die( '<pre>' . print_r( $todo, true ) . '</pre>' );
      }
      // Allow files to be excluded from Minit
      $minit_exclude = apply_filters( 'minit-exclude-' . $extension, array() );

      // Not just exclude but actually drop files.
      $minit_drop = apply_filters( 'minit-drop-' . $extension, array() );

      if( !is_array( $minit_exclude ) )
        $minit_exclude = array();

      // Exluce all minit items by default. When ran in footer i
      $minit_exclude = array_merge( $minit_exclude, $this->get_done() );

      if( $where === 'header' && $extension == 'js' ) {
        // die( '<pre>$minit_todo ' . print_r( $todo, true ) . '</pre>' );
      }

      foreach( $todo as $_handle ) {
        if( isset( $wp_scripts->groups[ $_handle ] ) && $wp_scripts->groups[ $_handle ] === 1 && $where === 'header' ) {
          $minit_exclude[] = $_handle;
        }
      }

      if( $where === 'header' && $extension == 'js' ) {
        // die( '<pre>$minit_exclude ' . print_r( $minit_exclude, true ) . '</pre>' );
      }

      // echo( '<pre> minit todo ' . $extension . ' - ' . $where . ' - ' . print_r( $todo, true ) . '</pre>' );
      $minit_todo = array_diff( $todo, $minit_exclude );

      if( $where === 'header' && $extension == 'js' ) {
        //die( '<pre>$minit_todo ' . print_r( $minit_todo, true ) . '</pre>' );
      }

      if( empty( $minit_todo ) )
        return $todo;

      $done = array();
      $ver = array();
      $included_scripts = array();

      // Bust cache on Minit plugin update
      $ver[] = 'minit-ver-1.2';

      // Debug enable
      // if ( defined( 'WP_DEBUG' ) && WP_DEBUG )
      //	$ver[] = 'debug-' . time();

      // Use different cache key for SSL and non-SSL
      $ver[] = 'is_ssl-' . is_ssl();

      // Use a global cache version key to purge cache
      $ver[] = 'minit_cache_ver-' . get_option( 'minit_cache_ver' );

      // Drop select files.
      foreach( (array)$minit_drop as $_to_drop ) {
        if( ( $key = array_search( $_to_drop, $minit_todo ) ) !== false ) {
          unset( $minit_todo[ $key ] );
        }
      }
      //if( $where === 'header' ) {die( '<pre>' . print_r( $minit_todo, true ) . '</pre>' );//}

      // Use script version to generate a cache key
      foreach( $minit_todo as $t => $script ) {
        $ver[] = sprintf( '%s-%s', $script, $object->registered[ $script ]->ver );
        $included_scripts[] = $script;
      }

      // allow for version override.
      $ver = apply_filters( 'minit-build-ver', $ver, $extension );

      $cache_ver = md5( 'minit-' . implode( '-', $ver ) . $extension );

      $cache_ver = apply_filters( 'minit-ver-tag-' . $extension, $cache_ver, $included_scripts );

      // Try to get queue from cache
      if( $_use_cache = apply_filters( 'minit-use-cache', true ) ) {
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $cache = get_transient( 'minit-' . $cache_ver );
      }

      if( isset( $cache[ 'cache_ver' ] ) && $cache[ 'cache_ver' ] == $cache_ver && file_exists( $cache[ 'file' ] ) )
        return $this->minit_enqueue_files( $object, $cache, $where );

      Minit::console_log( array(
        "where" => $where,
        "data" => $minit_todo
      ) );

      $_paths_used = array();
      $_modified_times = array();

      foreach( $minit_todo as $script ) {

        // Get the relative URL of the asset
        $src = self::get_asset_relative_path( $object->base_url, $object->registered[ $script ]->src );

        // Add support for pseudo packages such as jquery which return src as empty string
        if( empty( $object->registered[ $script ]->src ) || '' == $object->registered[ $script ]->src )
          $done[ $script ] = null;

        // Skip if the file is not hosted locally
        if( !$src || !file_exists( ABSPATH . $src ) )
          continue;

        $script_content = apply_filters( 'minit-item-' . $extension, file_get_contents( ABSPATH . $src ), $object, $script );
        $_paths_used[] = ABSPATH . $src;

        $_modified_times[ $src ] = filemtime( ABSPATH . $src );

        if( false !== $script_content )
          $done[ $script ] = $script_content;

      }

      if( empty( $done ) )
        return $todo;

      $wp_upload_dir = wp_upload_dir();

      // Try to create the folder for cache
      if( !is_dir( $wp_upload_dir[ 'basedir' ] . '/minit' ) )
        if( !mkdir( $wp_upload_dir[ 'basedir' ] . '/minit' ) )
          return $todo;

      // Use highest modified time.
      if( is_array( $_modified_times ) ) {
        $cache_ver = $cache_ver . '-' . md5( max( $_modified_times ) );
      }

      $combined_file_path = sprintf( apply_filters( 'minit-file-pattern', '%s/minit/%s.%s', $extension, $where, $_modified_times ), $wp_upload_dir[ 'basedir' ], $cache_ver, $extension );
      $combined_file_url = sprintf( apply_filters( 'minit-file-pattern', '%s/minit/%s.%s', $extension, $where, $_modified_times ), $wp_upload_dir[ 'baseurl' ], $cache_ver, $extension );

      if( isset( $where ) && $where === 'header' && $extension === 'js' ) {
        // die( '<pre>' . print_r( $_modified_times, true ) . '</pre>' );
        // die( '<pre>' . print_r( array( 'where' => $where, '$extension' => $extension, '$combined_file_url' => $combined_file_url  ), true ) . '</pre>' );
      }

      // Allow other plugins to do something with the resulting URL
      $combined_file_url = apply_filters( 'minit-url-' . $extension, $combined_file_url, $done );

      // Allow other plugins to minify and obfuscate
      $done_imploded = apply_filters( 'minit-content-' . $extension, implode( "\n\n", $done ), $done );

      // Store the combined file on the filesystem
      if( !file_exists( $combined_file_path ) )
        if( !file_put_contents( $combined_file_path, $done_imploded ) )
          return $todo;

      $status = array(
        'cache_ver' => $cache_ver,
        'todo' => $todo,
        'done' => array_keys( $done ),
        'url' => $combined_file_url,
        'file' => $combined_file_path,
        'extension' => $extension
      );

      if( $_use_cache = apply_filters( 'minit-use-cache', true ) ) {
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        // Cache this set of scripts, by default for 24 hours
        $cache_expiration = apply_filters( 'minit-cache-expiration', 24 * 60 * 60 );
        set_transient( 'minit-' . $cache_ver, $status, $cache_expiration );
      }

      $this->set_done( $cache_ver );

      return $this->minit_enqueue_files( $object, $status, $where );

    }

    /**
     * @param $message
     */
    function console_log( $message ) {


      if( is_array( $message ) ) {
        $message = json_encode( $message );
      } else {
        $message = '"' . $message . '"';
      }

      if( defined( 'WP_DEBUG_MINIT' ) && WP_DEBUG_MINIT ) {
        echo "<script type='text/javascript'>console.log('minit'," . $message . ");</script>";
      }

    }

    function minit_enqueue_files( &$object, $status, $where ) {


      extract( $status );

      Minit::console_log( "minit_enqueue_files " . ' ' . $extension . ' ' . $where );

      //$minit_exclude = (array)apply_filters( 'minit-exclude-js', array() );

      switch( $extension ) {

        case 'css':

          wp_enqueue_style( 'minit-' . $cache_ver, $url, null, null );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

          // Add inline styles for all minited styles
          foreach( $done as $script ) {

            $inline_style = $object->get_data( $script, 'after' );

            if( empty( $inline_style ) )
              continue;

            if( is_string( $inline_style ) )
              $object->add_inline_style( 'minit-' . $cache_ver, $inline_style );
            elseif( is_array( $inline_style ) )
              $object->add_inline_style( 'minit-' . $cache_ver, implode( ' ', $inline_style ) );

          }

          break;

        case 'js':

          wp_enqueue_script( 'minit-' . $cache_ver, $url, null, null, apply_filters( 'minit-js-in-footer', $where == 'footer' ? true : false ) );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

          // Add to the correct
          $object->set_group( 'minit-' . $cache_ver, false, apply_filters( 'minit-js-in-footer', $where == 'footer' ? true : false ) );

          $inline_data = array();

          // Add inline scripts for all minited scripts
          foreach( $done as $script )
            $inline_data[] = $object->get_data( $script, 'data' );

          // Filter out empty elements
          $inline_data = array_filter( $inline_data );

          if( !empty( $inline_data ) )
            $object->add_data( 'minit-' . $cache_ver, 'data', implode( "\n", $inline_data ) );

          break;

        default:

          return $todo;

      }

      // Remove scripts that were merged
      $todo = array_diff( $todo, $done );

      $todo[] = 'minit-' . $cache_ver;

      // Mark these items as done
      $object->done = array_merge( $object->done, $done );

      // Remove Minit items from the queue
      $object->queue = array_diff( $object->queue, $done );

      return $todo;

    }

    function set_done( $handle ) {


      $this->minit_done[] = 'minit-' . $handle;

    }

    function get_done() {


      return $this->minit_done;

    }

    public static function get_asset_relative_path( $base_url, $item_url ) {

      // Remove protocol reference from the local base URL
      $base_url = preg_replace( '/^(https?:\/\/|\/\/)/i', '', $base_url );

      // Check if this is a local asset which we can include
      $src_parts = explode( $base_url, $item_url );

      // Get the trailing part of the local URL
      $maybe_relative = end( $src_parts );

      if( !file_exists( ABSPATH . $maybe_relative ) )
        return false;

      return $maybe_relative;

    }

    public function async_init() {

      global $wp_scripts;

      if( !is_object( $wp_scripts ) || empty( $wp_scripts->queue ) )
        return;

      $base_url = site_url();
      $minit_exclude = (array)apply_filters( 'minit-exclude-js', array() );

      foreach( $wp_scripts->queue as $handle ) {

        // Skip asyncing explicitly excluded script handles
        if( in_array( $handle, $minit_exclude ) ) {
          continue;
        }

        $script_relative_path = Minit::get_asset_relative_path(
          $base_url,
          $wp_scripts->registered[ $handle ]->src
        );

        if( !$script_relative_path ) {
          // Add this script to our async queue
          $this->async_queue[] = $handle;

          // Remove this script from being printed the regular way
          wp_dequeue_script( $handle );
        }

      }

    }

    public function async_print() {

      global $wp_scripts;

      if( empty( $this->async_queue ) )
        return;

      // Disable the actual async..
      if( !apply_filters( 'minit-js-footer-async', true ) ) {
        return;
      }

      // Seems to be adding "head" script twice. Adding this to prevent.
      if( !apply_filters( 'minit-js-in-footer', true ) ) {
        return;
      }

      ?>
      <!-- Asynchronous scripts by Minit -->
      <script id="minit-async-scripts" type="text/javascript">
      (function () {
        var js, fjs = document.getElementById( 'minit-async-scripts' ),
          add = function ( url, id ) {
            js = document.createElement( 'script' );
            js.type = 'text/javascript';
            js.src = url;
            js.async = true;
            js.id = id;
            fjs.parentNode.insertBefore( js, fjs );
          };
        <?php
        foreach( $this->async_queue as $handle ) {
          printf(
            'add("%s", "%s"); ',
            $wp_scripts->registered[ $handle ]->src,
            'async-script-' . esc_attr( $handle )
          );
        }
        ?>
      })();
    </script>
      <?php

    }

    public function script_tag_async( $tag, $handle, $src ) {


      // Allow others to disable this feature
      if( !apply_filters( 'minit-script-tag-async', true ) )
        return $tag;

      // Do this for minit scripts only
      if( false === stripos( $handle, 'minit-' ) )
        return $tag;

      // Bail if async is already set
      if( false !== stripos( $tag, ' async' ) )
        return $tag;

      // return str_ireplace( '<script ', '<script async ', $tag );
      return str_ireplace( '<script ', '<script ', $tag );

    }

  }

// Prepend the filename of the file being included
  add_filter( 'minit-item-css', 'UsabilityDynamics\AMD\minit_comment_combined', 15, 3 );
  add_filter( 'minit-item-js', 'UsabilityDynamics\AMD\minit_comment_combined', 15, 3 );

  function minit_comment_combined( $content, $object, $script ) {

    if( !$content )
      return $content;

    return sprintf(
      "\n\n/* Minit: %s */\n",
      $object->registered[ $script ]->src
    ) . $content;

  }

// Add table of contents at the top of the Minit file
  add_filter( 'minit-content-css', 'UsabilityDynamics\AMD\minit_add_toc', 100, 2 );
  add_filter( 'minit-content-js', 'UsabilityDynamics\AMD\minit_add_toc', 100, 2 );

  function minit_add_toc( $content, $items ) {

    if( !$content || empty( $items ) )
      return $content;

    $toc = array();

    foreach( $items as $handle => $item_content )
      $toc[] = sprintf( ' - %s', $handle );

    return sprintf( "/* TOC: " . time() . "\n%s\n*/", implode( "\n", $toc ) ) . $content;

  }

// Turn all local asset URLs into absolute URLs
  add_filter( 'minit-item-css', 'UsabilityDynamics\AMD\minit_resolve_css_urls', 10, 3 );

  function minit_resolve_css_urls( $content, $object, $script ) {


    if( !$content )
      return $content;

    $src = Minit::get_asset_relative_path(
      $object->base_url,
      $object->registered[ $script ]->src
    );

    // Make all local asset URLs absolute
    $content = preg_replace(
      '/url\(["\' ]?+(?!data:|https?:|\/\/)(.*?)["\' ]?\)/i',
      sprintf( "url('%s/$1')", $object->base_url . dirname( $src ) ),
      $content
    );

    return $content;

  }

// Add support for relative CSS imports
  add_filter( 'minit-item-css', 'UsabilityDynamics\AMD\minit_resolve_css_imports', 10, 3 );

  function minit_resolve_css_imports( $content, $object, $script ) {


    if( !$content )
      return $content;

    $src = Minit::get_asset_relative_path(
      $object->base_url,
      $object->registered[ $script ]->src
    );

    // Make all import asset URLs absolute
    $content = preg_replace(
      '/@import\s+(url\()?["\'](?!https?:|\/\/)(.*?)["\'](\)?)/i',
      sprintf( "@import url('%s/$2')", $object->base_url . dirname( $src ) ),
      $content
    );

    return $content;

  }

// Exclude styles with media queries from being included in Minit
  add_filter( 'minit-item-css', 'UsabilityDynamics\AMD\minit_exclude_css_with_media_query', 10, 3 );

  function minit_exclude_css_with_media_query( $content, $object, $script ) {

    if( !$content )
      return $content;

    $whitelist = array( '', 'all', 'screen' );

    // Exclude from Minit if media query specified
    if( !in_array( $object->registered[ $script ]->args, $whitelist ) )
      return false;

    return $content;

  }

// Make sure that all Minit files are served from the correct protocol
  add_filter( 'minit-url-css', 'UsabilityDynamics\AMD\minit_maybe_ssl_url' );
  add_filter( 'minit-url-js', 'UsabilityDynamics\AMD\minit_maybe_ssl_url' );

  function minit_maybe_ssl_url( $url ) {

    if( is_ssl() )
      return str_replace( 'http://', 'https://', $url );

    return $url;

  }

// Add a Purge Cache link to the plugin list
  add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), 'UsabilityDynamics\AMD\minit_cache_purge_admin_link' );

  function minit_cache_purge_admin_link( $links ) {

    $links[] = sprintf(
      '<a href="%s">%s</a>',
      wp_nonce_url( add_query_arg( 'purge_minit', true ), 'purge_minit' ),
      __( 'Purge cache', 'minit' )
    );

    return $links;

  }

  /**
   * Maybe purge minit cache
   */
  add_action( 'admin_init', 'purge_minit_cache' );

  function purge_minit_cache() {

    if( !isset( $_GET[ 'purge_minit' ] ) )
      return;

    if( !check_admin_referer( 'purge_minit' ) )
      return;

    // Use this as a global cache version number
    update_option( 'minit_cache_ver', time() );

    add_action( 'admin_notices', 'UsabilityDynamics\AMD\minit_cache_purged_success' );

    // Allow other plugins to know that we purged
    do_action( 'minit-cache-purged' );

  }

  function minit_cache_purged_success() {

    printf(
      '<div class="updated"><p>%s</p></div>',
      __( 'Success: Minit cache purged.', 'minit' )
    );

  }

// This can used from cron to delete all Minit cache files
  add_action( 'minit-cache-purge-delete', 'UsabilityDynamics\AMD\minit_cache_delete_files' );

  function minit_cache_delete_files() {

    $wp_upload_dir = wp_upload_dir();
    $minit_files = glob( $wp_upload_dir[ 'basedir' ] . '/minit/*' );

    if( $minit_files ) {

      foreach( $minit_files as $minit_file ) {
        unlink( $minit_file );
      }
    }

  }

  /* Set timestamp for Minit */
  function minit_timestamp() {
    if( isset( $_GET[ "minitflush" ] ) || ( ( isset( $_SERVER[ 'HTTP_X_ACCESS_TOKEN' ] ) && $_SERVER[ 'HTTP_X_ACCESS_TOKEN' ] == 'yhcwokwserjzdjir' ) && ( isset( $_SERVER[ 'HTTP_X_MINIT_FLUSH' ] ) && $_SERVER[ 'HTTP_X_MINIT_FLUSH' ] == true ) ) ) {
      update_option( 'minit_timestamp', time() );
      $time = get_option( 'minit_timestamp' );
    } else {
      if( get_option( 'minit_timestamp' ) == true && get_option( 'minit_timestamp' ) !== '' ) {
        $time = get_option( 'minit_timestamp' );
      } else {
        $time = time();
      }
    }
    return $time;
  }

}
UsabilityDynamics / wp-amd

Push — v1.5 ( 5d3331...24344c )

class-minit.php ➔ minit_add_toc() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
