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
|
# frozen_string_literal: true
require "nokogiri"
module Loofah
class << self
def html5_support?
# Note that Loofah can only support HTML5 in Nokogiri >= 1.14.0 because it requires the
# subclassing fix from https://github.com/sparklemotion/nokogiri/pull/2534
return @html5_support if defined? @html5_support
@html5_support =
Gem::Version.new(Nokogiri::VERSION) > Gem::Version.new("1.14.0") &&
Nokogiri.uses_gumbo?
end
end
end
require_relative "loofah/version"
require_relative "loofah/metahelpers"
require_relative "loofah/elements"
require_relative "loofah/html5/safelist"
require_relative "loofah/html5/libxml2_workarounds"
require_relative "loofah/html5/scrub"
require_relative "loofah/scrubber"
require_relative "loofah/scrubbers"
require_relative "loofah/concerns"
require_relative "loofah/xml/document"
require_relative "loofah/xml/document_fragment"
require_relative "loofah/html4/document"
require_relative "loofah/html4/document_fragment"
if Loofah.html5_support?
require_relative "loofah/html5/document"
require_relative "loofah/html5/document_fragment"
end
# == Strings and IO Objects as Input
#
# The following methods accept any IO object in addition to accepting a string:
#
# - Loofah.html4_document
# - Loofah.html4_fragment
# - Loofah.scrub_html4_document
# - Loofah.scrub_html4_fragment
#
# - Loofah.html5_document
# - Loofah.html5_fragment
# - Loofah.scrub_html5_document
# - Loofah.scrub_html5_fragment
#
# - Loofah.xml_document
# - Loofah.xml_fragment
# - Loofah.scrub_xml_document
# - Loofah.scrub_xml_fragment
#
# - Loofah.document
# - Loofah.fragment
# - Loofah.scrub_document
# - Loofah.scrub_fragment
#
# That IO object could be a file, or a socket, or a StringIO, or anything that responds to +read+
# and +close+.
#
module Loofah
# Alias for Loofah::HTML4
HTML = HTML4
class << self
# Shortcut for Loofah::HTML4::Document.parse(*args, &block)
#
# This method accepts the same parameters as Nokogiri::HTML4::Document.parse
def html4_document(*args, &block)
Loofah::HTML4::Document.parse(*args, &block)
end
# Shortcut for Loofah::HTML4::DocumentFragment.parse(*args, &block)
#
# This method accepts the same parameters as Nokogiri::HTML4::DocumentFragment.parse
def html4_fragment(*args, &block)
Loofah::HTML4::DocumentFragment.parse(*args, &block)
end
# Shortcut for Loofah::HTML4::Document.parse(string_or_io).scrub!(method)
def scrub_html4_document(string_or_io, method)
Loofah::HTML4::Document.parse(string_or_io).scrub!(method)
end
# Shortcut for Loofah::HTML4::DocumentFragment.parse(string_or_io).scrub!(method)
def scrub_html4_fragment(string_or_io, method)
Loofah::HTML4::DocumentFragment.parse(string_or_io).scrub!(method)
end
if Loofah.html5_support?
# Shortcut for Loofah::HTML5::Document.parse(*args, &block)
#
# This method accepts the same parameters as Nokogiri::HTML5::Document.parse
def html5_document(*args, &block)
Loofah::HTML5::Document.parse(*args, &block)
end
# Shortcut for Loofah::HTML5::DocumentFragment.parse(*args, &block)
#
# This method accepts the same parameters as Nokogiri::HTML5::DocumentFragment.parse
def html5_fragment(*args, &block)
Loofah::HTML5::DocumentFragment.parse(*args, &block)
end
# Shortcut for Loofah::HTML5::Document.parse(string_or_io).scrub!(method)
def scrub_html5_document(string_or_io, method)
Loofah::HTML5::Document.parse(string_or_io).scrub!(method)
end
# Shortcut for Loofah::HTML5::DocumentFragment.parse(string_or_io).scrub!(method)
def scrub_html5_fragment(string_or_io, method)
Loofah::HTML5::DocumentFragment.parse(string_or_io).scrub!(method)
end
else
def html5_document(*args, &block)
raise NotImplementedError, "Loofah::HTML5 is not supported by your version of Nokogiri"
end
def html5_fragment(*args, &block)
raise NotImplementedError, "Loofah::HTML5 is not supported by your version of Nokogiri"
end
def scrub_html5_document(string_or_io, method)
raise NotImplementedError, "Loofah::HTML5 is not supported by your version of Nokogiri"
end
def scrub_html5_fragment(string_or_io, method)
raise NotImplementedError, "Loofah::HTML5 is not supported by your version of Nokogiri"
end
end
alias_method :document, :html4_document
alias_method :fragment, :html4_fragment
alias_method :scrub_document, :scrub_html4_document
alias_method :scrub_fragment, :scrub_html4_fragment
# Shortcut for Loofah::XML::Document.parse(*args, &block)
#
# This method accepts the same parameters as Nokogiri::XML::Document.parse
def xml_document(*args, &block)
Loofah::XML::Document.parse(*args, &block)
end
# Shortcut for Loofah::XML::DocumentFragment.parse(*args, &block)
#
# This method accepts the same parameters as Nokogiri::XML::DocumentFragment.parse
def xml_fragment(*args, &block)
Loofah::XML::DocumentFragment.parse(*args, &block)
end
# Shortcut for Loofah.xml_fragment(string_or_io).scrub!(method)
def scrub_xml_fragment(string_or_io, method)
Loofah.xml_fragment(string_or_io).scrub!(method)
end
# Shortcut for Loofah.xml_document(string_or_io).scrub!(method)
def scrub_xml_document(string_or_io, method)
Loofah.xml_document(string_or_io).scrub!(method)
end
# A helper to remove extraneous whitespace from text-ified HTML
def remove_extraneous_whitespace(string)
string.gsub(/\n\s*\n\s*\n/, "\n\n")
end
end
end
|
