#
# With a link:
#
# !/common/textist.gif(Textist)!:http://textism.com
#
# Will become:
#
#
#
# == Defining Acronyms
#
# HTML allows authors to define acronyms via the tag. The definition appears as a
# tool tip when a cursor hovers over the acronym. A crucial aid to clear writing,
# this should be used at least once for each acronym in documents where they appear.
#
# To quickly define an acronym in Textile, place the full text in (parentheses)
# immediately following the acronym.
#
# Example:
#
# ACLU(American Civil Liberties Union)
#
# Will become:
#
# ACLU
#
# == Adding Tables
#
# In Textile, simple tables can be added by separating each column by
# a pipe.
#
# |a|simple|table|row|
# |And|Another|table|row|
#
# Attributes are defined by style definitions in parentheses.
#
# table(border:1px solid black).
# (background:#ddd;color:red). |{}| | | |
#
# == Using RedCloth
#
# RedCloth is simply an extension of the String class, which can handle
# Textile formatting. Use it like a String and output HTML with its
# RedCloth#to_html method.
#
# doc = RedCloth.new "
#
# h2. Test document
#
# Just a simple test."
#
# puts doc.to_html
#
# By default, RedCloth uses both Textile and Markdown formatting, with
# Textile formatting taking precedence. If you want to turn off Markdown
# formatting, to boost speed and limit the processor:
#
# class RedCloth::Textile.new( str )
class RedCloth3 < String
include Redmine::Helpers::URL
VERSION = '3.0.4'
DEFAULT_RULES = [:textile, :markdown]
#
# Two accessor for setting security restrictions.
#
# This is a nice thing if you're using RedCloth for
# formatting in public places (e.g. Wikis) where you
# don't want users to abuse HTML for bad things.
#
# If +:filter_html+ is set, HTML which wasn't
# created by the Textile processor will be escaped.
#
# If +:filter_styles+ is set, it will also disable
# the style markup specifier. ('{color: red}')
#
attr_accessor :filter_html, :filter_styles
#
# Accessor for toggling hard breaks.
#
# If +:hard_breaks+ is set, single newlines will
# be converted to HTML break tags. This is the
# default behavior for traditional RedCloth.
#
attr_accessor :hard_breaks
# Accessor for toggling lite mode.
#
# In lite mode, block-level rules are ignored. This means
# that tables, paragraphs, lists, and such aren't available.
# Only the inline markup for bold, italics, entities and so on.
#
# r = RedCloth.new( "And then? She *fell*!", [:lite_mode] )
# r.to_html
# #=> "And then? She fell!"
#
attr_accessor :lite_mode
#
# Accessor for toggling span caps.
#
# Textile places `span' tags around capitalized
# words by default, but this wreaks havoc on Wikis.
# If +:no_span_caps+ is set, this will be
# suppressed.
#
attr_accessor :no_span_caps
#
# Establishes the markup predence. Available rules include:
#
# == Textile Rules
#
# The following textile rules can be set individually. Or add the complete
# set of rules with the single :textile rule, which supplies the rule set in
# the following precedence:
#
# refs_textile:: Textile references (i.e. [hobix]http://hobix.com/)
# block_textile_table:: Textile table block structures
# block_textile_lists:: Textile list structures
# block_textile_prefix:: Textile blocks with prefixes (i.e. bq., h2., etc.)
# inline_textile_image:: Textile inline images
# inline_textile_link:: Textile inline links
# inline_textile_span:: Textile inline spans
# glyphs_textile:: Textile entities (such as em-dashes and smart quotes)
#
# == Markdown
#
# refs_markdown:: Markdown references (for example: [hobix]: http://hobix.com/)
# block_markdown_setext:: Markdown setext headers
# block_markdown_atx:: Markdown atx headers
# block_markdown_rule:: Markdown horizontal rules
# block_markdown_bq:: Markdown blockquotes
# block_markdown_lists:: Markdown lists
# inline_markdown_link:: Markdown links
attr_accessor :rules
# Returns a new RedCloth object, based on _string_ and
# enforcing all the included _restrictions_.
#
# r = RedCloth.new( "h1. A bold man", [:filter_html] )
# r.to_html
# #=>"' * (l-indent) : '' * (indent-l)) + "\n\n") indent = l end quotes << (content + "\n") end quotes << ("\n" + '' * indent + "\n\n") quotes end end CODE_RE = /(\W) @ (?:\|(\w+?)\|)? (.+?) @ (?=\W)/x def inline_textile_code(text) text.gsub!(CODE_RE) do |m| before, lang, code, after = $~[1..4] lang = " lang=\"#{lang}\"" if lang rip_offtags("#{before}
#{blk}#{blk}
" end end # hard_break blk blk + "\n#{code_blk}" end end end.join("\n\n")) end def textile_bq(tag, atts, cite, content) cite, cite_title = check_refs(cite) cite = " cite=\"#{htmlesc cite.dup}\"" if cite atts = shelve(atts) if atts "\t\n#{blk}\n\n\n" end end MARKDOWN_RULE_RE = /^(#{ ['*', '-', '_'].collect { |ch| ' ?(' + Regexp::quote(ch) + ' ?){3,}' }.join('|') })$/ def block_markdown_rule(text) text.gsub!(MARKDOWN_RULE_RE) do |blk| "
" out = "
#{out}"
else
out = "#{stln}#{out}"
end
else
out = stln + out
end
out
end
end
def shelve(val)
@shelf << val
" :redsh##{@shelf.length}:"
end
def retrieve(text)
text.gsub!(/ :redsh#(\d+):/) do
@shelf[$1.to_i - 1] || $&
end
end
def incoming_entities(text)
## turn any incoming ampersands into a dummy character for now.
## This uses a negative lookahead for alphanumerics followed by a semicolon,
## implying an incoming html entity, to be skipped
text.gsub!(/&(?![#a-z0-9]+;)/i, "x%x%")
end
def no_textile(text)
text.gsub!(/(^|\s)==([^=]+.*?)==(\s|$)?/,
'\1, etc.
if $1
if OFFTAG_OPEN.match?(line)
codepre += 1
elsif OFFTAG_CLOSE.match?(line)
codepre -= 1
codepre = 0 if codepre < 0
end
elsif codepre.zero?
glyphs_textile(line, level + 1)
else
htmlesc(line, :NoQuotes)
end
# p [level, codepre, line]
line
end
end
end
def rip_offtags(text, escape_aftertag=true, escape_line=true)
if text =~ /<.*>/
## strip and encode content
codepre, used_offtags = 0, {}
text.gsub!(OFFTAG_MATCH) do |line|
if $3
first, offtag, aftertag = $3, $4, $5
codepre += 1
used_offtags[offtag] = true
if codepre - used_offtags.length > 0
htmlesc(line, :NoQuotes) if escape_line
@pre_list.last << line
line = +""
else
### htmlesc is disabled between CODE tags which will be parsed with highlighter
### Regexp in formatter.rb is : / content
text.gsub!(/
'
end
# HTML cleansing stuff
BASIC_TAGS = {
'a' => ['href', 'title'],
'img' => ['src', 'alt', 'title'],
'br' => [],
'i' => nil,
'u' => nil,
'b' => nil,
'pre' => nil,
'kbd' => nil,
'code' => ['lang'],
'cite' => nil,
'strong' => nil,
'em' => nil,
'ins' => nil,
'sup' => nil,
'sub' => nil,
'del' => nil,
'table' => nil,
'tr' => nil,
'td' => ['colspan', 'rowspan'],
'th' => nil,
'ol' => nil,
'ul' => nil,
'li' => nil,
'p' => nil,
'h1' => nil,
'h2' => nil,
'h3' => nil,
'h4' => nil,
'h5' => nil,
'h6' => nil,
'blockquote' => ['cite']
}
def clean_html(text, tags = BASIC_TAGS)
text.gsub!("]*)>/) do
raw = $~
tag = raw[2].downcase
if tags.has_key? tag
pcs = [tag]
tags[tag].each do |prop|
['"', "'", ''].each do |q|
q2 = (q != '' ? q : '\s')
if raw[3] =~ /#{prop}\s*=\s*#{q}([^#{q2}]+)#{q}/i
attrv = $1
next if prop == 'src' and attrv =~ %r{^(?!http)\w+:}
pcs << "#{prop}=\"#{$1.gsub('"', '\\"')}\""
break
end
end
end if tags[tag]
"<#{raw[1]}#{pcs.join " "}>"
else
" "
end
end
end
ALLOWED_TAGS = %w(pre code kbd notextile)
def escape_html_tags(text)
text.gsub!(%r{<(\/?([!\w][^ >\t\f\r\n]*)[^<>\n]*)(>?)}) do |m|
all, tag, close = $1, $2, $3
if close.present? && (ALLOWED_TAGS.include?(tag) || (tag =~ /\Aredpre#\d+\z/))
"<#{htmlesc all}#{close}"
else
"<#{htmlesc all}#{'>' unless close.blank?}"
end
end
end
def remove_html_comments(text)
text.gsub!(//, '')
end
end