text_helper.rb 26.6 KB
Newer Older
1 2
require 'action_view/helpers/tag_helper'
require 'html/document'
3

D
Initial  
David Heinemeier Hansson 已提交
4 5
module ActionView
  module Helpers #:nodoc:
6 7
    # The TextHelper module provides a set of methods for filtering, formatting 
    # and transforming strings, which can reduce the amount of inline Ruby code in 
D
David Heinemeier Hansson 已提交
8
    # your views. These helper methods extend ActionView making them callable 
9
    # within your template files.
10
    module TextHelper      
D
David Heinemeier Hansson 已提交
11 12 13
      # The preferred method of outputting text in your views is to use the 
      # <%= "text" %> eRuby syntax. The regular _puts_ and _print_ methods 
      # do not operate as expected in an eRuby code block. If you absolutely must 
14
      # output text within a non-output code block (i.e., <% %>), you can use the concat method.
D
David Heinemeier Hansson 已提交
15
      #
16 17 18 19 20 21 22 23 24 25 26 27
      # ==== Examples
      #   <% 
      #       concat "hello", binding 
      #       # is the equivalent of <%= "hello" %>
      #
      #       if (logged_in == true):
      #         concat "Logged in!", binding
      #       else
      #         concat link_to('login', :action => login), binding
      #       end
      #       # will either display "Logged in!" or a login link
      #   %>
D
Initial  
David Heinemeier Hansson 已提交
28
      def concat(string, binding)
29
        eval(ActionView::Base.erb_variable, binding) << string
D
Initial  
David Heinemeier Hansson 已提交
30 31
      end

D
David Heinemeier Hansson 已提交
32
      # If +text+ is longer than +length+, +text+ will be truncated to the length of 
33
      # +length+ (defaults to 30) and the last characters will be replaced with the +truncate_string+
34
      # (defaults to "...").
D
David Heinemeier Hansson 已提交
35
      #
36
      # ==== Examples
D
David Heinemeier Hansson 已提交
37
      #   truncate("Once upon a time in a world far far away", 14)  
38 39 40 41 42 43 44 45 46 47
      #   # => Once upon a...
      #
      #   truncate("Once upon a time in a world far far away")  
      #   # => Once upon a time in a world f...
      #
      #   truncate("And they found that many people were sleeping better.", 25, "(clipped)")
      #   # => And they found that many (clipped)
      #
      #   truncate("And they found that many people were sleeping better.", 15, "... (continued)")
      #   # => And they found... (continued)
D
Initial  
David Heinemeier Hansson 已提交
48 49
      def truncate(text, length = 30, truncate_string = "...")
        if text.nil? then return end
50
        l = length - truncate_string.chars.length
51
        (text.chars.length > length ? text.chars[0...l] + truncate_string : text).to_s
D
Initial  
David Heinemeier Hansson 已提交
52 53
      end

54
      # Highlights one or more +phrases+ everywhere in +text+ by inserting it into
D
David Heinemeier Hansson 已提交
55
      # a +highlighter+ string. The highlighter can be specialized by passing +highlighter+ 
56 57
      # as a single-quoted string with \1 where the phrase is to be inserted (defaults to
      # '<strong class="highlight">\1</strong>')
D
David Heinemeier Hansson 已提交
58
      #
59
      # ==== Examples
D
David Heinemeier Hansson 已提交
60
      #   highlight('You searched for: rails', 'rails')  
61 62
      #   # => You searched for: <strong class="highlight">rails</strong>
      #
63 64 65
      #   highlight('You searched for: ruby, rails, dhh', 'actionpack')
      #   # => You searched for: ruby, rails, dhh 
      #
66 67
      #   highlight('You searched for: rails', ['for', 'rails'], '<em>\1</em>')  
      #   # => You searched <em>for</em>: <em>rails</em>
68 69 70
      # 
      #   highlight('You searched for: rails', 'rails', "<a href='search?q=\1'>\1</a>")
      #   # => You searched for: <a href='search?q=rails>rails</a>
71 72 73 74 75 76 77
      def highlight(text, phrases, highlighter = '<strong class="highlight">\1</strong>')
        if text.blank? || phrases.blank?
          text
        else
          match = Array(phrases).map { |p| Regexp.escape(p) }.join('|')
          text.gsub(/(#{match})/i, highlighter)
        end
D
Initial  
David Heinemeier Hansson 已提交
78
      end
79

D
David Heinemeier Hansson 已提交
80
      # Extracts an excerpt from +text+ that matches the first instance of +phrase+. 
81 82
      # The +radius+ expands the excerpt on each side of the first occurance of +phrase+ by the number of characters
      # defined in +radius+ (which defaults to 100). If the excerpt radius overflows the beginning or end of the +text+,
D
David Heinemeier Hansson 已提交
83 84 85
      # then the +excerpt_string+ will be prepended/appended accordingly. If the +phrase+ 
      # isn't found, nil is returned.
      #
86
      # ==== Examples
D
David Heinemeier Hansson 已提交
87
      #   excerpt('This is an example', 'an', 5) 
88
      #   # => "...s is an examp..."
D
David Heinemeier Hansson 已提交
89 90
      #
      #   excerpt('This is an example', 'is', 5) 
91 92 93 94 95 96 97 98 99 100
      #   # => "This is an..."
      #
      #   excerpt('This is an example', 'is') 
      #   # => "This is an example"
      #
      #   excerpt('This next thing is an example', 'ex', 2) 
      #   # => "...next t..."
      #
      #   excerpt('This is also an example', 'an', 8, '<chop> ')
      #   # => "<chop> is also an example"
D
Initial  
David Heinemeier Hansson 已提交
101 102
      def excerpt(text, phrase, radius = 100, excerpt_string = "...")
        if text.nil? || phrase.nil? then return end
103
        phrase = Regexp.escape(phrase)
104

105
        if found_pos = text.chars =~ /(#{phrase})/i
D
Initial  
David Heinemeier Hansson 已提交
106
          start_pos = [ found_pos - radius, 0 ].max
107
          end_pos   = [ found_pos + phrase.chars.length + radius, text.chars.length ].min
D
Initial  
David Heinemeier Hansson 已提交
108 109

          prefix  = start_pos > 0 ? excerpt_string : ""
110
          postfix = end_pos < text.chars.length ? excerpt_string : ""
D
Initial  
David Heinemeier Hansson 已提交
111

112
          prefix + text.chars[start_pos..end_pos].strip + postfix
D
Initial  
David Heinemeier Hansson 已提交
113 114 115 116 117
        else
          nil
        end
      end

D
David Heinemeier Hansson 已提交
118 119 120 121 122
      # Attempts to pluralize the +singular+ word unless +count+ is 1. If +plural+
      # is supplied, it will use that when count is > 1, if the ActiveSupport Inflector 
      # is loaded, it will use the Inflector to determine the plural form, otherwise 
      # it will just add an 's' to the +singular+ word.
      #
123 124 125 126 127 128 129 130 131 132 133 134
      # ==== Examples
      #   pluralize(1, 'person')           
      #   # => 1 person
      #
      #   pluralize(2, 'person')           
      #   # => 2 people
      #
      #   pluralize(3, 'person', 'users')  
      #   # => 3 users
      #
      #   pluralize(0, 'person')
      #   # => 0 people
D
Initial  
David Heinemeier Hansson 已提交
135
      def pluralize(count, singular, plural = nil)
136
         "#{count || 0} " + if count == 1 || count == '1'
D
Initial  
David Heinemeier Hansson 已提交
137 138 139 140 141
          singular
        elsif plural
          plural
        elsif Object.const_defined?("Inflector")
          Inflector.pluralize(singular)
142
        else
D
Initial  
David Heinemeier Hansson 已提交
143 144 145 146
          singular + "s"
        end
      end

D
David Heinemeier Hansson 已提交
147
      # Wraps the +text+ into lines no longer than +line_width+ width. This method
148 149
      # breaks on the first whitespace character that does not exceed +line_width+
      # (which is 80 by default).
D
David Heinemeier Hansson 已提交
150
      #
151
      # ==== Examples
D
David Heinemeier Hansson 已提交
152
      #   word_wrap('Once upon a time', 4)
153 154 155 156 157 158 159 160 161 162
      #   # => Once\nupon\na\ntime
      #
      #   word_wrap('Once upon a time', 8)
      #   # => Once upon\na time
      #
      #   word_wrap('Once upon a time')
      #   # => Once upon a time
      #
      #   word_wrap('Once upon a time', 1)
      #   # => Once\nupon\na\ntime
163
      def word_wrap(text, line_width = 80)
164 165 166
        text.split("\n").collect do |line|
          line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
        end * "\n"
167 168
      end

D
Initial  
David Heinemeier Hansson 已提交
169
      begin
170
        require_library_or_gem "redcloth" unless Object.const_defined?(:RedCloth)
D
Initial  
David Heinemeier Hansson 已提交
171

172 173 174
        # Returns the text with all the Textile[http://www.textism.com/tools/textile] codes turned into HTML tags.
        #
        # You can learn more about Textile's syntax at its website[http://www.textism.com/tools/textile].
D
David Heinemeier Hansson 已提交
175 176
        # <i>This method is only available if RedCloth[http://whytheluckystiff.net/ruby/redcloth/]
        # is available</i>.
177 178 179 180 181 182 183 184 185 186 187 188 189
        #
        # ==== Examples
        #   textilize("*This is Textile!*  Rejoice!")
        #   # => "<p><strong>This is Textile!</strong>  Rejoice!</p>"
        #
        #   textilize("I _love_ ROR(Ruby on Rails)!")
        #   # => "<p>I <em>love</em> <acronym title="Ruby on Rails">ROR</acronym>!</p>"
        #
        #   textilize("h2. Textile makes markup -easy- simple!")
        #   # => "<h2>Textile makes markup <del>easy</del> simple!</h2>"
        #
        #   textilize("Visit the Rails website "here":http://www.rubyonrails.org/.)
        #   # => "<p>Visit the Rails website <a href="http://www.rubyonrails.org/">here</a>.</p>"
D
Initial  
David Heinemeier Hansson 已提交
190
        def textilize(text)
191 192 193 194 195 196
          if text.blank?
            ""
          else
            textilized = RedCloth.new(text, [ :hard_breaks ])
            textilized.hard_breaks = true if textilized.respond_to?("hard_breaks=")
            textilized.to_html
197
          end
D
Initial  
David Heinemeier Hansson 已提交
198 199
        end

D
David Heinemeier Hansson 已提交
200 201
        # Returns the text with all the Textile codes turned into HTML tags, 
        # but without the bounding <p> tag that RedCloth adds.
202 203
        #
        # You can learn more about Textile's syntax at its website[http://www.textism.com/tools/textile].
D
David Heinemeier Hansson 已提交
204 205
        # <i>This method is only available if RedCloth[http://whytheluckystiff.net/ruby/redcloth/]
        # is available</i>.
206 207 208 209 210 211 212 213 214 215 216 217 218
        #
        # ==== Examples
        #   textilize_without_paragraph("*This is Textile!*  Rejoice!")
        #   # => "<strong>This is Textile!</strong>  Rejoice!"
        #
        #   textilize_without_paragraph("I _love_ ROR(Ruby on Rails)!")
        #   # => "I <em>love</em> <acronym title="Ruby on Rails">ROR</acronym>!"
        #
        #   textilize_without_paragraph("h2. Textile makes markup -easy- simple!")
        #   # => "<h2>Textile makes markup <del>easy</del> simple!</h2>"
        #
        #   textilize_without_paragraph("Visit the Rails website "here":http://www.rubyonrails.org/.)
        #   # => "Visit the Rails website <a href="http://www.rubyonrails.org/">here</a>."
D
Initial  
David Heinemeier Hansson 已提交
219 220 221 222 223 224 225 226 227 228 229
        def textilize_without_paragraph(text)
          textiled = textilize(text)
          if textiled[0..2] == "<p>" then textiled = textiled[3..-1] end
          if textiled[-4..-1] == "</p>" then textiled = textiled[0..-5] end
          return textiled
        end
      rescue LoadError
        # We can't really help what's not there
      end

      begin
230
        require_library_or_gem "bluecloth" unless Object.const_defined?(:BlueCloth)
D
Initial  
David Heinemeier Hansson 已提交
231

D
David Heinemeier Hansson 已提交
232 233 234
        # Returns the text with all the Markdown codes turned into HTML tags.
        # <i>This method is only available if BlueCloth[http://www.deveiate.org/projects/BlueCloth]
        # is available</i>.
235 236 237 238 239 240 241 242 243 244 245 246 247 248
        #
        # ==== Examples
        #   markdown("We are using __Markdown__ now!")
        #   # => "<p>We are using <strong>Markdown</strong> now!</p>"
        #
        #   markdown("We like to _write_ `code`, not just _read_ it!")
        #   # => "<p>We like to <em>write</em> <code>code</code>, not just <em>read</em> it!</p>"
        #
        #   markdown("The [Markdown website](http://daringfireball.net/projects/markdown/) has more information.")
        #   # => "<p>The <a href="http://daringfireball.net/projects/markdown/">Markdown website</a> 
        #   #     has more information.</p>"
        #
        #   markdown('![The ROR logo](http://rubyonrails.com/images/rails.png "Ruby on Rails")')
        #   # => '<p><img src="http://rubyonrails.com/images/rails.png" alt="The ROR logo" title="Ruby on Rails" /></p>'     
D
Initial  
David Heinemeier Hansson 已提交
249
        def markdown(text)
250
          text.blank? ? "" : BlueCloth.new(text).to_html
D
Initial  
David Heinemeier Hansson 已提交
251 252 253 254
        end
      rescue LoadError
        # We can't really help what's not there
      end
255
      
D
David Heinemeier Hansson 已提交
256 257 258 259 260
      # Returns +text+ transformed into HTML using simple formatting rules.
      # Two or more consecutive newlines(<tt>\n\n</tt>) are considered as a 
      # paragraph and wrapped in <tt><p></tt> tags. One newline (<tt>\n</tt>) is
      # considered as a linebreak and a <tt><br /></tt> tag is appended. This
      # method does not remove the newlines from the +text+. 
261 262 263 264 265 266 267 268 269 270 271 272 273 274
      #
      # ==== Examples
      #   my_text = """Here is some basic text...
      #             ...with a line break."""
      #
      #   simple_format(my_text)
      #   # => "<p>Here is some basic text...<br />...with a line break.</p>"
      #
      #   more_text = """We want to put a paragraph...
      #     
      #               ...right there."""
      #
      #   simple_format(more_text)
      #   # => "<p>We want to put a paragraph...</p><p>...right there.</p>"
275
      def simple_format(text)
276 277 278 279
        content_tag 'p', text.to_s.
          gsub(/\r\n?/, "\n").                    # \r\n and \r -> \n
          gsub(/\n\n+/, "</p>\n\n<p>").           # 2+ newline  -> paragraph
          gsub(/([^\n]\n)(?=[^\n])/, '\1<br />')  # 1 newline   -> br
280
      end
D
Initial  
David Heinemeier Hansson 已提交
281

282 283
      # Turns all URLs and e-mail addresses into clickable links. The +link+ parameter 
      # will limit what should be linked. You can add HTML attributes to the links using
D
David Heinemeier Hansson 已提交
284
      # +href_options+. Options for +link+ are <tt>:all</tt> (default), 
285 286 287 288 289 290 291
      # <tt>:email_addresses</tt>, and <tt>:urls</tt>. If a block is given, each URL and 
      # e-mail address is yielded and the result is used as the link text.
      #
      # ==== Examples
      #   auto_link("Go to http://www.rubyonrails.org and say hello to david@loudthinking.com") 
      #   # => "Go to <a href="http://www.rubyonrails.org">http://www.rubyonrails.org</a> and
      #   #     say hello to <a href="mailto:david@loudthinking.com">david@loudthinking.com</a>"
292
      #
293 294 295
      #   auto_link("Visit http://www.loudthinking.com/ or e-mail david@loudthinking.com", :urls)
      #   # => "Visit <a href=\"http://www.loudthinking.com/\">http://www.loudthinking.com/</a> 
      #   #     or e-mail david@loudthinking.com"
296
      #
297 298
      #   auto_link("Visit http://www.loudthinking.com/ or e-mail david@loudthinking.com", :email_addresses)
      #   # => "Visit http://www.loudthinking.com/ or e-mail <a href=\"mailto:david@loudthinking.com\">david@loudthinking.com</a>"
D
David Heinemeier Hansson 已提交
299
      #
300 301
      #   post_body = "Welcome to my new blog at http://www.myblog.com/.  Please e-mail me at me@email.com."
      #   auto_link(post_body, :all, :target => '_blank') do |text|
302 303
      #     truncate(text, 15)
      #   end
304 305 306
      #   # => "Welcome to my new blog at <a href=\"http://www.myblog.com/\" target=\"_blank\">http://www.m...</a>.  
      #         Please e-mail me at <a href=\"mailto:me@email.com\">me@email.com</a>."
      #   
307
      def auto_link(text, link = :all, href_options = {}, &block)
308
        return '' if text.blank?
309
        case link
310
          when :all             then auto_link_email_addresses(auto_link_urls(text, href_options, &block), &block)
311 312
          when :email_addresses then auto_link_email_addresses(text, &block)
          when :urls            then auto_link_urls(text, href_options, &block)
313
        end
314 315
      end

316
      # Strips all link tags from +text+ leaving just the link text.
D
David Heinemeier Hansson 已提交
317
      #
318
      # ==== Examples
D
David Heinemeier Hansson 已提交
319
      #   strip_links('<a href="http://www.rubyonrails.org">Ruby on Rails</a>')
320 321 322 323 324 325 326
      #   # => Ruby on Rails
      #
      #   strip_links('Please e-mail me at <a href="mailto:me@email.com">me@email.com</a>.')
      #   # => Please e-mail me at me@email.com.
      #
      #   strip_links('Blog: <a href="http://www.myblog.com/" class="nav" target=\"_blank\">Visit</a>.')
      #   # => Blog: Visit
327 328 329 330 331 332 333 334 335 336 337 338 339
      def strip_links(html)
        # Stupid firefox treats '<href="http://whatever.com" onClick="alert()">something' as link! 
        if html.index("<a") || html.index("<href")   
          tokenizer = HTML::Tokenizer.new(html) 
          result = ''
          while token = tokenizer.next 
            node = HTML::Node.parse(nil, 0, 0, token, false) 
            result << node.to_s unless node.is_a?(HTML::Tag) && ["a", "href"].include?(node.name) 
          end 
          strip_links(result) # Recurse - handle all dirty nested links
        else
          html
        end
D
Initial  
David Heinemeier Hansson 已提交
340
      end
341

342 343 344 345
      # This #sanitize helper will html encode all tags and strip all attributes that aren't specifically allowed.  
      # It also strips href/src tags with invalid protocols, like javascript: especially.  It does its best to counter any
      # tricks that hackers may use, like throwing in unicode/ascii/hex values to get past the javascript: filters.  Check out
      # the extensive test suite.
346
      #
347 348 349 350
      #   <%= sanitize @article.body %>
      # 
      # You can add or remove tags/attributes if you want to customize it a bit.  See ActionView::Base for full docs on the
      # available options.  You can add tags/attributes for single uses of #sanitize by passing either the :attributes or :tags options:
351
      #
352
      # Normal Use
353
      #
354
      #   <%= sanitize @article.body %>
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
      # Custom Use
      #
      #   <%= sanitize @article.body, :tags => %w(table tr td), :attributes => %w(id class style)
      # 
      # Add table tags
      #   
      #   Rails::Initializer.run do |config|
      #     config.action_view.sanitized_allowed_tags = 'table', 'tr', 'td'
      #   end
      # 
      # Remove tags
      #   
      #   Rails::Initializer.run do |config|
      #     config.after_initialize do
      #       ActionView::Base.sanitized_allowed_tags.delete 'div'
      #     end
      #   end
      # 
      # Change allowed attributes
      # 
      #   Rails::Initializer.run do |config|
      #     config.action_view.sanitized_allowed_attributes = 'id', 'class', 'style'
      #   end
      # 
      def sanitize(html, options = {})
        return html if html.blank? || !html.include?('<')
        attrs = options.key?(:attributes) ? Set.new(options[:attributes]).merge(sanitized_allowed_attributes) : sanitized_allowed_attributes
        tags  = options.key?(:tags)       ? Set.new(options[:tags]      ).merge(sanitized_allowed_tags)       : sanitized_allowed_tags
        returning [] do |new_text|
385
          tokenizer = HTML::Tokenizer.new(html)
386
          parent    = [] 
387 388 389 390
          while token = tokenizer.next
            node = HTML::Node.parse(nil, 0, 0, token, false)
            new_text << case node
              when HTML::Tag
391 392
                if node.closing == :close
                  parent.shift
393
                else
394
                  parent.unshift node.name
395
                end
396 397 398 399 400 401 402 403 404
                node.attributes.keys.each do |attr_name|
                  value = node.attributes[attr_name].to_s
                  if !attrs.include?(attr_name) || contains_bad_protocols?(attr_name, value)
                    node.attributes.delete(attr_name)
                  else
                    node.attributes[attr_name] = attr_name == 'style' ? sanitize_css(value) : CGI::escapeHTML(value)
                  end
                end if node.attributes
                tags.include?(node.name) ? node : nil
405
              else
406
                sanitized_bad_tags.include?(parent.first) ? nil : node.to_s.gsub(/</, "&lt;")
407 408
            end
          end
409 410
        end.join
      end
411

412 413 414 415 416 417 418 419 420
      # Sanitizes a block of css code.  Used by #sanitize when it comes across a style attribute
      def sanitize_css(style)
        # disallow urls
        style = style.to_s.gsub(/url\s*\(\s*[^\s)]+?\s*\)\s*/, ' ')

        # gauntlet
        if style !~ /^([:,;#%.\sa-zA-Z0-9!]|\w-\w|\'[\s\w]+\'|\"[\s\w]+\"|\([\d,\s]+\))*$/ ||
            style !~ /^(\s*[-\w]+\s*:\s*[^:;]*(;|$))*$/
          return ''
421 422
        end

423 424 425 426 427 428 429 430 431 432 433 434 435 436
        returning [] do |clean|
          style.scan(/([-\w]+)\s*:\s*([^:;]*)/) do |prop,val|
            if sanitized_allowed_css_properties.include?(prop.downcase)
              clean <<  prop + ': ' + val + ';'
            elsif sanitized_shorthand_css_properties.include?(prop.split('-')[0].downcase) 
              unless val.split().any? do |keyword|
                !sanitized_allowed_css_keywords.include?(keyword) && 
                  keyword !~ /^(#[0-9a-f]+|rgb\(\d+%?,\d*%?,?\d*%?\)?|\d{0,2}\.?\d{0,2}(cm|em|ex|in|mm|pc|pt|px|%|,|\))?)$/
              end
                clean << prop + ': ' + val + ';'
              end
            end
          end
        end.join(' ')
437
      end
438

D
David Heinemeier Hansson 已提交
439 440 441
      # Strips all HTML tags from the +html+, including comments.  This uses the 
      # html-scanner tokenizer and so its HTML parsing ability is limited by 
      # that of html-scanner.
442 443 444 445 446 447 448 449 450 451
      #
      # ==== Examples
      #   strip_tags("Strip <i>these</i> tags!")
      #   # => Strip these tags!
      #
      #   strip_tags("<b>Bold</b> no more!  <a href='more.html'>See more here</a>...")
      #   # => Bold no more!  See more here...
      # 
      #   strip_tags("<div id='top-bar'>Welcome to my website!</div>")
      #   # => Welcome to my website!
452
      def strip_tags(html)     
453
        return html if html.blank?
454 455 456 457 458 459 460 461 462 463 464
        if html.index("<")
          text = ""
          tokenizer = HTML::Tokenizer.new(html)

          while token = tokenizer.next
            node = HTML::Node.parse(nil, 0, 0, token, false)
            # result is only the content of any Text nodes
            text << node.to_s if node.class == HTML::Text  
          end
          # strip any comments, and if they have a newline at the end (ie. line with
          # only a comment) strip that too
465
          strip_tags(text.gsub(/<!--(.*?)-->[\n]?/m, "")) # Recurse - handle all dirty nested tags
466 467 468 469 470
        else
          html # already plain text
        end 
      end
      
D
David Heinemeier Hansson 已提交
471 472
      # Creates a Cycle object whose _to_s_ method cycles through elements of an
      # array every time it is called. This can be used for example, to alternate 
473 474 475 476
      # classes for table rows.  You can use named cycles to allow nesting in loops.  
      # Passing a Hash as the last parameter with a <tt>:name</tt> key will create a 
      # named cycle.  You can manually reset a cycle by calling reset_cycle and passing the 
      # name of the cycle.
477
      #
478 479 480 481
      # ==== Examples 
      #   # Alternate CSS classes for even and odd numbers...
      #   @items = [1,2,3,4]
      #   <table>
D
David Heinemeier Hansson 已提交
482 483 484
      #   <% @items.each do |item| %>
      #     <tr class="<%= cycle("even", "odd") -%>">
      #       <td>item</td>
485
      #     </tr>
D
David Heinemeier Hansson 已提交
486
      #   <% end %>
487
      #   </table>
488 489
      #
      #
490 491 492 493
      #   # Cycle CSS classes for rows, and text colors for values within each row
      #   @items = x = [{:first => 'Robert', :middle => 'Daniel', :last => 'James'}, 
      #                {:first => 'Emily', :middle => 'Shannon', :maiden => 'Pike', :last => 'Hicks'}, 
      #               {:first => 'June', :middle => 'Dae', :last => 'Jones'}]
D
David Heinemeier Hansson 已提交
494
      #   <% @items.each do |item| %>
495 496
      #     <tr class="<%= cycle("even", "odd", :name => "row_class")
      #       <td>
D
David Heinemeier Hansson 已提交
497
      #         <% item.values.each do |value| %>
D
David Heinemeier Hansson 已提交
498
      #           <%# Create a named cycle "colors" %>
D
David Heinemeier Hansson 已提交
499
      #           <span style="color:<%= cycle("red", "green", "blue", :name => "colors") -%>">
500
      #             <%= value %>
501
      #           </span>
D
David Heinemeier Hansson 已提交
502 503
      #         <% end %>
      #         <% reset_cycle("colors") %>
504 505
      #       </td>
      #    </tr>
D
David Heinemeier Hansson 已提交
506
      #  <% end %>
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
      def cycle(first_value, *values)
        if (values.last.instance_of? Hash)
          params = values.pop
          name = params[:name]
        else
          name = "default"
        end
        values.unshift(first_value)

        cycle = get_cycle(name)
        if (cycle.nil? || cycle.values != values)
          cycle = set_cycle(name, Cycle.new(*values))
        end
        return cycle.to_s
      end
      
D
David Heinemeier Hansson 已提交
523 524
      # Resets a cycle so that it starts from the first element the next time 
      # it is called. Pass in +name+ to reset a named cycle.
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
      #
      # ==== Example
      #   # Alternate CSS classes for even and odd numbers...
      #   @items = [[1,2,3,4], [5,6,3], [3,4,5,6,7,4]]
      #   <table>
      #   <% @items.each do |item| %>
      #     <tr class="<%= cycle("even", "odd") -%>">
      #         <% item.each do |value| %>
      #           <span style="color:<%= cycle("#333", "#666", "#999", :name => "colors") -%>">
      #             <%= value %>
      #           </span>
      #         <% end %>
      #
      #         <% reset_cycle("colors") %>
      #     </tr>
      #   <% end %>
      #   </table>
542 543
      def reset_cycle(name = "default")
        cycle = get_cycle(name)
544
        cycle.reset unless cycle.nil?
545 546
      end

547
      class Cycle #:nodoc:
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
        attr_reader :values
        
        def initialize(first_value, *values)
          @values = values.unshift(first_value)
          reset
        end
        
        def reset
          @index = 0
        end

        def to_s
          value = @values[@index].to_s
          @index = (@index + 1) % @values.size
          return value
        end
      end
565
      
D
Initial  
David Heinemeier Hansson 已提交
566
      private
567 568 569 570
        # The cycle helpers need to store the cycles in a place that is
        # guaranteed to be reset every time a page is rendered, so it
        # uses an instance variable of ActionView::Base.
        def get_cycle(name)
571
          @_cycles = Hash.new unless defined?(@_cycles)
572 573 574 575
          return @_cycles[name]
        end
        
        def set_cycle(name, cycle_object)
576
          @_cycles = Hash.new unless defined?(@_cycles)
577 578
          @_cycles[name] = cycle_object
        end
579

580
        AUTO_LINK_RE = %r{
581 582 583 584
                        (                          # leading text
                          <\w+.*?>|                # leading HTML tag, or
                          [^=!:'"/]|               # leading punctuation, or 
                          ^                        # beginning of line
585 586
                        )
                        (
587 588
                          (?:https?://)|           # protocol spec, or
                          (?:www\.)                # www.*
589 590
                        ) 
                        (
591 592 593
                          [-\w]+                   # subdomain or domain
                          (?:\.[-\w]+)*            # remaining subdomains or domain
                          (?::\d+)?                # port
594 595
                          (?:/(?:(?:[~\w\+@%-]|(?:[,.;:][^\s$]))+)?)* # path
                          (?:\?[\w\+@%&=.;-]+)?     # query string
596
                          (?:\#[\w\-]*)?           # trailing anchor
597
                        )
598
                        ([[:punct:]]|\s|<|$)       # trailing text
599
                       }x unless const_defined?(:AUTO_LINK_RE)
600

601
        # Turns all urls into clickable links.  If a block is given, each url
D
David Heinemeier Hansson 已提交
602
        # is yielded and the result is used as the link text.
603
        def auto_link_urls(text, href_options = {})
604
          extra_options = tag_options(href_options.stringify_keys) || ""
605
          text.gsub(AUTO_LINK_RE) do
606
            all, a, b, c, d = $&, $1, $2, $3, $4
607 608 609
            if a =~ /<a\s/i # don't replace URL's that are already linked
              all
            else
610 611 612
              text = b + c
              text = yield(text) if block_given?
              %(#{a}<a href="#{b=="www."?"http://www.":b}#{c}"#{extra_options}>#{text}</a>#{d})
613 614
            end
          end
615 616
        end

617 618
        # Turns all email addresses into clickable links.  If a block is given,
        # each email is yielded and the result is used as the link text.
619
        def auto_link_email_addresses(text)
620
          body = text.dup
621 622
          text.gsub(/([\w\.!#\$%\-+.]+@[A-Za-z0-9\-]+(\.[A-Za-z0-9\-]+)+)/) do
            text = $1
623 624 625 626 627 628 629
            
            if body.match(/<a\b[^>]*>(.*)(#{Regexp.escape(text)})(.*)<\/a>/)
              text
            else
              display_text = (block_given?) ? yield(text) : text
              %{<a href="mailto:#{text}">#{display_text}</a>}
            end
630
          end
631
        end
632 633 634 635 636

        def contains_bad_protocols?(attr_name, value)
          sanitized_uri_attributes.include?(attr_name) && 
          (value =~ /(^[^\/:]*):|(&#0*58)|(&#x70)|(%|&#37;)3A/ && !sanitized_allowed_protocols.include?(value.split(sanitized_protocol_separator).first))
        end
D
Initial  
David Heinemeier Hansson 已提交
637 638
    end
  end
639
end