path: root/js/codeq/core.js

(function () {
    window.siteDefinition = {logLevel: 'debug'}; // for debug purposes

    // ================================================================================
    // JSON-ization (stringification) function
    // ================================================================================

    var jsonize = JSON && JSON.stringify || function (obj) {
            var t, buffer, i, isFirst;
            if (null === obj) return 'null';
            t = typeof obj;
            if (t === 'string') {
                return '"' + obj.replace(regexpBackslash, '\\\\').replace(regexpQuote, '\\"') + '"';
            }
            if (t === 'number') {
                if (isFinite(obj)) return obj.toString();
                throw new Error('Cannot jsonize a non-finite number: ' + obj.toString());
            }
            if (t === 'boolean') {
                if (obj) return 'true';
                return 'false';
            }
            if (t === 'object') {
                if (obj instanceof String) return jsonize(obj.valueOf());
                if (obj instanceof Number) return jsonize(obj.valueOf());
                if (obj instanceof Boolean) return jsonize(obj.valueOf());
                if (obj instanceof Array) {
                    buffer = [ '[' ];
                    isFirst = true;
                    for (i = 0; i < obj.length; i++) {
                        if (isFirst) isFirst = false;
                        else buffer.push(',');
                        buffer.push(jsonize(obj[i]));
                    }
                    buffer.push(']');
                    return buffer.join('');
                }
                buffer = [ '{' ];
                isFirst = true;
                for (i in obj) {
                    if (!obj.hasOwnProperty(i)) continue;
                    if (isFirst) isFirst = false;
                    else buffer.push(',');
                    buffer.push(jsonize(i), ':', jsonize(obj[i]));
                }
                buffer.push('}');
                return buffer.join('');
            }
            throw new Error('Cannot jsonize ' + t);
        };

    // ================================================================================
    // The log module: contains methods for logging, sending logs to the server
    // ================================================================================

    var log = (function () {
        var logServiceUrl = window.siteDefinition && (typeof siteDefinition.logService === 'string') && siteDefinition.logService,
            assembleOutput = function (stuff, e) {
                var lines = [ stuff ];
                if (e && e.stack) lines.push(e.stack);
                return lines.join('\n');
            },
            console = window.console || {},
            levelPrefix = {'debug': 'DEBUG: ', 'info': 'INFO: ', 'warn': 'WARN: ', 'error': 'ERROR: '},
            levelSeverity = {'debug': 1, 'info': 2, 'warn': 3, 'error': 4, 'off': 5},
            severityThreshold = window.siteDefinition && levelSeverity[siteDefinition.logLevel] || levelSeverity['off'],
            logToConsole = function (level) {
                var prefix = levelPrefix[level];
                if (levelSeverity[level] < severityThreshold) return function () {}; // level is below threshold, ignore
                if (typeof console[level] === 'function') return function (output) {console[level](output);};
                if (typeof console.log === 'function') return function (output) {console.log(prefix + output);};
                if (typeof dump === 'function') return function (output) {dump(prefix + output);};
                return function () {}; // no way to log in browser
            },
            consoleLogger = {
                'debug': logToConsole('debug'),
                'info': logToConsole('info'),
                'warn': logToConsole('warn'),
                'error': logToConsole('error')
            },
            logger = {},
            level;

        if (logServiceUrl) {
            // log to the service and to the console
            var logs = []; // buffered logs
            for (level in levelPrefix) {
                if (!levelPrefix.hasOwnProperty(level)) continue;
                logger[level] = (function (levelLogger, level) {
                    if (levelSeverity[level] < severityThreshold) return function () {}; // level is below threshold, ignore
                    return function (stuff, e) {
                        var output = assembleOutput(stuff, e);
                        levelLogger(output);
                        logs.push({
                            't': Date.now(),
                            'l': level,
                            'm': output
                        });
                    };
                })(consoleLogger[level], level);
            }
            setInterval(function () {
                // each second send any logs to the server
                var copyOfLogs;
                if (logs.length < 1) return;
                copyOfLogs = jsonize({'logs': logs});
                logs = [];
                $.ajax({
                    contentType: 'application/json',
                    dataType: 'application/json',
                    type: 'POST',
                    url: logServiceUrl,
                    data: copyOfLogs,
                    error: function (jqXHR, textStatus, errorThrown) {
                        consoleLogger.error(assembleOutput('Posting of logs to ' + logServiceUrl + ' failed: ' + textStatus, errorThrown));
                    },
                    success: function (data, textStatus, jqXHR) {}
                });
            }, 1000);
        }
        else {
            // log only to the console
            for (level in levelPrefix) {
                if (!levelPrefix.hasOwnProperty(level)) continue;
                logger[level] = (function (levelLogger) {
                    if (levelSeverity[level] < severityThreshold) return function () {}; // level is below threshold, ignore
                    return function (stuff, e) { levelLogger(assembleOutput(stuff, e)); };
                })(consoleLogger[level]);
            }
        }

        return logger;
    })();

    // ================================================================================
    // The core CodeQ module
    // ================================================================================

    var jqDisabled = $('#disabled'), // used in codeq.wait()
        waitCssEnter = {'cursor': 'wait', 'display': ''};

    // regular expressions for the templating function, etc.
    var regexpQuote = new RegExp('"', 'g'),
        regexpBackslash = new RegExp('\\\\', 'g'),
        regexpWhiteSpaceStart = new RegExp('^[ \r\n\t]+'),
        regexpWhiteSpaceEnd = new RegExp('[ \r\n\t]+$'),
        regexpWhiteSpaceNonPrintable = new RegExp('[\r\n\t]', 'g'),
        regexpWhiteSpaceBeforeTag = new RegExp('[ \r\n\t]+(?=<)', 'g'),
        regexpWhiteSpaceAfterTag = new RegExp('>[ \r\n\t]+', 'g'),
        regexpWhiteSpace = new RegExp('[ \\r\\n\\t]+'),
        regexpWhiteSpaceTrim = new RegExp('^[ \\t\\r\\n]*(.*[^ \\t\\r\\n])[ \\t\\r\\n]*$', 'm'),
        regexpAmp = new RegExp('&', 'g'),
        regexpLt = new RegExp('<', 'g'),
        regexpGt = new RegExp('>', 'g');

    // convert a string into its definition (javascript literal)
    var stringToDef = function (str) {
        return str.replace(regexpBackslash, '\\\\').replace(regexpQuote, '\\"').replace(regexpWhiteSpaceNonPrintable, ' ');
    };

    // given a HTML source, remove whitespace among tags
    var cleanHtml = function (html) {
        // JavaScript doesn't support lookbehind, so we use the split-join trick
        return html.replace(regexpWhiteSpaceBeforeTag, '').split(regexpWhiteSpaceAfterTag).join('>');
    };

    var lang = 'en', // this is overridden in the boot sequence below, if the browser uses a supported language
        resources = {}; // resource tree, loaded from data/resources.json in the boot sequence

    // event dispatch
    var eventListeners = {}, // keyed by event name, value is an array of listeners
        asyncTimer = null,
        queuedEvents = [],
        fireEvents = function () {
            if (asyncTimer !== null) return;
            asyncTimer = setTimeout(function () {
                var N = queuedEvents.length,
                    i, event, args, listeners, j;
                asyncTimer = null;
                for (i = 0; i < N; i++) {
                    event = queuedEvents[i];
                    listeners = eventListeners[event.name];
                    if (!listeners) continue;
                    args = event.args;
                    listeners = listeners.slice(); // make a copy of the list, so we're unaffected of any changes
                    for (j = 0; j < listeners.length; j++) {
                        try {
                            listeners[j](args);
                        }
                        catch (e) {
                            codeq.log.error('Error while invoking an event handler for ' + event.name + ': ' + e, e);
                        }
                    }
                }
                queuedEvents.splice(0, N);
                if (queuedEvents.length > 0) fireEvents();
            }, 0);
        };

    var tokenize = function (line) {
        var result = [],
            N = line.length,
            i = 0, // character index into line
            storedAtom = null, // the previous atom, to decide whether to store a string or an object {key:'', value:''}
            atom = [], // currently parsed content
            isKeyValue = false,
            storeAtom = function () {
                if (atom.length == 0) return;
                if (storedAtom === null) storedAtom = atom.join('');
                else if (isKeyValue) {
                    result.push({'key': storedAtom, 'value': atom.join('')});
                    storedAtom = null;
                    isKeyValue = false;
                }
                else {
                    result.push(storedAtom);
                    storedAtom = atom.join('');
                }
                atom.length = 0;
            },
            c, q;

        while (i < N) {
            c = line[i++];
            switch (c) {
                // end-of-atom characters
                case ' ':
                case '\r':
                case '\n':
                case '\t':
                    storeAtom();
                    break;

                // escape character
                case '\\':
                    if (i < N) atom.push(line[i++]);
                    break;

                // key-value delimiter character
                case '=':
                    if (storedAtom) {
                        if (isKeyValue) atom.push(c);
                        else if (atom.length == 0) isKeyValue = true; // must have been a whitespace before "="
                        else {
                            storeAtom();
                            isKeyValue = true;
                        }
                    }
                    else atom.push(c); // "=" is delimiter only before the value, not before the key
                    break;

                // quoted string
                case '"':
                case "'":
                    stringConsume:
                    while (i < N) {
                        q = line[i++];
                        switch (q) {
                            case '\\':
                                if (i < N) atom.push(line[i++]);
                                break;
                            case c:
                                break stringConsume;
                            default:
                                atom.push(q);
                                break;
                        }
                    }
                    break;

                default:
                    atom.push(c);
                    break;
            }
        }
        // purge anything in cache
        storeAtom();
        if (storedAtom !== null) result.push(storedAtom);
        return result;
    };

    var resolveResource = function (resourceName, resourceBranches) {
        var traversedPath = ['data'], // top-level directory
            branch = resources,
            candidate = null,
            i, fragment;
        if (!resourceName) {
            codeq.log.error('No resource name provided; path: "' + resourceBranches.join('/') + '"');
            return null;
        }
        if (branch[resourceName]) candidate = 'data/' + resourceName; // top-level match
        for (i = 0; i < resourceBranches.length; i++) {
            fragment = resourceBranches[i];
            branch = branch[fragment];
            if (!branch) {
                codeq.log.error('Resource sub-branch ' + fragment + ' does not exist; resource: "' + resourceName + '", path: "' + resourceBranches.join('/') + '"');
                break;
            }
            traversedPath.push(fragment);
            if (branch[resourceName]) candidate = traversedPath.join('/') + '/' + resourceName;
        }
        if (candidate) return candidate;
        codeq.log.error('Resource ' + resourceName + ' was not found; path: "' + resourceBranches.join('/') + '"');
        return null;
    };

    var directiveHandlers = {
        'resource': function (code, tokens, templatePath) {
            code.push('_result.push("', resolveResource(tokens[1], templatePath) || 'data/broken.png', '");\n');
        },

        'img': function (code, tokens, templatePath) {
            var N = tokens.length,
                attrs = [],
                token, i;
            for (i = 1; i < N; i++) {
                token = tokens[i];
                if (!token || typeof token !== 'object') {
                    codeq.log.error('Invalid token at position ' + i + ' in @img');
                    continue;
                }
                switch (token.key) {
                    case 'src':
                        attrs.push('src="' + resolveResource(token.value, templatePath) + '"');
                        break;
                    case 'alt':
                        attrs.push('alt="' + codeq.escapeHtml(token.value) + '"');
                        break;
                    case 'class':
                        attrs.push('class="' + token.value + '"');
                        break;
                }
            }
            code.push('_result.push("<img ', attrs.join(' ').replace(regexpQuote, '\\"'), '>");\n');
        }
    };

    window.codeq = {
        'jsonize': jsonize,

        'log': log,

        'settings':{},

        'availableLangs': [], // filled at boot from 'supportedLangs'
        'supportedLangs': {
            'en': 'English',
            'sl': 'Slovenščina'
        },
        'getLang': function () {
            return lang;
        },

        'setLang': function (newLang) {
            lang = newLang;
            codeq.fire('langchange', {'lang': newLang});
        },

        'chooseTranslation': function (translations, language) {
            var tr, lang;
            if ((typeof translations !== 'object') || (translations === null)) return {};
            tr = translations[language || codeq.lang];
            if ((typeof tr === 'object') && (tr !== null)) return tr;
            // default fallback
            tr = translations['en'];
            if ((typeof tr === 'object') && (tr !== null)) return tr;
            // fallback to whatever is available
            for (lang in translations) {
                tr = translations[lang];
                if ((typeof tr === 'object') && (tr !== null)) return tr;
            }
            // all options were exhausted, we have nothing
            return {};
        },

        'escapeHtml': function (s) {
            return ('' + s).replace(regexpAmp, '&amp;').replace(regexpLt, '&lt;').replace(regexpGt, '&gt;');
        },

        /**
         * Returns the number of Unicode code points in the given string.
         *
         * @param s {string}
         * @returns {number}
         */
        'codePointCount': function (s) {
            var n = 0, i, code;
            if (typeof s !== 'string') {
                code = 'codePointCount(): argument not a string: type = ' + typeof s + ', is null = ' + (s === null);
                if ((typeof s === 'object') && (s !== null) && s.constructor) code += ', constructor = ' + s.constructor.name;
                codeq.log.error(code);
                return 0;
            }
            for (i = s.length - 1; i >= 0; i--) {
                try {
                    code = s.charCodeAt(i);
                }
                catch (e) {
                    codeq.log.error('Invocation of charCodeAt() failed at iteration #' + i + ': ' + e, e);
                    return 0;
                }
                if ((code >= 0xd800) && (code < 0xe000)) i++;
                n++;
            }
            return n;
        },

        'wait': function (promise) {
            jqDisabled.css(waitCssEnter);
            return promise.fin(function () {
                jqDisabled.css('display', 'none');
            });
        },

        'templator': function (str, templatePath, templateName) {
            var f, parts, i, subparts, subpart,
                src = [ 'var _result = [], echo = function (s) { _result.push(s); };\n' ],
                atoms, j, atom, debugPrefix, s, r, tokens, handler;

            if (!templateName) templateName = 'unknown template';
            debugPrefix = '[' + templateName + ']';
            if (!templatePath) templatePath = [];

            // remove comments
            parts = str.split('[%--'); // break on start-of-comment
            atoms = [ parts[0] ]; // first part is not a comment
            for (i = 1; i < parts.length; i++) { // iterate over start-of-comments
                atom = parts[i].split('--%]'); // break on end-of-comment
                if (atom.length > 1) { // if end-of-comment was encountered
                    atoms.push(atom[1]); // add whatever is trailing it
                    for (j = 2; j < atom.length; j++) { // re-add even dangling end-of-comments
                        atoms.push('--%]');
                        atoms.push(atom[j]);
                    }
                }
            }

            // start processing
            parts = atoms.join('').split('[%');

            if (parts[0].length > 0) src.push('_result.push("', stringToDef(cleanHtml(parts[0])), '");\n'); // the first part that doesn't begin with '[%'
            for (i = 1; i < parts.length; i++) { // for every part that begins with '[%'
                if (parts[i].slice(0, 2) === '--') { // a comment start
                    subparts = parts[i].split('--%]'); // split at comment end
                }
                else { // a start of a statement or of a value reference
                    subparts = parts[i].split('%]'); // there should be only one terminating '%]', find it
                    subpart = subparts[0].replace(regexpWhiteSpaceStart, '').replace(regexpWhiteSpaceEnd, ''); // trim the white space
                    if (subpart.length > 0) {
                        if (subpart[0] === '=') { // a value reference
                            s = subpart.slice(1);
                            r = regexpWhiteSpaceTrim.exec(s);
                            r = r && r[1] || s;
                            src.push('_result.push(typeof this.', r, ' === \'undefined\' ? \'', r, ' missing\' : this.', r, ');\n');
                        }
                        else if (subpart[0] === '@') { // a directive
                            tokens = tokenize(subpart.slice(1));
                            if (tokens.length === 0) {
                                codeq.log.error('An empty directive in ' + templateName);
                            }
                            else {
                                handler = directiveHandlers[tokens[0]];
                                if (!handler) {
                                    codeq.log.error('An unknown directive in ' + templateName + ': ' + tokens[0]);
                                }
                                else {
                                    handler(src, tokens, templatePath);
                                }
                            }
                        }
                        else { // javascript statement(s)
                            src.push(subpart, '\n');
                        }
                    }
                }
                if ((subparts.length > 1) && (subparts[1].length > 0)) { // there's a trailing text
                    src.push('_result.push("', stringToDef(cleanHtml(subparts[1])), '");\n');
                }
            }
            src.push('return _result.join("");');
//            if (_internalDoLog_) codeq.log.debug('createTemplate(): ' + debugPrefix + ' creating templating function:\nfunction(_components_) {\n' + src.join('') + '\n}\n=== Created from template: ===\n' + str);
            try {
                f = new Function(src.join('')); // create a function based on the given template
            }
            catch (e) {
                codeq.log.error('createTemplate(): ' + debugPrefix + ' Failed to instantiate template function: ' + e + '\nfunction() {\n' + src.join('') + '\n}\n=== Created from template: ===\n' + str, e);
                throw e;
            }

            return function (args) {
                var esc = codeq.escapeHtml,
                    escArgs = {},
                    key;
                if ((typeof args === 'object') && (args !== null)) {
                    for (key in args) {
                        if (!args.hasOwnProperty(key)) continue;
                        escArgs[key] = esc(args[key]);
                    }
                }
                try {
                    return f.apply(escArgs);
                }
                catch (e) {
                    codeq.log.error('Error evaluating template ' + templateName + ' function: ' + e + '\nfunction() {\n' + src.join('') + '\nCreated from template:\n' + str, e);
                    throw e;
                }
            };
        },

        // codeq event handling

        'fire': function (eventName, args) {
            queuedEvents.push({'name': eventName, 'args': args});
            fireEvents();
        },

        'on': function (eventName, callback) {
            var listeners = eventListeners[eventName],
                i;
            if (listeners) {
                for (i = listeners.length - 1; i >= 0; i--) {
                    if (listeners[i] === callback) return; // already registered
                }
            }
            else {
                listeners = [];
                eventListeners[eventName] = listeners;
            }
            listeners.push(callback);
        },

        'off': function (eventName, callback) {
            var listeners = eventListeners[eventName],
                i;
            if (listeners) {
                for (i = listeners.length - 1; i >= 0; i--) {
                    if (listeners[i] === callback) listeners.splice(i, 1);
                }
            }
        }
    };

    // ================================================================================
    // The boot sequence
    // ================================================================================

    var loadGuiTranslations = function () {
        var langs = codeq.availableLangs,
            loaders = [],
            loaderLangs = [],
            i, lang;
        for (i = langs.length - 1; i >= 0; i--) {
            lang = langs[i];
            loaders.push(codeq.comms.getGuiTranslation(lang));
            loaderLangs.push(lang);
        }
        return Q.all(loaders)
            .then(function (results) {
                // convert translations into something that the translation module can use
                var dictionary = {},
                    i, json, key, lang, translations;
                for (i = results.length - 1; i >= 0; i--) {
                    json = results[i];
                    lang = loaderLangs[i];
                    for (key in json) {
                        if (!json.hasOwnProperty(key)) continue;
                        translations = dictionary[key];
                        if (translations) translations[lang] = json[key];
                        else {
                            translations = {};
                            dictionary[key] = translations;
                            translations[lang] = json[key];
                        }
                    }
                }
                // ensure each key contains all translations
                for (key in dictionary) {
                    if (!dictionary.hasOwnProperty(key)) continue;
                    translations = dictionary[key];
                    for (i = langs.length - 1; i >= 0; i--) {
                        lang = langs[i];
                        if (!(lang in translations)) translations[lang] = "(Untranslated: " + lang + ")";
                    }
                }
                // register with the system
                codeq.tr.registerDictionary('gui', dictionary);
            });
    };

    $(document).ready(function () {
        // set the language
        var navigatorLang = navigator.language || navigator.browserLanguage, // language reported by browser
            lang = null, // the translation language that will be chosen
            key;
        if (typeof navigatorLang === 'string') {
            navigatorLang = navigatorLang.split('-')[0]; // truncate the language variant, in eg. en-US
        }
        else navigatorLang = 'en';
        for (key in codeq.supportedLangs) {
            if (!codeq.supportedLangs.hasOwnProperty(key)) continue;
            if (key === navigatorLang) lang = key; // we support the browser's language
            codeq.availableLangs.push(key);
        }

        // the boot chain: must be a sequence of .then() terminated with a .fail().done()
        loadGuiTranslations()
            .then(codeq.comms.getResourceTree)
            .then(function (resourceTree) {
                resources = resourceTree; // save the loaded resource tree to the internal variable

                codeq.fire('init'); // tell any interested modules that we are now initialized, perhaps they want to initialize too
                codeq.setLang(lang || 'en'); // initial language setting, this also translates the GUI
                // go to login
                codeq.globalStateMachine.transition('login');

                //For performance reasons, the Tooltip and Popover data-apis are opt-in, meaning you must initialize them yourself.
                $('[data-toggle="popover"]').popover()
            })
            .fail(function (e) {
                codeq.log.error('CodeQ failed to start: ' + e, e);
                alert('CodeQ failed to start: ' + e);
            })
            .done();
    });
})();