Ozh\Bookmarkletgen\Bookmarkletgen

Complexity

Total Complexity

18

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	crunch()	0	13	1
A	encodeURIComponent()	0	7	1
A	kill_comments()	0	6	1
A	compress_white_space()	0	19	2
A	combine_strings()	0	6	1
C	replace_strings()	0	52	10
A	restore_strings()	0	7	2

<?php

/**
 * BookmarkletGen : converts readable Javascript code into a bookmarklet link
 *
 * Features :
 * - removes comments
 * - compresses code, not literal strings
 *   Example:
 *   function someName( param ) { alert( "this is a string" ) }
 *   will return:
 *   function%20someName(param){alert("this is a string")}
 * - wraps code into a self invoking function
 *
 * This is basically a slightly enhanced PHP port of the excellent Bookmarklet Crunchinator
 * http://ted.mielczarek.org/code/mozilla/bookmarklet.html
 *
 */
namespace Ozh\Bookmarkletgen;

class Bookmarkletgen {

    private $literal_strings = array();
    
    /**
     * Main function, calls all others
     *
     * @param  string $code  Javascript code to bookmarkletify
     * @return string        Bookmarklet link
     */
    public function crunch( $code ) {
        $out = "(function() {\n" . $code . "\n})();";

        $out = $this->replace_strings( $out );
        $out = $this->kill_comments( $out );
        $out = $this->compress_white_space( $out );
        $out = $this->combine_strings( $out );
        $out = $this->restore_strings( $out );
        $out = $this->encodeURIComponent( $out );
        $out = 'javascript:' . $out;

        return $out;
    }
    
    /**
     * PHP port of Javascript function encodeURIComponent
     *
     * From http://stackoverflow.com/a/1734255/36850
     *
     * @since
     * @param  string $str  String to encode
     * @return string       Encoded string
     */
    // 
    private function encodeURIComponent( $str ) {
        $revert = array(
            '%21'=>'!', '%2A'=>'*', '%28'=>'(', '%29'=>')',
        );
    
        return strtr( rawurlencode( $str ), $revert );
    }

    /**
     * Kill comment lines and blocks
     *
     * @param  string $code  Commented Javascript code
     * @return string        Commentless code
     */
    private function kill_comments( $code ) {
        $code = preg_replace( '!\s*//.+$!m', '', $code );
        $code = preg_replace( '!/\*.+?\*/!sm', '', $code ); // s modifier: dot matches new lines
        
        return $code;
    }
    
    /**
     * Compress white space
     *
     * Remove some extraneous spaces and make the whole script a one liner
     *
     * @param  string $code  Javascript code
     * @return string        Compressed code
     */
    private function compress_white_space( $code ) {
        // Tabs to space, no more than 1 consecutive space
        $code = preg_replace( '!\t!m', ' ', $code );
        $code = preg_replace( '![ ]{2,}!m', ' ', $code );
        
        // Remove uneccessary white space around operators, braces and brackets.
        // \xHH sequence is: !%&()*+,-/:;<=>?[]\{|}~
        $code = preg_replace( '/\s([\x21\x25\x26\x28\x29\x2a\x2b\x2c\x2d\x2f\x3a\x3b\x3c\x3d\x3e\x3f\x5b\x5d\x5c\x7b\x7c\x7d\x7e])/m', "$1", $code );
        $code = preg_replace( '/([\x21\x25\x26\x28\x29\x2a\x2b\x2c\x2d\x2f\x3a\x3b\x3c\x3d\x3e\x3f\x5b\x5d\x5c\x7b\x7c\x7d\x7e])\s/m', "$1", $code );
        
        // Split on each line, trim leading/trailing white space, kill empty lines, combine everything in one line
        $code = preg_split( '/\r\n|\r|\n/', $code );
        foreach( $code as $i => $line ) {
            $code[ $i ] = trim( $line );
        }
        $code = implode( '', $code );

        return $code;
    }
    
    /**
     * Combine any consecutive strings
     *
     * In the case we have two consecutive quoted strings (eg: "hello" + "world"), save a couple more
     * length and combine them
     *
     * @param  string $code  Javascript code
     * @return string        Javascript code
     */
    private function combine_strings( $code ) {
        $code = preg_replace('/"\+"/m', "", $code);
        $code = preg_replace("/'\+'/m", "", $code);

        return $code;
    }

    
    /**
     * Replace all literal strings (eg: "hello world") with a placeholder and collect them in an array
     *
     * The idea is that strings cannot be trimmed or white-space optimized: take them out first before uglifying
     * the code, then we'll reinject them back in later
     *
     * @param  string $code  Javascript code
     * @return string        Javascript code with placeholders (eg "__1__") instead of literal strings
     */
    private function replace_strings( $code ) {
        $return    = "";
        $literal   = "";
        $quoteChar = "";
        $escaped   = false;

        // Split script into individual lines.
        $lines = explode("\n", $code);
        $count = count( $lines );
        for( $i = 0; $i < $count; $i++ ) {

            $j = 0;
            $inQuote = false;
            while ($j < strlen( $lines[$i] ) ) {
                $c = $lines[ $i ][ $j ];

                // If not already in a string, look for the start of one.
                if (!$inQuote) {
                    if ($c == '"' || $c == "'") {
                        $inQuote = true;
                        $escaped = false;
                        $quoteChar = $c;
                        $literal = $c;
                    }
                    else {
                        $return .= $c;
                    }
                }

                // Already in a string, look for end and copy characters.
                else {
                    if ($c == $quoteChar && !$escaped) {
                        $inQuote = false;
                        $literal .= $quoteChar;
                        $return .= "__" . count( $this->literal_strings ) . "__";
                        $this->literal_strings[ count( $this->literal_strings ) ] = $literal;
                    }
                    else if ($c == "\\" && !$escaped) {
                        $escaped = true;
                    }
                    else {
                        $escaped = false;
                    }
                    $literal .= $c;
                }
                $j++;
            }
            $return .= "\n";
        }

        return $return;
    }
    
    /**
     * Restore literal strings by replacing their placeholders with actual strings
     *
     * @param  string $code  Javascript code with placeholders
     * @return string        Javascript code with actual strings
     */
    private function restore_strings( $code ) {
        foreach( $this->literal_strings as $i => $string ) {
            $code = preg_replace( '/__' . $i . '__/', $string, $code, 1 );
        }
        
        return $code;
    }

}