' when /./ @out << escape_html($&) else raise CreoleParseError, "Parse error at #{str[0,30].inspect}" end # p [$&, $'] str = $' end end def parse_table_row(str) @out << '
Hello World
" # # This is an alias for calling CreoleParser#parse: # CreoleParser.new.parse(creole) def self.creolize(creole) CreoleParser.new.parse(creole) end # Main Creole parser class. Call CreoleParser#parse to parse Creole # formatted text. # # This class is not reentrant. A separate instance is needed for # each thread that needs to convert Creole to HTML. # # Inherit this to provide custom handling of links. The overrideable # methods are: make_local_link class CreoleParser # Create a new CreoleParser instance. def initialize @base = nil @allowed_schemes = [ 'http', 'https', 'ftp', 'ftps' ] @uri_scheme_re = @allowed_schemes.join('|') end # Parse and convert the argument in Creole text to HTML and return # the result. The resulting HTML does not contain and # tags. # # Example: # # parser = CreoleParser.new # parser.parse("**Hello //World//**") # #=> "Hello World
" def parse(string) @out = "" @strong = false @p = false @stack = [] parse_block(string) return @out end # Escape any characters with special meaning in HTML using HTML # entities. private def escape_html(string) CGI::escapeHTML(string) end # Escape any characters with special meaning in URLs using URL # encoding. private def escape_url(string) CGI::escape(string) end private def toggle_tag(tag, match) if @stack.include?(tag) if @stack.last == tag @stack.pop @out << '' else @out << escape_html(match) end else @stack.push(tag) @out << '<' << tag << '>' end end def end_paragraph while tag = @stack.pop @out << "" end @p = false end def start_paragraph if not @p end_paragraph @out << ''
@stack.push('p')
@p = true
else
@out << ' ' unless @out[-1,1] == ' '
end
end
# Create anchor markup for direct links. This
# method can be overridden to generate custom
# markup, for example to add html additional attributes.
private
def make_direct_anchor(uri, text)
'' << escape_html(text) << ''
end
# Create anchor markup for explicit links. This
# method can be overridden to generate custom
# markup, for example to add html additional attributes.
private
def make_explicit_anchor(uri, text)
'' << escape_html(text) << ''
end
# Translate an explicit local link to a desired URL that is
# properly URL-escaped. The default behaviour is to convert local
# links directly, escaping any characters that have special
# meaning in URLs. Relative URLs in local links are not handled.
#
# Examples:
#
# make_local_link("LocalLink") #=> "LocalLink"
# make_local_link("/Foo/Bar") #=> "%2FFoo%2FBar"
#
# Must ensure that the result is properly URL-escaped. The caller
# will handle HTML escaping as necessary. HTML links will not be
# inserted if the function returns nil.
#
# Example custom behaviour:
#
# make_local_link("LocalLink") #=> "/LocalLink"
# make_local_link("Wikipedia:Bread") #=> "http://en.wikipedia.org/wiki/Bread"
private
def make_local_link(link) #:doc:
escape_url(link)
end
# Sanatize a direct url (e.g. http://wikipedia.org/). The default
# behaviour returns the original link as-is.
#
# Must ensure that the result is properly URL-escaped. The caller
# will handle HTML escaping as necessary. Links will not be
# converted to HTML links if the function returns link.
#
# Custom versions of this function in inherited classes can
# implement specific link handling behaviour, such as redirection
# to intermediate pages (for example, for notifing the user that
# he is leaving the site).
private
def make_direct_link(url) #:doc:
return url
end
# Sanatize and prefix image URLs. When images are encountered in
# Creole text, this function is called to obtain the actual URL of
# the image. The default behaviour is to return the image link
# as-is. No image tags are inserted if the function returns nil.
#
# Custom version of the method can be used to sanatize URLs
# (e.g. remove query-parts), inhibit off-site images, or add a
# base URL, for example:
#
# def make_image_link(url)
# URI.join("http://mywiki.org/images/", url)
# end
private
def make_image_link(url) #:doc:
return url
end
# Create image markup. This
# method can be overridden to generate custom
# markup, for example to add html additional attributes or
# to put divs around the imgs.
private
def make_image(uri, alt)
if alt
''
else
'
'
end
end
private
def make_explicit_link(link)
begin
uri = URI.parse(link)
if uri.scheme and @allowed_schemes.include?(uri.scheme)
return uri.to_s
end
rescue URI::InvalidURIError
end
return make_local_link(link)
end
def parse_inline(str)
until str.empty?
case str
when /\A\r?\n/
return
when /\A(\~)?((https?|ftps?):\/\/\S+?)(?=([,.?!:;"'])?(\s|$))/
if $1
@out << escape_html($2)
else
if uri = make_direct_link($2)
@out << make_direct_anchor(uri, $2)
else
@out << escape_html($&)
end
end
when /\A\[\[\s*([^|]*?)\s*(\|\s*(.*?))?\s*\]\]/m
link = $1
if uri = make_explicit_link(link)
@out << make_explicit_anchor(uri, $3 || link)
else
@out << escape_html($&)
end
when /\A[^\/\\*\s{}~]+/
@out << escape_html($&)
when /\A\{\{\{(.*)\}\}\}/
@out << '' << escape_html($1) << ''
when /\A\{\{\s*(.*?)\s*(\|\s*(.*?)\s*)?\}\}/ # (|\s*(.*?)\s*)?*\}\}/
if uri = make_image_link($1)
@out << make_image(uri, $3)
else
@out << escape_html($&)
end
when /\A~([^\s])/
@out << escape_html($1)
when /\A[ \t]+/
@out << ' ' unless @out[-1,1] == ' '
when /\A\*\*/
toggle_tag 'strong', $&
when /\A\/\//
toggle_tag 'em', $&
when /\A\\\\/
@out << '
'
when /./
@out << escape_html($&)
else
raise CreoleParseError, "Parse error at #{str[0,30].inspect}"
end
# p [$&, $']
str = $'
end
end
def parse_table_row(str)
@out << '
' << escape_html(nowikiblock) << '' when /\A\s*-{4,}\s*$/ end_paragraph @out << '