1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
|
require 'cgi'
require 'rexml/document'
require 'time'
require 'feedparser/textconverters'
require 'feedparser/rexml_patch'
require 'feedparser/text-output'
require 'feedparser/version'
require 'base64'
require 'magic'
require 'uri'
module FeedParser
class UnknownFeedTypeException < RuntimeError
end
def self.recode(str)
encoding = nil
begin
encoding = Magic.guess_string_mime_encoding(str)
rescue => e
raise unless e.class.to_s =~ /\AMagic::(?:Exception|Error)\z/
# this happens when magic does not find any content at all, e.g. with
# strings that contain only whitespace. In these case it *should* be safe
# to assume UTF-8
encoding = Encoding::UTF_8
end
if encoding == 'unknown-8bit'
# find first substring with a valid encoding that is not us-ascii
length = 1 # has to start at 1, magic requires at least 2 bytes
while length < str.length && ['us-ascii', 'unknown-8bit'].include?(encoding)
encoding = Magic.guess_string_mime_encoding(str[0..length])
length = length + 1
end
# need to remove iso-8859-1 control characters
if encoding == 'iso-8859-1'
str = str.bytes.select { |c| c < 128 || c > 159 }.map(&:chr).join
end
end
str.force_encoding(encoding)
str = str.chars.select { |c| c.valid_encoding? }.join
str.encode('UTF-8', invalid: :replace, undef: :replace, replace: '?')
end
# an RSS/Atom feed
class Feed
attr_reader :type, :title, :link, :description, :creator, :encoding, :items
# REXML::Element for this feed.
attr_reader :xml
# parse str to build a Feed
def initialize(str = nil, uri = nil)
parse(str) if str
parse_origin(uri) if uri
end
# Determines all the fields using a string containing an
# XML document
def parse(str)
str = FeedParser.recode(str)
# Dirty hack: some feeds contain the & char. It must be changed to &
str.gsub!(/&(\s+)/, '&\1')
doc = REXML::Document.new(str)
@xml = doc.root
# get feed info
@encoding = doc.encoding
@title,@link,@description,@creator = nil
@title = ""
@items = []
if doc.root.elements['channel'] || doc.root.elements['rss:channel']
@type = "rss"
# We have a RSS feed!
# Title
if (e = doc.root.elements['channel/title'] ||
doc.root.elements['rss:channel/rss:title']) && e.text
@title = e.text.unescape_html.toUTF8(@encoding).rmWhiteSpace!
end
# Link
if (e = doc.root.elements['channel/link'] ||
doc.root.elements['rss:channel/rss:link']) && e.text
@link = e.text.rmWhiteSpace!
end
# Description
if (e = doc.root.elements['channel/description'] ||
doc.root.elements['rss:channel/rss:description']) && e.text
@description = e.text.toUTF8(@encoding).rmWhiteSpace!
end
# Creator
if ((e = doc.root.elements['channel/dc:creator']) && e.text) ||
((e = doc.root.elements['channel/author'] ||
doc.root.elements['rss:channel/rss:author']) && e.text)
@creator = e.text.unescape_html.toUTF8(@encoding).rmWhiteSpace!
end
# Items
if doc.root.elements['channel/item']
query = 'channel/item'
elsif doc.root.elements['item']
query = 'item'
elsif doc.root.elements['rss:channel/rss:item']
query = 'rss:channel/rss:item'
else
query = 'rss:item'
end
doc.root.each_element(query) { |e| @items << RSSItem::new(e, self) }
elsif doc.root.elements['/feed']
# We have an ATOM feed!
@type = "atom"
# Title
if (e = doc.root.elements['/feed/title']) && e.text
@title = e.text.unescape_html.toUTF8(@encoding).rmWhiteSpace!
end
# Link
doc.root.each_element('/feed/link') do |e|
if e.attribute('type') and (
e.attribute('type').value == 'text/html' or
e.attribute('type').value == 'application/xhtml' or
e.attribute('type').value == 'application/xhtml+xml')
if (h = e.attribute('href')) && h
@link = h.value.rmWhiteSpace!
end
end
end
# Description
if e = doc.root.elements['/feed/info']
e = e.elements['div'] || e
@description = e.to_s.toUTF8(@encoding).rmWhiteSpace!
end
# Items
doc.root.each_element('/feed/entry') do |e|
@items << AtomItem::new(e, self)
end
else
raise UnknownFeedTypeException::new
end
end
def to_s(localtime = true)
s = ''
s += "Type: #{@type}\n"
s += "Encoding: #{@encoding}\n"
s += "Title: #{@title}\n"
s += "Link: #{link}\n"
s += "Description: #{@description}\n"
s += "Creator: #{@creator}\n"
s += "\n"
@items.each { |i| s += i.to_s(localtime) }
s
end
def parse_origin(uri)
uri = URI.parse(uri)
if uri.hostname && uri.scheme
@origin = "#{uri.scheme}://#{uri.hostname}"
end
end
attr_reader :origin
end
# an Item from a feed
class FeedItem
attr_accessor :title, :content, :date, :creators, :subject,
:cacheditem, :links
# The item's categories/tags. An array of strings.
attr_accessor :categories
# The item's enclosures childs. An array of (url, length, type) triplets.
attr_accessor :enclosures
attr_reader :feed
# REXML::Element for this item
attr_reader :xml
def initialize(item = nil, feed = nil)
@xml = item
@feed = feed
@title, @link, @content, @date, @subject = nil
@links = []
@creators = []
@categories = []
@enclosures = []
@title = ""
parse(item) if item
end
def parse(item)
raise "parse() should be implemented by subclasses!"
end
def creator
case @creators.length
when 0
return nil
when 1
return creators[0]
else
sorted_creators = creators.sort
return sorted_creators[0...-1].join(", ") + " and " + sorted_creators[-1]
end
end
def to_s(localtime = true)
s = "--------------------------------\n" +
"Title: #{@title}\nLink: #{link}\n"
if localtime or @date.nil?
s += "Date: #{@date.to_s}\n"
else
s += "Date: #{@date.getutc.to_s}\n"
end
s += "Creator: #{creator}\n" +
"Subject: #{@subject}\n"
if defined?(@categories) and @categories.length > 0
s += "Filed under: " + @categories.join(', ') + "\n"
end
s += "Content:\n#{content}\n"
if defined?(@enclosures) and @enclosures.length > 0
s2 = "Enclosures:\n"
@enclosures.each do |e|
s2 += e.join(' ') + "\n"
end
s += s2
end
return s
end
attr_writer :link
def link
if @link
begin
uri = URI.parse(@link)
rescue URI::InvalidURIError
return @link
end
if uri.hostname && uri.scheme
@link
elsif feed && feed.origin
[feed.origin, @link].compact.join
else
@link
end
end
end
end
class RSSItem < FeedItem
def parse(item)
# Title. If no title, use the pubDate as fallback.
if ((e = item.elements['title'] || item.elements['rss:title']) &&
e.text) ||
((e = item.elements['pubDate'] || item.elements['rss:pubDate']) &&
e.text)
@title = e.text.unescape_html.toUTF8(@feed.encoding).html2text.rmWhiteSpace!
end
# Link
if ((e = item.elements['link'] || item.elements['rss:link']) && e.text)||
(e = item.elements['guid'] || item.elements['rss:guid'] and
not (e.attribute('isPermaLink') and
e.attribute('isPermaLink').value == 'false'))
self.link = e.text.rmWhiteSpace!
end
# Content
if (e = item.elements['content:encoded']) ||
(e = item.elements['description'] || item.elements['rss:description'])
@content = FeedParser::getcontent(e, @feed)
end
# Date
if e = item.elements['dc:date'] || item.elements['pubDate'] ||
item.elements['rss:pubDate']
begin
@date = Time::xmlschema(e.text)
rescue
begin
@date = Time::rfc2822(e.text)
rescue
begin
@date = Time::parse(e.text)
rescue
@date = nil
end
end
end
end
# Creator
if (e = item.elements['dc:creator'] || item.elements['author'] ||
item.elements['rss:author']) && e.text
@creators << e.text.unescape_html.toUTF8(@feed.encoding).rmWhiteSpace!
end
@creators << @feed.creator if @creators.empty? and @feed.creator
# Subject
if (e = item.elements['dc:subject']) && e.text
@subject = e.text.unescape_html.toUTF8(@feed.encoding).rmWhiteSpace!
end
# Categories
cat_elts = []
item.each_element('dc:category') { |e| cat_elts << e if e.text }
item.each_element('category') { |e| cat_elts << e if e.text }
item.each_element('rss:category') { |e| cat_elts << e if e.text }
cat_elts.each do |e|
@categories << e.text.unescape_html.toUTF8(@feed.encoding).rmWhiteSpace!
end
# Enclosures
item.each_element('enclosure') do |e|
url = e.attribute('url').value if e.attribute('url')
length = e.attribute('length').value if e.attribute('length')
type = e.attribute('type').value if e.attribute('type')
@enclosures << [ url, length, type ] if url
end
end
end
class AtomItem < FeedItem
def parse(item)
# Title
if (e = item.elements['title']) && e.text
@title = e.text.unescape_html.toUTF8(@feed.encoding).html2text.rmWhiteSpace!
end
# Link
item.each_element('link') do |e|
if (h = e.attribute('href')) && h.value
self.link = h.value
if e.attribute('type')
@links << {:href => h.value, :type => e.attribute('type').value}
else
@links << {:href => h.value, :type => ''}
end
end
end
# Content
if e = item.elements['content'] || item.elements['summary']
if (e.attribute('mode') and e.attribute('mode').value == 'escaped') &&
e.text
@content = e.text.toUTF8(@feed.encoding).rmWhiteSpace!
else
@content = FeedParser::getcontent(e, @feed)
end
end
# Date
if (e = item.elements['issued'] || e = item.elements['created'] || e = item.elements['updated'] || e = item.elements['published']) && e.text
begin
@date = Time::xmlschema(e.text)
rescue
begin
@date = Time::rfc2822(e.text)
rescue
begin
@date = Time::parse(e.text)
rescue
@date = nil
end
end
end
end
# Creator
item.each_element('author/name') do |e|
if e.text
@creators << e.text.unescape_html.toUTF8(@feed.encoding).rmWhiteSpace!
end
end
@creators << @feed.creator if @creators.empty? and @feed.creator
# Categories
item.each_element('category') do |e|
if (h = e.attribute('term')) && h.value
# Use human-readable label if it is provided
if (l = e.attribute('label')) && l.value
cat = l.value
else
cat = h.value
end
@categories << cat.unescape_html.toUTF8(@feed.encoding).rmWhiteSpace!
end
end
end
end
def FeedParser::getcontent(e, feed = nil)
encoding = feed ? feed.encoding : 'utf-8'
children = e.children.reject do |i|
i.class == REXML::Text and i.to_s.chomp == ''
end
if children.length > 1
s = ''
children.each do |c|
s += c.to_s if c.class != REXML::Comment
end
return s.toUTF8(encoding).rmWhiteSpace!.text2html(feed)
elsif children.length == 1
c = children[0]
if c.class == REXML::Text
return e.text.toUTF8(encoding).rmWhiteSpace!.text2html(feed)
elsif c.class == REXML::CData
return c.to_s.toUTF8(encoding).rmWhiteSpace!.text2html(feed)
elsif c.class == REXML::Element
# only one element. recurse.
return getcontent(c, feed)
elsif c.text
return c.text.toUTF8(encoding).text2html(feed)
end
end
end
end
|