ComunicWeb/assets/js/common/api.js

/**
 * API main functions
 * 
 * @author Pierre HUBERT
 */

/**
 * Make an API request
 * 
 * @param {String} apiURI The URI to call in the API
 * @param {Object} params The params to include in request
 * @param {Boolean} requireLoginTokens Specify if login tokens are required or not
 * @param {Function} nextAction What to do next
 */
ComunicWeb.common.api.makeAPIrequest = function(apiURI, params, requireLoginTokens, nextAction){
    //Prepare the request URL
    var requestURL = ComunicWeb.__config.apiURL + apiURI;
    
    //Add API service tokens
    params.serviceName = ComunicWeb.__config.apiServiceName;
    params.serviceToken = ComunicWeb.__config.apiServiceToken;

    //Add login tokens to params if required
    if(requireLoginTokens){
        //Get login tokens
        tokens = ComunicWeb.user.loginTokens.getLoginTokens();

        if(tokens){
            //Add tokens
            params.userToken1 = tokens.token1;
            params.userToken2 = tokens.token2;
        }

    }

    //Prepare data to send in request
    var count = 0;
    var datas = "";
    for(paramName in params){
        //We add a "&" if it isn't the first param
        if(count != 0)
            datas += "&";

        //We add field value
        datas += encodeURIComponent(paramName) + "=" + encodeURIComponent(params[paramName]);

        count++; //Increment counter
    }     

    //Create request
    var apiXHR = new XMLHttpRequest();
    apiXHR.open("POST", requestURL);

    //Prepare request response
    apiXHR.onreadystatechange = function(){
        //We continue only if request is terminated
        if(apiXHR.readyState == 4){

            //Check if response code is 0
            if(apiXHR.status == 0){
                //An error occured
                ComunicWeb.common.network.setStatus(false);
            }
            else{
                //It is a success
                ComunicWeb.common.network.setStatus(true);
            }

            //Check if response is empty
            if(apiXHR.responseText.length == ""){
                //Auto-create a response for empty responses (to avoid Javascript errors and allow the script to continue to execute)
                result = {
                    error : {
                        code: 0,
                        message: "Empty response",
                    },
                };
            }
            else
                //Prepare result
                var result = JSON.parse(apiXHR.responseText);

            //We check if we got any error
            if(result.error){
                //Log error
                ComunicWeb.debug.logMessage("Got an error in a XHR request! \n Request URL: "+requestURL+" \n Response : "+apiXHR.responseText);
            }

            //We can do the next step
            if(nextAction)
                nextAction(result);
        }
    }

    //Set request headers
    apiXHR.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");

    //Submit request
    apiXHR.send(datas);
};