author | ivanl |
Tue, 21 Jul 2009 12:16:25 +0100 | |
changeset 10 | 07ac2f6a36a9 |
parent 6 | 5e0dece09f96 |
child 13 | 3a1db8573f1e |
permissions | -rw-r--r-- |
0 | 1 |
/////////////////////////////////////////////////////////////////////////////// |
2 |
// The FeedUpdateBroker class implements a simple RSS fetcher and parser. |
|
3 |
// Adapted from WRTKit RssReader example |
|
4 |
||
5 |
// Constructor. |
|
6 |
function FeedUpdateBroker() { |
|
10
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
7 |
this.escapeLtGt=true; |
0 | 8 |
this.httpReq = null; |
9 |
this.feedAddress = null; |
|
10 |
this.callback = null; |
|
11 |
this.ignoreContent = false; |
|
12 |
this.cancelled = false; |
|
13 |
this.responseParser = this.handleRssResponse; |
|
14 |
this.startFromItem = 0; |
|
15 |
this.maxItems = 0; |
|
16 |
} |
|
17 |
||
18 |
// Fetches a feed from the specified URL and calls the callback when the feed |
|
19 |
// has been fetched and parsed, or if the process results in an error. |
|
20 |
FeedUpdateBroker.prototype.doFetchFeed = function(){ |
|
21 |
// create new XML HTTP request |
|
22 |
this.httpReq = new Ajax(); |
|
23 |
||
24 |
// set callback |
|
25 |
var self = this; |
|
26 |
this.httpReq.onreadystatechange = function() { self.readyStateChanged(); }; |
|
27 |
||
28 |
// initiate the request |
|
3 | 29 |
this.httpReq.open("GET", nocache(this.feedAddress), true); |
0 | 30 |
this.httpReq.send(null); |
31 |
} |
|
32 |
||
33 |
// has been fetched and parsed, or if the process results in an error. |
|
34 |
FeedUpdateBroker.prototype.fetchFeed = function(feedURL, callback) { |
|
35 |
// remember callback |
|
36 |
this.callback = callback; |
|
37 |
this.feedAddress = feedURL; |
|
38 |
this.doFetchFeed(); |
|
39 |
} |
|
40 |
||
41 |
// Callback for ready-state change events in the XML HTTP request. |
|
42 |
FeedUpdateBroker.prototype.readyStateChanged = function() { |
|
43 |
// complete request? |
|
44 |
if (this.httpReq.readyState == 4) { |
|
45 |
// attempt to get response status |
|
46 |
var responseStatus = null; |
|
47 |
try { |
|
48 |
responseStatus = this.httpReq.status; |
|
49 |
} catch (noStatusException) {} |
|
50 |
||
51 |
// are we being prompted for login? |
|
52 |
var text = this.httpReq.responseText; |
|
53 |
if ( isLoginPrompt (text) ) { |
|
54 |
var self = this; |
|
55 |
login(function(){self.doFetchFeed();}); |
|
56 |
return; |
|
57 |
} |
|
58 |
||
59 |
// handle the response and call the registered callback object |
|
60 |
var response = this.httpReq.responseXML; |
|
61 |
if (response == null) { |
|
62 |
// if the content type is not set correctly, we get the response as text |
|
63 |
var xmlparser = new DOMParser(); |
|
64 |
response = xmlparser.parseFromString(this.httpReq.responseText, "text/xml"); |
|
65 |
} |
|
66 |
this.callback.feedUpdateCompleted(this.handleResponse(responseStatus, response)); |
|
67 |
} |
|
68 |
} |
|
69 |
||
70 |
// Handles a completed response. |
|
71 |
FeedUpdateBroker.prototype.handleResponse = function(responseStatus, xmlDoc){ |
|
72 |
if (this.responseParser == null) { |
|
73 |
return this.handleRssResponse(responseStatus, xmlDoc); |
|
74 |
} |
|
75 |
else { |
|
76 |
return this.responseParser.call(this, this, responseStatus, xmlDoc); |
|
77 |
} |
|
78 |
} |
|
79 |
||
80 |
||
81 |
FeedUpdateBroker.prototype.handleRssResponse = function(broker, responseStatus, xmlDoc){ |
|
82 |
if ( this.cancelled ) { |
|
83 |
return { status: "cancelled" }; |
|
84 |
} |
|
85 |
if (responseStatus == 200 && xmlDoc != null) { |
|
86 |
// node ref for iterating |
|
87 |
var node; |
|
88 |
||
89 |
// get last modified time - default to current time |
|
90 |
var lastModified = new Date().getTime(); |
|
91 |
var channelElements = xmlDoc.getElementsByTagName("channel"); |
|
92 |
if (channelElements.length > 0) { |
|
93 |
node = channelElements[0].firstChild; |
|
94 |
while (node != null) { |
|
95 |
if (node.nodeType == Node.ELEMENT_NODE) { |
|
96 |
if (node.nodeName == "pubDate" || |
|
97 |
node.nodeName == "lastBuildDate" || |
|
98 |
node.nodeName == "dc:date") { |
|
10
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
99 |
lastModified = getTextOfNode(node, this.escapeLtGt); |
0 | 100 |
break; |
101 |
} |
|
102 |
} |
|
103 |
node = node.nextSibling; |
|
104 |
} |
|
105 |
} |
|
106 |
||
107 |
// init feed items array |
|
108 |
var items = []; |
|
109 |
||
110 |
// we got the feed XML so now we'll parse it |
|
111 |
var itemElements = xmlDoc.getElementsByTagName("item"); |
|
112 |
||
113 |
for (var i = this.startFromItem; i < itemElements.length; i++) { |
|
114 |
if ( this.maxItems > 0 && this.maxItems < i ) { |
|
115 |
break; |
|
116 |
} |
|
117 |
// iterate through child nodes of this item and gather |
|
118 |
// all the data we need for a feed item |
|
119 |
var title = null; |
|
120 |
var date = null; |
|
121 |
var description = null; |
|
122 |
var url = null; |
|
123 |
var author = null; |
|
124 |
node = itemElements[i].firstChild; |
|
125 |
while (node != null) { |
|
126 |
if (node.nodeType == Node.ELEMENT_NODE) { |
|
127 |
if (node.nodeName == "title") { |
|
128 |
// item title |
|
10
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
129 |
title = getTextOfNode(node, this.escapeLtGt); |
0 | 130 |
} else if (node.nodeName == "pubDate" || node.nodeName == "dc:date") { |
131 |
// item publishing date |
|
10
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
132 |
date = getTextOfNode(node, this.escapeLtGt); |
0 | 133 |
} else if (node.nodeName == "description" && !this.ignoreContent ) { |
134 |
// item description |
|
10
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
135 |
description = getTextOfNode(node, this.escapeLtGt); |
0 | 136 |
} else if (node.nodeName == "link") { |
137 |
// link URL |
|
10
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
138 |
url = getTextOfNode(node, this.escapeLtGt); |
0 | 139 |
} else if (node.nodeName == "dc:creator" ) { |
10
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
140 |
author = getTextOfNode(node, this.escapeLtGt); |
0 | 141 |
} |
142 |
} |
|
143 |
node = node.nextSibling; |
|
144 |
} |
|
145 |
||
146 |
// create the item and add to the items array |
|
147 |
items.push({ title: title, date: date, description: description, url: url, author: author }); |
|
148 |
} |
|
149 |
||
150 |
// update was completed successfully |
|
151 |
return { status: "ok", lastModified: lastModified, items: items }; |
|
152 |
} else { |
|
153 |
// update failed |
|
154 |
return { status: "error" }; |
|
155 |
} |
|
156 |
} |
|
157 |
||
158 |
// Returns the text of a node. |
|
10
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
159 |
function getTextOfNode(node, escapeLtGt) { |
0 | 160 |
var buf = ""; |
6 | 161 |
// iterate through all child elements and collect all text to the buffer |
162 |
var child = node.firstChild; |
|
163 |
while (child != null) { |
|
164 |
if (child.nodeType == Node.TEXT_NODE || child.nodeType == Node.CDATA_SECTION_NODE) { |
|
165 |
// append text to buffer |
|
166 |
if (buf != "") { |
|
167 |
buf += " "; |
|
168 |
} |
|
10
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
169 |
buf += child.textContent; |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
170 |
// if (escapeLtGt) { |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
171 |
// buf += doEscapeLtGt(child.nodeValue); |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
172 |
// } else { |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
173 |
// buf += child.nodeValue; |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
174 |
// } |
6 | 175 |
} |
176 |
child = child.nextSibling; |
|
177 |
} |
|
4 | 178 |
|
10
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
179 |
return buf; |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
180 |
// // strip all tags from the buffer |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
181 |
// var strippedBuf = ""; |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
182 |
// var textStartPos = -1; |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
183 |
// var tagBalance = 0; |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
184 |
// |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
185 |
// var pos; |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
186 |
// // iterate through the text and append all text to the stripped buffer |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
187 |
// // that is at a tag balance of 0 |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
188 |
// for (pos = 0; pos < buf.length; pos++) { |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
189 |
// var c = buf.charAt(pos); |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
190 |
// if (c == '<') { |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
191 |
// // entering a tag |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
192 |
// if (tagBalance == 0 && textStartPos != -1) { |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
193 |
// // everything up to here was valid text |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
194 |
// strippedBuf += buf.substring(textStartPos, pos); |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
195 |
// textStartPos = -1; |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
196 |
// } |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
197 |
// tagBalance++; |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
198 |
// } else if (c == '>') { |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
199 |
// // leaving a tag |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
200 |
// tagBalance--; |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
201 |
// textStartPos = -1; |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
202 |
// } else if (tagBalance == 0 && textStartPos == -1) { |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
203 |
// // first char of text |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
204 |
// textStartPos = pos; |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
205 |
// } |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
206 |
// } |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
207 |
// |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
208 |
// // add remaining text - if any |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
209 |
// if (tagBalance == 0 && textStartPos != -1) { |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
210 |
// strippedBuf += buf.substring(textStartPos, pos); |
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
211 |
// } |
0 | 212 |
|
10
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
213 |
// return strippedBuf; |
0 | 214 |
} |
215 |
||
216 |
FeedUpdateBroker.prototype.cancel = function() { |
|
217 |
this.cancelled = true; |
|
218 |
this.httpReq.abort(); |
|
219 |
} |
|
4 | 220 |
|
10
07ac2f6a36a9
1.0rc10 Fixes annoyances and buglets in reading forums and blog.
ivanl
parents:
6
diff
changeset
|
221 |
function doEscapeLtGt(text){ |
4 | 222 |
var lt = "<"; |
223 |
var gt = ">"; |
|
224 |
return text.replace(/</g, lt).replace(/>/g, gt); |
|
225 |
} |