YUI Library JavaScript DHTML

  1. Home
  2. JavaScript DHTML
  3. YUI Library
  4. Getting a Script Node with JSON Data from a Web Service




    
Getting a Script Node with JSON Data from a Web Service

/*margin and padding on body element
  can introduce errors in determining
  element position and are not recommended;
  we turn them off as a foundation for YUI
  CSS treatments. */
body {
  margin:0;
  padding:0;
}








#container ol {
  /*bringing lists on to the page with breathing room */
  margin-left:2em !important;
}
#container ol li {
  /*giving OL's LIs generated numbers*/
  list-style: decimal outside !important;  
}
#container h3 {
  margin-top: 1em;
}




Getting a Script Node with JSON Data from a Web Service



  

This example employs the YUI Get Utility in a simple use case: retrieving JSON data from a cross-domain web service. While this is a relatively common usage, it's important to understand the security ramifications of this technique. Scripts loaded via the Get Utility (or any other "script node" solution) execute immediately once they are loaded. If you do not fully control (or fully trust) the script's source, this is not a safe technique and it can put the security of your users' data at risk. (For more information on the dangers of cross-site scripting [XSS] exploits, check out the Wikipedia entry on this subject.)


Here, we will use a trusted Yahoo! Search web service called Site Explorer to return a list of inbound links for a given URL. The principal difference between this example and similar examples using YUI Connection Manager is that this technique does not require a server-side proxy. The browser connects directly to the third-party web service without bouncing through a proxy page as is required when using the XMLHttpRequest object (on which Connection Manager relies).


      



    
    
        Site URL: 
        
        
        
    
        
    
    
    
        
        
    



//create a namespace for this example:
YAHOO.namespace("example.SiteExplorer");
//This example uses the "Module Pattern"; a full explanation of 
//this pattern can be found on yuiblog:
// http://yuiblog.com/blog/2007/06/12/module-pattern
YAHOO.example.SiteExplorer = function() {
    //set up some shortcuts in case our typing fingers
    //get lazy:
    var Event = YAHOO.util.Event,
        Dom = YAHOO.util.Dom,
        Button = YAHOO.widget.Button,
        Get = YAHOO.util.Get,
        elResults = Dom.get("results"),
        tIds = {},
        loading = false,
        current = null;
        
    // We use the Get Utility's success handler in conjunction with
    // the web service callback in order to detect bad responses 
    // from the web service.
    var onSiteExplorerSuccess = function(o) {
        // stop blocking requests
        loading = false;
        // A success response means the script node is inserted.  However, the
        // utility is unable to detect whether or not the content of the script
        // node is correct, or even if there was a bad response (like a 404
        // error).  To get around this, we use the web service callback to
        // verify that the script contents was correct.
        if (o.tId in tIds) {
YAHOO.log("The Get Utility has fired the success handler indicating that the " +
          "requested script has loaded and is ready for use.", "info", "example");
        } else {
YAHOO.log("The Get utility has fired onSuccess but the webservice callback did not " +
          "fire.  We could retry the transaction here, or notify the user of the " +
          "failure.", "info", "example");
        }
    }
    var onSiteExplorerFailure = function(o) {
YAHOO.log("The Get Utility failed.", "info", "example");
    }
    
    //function to retrieve data from Yahoo! Site Explorer web service --
    // http://developer.yahoo.com/search/siteexplorer/V1/inlinkData.html
    var getSiteExplorerData = function() {
        YAHOO.log("Button clicked; getSiteExplorerData firing.", "info", "example");
        // block multiple requests
        if (loading) {
            return;
        }
        loading = true;
        
        //Load the transitional state of the results section:
        elResults.innerHTML = "

Retrieving incoming links for " +
            Dom.get("searchString").value + ":

" +
            "            "alt='Please wait...'>";
        
        //prepare the URL for the Yahoo Site Explorer API:
        var sURL = "http://search.yahooapis.com/SiteExplorerService/V1/inlinkData?" +
            "appid=3wEDxLHV34HvAU2lMnI51S4Qra5m.baugqoSv4gcRllqqVZm3UrMDZWToMivf5BJ3Mom" +
            "&results=20&output=json&omit_inlinks=domain" +
            "&callback=YAHOO.example.SiteExplorer.callback" +
            "&query=" + encodeURIComponent(Dom.get("searchString").value);
        
        //This simple line is the call to the Get Utility; we pass
        //in the URL and the configuration object, which in this case
        //consists merely of our success and failure callbacks:
        var transactionObj = Get.script(sURL, {
            onSuccess: onSiteExplorerSuccess,
            onFailure: onSiteExplorerFailure,
            scope    : this
        });
        
        //The script method returns a single-field object containing the
        //tranaction id:
        YAHOO.log("Get Utility transaction started; transaction object: " + YAHOO.lang.dump(transactionObj), "info", "example");
        // keep track of the current transaction id.  The transaction will be
        // considered complete only if the web service callback is executed.
        current = transactionObj.tId; 
    }
    return {
        init: function() {
                
            //suppress default form behavior
            Event.on("siteExplorer", "submit", function(e) {
                Event.preventDefault(e);
                getSiteExplorerData();
            }, this, true);
        
            //instantiate Button:
            var oButton = new Button("getSiteExplorerData");
            YAHOO.log("Button instantiated.", "info", "example");
        },
        callback: function(results) {
            YAHOO.log("Web service returned data to YAHOO.example.SiteExplorer.callback; beginning to process.", "info", "example");
            // Mark the transaction as complete.  This will be checked by the onSuccess
            // handler to determine if the transaction really succeeded.
            tIds[current] = true;
            
            //work with the returned data to extract meaningful fields:
            var aResults = results.ResultSet.Result;
            var totalLinks = results.ResultSet.totalResultsAvailable;
            var returnedLinkCount = results.ResultSet.totalResultsReturned;
            
            if(aResults) {//there are inbound links; process and display them:
            
                //write header and open list of inbound links:          
                var html = "

There are " +
                    totalLinks + 
                    " inbound links for this page; here are the first " + 
                    returnedLinkCount +
                    ":

    ";
                    
                    //process list of inbound links:
                    for (var i=0; i < aResults.length; i++) {
                        html += "
  1. " +
                            aResults[i].Title +
                            ":                             aResults[i].Url +
                            "'>" + aResults[i].Url +
                            "
    2. ";
                    }
                    
                    //close list of inbound links
                    html += "
";
                
            } else {//no inbound links exist for this page:
            
                var html = "

There are no inbound links for the page specified.                
            }
            
            //insert string into DOM:
            elResults.innerHTML = html;
        }
    }
}();
//Initialize the example when the DOM is completely loaded:
YAHOO.util.Event.onDOMReady(
    YAHOO.example.SiteExplorer.init, 
    YAHOO.example.SiteExplorer,         //pass this object to init and...
    true);                              //...run init in the passed object's
                                        //scope





   
  
yui_2.7.0b.zip( 4,431 k)