SunHateR.com Projects	KCFinder \| CSS Joiner \| JS Joiner

JS Joiner: realtime JavaScript optimizer

Current version: 1.0
Author: Pavel Tzonkov
License: LGPLv2
Copyright ©2010 JS Joiner Project

Overview
Features
Compatibality
Demo
Download
Last version changelog
Installation
How to integrate another JavaScript parser
Used 3rd party software

Overview

JS Joiner is a realtime JavaScript optimizer, you may use in your web site/application to minimize JavaScript code returned from your web server. Multiple local or external files can be loaded just like single JavaScript file - using single <script> tag (one server request). Caching system is available for faster responses - generate and save compressed JavaScript code once, until change in source files is done.

Features

Load multile local and/or external JavaScript files in single <script> tag.
Multiple compression methods. Easy to integrate new one.
Parse only new requests and/or modified JavaScript files, and return compressed content from cache.
Browser-side cache.
HTTP referer protection to avoid external use.

Compatibality

JS Joiner is tested on Apache 2 web server on Linux only. Probably it will works on other web servers and operating systems.
mod_rewrite Apache module is optioanl requirement for non-parameter URLs.
PHP5 is required. For loading external JavaScript files, allow_url_fopen ini setting should be enabled.

Demo

Enter URL paths to source JavaScript files you want to parse. Please type each URL in single line:

Method: mod_rewrite URL style

Script tag:

Uncompressed code:

Compressed code:

Download

Last version changelog

Version 1.0 - May 15, 2010

It's first public version!

Installation

Unpack and upload the package files to a directory on your site (e.g. /jsj).
Make sure /jsj/jsmin/cache and /jsj/jspack/cache directories are writable for the web server.
Now JS Joiner is installed and ready for use. You may parse your JavaScript files in src atribute of a <script> tag.

Using JSMin method with js[] GET parameters:

/jsj/jsmin/?js[]=unlocated.js&js[]=%2Fapp%2Flocated.js&js[]=%2Fjs_dir&js[]=http%3A%2F%2Fexternal.site.com%2Fscript.js

Paths to source JavaScript files are defined as js[] GET parameters. It's recommended to URL-encode these parameters. The files will be parsed in order as they are defined in the URL address. This example will parse these files if they exists:

/jsj/jsmin/unlocated.js - if not exists JS Joiner will try to parse /unlocated.js
/app/located.js
/js_dir - all .js files in /js_dir directory
http://external.site.com/script.js - will be parsed only if allow_url_fopen PHP ini setting is enabled

For security resons local files with .js extension only can be parsed. By default it's valid rule for external files. There are several external files settings defined and described in /jsj/class.JSjoin.php.

Using JavaScript Packer method with mod_rewrite URL style:

/jsj/jspack/unlocated.js../js../app/common.js..http://external.site.com/script.js

This example will work only if mod_rewrite Apache module is available. JavaScript Packer (jspack) method is used. The source JavaScript files are separated by .. delimiter. You may change the delimiter editing /jsj/class.JSjoin.php file.

How to integrate another JavaScript parser

Currently JS Joiner has two JavaScript parsers - JSMin and JavaScript Packer. If you want to use another parser please follow these steps:

Create unique directory in JS Joiner main directory. (e.g. /jsj/new_parser).
Copy there .htaccess and index.php files from other parser's directory.
Create /jsj/new_parser/cache directory and change its permissions to be writable for the web server.
Create /jsj/new_parser/includes directory.
Create /jsj/new_parser/includes/parser.php file:

<?php

class parser extends JSjoin {

    protected function parse_file($file) {
        return self::parse_file_static($file);
    }

    static function parse_file_static($file) {
        $code = file_get_contents($file);

        // Here is the place you should to parse JavaScript code

        return $code;
    }
}

?>

If you leave this file as is, the parser will only join source JavaScript files without any compression. You may parse $code variable. If you want to use complete 3rd party parser, you should to include its source code on top of this file. See /jsj/jsmin/includes/parser.php and /jsj/jspack/includes/parser.php for examples.