popup.html

<!--
Copyright (c) 2010 Jeremy Thomerson

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
-->
<style>
body {
    min-width: 457px;
    font-family: Verdana, Arial, Times New Roman, Helvetica;
}

p#message {
    width: 420px;
    font-size: 0.85em;
}

p#message pre {
    font-size: 1.0em;
}

h1 {
    font-size: 0.95em;
}

fieldset {
    border: 1px solid #091A6C;
    margin-top: 10px;
}

fieldset legend {
    border: 1px solid #091A6C;
    background-color: #B2BAD9;
    padding: 1px 12px;
    width: 200px;
}

input {
    border: 1px solid #B2BAD9;
}

input:focus {
    background-color: #EFEFEF;
    border: 1px solid #091A6C;
}

.field label {
    width: 200px;
    float: left;
}
</style>

<script type="text/javascript" src="jquery-1.3.2-min.js"> </script>
<script type="text/javascript" src="jquery.xml2json-min.js"> </script>
<script type="text/javascript" src="json2.js"> </script>
<script type="text/javascript" src="sha1-min.js"> </script>
<script>

if (console == undefined) {
    var console = new Object();
    console.debug = function(msg) {};
}

// html elements used in script:
var form = null;
var callFields = null;
var callSelector = null
var messageElem = null

// transient values:
var fieldSetAlreadyFocused = false;
var callParams = new Array();
var isRedirectCall = false;

function clearCallConfigFields() {
    callParams = new Array();
    clearElemChildren(callFields);
    fieldSetAlreadyFocused = false;
}
function clearElemChildren(elem) {
    if (elem.hasChildNodes()) {
        while (elem.childNodes.length >= 1) {
            elem.removeChild(elem.firstChild);
        }
    }
}

function addCallConfigField(fldName, fldDesc, defVal) {
    var div = document.createElement('div');
    var label = document.createElement('label');
    var input = document.createElement('input');
    div.className = 'field';
    label.htmlFor = fldName;
    label.appendChild(document.createTextNode(fldDesc));
    input.type = 'text';
    input.name = fldName;
    input.value = defVal;
    div.appendChild(label);
    div.appendChild(input);
    callParams.push(fldName);
    callFields.appendChild(div);
    if (fieldSetAlreadyFocused == false) {
        setTimeout(function() {
            input.focus();
        }, 100);
        fieldSetAlreadyFocused = true;
    }
}

function isValidCallSelected(selector) {
    return selector.value != '__NOCALL__';
}
function callChanged() {
    var selector = callSelector;
    if (!isValidCallSelected(selector)) {
        return false;
    }
    console.debug('new call selected: ' + selector.value);
    var version = form.apiVersion.value;
    clearCallConfigFields();
    isRedirectCall = false;
    switch(selector.value) {
        case 'getMeetings':
            addCallConfigField('random', 'Random value:', Math.floor(Math.random()*10000));
            break;
        case 'isMeetingRunning':
            addCallConfigField('meetingID', 'Meeting ID:', 'test123');
            if (version == '0.64') {
                addCallConfigField('meetingToken', 'Meeting Token:', '');
            }
            break;
        case 'create':
            addCallConfigField('meetingID', 'Meeting ID:', 'test123');
            if (version == '0.64') {
                addCallConfigField('meetingToken', 'Meeting Token:', '');
            }
            addCallConfigField('name', 'Meeting Name:', 'BBB Example Meeting');
            addCallConfigField('moderatorPW', 'Moderator Password:', '123456');
            addCallConfigField('attendeePW', 'Attendee Password:', '234567');
            break;
        case 'join':
            addCallConfigField('meetingID', 'Meeting ID:', 'test123');
            if (version == '0.64') {
                addCallConfigField('meetingToken', 'Meeting Token:', '');
            }
            addCallConfigField('password', 'Password:', '123456');
            addCallConfigField('fullName', 'Attendee Name:', 'Joe Host');
            if (version == '0.7') {
                addCallConfigField('userID', 'User ID:', 'joehost-123');
            }
            isRedirectCall = true;
            break;
        case 'getMeetingInfo':
            addCallConfigField('meetingID', 'Meeting ID:', 'test123');
            if (version == '0.64') {
                addCallConfigField('meetingToken', 'Meeting Token:', '');
            }
            addCallConfigField('password', 'Moderator Password:', '123456');
            break;
        case 'end':
            addCallConfigField('meetingID', 'Meeting ID:', 'test123');
            if (version == '0.64') {
                addCallConfigField('meetingToken', 'Meeting Token:', '');
            }
            addCallConfigField('password', 'Moderator Password:', '123456');
            break;
        default:
            clearCallConfigFields();
            showMessage('No configurable fields for this call [' + selector.value + ']');
            callSelector.focus();
            break;
    }

}

var savedFields = ['serverDomain', 'contextPath', 'securitySalt', 'apiVersion'];
var savedFieldsKey = 'serverDomain';

function saveValues() {
    console.debug('saveValues');
    
    var keyelem = eval('form.' + savedFieldsKey);
    var key = keyelem.value;
    console.debug('saving with key: ' + key);

    var toSave = {};
    for(var i = 0; i < savedFields.length; i++) {  
        console.debug('save field: ' + savedFields[i]);
        var elem = eval('form.' + savedFields[i]);
        console.debug('value: ' + elem.value);
        toSave[savedFields[i]] = elem.value;
    }

    localStorage[key] = JSON.stringify(toSave);
    localStorage['lastKey'] = key;
    console.debug('saved: ' + JSON.stringify(toSave));
}

function loadValuesWithKey(key) {
    var loadedValues = localStorage[key];
    console.debug('loaded: ' + loadedValues);
    if (loadedValues != undefined) {
        loadedValues = JSON.parse(loadedValues);
        for(var i = 0; i < savedFields.length; i++) {  
            console.debug('load field: ' + savedFields[i]);
            var elem = eval('form.' + savedFields[i]);
            console.debug('value: ' + elem.value);
            var loaded = loadedValues[savedFields[i]];
            if (loaded != undefined) {
                elem.value = loaded;
            }
        }
    }
}

function tryLoadingConfigForServer(server) {
    loadValuesWithKey(server);
    callChanged();
}

function configurePage() {
    form = document.getElementById('mainForm');
    callFields = document.getElementById('perCallFields');
    callSelector = document.getElementById('callSelector');
    messageElem = document.getElementById('message');
    loadValuesWithKey(localStorage['lastKey']);
    callSelector.focus();
}

function encodeQueryParams(params) {
    var ret = [];
    for (var d in params) {
        ret.push(encodeURIComponent(d) + "=" + encodeURIComponent(params[d]));
    }
    return ret.join("&");
}

function makeAPICall() {
    saveValues();
    showMessage('Making API call...');
    /*
    Example URLs (these don't have checksums):
    http://devbuild.bigbluebutton.org/bigbluebutton/api/create?meetingID=123456&name=Test&attendeePW=abc&moderatorPW=qwe
    http://devbuild.bigbluebutton.org/bigbluebutton/api/join?meetingID=123456&fullName=JT+Moderator&password=qwe
    http://devbuild.bigbluebutton.org/bigbluebutton/api/join?meetingID=123456&fullName=JT+Attendee&password=abc
    http://devbuild.bigbluebutton.org/bigbluebutton/api/isMeetingRunning?meetingID=123456
    http://devbuild.bigbluebutton.org/bigbluebutton/api/getMeetingInfo?meetingID=123456
    */
    var version = form.apiVersion.value;
    var domain = form.serverDomain.value;
    var salt = form.securitySalt.value;
    var context = form.contextPath.value;
    if (context.substr(context.length - 1) != '/') {
        context = context + '/';
    }
    var callName = form.callSelector.value;

    var params = new Array();
    for (var i = 0; i < callParams.length; i++) {
        var elem = eval('form.' + callParams[i]);
        params[callParams[i]] = elem.value;
    }

    if (containsValue(params['meetingID'])) {
        params = removeKey(params, 'meetingToken');
    } else {
        params = removeKey(params, 'meetingID');
    }

    if (containsValue(salt)) {
        params['checksum'] = createChecksum(version, callName, salt, encodeQueryParams(params));
    }

    var url = "http://" + domain + context + callName + "?" + encodeQueryParams(params);
	console.debug('Call URL: ' + url);
    
    if (isRedirectCall) {
        showMessage('Redirect to: ' + url);
        chrome.tabs.create({ url: url });
    } else {
        var xhr = new XMLHttpRequest();
        xhr.onreadystatechange = function() {
            apiCallReadyStateChange(xhr, url);
        };
        xhr.open("GET", url, true);
        xhr.send();
    }

    return false;
}

function createChecksum(version, callName, salt, queryString) {
    if (version == '0.64') {
        return hex_sha1(queryString + salt);
    }
    return hex_sha1(callName + queryString + salt);
}

function containsValue(val) {
    return val != null && val != '';
}

function removeKey(arr, key) {
    var tmpArray = new Array();
    for(var i in arr) {
        if(i != key) { tmpArray[i] = arr[i]; }
    }
    return tmpArray;
}

function apiCallReadyStateChange(xhr, url) {
    if (xhr.readyState == 4) {
        if (xhr.status == 200 || xhr.status == 0) {
            console.debug('success');
            console.debug("xhr.status: " + xhr.status + ' [' + xhr.statusText + ']');
            console.debug("Response Text:\n" + xhr.responseText);
        } else {
            showMessage('There was a problem calling the API: ' + xhr.status + ' [' + xhr.statusText + ']<br />URL was: ' + url + '<br />');
            return;
        }

        var response = xhr.responseText;
        if (response == undefined || response == null) {
	        showMessage('error - response is undefined');
	        return;
        }

        showMessage('Called URL:<br /><a onclick="chrome.tabs.create({ url: ' + url + ' });">' + url + '</a><br /><br />Response XML:', response);
        var resp = $.xml2json(response);
        var status = resp.returncode;
        var msg = resp.message;

        if('SUCCESS' == status) {
        } else{ 
	        console.debug('error in json response: ' + msg);
        }
    }
}

function showMessage(msg, xml) {
    clearElemChildren(messageElem);
    messageElem.innerHTML = msg;
    if (xml != undefined && xml != null) {
        var pre = document.createElement('pre');
        pre.innerHTML = xml.replace(/></g,">\n<").replace(/</g,"&lt;").replace(/>/g,"&gt;");
        messageElem.appendChild(pre);
    }
}

</script>

<body onload="configurePage();">
<div>
    <h1>Test a BigBlueButton API Call</h1>
    <p id="message"></p>
    <form id="mainForm" action="#" method="get">
        <div class="field">
            <label for="callSelector">API Call:</label>
            <select id="callSelector" name="callSelector" onchange="callChanged()" onblur="callChanged()">
                <option value="__NOCALL__">-- Choose One --</option>
                <option value="getMeetings">getMeetings</option>
                <option value="create">create</option>
                <option value="join">join</option>
                <option value="isMeetingRunning">isMeetingRunning</option>
                <option value="getMeetingInfo">getMeetingInfo</option>
                <option value="end">end</option>
            </select>
        </div>
        <fieldset id="configFields">
            <legend>Call Configuration</legend>
            <div id="perCallFields">
            </div>
        </fieldset>
        <fieldset id="serverFields">
            <legend>Server Configuration</legend>
            <div class="field">
                <label for="serverDomain">Server:</label>
                <input type="text" name="serverDomain" onchange="tryLoadingConfigForServer(this.value)" onblur="tryLoadingConfigForServer(this.value)" value="devbuild.bigbluebutton.org" />
            </div>
            <div class="field">
                <label for="apiVersion">API Version:</label>
                <select id="apiVersion" name="apiVersion" onchange="callChanged()" onblur="callChanged()">
                    <option value="0.64">0.64</option>
                    <option value="0.7">0.7</option>
                </select>
            </div>
            <div class="field">
                <label for="contextPath">Context Path:</label>
                <input type="text" name="contextPath" value="/bigbluebutton/api" />
            </div>
            <div class="field">
                <label for="securitySalt">Security Salt:</label>
                <input type="text" name="securitySalt" value="639259d4-9dd8-4b25-bf01-95f9567eaf4b" />
            </div>
        </fieldset>
        <input type="button" onclick="makeAPICall();" value="Make Call" />
    </form>
</div>
</body>