Getting a Script Node with JSON Data from a Web Service
<!--
Software License Agreement (BSD License)
Copyright (c) 2009, Yahoo! Inc.
All rights reserved.
Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the
following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of Yahoo! Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of Yahoo! Inc.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Sources of Intellectual Property Included in the YUI Library
YUI is issued by Yahoo! under the BSD license above. Below is a list of certain publicly available software that is the source of intellectual property in YUI, along with the licensing terms that pertain to thosesources of IP. This list is for informational purposes only and is not intended to represent an exhaustive list of third party contributions to the YUI.
* Douglas Crockford's JSON parsing and stringifying methods: In the JSON Utility, Douglas Crockford's JSON parsing and stringifying methods are adapted from work published at JSON.org. The adapted work is in the public domain.
* Robert Penner's animation-easing algorithms: In the Animation Utility, YUI makes use of Robert Penner's algorithms for easing.
* Geoff Stearns's SWFObject: In the Charts Control and the Uploader versions through 2.7.0, YUI makes use of Geoff Stearns's SWFObject v1.5 for Flash Player detection and embedding. More information on SWFObject can be found here (http://blog.deconcept.com/swfobject/). SWFObject is (c) 2007 Geoff Stearns and is released under the MIT License (http://www.opensource.org/licenses/mit-license.php).
* Diego Perini's IEContentLoaded technique: The Event Utility employs a technique developed by Diego Perini and licensed under GPL. YUI's use of this technique is included under our BSD license with the author's permission.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Getting a Script Node with JSON Data from a Web Service</title>
<style type="text/css">
/*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;
}
</style>
<link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/fonts/fonts-min.css" />
<link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/button/assets/skins/sam/button.css" />
<script type="text/javascript" src="yui_2.7.0b-lib/yuiloader-dom-event/yuiloader-dom-event.js"></script>
<script type="text/javascript" src="yui_2.7.0b-lib/element/element-min.js"></script>
<script type="text/javascript" src="yui_2.7.0b-lib/button/button-min.js"></script>
<!--begin custom header content for this example-->
<style type="text/css">
#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;
}
</style>
<!--end custom header content for this example-->
</head>
<body class=" yui-skin-sam">
<h1>Getting a Script Node with JSON Data from a Web Service</h1>
<div class="exampleIntro">
<p>This example employs the <a href="http://developer.yahoo.com/yui/get/">YUI Get Utility</a> 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, <a href="http://en.wikipedia.org/wiki/Cross-site_scripting">check out the Wikipedia entry on this subject</a>.)</p>
<p>Here, we will use a trusted Yahoo! Search web service called <a href="http://developer.yahoo.com/search/siteexplorer/V1/inlinkData.html">Site Explorer</a> to return a list of inbound links for a given URL. The principal difference between this example and similar examples using <a href="http://developer.yahoo.com/yui/connection/">YUI Connection Manager</a> 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).</p>
</div>
<!--BEGIN SOURCE CODE FOR EXAMPLE -->
<div id="container">
<!--Use a real form that works without JavaScript:-->
<form method="GET" action="http://siteexplorer.search.yahoo.com/advsearch" id="siteExplorer">
<label for="searchString">Site URL:</label> <input type="text" name="p" id="searchString" value="http://developer.yahoo.com/yui" size="40">
<input type="hidden" name="bwm" value="i">
<input type="hidden" name="bwms" value="p">
<input type="submit" id="getSiteExplorerData" value="Click here to get JSON data.">
</form>
<div id="results">
<!--JSON output will be written to the DOM here-->
</div>
</div>
<script type="text/javascript">
//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 = "<h3>Retrieving incoming links for " +
Dom.get("searchString").value + ":</h3>" +
"<img src='http://l.yimg.com/us.yimg.com/i/nt/ic/ut/bsc/busybar_1.gif' " +
"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 = "<h3>There are " +
totalLinks +
" inbound links for this page; here are the first " +
returnedLinkCount +
":</h3><ol>";
//process list of inbound links:
for (var i=0; i < aResults.length; i++) {
html += "<li><strong>" +
aResults[i].Title +
":</strong> <a href='" +
aResults[i].Url +
"'>" + aResults[i].Url +
"</a></li>";
}
//close list of inbound links
html += "</ol>";
} else {//no inbound links exist for this page:
var html = "<h3>There are no inbound links for the page specified.</h3";
}
//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
</script>
<!--END SOURCE CODE FOR EXAMPLE -->
</body>
</html>
<!-- presentbright.corp.yahoo.com uncompressed/chunked Thu Feb 19 10:53:15 PST 2009 -->
yui_2.7.0b.zip( 4,431 k)Related examples in the same category