SoundSoftware Code Site

# encoding: utf-8

#

# Redmine - project management software

# Copyright (C) 2006-2014  Jean-Philippe Lang

#

# This program is free software; you can redistribute it and/or

# modify it under the terms of the GNU General Public License

# as published by the Free Software Foundation; either version 2

# of the License, or (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

require 'forwardable'

require 'cgi'

module ApplicationHelper

  include Redmine::WikiFormatting::Macros::Definitions

  include Redmine::I18n

  include GravatarHelper::PublicMethods

  include Redmine::Pagination::Helper

  extend Forwardable

  def_delegators :wiki_helper, :wikitoolbar_for, :heads_for_wiki_formatter

  # Return true if user is authorized for controller/action, otherwise false

  def authorize_for(controller, action)

    User.current.allowed_to?({:controller => controller, :action => action}, @project)

  end

  # Display a link if user is authorized

  #

  # @param [String] name Anchor text (passed to link_to)

  # @param [Hash] options Hash params. This will checked by authorize_for to see if the user is authorized

  # @param [optional, Hash] html_options Options passed to link_to

  # @param [optional, Hash] parameters_for_method_reference Extra parameters for link_to

  def link_to_if_authorized(name, options = {}, html_options = nil, *parameters_for_method_reference)

    link_to(name, options, html_options, *parameters_for_method_reference) if authorize_for(options[:controller] || params[:controller], options[:action])

  end

  # Displays a link to user's account page if active

  def link_to_user(user, options={})

    if user.is_a?(User)

      name = h(user.name(options[:format]))

      if user.active? || (User.current.admin? && user.logged?)

        link_to name, user_path(user), :class => user.css_classes

      else

        name

      end

    else

      h(user.to_s)

    end

  end

  # Displays a link to +issue+ with its subject.

  # Examples:

  #

  #   link_to_issue(issue)                        # => Defect #6: This is the subject

  #   link_to_issue(issue, :truncate => 6)        # => Defect #6: This i...

  #   link_to_issue(issue, :subject => false)     # => Defect #6

  #   link_to_issue(issue, :project => true)      # => Foo - Defect #6

  #   link_to_issue(issue, :subject => false, :tracker => false)     # => #6

  #

  def link_to_issue(issue, options={})

    title = nil

    subject = nil

    text = options[:tracker] == false ? "##{issue.id}" : "#{issue.tracker} ##{issue.id}"

    if options[:subject] == false

      title = issue.subject.truncate(60)

    else

      subject = issue.subject

      if truncate_length = options[:truncate]

        subject = subject.truncate(truncate_length)

      end

    end

    only_path = options[:only_path].nil? ? true : options[:only_path]

    s = link_to(text, issue_path(issue, :only_path => only_path),

                :class => issue.css_classes, :title => title)

    s << h(": #{subject}") if subject

    s = h("#{issue.project} - ") + s if options[:project]

    s

  end

  # Generates a link to an attachment.

  # Options:

  # * :text - Link text (default to attachment filename)

  # * :download - Force download (default: false)

  def link_to_attachment(attachment, options={})

    text = options.delete(:text) || attachment.filename

    route_method = options.delete(:download) ? :download_named_attachment_path : :named_attachment_path

    html_options = options.slice!(:only_path)

    url = send(route_method, attachment, attachment.filename, options)

    link_to text, url, html_options

  end

  # Generates a link to a SCM revision

  # Options:

  # * :text - Link text (default to the formatted revision)

  def link_to_revision(revision, repository, options={})

    if repository.is_a?(Project)

      repository = repository.repository

    end

    text = options.delete(:text) || format_revision(revision)

    rev = revision.respond_to?(:identifier) ? revision.identifier : revision

    link_to(

        h(text),

        {:controller => 'repositories', :action => 'revision', :id => repository.project, :repository_id => repository.identifier_param, :rev => rev},

        :title => l(:label_revision_id, format_revision(revision))

      )

  end

  # Generates a link to a message

  def link_to_message(message, options={}, html_options = nil)

    link_to(

      message.subject.truncate(60),

      board_message_path(message.board_id, message.parent_id || message.id, {

        :r => (message.parent_id && message.id),

        :anchor => (message.parent_id ? "message-#{message.id}" : nil)

      }.merge(options)),

      html_options

    )

  end

  # Generates a link to a project if active

  # Examples:

  #

  #   link_to_project(project)                          # => link to the specified project overview

  #   link_to_project(project, {:only_path => false}, :class => "project") # => 3rd arg adds html options

  #   link_to_project(project, {}, :class => "project") # => html options with default url (project overview)

  #

  def link_to_project(project, options={}, html_options = nil)

    if project.archived?

      h(project.name)

    elsif options.key?(:action)

      ActiveSupport::Deprecation.warn "#link_to_project with :action option is deprecated and will be removed in Redmine 3.0."

      url = {:controller => 'projects', :action => 'show', :id => project}.merge(options)

      link_to project.name, url, html_options

    else

      link_to project.name, project_path(project, options), html_options

    end

  end

  # Generates a link to a project settings if active

  def link_to_project_settings(project, options={}, html_options=nil)

    if project.active?

      link_to project.name, settings_project_path(project, options), html_options

    elsif project.archived?

      h(project.name)

    else

      link_to project.name, project_path(project, options), html_options

    end

  end

  # Helper that formats object for html or text rendering

  def format_object(object, html=true)

    case object.class.name

    when 'Array'

      object.map {|o| format_object(o, html)}.join(', ').html_safe

    when 'Time'

      format_time(object)

    when 'Date'

      format_date(object)

    when 'Fixnum'

      object.to_s

    when 'Float'

      sprintf "%.2f", object

    when 'User'

      html ? link_to_user(object) : object.to_s

    when 'Project'

      html ? link_to_project(object) : object.to_s

    when 'Version'

      html ? link_to(object.name, version_path(object)) : object.to_s

    when 'TrueClass'

      l(:general_text_Yes)

    when 'FalseClass'

      l(:general_text_No)

    when 'Issue'

      object.visible? && html ? link_to_issue(object) : "##{object.id}"

    when 'CustomValue', 'CustomFieldValue'

      if object.custom_field

        f = object.custom_field.format.formatted_custom_value(self, object, html)

        if f.nil? || f.is_a?(String)

          f

        else

          format_object(f, html)

        end

      else

        object.value.to_s

      end

    else

      html ? h(object) : object.to_s

    end

  end

  def wiki_page_path(page, options={})

    url_for({:controller => 'wiki', :action => 'show', :project_id => page.project, :id => page.title}.merge(options))

  end

  def thumbnail_tag(attachment)

    link_to image_tag(thumbnail_path(attachment)),

      named_attachment_path(attachment, attachment.filename),

      :title => attachment.filename

  end

  def toggle_link(name, id, options={})

    onclick = "$('##{id}').toggle(); "

    onclick << (options[:focus] ? "$('##{options[:focus]}').focus(); " : "this.blur(); ")

    onclick << "return false;"

    link_to(name, "#", :onclick => onclick)

  end

  def image_to_function(name, function, html_options = {})

    html_options.symbolize_keys!

    tag(:input, html_options.merge({

        :type => "image", :src => image_path(name),

        :onclick => (html_options[:onclick] ? "#{html_options[:onclick]}; " : "") + "#{function};"

        }))

  end

  def format_activity_title(text)

    h(truncate_single_line_raw(text, 100))

  end

  def format_activity_day(date)

    date == User.current.today ? l(:label_today).titleize : format_date(date)

  end

  def format_activity_description(text)

    h(text.to_s.truncate(120).gsub(%r{[\r\n]*<(pre|code)>.*$}m, '...')

       ).gsub(/[\r\n]+/, "<br />").html_safe

  end

  def format_version_name(version)

    if version.project == @project

      h(version)

    else

      h("#{version.project} - #{version}")

    end

  end

  def due_date_distance_in_words(date)

    if date

      l((date < Date.today ? :label_roadmap_overdue : :label_roadmap_due_in), distance_of_date_in_words(Date.today, date))

    end

  end

  # Renders a tree of projects as a nested set of unordered lists

  # The given collection may be a subset of the whole project tree

  # (eg. some intermediate nodes are private and can not be seen)

  def render_project_nested_lists(projects)

    s = ''

    if projects.any?

      ancestors = []

      original_project = @project

      projects.sort_by(&:lft).each do |project|

        # set the project environment to please macros.

        @project = project

        if (ancestors.empty? || project.is_descendant_of?(ancestors.last))

          s << "<ul class='projects #{ ancestors.empty? ? 'root' : nil}'>\n"

        else

          ancestors.pop

          s << "</li>"

          while (ancestors.any? && !project.is_descendant_of?(ancestors.last))

            ancestors.pop

            s << "</ul></li>\n"

          end

        end

        classes = (ancestors.empty? ? 'root' : 'child')

        s << "<li class='#{classes}'><div class='#{classes}'>"

        s << h(block_given? ? yield(project) : project.name)

        s << "</div>\n"

        ancestors << project

      end

      s << ("</li></ul>\n" * ancestors.size)

      @project = original_project

    end

    s.html_safe

  end

  def render_page_hierarchy(pages, node=nil, options={})

    content = ''

    if pages[node]

      content << "<ul class=\"pages-hierarchy\">\n"

      pages[node].each do |page|

        content << "<li>"

        content << link_to(h(page.pretty_title), {:controller => 'wiki', :action => 'show', :project_id => page.project, :id => page.title, :version => nil},

                           :title => (options[:timestamp] && page.updated_on ? l(:label_updated_time, distance_of_time_in_words(Time.now, page.updated_on)) : nil))

        content << "\n" + render_page_hierarchy(pages, page.id, options) if pages[page.id]

        content << "</li>\n"

      end

      content << "</ul>\n"

    end

    content.html_safe

  end

  # Renders flash messages

  def render_flash_messages

    s = ''

    flash.each do |k,v|

      s << content_tag('div', v.html_safe, :class => "flash #{k}", :id => "flash_#{k}")

    end

    s.html_safe

  end

  # Renders tabs and their content

  def render_tabs(tabs, selected=params[:tab])

    if tabs.any?

      unless tabs.detect {|tab| tab[:name] == selected}

        selected = nil

      end

      selected ||= tabs.first[:name]

      render :partial => 'common/tabs', :locals => {:tabs => tabs, :selected_tab => selected}

    else

      content_tag 'p', l(:label_no_data), :class => "nodata"

    end

  end

  # Renders the project quick-jump box

  def render_project_jump_box

    return unless User.current.logged?

    projects = User.current.memberships.collect(&:project).compact.select(&:active?).uniq

    if projects.any?

      options =

        ("<option value=''>#{ l(:label_jump_to_a_project) }</option>" +

         '<option value="" disabled="disabled">---</option>').html_safe

      options << project_tree_options_for_select(projects, :selected => @project) do |p|

        { :value => project_path(:id => p, :jump => current_menu_item) }

      end

      select_tag('project_quick_jump_box', options, :onchange => 'if (this.value != \'\') { window.location = this.value; }')

    end

  end

  def project_tree_options_for_select(projects, options = {})

    s = ''

    project_tree(projects) do |project, level|

      name_prefix = (level > 0 ? ' ' * 2 * level + '» ' : '').html_safe

      tag_options = {:value => project.id}

      if project == options[:selected] || (options[:selected].respond_to?(:include?) && options[:selected].include?(project))

        tag_options[:selected] = 'selected'

      else

        tag_options[:selected] = nil

      end

      tag_options.merge!(yield(project)) if block_given?

      s << content_tag('option', name_prefix + h(project), tag_options)

    end

    s.html_safe

  end

  # Yields the given block for each project with its level in the tree

  #

  # Wrapper for Project#project_tree

  def project_tree(projects, &block)

    Project.project_tree(projects, &block)

  end

  def principals_check_box_tags(name, principals)

    s = ''

    principals.sort.each do |principal|

      if principal.type == "User"

        s << "<label>#{ check_box_tag name, principal.id, false, :id => nil } #{link_to_user principal}</label>\n"

      else

        s << "<label>#{ check_box_tag name, principal.id, false, :id => nil } #{h principal} (Group)</label>\n"

      end

    end

    s.html_safe

  end

  # Returns a string for users/groups option tags

  def principals_options_for_select(collection, selected=nil)

    s = ''

    if collection.include?(User.current)

      s << content_tag('option', "<< #{l(:label_me)} >>", :value => User.current.id)

    end

    groups = ''

    collection.sort.each do |element|

      selected_attribute = ' selected="selected"' if option_value_selected?(element, selected) || element.id.to_s == selected

      (element.is_a?(Group) ? groups : s) << %(<option value="#{element.id}"#{selected_attribute}>#{h element.name}</option>)

    end

    unless groups.empty?

      s << %(<optgroup label="#{h(l(:label_group_plural))}">#{groups}</optgroup>)

    end

    s.html_safe

  end

  # Options for the new membership projects combo-box

  def options_for_membership_project_select(principal, projects)

    options = content_tag('option', "--- #{l(:actionview_instancetag_blank_option)} ---")

    options << project_tree_options_for_select(projects) do |p|

      {:disabled => principal.projects.to_a.include?(p)}

    end

    options

  end

  def option_tag(name, text, value, selected=nil, options={})

    content_tag 'option', value, options.merge(:value => value, :selected => (value == selected))

  end

  # Truncates and returns the string as a single line

  def truncate_single_line(string, *args)

    ActiveSupport::Deprecation.warn(

      "ApplicationHelper#truncate_single_line is deprecated and will be removed in Rails 4 poring")

    # Rails 4 ActionView::Helpers::TextHelper#truncate escapes.

    # So, result is broken.

    truncate(string.to_s, *args).gsub(%r{[\r\n]+}m, ' ')

  end

  def truncate_single_line_raw(string, length)

    string.truncate(length).gsub(%r{[\r\n]+}m, ' ')

  end

  # Truncates at line break after 250 characters or options[:length]

  def truncate_lines(string, options={})

    length = options[:length] || 250

    if string.to_s =~ /\A(.{#{length}}.*?)$/m

      "#{$1}..."

    else

      string

    end

  end

  def anchor(text)

    text.to_s.gsub(' ', '_')

  end

  def html_hours(text)

    text.gsub(%r{(\d+)\.(\d+)}, '<span class="hours hours-int">\1</span><span class="hours hours-dec">.\2</span>').html_safe

  end

  def authoring(created, author, options={})

    l(options[:label] || :label_added_time_by, :author => link_to_user(author), :age => time_tag(created)).html_safe

  end

  def time_tag(time)

    text = distance_of_time_in_words(Time.now, time)

    if @project

      link_to(text, {:controller => 'activities', :action => 'index', :id => @project, :from => User.current.time_to_date(time)}, :title => format_time(time))

    else

      content_tag('abbr', text, :title => format_time(time))

    end

  end

  def syntax_highlight_lines(name, content)

    lines = []

    syntax_highlight(name, content).each_line { |line| lines << line }

    lines

  end

  def syntax_highlight(name, content)

    Redmine::SyntaxHighlighting.highlight_by_filename(content, name)

  end

  def to_path_param(path)

    str = path.to_s.split(%r{[/\\]}).select{|p| !p.blank?}.join("/")

    str.blank? ? nil : str

  end

  def reorder_links(name, url, method = :post)

    link_to(image_tag('2uparrow.png', :alt => l(:label_sort_highest)),

            url.merge({"#{name}[move_to]" => 'highest'}),

            :method => method, :title => l(:label_sort_highest)) +

    link_to(image_tag('1uparrow.png',   :alt => l(:label_sort_higher)),

            url.merge({"#{name}[move_to]" => 'higher'}),

           :method => method, :title => l(:label_sort_higher)) +

    link_to(image_tag('1downarrow.png', :alt => l(:label_sort_lower)),

            url.merge({"#{name}[move_to]" => 'lower'}),

            :method => method, :title => l(:label_sort_lower)) +

    link_to(image_tag('2downarrow.png', :alt => l(:label_sort_lowest)),

            url.merge({"#{name}[move_to]" => 'lowest'}),

           :method => method, :title => l(:label_sort_lowest))

  end

  def breadcrumb(*args)

    elements = args.flatten

    elements.any? ? content_tag('p', (args.join(" \xc2\xbb ") + " \xc2\xbb ").html_safe, :class => 'breadcrumb') : nil

  end

  def other_formats_links(&block)

    concat('<p class="other-formats">'.html_safe + l(:label_export_to))

    yield Redmine::Views::OtherFormatsBuilder.new(self)

    concat('</p>'.html_safe)

  end

  def page_header_title

    if @project.nil? || @project.new_record?

      a = [h(Setting.app_title), '']

    else

      pname = []

      b = []

      ancestors = (@project.root? ? [] : @project.ancestors.visible.all)

      if ancestors.any?

        root = ancestors.shift

        b << link_to_project(root, {:jump => current_menu_item}, :class => 'root')

        if ancestors.size > 2

          b << '&#8230;'

          ancestors = ancestors[-2, 2]

        end

        b += ancestors.collect {|p| link_to_project(p, {:jump => current_menu_item}, :class => 'ancestor') }

        b = b.join(' » ').html_safe

        b << (' &#187;'.html_safe)

      end

      pname << h(@project)

      a = [pname, b]

    end

  end

  # Returns a h2 tag and sets the html title with the given arguments

  def title(*args)

    strings = args.map do |arg|

      if arg.is_a?(Array) && arg.size >= 2

        link_to(*arg)

      else

        h(arg.to_s)

      end

    end

    html_title args.reverse.map {|s| (s.is_a?(Array) ? s.first : s).to_s}

    content_tag('h2', strings.join(' » ').html_safe)

  end

  # Sets the html title

  # Returns the html title when called without arguments

  # Current project name and app_title and automatically appended

  # Exemples:

  #   html_title 'Foo', 'Bar'

  #   html_title # => 'Foo - Bar - My Project - Redmine'

  def html_title(*args)

    if args.empty?

      title = @html_title || []

      title << @project.name if @project

      title << Setting.app_title unless Setting.app_title == title.last

      title.reject(&:blank?).join(' - ')

    else

      @html_title ||= []

      @html_title += args

    end

  end

  # Returns the theme, controller name, and action as css classes for the

  # HTML body.

  def body_css_classes

    css = []

    if theme = Redmine::Themes.theme(Setting.ui_theme)

      css << 'theme-' + theme.name

    end

    css << 'project-' + @project.identifier if @project && @project.identifier.present?

    css << 'controller-' + controller_name

    css << 'action-' + action_name

    css.join(' ')

  end

  def accesskey(s)

    @used_accesskeys ||= []

    key = Redmine::AccessKeys.key_for(s)

    return nil if @used_accesskeys.include?(key)

    @used_accesskeys << key

    key

  end

  # Formats text according to system settings.

  # 2 ways to call this method:

  # * with a String: textilizable(text, options)

  # * with an object and one of its attribute: textilizable(issue, :description, options)

  def textilizable(*args)

    options = args.last.is_a?(Hash) ? args.pop : {}

    case args.size

    when 1

      obj = options[:object]

      text = args.shift

    when 2

      obj = args.shift

      attr = args.shift

      text = obj.send(attr).to_s

    else

      raise ArgumentError, 'invalid arguments to textilizable'

    end

    return '' if text.blank?

    project = options[:project] || @project || (obj && obj.respond_to?(:project) ? obj.project : nil)

    only_path = options.delete(:only_path) == false ? false : true

    text = text.dup

    macros = catch_macros(text)

    text = Redmine::WikiFormatting.to_html(Setting.text_formatting, text, :object => obj, :attribute => attr)

    @parsed_headings = []

    @heading_anchors = {}

    @current_section = 0 if options[:edit_section_links]

    parse_sections(text, project, obj, attr, only_path, options)

    text = parse_non_pre_blocks(text, obj, macros) do |text|

      [:parse_inline_attachments, :parse_wiki_links, :parse_redmine_links].each do |method_name|

        send method_name, text, project, obj, attr, only_path, options

      end

    end

    parse_headings(text, project, obj, attr, only_path, options)

    if @parsed_headings.any?

      replace_toc(text, @parsed_headings)

    end

    text.html_safe

  end

  def parse_non_pre_blocks(text, obj, macros)

    s = StringScanner.new(text)

    tags = []

    parsed = ''

    while !s.eos?

      s.scan(/(.*?)(<(\/)?(pre|code)(.*?)>|\z)/im)

      text, full_tag, closing, tag = s[1], s[2], s[3], s[4]

      if tags.empty?

        yield text

        inject_macros(text, obj, macros) if macros.any?

      else

        inject_macros(text, obj, macros, false) if macros.any?

      end

      parsed << text

      if tag

        if closing

          if tags.last == tag.downcase

            tags.pop

          end

        else

          tags << tag.downcase

        end

        parsed << full_tag

      end

    end

    # Close any non closing tags

    while tag = tags.pop

      parsed << "</#{tag}>"

    end

    parsed

  end

  def parse_inline_attachments(text, project, obj, attr, only_path, options)

    # when using an image link, try to use an attachment, if possible

    attachments = options[:attachments] || []

    attachments += obj.attachments if obj.respond_to?(:attachments)

    if attachments.present?

      text.gsub!(/src="([^\/"]+\.(bmp|gif|jpg|jpe|jpeg|png))"(\s+alt="([^"]*)")?/i) do |m|

        filename, ext, alt, alttext = $1.downcase, $2, $3, $4

        # search for the picture in attachments

        if found = Attachment.latest_attach(attachments, filename)

          image_url = download_named_attachment_path(found, found.filename, :only_path => only_path)

          desc = found.description.to_s.gsub('"', '')

          if !desc.blank? && alttext.blank?

            alt = " title=\"#{desc}\" alt=\"#{desc}\""

          end

          "src=\"#{image_url}\"#{alt}"

        else

          m

        end

      end

    end

  end

  # Wiki links

  #

  # Examples:

  #   [[mypage]]

  #   [[mypage|mytext]]

  # wiki links can refer other project wikis, using project name or identifier:

  #   [[project:]] -> wiki starting page

  #   [[project:|mytext]]

  #   [[project:mypage]]

  #   [[project:mypage|mytext]]

  def parse_wiki_links(text, project, obj, attr, only_path, options)

    text.gsub!(/(!)?(\[\[([^\]\n\|]+)(\|([^\]\n\|]+))?\]\])/) do |m|

      link_project = project

      esc, all, page, title = $1, $2, $3, $5

      if esc.nil?

        if page =~ /^([^\:]+)\:(.*)$/

          identifier, page = $1, $2

          link_project = Project.find_by_identifier(identifier) || Project.find_by_name(identifier)

          title ||= identifier if page.blank?

        end

        if link_project && link_project.wiki

          # extract anchor

          anchor = nil

          if page =~ /^(.+?)\#(.+)$/

            page, anchor = $1, $2

          end

          anchor = sanitize_anchor_name(anchor) if anchor.present?

          # check if page exists

          wiki_page = link_project.wiki.find_page(page)

          url = if anchor.present? && wiki_page.present? && (obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version)) && obj.page == wiki_page

            "##{anchor}"

          else

            case options[:wiki_links]

            when :local; "#{page.present? ? Wiki.titleize(page) : ''}.html" + (anchor.present? ? "##{anchor}" : '')

            when :anchor; "##{page.present? ? Wiki.titleize(page) : title}" + (anchor.present? ? "_#{anchor}" : '') # used for single-file wiki export

            else

              wiki_page_id = page.present? ? Wiki.titleize(page) : nil

              parent = wiki_page.nil? && obj.is_a?(WikiContent) && obj.page && project == link_project ? obj.page.title : nil

              url_for(:only_path => only_path, :controller => 'wiki', :action => 'show', :project_id => link_project,

               :id => wiki_page_id, :version => nil, :anchor => anchor, :parent => parent)

            end

          end

          link_to(title.present? ? title.html_safe : h(page), url, :class => ('wiki-page' + (wiki_page ? '' : ' new')))

        else

          # project or wiki doesn't exist

          all

        end

      else

        all

      end

    end

  end

  # Redmine links

  #

  # Examples:

  #   Issues:

  #     #52 -> Link to issue #52

  #   Changesets:

  #     r52 -> Link to revision 52

  #     commit:a85130f -> Link to scmid starting with a85130f

  #   Documents:

  #     document#17 -> Link to document with id 17

  #     document:Greetings -> Link to the document with title "Greetings"

  #     document:"Some document" -> Link to the document with title "Some document"

  #   Versions:

  #     version#3 -> Link to version with id 3

  #     version:1.0.0 -> Link to version named "1.0.0"

  #     version:"1.0 beta 2" -> Link to version named "1.0 beta 2"

  #   Attachments:

  #     attachment:file.zip -> Link to the attachment of the current object named file.zip

  #   Source files:

  #     source:some/file -> Link to the file located at /some/file in the project's repository

  #     source:some/file@52 -> Link to the file's revision 52

  #     source:some/file#L120 -> Link to line 120 of the file

  #     source:some/file@52#L120 -> Link to line 120 of the file's revision 52

  #     export:some/file -> Force the download of the file

  #   Forum messages:

  #     message#1218 -> Link to message with id 1218

  #  Projects:

  #     project:someproject -> Link to project named "someproject"

  #     project#3 -> Link to project with id 3

  #

  #   Links can refer other objects from other projects, using project identifier:

  #     identifier:r52

  #     identifier:document:"Some document"

  #     identifier:version:1.0.0

  #     identifier:source:some/file

  def parse_redmine_links(text, default_project, obj, attr, only_path, options)

    text.gsub!(%r{([\s\(,\-\[\>]|^)(!)?(([a-z0-9\-_]+):)?(attachment|document|version|forum|news|message|project|commit|source|export)?(((#)|((([a-z0-9\-_]+)\|)?(r)))((\d+)((#note)?-(\d+))?)|(:)([^"\s<>][^\s<>]*?|"[^"]+?"))(?=(?=[[:punct:]][^A-Za-z0-9_/])|,|\s|\]|<|$)}) do |m|

      leading, esc, project_prefix, project_identifier, prefix, repo_prefix, repo_identifier, sep, identifier, comment_suffix, comment_id = $1, $2, $3, $4, $5, $10, $11, $8 || $12 || $18, $14 || $19, $15, $17

      link = nil

      project = default_project

      if project_identifier

        project = Project.visible.find_by_identifier(project_identifier)

      end

      if esc.nil?

        if prefix.nil? && sep == 'r'

          if project

            repository = nil

            if repo_identifier

              repository = project.repositories.detect {|repo| repo.identifier == repo_identifier}

            else

              repository = project.repository

            end

            # project.changesets.visible raises an SQL error because of a double join on repositories

            if repository &&

                 (changeset = Changeset.visible.

                                  find_by_repository_id_and_revision(repository.id, identifier))

              link = link_to(h("#{project_prefix}#{repo_prefix}r#{identifier}"),

                             {:only_path => only_path, :controller => 'repositories',

                              :action => 'revision', :id => project,

                              :repository_id => repository.identifier_param,

                              :rev => changeset.revision},

                             :class => 'changeset',

                             :title => truncate_single_line_raw(changeset.comments, 100))

            end

          end

        elsif sep == '#'

          oid = identifier.to_i

          case prefix

          when nil

            if oid.to_s == identifier &&

                  issue = Issue.visible.includes(:status).find_by_id(oid)

              anchor = comment_id ? "note-#{comment_id}" : nil

              link = link_to(h("##{oid}#{comment_suffix}"),

                             {:only_path => only_path, :controller => 'issues',

                              :action => 'show', :id => oid, :anchor => anchor},

                             :class => issue.css_classes,

                             :title => "#{issue.subject.truncate(100)} (#{issue.status.name})")

            end

          when 'document'

            if document = Document.visible.find_by_id(oid)

              link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document},

                                                :class => 'document'

            end

          when 'version'

            if version = Version.visible.find_by_id(oid)

              link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version},

                                              :class => 'version'

            end

          when 'message'

            if message = Message.visible.includes(:parent).find_by_id(oid)

              link = link_to_message(message, {:only_path => only_path}, :class => 'message')

            end

          when 'forum'

            if board = Board.visible.find_by_id(oid)

              link = link_to h(board.name), {:only_path => only_path, :controller => 'boards', :action => 'show', :id => board, :project_id => board.project},

                                             :class => 'board'

            end

          when 'news'

            if news = News.visible.find_by_id(oid)

              link = link_to h(news.title), {:only_path => only_path, :controller => 'news', :action => 'show', :id => news},

                                            :class => 'news'

            end

          when 'project'

            if p = Project.visible.find_by_id(oid)

              link = link_to_project(p, {:only_path => only_path}, :class => 'project')

            end

          end

        elsif sep == ':'

          # removes the double quotes if any

          name = identifier.gsub(%r{^"(.*)"$}, "\\1")

          name = CGI.unescapeHTML(name)

          case prefix

          when 'document'

            if project && document = project.documents.visible.find_by_title(name)

              link = link_to h(document.title), {:only_path => only_path, :controller => 'documents', :action => 'show', :id => document},

                                                :class => 'document'

            end

          when 'version'

            if project && version = project.versions.visible.find_by_name(name)

              link = link_to h(version.name), {:only_path => only_path, :controller => 'versions', :action => 'show', :id => version},

                                              :class => 'version'

            end

          when 'forum'

            if project && board = project.boards.visible.find_by_name(name)

              link = link_to h(board.name), {:only_path => only_path, :controller => 'boards', :action => 'show', :id => board, :project_id => board.project},

                                             :class => 'board'

            end

          when 'news'

            if project && news = project.news.visible.find_by_title(name)

              link = link_to h(news.title), {:only_path => only_path, :controller => 'news', :action => 'show', :id => news},

                                            :class => 'news'

            end

          when 'commit', 'source', 'export'

            if project

              repository = nil

              if name =~ %r{^(([a-z0-9\-_]+)\|)(.+)$}

                repo_prefix, repo_identifier, name = $1, $2, $3

                repository = project.repositories.detect {|repo| repo.identifier == repo_identifier}

              else

                repository = project.repository

              end

              if prefix == 'commit'

                if repository && (changeset = Changeset.visible.where("repository_id = ? AND scmid LIKE ?", repository.id, "#{name}%").first)

                  link = link_to h("#{project_prefix}#{repo_prefix}#{name}"), {:only_path => only_path, :controller => 'repositories', :action => 'revision', :id => project, :repository_id => repository.identifier_param, :rev => changeset.identifier},

                                               :class => 'changeset',

                                               :title => truncate_single_line_raw(changeset.comments, 100)

                end

              else

                if repository && User.current.allowed_to?(:browse_repository, project)

                  name =~ %r{^[/\\]*(.*?)(@([^/\\@]+?))?(#(L\d+))?$}

                  path, rev, anchor = $1, $3, $5

                  link = link_to h("#{project_prefix}#{prefix}:#{repo_prefix}#{name}"), {:only_path => only_path, :controller => 'repositories', :action => (prefix == 'export' ? 'raw' : 'entry'), :id => project, :repository_id => repository.identifier_param,

                                                          :path => to_path_param(path),

                                                          :rev => rev,

                                                          :anchor => anchor},

                                                         :class => (prefix == 'export' ? 'source download' : 'source')

                end

              end

              repo_prefix = nil

            end

          when 'attachment'

            attachments = options[:attachments] || []

            attachments += obj.attachments if obj.respond_to?(:attachments)

            if attachments && attachment = Attachment.latest_attach(attachments, name)

              link = link_to_attachment(attachment, :only_path => only_path, :download => true, :class => 'attachment')

            end

          when 'project'

            if p = Project.visible.where("identifier = :s OR LOWER(name) = :s", :s => name.downcase).first

              link = link_to_project(p, {:only_path => only_path}, :class => 'project')

            end

          end

        end

      end

      (leading + (link || "#{project_prefix}#{prefix}#{repo_prefix}#{sep}#{identifier}#{comment_suffix}"))

    end

  end

  HEADING_RE = /(<h(\d)( [^>]+)?>(.+?)<\/h(\d)>)/i unless const_defined?(:HEADING_RE)

  def parse_sections(text, project, obj, attr, only_path, options)

    return unless options[:edit_section_links]

    text.gsub!(HEADING_RE) do

      heading = $1

      @current_section += 1

      if @current_section > 1

        content_tag('div',

          link_to(image_tag('edit.png'), options[:edit_section_links].merge(:section => @current_section)),

          :class => 'contextual',

          :title => l(:button_edit_section),

          :id => "section-#{@current_section}") + heading.html_safe

      else

        heading

      end

    end

  end

  # Headings and TOC

  # Adds ids and links to headings unless options[:headings] is set to false

  def parse_headings(text, project, obj, attr, only_path, options)

    return if options[:headings] == false

    text.gsub!(HEADING_RE) do

      level, attrs, content = $2.to_i, $3, $4

      item = strip_tags(content).strip

      anchor = sanitize_anchor_name(item)

      # used for single-file wiki export

      anchor = "#{obj.page.title}_#{anchor}" if options[:wiki_links] == :anchor && (obj.is_a?(WikiContent) || obj.is_a?(WikiContent::Version))

      @heading_anchors[anchor] ||= 0

      idx = (@heading_anchors[anchor] += 1)

      if idx > 1

        anchor = "#{anchor}-#{idx}"

      end

      @parsed_headings << [level, anchor, item]

      "<a name=\"#{anchor}\"></a>\n<h#{level} #{attrs}>#{content}<a href=\"##{anchor}\" class=\"wiki-anchor\">&para;</a></h#{level}>"

    end

  end

  MACROS_RE = /(

                (!)?                        # escaping

                (

                \{\{                        # opening tag

                ([\w]+)                     # macro name

                (\(([^\n\r]*?)\))?          # optional arguments

                ([\n\r].*?[\n\r])?          # optional block of text

                \}\}                        # closing tag

                )

               )/mx unless const_defined?(:MACROS_RE)

  MACRO_SUB_RE = /(

                  \{\{

                  macro\((\d+)\)

                  \}\}

                  )/x unless const_defined?(:MACRO_SUB_RE)

  # Extracts macros from text

  def catch_macros(text)

    macros = {}

    text.gsub!(MACROS_RE) do

      all, macro = $1, $4.downcase

      if macro_exists?(macro) || all =~ MACRO_SUB_RE

        index = macros.size

        macros[index] = all

        "{{macro(#{index})}}"

      else

        all

      end

    end

    macros

  end

  # Executes and replaces macros in text

  def inject_macros(text, obj, macros, execute=true)

    text.gsub!(MACRO_SUB_RE) do

      all, index = $1, $2.to_i

      orig = macros.delete(index)

      if execute && orig && orig =~ MACROS_RE

        esc, all, macro, args, block = $2, $3, $4.downcase, $6.to_s, $7.try(:strip)

        if esc.nil?

          h(exec_macro(macro, obj, args, block) || all)

        else

          h(all)

        end

      elsif orig

        h(orig)

      else

        h(all)

      end

    end

  end

  TOC_RE = /<p>\{\{((<|&lt;)|(>|&gt;))?toc\}\}<\/p>/i unless const_defined?(:TOC_RE)

  # Renders the TOC with given headings

  def replace_toc(text, headings)

    text.gsub!(TOC_RE) do

      left_align, right_align = $2, $3

      # Keep only the 4 first levels

      headings = headings.select{|level, anchor, item| level <= 4}

      if headings.empty?

        ''

      else

        div_class = 'toc'

        div_class << ' right' if right_align

        div_class << ' left' if left_align

        out = "<ul class=\"#{div_class}\"><li>"

        root = headings.map(&:first).min

        current = root

        started = false

        headings.each do |level, anchor, item|

          if level > current

            out << '<ul><li>' * (level - current)

          elsif level < current

            out << "</li></ul>\n" * (current - level) + "</li><li>"

          elsif started

            out << '</li><li>'

          end

          out << "<a href=\"##{anchor}\">#{item}</a>"

          current = level

          started = true

        end

        out << '</li></ul>' * (current - root)

        out << '</li></ul>'

      end

    end

  end

  # Same as Rails' simple_format helper without using paragraphs

  def simple_format_without_paragraph(text)

    text.to_s.