sniffer.js

/*
 * Sniffer - sniffs web pages to extract information such as JS libraries, CMS, analytics packages, etc.
 * Author: Mark Perkins, mark@allmarkedup.com
 */

var Sniffer = (function( win, doc, undefined ){

    var sniff       = {},
        detect      = {},
        pageinfo     = {},
        test_runner = {},
        results     = {},
        indexed_results = {},
        scripts     = doc.getElementsByTagName("script"),
        metas       = doc.getElementsByTagName("meta"),
        html        = doc.documentElement.outerHTML || doc.documentElement.innerHTML,
        doctype     = doc.doctype,
        has_run     = false;

    // discard meta tags that aren't useful
    metas = (function(){
        for ( var meta, temp = [], i = -1; meta = metas[++i]; )
        {
            if ( meta.name && meta.content ) temp.push(meta);
        }
        return temp;
    })();

    // discard script tags that aren't useful
    scripts = (function(){
        for ( var script, temp = [], i = -1; script = scripts[++i]; )
        {
            if ( script.src ) temp.push(scripts);
        }
        return temp;
    })();

    /* page component detection tests */

    detect.pageinfo = {

        description : 'Page information',

        return_type : 'detail',

        tests : {

            'Doctype' : [
                {
                    type : 'doctype', // source: http://www.w3.org/QA/2002/04/valid-dtd-list.html
                    test : {
                        'HTML5'                    : { name : 'html', publicId : '' },
                        'HTML 4.01 Strict'         : { name : 'html', publicId : '-//W3C//DTD HTML 4.01//EN' },
                        'HTML 4.01 Transitional'   : { name : 'html', publicId : '-//W3C//DTD HTML 4.01 Transitional//EN' },
                        'XHTML 1.0 Strict'         : { name : 'html', publicId : '-//W3C//DTD XHTML 1.0 Strict//EN' },
                        'XHTML 1.0 Transitional'   : { name : 'html', publicId : '-//W3C//DTD XHTML 1.0 Transitional//EN' },
                        'XHTML 1.0 Frameset'       : { name : 'html', publicId : '-//W3C//DTD XHTML 1.0 Frameset//EN' },
                        'XHTML 1.1'                : { name : 'html', publicId : '-//W3C//DTD XHTML 1.1//EN' },
                        'HTML 2.0'                 : { name : 'html', publicId : '-//IETF//DTD HTML 2.0//EN' },
                        'HTML 3.0'                 : { name : 'html', publicId : '-//W3C//DTD HTML 3.2 Final//EN' },
                        'XHTML 1.0 Basic'          : { name : 'html', publicId : '-//W3C//DTD XHTML Basic 1.0//EN' }
                    }
                }
            ],
            'Charset' : [
                {
                    type : 'custom',
                    test : function(){ return doc.characterSet || 'None detected'; }
                }
            ]
        }

    };

    detect.js_libs = {

        description : 'JavaScript Libraries',

        return_type : 'version',

        // All individual tests should either return a version number, true or false.

        tests : {

            'jQuery' : [
                {
                    type : 'custom',
                    test : function(){ return win.jQuery ? win.jQuery.fn.jquery : false; }
                }
            ],
            'jQuery UI' : [
                {
                    type : 'custom',
                    test : function(){ return win.jQuery && win.jQuery.ui ? win.jQuery.ui.version : false; }
                }
            ],
            'Prototype' : [
                {
                    type : 'custom',
                    test : function(){ return win.Prototype ? win.Prototype.Version : false; }
                }
            ],
            'Scriptaculous' : [
                {
                    type : 'custom',
                    test : function(){ return win.Scriptaculous ? win.Scriptaculous.Version : false; }
                }
            ],
            'MooTools' : [
                {
                    type : 'custom',
                    test : function(){ return win.MooTools ? win.MooTools.version : false; }
                }
            ],
            'Glow' : [
                {
                    type : 'custom',
                    test : function(){ return win.glow ? win.glow.VERSION : false; }
                }
            ],
            'Dojo' : [
                {
                    type : 'custom',
                    test : function(){ return win.dojo ? win.dojo.version.toString() : false; }
                }
            ],
            'ExtJS' : [
                {
                    type : 'custom',
                    test : function(){ return win.Ext ? win.Ext.version : false; }
                }
            ],
            'YUI' : [
                {
                    type : 'custom',
					test : function(){ return win.YAHOO ? win.YAHOO.VERSION : false; }
                }
            ],
            'Google Closure' : [
                {
                    type : 'custom',
                    test : function(){ return !! win.goog; } // need to figure out how to get YUI version
                }
            ],
            'Modernizr' : [
                {
                    type : 'custom',
                    test : function(){ return win.Modernizr ? win.Modernizr._version : false; } // need to figure out how to get YUI version
                }
            ],
			'Raphael' : [
				{
					type : 'custom',
					test : function(){ return win.Raphael ? win.Raphael.version : false; }
				}
			]
        }
    };

    detect.cms = {

        description : 'Content Management System',

        return_type : 'version',

        tests : {

            'Wordpress' : [
                {
                    type : 'meta',
                    test : { name : 'generator', match : /WordPress\s?([\w\d\.\-_]*)/i }
                },
                {
                    type : 'text',
                    test : /<link rel=["|']stylesheet["|'] [^>]+wp-content/i
                }
            ],
            'Typepad' : [
                {
                    type : 'meta',
                    test : { name : 'generator', match : /typepad\.com/i }
                }
            ],
            'Joomla' : [
                {
                    type : 'meta',
                    test : { name : 'generator', match : /joomla\!?\s?([\d.]*)/i }
                }
            ],
			'Blogger' : [
				{
					type : 'meta',
					test : { name : 'generator', match : /blogger/i }
				}
			],
			'MovableType' : [
				{
					type : 'meta',
					test : { name : 'generator', match : /Movable Type Pro ([\d.]*)/i }
				}
			],
			'Drupal' : [
				{
					type : 'custom',
					test : function() { return win.Drupal ? true : false; } // no version in js obj
				}
			],
			'Cisco Eos' : [
				{
					type : 'custom',
					test : function() { return win.eos ? true : false; } // no version in js obj
				},
				{
                    type : 'text',
                    test : /<link rel=["|']stylesheet["|'] [^>]+ciscoeos.com/i
                }
			]
        }

    };

    detect.analytics = {

        description : 'Analytics',

        return_type : 'version',

        tests : {

            'Google Analytics' : [
                {
                    type : 'custom',
                    test : function(){ return !! (win._gat || win._gaq); }
                }
            ],
            'Reinvigorate' : [
                {
                    type : 'custom',
                    test : function(){ return !! win.reinvigorate; }
                }
            ],
            'Piwik' : [
                {
                    type : 'custom',
                    test : function(){ return !! win.Piwik; }
                }
            ],
            'Clicky' : [
                {
                    type : 'custom',
                    test : function(){ return !! win.clicky; }
                }
            ],
			'Open Web Analytics' : [
				{
					type : 'custom',
					test : function() { return !! win.OWA; }
				}
			]
        }

    };

    detect.fonts = {

        description : 'Fonts',

        return_type : 'version',

        tests : {

            'Cufon' : [
                {
                    type : 'custom',
                    test : function(){ return !! win.Cufon }
                }
            ],
            'Typekit' : [
                {
                    type : 'custom',
                    test : function(){ return !! win.Typekit }
                }
            ],
            'Fontdeck' : [
                {
                    type : 'text',
                    test : /<link rel=["|']stylesheet["|'] [^>]+f.fontdeck.com/i
                }
            ],
            'Google Webfonts' : [
                {
                    type : 'custom',
                    test : function(){ return !! win.WebFont }
                }
            ],
            'sIFR' : [
                {
                    type : 'custom',
                    test : function(){ return win.sIFR ? win.sIFR.VERSION : false }
                }
            ]
        }

    };


    /* test runners */

    // custom tests just run a function that returns a version number, true or false.
    test_runner.custom = function( test )
    {
        return test();
    }

    // one off regexp-based tests
    test_runner.text = function( test )
    {
        return match( html, test );
    }

    if ( doctype )
    {
        test_runner.doctype = function( test )
        {
            for ( subtest in test )
            {
                if ( test.hasOwnProperty(subtest) )
                {
                    var t = test[subtest];

                    if ( doctype.name.toLowerCase() == t.name && doctype.publicId == t.publicId )
                    {
                        return subtest;
                    }
                }
            }
            return false;
        }
    }
    else
    {
        test_runner.doctype = function(){
            return 'None detected';
        }
    }

    // check the script src... probably pretty unreliable
    if ( scripts.length )
    {
        test_runner.script = function( test )
        {
            for ( var script, i = -1; script = scripts[++i]; )
            {
                return match( script.src, test );
            }
            return false;
        }
    }
    else
    {
        // no scripts, tests will always return false.
       test_runner.script = function(){ return false; }
    }

    // check the meta elements in the head
    if ( metas.length )
    {
        test_runner.meta = function( test )
        {
            for ( var meta, i = -1; meta = metas[++i]; )
            {
                if ( meta.name == test.name )
                {
                    var res = match( meta.content, test.match );
                    if ( res ) return res;
                }
            }
            return false;
        }
    }
    else
    {
        // there are no meta elements on the page so this will always return false
        test_runner.meta = function(){ return false; }
    }

    // test arg should be a regexp, in which the only *specific* match is the version number
    function match( str, test )
    {
        var match = str.match(test);
        if ( match ) return match[1] && match[1] != '' ? match[1] : true; // return version number if poss or else true.
        return false;
    }

    /* main function responsible for running the tests */

    var run = function( tests_array )
    {
        for ( var check, i = -1; check = tests_array[++i]; )
        {
            var result = test_runner[check.type]( check.test );
            if ( result !== false ) return result;
        }
        return false;
    }

    var empty = function( obj )
    {
        for ( var name in obj ) return false;
        return true;
    }
    
    // utility function for iterating over the tests
    var forEachTest = function( callback )
    {
        for ( group in detect )
        {
            if ( detect.hasOwnProperty(group) )
            {
                for ( test in detect[group].tests )
                {
                    if ( detect[group].tests.hasOwnProperty(test) )
                    {
                        if ( callback( group, test ) === false ) return;
                    }
                }
            }
        }
    }
    
    var addToResults = function( group, test, res )
    {
        // add results to group results object
        
        results[group] = results[group] || {};
        results[group].results = results[group].results || {};

        results[group].description = detect[group].description;
        results[group].return_type = detect[group].return_type;

        results[group]['results'][test] = res;
        
        // add the result to the name-index results object
        
        indexed_results[test.toLowerCase()] = res;
    }

    /* publicly available methods */
    
    // return results of all checks run so far 
    sniff.results = function(){
        return results;
    };
    
    // perform an individual check
    sniff.check = function( to_test )
    {
        to_test = to_test.toLowerCase();
        if ( indexed_results[to_test] != undefined ) return indexed_results[to_test];
        else {
            
            forEachTest(function( group, test ){
                
                if ( test.toLowerCase() === to_test )
                {
                    addToResults( group, test, run( detect[group].tests[test] ) );
                    return false; // break out of forEachTest loop
                }
                
            });
        }
        return indexed_results[to_test];
    };
    
    // run or re-run all checks
    sniff.run = function()
    {
        forEachTest(function( group, test ){
            
            addToResults( group, test, run( detect[group].tests[test] ) );
                    
        });      

        return sniff.results();
    };

    return sniff;

})( window, document );